songkick-transport 0.2.2 → 1.2.0

data/lib/songkick/transport/serialization.rb

@@ -1,18 +1,18 @@
 module Songkick
   module Transport
     module Serialization
-      
+
       extend self
-      
+
       SANITIZED_VALUE = '[REMOVED]'
-      
+
       def build_url(verb, host, path, params, scrub=false)
         url = host + path
         return url if USE_BODY.include?(verb)
         qs  = build_query_string(params, true, scrub)
         url + (qs == '' ? '' : '?' + qs)
       end
-      
+
       def build_query_string(params, fully_encode = true, sanitize = false)
         return params if String === params
         pairs = []
@@ -21,7 +21,7 @@ module Songkick
           pairs << [key, value]
         end
         if fully_encode
-          pairs.map { |p| p.join('=') }.join('&') 
+          pairs.map { |p| p.join('=') }.join('&')
         else
           pairs.inject({}) do |hash, pair|
             hash[pair.first] = pair.last
@@ -29,7 +29,7 @@ module Songkick
           end
         end
       end
-      
+
       def each_qs_param(prefix, value, fully_encode = true, &block)
         case value
         when Array
@@ -47,7 +47,7 @@ module Songkick
           block.call(prefix, encoded)
         end
       end
-      
+
       def multipart?(params)
         case params
         when Hash  then params.any? { |k,v| multipart? v }
@@ -55,25 +55,25 @@ module Songkick
         else Transport::IO === params
         end
       end
-      
+
       def sanitize?(key)
         Transport.sanitized_params.any? { |param| param === key }
       end
-      
+
       def serialize_multipart(params, boundary = Multipartable::DEFAULT_BOUNDARY)
         params = build_query_string(params, false)
-        
+
         parts = params.map { |k,v| Parts::Part.new(boundary, k, v) }
         parts << Parts::EpiloguePart.new(boundary)
         ios = parts.map { |p| p.to_io }
-        
+
         {
           :content_type   => "multipart/form-data; boundary=#{boundary}",
           :content_length => parts.inject(0) { |sum,i| sum + i.length }.to_s,
           :body           => CompositeReadIO.new(*ios).read
         }
       end
-      
+
     end
   end
 end

data/lib/songkick/transport/service.rb

@@ -0,0 +1,89 @@
+module Songkick
+  module Transport
+    class Service
+      def self.endpoint(name)
+        @endpoint_name = name.to_s
+      end
+
+      def self.timeout(value)
+        @timeout = value
+      end
+
+      def self.user_agent(value)
+        @user_agent = value
+      end
+
+      def self.transport_layer(value)
+        @transport_layer = value
+      end
+
+      def self.stub_transport(stub)
+        @stub_transport = stub
+      end
+
+      def self.set_endpoints(hash)
+        unless self == Songkick::Transport::Service
+          raise "set_endpoints only on Songkick::Transport::Service"
+        end
+        @endpoints = hash
+      end
+
+      def self.ancestor
+        self.ancestors.select {|a| a.respond_to?(:get_user_agent)}[1]
+      end
+
+      def self.get_endpoint_name
+        @endpoint_name || (ancestor && ancestor.get_endpoint_name)
+      end
+
+      def self.get_timeout
+        @timeout || (ancestor && ancestor.get_timeout) || 10
+      end
+
+      def self.get_user_agent
+        @user_agent || (ancestor && ancestor.get_user_agent)
+      end
+
+      def self.get_endpoints
+        @endpoints || {}
+      end
+
+      def self.get_transport_layer
+        @transport_layer || (ancestor && ancestor.get_transport_layer) || Songkick::Transport::Curb
+      end
+
+      def self.get_stub_transport
+        @stub_transport || (ancestor && ancestor.get_stub_transport) || nil
+      end
+
+      def self.new_transport
+        unless name = get_endpoint_name
+          raise "no endpoint specified for #{self}, call endpoint 'foo' inside #{self}"
+        end
+        unless endpoint = Service.get_endpoints[name]
+          raise "can't find endpoint for '#{name}', should have called Songkick::Transport::Service.set_endpoints"
+        end
+        unless user_agent = get_user_agent
+          raise "no user agent specified for #{self}, call user_agent 'foo' inside #{self} or on Songkick::Transport::Service"
+        end
+        get_stub_transport || get_transport_layer.new(endpoint, :user_agent => user_agent, 
+                                                                :timeout    => get_timeout)
+      end
+
+      def http
+        @http ||= self.class.new_transport
+      end
+
+      def stub_transport(http)
+        @http = http
+      end
+
+      def rescue_404(response=nil)
+        yield
+      rescue Songkick::Transport::HttpError => e
+        e.status == 404 ? response : (raise e)
+      end
+
+    end
+  end
+end

data/spec/songkick/transport/response_spec.rb

@@ -72,5 +72,17 @@ describe Songkick::Transport::Response do
       response.errors.should == []
     end
   end
+
+  describe "422 with customer user error codes" do
+    let(:response) { process("", 422, {"Content-Type" => "application/json"}, '{"errors":[]}', [409, 422]) }
+    
+    it "is a UserError" do
+      response.should be_a(Songkick::Transport::Response::UserError)
+    end
+    
+    it "exposes the errors" do
+      response.errors.should == []
+    end
+  end
 end
 

data/spec/songkick/transport_spec.rb

@@ -1,206 +1,219 @@
 require "spec_helper"
 
-describe Songkick::Transport do
-  shared_examples_for "transport" do
-    before { TestApp.listen(4567) }
-    after  { TestApp.stop }
-    
-    describe :get do
-      it "retrieves data using GET" do
-        transport.get("/artists/99").data.should == {"id" => 99}
-      end
-      
-      it "exposes the response headers" do
-        transport.get("/artists/99").headers["content-type"].should == "application/json"
-      end
-      
-      it "can send array params" do
-        transport.get("/", :list => %w[a b]).data.should == {"list" => ["a", "b"]}
-      end
-      
-      it "can send hash params" do
-        transport.get("/", :list => {:a => "b"}).data.should == {"list" => {"a" => "b"}}
-      end
-      
-      it "can send nested data structures" do
-        structure = {
-          "hash" => {"a" => {"b" => ["c", "d"], "e" => "f"}},
-          "lisp" => ["define", {"square" => ["x", "y"]}, "*", "x", "x"]
-        }
-        transport.get("/", structure).data.should == structure
-      end
-      
-      it "raises an UpstreamError for a nonexistent resource" do
-        lambda { transport.get("/nothing") }.should raise_error(Songkick::Transport::UpstreamError)
-      end
-      
-      it "raises an UpstreamError for a POST resource" do
-        lambda { transport.get("/artists") }.should raise_error(Songkick::Transport::UpstreamError)
-      end
-      
-      it "raises an UpstreamError for invalid JSON" do
-        lambda { transport.get("/invalid") }.should raise_error(Songkick::Transport::InvalidJSONError)
-      end
-    end
-    
-    describe :with_headers do
-      it "adds the given headers to requests" do
-        data = transport.with_headers("Authorization" => "correct password").get("/authenticate").data
-        data.should == {"successful" => true}
-      end
-      
-      it "reformats Rack-style headers" do
-        data = transport.with_headers("HTTP_AUTHORIZATION" => "correct password").get("/authenticate").data
-        data.should == {"successful" => true}
-      end
-      
-      it "does not affect requests made directly on the transport object" do
-        transport.with_headers("Authorization" => "correct password").get("/authenticate")
-        data = transport.get("/authenticate").data
-        data.should == {"successful" => false}
-      end
-      
-      it "can set Content-Type" do
-        data = transport.with_headers("Content-Type" => "application/json").post("/content").data
-        data.should == {"type" => "application/json"}
-      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.should == {"id" => "new", "name" => "AMON TOBIN"}
-      end
-      
-      it "can send array params" do
-        transport.post("/", :list => %w[a b]).data.should == {"list" => ["a", "b"]}
-      end
-      
-      it "can send hash params" do
-        transport.post("/", :list => {:a => "b"}).data.should == {"list" => {"a" => "b"}}
-      end
-
-      it "can send a raw body" do
-        response = transport.with_headers("Content-Type" => "text/plain").post("/process", "Hello, world!")
-        response.data.should == {"body" => "Hello, world!", "type" => "text/plain"}
-      end
-      
-      it "raises an UpstreamError for a PUT resource" do
-        lambda { transport.post("/artists/64") }.should raise_error(Songkick::Transport::UpstreamError)
-      end
-    end
-    
-    describe :put do
-      it "sends data using PUT" do
-        data = transport.put("/artists/64", :name => "Amon Tobin").data
-        data.should == {"id" => 64, "name" => "amon tobin"}
-      end
-      
-      it "raises an UpstreamError for a POST resource" do
-        lambda{transport.put("/artists")}.should raise_error(Songkick::Transport::UpstreamError)
-      end
-    end
-    
-    describe "file uploads" do
-      before do
-        pending if Songkick::Transport::RackTest === transport
-      end
-      
-      after { file.close }
-            
-      let(:file)   { File.open(File.expand_path("../../songkick.png", __FILE__)) }
-      let(:upload) { Songkick::Transport::IO.new(file, "image/jpeg", "songkick.png") }
-      
-      let :params do
-        {:concert => {:file => upload, :foo => "me@thing.com"}}
-      end
-      
-      let :expected_response do
-        {
-          "filename" => "songkick.png",
-          "method"   => @http_method,
-          "size"     => 6694,
-          "foo"      => "me@thing.com"
-        }
-      end
-      
-      it "uploads files using POST" do
-        @http_method = "post"
-        response = transport.post('/upload', params)
-        response.status.should == 200
-        response.data.should == expected_response
-      end
-      
-      it "uploads files using PUT" do
-        @http_method = "put"
-        response = transport.put('/upload', params)
-        response.status.should == 200
-        response.data.should == expected_response
-      end
-    end
-    
-    describe "reporting" do
-      before do
-        @report = Songkick::Transport.report
-      end
-      
-      it "executes a block and returns its value" do
-        @report.execute { transport.get("/artists/99").data }.should == {"id" => 99}
-      end
-      
-      it "reports a successful request" do
-        @report.execute { transport.get("/artists/99") }
-        @report.size.should == 1
-        
-        request = @report.first
-        request.endpoint.should == endpoint
-        request.http_method.should == "get"
-        request.path.should == "/artists/99"
-        request.response.data.should == {"id" => 99}
-      end
-      
-      it "reports a failed request" do
-        @report.execute { transport.get("/invalid") } rescue nil
-        @report.size.should == 1
-        
-        request = @report.first
-        request.http_method.should == "get"
-        request.path.should == "/invalid"
-        request.response.should == nil
-        request.error.should be_a(Songkick::Transport::InvalidJSONError)
-      end
-      it "reports the total duration" do
-        @report.execute { transport.get("/artists/99") }
-        request = @report.first
-        request.stub(:duration).and_return 3.14
-        @report.total_duration.should == 3.14
-      end
+shared_examples_for "Songkick::Transport" do
+  before(:all) { TestApp.listen(4567) }
+  after(:all)  { TestApp.stop }
+
+  describe :get do
+    it "retrieves data using GET" do
+      transport.get("/artists/99").data.should == {"id" => 99}
+    end
+
+    it "exposes the response headers" do
+      transport.get("/artists/99").headers["content-type"].should == "application/json"
+    end
+
+    it "can send array params" do
+      transport.get("/", :list => %w[a b]).data.should == {"list" => ["a", "b"]}
+    end
+
+    it "can send hash params" do
+      transport.get("/", :list => {:a => "b"}).data.should == {"list" => {"a" => "b"}}
+    end
+
+    it "can send nested data structures" do
+      structure = {
+        "hash" => {"a" => {"b" => ["c", "d"], "e" => "f"}},
+        "lisp" => ["define", {"square" => ["x", "y"]}, "*", "x", "x"]
+      }
+      transport.get("/", structure).data.should == structure
+    end
+
+    it "raises an UpstreamError for a nonexistent resource" do
+      lambda { transport.get("/nothing") }.should raise_error(Songkick::Transport::UpstreamError)
+    end
+
+    it "raises an UpstreamError for a POST resource" do
+      lambda { transport.get("/artists") }.should raise_error(Songkick::Transport::UpstreamError)
+    end
+
+    it "raises an UpstreamError for invalid JSON" do
+      lambda { transport.get("/invalid") }.should raise_error(Songkick::Transport::InvalidJSONError)
+    end
+  end
+
+  describe :with_headers do
+    it "adds the given headers to requests" do
+      data = transport.with_headers("Authorization" => "correct password").get("/authenticate").data
+      data.should == {"successful" => true}
+    end
+
+    it "reformats Rack-style headers" do
+      data = transport.with_headers("HTTP_AUTHORIZATION" => "correct password").get("/authenticate").data
+      data.should == {"successful" => true}
+    end
+
+    it "does not affect requests made directly on the transport object" do
+      transport.with_headers("Authorization" => "correct password").get("/authenticate")
+      data = transport.get("/authenticate").data
+      data.should == {"successful" => false}
+    end
+
+    it "can set Content-Type" do
+      data = transport.with_headers("Content-Type" => "application/json").post("/content").data
+      data.should == {"type" => "application/json"}
+    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.should == {"id" => "new", "name" => "AMON TOBIN"}
+    end
+
+    it "can send array params" do
+      transport.post("/", :list => %w[a b]).data.should == {"list" => ["a", "b"]}
+    end
+
+    it "can send hash params" do
+      transport.post("/", :list => {:a => "b"}).data.should == {"list" => {"a" => "b"}}
+    end
+
+    it "can send a raw body" do
+      response = transport.with_headers("Content-Type" => "text/plain").post("/process", "Hello, world!")
+      response.data.should == {"body" => "Hello, world!", "type" => "text/plain"}
+    end
+
+    it "raises an UpstreamError for a PUT resource" do
+      lambda { transport.post("/artists/64") }.should raise_error(Songkick::Transport::UpstreamError)
+    end
+  end
+
+  describe :put do
+    it "sends data using PUT" do
+      data = transport.put("/artists/64", :name => "Amon Tobin").data
+      data.should == {"id" => 64, "name" => "amon tobin"}
+    end
+
+    it "raises an UpstreamError for a POST resource" do
+      lambda{transport.put("/artists")}.should raise_error(Songkick::Transport::UpstreamError)
     end
   end
