songkick-transport 0.1.0

data/spec/songkick/transport/response_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Songkick::Transport::Response do
+  def process(*args)
+    Songkick::Transport::Response.process(*args)
+  end
+  
+  describe "200 with a body" do
+    let(:response) { process("", 200, {}, '{"hello":"world"}') }
+    
+    it "is an OK" do
+      response.should be_a(Songkick::Transport::Response::OK)
+    end
+    
+    it "exposes its data" do
+      response.data.should == {"hello" => "world"}
+    end
+  end
+  
+  describe "200 with a body with an empty line in it" do
+    let(:response) { process("", 200, {}, "{\"hello\":\"world\"\n\n}") }
+    
+    it "is an OK" do
+      response.should be_a(Songkick::Transport::Response::OK)
+    end
+    
+    it "exposes its data" do
+      response.data.should == {"hello" => "world"}
+    end
+  end
+  
+  describe "200 with a parsed body" do
+    let(:response) { process("", 200, {}, {"hello" => "world"}) }
+    
+    it "exposes its data" do
+      response.data.should == {"hello" => "world"}
+    end
+  end
+  
+  describe "200 with an empty body" do
+    let(:response) { process("", 200, {}, "") }
+    
+    it "exposes its data" do
+      response.data.should be_nil
+    end
+  end
+  
+  describe "201 with an empty body" do
+    let(:response) { process("", 201, {}, "") }
+    
+    it "is a Created" do
+      response.should be_a(Songkick::Transport::Response::Created)
+    end
+  end
+  
+  describe "204 with an empty body" do
+    let(:response) { process("", 204, {}, "") }
+    
+    it "is a NoContent" do
+      response.should be_a(Songkick::Transport::Response::NoContent)
+    end
+  end
+  
+  describe "409 with a body" do
+    let(:response) { process("", 409, {}, '{"errors":[]}') }
+    
+    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

@@ -0,0 +1,189 @@
+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
+    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 "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 => :bar}}
+      end
+      
+      let :expected_response do
+        {
+          "filename" => "songkick.png",
+          "method"   => @http_method,
+          "size"     => 6694,
+          "foo"      => "bar"
+        }
+      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
+    end
+  end
+  
+  describe Songkick::Transport::Curb do
+    let(:endpoint)  { "http://localhost:4567" }
+    let(:transport) { Songkick::Transport::Curb.new(endpoint) }
+    it_should_behave_like "transport"
+  end
+  
+  describe Songkick::Transport::HttParty do
+    let(:endpoint)  { "http://localhost:4567" }
+    let(:transport) { Songkick::Transport::HttParty.new(endpoint) }
+    it_should_behave_like "transport"
+  end
+  
+  describe Songkick::Transport::RackTest do
+    let(:endpoint)  { TestApp }
+    let(:transport) { Songkick::Transport::RackTest.new(endpoint) }
+    it_should_behave_like "transport"
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,72 @@
+require 'rubygems'
+require File.expand_path('../../lib/songkick/transport', __FILE__)
+
+require 'logger'
+require 'sinatra'
+require 'thin'
+
+Thin::Logging.silent = true
+Songkick::Transport.logger = Logger.new(StringIO.new)
+
+class TestApp < Sinatra::Base
+  before do
+    headers 'Content-Type' => 'application/json'
+  end
+  
+  get('/')  { Yajl::Encoder.encode(params) }
+  post('/') { Yajl::Encoder.encode(params) }
+  
+  get '/invalid' do
+    '}'
+  end
+  
+  get '/authenticate' do
+    env['HTTP_AUTHORIZATION'] ?
+        Yajl::Encoder.encode('successful' => true) :
+        Yajl::Encoder.encode('successful' => false)
+  end
+  
+  get '/artists/:id' do
+    Yajl::Encoder.encode('id' => params[:id].to_i)
+  end
+  
+  post '/artists' do
+    Yajl::Encoder.encode('id' => 'new', 'name' => params[:name].upcase)
+  end
+  
+  put '/artists/:id' do
+    name = params[:name] || CGI.parse(env['rack.input'].read)['name'].first || ''
+    Yajl::Encoder.encode('id' => params[:id].to_i, 'name' => name.downcase)
+  end
+  
+  %w[post put].each do |verb|
+    __send__(verb, '/upload') do
+      c = params[:concert]
+      Yajl::Encoder.encode(
+        "filename" => c[:file][:filename],
+        "method"   => verb,
+        "size"     => c[:file][:tempfile].size,
+        "foo"      => c[:foo]
+      )
+    end
+  end
+  
+  def self.ensure_reactor_running
+    Thread.new { EM.run } unless EM.reactor_running?
+    Thread.pass until EM.reactor_running?
+  end
+  
+  def self.listen(port)
+    ensure_reactor_running
+    thin = Rack::Handler.get('thin')
+    app  = Rack::Lint.new(self)
+    thin.run(app, :Port => port) { |s| @server = s }
+  end
+  
+  def self.stop
+    @server.stop
+    sleep 0.1
+  rescue
+  end
+end
+

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: songkick-transport
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- James Coglan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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
+    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: sinatra
+  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: thin
+  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'
+description: 
+email: james@songkick.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- examples/tcp_server.rb
+- examples/loop.rb
+- examples/thread_safety.rb
+- examples/server.rb
+- examples/example.rb
+- lib/songkick/transport/request.rb
+- lib/songkick/transport/rack_test.rb
+- lib/songkick/transport/timeout_decorator.rb
+- lib/songkick/transport/httparty.rb
+- lib/songkick/transport/serialization.rb
+- lib/songkick/transport/http_error.rb
+- lib/songkick/transport/headers.rb
+- lib/songkick/transport/response.rb
+- lib/songkick/transport/upstream_error.rb
+- lib/songkick/transport/curb.rb
+- lib/songkick/transport/header_decorator.rb
+- lib/songkick/transport/reporting.rb
+- lib/songkick/transport/base.rb
+- lib/songkick/transport.rb
+- spec/songkick/transport_spec.rb
+- spec/songkick/transport/response_spec.rb
+- spec/songkick/transport/httparty_spec.rb
+- spec/songkick/transport/request_spec.rb
+- spec/songkick/transport/curb_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/songkick/transport
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: HTTP client abstraction for service clients
+test_files: []