ddy_remote_resource 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd27f10265b4c4567775dc03f968ec908257802e
-  data.tar.gz: 5abcb50998d29ad84675de80012dfc20f3b836b2
+  metadata.gz: ee1e160b0d79e1f23df3b5f2005f26440bd443c5
+  data.tar.gz: 85fb186045fd88dadeccd07f349c7695c4338df9
 SHA512:
-  metadata.gz: 27c071103e04b51b9eef007bf57b802147c0bed726d000c547ea1561ed7e1d941733c366eb5c4a847efe4e7d2c96c43ae3170c9e006d820d362037a03a4eccee
-  data.tar.gz: 67bf285bdfd25e82f43c7f6e8c68fbfdfd9113117487e249d6f6cedb9a01b30578d2a980d6613dd0d7d205d662f575776ddf2f3761e84b903e9d5bb6ebdc6e3f
+  metadata.gz: 6e50af7d6a5c7049e2067ea0521c8f74030eedbf74644ff254d831b797c923c87c6e2f74c7e968cf2706ac65d86036a9e5ad212eed20d32e79b916cb34e8681a
+  data.tar.gz: 88f99d3f9c0d5b136095d0baf364017b821b8e8108019d642e8d73c24bc80b5188e5fe470b0236b3e63750a794b2a0b50cf82001c2026f74fda31a029e71b84a

data/lib/remote_resource/base.rb

@@ -2,7 +2,7 @@ module RemoteResource
   module Base
     extend ActiveSupport::Concern
 
-    OPTIONS = [:base_url, :site, :headers, :version, :path_prefix, :path_postfix, :content_type, :collection, :collection_name, :root_element]
+    OPTIONS = [:base_url, :site, :headers, :version, :path_prefix, :path_postfix, :collection_prefix, :content_type, :collection, :collection_name, :root_element]
 
     included do
       include Virtus.model

data/lib/remote_resource/request.rb

@@ -44,7 +44,7 @@ module RemoteResource
 
     def determined_request_url
       id           = attributes[:id].presence
-      base_url     = original_connection_options[:base_url].presence || determined_url_naming.base_url(id)
+      base_url     = original_connection_options[:base_url].presence || determined_url_naming.base_url(id, check_collection_options: true)
       content_type = connection_options[:content_type]
 
       "#{base_url}#{content_type}"

data/lib/remote_resource/url_naming_determination.rb

@@ -1,5 +1,6 @@
 module RemoteResource
   class UrlNamingDetermination
+    CollectionOptionKeyError = Class.new(StandardError)
 
     attr_reader :resource_klass, :connection_options
 
@@ -8,7 +9,7 @@ module RemoteResource
       @connection_options = connection_options
     end
 
-    def base_url(id = nil)
+    def base_url(id = nil, check_collection_options: false)
       site         = connection_options.fetch(:site, resource_klass.site)
       version      = connection_options.fetch(:version, resource_klass.version)
       path_prefix  = connection_options.fetch(:path_prefix, resource_klass.path_prefix)
@@ -16,16 +17,24 @@ module RemoteResource
 
       id           = "/#{id}" if id.present?
 
-      "#{site}#{version.presence}#{path_prefix.presence}#{collection_prefix}/#{url_safe_relative_name}#{id}#{path_postfix.presence}"
+      "#{site}#{version.presence}#{path_prefix.presence}#{collection_prefix(check_collection_options)}/#{url_safe_relative_name}#{id}#{path_postfix.presence}"
     end
 
-    def collection_prefix
+    def collection_prefix(check_collection_options)
       prefix = connection_options.fetch(:collection_prefix, resource_klass.collection_prefix)
 
       if prefix.present?
         prefix = "/#{prefix}" unless prefix.chr == '/'
-        collection_options = connection_options.fetch(:collection_options).with_indifferent_access
-        prefix.gsub(/:\w+/) { |key| URI.parser.escape(collection_options.fetch(key[1..-1]).to_s) }
+        collection_options = connection_options.fetch(:collection_options, {}).with_indifferent_access
+
+        prefix.gsub(/:\w+/) do |key|
+          value = collection_options.fetch(key[1..-1], nil)
+          if value.nil?
+            raise(CollectionOptionKeyError, "`collection_prefix` variable `#{key}` is missing from `collection_options`") if check_collection_options
+            value = key
+          end
+          URI.parser.escape(value.to_s)
+        end
       end
     end
 

data/lib/remote_resource/version.rb

@@ -1,3 +1,3 @@
 module RemoteResource
-  VERSION = '0.4.6'
+  VERSION = '0.4.7'
 end

data/spec/lib/remote_resource/base_spec.rb

@@ -23,7 +23,7 @@ describe RemoteResource::Base do
   specify { expect(described_class.const_defined?('RemoteResource::Querying::PersistenceMethods')).to be_truthy }
 
   describe 'OPTIONS' do
-    let(:options) { [:base_url, :site, :headers, :version, :path_prefix, :path_postfix, :content_type, :collection, :collection_name, :root_element] }
+    let(:options) { [:base_url, :site, :headers, :version, :path_prefix, :path_postfix, :collection_prefix, :content_type, :collection, :collection_name, :root_element] }
 
     specify { expect(described_class::OPTIONS).to eql options }
   end

data/spec/lib/remote_resource/connection_options_spec.rb

@@ -6,15 +6,16 @@ describe RemoteResource::ConnectionOptions do
     class ConnectionOptionsDummy
       include RemoteResource::Base
 
-      self.site           = 'https://foobar.com'
-      self.content_type   = ''
-      self.extra_headers  = { "X-Locale" => "nl" }
-      self.version        = '/v1'
-      self.path_prefix    = '/prefix'
-      self.path_postfix   = '/postfix'
-      self.content_type   = '.json'
-      self.collection     = true
-      self.root_element   = :test_dummy
+      self.site              = 'https://foobar.com'
+      self.content_type      = ''
+      self.extra_headers     = { "X-Locale" => "nl" }
+      self.version           = '/v1'
+      self.path_prefix       = '/prefix'
+      self.path_postfix      = '/postfix'
+      self.content_type      = '.json'
+      self.collection_prefix = '/parent/:parent_id'
+      self.collection        = true
+      self.root_element      = :test_dummy
 
     end
   end
@@ -77,16 +78,17 @@ describe RemoteResource::ConnectionOptions do
   describe '#to_hash' do
     let(:connection_options_hash) do
       {
-        base_url:         'https://foobar.com/v1/prefix/connection_options_dummies/postfix',
-        site:             'https://foobar.com',
-        headers:          { "Accept" => "application/json", "X-Locale" => "nl" },
-        version:          '/v1',
-        path_prefix:      '/prefix',
-        path_postfix:     '/postfix',
-        content_type:     '.json',
-        collection:       true,
-        collection_name:  nil,
-        root_element:     :test_dummy
+        base_url:          'https://foobar.com/v1/prefix/parent/:parent_id/connection_options_dummies/postfix',
+        site:              'https://foobar.com',
+        headers:           { "Accept" => "application/json", "X-Locale" => "nl" },
+        version:           '/v1',
+        path_prefix:       '/prefix',
+        path_postfix:      '/postfix',
+        content_type:      '.json',
+        collection_prefix: '/parent/:parent_id',
+        collection:        true,
+        collection_name:   nil,
+        root_element:      :test_dummy
       }
     end
 

data/spec/lib/remote_resource/request_spec.rb

@@ -11,6 +11,10 @@ describe RemoteResource::Request do
       attr_accessor :name
 
     end
+
+    class RequestDummyWithCollectionPrefix < RequestDummy
+      self.collection_prefix = '/parent/:parent_id'
+    end
   end
 
   let(:dummy_class) { RemoteResource::RequestDummy }
@@ -334,6 +338,24 @@ describe RemoteResource::Request do
         expect(request.determined_request_url).to eql 'http://www.foobar.com/request_dummy.json'
       end
     end
+
+    context 'collection_prefix' do
+      let(:dummy_class) { RemoteResource::RequestDummyWithCollectionPrefix }
+
+      context 'when connection_options does include collection_options' do
+        let(:connection_options) do
+          { collection_options: { parent_id: 23 } }
+        end
+
+        it { expect(request.determined_request_url).to eql 'http://www.foobar.com/parent/23/request_dummy_with_collection_prefix.json' }
+      end
+
+      context 'when connection_options does NOT include collection_options' do
+        it 'raises error' do
+          expect{ request.determined_request_url }.to raise_error(RemoteResource::UrlNamingDetermination::CollectionOptionKeyError)
+        end
+      end
+    end
   end
 
   describe '#determined_params' do

data/spec/lib/remote_resource/url_naming_determination_spec.rb

@@ -110,8 +110,14 @@ describe RemoteResource::UrlNamingDetermination do
             { collection_prefix: '/parent/:parent_id' }
           end
 
-          it 'raises an exception' do
-            expect { url_naming_determination.base_url }.to raise_error(KeyError)
+          it 'returns base_url with variable' do
+            expect(url_naming_determination.base_url).to eql 'http://www.foobar.com/parent/:parent_id/url_naming_determination_dummy'
+          end
+
+          context 'when check_collection_options is true' do
+            it 'raises an exception' do
+              expect { url_naming_determination.base_url(nil, check_collection_options: true) }.to raise_error(RemoteResource::UrlNamingDetermination::CollectionOptionKeyError)
+            end
           end
         end
 
@@ -120,8 +126,14 @@ describe RemoteResource::UrlNamingDetermination do
             { collection_prefix: '/parent/:parent_id', collection_options: { other_id: 696 } }
           end
 
-          it 'raises an exception' do
-            expect { url_naming_determination.base_url }.to raise_error(KeyError)
+          it 'returns base_url with variable' do
+            expect(url_naming_determination.base_url).to eql 'http://www.foobar.com/parent/:parent_id/url_naming_determination_dummy'
+          end
+
+          context 'when check_collection_options is true' do
+            it 'raises an exception' do
+              expect { url_naming_determination.base_url(nil, check_collection_options: true) }.to raise_error(RemoteResource::UrlNamingDetermination::CollectionOptionKeyError)
+            end
           end
         end
       end
@@ -142,8 +154,14 @@ describe RemoteResource::UrlNamingDetermination do
           end
 
           context 'when connection_options does NOT include collection_options' do
-            it 'uses the collection_prefix of the resource_klass' do
-              expect { url_naming_determination.base_url }.to raise_error(KeyError)
+            it 'returns base_url with variable' do
+              expect(url_naming_determination.base_url).to eql 'http://www.foobar.com/parent/:parent_id/url_naming_determination_dummy'
+            end
+
+            context 'when check_collection_options is true' do
+              it 'raises an exception' do
+                expect { url_naming_determination.base_url(nil, check_collection_options: true) }.to raise_error(RemoteResource::UrlNamingDetermination::CollectionOptionKeyError)
+              end
             end
           end
         end

data/spec/lib/remote_resource/version_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe RemoteResource::VERSION do
 
-  it { should eql '0.4.6' }
+  it { should eql '0.4.7' }
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ddy_remote_resource
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Jan van der Pas