-  
-  describe Songkick::Transport::Curb do
-    let(:endpoint)  { "http://localhost:4567" }
-    let(:transport) { Songkick::Transport::Curb.new(endpoint) }
-    it_should_behave_like "transport"
+
+  describe "file uploads" do
+    before do
+      pending if Songkick::Transport::RackTest === transport
+    end
+
+    after { file.close }
+
+    let(:file)   { File.open(File.expand_path("../../songkick.png", __FILE__)) }
+    let(:upload) { Songkick::Transport::IO.new(file, "image/jpeg", "songkick.png") }
+
+    let :params do
+      {:concert => {:file => upload, :foo => "me@thing.com"}}
+    end
+
+    let :expected_response do
+      {
+        "filename" => "songkick.png",
+        "method"   => @http_method,
+        "size"     => 6694,
+        "foo"      => "me@thing.com"
+      }
+    end
+
+    it "uploads files using POST" do
+      @http_method = "post"
+      response = transport.post('/upload', params)
+      response.status.should == 200
+      response.data.should == expected_response
+    end
+
+    it "uploads files using PUT" do
+      @http_method = "put"
+      response = transport.put('/upload', params)
+      response.status.should == 200
+      response.data.should == expected_response
+    end
   end
-  
-  describe Songkick::Transport::HttParty do
-    let(:endpoint)  { "http://localhost:4567" }
-    let(:transport) { Songkick::Transport::HttParty.new(endpoint) }
-    it_should_behave_like "transport"
+
+  describe "reporting" do
+    before do
+      Songkick::Transport::Reporting.start
+      @report = Songkick::Transport.report
+    end
+
+    it "executes a block and returns its value" do
+      @report.execute { transport.get("/artists/99").data }.should == {"id" => 99}
+    end
+
+    it "reports a successful request" do
+      @report.execute { transport.get("/artists/99") }
+      @report.size.should == 1
+
+      request = @report.first
+      request.endpoint.should == endpoint
+      request.http_method.should == "get"
+      request.path.should == "/artists/99"
+      request.response.data.should == {"id" => 99}
+    end
+
+    it "reports a failed request" do
+      @report.execute { transport.get("/invalid") } rescue nil
+      @report.size.should == 1
+
+      request = @report.first
+      request.http_method.should == "get"
+      request.path.should == "/invalid"
+      request.response.should == nil
+      request.error.should be_a(Songkick::Transport::InvalidJSONError)
+    end
+
+    it "reports the total duration" do
+      @report.execute { transport.get("/artists/99") }
+      request = @report.first
+      request.stub(:duration).and_return 3.14
+      @report.total_duration.should == 3.14
+    end
   end
-  
-  describe Songkick::Transport::RackTest do
-    let(:endpoint)  { TestApp }
-    let(:transport) { Songkick::Transport::RackTest.new(endpoint) }
-    it_should_behave_like "transport"
+
+  describe "error_status_codes" do
+    let(:codes) { [409, 422] }
+
+    it "can be provided on initialization" do
+      transport = described_class.new(endpoint, :user_error_codes => codes)
+      transport.user_error_codes.should == codes
+    end
+
+    it "default to 409" do
+      transport.user_error_codes.should == [409]
+    end
   end
 end
 
+describe Songkick::Transport::Curb do
+  let(:endpoint)  { "http://localhost:4567" }
+  let(:transport) { Songkick::Transport::Curb.new(endpoint) }
+  it_should_behave_like "Songkick::Transport"
+end
+
+describe Songkick::Transport::HttParty do
+  let(:endpoint)  { "http://localhost:4567" }
+  let(:transport) { Songkick::Transport::HttParty.new(endpoint) }
+  it_should_behave_like "Songkick::Transport"
+end
+
+describe Songkick::Transport::RackTest do
+  let(:endpoint)  { TestApp }
+  let(:transport) { Songkick::Transport::RackTest.new(endpoint) }
+  it_should_behave_like "Songkick::Transport"
+end
+