![stores = client.stores({:area => ['76227', 50]}).products({:salePrice => {'$gt' => 3000}}).fetch.stores](https://image.slidesharecdn.com/json-100828202446-phpapp01/75/json-and-the-apinauts-26-2048.jpg?cb=1667953157)
![Method chaining
stores = client.stores({:area => ['76227', 50]}).products({:salePrice => {'$gt' => 3000}}).fetch.stores](https://image.slidesharecdn.com/json-100828202446-phpapp01/75/json-and-the-apinauts-27-2048.jpg?cb=1667953157)
![Weary
declare "foo" do |r|
r.url = "path/to/foo"
r.via = :post
r.requires = [:id, :bar]
r.with = [:blah] becomes
r.authenticates = false
r.follows = false
r.headers = {'Accept' => 'text/html'}
end
client.foo :id => 123, :bar => 'baz'](https://image.slidesharecdn.com/json-100828202446-phpapp01/75/json-and-the-apinauts-60-2048.jpg?cb=1667953157)
![ShamRack
ShamRack.at("sinatra.xyz").sinatra do
get "/hello/:subject" do
"Hello, #{params[:subject]}"
end
end
open("http://sinatra.xyz/hello/
stranger").read
#=> "Hello, stranger"](https://image.slidesharecdn.com/json-100828202446-phpapp01/75/json-and-the-apinauts-78-2048.jpg?cb=1667953157)
JSON and the APInauts
•25 gefällt mir•5,091 views
Melden
Teilen
Downloaden Sie, um offline zu lesen
Guide to writing great API wrappers in Ruby.
Más contenido relacionado
Was ist angesagt?
Was ist angesagt?(20)
Destacado
Destacado(20)
Similar a JSON and the APInauts
Similar a JSON and the APInauts(20)
Más de Wynn Netherland
Más de Wynn Netherland(9)
Último
Último(20)
JSON and the APInauts
- 1. API JSON AND THE ARGONAUTS WYNNNETHERLAND
- 2. whoami
- 3. +
- 5. A lot of API wrappers! I write API wrappers
- 6. & more!
- 7. Why create API wrappers?
- 8. After all, we have
- 9. curl
- 11. Net::HTTP
- 12. url = "http://api.twitter.com/1/users/show.json?screen_name=pengwynn" Net::HTTP.get(URI.parse(url))
- 13. Because we're Rubyists, and we want
- 14. Idiomatic access
- 15. {"chart":{ "issueDate":2006-03-04, "description":"Chart", "chartItems":{ "firstPosition":1, "totalReturned":15, "totalRecords":25663, "chartItem":[{ "songName":"Lonely Runs Both Ways", "artistName":"Alison Krauss + Union Station", "peek":1, "catalogNo":"610525", "rank":1, "exrank":1, "weeksOn":65, "albumId":655684, ... }}
- 16. {"chart":{ "issueDate":2006-03-04, "description":"Chart", "chartItems":{ "firstPosition":1, "totalReturned":15, "totalRecords":25663, "chartItem":[{ "songName":"Lonely Runs Both Ways", "artistName":"Alison Krauss + Union Station", "peek":1, "catalogNo":"610525", "rank":1, "exrank":1, "weeksOn":65, "albumId":655684, ... }}
- 17. Rubyified keys
- 18. {"chart":{ "issueDate":2006-03-04, "description":"Chart", "chartItems":{ "firstPosition":1, "totalReturned":15, "totalRecords":25663, "chartItem":[{ "songName":"Lonely Runs Both Ways", "artistName":"Alison Krauss + Union Station", "peek":1, "catalogNo":"610525", "rank":1, "exrank":1, "weeksOn":65, "albumId":655684, ... }}
- 19. {"chart":{ "issue_date":2006-03-04, "description":"Chart", "chart_items":{ "first_position":1, "total_returned":15, "total_records":25663, "chart_item":[{ "song_name":"Lonely Runs Both Ways", "artist_name":"Alison Krauss + Union Station", "peek":1, "catalog_no":"610525", "rank":1, "exrank":1, "weeks_on":65, "album_id":655684, ... }}
- 20. ... and method names
- 21. # Retrieve the details about a user by email # # +email+ (Required) # The email of the user to look within. To run getInfoByEmail on multiple addresses, simply pass a comma-separated list of valid email addresses. # def self.info_by_email(email) email = email.join(',') if email.is_a?(Array) Mash.new(self.get('/', ! ! :query => { ! ! ! :method => 'user.getInfoByEmail', ! ! ! :email => email }.merge(Upcoming.default_options))).rsp.user end
- 22. # Retrieve the details about a user by email # # +email+ (Required) # The email of the user to look within. To run getInfoByEmail on multiple addresses, simply pass a comma-separated list of valid email addresses. # More Ruby like th an def self.info_by_email(email) email = email.join(',') if email.is_a?(Array) Mash.new(self.get('/', ! ! :query => { ! ! ! :method => 'user.getInfoByEmail', ! ! ! :email => email }.merge(Upcoming.default_options))).rsp.user end
- 23. SYNTACTIC SUGAR
- 26. stores = client.stores({:area => ['76227', 50]}).products({:salePrice => {'$gt' => 3000}}).fetch.stores
- 27. Method chaining stores = client.stores({:area => ['76227', 50]}).products({:salePrice => {'$gt' => 3000}}).fetch.stores
- 28. client.statuses.update.json! :status => 'this status is from grackle'
- 29. Method chaining Bang for POST client.statuses.update.json! :status => 'this status is from grackle'
- 30. APPROACHES
- 31. Simple Wrapping
- 32. SOME TWITTER EXAMPLES Twitter Auth from @mbleigh Wrapping user.twitter.post( '/statuses/update.json', 'status' => 'Tweet, tweet!' ) Wrapping... with style Grackle from @hayesdavis client.statuses.update.json! :status => 'Tweet, tweet!' Abstraction Twitter from @jnunemaker client.update('Tweet, tweet!')
- 33. Why simply wrap?
- 36. Why abstract?
- 37. ...or writing APIs to wrap APIs
- 38. Simplify a complex API
- 39. Provide a business domain
- 40. TOOLS
- 41. Transports
- 42. Net::HTTP
- 46. Parsers
- 47. Crack http://github.com/jnunemaker/crack Puts the party in HTTParty
- 48. JSON
- 52. HTTParty http://github.com/jnunemaker/httparty When you HTTParty, you must party hard!
- 53. HTTParty - Ruby module - GET, POST, PUT, DELETE - basic_auth, base_uri, default_params, etc. - Net::HTTP for transport - Crack parses JSON and XML
- 54. HTTParty class Delicious include HTTParty base_uri 'https://api.del.icio.us/v1' def initialize(u, p) @auth = {:username => u, :password => p} end ... def recent(options={}) options.merge!({:basic_auth => @auth}) self.class.get('/posts/recent', options) end ...
- 55. monster_mash http://github.com/dbalatero/monster_mash HTTParty for Typhoeus, a monster. Get it?
- 57. RestClient - Simple DSL - ActiveResource support - Built-in shell RestClient.post( ! 'http://example.com/resource', :param1 => 'one', :nested => { :param2 => 'two' } )
- 59. Weary - Simple DSL - Specify required, optional params - Async support
- 60. Weary declare "foo" do |r| r.url = "path/to/foo" r.via = :post r.requires = [:id, :bar] r.with = [:blah] becomes r.authenticates = false r.follows = false r.headers = {'Accept' => 'text/html'} end client.foo :id => 123, :bar => 'baz'
- 62. RackClient - Rack API - Middleware! client = Rack::Client.new('http:// whoismyrepresentative.com')
- 64. Faraday - Rack-like - Middleware! - Adapters
- 65. Faraday url = 'http://api.twitter.com/1' conn = Faraday::Connection.new(:url => url ) do |builder| builder.adapter Faraday.default_adapter builder.use Faraday::Response::MultiJson builder.use Faraday::Response::Mashify end resp = conn.get do |req| req.url '/users/show.json', :screen_name => 'pengwynn' end u = resp.body u.name # => "Wynn Netherland"
- 67. Faraday Middleware - Hashie - Multi JSON - OAuth, OAuth2 as needed
- 68. My current stack - Faraday - Faraday Middleware - Hashie - Multi JSON - OAuth, OAuth2 as needed
- 69. Hashie - Mash - Dash - Trash - Clash
- 71. HTTPScoop
- 72. If you have an iOS app, you have an API ;-) Charles Proxy
- 73. Testing
- 76. Artifice http://github.com/wycats/artifice Artifice.activate_with(rack_endpoint) do # make some requests using Net::HTTP end a @wycats joint
- 78. ShamRack ShamRack.at("sinatra.xyz").sinatra do get "/hello/:subject" do "Hello, #{params[:subject]}" end end open("http://sinatra.xyz/hello/ stranger").read #=> "Hello, stranger"
- 79. ShamRack Rack 'em up! ShamRack.at("rackup.xyz").rackup do use Some::Middleware use Some::Other::Middleware run MyApp.new end
- 80. Authentication
- 81. Basic