json_apiable 0.2.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2730ce86ac44faba4e0e0259559e346efe33442f474f9ba715aa2601045a02ac
-  data.tar.gz: f98a96c78028431660ac200e568b857133d581618594277a25829135a1a40cb1
+  metadata.gz: 1d67de4927cb04df83deea484a0890bdfdc36cbf48d6bda986000ffabcda8f3b
+  data.tar.gz: a90a940bc16d451c698355f1e18c74a5e183135ed3315f7aa272ad9a37e345f5
 SHA512:
-  metadata.gz: 9646248670873df706251afa484cfc14cff8ac9f8fd3e3eea7465659b52fac3a1f4ffa5b5312ed3d4c570e3178d05354bb1d7991eaf7dbac3e27861bd510ec9b
-  data.tar.gz: 872d84af6b05e4396be7aece31fc8fff11c34690dc2f17cb5908b0d2c08d9cf9a2f06bc811e9de0e2b9a78e7edb9d12dd5c2a96365c46d95d1cb84bb5f5f1800
+  metadata.gz: ee5e99fac5548996d4222e3b281ca8d3d03c78e95b57414c08b8f6f624497140c1eff43d0f5e5d54a3c2c2fec9501e92b09d37deb2e5c688c132161ca88f031c
+  data.tar.gz: 8d36927df5f8684188cc4e6f4ef263640429ddff9a84f9824860fe1ff1519c94fdb1b90642291681d5612478e9913ca818539a1f2c8d642657dba2d24d0f6a48

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_apiable (0.2.1)
+    json_apiable (0.3)
       activerecord (>= 4.2)
       activesupport (>= 4.2)
       fast_jsonapi (~> 1.5)

data/README.md

@@ -103,8 +103,8 @@ class API::PostsController < API::BaseController
   def create
     # use jsonapi_attribute_present? to quickly test presence of specific attributes
     raise UnprocessableEntityError, 'No title!' unless jsonapi_attribute_present?(:title)
-    # use jsonapi_attribute_value to get attribute values. If non-existent, nil would be returned
-    @title = jsonapi_attribute_value(:title)
+    # use jsonapi_attribute to get attribute values. If non-existent, nil would be returned
+    @title = jsonapi_attribute(:title)
     # exclude 'author' attribute from assign params, for example because it's a separate table on the DB level)
     @author_name = jsonapi_exclude_attribute(:author_name)
     # exclude 'comments' relationship from assign params, for example because we want to filter which ones are added to post

data/lib/json_apiable/json_apiable.rb

@@ -42,12 +42,29 @@ module JsonApiable
     yield(configuration)
   end
 
+  def jsonapi_attribute(attrib_key)
+    jsonapi_build_params.dig(:data, :attributes, attrib_key)
+  end
+
   def jsonapi_attribute_present?(attrib_key)
-    jsonapi_build_params.dig(:data, :attributes, attrib_key).present?
+    jsonapi_attribute(attrib_key).present?
   end
 
-  def jsonapi_attribute_value(attrib_key)
-    jsonapi_build_params.dig(:data, :attributes, attrib_key)
+  def jsonapi_relationship(attrib_key)
+    jsonapi_build_params.dig(:data, :relationships, attrib_key)
+  end
+
+  def jsonapi_relationship_data(attrib_key)
+    jsonapi_build_params.dig(:data, :relationships, attrib_key, :data)
+  end
+
+  def jsonapi_relationship_present?(attrib_key)
+    jsonapi_relationship(attrib_key).present?
+  end
+
+  def jsonapi_relationship_attribute(relationship, attribute)
+    [:id, :type].include?(attribute.to_sym) ? jsonapi_relationship_data(relationship)&.dig(attribute) :
+                                              jsonapi_relationship_data(relationship)&.dig(:attributes, attribute)
   end
 
   def jsonapi_assign_params
@@ -71,7 +88,8 @@ module JsonApiable
     jsonapi_build_params.dig(:data, :relationships, rel_key)
   end
 
-  # Should be overwritten in specific controllers
+  # Should be overwritten in specific controllers. If you need to manipulate params before they are parsed,
+  # that's the place to do it
   def jsonapi_build_params
     params
   end

data/lib/json_apiable/version.rb

@@ -1,3 +1,3 @@
 module JsonApiable
-  VERSION = "0.2.1"
+  VERSION = "0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_apiable
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - Mike Polischuk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-18 00:00:00.000000000 Z
+date: 2020-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord