Building API clients with Cistern

@nwrug - github.com/lanej/cistern

Transcript

1. BUILDING API CLIENTS WITH CISTERN
2. @adamholt
3. @lanejoshlane
4. WHAT IS CISTERN?
5. “Cistern helps you consistently build your API clients and facilitates building mock support.”
7. SERVICE
8. class Twitter::Client < Cistern::Service ! model_path "twitter/models" request_path "twitter/requests" ! model :tweet collection :tweets request :create_tweet ! class Real def initialize(options={}) # Setup end end ! class Mock def self.data; @data ||= {}; end ! def initialize(options={}) # Setup Mock Data end end end
9. class Twitter::Client < Cistern::Service model_path "twitter/models" request_path "twitter/requests" ! ... end
10. class Twitter::Client < Cistern::Service ... ! model :tweet collection :tweets request :create_tweet ! ... end
11. class Twitter::Client < Cistern::Service ... ! class Real def initialize(options={}) # Setup end end ! class Mock def self.data; @data ||= {}; end ! def initialize(options={}) # Setup Mock Data end end end
12. MODELS
13. class Twitter::Client::Tweet < Cistern::Model identity :id ! attribute :user, type: :hash attribute :tweet, type: :array ! def retweet requires :id ! new_attributes = connection.retweet_tweet(id: id).body merge_attributes(new_attributes) end end !
14. COLLECTIONS
15. class Twitter::Client::Tweets < Cistern::Collection ! model Twitter::Client::Tweet ! def timeline(params = {}) response = connection.get_tweets(params) ! data = self.clone.load(response.body) ! collection.attributes.clear collection.merge_attributes(data) end ! def retweets(params={}) response = connection.get_retweets(params) ... end ! def get(id) new(connection.get_tweet("id" => id).body) end end
16. REQUESTS
17. module Twitter class Client class Real def create_tweet(options={}) request( :body => {status: options[:body]}, :method => :post, :path => '/statuses/update' ) end end # Real ! ... end # Client end # Twitter
18. module Twitter class Client ... ! class Mock def create_tweet(options={}) id = Foo.random_hex(6) ! tweet = { "id" => id, "text" => "Hello from @NWRUG", "user" => {"name": "omgitsads"}, }.merge(options) ! self.data[:tweets][id]= tweet ! response( :body => tweet, :status => 200, :path => '/statuses/user_timeline.json', ) end end # Mock end # Client end # Twitter
19. DRAWBACKS
20. QUESTIONS?