Merge branch 'JsonApiClient:master' into master

Author: randyv12

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Unreleased
 
+## 1.21.0
+- [#395](https://github.com/JsonApiClient/json_api_client/pull/395) - relaxing faraday dependency to anything less than 2.0
+
+## 1.20.0
+- [#389](https://github.com/JsonApiClient/json_api_client/pull/389) - adding `create!`, `update_attributes!`, `update!` methods
+
+## 1.19.0
+- [#382](https://github.com/JsonApiClient/json_api_client/pull/382) - Add extra error classes to hande server errors.
+
+- [#386](https://github.com/JsonApiClient/json_api_client/pull/386) - use HashWithIndifferentAccess
+
 ## 1.18.0
 - [#372](https://github.com/JsonApiClient/json_api_client/pull/372) - Fix handling of dashed-types associations correctly
 
@@ -96,20 +107,20 @@
 
 ## v1.6.3
 
-- [#312](https://githup.com/JsonApiClient/json_api_client/pull/312) - Don't raise on `422`
+- [#312](https://github.com/JsonApiClient/json_api_client/pull/312) - Don't raise on `422`
 
 ## v1.6.2
 
-- [#311](https://githup.com/JsonApiClient/json_api_client/pull/311) - Raise JsonApiClient::Errors::ClientError for unhandled 4xx responses
+- [#311](https://github.com/JsonApiClient/json_api_client/pull/311) - Raise JsonApiClient::Errors::ClientError for unhandled 4xx responses
 
 ## v1.6.1
 
-- [#297](https://githup.com/JsonApiClient/json_api_client/pull/297) - Fix test_helper
-- [#298](https://githup.com/JsonApiClient/json_api_client/pull/298) - README update: arguments for custom connections run method
-- [#306](https://githup.com/JsonApiClient/json_api_client/pull/306) - README update: pagination override examples
-- [#307](https://githup.com/JsonApiClient/json_api_client/pull/307) - Symbolize params keys on model initialize
-- [#304](https://githup.com/JsonApiClient/json_api_client/pull/304) - Optional add default to changes
-- [#300](https://githup.com/JsonApiClient/json_api_client/pull/300) - Define methods for properties and associations getter/setter
+- [#297](https://github.com/JsonApiClient/json_api_client/pull/297) - Fix test_helper
+- [#298](https://github.com/JsonApiClient/json_api_client/pull/298) - README update: arguments for custom connections run method
+- [#306](https://github.com/JsonApiClient/json_api_client/pull/306) - README update: pagination override examples
+- [#307](https://github.com/JsonApiClient/json_api_client/pull/307) - Symbolize params keys on model initialize
+- [#304](https://github.com/JsonApiClient/json_api_client/pull/304) - Optional add default to changes
+- [#300](https://github.com/JsonApiClient/json_api_client/pull/300) - Define methods for properties and associations getter/setter
 
 ## v1.6.0
 

README.md

@@ -1,4 +1,4 @@
-# JsonApiClient [![Build Status](https://travis-ci.org/JsonApiClient/json_api_client.png)](https://travis-ci.org/JsonApiClient/json_api_client) [![Code Climate](https://codeclimate.com/github/JsonApiClient/json_api_client.png)](https://codeclimate.com/github/JsonApiClient/json_api_client) [![Code Coverage](https://codeclimate.com/github/JsonApiClient/json_api_client/coverage.png)](https://codeclimate.com/github/JsonApiClient/json_api_client)
+# JsonApiClient [![Build Status](https://travis-ci.org/JsonApiClient/json_api_client.png?branch=master)](https://travis-ci.org/JsonApiClient/json_api_client) [![Code Climate](https://codeclimate.com/github/JsonApiClient/json_api_client.png)](https://codeclimate.com/github/JsonApiClient/json_api_client) [![Code Coverage](https://codeclimate.com/github/JsonApiClient/json_api_client/coverage.png)](https://codeclimate.com/github/JsonApiClient/json_api_client)
 
 This gem is meant to help you build an API client for interacting with REST APIs as laid out by [http://jsonapi.org](http://jsonapi.org). It attempts to give you a query building framework that is easy to understand (it is similar to ActiveRecord scopes).
 

json_api_client.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   s.summary = 'Build client libraries compliant with specification defined by jsonapi.org'
 
   s.add_dependency "activesupport", '>= 3.2.0'
-  s.add_dependency "faraday", '>= 0.15.2', '< 1.2.0'
-  s.add_dependency "faraday_middleware", '>= 0.9.0', '< 1.2.0'
+  s.add_dependency "faraday", '>= 0.15.2', '< 2.0'
+  s.add_dependency "faraday_middleware", '>= 0.9.0', '< 2.0'
   s.add_dependency "addressable", '~> 2.2'
   s.add_dependency "activemodel", '>= 3.2.0'
   s.add_dependency "rack", '>= 0.2'

lib/json_api_client/errors.rb

@@ -44,6 +44,28 @@ class AccessDenied < ClientError
     class NotAuthorized < ClientError
     end
 
+    class NotFound < ClientError
+      attr_reader :uri
+      def initialize(uri)
+        @uri = uri
+
+        msg = "Resource not found: #{uri.to_s}"
+        super nil, msg
+      end
+    end
+
+    class RequestTimeout < ClientError
+    end
+
+    class Conflict < ClientError
+      def initialize(env, msg = 'Resource already exists')
+        super env, msg
+      end
+    end
+
+    class TooManyRequests < ClientError
+    end
+
     class ConnectionError < ApiError
     end
 
@@ -59,23 +81,16 @@ def initialize(env, msg = nil)
       end
     end
 
-    class Conflict < ServerError
-      def initialize(env, msg = 'Resource already exists')
-        super env, msg
-      end
+    class InternalServerError < ServerError
     end
 
-    class NotFound < ServerError
-      attr_reader :uri
-      def initialize(uri)
-        @uri = uri
+    class BadGateway < ServerError
+    end
 
-        msg = "Couldn't find resource at: #{uri.to_s}"
-        super nil, msg
-      end
+    class ServiceUnavailable < ServerError
     end
 
-    class InternalServerError < ServerError
+    class GatewayTimeout < ServerError
     end
 
     class UnexpectedStatus < ServerError
@@ -88,5 +103,16 @@ def initialize(code, uri)
         super nil, msg
       end
     end
+
+    class RecordNotSaved < ServerError
+      attr_reader :record
+
+      def initialize(message = nil, record = nil)
+        @record = record
+      end
+      def message
+        "Record not saved"
+      end
+    end
   end
 end

lib/json_api_client/middleware/status.rb

@@ -38,14 +38,24 @@ def handle_status(code, env)
           raise Errors::AccessDenied, env
         when 404
           raise Errors::NotFound, env[:url]
+        when 408
+          raise Errors::RequestTimeout, env
         when 409
           raise Errors::Conflict, env
         when 422
           # Allow to proceed as resource errors will be populated
+        when 429
+          raise Errors::TooManyRequests, env
         when 400..499
           raise Errors::ClientError, env
         when 500
           raise Errors::InternalServerError, env
+        when 502
+          raise Errors::BadGateway, env
+        when 503
+          raise Errors::ServiceUnavailable, env
+        when 504
+          raise Errors::GatewayTimeout, env
         when 501..599
           raise Errors::ServerError, env
         else

lib/json_api_client/query/builder.rb

@@ -67,11 +67,11 @@ def last
       end
 
       def build(attrs = {})
-        klass.new @path_params.merge(attrs.symbolize_keys)
+        klass.new @path_params.merge(attrs.with_indifferent_access)
       end
 
       def create(attrs = {})
-        klass.create @path_params.merge(attrs.symbolize_keys)
+        klass.create @path_params.merge(attrs.with_indifferent_access)
       end
 
       def params

lib/json_api_client/resource.rb

@@ -172,6 +172,12 @@ def create(attributes = {})
         end
       end
 
+      def create!(attributes = {})
+        new(attributes).tap do |resource|
+          raise(Errors::RecordNotSaved.new("Failed to save the record", resource)) unless resource.save
+        end
+      end
+
       # Within the given block, add these headers to all requests made by
       # the resource class
       #
@@ -348,7 +354,7 @@ def _build_connection(rebuild = false)
     #
     # @param params [Hash] Attributes, links, and relationships
     def initialize(params = {})
-      params = params.symbolize_keys
+      params = params.with_indifferent_access
       @persisted = nil
       @destroyed = nil
       self.links = self.class.linker.new(params.delete(:links) || {})
@@ -376,6 +382,11 @@ def update_attributes(attrs = {})
       save
     end
 
+    def update_attributes!(attrs = {})
+      self.attributes = attrs
+      save ? true : raise(Errors::RecordNotSaved.new("Failed to update the record", self))
+    end
+
     # Alias to update_attributes
     #
     # @param attrs [Hash] Attributes to update
@@ -384,6 +395,10 @@ def update(attrs = {})
       update_attributes(attrs)
     end
 
+    def update!(attrs = {})
+      update_attributes!(attrs)
+    end
+
     # Mark the record as persisted
     def mark_as_persisted!
       @persisted = true
@@ -538,7 +553,7 @@ def reset_request_select!(*resource_types)
     end
 
     def path_attributes
-      _belongs_to_params.merge attributes.slice( self.class.primary_key ).symbolize_keys
+      _belongs_to_params.merge attributes.slice( self.class.primary_key ).with_indifferent_access
     end
 
     protected

lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.18.0"
+  VERSION = "1.21.0"
 end

test/unit/creation_test.rb

@@ -66,6 +66,23 @@ def test_can_create_with_class_method
     assert_equal "Rails is Omakase", article.title
   end
 
+  def test_failed_create!
+    stub_request(:post, "http://example.com/users")
+      .to_return(headers: {content_type: "application/vnd.api+json"}, body: {
+        errors: [
+          {
+            status: "400",
+            title: "Error"
+          }
+        ]
+      }.to_json)
+
+    exception = assert_raises JsonApiClient::Errors::RecordNotSaved do
+      User.create!(name: 'Hans')
+    end
+    assert_equal "Record not saved", exception.message
+  end
+
   def test_changed_attributes_empty_after_create_with_class_method
     stub_simple_creation
     article = Article.create({
@@ -206,7 +223,65 @@ def test_can_create_with_new_record_with_relationships_and_save
     assert article.persisted?
     assert_equal article.comments.length, 1
     assert_equal "1", article.id
+  end
 
+  def test_can_create_with_new_record_with_associated_relationships_and_save
+    stub_request(:post, "http://example.com/articles")
+      .with(headers: {content_type: "application/vnd.api+json", accept: "application/vnd.api+json"}, body: {
+        data: {
+          type: "articles",
+          relationships: {
+            author: {
+              data: {
+                id: 1,
+                type: "authors"
+              }
+            }
+          },
+          attributes: {
+            title: "Rails is Omakase"
+          }
+        }
+      }.to_json)
+      .to_return(headers: {content_type: "application/vnd.api+json"}, body: {
+        data: {
+          type: "articles",
+          id: "1",
+          attributes: {
+            title: "Rails is Omakase"
+          },
+          relationships: {
+            author: {
+              data: [
+                {
+                  id: "1",
+                  type: "comments"
+                }
+              ]
+            }
+          }
+        },
+        included: [
+          {
+            id: "1",
+            type: "authors",
+          }
+        ]
+      }.to_json)
+
+    author_hash = {
+      author: {
+        data: {
+          id: 1,
+          type: 'authors'
+        }
+      }
+    }
+    article = Article.new({title: "Rails is Omakase", "relationships" => author_hash})
+
+    assert article.save
+    assert article.persisted?
+    assert_equal "1", article.id
   end
 
   def test_correct_create_with_nil_attribute_value

test/unit/errors_test.rb

@@ -96,6 +96,51 @@ def test_not_authorized
     end
   end
 
+  def test_request_timeout
+    stub_request(:get, "http://example.com/users")
+      .to_return(headers: {content_type: "text/plain"}, status: 408, body: "request timeout")
+
+    assert_raises JsonApiClient::Errors::RequestTimeout do
+      User.all
+    end
+  end
+
+  def test_too_many_requests
+    stub_request(:get, "http://example.com/users")
+      .to_return(headers: {content_type: "text/plain"}, status: 429, body: "too many requests")
+
+    assert_raises JsonApiClient::Errors::TooManyRequests do
+      User.all
+    end
+  end
+
+  def test_bad_gateway
+    stub_request(:get, "http://example.com/users")
+      .to_return(headers: {content_type: "text/plain"}, status: 502, body: "bad gateway")
+
+    assert_raises JsonApiClient::Errors::BadGateway do
+      User.all
+    end
+  end
+
+  def test_service_unavailable
+    stub_request(:get, "http://example.com/users")
+      .to_return(headers: {content_type: "text/plain"}, status: 503, body: "service unavailable")
+
+    assert_raises JsonApiClient::Errors::ServiceUnavailable do
+      User.all
+    end
+  end
+
+  def test_gateway_timeout
+    stub_request(:get, "http://example.com/users")
+      .to_return(headers: {content_type: "text/plain"}, status: 504, body: "gateway timeout")
+
+    assert_raises JsonApiClient::Errors::GatewayTimeout do
+      User.all
+    end
+  end
+
   def test_errors_are_rescuable_by_default_rescue
     begin
       raise JsonApiClient::Errors::ApiError, "Something bad happened"