bootic_client 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8095f21114667841cc61f8048100b8f31e56f34e
-  data.tar.gz: 1022b40385355b90b2a478af677dd7221d5bc68b
+  metadata.gz: 1ca933989403d66243755d735272c645458c5575
+  data.tar.gz: bdbdb38d2b417c05634953ffb48395d3f2971301
 SHA512:
-  metadata.gz: ff530bf2fc8d5c4215ddf7838685fb7550e6e38b2085c109d8d5878ddae3ef263cb667803f751dfba15cfe0e8be127cbcf9654e9735091b87ba0164334039e00
-  data.tar.gz: aada7437aa9a191accd6cd72e96fd21ff22fb85cd53ebe024929523d9ace1c95fe02fd24ff953a51b6b5bbdfb8ff547b46878a1193bbc8b30d63a1657d68a6c4
+  metadata.gz: c76703781e56dc5ee87eb065355fb8de38daf775f5fc38989e626985abe0a12e3800d94334482405081281ffbdbae295c8e9a66915e6e1f6b2c3f1f0b977b0f4
+  data.tar.gz: b5eac3f968ba339d877a798929c123c25beea50eae2f83e04078935ccbce24b97e57833ad398593d97d1dfbe057619bcc4286a0f5199cf2918968a0fd80c24f8

data/README.md

@@ -115,6 +115,20 @@ client = BooticClient.client(:client_credentials, scope: 'admin', access_token:
 end
 ```
 
+### 3. Basic Auth
+
+This strategy uses a `username` and `password` against APIs supporting HTTP's Basic Authentication scheme.
+
+The official Bootic API only supports OAuth2 tokens, but this allows the client to be used against internal APIs or stub APIs on development.
+
+```ruby
+client = BooticClient.client(:basic_auth, username: 'foo', password: 'bar')
+
+root = client.root # etc
+```
+
+NOTE: `username` and `password` have nothing to do with your Bootic administrative credentials, and will be up to API maintainers to define.
+
 ## Non GET links
 
 Most resource links lead to `GET` resources, but some will expect `POST`, `PUT`, `DELETE` or others.
@@ -186,6 +200,23 @@ BooticClient.configure do |c|
 end
 ```
 
+## Pre-loaded or custom root resources
+
+This client is designed to always navigate APIs starting from the root endpoint (the Hypermedia approach), but it's also possible to skip the root and start from a locally defined resource definition.
+
+```ruby
+messaging_api = client.from_hash(
+  "_links" => {
+    "send_message" => {"href" => 'https://some.api.com/messages', "method" => 'post'},
+    "delete_message" => {"href" => 'https://some.api.com/messages/:id', "method" => 'delete', "templated" => true}
+  }
+)
+
+new_message = messaging_api.send_message(title: 'This is a new message')
+
+messaging_api.delete_message(id: new_message.id)
+```
+
 ## Contributing
 
 1. Fork it

data/lib/bootic_client/client.rb

@@ -15,7 +15,6 @@ module BooticClient
 
     def initialize(options = {}, &block)
       @options = {
-        access_token: nil,
         logging: false
       }.merge(options.dup)
 
@@ -24,32 +23,38 @@ module BooticClient
       conn &block if block_given?
     end
 
-    def get(href, query = {})
+    def get(href, query = {}, headers = {})
       validated_request!(:get, href) do |req|
+        req.headers.update headers
         req.params.update(query)
       end
     end
 
-    def post(href, payload = {})
+    def post(href, payload = {}, headers = {})
       validated_request!(:post, href) do |req|
+        req.headers.update headers
         req.body = JSON.dump(payload)
       end
     end
 
-    def put(href, payload = {})
+    def put(href, payload = {}, headers = {})
       validated_request!(:put, href) do |req|
+        req.headers.update headers
         req.body = JSON.dump(payload)
       end
     end
 
-    def patch(href, payload = {})
+    def patch(href, payload = {}, headers = {})
       validated_request!(:patch, href) do |req|
+        req.headers.update headers
         req.body = JSON.dump(payload)
       end
     end
 
-    def delete(href, query = {})
-      validated_request!(:delete, href)
+    def delete(href, headers = {})
+      validated_request!(:delete, href) do |req|
+        req.headers.update headers
+      end
     end
 
     protected
@@ -69,7 +74,6 @@ module BooticClient
 
     def request_headers
       {
-        'Authorization' => "Bearer #{options[:access_token]}",
         'User-Agent' => USER_AGENT,
         'Accept' => JSON_MIME,
         'Content-Type' => JSON_MIME
@@ -77,7 +81,6 @@ module BooticClient
     end
 
     def validated_request!(verb, href, &block)
-      validate_request!
       resp = conn.send(verb) do |req|
         req.url href
         req.headers.update request_headers
@@ -88,10 +91,6 @@ module BooticClient
       resp
     end
 
-    def validate_request!
-      raise NoAccessTokenError, "Missing access token" unless options[:access_token]
-    end
-
     def raise_if_invalid!(resp)
       raise ServerError, "Server Error" if resp.status > 499
       raise NotFoundError, "Not Found" if resp.status == 404

data/lib/bootic_client/entity.rb

@@ -41,7 +41,8 @@ module BooticClient
     end
 
     def [](key)
-      properties[key.to_sym] || entities[key.to_sym]
+      key = key.to_sym
+      has_property?(key) ? properties[key] : entities[key]
     end
 
     def has?(prop_name)

data/lib/bootic_client/errors.rb

@@ -2,8 +2,7 @@ module BooticClient
   class TransportError < StandardError; end
   class ServerError < TransportError; end
   class NotFoundError < ServerError; end
-  class TokenError < ServerError; end
-  class UnauthorizedError < TokenError; end
-  class AccessForbiddenError < TokenError; end
-  class NoAccessTokenError < TokenError; end
-end
+  class AuthorizationError < ServerError; end
+  class UnauthorizedError < AuthorizationError; end
+  class AccessForbiddenError < AuthorizationError; end
+end

data/lib/bootic_client/relation.rb

@@ -45,7 +45,11 @@ module BooticClient
 
     def run(opts = {})
       if templated?
-        client.request_and_wrap transport_method.to_sym, uri.expand(opts), wrapper_class, opts
+        uri_vars = uri.variables
+        payload = opts.each_with_object({}) do |(k,v),memo|
+          memo[k] = v unless uri_vars.include?(k.to_s)
+        end
+        client.request_and_wrap transport_method.to_sym, uri.expand(opts), wrapper_class, payload
       else
         client.request_and_wrap transport_method.to_sym, href, wrapper_class, opts
       end

data/lib/bootic_client/strategies/authorized.rb

@@ -1,13 +1,13 @@
-require 'bootic_client/strategies/strategy'
+require 'bootic_client/strategies/oauth2_strategy'
 
 module BooticClient
   module Strategies
 
-    class Authorized < Strategy
+    class Authorized < Oauth2Strategy
       protected
 
-      def validate!(options)
-        raise "options MUST include access_token" unless options[:access_token]
+      def validate!
+        raise ArgumentError, "options MUST include access_token" unless options[:access_token]
       end
 
       def get_token

data/lib/bootic_client/strategies/basic_auth.rb

@@ -0,0 +1,27 @@
+require 'bootic_client/strategies/strategy'
+
+module BooticClient
+  module Strategies
+    class BasicAuth < Strategy
+
+      def inspect
+        %(#<#{self.class.name} root: #{config.api_root} username: #{options[:username]}>)
+      end
+
+      protected
+
+      def validate!
+        raise ArgumentError, "options MUST include username" unless options[:username]
+        raise ArgumentError, "options MUST include password" unless options[:password]
+      end
+
+      def client
+        @client ||= Client.new(options) do |c|
+          c.request :basic_auth, options[:username], options[:password]
+        end
+      end
+    end
+  end
+
+  strategies[:basic_auth] = Strategies::BasicAuth
+end

data/lib/bootic_client/strategies/client_credentials.rb

@@ -1,10 +1,11 @@
-require 'bootic_client/strategies/strategy'
+require 'bootic_client/strategies/oauth2_strategy'
 
 module BooticClient
   module Strategies
 
-    class ClientCredentials < Strategy
+    class ClientCredentials < Oauth2Strategy
       protected
+
       def get_token
         opts = {}
         opts['scope'] = options.delete(:scope) if options[:scope]
@@ -16,4 +17,4 @@ module BooticClient
   end
 
   strategies[:client_credentials] = Strategies::ClientCredentials
-end
+end

data/lib/bootic_client/strategies/oauth2_strategy.rb

@@ -0,0 +1,61 @@
+require 'oauth2'
+require 'bootic_client/strategies/strategy'
+
+module BooticClient
+  module Strategies
+
+    class Oauth2Strategy < Strategy
+
+      def inspect
+        %(#<#{self.class.name} cid: #{config.client_id} root: #{config.api_root} auth: #{config.auth_host}>)
+      end
+
+      protected
+
+      def validate!
+        raise ArgumentError, "MUST include client_id" unless config.client_id
+        raise ArgumentError, "MUST include client_secret" unless config.client_secret
+        raise ArgumentError, "MUST include api_root" unless config.api_root
+      end
+
+      def pre_flight
+        update_token! unless options[:access_token]
+      end
+
+      def request_headers
+        {
+          'Authorization' => "Bearer #{options[:access_token]}"
+        }
+      end
+
+      def retryable(&block)
+        begin
+          yield
+        rescue AuthorizationError => e
+          update_token!
+          yield
+        end
+      end
+
+      def update_token!
+        new_token = get_token
+        options[:access_token] = new_token
+        on_new_token.call new_token
+      end
+
+      def get_token
+        raise "Implement this in subclasses"
+      end
+
+      def auth
+        @auth ||= OAuth2::Client.new(
+          config.client_id,
+          config.client_secret,
+          site: config.auth_host
+        )
+      end
+
+    end
+
+  end
+end

data/lib/bootic_client/strategies/strategy.rb

@@ -1,5 +1,3 @@
-require 'oauth2'
-
 module BooticClient
   module Strategies
     class Strategy
@@ -8,11 +6,7 @@ module BooticClient
 
       def initialize(config, client_opts = {}, &on_new_token)
         @config, @options, @on_new_token = config, client_opts, (on_new_token || Proc.new{})
-        raise "MUST include client_id" unless config.client_id
-        raise "MUST include client_secret" unless config.client_secret
-        raise "MUST include api_root" unless config.api_root
-        validate! @options
-        reset!
+        validate!
       end
 
       def root
@@ -24,43 +18,56 @@ module BooticClient
       end
 
       def request_and_wrap(request_method, href, wrapper_class, payload = {})
-        begin
-          wrapper_class.new client.send(request_method, href, payload).body, self
-        rescue TokenError => e
-          new_token = get_token
-          options[:access_token] = new_token
-          reset!
-          on_new_token.call new_token
-          wrapper_class.new client.send(request_method, href, payload).body, self
+        pre_flight
+        retryable do
+          wrapper_class.new client.send(request_method, href, payload, request_headers).body, self
         end
       end
 
       def inspect
-        %(#<#{self.class.name} cid: #{config.client_id} root: #{config.api_root} auth: #{config.auth_host}>)
+        %(#<#{self.class.name} root: #{config.api_root}>)
       end
 
       protected
 
-      attr_reader :config, :on_new_token, :client
+      attr_reader :config, :on_new_token
+
+      def validate!
+        # Overwrite in sub classes
+        # to raise ArgumentErrors on
+        # missing config attributes of options values.
+      end
 
-      def validate!(options)
-        
+      def pre_flight
+        # Runs before every request
+        # Overwrite in sub classes to run checks
+        # (ie authorisation status, missing options, expired token refresh)
       end
 
-      def get_token
-        raise "Implement this in subclasses"
+      # Noop.
+      # Overwrite in sub classes to implement retryable requests.
+      # Example:
+      #
+      #   def retryable(&block)
+      #      begin
+      #        yield # issue request
+      #      rescue SomeException => e
+      #        fix_cause_of_exception
+      #        yield # try again
+      #      end
+      #   end
+      #
+      def retryable(&block)
+        yield
       end
 
-      def auth
-        @auth ||= OAuth2::Client.new(
-          config.client_id,
-          config.client_secret,
-          site: config.auth_host
-        )
+      # Noop. Merge these headers into every request.
+      def request_headers
+        {}
       end
 
-      def reset!
-        @client = Client.new(options)
+      def client
+        @client ||= Client.new(options)
       end
     end
   end

data/lib/bootic_client/version.rb

@@ -1,3 +1,3 @@
 module BooticClient
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/authorized_strategy_spec.rb

@@ -55,7 +55,7 @@ describe 'BooticClient::Strategies::Authorized' do
     it 'raises error' do
       expect{
         BooticClient.client(:authorized)
-      }.to raise_error
+      }.to raise_error(ArgumentError)
     end
   end
 
@@ -63,7 +63,7 @@ describe 'BooticClient::Strategies::Authorized' do
     it 'raises error' do
       expect{
         BooticClient.client(:authorized)
-      }.to raise_error
+      }.to raise_error(ArgumentError)
     end
   end
 

data/spec/basic_auth_strategy_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe 'BooticClient::Strategies::BasicAuth' do
+  require 'webmock/rspec'
+
+  let(:root_data) {
+    {
+      '_links' => {
+        'a_product' => {'href' => 'https://api.bootic.net/v1/products/1'}
+      },
+      'message' => "Hello!"
+    }
+  }
+
+  let(:product_data) {
+    {'title' => 'iPhone 6 Plus'}
+  }
+
+  let(:client) { BooticClient.client(:basic_auth, username: 'foo', password: 'bar') }
+
+  describe '#inspect' do
+    it 'is informative' do
+      expect(client.inspect).to eql %(#<BooticClient::Strategies::BasicAuth root: https://api.bootic.net/v1 username: foo>)
+    end
+  end
+
+  context 'with missing credentials' do
+    it 'raises error' do
+      expect{
+        BooticClient.client(:basic_auth)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'with invalid BasicAuth credentials' do
+    let!(:root_request) do
+      stub_request(:get, 'https://foo:bar@api.bootic.net/v1')
+        .to_return(status: 401, body: JSON.dump(root_data))
+    end
+
+    it 'raises an Unauthorized error' do
+      expect{ client.root }.to raise_error(BooticClient::UnauthorizedError)
+      expect(root_request).to have_been_requested
+    end
+  end
+
+  context 'with valid BasicAuth credentials' do
+    let!(:root_request) do
+      stub_request(:get, 'https://foo:bar@api.bootic.net/v1')
+        .to_return(status: 200, body: JSON.dump(root_data))
+    end
+
+    let!(:product_request) do
+      stub_request(:get, 'https://foo:bar@api.bootic.net/v1/products/1')
+        .to_return(status: 200, body: JSON.dump(product_data))
+    end
+
+    let!(:root) { client.root }
+
+    it 'includes Basic Auth credentials in request' do
+      expect(root_request).to have_been_requested
+      expect(root.message).to eql('Hello!')
+    end
+
+    it 'follows links as normal, including Basic Auth in every request' do
+      product = root.a_product
+      expect(product_request).to have_been_requested
+      expect(product.title).to eql 'iPhone 6 Plus'
+    end
+  end
+end

data/spec/client_credentials_strategy_spec.rb

@@ -18,7 +18,7 @@ describe 'BooticClient::Strategies::ClientCredentials' do
       BooticClient.client_id = nil
       expect{
         BooticClient.client(:client_credentials, scope: 'admin')
-      }.to raise_error
+      }.to raise_error(ArgumentError)
     end
   end
 
@@ -33,7 +33,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'=>'application/json', 'Authorization'=>"Bearer #{access_token}"}).
-        to_return(status: status, :body => JSON.dump(body))
+        to_return(status: status, body: JSON.dump(body))
     end
 
     before do

data/spec/client_spec.rb

@@ -6,9 +6,9 @@ describe BooticClient::Client do
 
   describe 'valid response' do
     let(:root_url) { 'https://api.bootic.net/v1' }
-    let(:client) { BooticClient::Client.new(access_token: 'xxx') }
+    let(:client) { BooticClient::Client.new }
     let(:request_headers) {
-      {'Accept' => 'application/json', 'Authorization' => "Bearer xxx"}
+      {'Authorization' => "Bearer xxx"}
     }
     let(:response_headers) {
       {
@@ -35,7 +35,7 @@ describe BooticClient::Client do
             .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
         end
 
-        let!(:response) { client.get(root_url) }
+        let!(:response) { client.get(root_url, {}, request_headers) }
 
         it 'returns parsed Faraday response' do
           expect(response).to be_kind_of(Faraday::Response)
@@ -53,7 +53,7 @@ describe BooticClient::Client do
           end
 
           it 'returns cached response' do
-            r = client.get(root_url)
+            r = client.get(root_url, {}, request_headers)
             expect(@cached_request).to have_been_requested
 
             expect(r.status).to eql(200)
@@ -71,7 +71,7 @@ describe BooticClient::Client do
           end
 
           it 'returns cached response' do
-            r = client.get(root_url)
+            r = client.get(root_url, {}, request_headers)
             expect(@cached_request).to have_been_requested
 
             expect(r.status).to eql(200)
@@ -83,14 +83,6 @@ describe BooticClient::Client do
       end
 
       context 'errors' do
-        describe 'no access token' do
-          it 'raises error' do
-            expect{
-              BooticClient::Client.new.get(root_url)
-            }.to raise_error(BooticClient::NoAccessTokenError)
-          end
-        end
-
         describe '500 Server error' do
           before do
             stub_request(:get, root_url)
@@ -156,7 +148,7 @@ describe BooticClient::Client do
         end
 
         it 'GETs response' do
-          expect(client.get(root_url, foo: 'bar').body['message']).to eql('Hello!')
+          expect(client.get(root_url, {foo: 'bar'}, request_headers).body['message']).to eql('Hello!')
         end
       end
 
@@ -168,7 +160,7 @@ describe BooticClient::Client do
         end
 
         it 'POSTs request and parses response' do
-          expect(client.post(root_url, foo: 'bar').body['message']).to eql('Hello!')
+          expect(client.post(root_url, {foo: 'bar'}, request_headers).body['message']).to eql('Hello!')
         end
       end
  
@@ -181,7 +173,7 @@ describe BooticClient::Client do
           end
 
           it "#{verb.to_s.upcase}s request and parses response" do
-            expect(client.send(verb, root_url, foo: 'bar').body['message']).to eql('Hello!')
+            expect(client.send(verb, root_url, {foo: 'bar'}, request_headers).body['message']).to eql('Hello!')
           end
         end
       end
@@ -194,7 +186,7 @@ describe BooticClient::Client do
         end
 
         it 'DELETEs request and parses response' do
-          expect(client.send(:delete, root_url).status).to eql(200)
+          expect(client.send(:delete, root_url, request_headers).status).to eql(200)
           expect(@delete_requst).to have_been_requested
         end
       end

data/spec/entity_spec.rb

@@ -29,6 +29,7 @@ describe BooticClient::Entity do
           {
             'title' => 'iPhone 4',
             'price' => 12345,
+            'published' => false,
             '_links' => {
               'self' => {href: '/products/iphone4'},
               'btc:delete_product' => {'href' => '/products/12345'}
@@ -43,6 +44,7 @@ describe BooticClient::Entity do
           {
             'title' => 'iPhone 5',
             'price' => 12342,
+            'published' => true,
             '_links' => {
               'self' => {href: '/products/iphone5'}
             },
@@ -52,7 +54,7 @@ describe BooticClient::Entity do
               }
             }
           }
-          
+
         ] # / items
       }
     }
@@ -118,6 +120,11 @@ describe BooticClient::Entity do
           expect(shop.name).to eql('Acme')
         end
       end
+
+      it 'includes FALSE values' do
+        expect(entity.items.first.published).to be false
+        expect(entity.items.last.published).to be true
+      end
     end #/ embedded entities
 
     describe 'link relations' do
@@ -161,7 +168,7 @@ describe BooticClient::Entity do
         end
 
         it 'takes optional URI parameters' do
-          expect(client).to receive(:request_and_wrap).with(:get, '/search?q=foo', BooticClient::Entity, {q: 'foo'}).and_return next_page
+          expect(client).to receive(:request_and_wrap).with(:get, '/search?q=foo', BooticClient::Entity, {}).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

@@ -48,8 +48,8 @@ describe BooticClient::Relation do
         end
 
         it 'interpolates tokens' do
-          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)
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/2?q=test&page=2', BooticClient::Entity, {other: 'other'}).and_return entity
+          expect(relation.run(id: 2, q: 'test', page: 2, other: 'other')).to eql(entity)
         end
       end
     end
@@ -62,9 +62,9 @@ describe BooticClient::Relation do
         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
+        client.stub(:request_and_wrap).with(:post, '/foo/123', BooticClient::Entity, {foo: 'bar'}).and_return entity
         expect(relation_templated.run(bars: 123, foo: 'bar')).to eql(entity)
       end
     end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'bootic_client'
+require 'byebug'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_client
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-07 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -186,10 +186,13 @@ files:
 - lib/bootic_client/relation.rb
 - lib/bootic_client/stores/memcache.rb
 - lib/bootic_client/strategies/authorized.rb
+- lib/bootic_client/strategies/basic_auth.rb
 - lib/bootic_client/strategies/client_credentials.rb
+- lib/bootic_client/strategies/oauth2_strategy.rb
 - lib/bootic_client/strategies/strategy.rb
 - lib/bootic_client/version.rb
 - spec/authorized_strategy_spec.rb
+- spec/basic_auth_strategy_spec.rb
 - spec/bootic_client_spec.rb
 - spec/client_credentials_strategy_spec.rb
 - spec/client_spec.rb
@@ -223,6 +226,7 @@ specification_version: 4
 summary: Official Ruby client for the Bootic API
 test_files:
 - spec/authorized_strategy_spec.rb
+- spec/basic_auth_strategy_spec.rb
 - spec/bootic_client_spec.rb
 - spec/client_credentials_strategy_spec.rb
 - spec/client_spec.rb