ddy_remote_resource 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81623623abfc2c02eca8ba86097669fe5228e691
-  data.tar.gz: d6d96b4787ab3c8fbbc9489025da6b8fa680c3b0
+  metadata.gz: fd27f10265b4c4567775dc03f968ec908257802e
+  data.tar.gz: 5abcb50998d29ad84675de80012dfc20f3b836b2
 SHA512:
-  metadata.gz: 5891d80cd394f2682b5df1f1962ac676d42966d50153637a9250c0e096ae3ddce3dd1fffd979224561669c6e02bfda14ddf2da50bd1ef86575e416c024e32257
-  data.tar.gz: 93d0f8606a690a56b8fe2f319beac338735810772ba4af8d6b9179947799dd12d06cdb6d645fdc1b1399c13575413d25ec9a4880ed0986bf647254231648321e
+  metadata.gz: 27c071103e04b51b9eef007bf57b802147c0bed726d000c547ea1561ed7e1d941733c366eb5c4a847efe4e7d2c96c43ae3170c9e006d820d362037a03a4eccee
+  data.tar.gz: 67bf285bdfd25e82f43c7f6e8c68fbfdfd9113117487e249d6f6cedb9a01b30578d2a980d6613dd0d7d205d662f575776ddf2f3761e84b903e9d5bb6ebdc6e3f

data/README.md

@@ -39,7 +39,7 @@ You can set a few options for the `RemoteResource` enabled class.
 
 #### Base URL options (`base_url`)
 
-The `base_url` is constructed from the `.site`, `.version`,  `.path_prefix`, `.path_postfix`, `.collection`, and `.collection_name` options. The `.collection_name` is automatically constructed from the relative class name.
+The `base_url` is constructed from the `.site`, `.version`,  `.path_prefix`, `.path_postfix`, `.collection`, `.collection_prefix`, and `.collection_name` options. The `.collection_name` is automatically constructed from the relative class name.
 
 We will use the `ContactPerson` class for these examples, with the `.collection_name` of `'contact_person'`:
 
@@ -59,6 +59,10 @@ We will use the `ContactPerson` class for these examples, with the `.collection_
     * *Default:* `false`
     * *Example:* `.collection = true`
     * *`base_url`:* `https://www.myapp.com/contact_persons`
+* `.collection_prefix`: This sets the prefix for the collection, before `collection_name` that is used to construct the `base_url`. The prefix variable has to be set via connection_options' key `collection_options`.
+    * *Default:* ``
+    * *Example:* `.collection_prefix = "/companies/:company_id"` and connection_options `collection_options: { company_id: 2 }`
+    * *`base_url`:* `https://www.myapp.com/companies/2/contact_persons`
 * `.collection_name`: This sets the `collection_name` that is used to construct the `base_url`.
     * *Example:* `.collection_name = "company"`
     * *`base_url`:* `https://www.myapp.com/company`

data/lib/remote_resource/url_naming.rb

@@ -3,7 +3,7 @@ module RemoteResource
     extend ActiveSupport::Concern
 
     included do
-      class_attribute :site, :version, :path_prefix, :path_postfix, :collection, :collection_name, instance_accessor: false
+      class_attribute :site, :version, :path_prefix, :path_postfix, :collection_prefix, :collection, :collection_name, instance_accessor: false
 
       self.collection = false
     end

data/lib/remote_resource/url_naming_determination.rb

@@ -16,7 +16,17 @@ module RemoteResource
 
       id           = "/#{id}" if id.present?
 
-      "#{site}#{version.presence}#{path_prefix.presence}/#{url_safe_relative_name}#{id}#{path_postfix.presence}"
+      "#{site}#{version.presence}#{path_prefix.presence}#{collection_prefix}/#{url_safe_relative_name}#{id}#{path_postfix.presence}"
+    end
+
+    def collection_prefix
+      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) }
+      end
     end
 
     def url_safe_relative_name

data/lib/remote_resource/version.rb

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

data/spec/lib/remote_resource/url_naming_determination_spec.rb

@@ -95,6 +95,67 @@ describe RemoteResource::UrlNamingDetermination do
       end
     end
 
+    context 'collection_prefix' do
+      context 'when the connection_options contain a collection_prefix' do
+        let(:connection_options) do
+          { collection_prefix: '/parent/:parent_id', collection_options: { parent_id: 696 } }
+        end
+
+        it 'uses the collection_prefix of the connection_options' do
+          expect(url_naming_determination.base_url).to eql 'http://www.foobar.com/parent/696/url_naming_determination_dummy'
+        end
+
+        context 'when collection_options is NOT present' do
+          let(:connection_options) do
+            { collection_prefix: '/parent/:parent_id' }
+          end
+
+          it 'raises an exception' do
+            expect { url_naming_determination.base_url }.to raise_error(KeyError)
+          end
+        end
+
+        context 'when collection_prefix variable is not set in the collection_options' do
+          let(:connection_options) 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)
+          end
+        end
+      end
+
+      context 'when the connection_options do NOT contain a collection_prefix' do
+        context 'and the resource_klass contains a collection_prefix' do
+          before { dummy_class.collection_prefix = '/parent/:parent_id' }
+          after { dummy_class.collection_prefix = nil }
+
+          context 'when connection_options includes collection_options with key parent_id' do
+            let(:connection_options) do
+              { collection_options: { parent_id: 696 } }
+            end
+
+            it 'uses the collection_prefix of the resource_klass' do
+              expect(url_naming_determination.base_url).to eql 'http://www.foobar.com/parent/696/url_naming_determination_dummy'
+            end
+          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)
+            end
+          end
+        end
+
+        context 'and the resource_klass does NOT contain a collection_prefix' do
+          it 'does NOT use the collection_prefix' do
+            expect(url_naming_determination.base_url).to eql 'http://www.foobar.com/url_naming_determination_dummy'
+          end
+        end
+      end
+    end
+
     context 'id' do
       context 'when an id is specified' do
         it 'uses that id in the base url' do

data/spec/lib/remote_resource/version_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddy_remote_resource
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Jan van der Pas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler