onsi 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 638533886ab71bbcb08509a8fc97847bf8758780f57ec9cd447b7d2e238f2004
-  data.tar.gz: 752a3904540d06b5e633440a4e953da4d2df53697bb3d2581c4a513ed575ecbb
+  metadata.gz: 125362cc7e8b37e2a01878974ca1f8df845d5ae6235fb09571c939ea4ef0dbef
+  data.tar.gz: 1453b4fd3d2cc8f4f55c5a8862e3dedcf8caec1e866438cc9b125ef8e9897b21
 SHA512:
-  metadata.gz: 6cdd245d7d1b287869aade512beb827527912054c1d633db3b4adb05d374c1c1bcdeff39014e47a885bddabc3d8f0c304768d204b90b29b21a7822925c382fa8
-  data.tar.gz: d164bbedc0824ed6b2650c7994f58167f8c44dc515731b8562de55701479be8f14f63ab18f237b17bcc06f091920f6a1690ff487a83864ef318e10f5423f92d3
+  metadata.gz: 3f46696980dcffe537154b596eae1783b56fbbc85e6ec789e616878e89a455519c291f5450ece97fe002554b52ef72e23b479a74137a1c3d617d6c1d4ecd3965
+  data.tar.gz: 9ccd840a50e92d321f62fdd304a225d771ab2c298880c506f0b684f68c6a9c201348dcd294161dedceaab3207798283741ab10f797f86b4e0bf590a2ce58ab9b

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# Version 1.2.0
+
+## Released February 23, 2019
+
+###
+
+- Feat: Allow setting a different primary id attribute.
+
+---
+
 # Version 1.1.0
 
 ## Released February 23, 2019
@@ -8,6 +18,8 @@
 
 - Feat: Allow Params to parse included relationships
 
+---
+
 # Version 1.0.1
 
 ## Released November 21, 2018
@@ -16,6 +28,8 @@
 
 - Fix for nested complex attributes.
 
+---
+
 # Version 1.0.0
 
 ## Released November 15, 2018

data/lib/onsi/model.rb

@@ -48,8 +48,8 @@ module Onsi
       #
       # @param block [Block] The block. Called on an instance
       #   of {Onsi::Model::ModelRenderer}
-      def api_render(version, &block)
-        api_renderer(version).instance_exec(&block)
+      def api_render(version, id: :id, &block)
+        api_renderer(version, id).instance_exec(&block)
       end
 
       ##
@@ -63,12 +63,12 @@ module Onsi
       #
       # @raise [Onsi::Errors::UnknownVersionError] If the version isn't defined
       #   and the for_render param is true.
-      def api_renderer(version, for_render: false)
+      def api_renderer(version, id, for_render: false)
         @api_renderer ||= {}
         if for_render
           raise Errors::UnknownVersionError.new(self, version) if @api_renderer[version].nil?
         else
-          @api_renderer[version] ||= ModelRenderer.new
+          @api_renderer[version] ||= ModelRenderer.new(id)
         end
         @api_renderer[version]
       end
@@ -91,11 +91,16 @@ module Onsi
       # The default date-time format for a rendered Date and Time. (ISO-8601)
       DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'.freeze
 
+      ##
+      # The name of the id attribute on the model
+      attr_reader :id_attr
+
       ##
       # Create a new ModelRenderer
       #
       # @private
-      def initialize
+      def initialize(id_attr)
+        @id_attr = id_attr
         @attributes = {}
         @relationships = {}
         @metadata = {}

data/lib/onsi/resource.rb

@@ -154,7 +154,7 @@ module Onsi
     def as_json(_opts = {})
       {}.tap do |root|
         root[TYPE_KEY] = type
-        root[ID_KEY]   = object.id.to_s
+        root[ID_KEY]   = object_id
         root[ATTRIBUTES_KEY] = generate_attributes
         append_relationships(root)
         append_meta(root)
@@ -189,8 +189,13 @@ module Onsi
       end
     end
 
+    def object_id
+      attr = object.class.api_renderer(version, nil, for_render: true).id_attr
+      object.send(attr).to_s
+    end
+
     def type
-      object.class.api_renderer(version, for_render: true).type || object.class.name.underscore
+      object.class.api_renderer(version, nil, for_render: true).type || object.class.name.underscore
     end
 
     def append_relationships(root)
@@ -216,15 +221,15 @@ module Onsi
     end
 
     def generate_attributes
-      object.class.api_renderer(version, for_render: true).render_attributes(object)
+      object.class.api_renderer(version, nil, for_render: true).render_attributes(object)
     end
 
     def generate_relationships
-      object.class.api_renderer(version, for_render: true).render_relationships(object)
+      object.class.api_renderer(version, nil, for_render: true).render_relationships(object)
     end
 
     def generate_metadata
-      object.class.api_renderer(version, for_render: true).render_metadata(object)
+      object.class.api_renderer(version, nil, for_render: true).render_metadata(object)
     end
 
     def generate_includes

data/lib/onsi/version.rb

@@ -1,5 +1,5 @@
 module Onsi
   ##
   # The current version of Onsi
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onsi
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Maddie Schipper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-23 00:00:00.000000000 Z
+date: 2019-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable