json_api_ruby 0.0.1.alpha → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f137dccac6caa31e15ca4519ed3b6a9e45682739
-  data.tar.gz: 5256e906efe7899bfacd0c6916620bdc066d8dc6
+  metadata.gz: aecf0984e8890283e322162acfacab44fa72647c
+  data.tar.gz: 08fc7edccd62b61df8a9f0883dcfb790a4a9af2e
 SHA512:
-  metadata.gz: 76ce05324913fb8100783b4a3f274c98c1e4a8afa6d2ec0fc90db58f8d1aac39379012de2bd6dd0f178343d11f805a867fb9b1a715df3021ea76c5d50f62ba83
-  data.tar.gz: 1bd8c66e4ebb6c7ddf1f0137f90fe5050b08c5e81d0b4c9503f42cf095fc2124d94b86ec7b44954a4c888634aa37294e207c2d3b55342060ee77e4074edca2d7
+  metadata.gz: 97f8d15d1a25fe1cfd6bdf8694e35266d5f968c4c82697d2214369e987a38d1008fd9b5eb54bce68874572f97b2d52527d2e747ce5be0c9b3ecfdce0cc5e762a
+  data.tar.gz: c2dbc5d3b6dc759724b1f7d332cb49d9ecfde7583d9e046399671ba838f41c38d8f08164557186af36de0b53edd21d340b7e66fe4f616383acf2cb4f8f1c499e

data/README.md

@@ -0,0 +1,9 @@
+# jsonapi_ruby
+Ruby serializer that takes a resource object and spits it out as a JSON API document
+
+### Usage
+See the <a href="https://github.com/teubanks/jsonapi_ruby/wiki">Wiki</a> page or the tests for usage
+
+### Status
+Definitely a work in progress.
+This is currently an Alpha release, use at your own peril

data/lib/json_api_ruby/resource.rb

@@ -47,8 +47,9 @@ module JsonApi
     attr_reader :includes
 
     def initialize(model, options={})
+      options.stringify_keys!
       @_model = model
-      @includes = options.fetch(:include, []).map(&:to_s)
+      @includes = Array.wrap(options.fetch('include', [])).map(&:to_s)
       build_object_graph # base module method
     end
   end

data/lib/json_api_ruby/resources/base.rb

@@ -51,8 +51,8 @@ module JsonApi
         @relationships ||= []
         Array(self.class.relationships).each do |relationship|
           included = includes.include?(relationship.name)
-          relationship.build_resources({parent_resource: self, included: included})
-          @relationships << relationship
+          rel = relationship.build_resources({parent_resource: self, included: included})
+          @relationships << rel
         end
       end
     end

data/lib/json_api_ruby/resources/dsl.rb

@@ -32,11 +32,7 @@ module JsonApi
       private
       def add_relationship(object_name, cardinality, options)
         @relationships ||= []
-        if cardinality == :one
-          @relationships << ToOneRelationship.new(object_name, options)
-        else
-          @relationships << ToManyRelationship.new(object_name, options)
-        end
+        @relationships << RelationshipMeta.new(object_name, options.merge(cardinality: cardinality))
         create_accessor_methods(object_name)
       end
 

data/lib/json_api_ruby/resources/relationships.rb

@@ -1,7 +1,7 @@
 module JsonApi
   module Resources
 
-    class Relationships
+    class RelationshipMeta
       # The name of this relationship.
       #   This name comes from the resource object that defines the
       #   relationship. Example:
@@ -10,6 +10,25 @@ module JsonApi
       #     end
       attr_reader :name
 
+      attr_reader :cardinality
+
+      def initialize(name, options)
+        @name = name.to_s
+        @cardinality = options.fetch(:cardinality)
+      end
+
+      def build_resources(options)
+        if cardinality == :one
+          relationship = ToOneRelationship.new(name, options)
+        else
+          relationship = ToManyRelationship.new(name, options)
+        end
+        relationship.build_resources(options)
+        relationship
+      end
+    end
+
+    class Relationship
       # The resource object that "owns" this relationship
       #
       # Example:
@@ -19,28 +38,19 @@ module JsonApi
       #
       # `ArticleResource` is the parent of the author object
       attr_reader :parent
+      attr_reader :parent_model
 
       # Determines whether the `data` attribute should be filled out and
       # included
       attr_reader :included
+      attr_reader :name
 
       # The resource object that represents this relationship
       attr_reader :resources
 
-      attr_reader :parent_model
-
       def initialize(name, options)
-        @name = name.to_s
+        @name = name
         @resources = []
-      end
-
-      def to_hash
-        return_hash = links
-        return_hash.merge!(data) if included?
-        return_hash
-      end
-
-      def build_resources(options)
         @parent = options.fetch(:parent_resource)
         @parent_model = parent._model
         @included = options.fetch(:included, false)
@@ -50,6 +60,12 @@ module JsonApi
         included == true
       end
 
+      def to_hash
+        return_hash = links
+        return_hash.merge!(data) if included?
+        return_hash
+      end
+
       def links
         {
           'links' => {
@@ -61,17 +77,17 @@ module JsonApi
     end
 
     # convenience classes
-    class ToOneRelationship < Relationships
+    class ToOneRelationship < Relationship
       def data(options={})
         identifier_hash = resource_object.identifier_hash if resource_object
-        {'data' => Hash(identifier_hash)}
+        {'data' => identifier_hash}
       end
 
       def build_resources(options)
-        super
         return unless included?
         resource_model = parent_model.send(name)
         return if resource_model.blank?
+
         resource_class = Discovery.resource_for_name(resource_model, options.merge(parent_resource: parent))
         @resources << resource_class.new(resource_model)
       end
@@ -81,7 +97,7 @@ module JsonApi
       end
     end
 
-    class ToManyRelationship < Relationships
+    class ToManyRelationship < Relationship
       def data(options={})
         data = resource_objects.map do |object|
           object.identifier_hash
@@ -90,8 +106,8 @@ module JsonApi
       end
 
       def build_resources(options)
-        super
         return unless included?
+
         parent_model.send(name).each do |resource_model|
           resource_class = Discovery.resource_for_name(resource_model, options.merge(parent_resource: parent))
           @resources << resource_class.new(resource_model)

data/lib/json_api_ruby/version.rb

@@ -1,3 +1,3 @@
 module JsonApi
-  VERSION = '0.0.1.alpha'
+  VERSION = '0.0.1'
 end

data/spec/json_api_ruby/resources/relationships_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe JsonApi::Resources::Relationships do
+RSpec.describe JsonApi::Resources::RelationshipMeta do
   let(:article) do
     Article.new('How to raise Triops', 'Triops are hardy little creatures whose eggs can be frozen for as long as 40 years')
   end
@@ -23,8 +23,8 @@ RSpec.describe JsonApi::Resources::Relationships do
 
   describe 'link serialization' do
     subject(:links_object) do
-      author_relation.build_resources(parent_resource: article_resource)
-      author_relation.to_hash
+      rel = author_relation.build_resources(parent_resource: article_resource)
+      rel.to_hash
     end
 
     it 'includes a links object' do
@@ -54,8 +54,8 @@ RSpec.describe JsonApi::Resources::Relationships do
 
   describe 'data serialization' do
     subject(:serialized_object) do
-      author_relation.build_resources(parent_resource: article_resource, included: true)
-      author_relation.to_hash
+      rel = author_relation.build_resources(parent_resource: article_resource, included: true)
+      rel.to_hash
     end
 
     it 'has a data top level object' do
@@ -65,8 +65,8 @@ RSpec.describe JsonApi::Resources::Relationships do
     describe 'data object' do
       context 'when an array' do
         subject(:serialized_object) do
-          comments_relation.build_resources(parent_resource: article_resource, included: true)
-          comments_relation.to_hash
+          rel = comments_relation.build_resources(parent_resource: article_resource, included: true)
+          rel.to_hash
         end
 
         it 'has an identity hash for each object' do
@@ -84,8 +84,8 @@ RSpec.describe JsonApi::Resources::Relationships do
 
   describe 'identity hash' do
     it 'returns an identity hash given a model and parent resource' do
-      author_relation.build_resources(parent_resource: article_resource, included: true)
-      serialized_object = author_relation.to_hash
+      rel = author_relation.build_resources(parent_resource: article_resource, included: true)
+      serialized_object = rel.to_hash
       expect(serialized_object['data'].keys).to eq ['id', 'type']
     end
   end
@@ -93,16 +93,16 @@ RSpec.describe JsonApi::Resources::Relationships do
   describe 'relationship serialization' do
     context 'when the option "include" is true' do
       it 'includes the data object' do
-        author_relation.build_resources(parent_resource: article_resource, included: true)
-        serialized_data = author_relation.to_hash
+        rel = author_relation.build_resources(parent_resource: article_resource, included: true)
+        serialized_data = rel.to_hash
         expect(serialized_data).to include('data')
       end
     end
 
     context 'when the option "include" is falsey' do
       it 'does not include data object' do
-        author_relation.build_resources(parent_resource: article_resource)
-        serialized_data = author_relation.to_hash
+        rel = author_relation.build_resources(parent_resource: article_resource)
+        serialized_data = rel.to_hash
         expect(serialized_data).to_not include('data')
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.1
 platform: ruby
 authors:
 - Tracey Eubanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-10 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,6 +106,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
+- README.md
 - Rakefile
 - json_api_ruby.gemspec
 - lib/json_api_ruby.rb
@@ -141,9 +142,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1