はじめてgemを作ったはなし / Making gem for the first time

はじめてGemを作ったはなし / ホスTech MTG #6

Transcript

1. GMOペパボ株式会社 ホスティング事業部 ムームードメイングループ 森 麻美 はじめてgemを作ったはなし
2. 森 麻美 Asami Mori
 あらみそ @orzup こんにちは！
3. 先日リリースされたロリポップ!マネージドクラウドβ！ リリースありがとうございます
4. みなさんぽちぽちしてみました？ 一瞬でサービスが誕生して本当に最高ですよね〜✨
5. さて、このマネクラなのですが
 実はAPIが公開される予定なんですよ〜
6. サインインして [~] curl -X "POST" "https://api.mc.lolipop/login" \ > -H "Content-Type: application/json" \ > -d '{"username":"___@____", "password":"____"}' "xxxx...xxxx"% # -> token
7. ゲットしたトークンを使ってプロジェクト作成〜 [~] curl -X "POST" "https://api.mc.lolipop/projects" \ > -H "Content-Type: application/json" \ > -H "Authorization: Bearer <TOKEN>” \ > -d '{"type":"rails", "db_password":"____"}' { "project_name":"crimson-akune-8238", "domain":"crimson-akune-8238.lolipop.io" }
8. できた感じする！ [~] curl -X "GET" "https://api.mc.lolipop/projects" \ > -H "Content-Type: application/json" \ > -H "Authorization: Bearer <TOKEN>” \ [ { "id":3464, "created_at":"2017-12-07T02:03:25.19289Z", "updated_at":"2017-12-07T02:11:56.345571Z", "cid":"crimson-akune-8238.lolipop.io-ef0943603f", "project_id":433, "status":3, "hacofile":"rails.haco", ... }
9. できてる〜
10. Webからはもちろん
 APIでもこんなに簡単にできちゃいますね〜☺
11. マネクラのAPIはインターネットに大公開される予定です これはたくさんの人に使ってもらうチャンス！
12. ということでgemを作る話にたどり着きます
13. @linyowsさんにかわいい名前をいただきました！
14. ちなみに各言語ごとにライブラリを用意していく予定だそうで
15. lolp.rb
16. lolp.js
17. lolp.php
18. golipop
20. 今回は lolp.rb を開発した時のことを追いかけながら 困ったことや工夫したことについて話していこうと思います
21. gemつくるぞ〜〜
22. これまでgemは利用するばかりで、0から作るのははじめて！
23. ということでどんな設計がいいのか
 クライアントなgemの調査からはじめました
24. 見聞きしたクライアントのライブラリを覗いてみる - octokit - https://github.com/octokit/octokit.rb - YAO - https://github.com/yaocloud/yao
25. おなじみ octokit は Github API のクライアントgem
 こちらもシンプルにAPIをラップしている感じですね Octokit.user Octokit.issue('pepabo/lolp.rb') Octokit.create_issue( 'pepabo/lolp.rb', 'title' )
26. YAO は OpenStack API のクライアントgem
 APIをそのままラップするだけでなくリソースをいじるように使える！ # list up networks... Yao::Network.list
 # list up instances… Yao::Server.list_detail
27. シンプルなAPIのラッパーしか知らなかったのですが
 リソースフルに使えるYAOわかりやすいしいいな〜〜〜✨
28. せっかく0から gem を作るので
 YAO みたいにかっこいい gem をかいてみたい…
 lolp.rb もその方向で書いてみよう！
29. まずは使い方を考えておいて…これに向かって開発だ！ # POST /api/projects
 Lolp::Project.new(haco_type: :wordpress) # GET /api/projects Lolp::Project.list
30. 意気揚々と書きはじめたのはいいものの
 だんだん迷走していきました
31. YAOはリソースごとにアクセスできるようにするために
 色んなテクニックがつまっていました
 例えばRestfullyAccessibleモジュールのあたりとか
32. ほうほう… RestfullyAccessibleモジュールはその名の通りリソースごと(インスタンスと かネットワークとか)にアクセスできるようにしてくれる君。これを各リソー スごとにextendするとRestfullyAccessibleに含まれているclientを使ってget やpostできるようになっています。
33. ほうほうほ、う… そもそもOpenStack APIはタイプがいくつかあって(admin, public, …)特定の権 限だとあるAPIは利用できない〜というものがあります。これはエンドポイント を変更することで使い分けることになります。YAOはリソースごとに利用するク ライアントが変わるようになっていてそれもRestfullyAccessibleのおかげでリ ソース側のクラスは気にしないで済むようになっている〜〜〜
34. はじめはいろんなコードのテクニックが詰まっていて
 完成されたパズルみたいでかっこいいな〜！と思った
35. でも注目するべきなのはそこではなかった☠
 もちろん使われてる技術は学びしかなかった！です！
36. YAOがラップしているOpenStack APIはとても複雑
37. 利用する人がAPIではなくリソースに注目して使えるよう
 APIを叩く以外のこともたくさん詰め込まれています
38. そういった背景があったからこそ
 YAOは今の設計になったんだなあ〜と感じました✨
39. マネクラAPIはもともとわかりやすくて、すごくシンプル
40. lolp.rbではマネクラAPIを叩く以外の
 何か特別な処理を行うわけではありません
41. こんな時はクライアント側で
 APIを意識せず触れるように〜とかを考えるのではなく
 シンプルなAPIクライアントがイチバンわかりやすいのでは...!
42. マネクラAPIはこれからインターネットに大公開される予定で これからもどんどん開発が進みそう
43. ということはマネクラAPIも増えそうな感じ = lolp.rbも対応していく必要がある
44. 成長していくマネクラAPIに合わせてlolp.rbを対応するのは
 もしかすると他サービスのパートナーや社外のエンジニア？
 と思うと、なるべくシンプルな構造にしておきたい
45. という流れでlolp.rbはoctokitのような
 シンプルなAPIクライアントがふさわしいのでは！
 と落ち着いたのでした
46. gemつくったぞ〜〜
47. こんな感じの設定をしておくと… Lolp.configure do |config| config.api_endpoint = 'LOLIPOP MC API ENDPOINT' config.username = 'LOLIPOP MC USERNAME' config.password = 'LOLIPOP MC PASSWORD' end
48. こんな感じで使えるようになりました # GET /projects
 Lolp.projects 
 # POST /projects Lolp.create_project(:rails) 
 # POST /projects/:name/custom-domain Lolp.create_custom_domain( 'jungly-naha-2778.lolipop.ohr', ‘example.com' )
49. LolpはLolp::Clientをインスタンスとして持っていて module Lolp class << self def client @client ||= Lolp::Client.new end def method_missing(method_name, *args, &block) if client.respond_to?(method_name) return client.send(method_name, *args, &block) end super end
50. Lolp.xxxで叩かれたメソッドはmethod_missingがキャッチ Lolp::Clientにメソッドがあればそれを呼び出します module Lolp class << self def client @client ||= Lolp::Client.new end def method_missing(method_name, *args, &block) if client.respond_to?(method_name) return client.send(method_name, *args, &block) end super end
51. Lolp::Clientの中身はこんな感じ APIのまとまりごとにもう一段切り分けています module Lolp class Client include Lolp::Project include Lolp::Configuration def connection @connection ||= Lolp::Connection.new(config) end end end
52. connectionを使ってAPIを叩いています module Lolp class Project def projects connection.get('projects') end def create_project(template, params = {}) connection.post( 'projects', params.merge(haco_type: template) ) end end
53. ですので、あつかうAPIの種類を増やしたい〜と思ったら module Lolp class Client include Lolp::Project include Lolp::Configuration def connection @connection ||= Lolp::Connection.new(config) end end end
54. クラスを増やして〜 module Lolp class Hoge def fuga connection.get('hoge') end ...
 end end
55. インクルードしてあげるだけ〜カンタン！ module Lolp class Client include Lolp::Project include Lolp::Hoge include Lolp::Configuration def connection @connection ||= Lolp::Connection.new(config) end end end
56. Lolp::Clientにどんどん増やすではなく
 APIの種類ごとにまとめておくことでわかりやすさをUP☺
57. また、connectionなるものを使ってAPIを叩いていたのですが module Lolp class Project def projects connection.get('projects') end def create_project(template, params = {}) connection.post( 'projects', params.merge(haco_type: template) ) end end
58. connectionはLolp::Connectionというクラスのインスタンス module Lolp class Connection def initialize(config) @config = config authenticate ... end def authenticate @token ||= connection.post( 'login', username: @config.username, password: @config.password ).body end
59. そのインスタンスを作る時に
 認証を通してトークンを保持するようにしてあります module Lolp class Connection def initialize(config) @config = config authenticate ... end def authenticate @token ||= connection.post( 'login', username: @config.username, password: @config.password ).body end
60. マネクラAPIはだいたいのものが
 認証を通してからじゃないと利用できません
61. 認証を通すためには
 サインインに成功した時に返ってくるトークンが必要です
62. でもこのトークン、lolp.rbを使ってくれる人には
 意識してほしくありませんでした〜
 やりたいのはサインインじゃなくてプロジェクトを作ったりとかだと思う
63. 初回だけトークンを保持するようにして隠しました module Lolp class Connection def initialize(config) @config = config authenticate ... end def authenticate @token ||= connection.post( 'login', username: @config.username, password: @config.password ).body end
64. これで認証通っているかどうかは気にせずに
 マネクラAPIを利用することができます〜 # GET /projects
 Lolp.projects 
 # POST /projects Lolp.create_project(:rails) 
 # POST /projects/:name/custom-domain Lolp.create_custom_domain( 'jungly-naha-2778.lolipop.ohr', ‘example.com' )
65. やりたいことに集中できるようにラッピング〜☺
66. こんな感じの工夫をつめこんで
 無事rubygemsへ公開となりました
68. 所感まとめ
69. この設計かっこいいな〜とか上っ面だけでなく、なぜその設計 にするのか？という背景を考えることは大事だなあという学び をえました gemの開発もサービスの開発と同じなのだなあ
70. 使う人が何をやりたいのかをとことん考えながら作れるので、
 上手に使える設計を考えついた時はパズルを解いた後みたい！ すごく楽しい！誰かの役にたったらさぞかし最&高だろうな〜
71. 普段の開発の中でgemにできないかな〜 と探していく気持ちをすっかり忘れていたので これからはどんどんgemチャンス掴んでいくぞ