ddy_remote_resource 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4c10288f80776d4eca63eb7f5f7db427b470d549e2050cef173a1719432e10
-  data.tar.gz: c6d661086f88ec0f9efd0b2c185f46824cfc9bbad46ae98a04db990907457a3c
+  metadata.gz: 9834a14e5c56cb3573cd70a5b29f928895baf53116926b219cf843f10a9c22df
+  data.tar.gz: bc8106a2ae149bcc1e185265d4cd49631a221f98aff93676c5c3fcec9e1833ba
 SHA512:
-  metadata.gz: 74d865281d9c94853ceff853318242bd412f34bacd33cb35c1aec4dbb3d02c55cee46a0cd412dd2fa9b6b903efaae7a339cd988a803436f6ba765510d0649022
-  data.tar.gz: cb9220f100cb61250b34f64c9368966aa300bf364a402d754b83b00f10ec78b95295b3274ce1e235bd37fbdebc3b959f0e311478aed153e7b9528308f8053006
+  metadata.gz: adb751faffb267b13f17b7645ab2690c262f7c3c9b7df8f46374afcf455f2f7beacb80b45bcff50489446e786df01ac1416b3d4816d7f4e0c67721079da52de6
+  data.tar.gz: d9e331a8342b281aebb2d07c087192dad0415c1aeab60d19966f9ae5c6eefd0880dce73002d757f57d004a8d9dbbb0ac381e612618333105645a3aa95937f1d4

data/lib/remote_resource/base.rb

@@ -23,6 +23,7 @@ module RemoteResource
       attr_writer :destroyed, :persisted, :success
 
       class_attribute :root_element, instance_accessor: false
+      class_attribute :json_spec, instance_accessor: false
 
       attribute :id
     end

data/lib/remote_resource/connection_options.rb

@@ -1,7 +1,7 @@
 module RemoteResource
   class ConnectionOptions
 
-    AVAILABLE_OPTIONS = [:site, :headers, :default_headers, :version, :path_prefix, :path_postfix, :collection_prefix, :extension, :collection, :collection_name, :root_element].freeze
+    AVAILABLE_OPTIONS = [:site, :headers, :default_headers, :version, :path_prefix, :path_postfix, :collection_prefix, :extension, :collection, :collection_name, :root_element, :json_spec].freeze
 
     attr_reader :base_class
 

data/lib/remote_resource/request.rb

@@ -84,12 +84,20 @@ module RemoteResource
     end
 
     def attributes
-      root_element = connection_options[:root_element]
-
-      if root_element.present?
-        { root_element => @attributes }
+      if connection_options[:json_spec] == :json_api
+        if @attributes
+          { data: { id: @attributes[:id], type: resource_klass.name.demodulize, attributes: @attributes.except(:id) } }
+        else
+          { data: {} }
+        end
       else
-        @attributes || {}
+        root_element = connection_options[:root_element]
+
+        if root_element.present?
+          { root_element => @attributes }
+        else
+          @attributes || {}
+        end
       end
     end
 
@@ -114,25 +122,44 @@ module RemoteResource
 
     def raise_http_error(request, response)
       case response.try(:response_code)
-      when 301, 302, 303, 307 then raise RemoteResource::HTTPRedirectionError.new(request, response)
-      when 400 then raise RemoteResource::HTTPBadRequest.new(request, response)
-      when 401 then raise RemoteResource::HTTPUnauthorized.new(request, response)
-      when 403 then raise RemoteResource::HTTPForbidden.new(request, response)
-      when 404 then raise RemoteResource::HTTPNotFound.new(request, response)
-      when 405 then raise RemoteResource::HTTPMethodNotAllowed.new(request, response)
-      when 406 then raise RemoteResource::HTTPNotAcceptable.new(request, response)
-      when 408 then raise RemoteResource::HTTPRequestTimeout.new(request, response)
-      when 409 then raise RemoteResource::HTTPConflict.new(request, response)
-      when 410 then raise RemoteResource::HTTPGone.new(request, response)
-      when 418 then raise RemoteResource::HTTPTeapot.new(request, response)
-      when 444 then raise RemoteResource::HTTPNoResponse.new(request, response)
-      when 494 then raise RemoteResource::HTTPRequestHeaderTooLarge.new(request, response)
-      when 495 then raise RemoteResource::HTTPCertError.new(request, response)
-      when 496 then raise RemoteResource::HTTPNoCert.new(request, response)
-      when 497 then raise RemoteResource::HTTPToHTTPS.new(request, response)
-      when 499 then raise RemoteResource::HTTPClientClosedRequest.new(request, response)
-      when 400..499 then raise RemoteResource::HTTPClientError.new(request, response)
-      when 500..599 then raise RemoteResource::HTTPServerError.new(request, response)
+      when 301, 302, 303, 307 then
+        raise RemoteResource::HTTPRedirectionError.new(request, response)
+      when 400 then
+        raise RemoteResource::HTTPBadRequest.new(request, response)
+      when 401 then
+        raise RemoteResource::HTTPUnauthorized.new(request, response)
+      when 403 then
+        raise RemoteResource::HTTPForbidden.new(request, response)
+      when 404 then
+        raise RemoteResource::HTTPNotFound.new(request, response)
+      when 405 then
+        raise RemoteResource::HTTPMethodNotAllowed.new(request, response)
+      when 406 then
+        raise RemoteResource::HTTPNotAcceptable.new(request, response)
+      when 408 then
+        raise RemoteResource::HTTPRequestTimeout.new(request, response)
+      when 409 then
+        raise RemoteResource::HTTPConflict.new(request, response)
+      when 410 then
+        raise RemoteResource::HTTPGone.new(request, response)
+      when 418 then
+        raise RemoteResource::HTTPTeapot.new(request, response)
+      when 444 then
+        raise RemoteResource::HTTPNoResponse.new(request, response)
+      when 494 then
+        raise RemoteResource::HTTPRequestHeaderTooLarge.new(request, response)
+      when 495 then
+        raise RemoteResource::HTTPCertError.new(request, response)
+      when 496 then
+        raise RemoteResource::HTTPNoCert.new(request, response)
+      when 497 then
+        raise RemoteResource::HTTPToHTTPS.new(request, response)
+      when 499 then
+        raise RemoteResource::HTTPClientClosedRequest.new(request, response)
+      when 400..499 then
+        raise RemoteResource::HTTPClientError.new(request, response)
+      when 500..599 then
+        raise RemoteResource::HTTPServerError.new(request, response)
       else
         raise RemoteResource::HTTPError.new(request, response)
       end

data/lib/remote_resource/response.rb

@@ -44,19 +44,29 @@ module RemoteResource
 
     def attributes
       @attributes ||= begin
-        root_element = @connection_options[:root_element].to_s
-        data         = nil
-
-        if root_element.present?
-          data = parsed_body.try(:key?, root_element) && parsed_body[root_element]
+        if @connection_options[:json_spec] == :json_api
+          data = parsed_body.fetch("data", {})
+          if data.is_a?(Array)
+            data.map { |row| row["attributes"].merge({ "id" => row["id"] }) }
+          elsif data.key?("attributes")
+            data["attributes"].merge({ "id" => data["id"] })
+          else
+            data
+          end
         else
-          data = parsed_body
-        end
+          root_element = @connection_options[:root_element].to_s
 
-        if data.is_a?(Array)
-          data
-        else
-          data.presence || {}
+          if root_element.present?
+            data = parsed_body.try(:key?, root_element) && parsed_body[root_element]
+          else
+            data = parsed_body
+          end
+
+          if data.is_a?(Array)
+            data
+          else
+            data.presence || {}
+          end
         end
       end
     end

data/lib/remote_resource/version.rb

@@ -1,3 +1,3 @@
 module RemoteResource
-  VERSION = '1.0.5'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/lib/remote_resource/connection_options_spec.rb

@@ -24,7 +24,7 @@ RSpec.describe RemoteResource::ConnectionOptions do
   end
 
   let(:dummy_class) { RemoteResource::ConnectionOptionsDummy }
-  let(:dummy)       { dummy_class.new }
+  let(:dummy) { dummy_class.new }
 
   let(:connection_options) { described_class.new dummy_class }
 
@@ -59,8 +59,8 @@ RSpec.describe RemoteResource::ConnectionOptions do
   describe '#merge' do
     let(:custom_connection_options) do
       {
-        site: 'https://dummy.foobar.com',
-        version: '/api/v2',
+        site:         'https://dummy.foobar.com',
+        version:      '/api/v2',
         root_element: :test_dummy_api
       }
     end
@@ -91,7 +91,8 @@ RSpec.describe RemoteResource::ConnectionOptions do
         collection_prefix: '/parent/:parent_id',
         collection:        true,
         collection_name:   nil,
-        root_element:      :test_dummy
+        root_element:      :test_dummy,
+        json_spec:         nil
       }
     end
 

data/spec/lib/remote_resource/request_spec.rb

@@ -18,10 +18,10 @@ RSpec.describe RemoteResource::Request do
   end
 
   let(:dummy_class) { RemoteResource::RequestDummy }
-  let(:dummy)       { dummy_class.new id: '12' }
+  let(:dummy) { dummy_class.new id: '12' }
 
-  let(:resource)           { dummy_class }
-  let(:http_action)        { :get }
+  let(:resource) { dummy_class }
+  let(:http_action) { :get }
   let(:connection_options) { {} }
   let(:attributes) do
     { name: 'Mies' }
@@ -68,6 +68,7 @@ RSpec.describe RemoteResource::Request do
 
     let(:block_connection_options) do
       {
+        json_spec:    'From .with_connection_options',
         root_element: 'From .with_connection_options',
         version:      'From .with_connection_options',
         path_prefix:  'From .with_connection_options'
@@ -85,6 +86,7 @@ RSpec.describe RemoteResource::Request do
       {
         site:              'From Klass.site',
         root_element:      'From connection_options[]',
+        json_spec:         'From .with_connection_options',
         version:           'From .with_connection_options',
         path_prefix:       'From .with_connection_options',
         path_postfix:      'From connection_options[]',
@@ -270,7 +272,7 @@ RSpec.describe RemoteResource::Request do
       let(:expected_request_url) { '' }
 
       it 'raises the RemoteResource::HTTPMethodUnsupported error' do
-        expect{ request.perform }.to raise_error RemoteResource::HTTPMethodUnsupported, 'Requested HTTP method=foo is NOT supported, the HTTP action MUST be a supported HTTP action=get, put, patch, post, delete'
+        expect { request.perform }.to raise_error RemoteResource::HTTPMethodUnsupported, 'Requested HTTP method=foo is NOT supported, the HTTP action MUST be a supported HTTP action=get, put, patch, post, delete'
       end
     end
   end
@@ -367,7 +369,7 @@ RSpec.describe RemoteResource::Request do
 
       context 'when connection_options does NOT include collection_options' do
         it 'raises error' do
-          expect{ request.request_url }.to raise_error(RemoteResource::CollectionOptionKeyError)
+          expect { request.request_url }.to raise_error(RemoteResource::CollectionOptionKeyError)
         end
       end
     end
@@ -473,6 +475,30 @@ RSpec.describe RemoteResource::Request do
         end
       end
     end
+
+    context 'when connection_options[:json_spec] == :json_api' do
+      let(:connection_options) do
+        { json_spec: :json_api }
+      end
+
+      let(:attributes) do
+        { id: 1, name: 'Mies', featured: true, labels: [1, '2', 'three'] }
+      end
+
+      it 'returns the given attributes wrapped in the json api spec' do
+        expect(request.attributes).to eql({ data: { id: 1, type: "RequestDummy", attributes: { name: 'Mies', featured: true, labels: [1, '2', 'three'] } } })
+      end
+
+      context 'and there are NO given attributes' do
+        let(:attributes) do
+          nil
+        end
+
+        it 'returns nil wrapped in the connection_options[:root_element]' do
+          expect(request.attributes).to eql({ data: {} })
+        end
+      end
+    end
   end
 
   describe '#headers' do
@@ -506,7 +532,7 @@ RSpec.describe RemoteResource::Request do
       end
 
       before { RemoteResource::Base.global_headers = { 'User-Agent' => 'From RemoteResource::Base.global_headers', 'X-Locale' => 'From RemoteResource::Base.global_headers' } }
-      after  { RemoteResource::Base.global_headers = nil }
+      after { RemoteResource::Base.global_headers = nil }
 
       it 'returns the default headers while overwriting the headers according to the correct precedence' do
         expect(request.headers).to eql expected_headers
@@ -562,7 +588,7 @@ RSpec.describe RemoteResource::Request do
 
   describe '#raise_http_error' do
     let(:connection_response) { instance_double(Typhoeus::Response, request: instance_double(Typhoeus::Request)) }
-    let(:response)            { RemoteResource::Response.new(connection_response, connection_options) }
+    let(:response) { RemoteResource::Response.new(connection_response, connection_options) }
 
     context 'when the response code is 301, 302, 303 or 307' do
       response_codes = [301, 302, 303, 307]

data/spec/lib/remote_resource/response_spec.rb

@@ -14,14 +14,14 @@ RSpec.describe RemoteResource::Response do
   end
 
   let(:dummy_class) { RemoteResource::ResponseDummy }
-  let(:dummy)       { dummy_class.new(id: '12') }
+  let(:dummy) { dummy_class.new(id: '12') }
 
   let(:connection_options) do
     { collection: true }
   end
-  let(:request)             { RemoteResource::Request.new(dummy_class, :post, { name: 'Mies' }, connection_options) }
+  let(:request) { RemoteResource::Request.new(dummy_class, :post, { name: 'Mies' }, connection_options) }
   let(:connection_response) { Typhoeus::Response.new(mock: true, code: 201, body: { id: 12, name: 'Mies' }.to_json, headers: { 'Content-Type' => 'application/json', 'Server' => 'nginx/1.4.6 (Ubuntu)' }) }
-  let(:connection_request)  { Typhoeus::Request.new('http://www.foobar.com/response_dummies.json', method: :post, body: { name: 'Mies' }.to_json, headers: { 'Content-Type' => 'application/json' }) }
+  let(:connection_request) { Typhoeus::Request.new('http://www.foobar.com/response_dummies.json', method: :post, body: { name: 'Mies' }.to_json, headers: { 'Content-Type' => 'application/json' }) }
 
   let(:response) { described_class.new(connection_response, connection_options.merge(request: request, connection_request: connection_request)) }
 
@@ -156,6 +156,36 @@ RSpec.describe RemoteResource::Response do
         expect(response.attributes).to eql({})
       end
     end
+
+    context 'with the json_api spec' do
+      let(:connection_options) do
+        { root_element: :data, json_spec: :json_api }
+      end
+
+      context "single response" do
+        let(:connection_response) { Typhoeus::Response.new(mock: true, code: 201, body: { data: { id: 12, attributes: { name: 'Mies' } } }.to_json, headers: { 'Content-Type' => 'application/json', 'Server' => 'nginx/1.4.6 (Ubuntu)' }) }
+
+        it 'parses the attributes from the nested hash' do
+          expect(response.attributes).to eql({ 'id' => 12, 'name' => 'Mies' })
+        end
+      end
+
+      context "empty response" do
+        let(:connection_response) { Typhoeus::Response.new(mock: true, code: 204, body: {}.to_json, headers: { 'Content-Type' => 'application/json', 'Server' => 'nginx/1.4.6 (Ubuntu)' }) }
+
+        it 'parses the attributes from the nested hash' do
+          expect(response.attributes).to eql({})
+        end
+      end
+
+      context "collection response" do
+        let(:connection_response) { Typhoeus::Response.new(mock: true, code: 201, body: { data: [{ id: 12, attributes: { name: 'Mies' } }] }.to_json, headers: { 'Content-Type' => 'application/json', 'Server' => 'nginx/1.4.6 (Ubuntu)' }) }
+
+        it 'parses the attributes from the nested hash' do
+          expect(response.attributes).to eql(['id' => 12, 'name' => 'Mies'])
+        end
+      end
+    end
   end
 
   describe '#errors' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddy_remote_resource
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Jan van der Pas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2019-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,22 +206,22 @@ dependencies:
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -319,8 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: RemoteResource, a gem to use resources with REST services.