bootic_client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 727d4868928f07359322ccc49dfed3d20edfae0a
-  data.tar.gz: 7626595ffbef58af0b052b6a74c3dc220b3e32ca
+  metadata.gz: 7f0b175f26ae3c07540c632a0e07488ab48256a2
+  data.tar.gz: 6dfc0cc96fdadce33457631b507ea355b0eefff9
 SHA512:
-  metadata.gz: 56d7d5c1c16e19f61f5d9e59de8b494f3ba20f8510c7eaba5d21a1d2aeab1a97eaf125c80c5923b524dd422c6f75904ddb5f20fd3c98f4d52765dce18e2e1071
-  data.tar.gz: 8fb91e3fcfbed8a09bf3903e3952f9078554b381d657eec9d92b08b1e955741a40c5e3c46b2f67dada5f3d0cac45feb1a337d2536c25a762606835a27af2ef94
+  metadata.gz: cff8a48dc27c6b5362df02749e63de27258ee8cf58091ee9bf3cac17079eea3a21c138a16245f16b96d5b2e22215411e97a5486c299944197fe0d8a2e66e8aa7
+  data.tar.gz: c82c7be167dd5519bc7750a60dabf4d0af95c2372f284817ace9d9e4a508216a0de8f4fbd0523ca6e3a288a9b0aef93c44e4d71a1a51276dac731ab7b78fabee

data/README.md

@@ -127,7 +127,7 @@ All resource link relations include a "docs" URL so you can learn more about tha
 
 ```ruby
 shop = root.shops.first
-puts shop.rels[:create_product] # => 'https://developers.bootic.net/rels/create_product'
+puts shop.rels[:create_product].docs # => 'https://developers.bootic.net/rels/create_product'
 ```
 
 ## Cache storage

data/lib/bootic_client/client.rb

@@ -11,10 +11,9 @@ module BooticClient
     USER_AGENT = "[BooticClient v#{VERSION}] Ruby-#{RUBY_VERSION} - #{RUBY_PLATFORM}".freeze
     JSON_MIME = 'application/json'.freeze
 
-    attr_reader :options, :api_root
+    attr_reader :options
 
