api_helper 0.0.6 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c9251a106ef4147f1bdeafd3c63c6bb772bcefe
-  data.tar.gz: 3f4b4a7493bfe73371c3d9f0879263b367d8b14d
+  metadata.gz: c365d5a68f094eb8d390ae7b126f47ea8bc48c70
+  data.tar.gz: a450ec9db2270080b79d61a7d1d50af88be9ff10
 SHA512:
-  metadata.gz: 994a9811ac0a139ceff2cc1c80af5e2503d41fb30d39ad2c9b3d32a1f1e37759133ee422dc1ce8e40e6c027c2fc82c68b877bbc2ec4b9a2f39813841075eed48
-  data.tar.gz: 1eac3f4b577c4107ca7031d060f4390509d544f8a51ee13c27c5d2a2fbc2799ebef267bbd8582f853d770709a14b8773f971d5164bd6a4a16739ef7e480428d7
+  metadata.gz: 04ea4c190caf03cb2eba99fb542d59ce56052d1b77cb0f5335428f617a097181530e4a0ec5207d777b114b12b8ccea7ebf5ab173cd055b68c88a4b1c54f93a70
+  data.tar.gz: 7e0bb35d2464dc17ca87d4e81857e8310d33146c917a94f8df0b05808ef2423e7f80f00f3b3793e0558ea22197821e6646aa32b5ea68246e8a50e97a505d2f08

data/api_helper.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "sqlite3"

data/examples/includable_childs.rabl

@@ -0,0 +1,29 @@
+this = locals[:self_resource]
+
+unless inclusion_field(this).blank?
+  inclusion_field(this).each_pair do |field_name, includable_field|
+    # use this if fieldset is used
+    # next if fieldset(this).present? && !fieldset(this).include?(field_name)
+
+    # include that child
+    if inclusion[this].include?(field_name)
+
+      child field_name.to_sym, root: field_name.to_sym, object_root: false do
+        template = (includable_field[:resource_name] || field_name).to_s.underscore.singularize
+        extends template
+      end
+
+    # not to include that child
+    else
+
+      node field_name do |obj|
+        if obj.try(includable_field[:id_field]).present?
+          obj.try(includable_field[:id_field])
+        else
+          foreign_key = obj.class.try("#{field_name}_foreign_key")
+          obj.try(foreign_key) if foreign_key.present?
+        end
+      end
+    end
+  end
+end

data/lib/api_helper/includable.rb

@@ -269,9 +269,14 @@ module APIHelper::Includable
   def set_inclusion(resource, default_includes: [], permitted_includes: [])
     @inclusion ||= ActiveSupport::HashWithIndifferentAccess.new
     @inclusion_field ||= ActiveSupport::HashWithIndifferentAccess.new
+    @inclusion_specified ||= ActiveSupport::HashWithIndifferentAccess.new
     @inclusion[resource] = default_includes.map(&:to_s) if @inclusion[resource].blank? &&
                                                            !@inclusion_specified[resource]
     @inclusion[resource] &= permitted_includes.map(&:to_s) if permitted_includes.present?
+
+    if @fieldset.is_a?(Hash) && @fieldset[resource].present?
+      @inclusion[resource] &= @fieldset[resource]
+    end
   end
 
   # View Helper to set the inclusion details
@@ -309,6 +314,24 @@ module APIHelper::Includable
     }
   end
 
+  # Getter for the data of includable fields
+  #
+  # Params:
+  #
+  # +resource+::
+  #   +Symbol+ the resource name of inclusion data to retrieve
+  #
+  def inclusion_field(resource = nil)
+    # act as a traditional getter if no parameters specified
+    if resource.blank?
+      @inclusion_field ||= ActiveSupport::HashWithIndifferentAccess.new
+
+    # returns the inclusion array if an specific resource is passed in
+    else
+      inclusion_field[resource] || {}
+    end
+  end
+
   # Returns the description of the 'include' URL parameter
   def self.include_param_desc(example: nil, default: nil)
     if default.present?
@@ -326,7 +349,7 @@ module APIHelper::Includable
 
   included do
     if defined? helper_method
-      helper_method :inclusion, :set_inclusion, :set_inclusion_field
+      helper_method :inclusion, :set_inclusion, :set_inclusion_field, :inclusion_field
     end
   end
 end

data/lib/api_helper/paginatable.rb

@@ -62,7 +62,7 @@ require 'active_support'
 # Then use the helper methods like this:
 #
 #   # this example uses kaminari
-#   User.page(page).per(per_page)
+#   User.page(pagination_per_page).per(pagination_page)
 #
 # HTTP Link header will be automatically set by the way.
 module APIHelper::Paginatable

data/lib/api_helper/version.rb

@@ -1,3 +1,3 @@
 module APIHelper
-  VERSION = "0.0.6"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.9
 platform: ruby
 authors:
 - Neson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-14 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement