json_api_client 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0d020be7e9bf6e1b22999ffc3a0acde1ecc5625
-  data.tar.gz: 5125ad8d9ea03cf4cf58c77e4031d678de6778f8
+  metadata.gz: c6080263ed5bd33871ec24abc5e89a8f70b6e63c
+  data.tar.gz: c084e334f7435d9301f5c5577df6b8b7b8baf6c5
 SHA512:
-  metadata.gz: 625e1b33f72351b242e9d3ed4920b43be7ab14c150c71eeb3d7f5f077a644d5bc8dfee01c58855735e3095d5f084e32ecd86ce0f3075f70bd869b1765e72b3c9
-  data.tar.gz: 7f8675ae9030f8b1d4d1342d77075c73f117715a0b3b8540144ca7074701e38fbed1f0e3b4c793fbddcdb588d627ae166beda7c2908d79fe7cd3f0ab66677205
+  metadata.gz: 141e23e17b57f4aa31a7299cb9d43acf177bc9703869dd4e97577cc32da7ee3bfe8924fdb69ff2ae8c62b3972d6b209c4b1848e940bdcbb2e33adf2fbf955ad9
+  data.tar.gz: 74b02104a09ef030924b5b885e397c35facd293e749a03a9fa8e8a83f2c11799a5006563d5dd095ec709623e4e393296a0a0b852433562cfec960aeeb2c1b70d

data/README.md

@@ -447,6 +447,17 @@ end
 
 You can customize how your resources find pagination information from the response.
 
+If the [existing paginator](https://github.com/chingor13/json_api_client/blob/master/lib/json_api_client/paginating/paginator.rb) fits your requirements but you don't use the default `page` and `per_page` params for pagination, you can customise the param keys as follows:
+
+```ruby
+JsonApiClient::Paginating::Paginator.page_param = "page[number]"
+JsonApiClient::Paginating::Paginator.per_page_param = "page[size]"
+```
+
+Please note that this is a global configuration, so library authors should create a custom paginator that inherits `JsonApiClient::Paginating::Paginator` and configure the custom paginator to avoid modifying global config.
+
+If the [existing paginator](https://github.com/chingor13/json_api_client/blob/master/lib/json_api_client/paginating/paginator.rb) does not fit your needs, you can create a custom paginator:
+
 ```ruby
 class MyPaginator
   def initialize(result_set, data); end
@@ -458,6 +469,36 @@ class MyApi::Base < JsonApiClient::Resource
 end
 ```
 
+
+### Type Casting
+
+You can define your own types and its casting mechanism for schema.
+
+```ruby
+require 'money'
+class MyMoneyCaster
+  def self.cast(value, default)
+    begin
+      Money.new(value, "USD")
+    rescue ArgumentError
+      default
+    end
+  end
+end
+   
+JsonApiClient::Schema.register money: MyMoneyCaster
+
+```
+and finally
+
+```ruby
+class Order < JsonApiClient::Resource
+  property :total_amount, type: :money
+end
+
+```
+
+
 ## Changelog
 
 See [changelog](https://github.com/chingor13/json_api_client/blob/master/CHANGELOG.md)

data/lib/json_api_client/paginating/paginator.rb

@@ -1,11 +1,18 @@
 module JsonApiClient
   module Paginating
     class Paginator
+      class_attribute :page_param,
+                      :per_page_param
+
+      self.page_param = "page"
+      self.per_page_param = "per_page"
+
       attr_reader :params, :result_set, :links
+
       def initialize(result_set, data)
         @params = params_for_uri(result_set.uri)
         @result_set = result_set
-        @links = data['links']
+        @links = data["links"]
       end
 
       def next
@@ -28,7 +35,7 @@ module JsonApiClient
         if links["last"]
           uri = result_set.links.link_url_for("last")
           last_params = params_for_uri(uri)
-          last_params.fetch("page") do
+          last_params.fetch(page_param) do
             current_page
           end.to_i
         else
@@ -47,13 +54,13 @@ module JsonApiClient
       end
 
       def per_page
-        params.fetch("per_page") do
+        params.fetch(per_page_param) do
           result_set.length
         end.to_i
       end
 
       def current_page
-        params.fetch("page", 1).to_i
+        params.fetch(page_param, 1).to_i
       end
 
       def out_of_bounds?

data/lib/json_api_client/resource.rb

@@ -398,7 +398,7 @@ module JsonApiClient
       if last_result_set.has_errors?
         last_result_set.errors.each do |error|
           if error.source_parameter
-            errors.add(error.source_parameter, error.title || error.detail)
+            errors.add(self.class.key_formatter.unformat(error.source_parameter), error.title || error.detail)
           else
             errors.add(:base, error.title || error.detail)
           end
@@ -409,6 +409,7 @@ module JsonApiClient
         mark_as_persisted!
         if updated = last_result_set.first
           self.attributes = updated.attributes
+          self.links.attributes = updated.links.attributes
           self.relationships.attributes = updated.relationships.attributes
           clear_changes_information
         end

data/lib/json_api_client/schema.rb

@@ -1,36 +1,108 @@
 require 'bigdecimal'
 module JsonApiClient
   class Schema
-    Property = Struct.new(:name, :type, :default) do
-      def cast(value)
-        return nil if value.nil?
-        return value if type.nil?
+    module Types
 
-        case type.to_sym
-        when :int, :integer
+      class Integer
+        def self.cast(value, _)
           value.to_i
-        when :string
+        end
+      end
+
+      class String
+        def self.cast(value, _)
           value.to_s
-        when :float
+        end
+      end
+
+      class Float
+        def self.cast(value, _)
           value.to_f
-        when :time
-          value.is_a?(Time) || nil ? value : Time.parse(value)
-        when :decimal
-          value.nil? ? nil : BigDecimal.new(value)
-        when :boolean
+        end
+      end
+
+      class Time
+        def self.cast(value, _)
+          value.is_a?(::Time) ? value : ::Time.parse(value)
+        end
+      end
+
+      class Decimal
+        def self.cast(value, _)
+          BigDecimal.new(value)
+        end
+      end
+
+      class Boolean
+        def self.cast(value, default)
           case value
-          when "false", "0", 0, false
-            false
-          when "true", "1", 1, true
-            true
-          else
-            # if it's unknown, use the default value
-            default
+            when "false", "0", 0, false
+              false
+            when "true", "1", 1, true
+              true
+            else
+              # if it's unknown, use the default value
+              default
           end
-        else
-          value
         end
       end
+
+    end
+
+    class TypeFactory
+      @@types = {}
+      # Register a new type key or keys with appropriate classes
+      #
+      # eg:
+      #
+      #   require 'money'
+      #
+      #   class MyMoneyCaster
+      #      def self.cast(value, default)
+      #         begin
+      #           Money.new(value, "USD")
+      #         rescue ArgumentError
+      #           default
+      #         end
+      #      end
+      #   end
+      #
+      #   JsonApiClient::Schema::Types.register money: MyMoneyCaster
+      #
+      # You can setup several at once:
+      #
+      #   JsonApiClient::Schema::Types.register money: MyMoneyCaster,
+      #                                         date: MyJsonDateTypeCaster
+      #
+      #
+      #
+      #
+      def self.register(type_hash)
+        @@types.merge!(type_hash)
+      end
+
+      def self.type_for(type)
+        @@types[type]
+      end
+
+      self.register int: Types::Integer,
+                    integer: Types::Integer,
+                    string: Types::String,
+                    float: Types::Float,
+                    time: Types::Time,
+                    decimal: Types::Decimal,
+                    boolean: Types::Boolean
+
+    end
+
+    Property = Struct.new(:name, :type, :default) do
+      def cast(value)
+        return nil if value.nil?
+        return value if type.nil?
+        type_caster = TypeFactory.type_for(type)
+        return value if type_caster.nil?
+        type_caster.cast(value, default)
+      end
     end
 
     def initialize
@@ -54,11 +126,13 @@ module JsonApiClient
     def size
       @properties.size
     end
+
     alias_method :length, :size
 
     def each_property(&block)
       @properties.values.each(&block)
     end
+
     alias_method :each, :each_property
 
     # Look up a property by name
@@ -68,6 +142,13 @@ module JsonApiClient
     def find(property_name)
       @properties[property_name.to_sym]
     end
+
     alias_method :[], :find
+
+    class << self
+      def register(type_hash)
+        TypeFactory.register(type_hash)
+      end
+    end
   end
 end

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-14 00:00:00.000000000 Z
+date: 2017-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Build client libraries compliant with specification defined by jsonapi.org