shutl_resource 0.8.0

data/spec/rest_resource_spec.rb

@@ -0,0 +1,329 @@
+require 'spec_helper'
+
+describe Shutl::Resource::Rest do
+  let(:headers) do
+    {'Accept'=>'application/json', 'Authorization'=>'Bearer', 'Content-Type'=>'application/json'}
+  end
+
+  it 'should include the REST verb' do
+    TestRest.should respond_to :get
+    TestRest.should respond_to :post
+    TestRest.should respond_to :post
+    TestRest.should respond_to :delete
+  end
+
+  let(:resource) { TestRest.new(a: 'a', b: 2)  }
+
+  describe '#find' do
+    context 'with no arguments' do
+      before do
+        @request = stub_request(:get, 'http://host/test_rests/a').
+          to_return(:status => 200,
+                    :body => '{"test_rest": { "a": "a", "b": 2 }}',
+                    :headers => headers)
+      end
+
+      it 'should query the endpoint' do
+        TestRest.find('a')
+
+        @request.should have_been_requested
+      end
+
+      it 'should parse the result of the body to create an object' do
+        resource = TestRest.find('a')
+
+        resource.should_not be_nil
+        resource.should be_kind_of TestRest
+      end
+
+      it 'should assign the attributes based on the json returned' do
+        resource = TestRest.find('a')
+
+        resource.instance_variable_get('@a').should == 'a'
+        resource.instance_variable_get('@b').should == 2
+      end
+
+      {
+        400 => Shutl::BadRequest,
+        401 => Shutl::UnauthorizedAccess,
+        403 => Shutl::ForbiddenAccess,
+        404 => Shutl::ResourceNotFound,
+        409 => Shutl::ResourceConflict,
+        410 => Shutl::ResourceGone,
+        422 => Shutl::ResourceInvalid,
+        503 => Shutl::ServiceUnavailable,
+        501..502 => Shutl::ServerError,
+        504..599 => Shutl::ServerError
+      }.each do |status, exception|
+        it "raises an #{exception} exception with a #{status}" do
+          if status.is_a? Range
+            status.each do |s|
+              stub_request(:get, 'http://host/test_rests/b').
+                to_return(status: s.to_i)
+
+              expect(->{TestRest.find('b')}).to raise_error(exception)
+            end
+          else
+            stub_request(:get, 'http://host/test_rests/b').
+              to_return(status: status)
+            lambda { TestRest.find('b') }.should raise_error(exception)
+
+          end
+
+        end
+      end
+
+      it 'should add a id based on the resource id' do
+        resource = TestRest.find('a')
+
+        resource.instance_variable_get('@id').should == 'a'
+      end
+    end
+
+    it 'should encode the url to support spaces' do
+      request = stub_request(:get, 'http://host/test_rests/new%20resource').
+        to_return(:status => 200, :body => '{"test_rest": {}}',
+                  :headers => headers)
+
+      TestRest.find('new resource')
+
+      request.should have_been_requested
+    end
+
+    context 'with url arguments' do
+      before do
+        @request = stub_request(:get, 'http://host/test_rests/a?arg1=val1&arg2=val2').
+          to_return(:status => 200, :body => '{"test_rest": { "a": "a", "b": 2 }}', :headers => headers)
+      end
+
+      it 'should query the endpoint with the parameters' do
+        TestRest.find('a', arg1: 'val1', arg2: 'val2')
+
+        @request.should have_been_requested
+      end
+
+    end
+  end
+
+  describe '#all' do
+
+    context 'with no arguments' do
+      before do
+        @request = stub_request(:get, 'http://host/test_rests').
+          to_return(:status => 200, :body => '{"test_rests": [{ "a": "a", "b": 2 }]}', :headers => headers)
+      end
+
+      it 'should query the endpoint' do
+        TestRest.all
+
+        @request.should have_been_requested
+      end
+
+      it 'should parse the result of the body to create an array' do
+        resource = TestRest.all
+
+        resource.should have(1).item
+      end
+
+      it 'should assign the attributes based on the json returned' do
+        resource = TestRest.all
+
+        resource.first.instance_variable_get('@a').should == 'a'
+        resource.first.instance_variable_get('@b').should == 2
+      end
+
+      it 'should raise an error of the request fails' do
+        stub_request(:get, 'http://host/test_rests').
+          to_return(:status => 403)
+
+        lambda { TestRest.all}.should raise_error(Shutl::ForbiddenAccess)
+
+      end
+    end
+
+    context 'with no arguments' do
+      before do
+        @request = stub_request(:get, 'http://host/test_rests?arg1=val1&arg2=val2').
+          to_return(:status => 200, :body => '{"test_rests": [{ "a": "a", "b": 2 }]}', :headers => headers)
+      end
+
+      it 'should query the endpoint' do
+        TestRest.all(arg1: 'val1', arg2: 'val2')
+
+        @request.should have_been_requested
+      end
+    end
+  end
+
+  describe '.create' do
+
+    context "With the setting to not raise exceptions" do
+      before do
+        Shutl::Resource.raise_exceptions_on_validation = false
+      end
+
+      after do
+        Shutl::Resource.raise_exceptions_on_validation = true
+      end
+      specify do
+        errors = {"base" => "invalid", "some_field" => "some field is invalid"}
+        body = {"errors" => errors}.to_json
+
+        @request = stub_request(:post, 'http://host/test_rests').
+          to_return(:status => 422, body: body, :headers => headers)
+
+        expect{@instance = TestRest.create}.to_not raise_error Shutl::ResourceInvalid
+
+        @request.should have_been_requested
+        @instance.should_not be_valid
+        @instance.errors.should == errors
+      end
+    end
+
+
+    it 'should send a post request to the endpoint' do
+      request = stub_post 200
+
+      TestRest.create
+
+      request.should have_been_requested
+    end
+
+    def stub_post status
+      stub_request(:post, 'http://host/test_rests').
+        to_return(:status => status, :body => '', :headers => headers)
+    end
+
+    it 'should raise error if the remote server returns an error' do
+      request = stub_post 403
+      expect(->{TestRest.create}).to raise_error Shutl::ForbiddenAccess
+
+      request.should have_been_requested
+    end
+
+
+    it 'should post the header content-type: json' do
+      request = stub_request(:post, 'http://host/test_rests').
+        with(:body => "{\"test_rest\":{}}", :headers => headers )
+
+      TestRest.create
+
+      request.should have_been_requested
+    end
+
+    it 'should raise an exception if the create is called with the ! and it fails' do
+      request = stub_request(:post, 'http://host/test_rests').
+        to_return(:status => 400)
+
+      expect(->{ TestRest.create}).to raise_error(Shutl::BadRequest)
+    end
+
+
+    it 'shoud create a new ressource with the attributes' do
+      request = stub_request(:post, "http://host/test_rests").
+        with(body: '{"test_rest":{"a":"a","b":"b"}}',
+             headers: headers)
+
+      TestRest.create(a: 'a', b: 'b')
+
+      request.should have_been_requested
+    end
+
+  end
+
+  describe '#destroy' do
+
+    it 'should send a delete query to the endpoint' do
+      request = stub_request(:delete, 'http://host/test_rests/a')
+
+      TestRest.destroy id: 'a'
+
+      request.should have_been_requested
+    end
+
+    it 'should return true if the request succeeds' do
+      stub_request(:delete, 'http://host/test_rests/a').
+        to_return(status: 204)
+
+      TestRest.destroy(id: 'a').should eq(true)
+    end
+
+    it 'should return false if the request fails' do
+      stub_request(:delete, 'http://host/test_rests/a').
+        to_return(status: 400)
+
+      expect(->{TestRest.destroy(id: 'a')}).to raise_error Shutl::BadRequest
+    end
+  end
+
+  describe '#save' do
+    it 'should send a delete query to the endpoint' do
+      request = stub_request(:put, 'http://host/test_rests/a')
+
+      resource.save
+
+      request.should have_been_requested
+    end
+
+    it 'should return true if the request succeeds' do
+      stub_request(:put, 'http://host/test_rests/a').
+        to_return(status: 204)
+
+      resource.save.should eq(true)
+    end
+
+    it 'should return false if the request fails' do
+      stub_request(:put, 'http://host/test_rests/a').
+        to_return(status: 400)
+
+      ->{resource.save}.should raise_error Shutl::BadRequest
+    end
+
+
+    it 'should post in the body the json serialized resource' do
+      Hash.any_instance.stub(:to_json).and_return('JSON')
+      request = stub_request(:put, 'http://host/test_rests/a').
+        with(:body => 'JSON', headers: headers)
+
+      resource.save
+
+      request.should have_been_requested
+    end
+
+
+    it 'should raise an error if the update is called with the ! and it fails' do
+      stub_request(:put, 'http://host/test_rests/a').
+        to_return(status: 400)
+
+      expect(->{ resource.save }).to raise_error(Shutl::BadRequest)
+    end
+  end
+
+  describe '#update!' do
+    it 'should post the new json representation' do
+      request = stub_request(:put, "http://host/test_rests/a").
+        with(:body => '{"test_rest":{"a":"a","id":"a","b":"b"}}',
+             headers: headers)
+      test_resource = TestRest.new
+
+      test_resource.update!(a: 'a', b: 'b')
+
+      request.should have_been_requested
+    end
+
+    it 'should convert new_id to id in attributes' do
+      request = stub_request(:put, "http://host/test_rests/a").
+         with(:body => "{\"test_rest\":{\"a\":\"a\",\"id\":\"xxx\",\"b\":\"b\"}}",
+              :headers => headers)
+
+      test_resource = TestRest.new
+
+      test_resource.update!(a: 'a', b: 'b', new_id: 'xxx')
+
+      request.should have_been_requested
+    end
+  end
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'shutl_resource'
+require 'webmock/rspec'
+
+require 'support/test_resource'
+require 'support/double_logger'
+
+
+require 'vcr'
+
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr'
+  c.hook_into :webmock
+  c.allow_http_connections_when_no_cassette = false
+  c.default_cassette_options = {
+    record: ENV['VCR_RERECORD'].present? ? :all : :once
+  }
+end
+
+

data/spec/support/double_logger.rb

@@ -0,0 +1,14 @@
+
+module Shutl::Resource
+  class NoLogger
+    def debug(message) ; end
+    def info(message) ; end
+    def warn(message) ; end
+    def error(message) ; end
+    def fatal(message) ; end
+  end
+end
+
+Shutl::Resource.configure do |config|
+  config.logger = Shutl::Resource::NoLogger.new
+end

data/spec/support/test_resource.rb

@@ -0,0 +1,6 @@
+class TestRest
+  include Shutl::Resource::Rest
+  base_uri 'http://host'
+  resource_id :a
+end
+

metadata

@@ -0,0 +1,248 @@
+--- !ruby/object:Gem::Specification
+name: shutl_resource
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.8.0
+platform: ruby
+authors:
+- David Rouchy
+- Volker Pacher
+- Mark Burns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  name: httparty
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  name: shutl_auth
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: activemodel
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: debugger
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: vcr
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  name: webmock
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: Shutl Rest resource
+email:
+- davidr@shutl.co.uk
+- volker@shutl.com
+- mark@shutl.com
+executables:
+- autospec
+- erubis
+- htmldiff
+- httparty
+- httpclient
+- ldiff
+- rackup
+- rails
+- rake
+- rake2thor
+- rdebug
+- ri
+- rspec
+- sprockets
+- thor
+- tilt
+- tt
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/autospec
+- bin/erubis
+- bin/htmldiff
+- bin/httparty
+- bin/httpclient
+- bin/ldiff
+- bin/rackup
+- bin/rails
+- bin/rake
+- bin/rake2thor
+- bin/rdebug
+- bin/ri
+- bin/rspec
+- bin/sprockets
+- bin/thor
+- bin/tilt
+- bin/tt
+- lib/shutl/resource/configuration.rb
+- lib/shutl/resource/errors.rb
+- lib/shutl/resource/rest.rb
+- lib/shutl/resource/rest_class_methods.rb
+- lib/shutl/resource/version.rb
+- lib/shutl_resource.rb
+- script/ci
+- shutl_resource.gemspec
+- spec/configuration_spec.rb
+- spec/dynamic_resource_spec.rb
+- spec/remote_url_spec.rb
+- spec/rest_resource_spec.rb
+- spec/spec_helper.rb
+- spec/support/double_logger.rb
+- spec/support/test_resource.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -2260222592976093947
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -2260222592976093947
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Manage Shutl Rest resource. Parse/Serialize JSON
+test_files:
+- spec/configuration_spec.rb
+- spec/dynamic_resource_spec.rb
+- spec/remote_url_spec.rb
+- spec/rest_resource_spec.rb
+- spec/spec_helper.rb
+- spec/support/double_logger.rb
+- spec/support/test_resource.rb