README_ja.md

English | 日本語

pixela-client-go

注意: pixela-client-go はバグ修正以外の開発は止まっています。

pixela4go を使うことを検討してください。

Go 用の Pixela API クライアントです。

ドキュメント

https://godoc.org/github.com/ebc-2in2crc/pixela-client-go

インストール

$ go get -u github.com/ebc-2in2crc/pixela-client-go

使い方

package main

import (
	"log"
	
	"github.com/ebc-2in2crc/pixela-client-go"
)

func main() {
	client := pixela.NewClient("YOUR_NAME", "YOUR_TOKEN")

	// 新しいユーザーを作る
	result, err := client.CreateUser(true, true, "")
	if err != nil {
		log.Fatal(err)
	}
	if result.IsSuccess == false {
		log.Fatal(result.Message)
	}

	// 新しいグラフを作る
	result, err = client.Graph("graph-id").Create(
		"graph-name",
		"commit",
		pixela.TypeInt,
		pixela.ColorShibafu,
		"Asia/Tokyo",
		pixela.SelfSufficientNone,
		false,
		false,
	)
	if err != nil {
		log.Fatal(err)
	}
	if result.IsSuccess == false {
		log.Fatal(result.Message)
	}

	// 値をピクセルに記録する
	result, err = client.Pixel("graph-id").Create("20180915", "5", "")
	if err != nil {
		log.Fatal(err)
	}
	if result.IsSuccess == false {
		log.Fatal(result.Message)
	}

	// ピクセルの値をインクリメントする
	result, err = client.Pixel("graph-id").Increment()
	if err != nil {
		log.Fatal(err)
	}
	if result.IsSuccess == false {
		log.Fatal(result.Message)
	}

	// 新しい webhook を作る
	webhook, err := client.Webhook().Create("graph-id", pixela.SelfSufficientIncrement)
	if err != nil {
		log.Fatal(err)
	}
	if webhook.IsSuccess == false {
		log.Fatal(webhook.Message)
	}

	// webhook を呼び出す
	result, err = client.Webhook().Invoke(webhook.WebhookHash)
	if err != nil {
		log.Fatal(err)
	}
	if result.IsSuccess == false {
		log.Fatal(result.Message)
	}
}

コントリビューション

1. このリポジトリをフォークします
2. issue ブランチを作成します (git checkout -b issue/:id)
3. コードを変更します
4. make test でテストを実行し, パスすることを確認します
5. make fmt でコードをフォーマットします
6. 変更をコミットします (git commit -am 'Add some feature')
7. 新しいプルリクエストを作成します

ライセンス

MIT

作者

ebc-2in2crc