ddy_remote_resource 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5d535b80c7ce7ac05077482e389f6f8c754c6468338225903774afb9720250c
-  data.tar.gz: f2c666b1216a0cca9bf544145a7fce488eca49c8a986248fd5892d315a5f504b
+  metadata.gz: 01c488609ff4533d6ea54be08027729ce36cc12af11de2d6f35bb5e56482e418
+  data.tar.gz: de39889dd48982a7c401c6c6f5172e15e76a0b35eb37e31801b7be3a3266df31
 SHA512:
-  metadata.gz: a0b2d03cc8948f7625fda15443fdd052eabfb2c9800c243aac99200d582461df08d2a9fae37edd5a5afc249635037befdca55f315345fb4286734e62b00b9929
-  data.tar.gz: 36e740906563d27c86e0f501b937ff171fca77b1fdf41203cfd47a9ee816b9ffa3bbde5482695e2b4706c415addb3043ebca2172b0690305997a0adbeac5148a
+  metadata.gz: 6658fe02ece1e49db0fa8cf6cf8d2d35ec2b338e30b1ac363c8a638ae55e036c83979ac850a19009028b2bdbbb03497c39264b3bd210050e7ce4603c98418555
+  data.tar.gz: b7515a8da8131f9981e5c3387cc7626e3ffe50939171087a469397f31bc094159e37db44e81a3c2bffa29fbc9093b3e97cd46b081d5467ed0b9bb05cfa76394e

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## [Unreleased]
+
+## [1.3.2] - 2023-08-08
+
+### Added
+
+- Allow using request body for GET requests by passing `force_get_params_in_body: true`.
+
+    User.all(params: {ids: ids}, force_get_params_in_body: true)
+
+## [1.3.1] - 2023-02-26
+
+### Changed
+
+- Update request_store dependency to 1.6.
+
+## [1.3.0] - 2022-07-04
+
+- Public release to Github.

data/lib/remote_resource/request.rb

@@ -68,7 +68,7 @@ module RemoteResource
       @query ||= begin
         params = connection_options[:params]
 
-        if params.present?
+        if params.present? && !connection_options[:force_get_params_in_body]
           RemoteResource::Util.encode_params_to_query(params)
         else
           nil
@@ -78,8 +78,11 @@ module RemoteResource
 
     def body
       @body ||= begin
-        if [:put, :patch, :post].include?(http_action)
+        case http_action
+        when :put, :patch, :post
           attributes.to_json
+        when :get
+          connection_options[:params].to_json if connection_options[:force_get_params_in_body]
         else
           nil
         end

data/lib/remote_resource/version.rb

@@ -1,3 +1,3 @@
 module RemoteResource
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.3.2'.freeze
 end

data/remote_resource.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'webmock', '~> 3'

data/spec/lib/remote_resource/querying/persistence_methods_spec.rb

@@ -16,56 +16,113 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
   end
 
   describe '.create' do
