bootic_client 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a89d8b5c05c6db2600def4db1c010412968182c
-  data.tar.gz: 407389c386a7f6323a4651b7200ce00881c9b0e9
+  metadata.gz: dcfbbb311b78031493af896f6db383dfebdffd82
+  data.tar.gz: ddbeb3d2dd2ff06defbaa67acdfbd32006fa074e
 SHA512:
-  metadata.gz: 703206264feeb2ce9e7baa20da05704655736e6429c9df239dadb6c7f7b6b59af21a154be20665d31760a372e829606665f68852c4a025a55bd20ce418fdbc63
-  data.tar.gz: 7001187975d691991a6ef3df1e8641776fdd42bc0462c3ad6f1580a6805a455cb2cccc2e64f82000f46ac5b05978c5015b65e797644047df06c9a18e4ca9718a
+  metadata.gz: b510fb186560ceeda306b87a72e22cdfbed0df944fc04c9950bf07ac9c6ec9bbb169914487d3ada5405fa57817c76b1c656e0fd209da015354057187042a7c97
+  data.tar.gz: a026d7e471ec31d53fd302f43afc8b6a80a24eaa2f827958c02ad6d6c543b4d9f4860c8158fad123a624dbb6ed67fcf482a91a6058fa7a041a44610e2311f414

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [v0.0.18](https://github.com/bootic/bootic_client.rb/tree/v0.0.18) (2017-04-03)
+[Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.17...v0.0.18)
+
+**Merged pull requests:**
+
+- Bearer token strategy [\#10](https://github.com/bootic/bootic_client.rb/pull/10) ([ismasan](https://github.com/ismasan))
+
 ## [v0.0.17](https://github.com/bootic/bootic_client.rb/tree/v0.0.17) (2017-04-02)
 [Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.16...v0.0.17)
 

data/README.md

@@ -39,7 +39,7 @@ end
 ### Using with an existing access token
 
 ```ruby
-bootic = BooticClient.client(:authorized, access_token: 'beidjbewjdiedue...', logging: true)
+bootic = BooticClient.client(:authorized, access_token: 'beidjbewjdiedue...')
 
 root = bootic.root
 
@@ -134,6 +134,12 @@ NOTE: `username` and `password` have nothing to do with your Bootic administrati
 This strategy adds an access token as a header in the format `Authorization: Bearer <your-token-here>`.
 It will not try to refresh an expired token from an Oauth2 server, so there's no need to configure Oauth2 credentials.
 
+```ruby
+client = BooticClient.client(:bearer, access_token: 'foobar')
+
+root = client.root # etc
+```
+
 Use this with APIs that don't expire tokens, or for testing.
 
 ## Non GET links

data/lib/bootic_client/errors.rb

@@ -5,4 +5,6 @@ module BooticClient
   class AuthorizationError < ServerError; end
   class UnauthorizedError < AuthorizationError; end
   class AccessForbiddenError < AuthorizationError; end
+  class ClientError < TransportError; end
+  class InvalidURLError < ClientError; end
 end

data/lib/bootic_client/relation.rb

@@ -1,4 +1,4 @@
-require 'uri_template'
+require "bootic_client/whiny_uri"
 require "bootic_client/entity"
 
 module BooticClient
@@ -6,6 +6,8 @@ module BooticClient
   class Relation
 
     GET = 'get'.freeze
+    HEAD = 'head'.freeze
+    OPTIONS = 'options'.freeze
 
     def initialize(attrs, client, wrapper_class = Entity)
       @attrs, @client, @wrapper_class = attrs, client, wrapper_class
@@ -48,7 +50,7 @@ module BooticClient
     end
 
     def transport_method
-      @transport_method ||= attrs['method'] || GET
+      @transport_method ||= attrs.key?('method') ? attrs['method'].to_s.downcase : GET
     end
 
     def run(opts = {})
@@ -57,6 +59,8 @@ module BooticClient
         payload = opts.each_with_object({}) do |(k,v),memo|
           memo[k] = v unless uri_vars.include?(k.to_s)
         end
+        # remove payload vars from URI opts if destructive action
+        opts = opts.reject{|k, v| !uri_vars.include?(k.to_s) } if destructive?
         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
@@ -64,15 +68,18 @@ module BooticClient
     end
 
     def self.expand(href, opts = {})
-      URITemplate.new(href).expand(opts)
+      WhinyURI.new(href).expand(opts)
     end
 
     protected
     attr_reader :wrapper_class, :client, :attrs
 
     def uri
-      @uri ||= URITemplate.new(href)
+      @uri ||= WhinyURI.new(href)
     end
-  end
 
+    def destructive?
+      ![GET, OPTIONS, HEAD].include? transport_method
+    end
+  end
 end

data/lib/bootic_client/version.rb

@@ -1,3 +1,3 @@
 module BooticClient
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

data/lib/bootic_client/whiny_uri.rb

@@ -0,0 +1,62 @@
+require 'uri_template'
+
+module BooticClient
+  class WhinyURI
+    attr_reader :variables
+
+    def initialize(href)
+      @href = href
+      @uri = URITemplate.new(href)
+      @variables = @uri.variables
+    end
+
+    def expand(attrs = {})
+      missing = missing_path_variables(attrs)
+      if missing.any?
+        raise InvalidURLError, missing_err(missing)
+      end
+
+      undeclared = undeclared_params(attrs)
+      if undeclared.any?
+        raise InvalidURLError, undeclared_err(undeclared)
+      end
+
+      uri.expand attrs
+    end
+
+    private
+    attr_reader :uri, :href
+
+    def path_variables
+      @path_variables ||= (
+        variables.find_all{ |v|
+          Regexp.new("(\/\{#{v}\})|(\{\/#{v}\})") =~ href
+        }
+      )
+    end
+
+    def missing_path_variables(attrs)
+      path_variables - attrs.keys.map(&:to_s)
+    end
+
+    def undeclared_params(attrs)
+      attrs.keys.map(&:to_s) - variables
+    end
+
+    def undeclared_err(undeclared)
+      msg = ["undeclared URI variables: #{format_vars(undeclared)}"]
+      query_vars = variables - path_variables
+      msg << "Allowed query variables are #{format_vars(query_vars)}" if query_vars.any?
+      msg.join('. ')
+    end
+
+    def missing_err(missing)
+      "missing required path variables: #{format_vars(missing)}"
+    end
+
+    def format_vars(vars)
+      vars.map{|v| "`#{v}`"}.join(', ')
+    end
+  end
+end
+

data/spec/relation_spec.rb

@@ -54,9 +54,15 @@ describe BooticClient::Relation do
           expect(relation.templated?).to eql(true)
         end
 
+        it 'complains if missing path variables' do
+          expect{
+            relation.run
+          }.to raise_error BooticClient::InvalidURLError
+        end
+
         it 'works with defaults' do
-          expect(client).to receive(:request_and_wrap).with(:get, '/foos/', BooticClient::Entity, {}).and_return entity
-          expect(relation.run).to eql(entity)
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/123', BooticClient::Entity, {}).and_return entity
+          expect(relation.run(id: 123)).to eql(entity)
         end
 
         it 'has parameter list' do
@@ -64,8 +70,14 @@ 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, {other: 'other'}).and_return entity
-          expect(relation.run(id: 2, q: 'test', page: 2, other: 'other')).to eql(entity)
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/2?q=test&page=2', BooticClient::Entity, {}).and_return entity
+          expect(relation.run(id: 2, q: 'test', page: 2)).to eql(entity)
+        end
+
+        it 'complains if passing undeclared query variables' do
+          expect{
+            relation.run(id: 2, q: 'test', page: 2, other: 'foo')
+          }.to raise_error BooticClient::InvalidURLError
         end
       end
     end
@@ -79,7 +91,7 @@ describe BooticClient::Relation do
         expect(relation.run).to eql(entity)
       end
 
-      it 'interpolates templated URLs' do
+      it 'interpolates templated URLs and sends remaining as BODY' do
         allow(client).to receive(: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

data/spec/whiny_uri_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require "bootic_client/whiny_uri"
+
+describe BooticClient::WhinyURI do
+  describe '#expand' do
+    let(:uri) {
+      described_class.new('http://www.host.com/shops/{id}/{?foo}')
+    }
+
+    it 'complains if missing a path segment' do
+      expect{
+        uri.expand(foo: 1)
+      }.to raise_error BooticClient::InvalidURLError
+    end
+
+    it 'understand different path segment syntax' do
+      uri = described_class.new('http://www.host.com/shops{/id}/{?foo}')
+      expect{
+        uri.expand(foo: 1)
+      }.to raise_error BooticClient::InvalidURLError
+    end
+
+    it 'expands if all path variables provided' do
+      expect(uri.expand(id: 123))
+        .to eql 'http://www.host.com/shops/123/'
+    end
+
+    it 'complains if passing undeclared params' do
+      expect{
+        uri.expand(id: 123, nope: 'nope')
+      }.to raise_error BooticClient::InvalidURLError
+    end
+
+    it 'understand variable lists in query' do
+      uri = described_class.new('http://www.host.com/shops{/id}/{?foo,bar}')
+      expect{
+        uri.expand(id: 123, foo: 'foo', bar: 'bar', nope: 'nope')
+      }.to raise_error BooticClient::InvalidURLError
+    end
+
+    it 'expands if passing declared query variables' do
+      expect(uri.expand(id: 123, foo: 'yes'))
+        .to eql 'http://www.host.com/shops/123/?foo=yes'
+    end
+
+    it 'expands if passing declared query variables defined as list' do
+      uri = described_class.new('http://www.host.com/shops{/id}/{?foo,bar}')
+      expect(uri.expand(id: 123, foo: 'yes', bar: 'no'))
+        .to eql 'http://www.host.com/shops/123/?foo=yes&bar=no'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_client
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -194,6 +194,7 @@ files:
 - lib/bootic_client/strategies/oauth2_strategy.rb
 - lib/bootic_client/strategies/strategy.rb
 - lib/bootic_client/version.rb
+- lib/bootic_client/whiny_uri.rb
 - spec/authorized_strategy_spec.rb
 - spec/basic_auth_strategy_spec.rb
 - spec/bearer_strategy_spec.rb
@@ -205,6 +206,7 @@ files:
 - spec/memcache_storage_spec.rb
 - spec/relation_spec.rb
 - spec/spec_helper.rb
+- spec/whiny_uri_spec.rb
 homepage: https://developers.bootic.net
 licenses:
 - MIT
@@ -241,3 +243,4 @@ test_files:
 - spec/memcache_storage_spec.rb
 - spec/relation_spec.rb
 - spec/spec_helper.rb
+- spec/whiny_uri_spec.rb