-    def initialize(api_root, options = {}, &block)
-      @api_root = api_root
+    def initialize(options = {}, &block)
       @options = {
         access_token: nil,
         logging: false
@@ -25,40 +24,38 @@ module BooticClient
       conn &block if block_given?
     end
 
-    def get_and_wrap(href, wrapper_class, query = {})
-      wrapper_class.new get(href, query).body, self
+    def get(href, query = {})
+      validated_request!(:get, href) do |req|
+        req.params.update(query)
+      end
     end
 
-    def post_and_wrap(href, wrapper_class, payload = {})
-      wrapper_class.new post(href, payload).body, self
+    def post(href, payload = {})
+      validated_request!(:post, href) do |req|
+        req.body = JSON.dump(payload)
+      end
     end
 
-    def get(href, query = {})
-      validated! do
-        conn.get do |req|
-          req.url href
-          req.headers.update request_headers
-          req.params.update(query)
-        end
+    def put(href, payload = {})
+      validated_request!(:put, href) do |req|
+        req.body = JSON.dump(payload)
       end
     end
 
-    def post(href, payload = {})
-      validated! do
-        conn.post do |req|
-          req.url href
-          req.headers.update request_headers
-          req.headers['Accept'] = JSON_MIME
-          req.headers['Content-Type'] = JSON_MIME
-          req.body = JSON.dump(payload)
-        end
+    def patch(href, payload = {})
+      validated_request!(:patch, href) do |req|
+        req.body = JSON.dump(payload)
       end
     end
 
+    def delete(href, query = {})
+      validated_request!(:delete, href)
+    end
+
     protected
 
     def conn(&block)
-      @conn ||= Faraday.new(url: api_root) do |f|
+      @conn ||= Faraday.new do |f|
         cache_options = {shared_cache: false, store: options[:cache_store]}
         cache_options[:logger] = options[:logger] if options[:logging]
 
@@ -73,13 +70,20 @@ module BooticClient
     def request_headers
       {
         'Authorization' => "Bearer #{options[:access_token]}",
-        'User-Agent' => USER_AGENT
+        'User-Agent' => USER_AGENT,
+        'Accept' => JSON_MIME,
+        'Content-Type' => JSON_MIME
       }
     end
 
-    def validated!(&block)
+    def validated_request!(verb, href, &block)
       validate_request!
-      resp = yield
+      resp = conn.send(verb) do |req|
+        req.url href
+        req.headers.update request_headers
+        yield req if block_given?
+      end
+
       raise_if_invalid! resp
       resp
     end
@@ -96,4 +100,4 @@ module BooticClient
     end
   end
 
-end
+end

data/lib/bootic_client/relation.rb

@@ -44,21 +44,13 @@ module BooticClient
     end
 
     def run(opts = {})
-      self.send(transport_method, opts)
-    end
-
-    def get(opts = {})
       if templated?
-        client.get_and_wrap uri.expand(opts), wrapper_class
+        client.request_and_wrap transport_method.to_sym, uri.expand(opts), wrapper_class, opts
       else
-        client.get_and_wrap href, wrapper_class, opts
+        client.request_and_wrap transport_method.to_sym, href, wrapper_class, opts
       end
     end
 
-    def post(opts = {})
-      client.post_and_wrap href, wrapper_class, opts
-    end
-
     def self.expand(href, opts = {})
       URITemplate.new(href).expand(opts)
     end
@@ -71,4 +63,4 @@ module BooticClient
     end
   end
 
-end
+end

data/lib/bootic_client/strategies/strategy.rb

@@ -13,17 +13,17 @@ module BooticClient
       end
 
       def root
-        get config.api_root
+        request_and_wrap :get, config.api_root, Entity
       end
 
-      def get(href, query = {})
+      def request_and_wrap(request_method, href, wrapper_class, payload = {})
         begin
-          client.get_and_wrap(href, Entity, query)
+          wrapper_class.new client.send(request_method, href, payload).body, self
         rescue TokenError => e
           new_token = get_token
           client.options[:access_token] = new_token
           on_new_token.call new_token
-          client.get_and_wrap(href, Entity, query)
+          wrapper_class.new client.send(request_method, href, payload).body, self
         end
       end
 
@@ -52,8 +52,8 @@ module BooticClient
       end
 
       def client
-        @client ||= Client.new(config.api_root, options)
+        @client ||= Client.new(options)
       end
     end
   end
-end
+end

data/lib/bootic_client/version.rb

@@ -1,3 +1,3 @@
 module BooticClient
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/authorized_strategy_spec.rb

@@ -18,7 +18,7 @@ describe 'BooticClient::Strategies::Authorized' do
 
   def stub_api_root(access_token, status, body)
     stub_request(:get, "https://api.bootic.net/v1").
-      with(headers: {'Accept'=>'*/*', 'Authorization' => "Bearer #{access_token}"}).
+      with(headers: {'Accept'=>'application/json', 'Authorization' => "Bearer #{access_token}"}).
       to_return(status: status, :body => JSON.dump(body))
   end
 
@@ -45,7 +45,7 @@ describe 'BooticClient::Strategies::Authorized' do
   let(:root_data) {
     {
       '_links' => {
-        'shops' => {'href' => 'https://api.bootic.net/v1/products'}
+        'shops' => {'href' => 'https://api.bootic.net/v1/shops'}
       },
       'message' => "Hello!"
     }
@@ -109,7 +109,7 @@ describe 'BooticClient::Strategies::Authorized' do
         @successful_root_request = stub_api_root('foobar', 200, root_data)
       end
 
-      it 'attempts unauthorised API request, refreshes token from auth an tries again' do
+      it 'attempts unauthorised API request, refreshes token from auth and tries again' do
         root = client.root
         expect(@failed_root_request).to have_been_requested
         expect(@auth_request).to have_been_requested
@@ -121,5 +121,28 @@ describe 'BooticClient::Strategies::Authorized' do
         expect(store[:access_token]).to eql('foobar')
       end
     end
+
+    context 'expired token, other resources' do
+      before do
+        stub_api_root('abc', 200, root_data)
+        @unauthorized_request = stub_request(:get, "https://api.bootic.net/v1/shops").
+          with(headers: {'Accept'=>'application/json', 'Authorization' => "Bearer abc"}).
+          to_return(status: 401, :body => JSON.dump(message: 'authorized'))
+        @auth_request = stub_auth('abc', 200, access_token: 'validtoken')
+
+        @authorized_request = stub_request(:get, "https://api.bootic.net/v1/shops").
+          with(headers: {'Accept'=>'application/json', 'Authorization' => "Bearer validtoken"}).
+          to_return(status: 200, :body => JSON.dump(title: 'All shops'))
+        @root = client.root
+      end
+
+      it 'attempts unauthorized API request to shops, refreshes token and tries again' do
+        shops = @root.shops
+        expect(@unauthorized_request).to have_been_requested
+        expect(@auth_request).to have_been_requested
+        expect(@authorized_request).to have_been_requested
+        expect(shops.title).to eql('All shops')
+      end
+    end
   end
-end
+end

data/spec/client_credentials_strategy_spec.rb

@@ -32,7 +32,7 @@ describe 'BooticClient::Strategies::ClientCredentials' do
 
     def stub_api_root(access_token, status, body)
       stub_request(:get, "https://api.bootic.net/v1").
-        with(headers: {'Accept'=>'*/*', 'Authorization' => "Bearer #{access_token}"}).
+        with(headers: {'Accept'=>'application/json', 'Authorization'=>"Bearer #{access_token}"}).
         to_return(status: status, :body => JSON.dump(body))
     end
 
@@ -94,4 +94,4 @@ describe 'BooticClient::Strategies::ClientCredentials' do
     end
   end
 
-end
+end

data/spec/client_spec.rb

@@ -6,7 +6,10 @@ describe BooticClient::Client do
 
   describe 'valid response' do
     let(:root_url) { 'https://api.bootic.net/v1' }
-    let(:client) { BooticClient::Client.new(root_url, access_token: 'xxx') }
+    let(:client) { BooticClient::Client.new(access_token: 'xxx') }
+    let(:request_headers) {
+      {'Accept' => 'application/json', 'Authorization' => "Bearer xxx"}
+    }
     let(:response_headers) {
       {'Content-Type' => 'application/json', 'Last-Modified' => 'Sat, 07 Jun 2014 12:10:33 GMT'}
     }
@@ -60,7 +63,7 @@ describe BooticClient::Client do
         describe 'no access token' do
           it 'raises error' do
             expect{
-              BooticClient::Client.new(root_url).get(root_url)
+              BooticClient::Client.new.get(root_url)
             }.to raise_error(BooticClient::NoAccessTokenError)
           end
         end
@@ -120,35 +123,61 @@ describe BooticClient::Client do
 
     end
 
-    describe '#get_and_wrap' do
-      before do
-        stub_request(:get, root_url)
-          .with(query: {foo: 'bar'})
-          .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+    context 'HTTP verbs' do
+      describe 'GET' do
+
+        before do
+          stub_request(:get, root_url)
+            .with(query: {foo: 'bar'}, headers: request_headers)
+            .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+        end
+
+        it 'GETs response' do
+          expect(client.get(root_url, foo: 'bar').body['message']).to eql('Hello!')
+        end
       end
 
-      it 'wraps JSON response in entity' do
-        wrapper = double('Wrapper Class')
-        entity = double('Entity')
-        expect(wrapper).to receive(:new).with(root_data, client).and_return entity
-        expect(client.get_and_wrap(root_url, wrapper, foo: 'bar')).to eql(entity)
+      describe 'POST' do
+        before do
+          stub_request(:post, root_url)
+            .with(body: JSON.dump({foo: 'bar'}), headers: request_headers)
+            .to_return(status: 201, body: JSON.dump(root_data), headers: response_headers)
+        end
+
+        it 'POSTs request and parses response' do
+          expect(client.post(root_url, foo: 'bar').body['message']).to eql('Hello!')
+        end
       end
-    end
+ 
+      [:put, :patch].each do |verb|
+        describe verb.to_s.upcase do
+          before do
+            stub_request(verb, root_url)
+              .with(body: JSON.dump({foo: 'bar'}), headers: request_headers)
+              .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+          end
 
-    describe '#post_and_wrap' do
-      before do
-        stub_request(:post, root_url)
-          .with(body: JSON.dump({foo: 'bar'}), headers: {'Accept' => 'application/json', 'Content-Type' => 'application/json'})
-          .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+          it "#{verb.to_s.upcase}s request and parses response" do
+            expect(client.send(verb, root_url, foo: 'bar').body['message']).to eql('Hello!')
+          end
+        end
       end
+ 
+      context 'DELETE' do
+        before do
+          @delete_requst = stub_request(:delete, root_url)
+            .with(headers: request_headers)
+            .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+        end
 
-      it 'wraps JSON response in entity' do
-        wrapper = double('Wrapper Class')
-        entity = double('Entity')
-        expect(wrapper).to receive(:new).with(root_data, client).and_return entity
-        expect(client.post_and_wrap(root_url, wrapper, foo: 'bar')).to eql(entity)
+        it 'DELETEs request and parses response' do
+          expect(client.send(:delete, root_url).status).to eql(200)
+          expect(@delete_requst).to have_been_requested
+        end
       end
+ 
     end
 
+
   end
-end
+end

data/spec/entity_spec.rb

@@ -139,7 +139,7 @@ describe BooticClient::Entity do
         let(:next_page) { BooticClient::Entity.new({'page' => 2}, client) }
 
         it 'exposes link target resources as normal properties' do
-          expect(client).to receive(:get_and_wrap).with('/foo?page=2', BooticClient::Entity, {}).and_return next_page
+          expect(client).to receive(:request_and_wrap).with(:get, '/foo?page=2', BooticClient::Entity, {}).and_return next_page
           entity.next.tap do |next_entity|
             expect(next_entity).to be_kind_of(BooticClient::Entity)
             expect(next_entity.page).to eql(2)
@@ -147,7 +147,7 @@ describe BooticClient::Entity do
         end
 
         it 'takes optional URI parameters' do
-          expect(client).to receive(:get_and_wrap).with('/search?q=foo', BooticClient::Entity).and_return next_page
+          expect(client).to receive(:request_and_wrap).with(:get, '/search?q=foo', BooticClient::Entity, {q: 'foo'}).and_return next_page
           entity.search(q: 'foo').tap do |next_entity|
             expect(next_entity).to be_kind_of(BooticClient::Entity)
             expect(next_entity.page).to eql(2)

data/spec/relation_spec.rb

@@ -18,7 +18,7 @@ describe BooticClient::Relation do
 
     describe 'running GET by default' do
       it 'fetches data and returns entity' do
-        client.stub(:get_and_wrap).with('/foo/bars', BooticClient::Entity, {}).and_return entity
+        client.stub(:request_and_wrap).with(:get, '/foo/bars', BooticClient::Entity, {}).and_return entity
         expect(relation.run).to eql(entity)
       end
 
@@ -30,7 +30,7 @@ describe BooticClient::Relation do
         end
 
         it 'passes query string to client' do
-          expect(client).to receive(:get_and_wrap).with('/foos/bar', BooticClient::Entity, id: 2, q: 'test', page: 2).and_return entity
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/bar', BooticClient::Entity, id: 2, q: 'test', page: 2).and_return entity
           expect(relation.run(id: 2, q: 'test', page: 2)).to eql(entity)
         end
       end
@@ -43,12 +43,12 @@ describe BooticClient::Relation do
         end
 
         it 'works with defaults' do
-          expect(client).to receive(:get_and_wrap).with('/foos/', BooticClient::Entity).and_return entity
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/', BooticClient::Entity, {}).and_return entity
           expect(relation.run).to eql(entity)
         end
 
         it 'interpolates tokens' do
-          expect(client).to receive(:get_and_wrap).with('/foos/2?q=test&page=2', BooticClient::Entity).and_return entity
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/2?q=test&page=2', BooticClient::Entity, {id:2,q:'test',page:2}).and_return entity
           expect(relation.run(id: 2, q: 'test', page: 2)).to eql(entity)
         end
       end
@@ -56,11 +56,17 @@ describe BooticClient::Relation do
 
     describe 'POST' do
       let(:relation) { BooticClient::Relation.new({'href' => '/foo/bars', 'type' => 'application/json', 'name' => 'self', 'method' => 'post'}, client) }
+      let(:relation_templated) { BooticClient::Relation.new({'href' => '/foo/{bars}', 'templated' => true, 'type' => 'application/json', 'name' => 'self', 'method' => 'post'}, client) }
 
       it 'POSTS data and returns resulting entity' do
-        client.stub(:post_and_wrap).with('/foo/bars', BooticClient::Entity, {}).and_return entity
+        client.stub(:request_and_wrap).with(:post, '/foo/bars', BooticClient::Entity, {}).and_return entity
         expect(relation.run).to eql(entity)
       end
+ 
+      it 'interpolates templated URLs' do
+        client.stub(:request_and_wrap).with(:post, '/foo/123', BooticClient::Entity, {foo: 'bar', bars: 123}).and_return entity
+        expect(relation_templated.run(bars: 123, foo: 'bar')).to eql(entity)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-21 00:00:00.000000000 Z
+date: 2014-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday