json_api_client 1.6.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43ad8115fe9360a602c120c6f4989ee54760d6a3
-  data.tar.gz: 9709b02b48e2c8b2295bd76b8620fcb1efaad487
+  metadata.gz: b1eaf54d769a3c0308319a18629440a2fea1fcdc
+  data.tar.gz: da232e4dfd3b4e13a45c69c22b993fa9c08f209b
 SHA512:
-  metadata.gz: 0f7c487d82b18df80d0b7ca0a076028ea9b0b5b6eeb9e7a154f83a95d3a7f0af6af418418b06168dd860fd5c1225ec9a064603660354bfae3c42d7524d8bccb8
-  data.tar.gz: c4d8967b2a2e85a8c9ba486290e1f860551e83eab7e3022b3fc8d408ef2f3bd204ec56cd57e6e20c60cf72c6dfbddcf433281b4b45777fd00a6c49226080e6e9
+  metadata.gz: 9737c509ddc0c91b6bf759e2b891acee5de9fe7c99e83f88bf4b1f8deef40b648dc166a03bad952ebcac0aada03a39aafcc538f05adea2473ec28a25bf54f2a2
+  data.tar.gz: b5e197b2d9164b5496cb0df20d248660d6191d5186403ea0da9f6df234bd2d9275974214000c5a730d07dac0ecfd0a40323d0727e95d8ae77f37d4347919f69d

data/README.md

@@ -157,13 +157,17 @@ articles.links.related
 
 You can force nested resource paths for your models by using a `belongs_to` association.
 
-**Note: Using belongs_to is only necessary for setting a nested path.**
+**Note: Using belongs_to is only necessary for setting a nested path unless you provide `shallow_path: true` option.**
 
 ```ruby
 module MyApi
   class Account < JsonApiClient::Resource
     belongs_to :user
   end
+  
+  class Customer < JsonApiClient::Resource
+      belongs_to :user, shallow_path: true
+    end
 end
 
 # try to find without the nested parameter
@@ -173,6 +177,28 @@ MyApi::Account.find(1)
 # makes request to /users/2/accounts/1
 MyApi::Account.where(user_id: 2).find(1)
 # => returns ResultSet
+
+# makes request to /customers/1
+MyApi::Customer.find(1)
+# => returns ResultSet
+
+# makes request to /users/2/customers/1
+MyApi::Customer.where(user_id: 2).find(1)
+# => returns ResultSet
+```
+
+you can also override param name for `belongs_to` association
+
+```ruby
+module MyApi
+  class Account < JsonApiClient::Resource
+    belongs_to :user, param: :customer_id
+  end
+end
+
+# makes request to /users/2/accounts/1
+MyApi::Account.where(customer_id: 2).find(1)
+# => returns ResultSet
 ```
 
 ## Custom Methods

data/lib/json_api_client/associations/belongs_to.rb

@@ -3,8 +3,17 @@ module JsonApiClient
     module BelongsTo
       class Association < BaseAssociation
         include Helpers::URI
-        def param
-          :"#{attr_name}_id"
+
+        attr_reader :param
+
+        def initialize(attr_name, klass, options = {})
+          super
+          @param = options.fetch(:param, :"#{attr_name}_id").to_sym
+          @shallow_path = options.fetch(:shallow_path, false)
+        end
+
+        def shallow_path?
+          @shallow_path
         end
 
         def to_prefix_path(formatter)
@@ -12,6 +21,7 @@ module JsonApiClient
         end
 
         def set_prefix_path(attrs, formatter)
+          return if shallow_path? && !attrs[param]
           attrs[param] = encode_part(attrs[param]) if attrs.key?(param)
           to_prefix_path(formatter) % attrs
         end

data/lib/json_api_client/helpers/associatable.rb

@@ -7,6 +7,7 @@ module JsonApiClient
         class_attribute :associations, instance_accessor: false
         self.associations = []
         attr_accessor :__cached_associations
+        attr_accessor :__belongs_to_params
       end
 
       module ClassMethods
@@ -14,6 +15,10 @@ module JsonApiClient
           attr_name = attr_name.to_sym
           association = association_klass.new(attr_name, self, options)
           self.associations += [association]
+        end
+
+        def _define_relationship_methods(attr_name)
+          attr_name = attr_name.to_sym
 
           define_method(attr_name) do
             _cached_relationship(attr_name) do
@@ -31,17 +36,36 @@ module JsonApiClient
 
         def belongs_to(attr_name, options = {})
           _define_association(attr_name, JsonApiClient::Associations::BelongsTo::Association, options)
+
+          param = associations.last.param
+          define_method(param) do
+            _belongs_to_params[param]
+          end
+
+          define_method(:"#{param}=") do |value|
+            _belongs_to_params[param] = value
+          end
         end
 
         def has_many(attr_name, options = {})
           _define_association(attr_name, JsonApiClient::Associations::HasMany::Association, options)
+          _define_relationship_methods(attr_name)
         end
 
         def has_one(attr_name, options = {})
           _define_association(attr_name, JsonApiClient::Associations::HasOne::Association, options)
+          _define_relationship_methods(attr_name)
         end
       end
 
+      def _belongs_to_params
+        self.__belongs_to_params ||= {}
+      end
+
+      def _clear_belongs_to_params
+        self.__belongs_to_params = {}
+      end
+
       def _cached_associations
         self.__cached_associations ||= {}
       end

data/lib/json_api_client/query/builder.rb

@@ -1,3 +1,5 @@
+require 'active_support/all'
+
 module JsonApiClient
   module Query
     class Builder
@@ -64,8 +66,12 @@ module JsonApiClient
         paginate(page: 1, per_page: 1).pages.last.to_a.last
       end
 
-      def build
-        klass.new(params)
+      def build(attrs = {})
+        klass.new @path_params.merge(attrs.symbolize_keys)
+      end
+
+      def create(attrs = {})
+        klass.create @path_params.merge(attrs.symbolize_keys)
       end
 
       def params

data/lib/json_api_client/query/requestor.rb

@@ -10,14 +10,14 @@ module JsonApiClient
 
       # expects a record
       def create(record)
-        request(:post, klass.path(record.attributes), {
+        request(:post, klass.path(record.path_attributes), {
             body: { data: record.as_json_api },
             params: record.request_params.to_params
         })
       end
 
       def update(record)
-        request(:patch, resource_path(record.attributes), {
+        request(:patch, resource_path(record.path_attributes), {
             body: { data: record.as_json_api },
             params: record.request_params.to_params
         })
@@ -30,7 +30,7 @@ module JsonApiClient
       end
 
       def destroy(record)
-        request(:delete, resource_path(record.attributes))
+        request(:delete, resource_path(record.path_attributes))
       end
 
       def linked(path)

data/lib/json_api_client/relationships/relations.rb

@@ -11,7 +11,6 @@ module JsonApiClient
       def initialize(record_class, relations)
         @record_class = record_class
         self.attributes = relations
-        clear_changes_information
       end
 
       def present?

data/lib/json_api_client/resource.rb

@@ -98,6 +98,7 @@ module JsonApiClient
         new(params).tap do |resource|
           resource.mark_as_persisted!
           resource.clear_changes_information
+          resource.relationships.clear_changes_information
         end
       end
 
@@ -318,7 +319,8 @@ module JsonApiClient
       @destroyed = nil
       self.links = self.class.linker.new(params.delete(:links) || {})
       self.relationships = self.class.relationship_linker.new(self.class, params.delete(:relationships) || {})
-      self.attributes = self.class.default_attributes.merge(params)
+      self.attributes = self.class.default_attributes.merge params.except(*self.class.prefix_params)
+      self.__belongs_to_params = params.slice(*self.class.prefix_params)
 
       setup_default_properties
 
@@ -465,6 +467,7 @@ module JsonApiClient
         mark_as_destroyed!
         self.relationships.last_result_set = nil
         _clear_cached_relationships
+        _clear_belongs_to_params
         true
       end
     end
@@ -498,6 +501,10 @@ module JsonApiClient
       self
     end
 
+    def path_attributes
+      _belongs_to_params.merge attributes.slice('id').symbolize_keys
+    end
+
     protected
 
     def setup_default_properties
@@ -566,10 +573,7 @@ module JsonApiClient
     end
 
     def non_serializing_attributes
-      [
-        self.class.read_only_attributes,
-        self.class.prefix_params.map(&:to_s)
-      ].flatten
+      self.class.read_only_attributes
     end
 
     def attributes_for_serialization

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.6.4"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2018-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport