bootic_client 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcfbbb311b78031493af896f6db383dfebdffd82
-  data.tar.gz: ddbeb3d2dd2ff06defbaa67acdfbd32006fa074e
+  metadata.gz: bd55ff4344906b2db45c139a932b1fe546bd83ac
+  data.tar.gz: 773cbf15b9e596ef502aae54e65df649c9da3bc1
 SHA512:
-  metadata.gz: b510fb186560ceeda306b87a72e22cdfbed0df944fc04c9950bf07ac9c6ec9bbb169914487d3ada5405fa57817c76b1c656e0fd209da015354057187042a7c97
-  data.tar.gz: a026d7e471ec31d53fd302f43afc8b6a80a24eaa2f827958c02ad6d6c543b4d9f4860c8158fad123a624dbb6ed67fcf482a91a6058fa7a041a44610e2311f414
+  metadata.gz: febd1da193a466980cfaaa62b8bcf29eb78a44b7629f65754b12dfd9d06c98266a005dd0fad6c2aa7a50d5b465feef096526a9edac07255dfaca9d37f9c583cc
+  data.tar.gz: 94449a8bfc7d58a03c9ae30cf80db26fe6e2946c0d7a183c05b69ee87fc4248834cf6642b2f116798026f09d9b20da4575c4cd9ce6c4ca866e17f2536b0c2f07

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [v0.0.19](https://github.com/bootic/bootic_client.rb/tree/v0.0.19) (2017-06-01)
+[Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.18...v0.0.19)
+
+**Merged pull requests:**
+
+- Raise errors on invalid URLs [\#11](https://github.com/bootic/bootic_client.rb/pull/11) ([ismasan](https://github.com/ismasan))
+
 ## [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)
 
@@ -33,7 +40,7 @@
 
 **Merged pull requests:**
 
-- Base64-encode IO instances before POST|PUT|PATH [\#6](https://github.com/bootic/bootic_client.rb/pull/6) ([ismasan](https://github.com/ismasan))
+- Base64-encode IO instances before POST|PUT|PATCH [\#6](https://github.com/bootic/bootic_client.rb/pull/6) ([ismasan](https://github.com/ismasan))
 
 ## [v0.0.13](https://github.com/bootic/bootic_client.rb/tree/v0.0.13) (2016-01-12)
 [Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.12...v0.0.13)

data/lib/bootic_client.rb

@@ -5,14 +5,15 @@ require "bootic_client/relation"
 require "bootic_client/client"
 
 module BooticClient
+  InvalidConfigurationError = Class.new(StandardError)
+  VERY_BASIC_URL_CHECK = /^(http|https):/.freeze
 
   AUTH_HOST = 'https://auth.bootic.net'.freeze
   API_ROOT = 'https://api.bootic.net/v1'.freeze
 
   class << self
-
-    attr_accessor :client_secret, :client_id, :logging, :cache_store
-    attr_writer :auth_host, :api_root, :logger
+    attr_accessor :logging
+    attr_reader :client_id, :client_secret, :cache_store
 
     def strategies
       @strategies ||= {}
@@ -27,6 +28,32 @@ module BooticClient
       strategies.fetch(strategy_name.to_sym).new self, opts, &on_new_token
     end
 
+    def client_id=(v)
+      set_non_nil :client_id, v
+    end
+
+    def client_secret=(v)
+      set_non_nil :client_secret, v
+    end
+
+    def cache_store=(v)
+      set_non_nil :cache_store, v
+    end
+
+    def auth_host=(v)
+      check_url! :auth_host, v
+      set_non_nil :auth_host, v
+    end
+
+    def api_root=(v)
+      check_url! :api_root, v
+      set_non_nil :api_root, v
+    end
+
+    def logger=(v)
+      set_non_nil :logger, v
+    end
+
     def auth_host
       @auth_host || AUTH_HOST
     end
@@ -42,6 +69,14 @@ module BooticClient
     def configure(&block)
       yield self
     end
-  end
 
+    def set_non_nil(name, v)
+      raise InvalidConfigurationError, "#{name} cannot be nil" if v.nil?
+      instance_variable_set("@#{name}", v)
+    end
+
+    def check_url!(name, v)
+      raise InvalidConfigurationError, "#{name} must be a valid URL" unless v.to_s =~ VERY_BASIC_URL_CHECK
+    end
+  end
 end

data/lib/bootic_client/entity.rb

@@ -30,7 +30,7 @@ module BooticClient
 
     attr_reader :curies, :entities
 
-    def initialize(attrs, client, top = self)
+    def initialize(attrs, client, top: self)
       @attrs = attrs.kind_of?(Hash) ? attrs : {}
       @client, @top = client, top
       build!
@@ -123,7 +123,7 @@ module BooticClient
           end
           if rel != CURIES_REL
             rel_attrs['name'] = rel
-            memo[rel.to_sym] = Relation.new(rel_attrs, client, Entity)
+            memo[rel.to_sym] = Relation.new(rel_attrs, client)
           end
         end
       )
@@ -142,9 +142,9 @@ module BooticClient
 
       @entities = attrs.fetch('_embedded', {}).each_with_object({}) do |(k,v),memo|
         memo[k.to_sym] = if v.kind_of?(Array)
-          v.map{|ent_attrs| Entity.new(ent_attrs, client, top)}
+          v.map{|ent_attrs| Entity.new(ent_attrs, client, top: top)}
         else
-          Entity.new(v, client, top)
+          Entity.new(v, client, top: top)
         end
       end
     end

data/lib/bootic_client/relation.rb

@@ -1,16 +1,26 @@
 require "bootic_client/whiny_uri"
 require "bootic_client/entity"
+require 'ostruct'
 
 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
+    class << self
+      attr_writer :complain_on_undeclared_params
+
+      def complain_on_undeclared_params
+        return true unless instance_variable_defined?('@complain_on_undeclared_params')
+        @complain_on_undeclared_params
+      end
+    end
+
+    def initialize(attrs, client, entity_class: Entity, complain_on_undeclared_params: self.class.complain_on_undeclared_params)
+      @attrs, @client, @entity_class = attrs, client, entity_class
+      @complain_on_undeclared_params = complain_on_undeclared_params
     end
 
     def inspect
@@ -61,9 +71,9 @@ module BooticClient
         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
+        client.request_and_wrap transport_method.to_sym, uri.expand(opts), entity_class, payload
       else
-        client.request_and_wrap transport_method.to_sym, href, wrapper_class, opts
+        client.request_and_wrap transport_method.to_sym, href, entity_class, opts
       end
     end
 
@@ -72,10 +82,10 @@ module BooticClient
     end
 
     protected
-    attr_reader :wrapper_class, :client, :attrs
+    attr_reader :entity_class, :client, :attrs, :complain_on_undeclared_params
 
     def uri
-      @uri ||= WhinyURI.new(href)
+      @uri ||= WhinyURI.new(href, complain_on_undeclared_params)
     end
 
     def destructive?

data/lib/bootic_client/version.rb

@@ -1,3 +1,3 @@
 module BooticClient
-  VERSION = "0.0.19"
+  VERSION = "0.0.20".freeze
 end

data/lib/bootic_client/whiny_uri.rb

@@ -4,28 +4,33 @@ module BooticClient
   class WhinyURI
     attr_reader :variables
 
-    def initialize(href)
+    def initialize(href, complain_on_undeclared_params = true)
       @href = href
       @uri = URITemplate.new(href)
       @variables = @uri.variables
+      @complain_on_undeclared_params = complain_on_undeclared_params
     end
 
     def expand(attrs = {})
+      attrs = stringify(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)
+      if complain_on_undeclared_params
+        if undeclared.any?
+          raise InvalidURLError, undeclared_err(undeclared)
+        end
       end
 
-      uri.expand attrs
+      uri.expand whitelisted(attrs)
     end
 
     private
-    attr_reader :uri, :href
+    attr_reader :uri, :href, :complain_on_undeclared_params
 
     def path_variables
       @path_variables ||= (
@@ -35,12 +40,22 @@ module BooticClient
       )
     end
 
+    def whitelisted(attrs = {})
+      variables.each_with_object({}) do |key, hash|
+        hash[key] = attrs[key] if attrs.key?(key)
+      end
+    end
+
     def missing_path_variables(attrs)
-      path_variables - attrs.keys.map(&:to_s)
+      path_variables - attrs.keys
+    end
+
+    def declared_params
+      @declared_params ||= variables - path_variables
     end
 
     def undeclared_params(attrs)
-      attrs.keys.map(&:to_s) - variables
+      attrs.keys - variables
     end
 
     def undeclared_err(undeclared)
@@ -57,6 +72,12 @@ module BooticClient
     def format_vars(vars)
       vars.map{|v| "`#{v}`"}.join(', ')
     end
+
+    def stringify(attrs)
+      attrs.each_with_object({}) do |(k, v), hash|
+        hash[k.to_s] = v
+      end
+    end
   end
 end
 

data/spec/client_credentials_strategy_spec.rb

@@ -15,7 +15,7 @@ describe 'BooticClient::Strategies::ClientCredentials' do
 
   describe 'with missing client credentials' do
     it 'raises error' do
-      BooticClient.client_id = nil
+      allow(BooticClient).to receive(:client_id).and_return nil
       expect{
         BooticClient.client(:client_credentials, scope: 'admin')
       }.to raise_error(ArgumentError)

data/spec/configuration_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe BooticClient do
+  it "raises if nil client_id" do
+    expect {
+      BooticClient.configure do |c|
+        c.client_id = nil
+      end
+    }.to raise_error BooticClient::InvalidConfigurationError
+  end
+
+  it "raises if nil client_secret" do
+    expect {
+      BooticClient.configure do |c|
+        c.client_secret = nil
+      end
+    }.to raise_error BooticClient::InvalidConfigurationError
+  end
+
+  it "raises if nil cache_store" do
+    expect {
+      BooticClient.configure do |c|
+        c.cache_store = nil
+      end
+    }.to raise_error BooticClient::InvalidConfigurationError
+  end
+
+  it "raises if nil or invalid auth_host" do
+    expect {
+      BooticClient.configure do |c|
+        c.auth_host = nil
+      end
+    }.to raise_error BooticClient::InvalidConfigurationError
+
+    expect {
+      BooticClient.configure do |c|
+        c.auth_host = 'not-a-url'
+      end
+    }.to raise_error BooticClient::InvalidConfigurationError
+  end
+
+  it "raises if nil or invalid api_root" do
+    expect {
+      BooticClient.configure do |c|
+        c.api_root = nil
+      end
+    }.to raise_error BooticClient::InvalidConfigurationError
+
+    expect {
+      BooticClient.configure do |c|
+        c.api_root = 'not-a-url'
+      end
+    }.to raise_error BooticClient::InvalidConfigurationError
+  end
+
+  it "raises if nil logger" do
+    expect {
+      BooticClient.configure do |c|
+        c.logger = nil
+      end
+    }.to raise_error BooticClient::InvalidConfigurationError
+  end
+end

data/spec/entity_spec.rb

@@ -174,6 +174,12 @@ describe BooticClient::Entity do
             expect(next_entity.page).to eql(2)
           end
         end
+
+        it 'complains if passing undeclared link params' do
+          expect {
+            entity.search(foo: 'bar')
+          }.to raise_error(BooticClient::InvalidURLError)
+        end
       end
 
     end

data/spec/relation_spec.rb

@@ -80,6 +80,25 @@ describe BooticClient::Relation do
           }.to raise_error BooticClient::InvalidURLError
         end
       end
+
+      context "configured to not complain on undeclared variables" do
+        it "whitelists params but does not complain" do
+          BooticClient::Relation.complain_on_undeclared_params = false
+
+          relation = BooticClient::Relation.new({
+            'href' => '/foos/{id}{?q,page}',
+            'templated' => true
+            },
+            client,
+          )
+
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/2?q=test&page=3', BooticClient::Entity, {foo: 1}).and_return entity
+
+          relation.run(id: 2, q: 'test', page: 3, foo: 1)
+
+          BooticClient::Relation.complain_on_undeclared_params = true
+        end
+      end
     end
 
     describe 'POST' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_client
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2018-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -201,6 +201,7 @@ files:
 - spec/bootic_client_spec.rb
 - spec/client_credentials_strategy_spec.rb
 - spec/client_spec.rb
+- spec/configuration_spec.rb
 - spec/entity_spec.rb
 - spec/fixtures/file.gif
 - spec/memcache_storage_spec.rb
@@ -227,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Official Ruby client for the Bootic API
@@ -238,6 +239,7 @@ test_files:
 - spec/bootic_client_spec.rb
 - spec/client_credentials_strategy_spec.rb
 - spec/client_spec.rb
+- spec/configuration_spec.rb
 - spec/entity_spec.rb
 - spec/fixtures/file.gif
 - spec/memcache_storage_spec.rb