-    let(:response_body) do
-      {
-        data: {
-          id:         12,
-          title:      'Lorem Ipsum',
-          body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
-          featured:   true,
-          created_at: Time.new(2015, 10, 4, 9, 30, 0),
+    context 'when resource is persisted' do
+      let(:response_body) do
+        {
+          data: {
+            id:         12,
+            title:      'Lorem Ipsum',
+            body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+            featured:   true,
+            created_at: Time.new(2015, 10, 4, 9, 30, 0),
+          }
         }
-      }
-    end
+      end
 
-    let!(:expected_request) do
-      mock_request = stub_request(:post, 'https://www.example.com/posts.json')
-      mock_request.to_return(status: 201, body: JSON.generate(response_body))
-      mock_request
-    end
+      let!(:expected_request) do
+        mock_request = stub_request(:post, 'https://www.example.com/posts.json')
+        mock_request.to_return(status: 201, body: JSON.generate(response_body))
+        mock_request
+      end
 
-    it 'performs the HTTP request' do
-      Post.create(title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true)
-      expect(expected_request).to have_been_requested
-    end
+      it 'performs the HTTP request' do
+        Post.create(title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true)
+        expect(expected_request).to have_been_requested
+      end
 
-    it 'builds the correct resource' do
-      post = Post.create(title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true)
+      it 'builds the correct resource' do
+        post = Post.create(title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true)
 
-      aggregate_failures do
-        expect(post.persisted?).to eql true
-        expect(post.id).to eql 12
-        expect(post.title).to eql 'Lorem Ipsum'
-        expect(post.body).to eql 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
-        expect(post.featured).to eql true
-        expect(post.created_at).to eql Time.new(2015, 10, 4, 9, 30, 0)
+        aggregate_failures do
+          expect(post.persisted?).to eql true
+          expect(post.id).to eql 12
+          expect(post.title).to eql 'Lorem Ipsum'
+          expect(post.body).to eql 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
+          expect(post.featured).to eql true
+          expect(post.created_at).to eql Time.new(2015, 10, 4, 9, 30, 0)
+        end
       end
-    end
 
-    it 'does NOT change the given attributes' do
-      attributes = { title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true }
+      it 'does NOT change the given attributes' do
+        attributes = { title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true }
 
-      expect { Post.create(attributes) }.not_to change { attributes }.from(attributes.dup)
-    end
+        expect { Post.create(attributes) }.not_to change { attributes }.from(attributes.dup)
+      end
 
-    it 'does NOT change the given connection_options' do
-      attributes         = { title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true }
-      connection_options = { headers: { 'Foo' => 'Bar' } }
+      it 'does NOT change the given connection_options' do
+        attributes         = { title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true }
+        connection_options = { headers: { 'Foo' => 'Bar' } }
 
-      expect { Post.create(attributes, connection_options) }.not_to change { connection_options }.from(connection_options.dup)
+        expect { Post.create(attributes, connection_options) }.not_to change { connection_options }.from(connection_options.dup)
+      end
     end
 
-    xcontext 'return value #success? and NOT #success?' do
+    context 'when resource is NOT persisted' do
+      let(:response_body) do
+        {
+          errors: {
+            title:             ['Please use a title which is more than 5 characters'],
+            body:              ['Please fill in a body'],
+            virtual_attribute: ['You already posted today', 'Please refrain from using curse words']
+          }
+        }
+      end
+
+      let(:resource) { Post.new(title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true) }
+
+      let!(:expected_request) do
+        mock_request = stub_request(:post, 'https://www.example.com/posts.json')
+        mock_request.to_return(status: 422, body: JSON.generate(response_body))
+        mock_request
+      end
+
+      it 'returns the resource' do
+        expect(Post.create(title: 'Aliquam lobortis', featured: true)).to be_a(Post)
+      end
+
+      it 'performs the HTTP request' do
+        Post.create(title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true)
+        expect(expected_request).to have_been_requested
+      end
+
+      it 'builds the correct resource' do
+        post = Post.create(title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true)
+
+        aggregate_failures do
+          expect(post.persisted?).to eql false
+          expect(post.id).to eql nil
+          expect(post.title).to eql 'Lorem Ipsum'
+          expect(post.body).to eql 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
+          expect(post.featured).to eql true
+          expect(post.created_at).to eql nil
+          expect(post.errors.messages[:title]).to eql ['Please use a title which is more than 5 characters']
+          expect(post.errors.messages[:body]).to eql ['Please fill in a body']
+          expect(post.errors.messages[:base]).to eql ['You already posted today', 'Please refrain from using curse words']
+        end
+      end
+
+      it 'does NOT change the given attributes' do
+        attributes = { title: 'Aliquam lobortis', featured: true }
+
+        expect { Post.create(attributes) }.not_to change { attributes }.from(attributes.dup)
+      end
+
+      it 'does NOT change the given connection_options' do
+        attributes         = { title: 'Aliquam lobortis', featured: true }
+        connection_options = { headers: { 'Foo' => 'Bar' } }
+
+        expect { Post.create(attributes, connection_options) }.not_to change { connection_options }.from(connection_options.dup)
+      end
     end
   end
 
@@ -99,25 +156,22 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
 
       expect { Post.destroy(12, connection_options) }.not_to change { connection_options }.from(connection_options.dup)
     end
-
-    xcontext 'return value #success? and NOT #success?' do
-    end
   end
 
   describe '#update_attributes' do
-    let(:response_body) do
-      {
-        data: {
-          id:         12,
-          title:      'Aliquam lobortis',
-          body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
-          featured:   true,
-          created_at: Time.new(2015, 10, 4, 9, 30, 0),
+    context 'when resource is persisted' do
+      let(:response_body) do
+        {
+          data: {
+            id:         12,
+            title:      'Aliquam lobortis',
+            body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+            featured:   true,
+            created_at: Time.new(2015, 10, 4, 9, 30, 0),
+          }
         }
-      }
-    end
+      end
 
-    context 'when resource is persisted' do
       let(:resource) { Post.new(id: 12, title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true, created_at: Time.new(2015, 10, 4, 9, 30, 0)) }
 
       let!(:expected_request) do
@@ -126,6 +180,10 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
         mock_request
       end
 
+      it 'returns the resource' do
+        expect(resource.update_attributes(title: 'Aliquam lobortis', featured: true)).to eql resource
+      end
+
       it 'performs the HTTP request' do
         resource.update_attributes(title: 'Aliquam lobortis', featured: true)
         expect(expected_request).to have_been_requested
@@ -158,20 +216,31 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
 
         expect { resource.update_attributes(attributes, connection_options) }.not_to change { connection_options }.from(connection_options.dup)
       end
-
-      xcontext 'return value #success? and NOT #success?' do
-      end
     end
 
     context 'when resource is NOT persisted' do
+      let(:response_body) do
+        {
+          errors: {
+            title:             ['Please use a title which is more than 5 characters'],
+            body:              ['Please fill in a body'],
+            virtual_attribute: ['You already posted today', 'Please refrain from using curse words']
+          }
+        }
+      end
+
       let(:resource) { Post.new(title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: true) }
 
       let!(:expected_request) do
         mock_request = stub_request(:post, 'https://www.example.com/posts.json')
-        mock_request.to_return(status: 201, body: JSON.generate(response_body))
+        mock_request.to_return(status: 422, body: JSON.generate(response_body))
         mock_request
       end
 
+      it 'returns false' do
+        expect(resource.update_attributes(title: 'Aliquam lobortis', featured: true)).to eql false
+      end
+
       it 'performs the HTTP request' do
         resource.update_attributes(title: 'Aliquam lobortis', featured: true)
         expect(expected_request).to have_been_requested
@@ -183,12 +252,15 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
         post = resource
 
         aggregate_failures do
-          expect(post.persisted?).to eql true
-          expect(post.id).to eql 12
+          expect(post.persisted?).to eql false
+          expect(post.id).to eql nil
           expect(post.title).to eql 'Aliquam lobortis'
           expect(post.body).to eql 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
           expect(post.featured).to eql true
-          expect(post.created_at).to eql Time.new(2015, 10, 4, 9, 30, 0)
+          expect(post.created_at).to eql nil
+          expect(post.errors.messages[:title]).to eql ['Please use a title which is more than 5 characters']
+          expect(post.errors.messages[:body]).to eql ['Please fill in a body']
+          expect(post.errors.messages[:base]).to eql ['You already posted today', 'Please refrain from using curse words']
         end
       end
 
@@ -204,26 +276,23 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
 
         expect { resource.update_attributes(attributes, connection_options) }.not_to change { connection_options }.from(connection_options.dup)
       end
-
-      xcontext 'return value #success? and NOT #success?' do
-      end
     end
   end
 
   describe '#save' do
-    let(:response_body) do
-      {
-        data: {
-          id:         12,
-          title:      'Lorem Ipsum',
-          body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
-          featured:   false,
-          created_at: Time.new(2015, 10, 4, 9, 30, 0),
+    context 'when resource is persisted' do
+      let(:response_body) do
+        {
+          data: {
+            id:         12,
+            title:      'Lorem Ipsum',
+            body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+            featured:   false,
+            created_at: Time.new(2015, 10, 4, 9, 30, 0),
+          }
         }
-      }
-    end
+      end
 
-    context 'when resource is persisted' do
       let(:resource) { Post.new(id: 12, title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: false, created_at: Time.new(2015, 10, 4, 9, 30, 0)) }
 
       let!(:expected_request) do
@@ -232,6 +301,10 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
         mock_request
       end
 
+      it 'returns the resource' do
+        expect(resource.save).to eql resource
+      end
+
       it 'performs the HTTP request' do
         resource.save
         expect(expected_request).to have_been_requested
@@ -257,37 +330,51 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
 
         expect { resource.save(connection_options) }.not_to change { connection_options }.from(connection_options.dup)
       end
-
-      xcontext 'return value #success? and NOT #success?' do
-      end
     end
 
     context 'when resource is NOT persisted' do
+      let(:response_body) do
+        {
+          errors: {
+            title:             ['Please use a title which is more than 5 characters'],
+            body:              ['Please fill in a body'],
+            virtual_attribute: ['You already posted today', 'Please refrain from using curse words']
+          }
+        }
+      end
+
       let(:resource) { Post.new(title: 'Lorem Ipsum', body: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', featured: false) }
 
       let!(:expected_request) do
         mock_request = stub_request(:post, 'https://www.example.com/posts.json')
-        mock_request.to_return(status: 201, body: JSON.generate(response_body))
+        mock_request.to_return(status: 422, body: JSON.generate(response_body))
         mock_request
       end
 
+      it 'returns false' do
+        expect(resource.save).to eql false
+      end
+
       it 'performs the HTTP request' do
         resource.save
         expect(expected_request).to have_been_requested
       end
 
-      it 'builds the correct resource' do
+      it 'builds the correct resource  with validation errors' do
         resource.save
 
         post = resource
 
         aggregate_failures do
-          expect(post.persisted?).to eql true
-          expect(post.id).to eql 12
+          expect(post.persisted?).to eql false
+          expect(post.id).to eql nil
           expect(post.title).to eql 'Lorem Ipsum'
           expect(post.body).to eql 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
           expect(post.featured).to eql false
-          expect(post.created_at).to eql Time.new(2015, 10, 4, 9, 30, 0)
+          expect(post.created_at).to eql nil
+          expect(post.errors.messages[:title]).to eql ['Please use a title which is more than 5 characters']
+          expect(post.errors.messages[:body]).to eql ['Please fill in a body']
+          expect(post.errors.messages[:base]).to eql ['You already posted today', 'Please refrain from using curse words']
         end
       end
 
@@ -296,9 +383,6 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
 
         expect { resource.save(connection_options) }.not_to change { connection_options }.from(connection_options.dup)
       end
-
-      xcontext 'return value #success? and NOT #success?' do
-      end
     end
   end
 
@@ -337,9 +421,6 @@ RSpec.describe RemoteResource::Querying::PersistenceMethods do
       expect { resource.destroy(connection_options) }.not_to change { connection_options }.from(connection_options.dup)
     end
 
-    xcontext 'return value #success? and NOT #success?' do
-    end
-
     context 'when the id is NOT present' do
       let(:resource) { Post.new }
 

data/spec/lib/remote_resource/request_spec.rb

@@ -398,6 +398,16 @@ RSpec.describe RemoteResource::Request do
       it 'returns the URL-encoded params' do
         expect(CGI.unescape(request.query)).to eql expected_query
       end
+
+      context "when connection_options[:force_get_params_in_body] is present" do
+        let(:connection_options) do
+          { root_element: :data, force_get_params_in_body: true, params: { pseudonym: 'pseudonym', labels: [1, '2', 'three'], pagination: { page: 5, limit: 15, ordered: true } } }
+        end
+
+        it 'returns nil' do
+          expect(request.query).to be_nil
+        end
+      end
     end
 
     context 'when connection_options[:params] are NOT present' do
@@ -428,7 +438,22 @@ RSpec.describe RemoteResource::Request do
       end
     end
 
-    context 'when the http_action is NOT :put, :patch or :post' do
+    context 'when the http_action is :get and connection_options[:force_get_params_in_body] is present' do
+      let(:http_action) { :get }
+      let(:connection_options) do
+        { force_get_params_in_body: true, params: { pseudonym: 'pseudonym', labels: [1, '2', 'three'] } }
+      end
+
+      let(:expected_body) do
+        '{"pseudonym":"pseudonym","labels":[1,"2","three"]}'
+      end
+
+      it 'returns the JSON-encoded connection_options[:params]' do
+        expect(request.body).to eql expected_body
+      end
+    end
+
+    context "when the http_action is :get and connection_options[:params][:force_get_params_in_body] is not present" do
       let(:http_action) { :get }
 
       it 'returns nil' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ddy_remote_resource
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Digidentity
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -253,6 +253,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -302,7 +303,6 @@ files:
 - spec/lib/remote_resource/url_naming_determination_spec.rb
 - spec/lib/remote_resource/url_naming_spec.rb
 - spec/lib/remote_resource/util_spec.rb
-- spec/lib/remote_resource/version_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/digidentity/ddy_remote_resource
 licenses:
@@ -354,5 +354,4 @@ test_files:
 - spec/lib/remote_resource/url_naming_determination_spec.rb
 - spec/lib/remote_resource/url_naming_spec.rb
 - spec/lib/remote_resource/util_spec.rb
-- spec/lib/remote_resource/version_spec.rb
 - spec/spec_helper.rb

data/spec/lib/remote_resource/version_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe RemoteResource::VERSION do
-  it { is_expected.to eql '1.3.0' }
-end