songkick-transport 0.1.6 → 0.2.0

data/README.rdoc

@@ -10,7 +10,8 @@ and serialization details. It transparently deals with parameter serialization,
 including the following:
 
 * Correctly CGI-escaping any data you pass in
-* Nested parameters, e.g. <tt>'foo' => {'bar' => 'qux'}</tt>
+* Nested parameters, e.g. <tt>'foo' => {'a' => 'b', 'c' => 'd'}</tt> becomes
+  <tt>foo[a]=b&foo[c]=d</tt>
 * File uploads and multipart requests
 * Entity body for POST/PUT, query string for everything else
 
@@ -20,7 +21,9 @@ We currently support three backends:
 * Talking HTTP with {HTTParty}[http://httparty.rubyforge.org/]
 * Talking directly to a {Rack}[http://rack.rubyforge.org/] app with Rack::Test
 
-It is assumed all service applications speak JSON as their serialization format.
+If the service you're talking to returns <tt>Content-Type: application/json</tt>,
+we automatically parse the response for you. You can register parsers for other
+content types as described below.
 
 
 == Using the transports
@@ -31,6 +34,7 @@ exposes some JSON:
     require 'sinatra'
     
     get '/ohai' do
+      headers 'Content-Type' => 'application/json'
       '{"hello":"world"}'
     end
 
@@ -63,8 +67,9 @@ takes a reference to a Rack application, for example:
 
 All transports expose exactly the same instance methods.
 
-The client supports the +get+, +post+, +put+, +delete+ and +head+ methods,
-which all take a path and an optional +Hash+ of parameters, for example:
+The client supports the +delete+, +get+, +head+, +patch+, +post+, +put+ and
++options+ methods, which all take a path and an optional +Hash+ of parameters,
+for example:
 
     client.post('/users', :username => 'bob', :password => 'foo')
 
@@ -94,10 +99,10 @@ This library was primarily developed to talk to Songkick's backend services, and
 as such adopts some conventions that put it at a higher level of abstraction
 than a vanilla HTTP client.
 
-It assumes successful responses will all contain JSON data. A response object
-has the following properties:
+A response object has the following properties:
 
-* +data+ -- the result of parsing the body as JSON
+* +body+ -- the raw response body
+* +data+ -- the result of parsing the body according to its content-type
 * +headers+ -- a read-only hash-like object containing response headers
 * +status+ -- the response's status code
 
@@ -127,6 +132,17 @@ If the request raises an exception, it will be of one of the following types:
   non-successful status code, e.g. 404 or 500
 
 
+=== Registering response parsers
+
+<tt>Songkick::Transport</tt> automatically sets <tt>response.data</tt> if the
+content-type of the response is <tt>application/json</tt>. You can register
+parsers for other content-types like so:
+
+    Songkick::Transport.register_parser('application/yaml', YAML)
+
+The parser object you register must respond to <tt>parse(string)</tt>.
+
+
 === Nested parameters
 
 All transports support serialization of nested parameters, for example you can
@@ -297,7 +313,7 @@ the total time spent calling backend services during the block.
 
 The MIT License
 
-Copyright (c) 2012 Songkick
+Copyright (c) 2012-2013 Songkick
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/lib/songkick/transport.rb

@@ -9,7 +9,7 @@ module Songkick
     DEFAULT_TIMEOUT = 5
     DEFAULT_FORMAT  = :json
     
-    HTTP_VERBS    = %w[get post put delete head]
+    HTTP_VERBS    = %w[options head get patch post put delete]
     USE_BODY      = %w[post put]
     FORM_ENCODING = 'application/x-www-form-urlencoded'
     
@@ -33,6 +33,21 @@ module Songkick
     autoload :ConnectionFailedError,ROOT + '/transport/upstream_error'
     autoload :InvalidJSONError,     ROOT + '/transport/upstream_error'
     autoload :HttpError,            ROOT + '/transport/http_error'
+
+    def self.regsiter_parser(content_type, parser)
+      @parsers ||= {}
+      @parsers[content_type] = parser
+    end
+
+    def self.parser_for(content_type)
+      parser = @parsers && @parsers[content_type]
+      unless parser
+        raise TypeError, "Could not find a parser for content-type: #{content_type}"
+      end
+      parser
+    end
+
+    regsiter_parser 'application/json', Yajl::Parser
     
     IO = UploadIO
     

data/lib/songkick/transport/base.rb

@@ -41,7 +41,7 @@ module Songkick
       def headers
         Headers.new(
           'Connection' => 'close',
-          'User-Agent' => user_agent || ''
+          'User-Agent' => user_agent
         )
       end
       

data/lib/songkick/transport/curb.rb

@@ -53,7 +53,7 @@ module Songkick
         if req.use_body?
           connection.__send__("http_#{req.verb}", req.body)
         else
-          connection.__send__("http_#{req.verb}")
+          connection.http(req.verb.upcase)
         end
 
         process(req, connection.response_code, response_headers, connection.body_str)

data/lib/songkick/transport/headers.rb

@@ -19,6 +19,7 @@ module Songkick
       def initialize(hash = {})
         @hash = {}
         hash.each do |key, value|
+          next if value.nil?
           @hash[self.class.normalize(key)] = value
         end
       end

data/lib/songkick/transport/response.rb

@@ -16,16 +16,20 @@ module Songkick
         Transport.logger.warn "Request returned invalid JSON: #{request}"
         raise Transport::InvalidJSONError, request
       end
+
+      def self.parse(body, content_type)
+        return body unless body.is_a?(String)
+        return nil if body.strip == ''
+
+        content_type = (content_type || '').split(/\s*;\s*/).first
+        Transport.parser_for(content_type).parse(body)
+      end
       
-      attr_reader :data, :headers, :status
+      attr_reader :body, :data, :headers, :status
       
       def initialize(status, headers, body)
-        @data = if body.is_a?(String)
-                  body.strip == '' ? nil : Yajl::Parser.parse(body)
-                else
-                  body
-                end
-        
+        @body    = body
+        @data    = Response.parse(body, headers['Content-Type'])
         @headers = Headers.new(headers)
         @status  = status.to_i
       end

data/spec/songkick/transport/curb_spec.rb

@@ -17,7 +17,7 @@ module Songkick
           @headers = {}
         end
         
-        def http_get
+        def http(verb)
           raise(@error, "bang") if @error
         end
         
@@ -57,4 +57,4 @@ module Songkick
     end
     
   end
-end
+end

data/spec/songkick/transport/response_spec.rb

@@ -6,7 +6,7 @@ describe Songkick::Transport::Response do
   end
   
   describe "200 with a body" do
-    let(:response) { process("", 200, {}, '{"hello":"world"}') }
+    let(:response) { process("", 200, {"Content-Type" => "application/json; charset=utf-8"}, '{"hello":"world"}') }
     
     it "is an OK" do
       response.should be_a(Songkick::Transport::Response::OK)
@@ -18,7 +18,7 @@ describe Songkick::Transport::Response do
   end
   
   describe "200 with a body with an empty line in it" do
-    let(:response) { process("", 200, {}, "{\"hello\":\"world\"\n\n}") }
+    let(:response) { process("", 200, {"Content-Type" => "application/json"}, "{\"hello\":\"world\"\n\n}") }
     
     it "is an OK" do
       response.should be_a(Songkick::Transport::Response::OK)
@@ -30,7 +30,7 @@ describe Songkick::Transport::Response do
   end
   
   describe "200 with a parsed body" do
-    let(:response) { process("", 200, {}, {"hello" => "world"}) }
+    let(:response) { process("", 200, {"Content-Type" => "application/json"}, {"hello" => "world"}) }
     
     it "exposes its data" do
       response.data.should == {"hello" => "world"}
@@ -62,7 +62,7 @@ describe Songkick::Transport::Response do
   end
   
   describe "409 with a body" do
-    let(:response) { process("", 409, {}, '{"errors":[]}') }
+    let(:response) { process("", 409, {"Content-Type" => "application/json"}, '{"errors":[]}') }
     
     it "is a UserError" do
       response.should be_a(Songkick::Transport::Response::UserError)

data/spec/songkick/transport_spec.rb

@@ -66,6 +66,13 @@ describe Songkick::Transport do
       end
     end
     
+    describe :options do
+      it "sends an OPTIONS request" do
+        response = transport.options("/.well-known/host-meta")
+        response.headers["Access-Control-Allow-Methods"].should == "GET, PUT, DELETE"
+      end
+    end
+
     describe :post do
       it "sends data using POST" do
         data = transport.post("/artists", :name => "Amon Tobin").data

data/spec/spec_helper.rb

@@ -29,6 +29,11 @@ class TestApp < Sinatra::Base
   get '/artists/:id' do
     Yajl::Encoder.encode('id' => params[:id].to_i)
   end
+
+  options '/.well-known/host-meta' do
+    headers 'Access-Control-Allow-Methods' => 'GET, PUT, DELETE'
+    ''
+  end
   
   post '/artists' do
     Yajl::Encoder.encode('id' => 'new', 'name' => params[:name].upcase)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: songkick-transport
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -91,22 +91,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement