15 min/d

ぼうずやのにっき

Backlog API for Clojure の使いかた

Backlog API for ClojureBacklog アプリケーション に掲載していただけるそうなので、使いかたなどを書いておく。

Backlog API for Clojure とは

Backlog API for ClojureClojure から Backlog API へのアクセスをやさしくするためのライブラリである。

ソースコードGitHubbouzuya/clj-backlog にあり、jar ファイルは Clojarsorg.clojars.bouzuya/backlog にある。

使いかた

Clojars にあるので Leiningen を使っているのなら project.clj:dependencies[org.clojars.ouzuya/clj-backlog "0.3.0"] を足して、lein deps で良い。

関数などの名前は backlog.getProject なら backlog/get-projectbacklog.admin.getUsers なら backlog.admin/get-users のように、Clojureでよく使われるハイフン区切りに置き換えている。

次のようにして呼び出せる。

(require 'backlog '[backlog.config :as config]) (binding [config/*backlog-auth* {:spacename "space" :username "user" :password "xxxx"}] (backlog/get-project "PROJ")) 

backlog.*backlog.admin.* の呼び出し前には backlog.config/*backlog-auth* にログイン情報を忘れず設定すること。

引数の指定は、必須のものはドキュメントの順に指定し、省略可能のものはキーワードと値を並べて書く。キーワードの名前もまた関数と同じように user_id なら user-idprojectId なら project-id と置き換えている。API リファレンスに書かれている PascalCasecamelCasesnake_case などは clojure-style に置き換えて読むと良い。

; プロジェクト "PROJ" から未対応の課題を得る(認証は割愛) (let [project-id (:id (backlog/get-project "PROJ"))] (backlog/find-issue project-id :status-id 1)) 

:status-id は省略可能な引数である。

上記例から分かるとおり、戻り値は XML ではなく Clojure のオブジェクトで返される。詳細は brehaut/necessary-evilの xml-rpc mappings を参照してほしい。

戻り値のキーワードについても関数や引数と同じような置き換えを取り入れるつもりだが、まだ実装できていない。今後もマイナーバージョン間でさえ互換性はないと考えてほしい。特定バージョンを使用するだろうし、問題ないと考えている。

サンプルアプリケーション

サンプルアプリケーションとして、コメントを投稿する bouzuya/clj-backlog-commenter を作成した。

Backlog API for Clojure 利用の際には、これらも参考になるかもしれない。

さいごに

Backlog API for Clojure で、Clojurian の Backlog ライフがより充実することを願っている。

60 min.