springboard-retail 4.0.0

data/spec/springboard/client_spec.rb

@@ -0,0 +1,214 @@
+require 'spec_helper'
+
+describe Springboard::Client do
+  include_context "client"
+
+  describe "session" do
+    it "should be a Patron::Session" do
+      client.session.should be_a Patron::Session
+    end
+  end
+
+  describe "auth" do
+    it "should attempt to authenticate with the given username and password" do
+      request_stub = stub_request(:post, "#{base_url}/auth/identity/callback").with \
+        :body => "auth_key=coco&password=boggle",
+        :headers => {'Content-Type' => 'application/x-www-form-urlencoded'}
+      client.auth(:username => 'coco', :password => 'boggle')
+      request_stub.should have_been_requested
+    end
+
+    it "should raise an exception if called without username or password" do
+      lambda { client.auth }.should raise_error("Must specify :username and :password")
+      lambda { client.auth(:username => 'x') }.should raise_error("Must specify :username and :password")
+      lambda { client.auth(:password => 'y') }.should raise_error("Must specify :username and :password")
+    end
+
+    it "should return true if auth succeeds" do
+      stub_request(:post, "#{base_url}/auth/identity/callback").to_return(:status => 200)
+      lambda { client.auth(:username => 'someone', :password => 'right') }.should be_true
+    end
+
+    it "should raise an AuthFailed if auth fails" do
+      stub_request(:post, "#{base_url}/auth/identity/callback").to_return(:status => 401)
+      lambda { client.auth(:username => 'someone', :password => 'wrong') }.should \
+        raise_error(Springboard::Client::AuthFailed, "Springboard auth failed")
+    end
+  end
+
+  describe "initialize" do
+    it "should call configure_session" do
+      Springboard::Client.any_instance.should_receive(:configure_session).with(base_url, {:x => 'y'})
+      Springboard::Client.new(base_url, :x => 'y')
+    end
+  end
+
+  describe "configure_session" do
+    it "should set the session's base_url" do
+      session.should_receive(:base_url=).with(base_url)
+      client.__send__(:configure_session, base_url, :x => 'y')
+    end
+
+    it "should enable cookies" do
+      session.should_receive(:handle_cookies)
+      client.__send__(:configure_session, base_url, :x => 'y')
+    end
+
+    it "should allow setting insecure on the session" do
+      session.should_receive(:insecure=).with(true)
+      client.__send__(:configure_session, base_url, :insecure => true)
+    end
+
+    it "set the default timeout" do
+      client.__send__(:configure_session, base_url, {})
+      client.session.timeout.should == Springboard::Client::DEFAULT_TIMEOUT
+    end
+
+    it "set the default connect timeout" do
+      client.__send__(:configure_session, base_url, {})
+      client.session.connect_timeout.should == Springboard::Client::DEFAULT_CONNECT_TIMEOUT
+    end
+  end
+
+  describe "[]" do
+    it "should return a resource object with the given path and client" do
+      client["path"].should be_a Springboard::Client::Resource
+    end
+  end
+
+
+  [:get, :head, :delete].each do |method|
+    bang_method = "#{method}!"
+    describe method do
+      it "should call session's #{method}" do
+        session.should_receive(method).with('/relative/path')
+        client.__send__(method, '/relative/path')
+      end
+
+      it "should return a Springboard::Client::Response" do
+        request_stub = stub_request(method, "#{base_url}/relative/path")
+        response = client.__send__(method, '/relative/path')
+        response.should be_a Springboard::Client::Response
+      end
+
+      it "should remove redundant base path prefix from URL if present" do
+        request_stub = stub_request(method, "#{base_url}/relative/path")
+        response = client.__send__(method, '/api/relative/path')
+        response.should be_a Springboard::Client::Response
+      end
+    end
+
+    describe bang_method do
+      it "should call #{method}" do
+        response = mock(Springboard::Client::Response)
+        response.should_receive(:success?).and_return(true)
+        client.should_receive(method).with('/path', false).and_return(response)
+        client.__send__(bang_method, '/path').should === response
+      end
+
+      it "should raise an exception on failure" do
+        response = mock(Springboard::Client::Response)
+        response.should_receive(:success?).and_return(false)
+        response.should_receive(:status_line).and_return('404 Not Found')
+        client.should_receive(method).with('/path', false).and_return(response)
+        lambda { client.send(bang_method, '/path') }.should raise_error(Springboard::Client::RequestFailed)
+      end
+    end
+  end
+
+
+  [:put, :post].each do |method|
+    bang_method = "#{method}!"
+    describe method do
+      it "should call session's #{method}" do
+        session.should_receive(method).with('/relative/path', 'body')
+        client.__send__(method, '/relative/path', 'body')
+      end
+
+      it "should return a Springboard::Client::Response" do
+        request_stub = stub_request(method, "#{base_url}/relative/path")
+        response = client.__send__(method, '/relative/path', 'body')
+        response.should be_a Springboard::Client::Response
+      end
+
+      it "should serialize the request body as JSON if it is a hash" do
+        body_hash = {:key1 => 'val1', :key2 => 'val2'}
+        session.should_receive(method).with('/path', body_hash.to_json)
+        client.__send__(method, '/path', body_hash)
+      end
+
+      it "should set the Content-Type header to application/json if not specified" do
+        request_stub = stub_request(method, "#{base_url}/my/resource").
+          with(:headers => {'Content-Type' => 'application/json'})
+        client.__send__(method, '/my/resource', :key1 => 'val1')
+        request_stub.should have_been_requested
+      end
+
+      it "should set the Content-Type header to specified value if specified" do
+        request_stub = stub_request(method, "#{base_url}/my/resource").
+          with(:headers => {'Content-Type' => 'application/pdf'})
+        client.__send__(method, '/my/resource', {:key1 => 'val1'}, 'Content-Type' => 'application/pdf')
+        request_stub.should have_been_requested
+      end
+    end
+
+    describe bang_method do
+      it "should call #{method}" do
+        response = mock(Springboard::Client::Response)
+        response.should_receive(:success?).and_return(true)
+        client.should_receive(method).with('/path', 'body', false).and_return(response)
+        client.__send__(bang_method, '/path', 'body').should === response
+      end
+
+      it "should raise an exception on failure" do
+        response = mock(Springboard::Client::Response)
+        response.should_receive(:success?).and_return(false)
+        response.should_receive(:status_line).and_return('404 Not Found')
+        client.should_receive(method).with('/path', 'body', false).and_return(response)
+        expect { client.send(bang_method, '/path', 'body') }.to raise_error { |error|
+          error.should be_a(Springboard::Client::RequestFailed)
+          error.response.should === response
+        }
+      end
+    end
+  end
+
+  describe "each_page" do
+    it "should request each page of the collection and yield each response to the block" do
+      responses = (1..3).map do |p|
+        response = mock(Springboard::Client::Response)
+        response.stub(:[]).with('pages').and_return(3)
+
+        client.should_receive(:get!).with("/things?page=#{p}&per_page=20".to_uri).and_return(response)
+
+        response
+      end
+
+      expect do |block|
+        client.each_page('/things', &block)
+      end.to yield_successive_args(*responses)
+    end
+  end
+
+  describe "each" do
+    it "should request each page of the collection and yield each individual result to the block" do
+      all_results = (1..3).inject([]) do |results, p|
+        response = mock(Springboard::Client::Response)
+        response.stub(:[]).with('pages').and_return(3)
+
+        page_results = 20.times.map {|i| "Page #{p} result #{i+1}"}
+        results += page_results
+
+        response.stub(:[]).with('results').and_return(page_results)
+
+        client.should_receive(:get!).with("/things?page=#{p}&per_page=20".to_uri).and_return(response)
+
+        results
+      end
+
+      expect do |block|
+        client.each('/things', &block)
+      end.to yield_successive_args(*all_results)
+    end
+  end
+end

data/springboard-retail.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name              = "springboard-retail"
+  s.version           = "4.0.0"
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = ["Jay Stotz"]
+  s.summary           = "Springboard Retail API client library"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_runtime_dependency 'patron', '>= 0.4.18'
+  s.add_runtime_dependency 'addressable', '>= 2.2.8'
+  s.add_runtime_dependency 'json', '>= 1.7.4'
+  s.add_runtime_dependency 'hashie'
+
+  s.files         = `git ls-files`.split("\n")
+  
+  s.require_path = 'lib'
+end
+
+

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: springboard-retail
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Jay Stotz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: patron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.18
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.4
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/springboard-retail.rb
+- lib/springboard/client.rb
+- lib/springboard/client/body.rb
+- lib/springboard/client/collection.rb
+- lib/springboard/client/errors.rb
+- lib/springboard/client/resource.rb
+- lib/springboard/client/response.rb
+- lib/springboard/client/uri_ext.rb
+- spec/shared_client_context.rb
+- spec/spec_helper.rb
+- spec/springboard/client/body_spec.rb
+- spec/springboard/client/resource_spec.rb
+- spec/springboard/client/response_spec.rb
+- spec/springboard/client/uri_ext_spec.rb
+- spec/springboard/client_spec.rb
+- springboard-retail.gemspec
+- vendor/cache/addressable-2.2.8.gem
+- vendor/cache/coderay-1.0.7.gem
+- vendor/cache/coveralls-0.6.9.gem
+- vendor/cache/crack-0.3.1.gem
+- vendor/cache/diff-lcs-1.1.3.gem
+- vendor/cache/hashie-2.0.5.gem
+- vendor/cache/json-1.8.1.gem
+- vendor/cache/method_source-0.8.gem
+- vendor/cache/mime-types-1.25.gem
+- vendor/cache/multi_json-1.8.0.gem
+- vendor/cache/patron-0.4.18.gem
+- vendor/cache/pry-0.9.10.gem
+- vendor/cache/rake-0.9.2.2.gem
+- vendor/cache/rest-client-1.6.7.gem
+- vendor/cache/rspec-2.11.0.gem
+- vendor/cache/rspec-core-2.11.1.gem
+- vendor/cache/rspec-expectations-2.11.2.gem
+- vendor/cache/rspec-mocks-2.11.1.gem
+- vendor/cache/simplecov-0.7.1.gem
+- vendor/cache/simplecov-html-0.7.1.gem
+- vendor/cache/slop-3.3.2.gem
+- vendor/cache/term-ansicolor-1.2.2.gem
+- vendor/cache/thor-0.18.1.gem
+- vendor/cache/tins-0.9.0.gem
+- vendor/cache/webmock-1.8.8.gem
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Springboard Retail API client library
+test_files: []