jsonapi-serializable 0.1.1.beta1 → 0.1.1.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 366782323070f412105463eeffabe870128e49c6
-  data.tar.gz: d80674ddfaa130ea341f286c3f12c87ef5e75016
+  metadata.gz: 9d7beafa6258df4dd44fa02cc22d7a62b8f0e2d0
+  data.tar.gz: fa7223c5647bd81486ec1066e13345a96311081a
 SHA512:
-  metadata.gz: 1bb696480c7e20a3dbe1b4d1525301bb0203b7fbe444268a7fd96bb8d684cdc8bddf8e9ed74161b261375f88e1962f8d1f7363647a544f7b040a9aa73aafdd2f
-  data.tar.gz: 9d17c652fc934460c7d1ef1249d1c32336671ce3fd26ade2acb0d430c98b24f40b56086d719ac481e77a6b6744f1225071564c5101f74b72b2e65b47d3f42160
+  metadata.gz: e041bc9ebe1a08d945eb721baf612d70166de3cda15a310de8ba860d3f9bb7cd0dc72c2b40a6bf682c7568a0635bf796ed9ebf3676edd47d93ce4c01fcd96e3c
+  data.tar.gz: fd83b712198356d829a7db4b10e2a831d8843a151cfaab7c3a573985a9f8005b2a78f113e0dfbf0b520ca443b18f4194f9635616a8229edf28da847bbbe737a6

data/README.md

@@ -1,6 +1,11 @@
 # jsonapi-serializable
-Ruby gem for building and rendering [JSON API](http://jsonapi.org) resources.
-Built upon the [jsonapi-renderer](https://github.com/beauby/jsonapi) gem.
+Ruby gem for building [JSON API](http://jsonapi.org) resources to be rendered by
+the [jsonapi-renderer](https://github.com/beauby/jsonapi) gem.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/jsonapi-serializable.svg)](https://badge.fury.io/rb/jsonapi-serializable)
+[![Build Status](https://secure.travis-ci.org/beauby/jsonapi-serializable.svg?branch=master)](http://travis-ci.org/beauby/jsonapi-serializable?branch=master)
 
 ## Installation
 ```ruby
@@ -24,6 +29,58 @@ require 'jsonapi/serializable'
 ```
 
 Then, define some resource classes:
+
+### For model-based resources
+
+For resources that are simple representations of models, the DSL is simplified:
+
+```ruby
+class PostResource < JSONAPI::Serializable::Resource
+  type 'posts'
+
+  id
+
+  attribute :title
+
+  attribute :date do
+    @model.created_at
+  end
+
+  relationship :author, UserResource do
+    link(:self) do
+      href @url_helper.link_for_rel('posts', @model.id, 'author')
+      meta link_meta: 'some meta'
+    end
+    link(:related) { @url_helper.link_for_res('users', @model.author.id) }
+    meta do
+      { relationship_meta: 'some meta' }
+    end
+  end
+
+  has_many :comments
+
+  meta do
+    { resource_meta: 'some meta' }
+  end
+
+  link(:self) do
+    @url_helper.link_for_res('posts', @model.id)
+  end
+end
+```
+Then, build your resources from your models and render them:
+```ruby
+# post = some post model
+# UrlHelper is some helper class
+resource = PostResource.new(model: post, url_helper: UrlHelper)
+document = JSONAPI.render(resource)
+```
+
+### For general resources
+
+In case your resource is not a simple representation of one of your models,
+the more general `JSONAPI::Serializable::Resource` class can be used.
+
 ```ruby
 class PostResource < JSONAPI::Serializable::Resource
   type 'posts'

data/lib/jsonapi/serializable/model.rb

@@ -0,0 +1,44 @@
+require 'jsonapi/serializable/model_dsl'
+require 'jsonapi/serializable/resource'
+
+module JSONAPI
+  module Serializable
+    class Model < Resource
+      include ModelDSL
+
+      class << self
+        attr_accessor :api_version_val
+      end
+
+      def self.inherited(klass)
+        super
+        klass.api_version_val = api_version_val
+      end
+
+      id { @model.public_send(:id).to_s }
+
+      def resource_klass_for(model_klass)
+        names = model_klass.name.split('::'.freeze)
+        model_klass_name = names.pop
+        namespace = names.join('::'.freeze)
+        version = self.class.api_version_val
+
+        klass_name = [namespace, version, "Serializable#{model_klass_name}"]
+                     .reject(&:nil?)
+                     .reject(&:empty?)
+                     .join('::'.freeze)
+
+        Object.const_get(klass_name)
+      end
+
+      def nil?
+        @model.nil?
+      end
+
+      def as_jsonapi(params = {})
+        return nil if nil?
+        super(params)
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/model_dsl.rb

@@ -0,0 +1,54 @@
+module JSONAPI
+  module Serializable
+    module ModelDSL
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def api_version(value)
+          self.api_version_val = value
+        end
+
+        def type(value = nil)
+          value ||= name
+          super(value)
+        end
+
+        def attribute(attr, &block)
+          block ||= proc { @model.public_send(attr) }
+          super(attr, &block)
+        end
+
+        def has_many(rel, resource_klass = nil, &block)
+          rel_block = proc do
+            if resource_klass
+              data do
+                @model.public_send(rel).map do |related|
+                  resource_klass ||= resource_klass_for(related.class)
+                  resource_klass.new(model: related)
+                end
+              end
+            end
+            instance_eval(&block) unless block.nil?
+          end
+          relationship(rel, &rel_block)
+        end
+
+        def has_one(rel, resource_klass = nil, &block)
+          rel_block = proc do
+            if resource_klass
+              data do
+                related = @model.public_send(rel)
+                resource_klass ||= resource_klass_for(related.class)
+                resource_klass.new(model: related)
+              end
+            end
+            instance_eval(&block) unless block.nil?
+          end
+          relationship(rel, &rel_block)
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/relationship.rb

@@ -17,8 +17,8 @@ module JSONAPI
         hash = {}
         hash[:links] = @_links if @_links.any?
         hash[:meta] = @_meta unless @_meta.nil?
-        hash[:data] = eval_linkage_data if included && (@_linkage_data_block ||
-                                                        @_data_block)
+        return hash unless included || (!@_links.any? && @_meta.nil?)
+        hash[:data] = eval_linkage_data
 
         hash
       end

data/lib/jsonapi/serializable/resource.rb

@@ -18,51 +18,43 @@ module JSONAPI
 
       def self.inherited(klass)
         super
+        klass.type_val = type_val
+        klass.type_block = type_block
+        klass.id_block = id_block
+        klass.meta_val = meta_val
+        klass.meta_block = meta_block
         klass.attribute_blocks = attribute_blocks.dup
         klass.relationship_blocks = relationship_blocks.dup
         klass.link_blocks = link_blocks.dup
       end
 
       def initialize(param_hash = {})
+        @_param_hash = param_hash
         param_hash.each { |k, v| instance_variable_set("@#{k}", v) }
-        @_id = instance_eval(&self.class.id_block)
-        @_type = self.class.type_val || instance_eval(&self.class.type_block)
-        @_meta = if self.class.meta_val
-                   self.class.meta_val
-                 elsif self.class.meta_block
-                   instance_eval(&self.class.meta_block)
-                 end
-        @_attributes = {}
-        @_relationships = self.class.relationship_blocks
-                              .each_with_object({}) do |(k, v), h|
-          h[k] = Relationship.new(param_hash, &v)
-        end
-        @_links = self.class.link_blocks.each_with_object({}) do |(k, v), h|
-          h[k] = Link.as_jsonapi(param_hash, &v)
-        end
       end
 
       def as_jsonapi(params = {})
         hash = {}
-        hash[:id] = @_id
-        hash[:type] = @_type
-        attr = attributes(params[:fields] || self.class.attribute_blocks.keys)
+        hash[:id] = jsonapi_id
+        hash[:type] = jsonapi_type
+        requested_attrs = params[:fields] || self.class.attribute_blocks.keys
+        attr = attributes(requested_attrs)
         hash[:attributes] = attr if attr.any?
-        rels = relationships(params[:fields] || @_relationships.keys,
-                             params[:include] || [])
+        requested_rels = params[:fields] || self.class.relationship_blocks.keys
+        rels = relationships(requested_rels, params[:include] || [])
         hash[:relationships] = rels if rels.any?
-        hash[:links] = @_links if @_links.any?
-        hash[:meta] = @_meta unless @_meta.nil?
+        hash[:links] = links if links.any?
+        hash[:meta] = meta unless meta.nil?
 
         hash
       end
 
       def jsonapi_type
-        @_type
+        @_type ||= self.class.type_val || instance_eval(&self.class.type_block)
       end
 
       def jsonapi_id
-        @_id
+        @_id ||= instance_eval(&self.class.id_block)
       end
 
       def jsonapi_related(include)
@@ -74,6 +66,7 @@ module JSONAPI
       private
 
       def attributes(fields)
+        @_attributes ||= {}
         self.class.attribute_blocks
             .select { |k, _| !@_attributes.key?(k) && fields.include?(k) }
             .each { |k, v| @_attributes[k] = instance_eval(&v) }
@@ -81,12 +74,31 @@ module JSONAPI
       end
 
       def relationships(fields, include)
+        @_relationships ||= self.class.relationship_blocks
+                                .each_with_object({}) do |(k, v), h|
+          h[k] = Relationship.new(@_param_hash, &v)
+        end
         @_relationships
           .select { |k, _| fields.include?(k) }
           .each_with_object({}) do |(k, v), h|
           h[k] = v.as_jsonapi(include.include?(k))
         end
       end
+
+      def meta
+        @_meta ||=
+          if self.class.meta_val
+            self.class.meta_val
+          elsif self.class.meta_block
+            instance_eval(&self.class.meta_block)
+          end
+      end
+
+      def links
+        @_links ||= self.class.link_blocks.each_with_object({}) do |(k, v), h|
+          h[k] = Link.as_jsonapi(@_param_hash, &v)
+        end
+      end
     end
   end
 end

data/lib/jsonapi/serializable.rb

@@ -1,2 +1,3 @@
 require 'jsonapi/serializable/error'
+require 'jsonapi/serializable/model'
 require 'jsonapi/serializable/resource'

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializable
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta1
+  version: 0.1.1.beta2
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-renderer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
+        version: '3.4'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '3.4'
 description: DSL for building resource classes to be rendered by jsonapi-renderer.
 email: lucas.hosseini@gmail.com
 executables: []
@@ -35,6 +63,8 @@ files:
 - lib/jsonapi/serializable/error.rb
 - lib/jsonapi/serializable/error_dsl.rb
 - lib/jsonapi/serializable/link.rb
+- lib/jsonapi/serializable/model.rb
+- lib/jsonapi/serializable/model_dsl.rb
 - lib/jsonapi/serializable/relationship.rb
 - lib/jsonapi/serializable/relationship_dsl.rb
 - lib/jsonapi/serializable/resource.rb