hal_api-rails 0.6.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f8ad6ad0044a8438881c35775259d46cce7448d
-  data.tar.gz: c4dd5e6a42a4cca9d744e7050a91dc6d06e335f9
+  metadata.gz: fee32a82297c2cc6ec8a4c5dd9c3ad19c78ed8b1
+  data.tar.gz: c6e4ce2430011f64b1e80beef0d5d3da9bb20d30
 SHA512:
-  metadata.gz: ae0cf7fc44f171df5972c660d732cbd837f89216e001ef76f8b9aa97a0cc25b8581e975a90efdfdee7401cc7e9ae3ad947442239119828a374806ac023b3ce3a
-  data.tar.gz: 9d8eb8563e870a584b7eb69696a8d205cbb03b5b6ea68b33c64913ced078a158cfc21a37fb62a0c349b2a66c4cb026a8e3448080139f27ec88bc939ebd6e0d12
+  metadata.gz: d5403262dc8862444f9156f96bab7ccb9140ee37f7cb96e3083ca47453c35024636894160fd8ce6e46f983d8b45820f9641c49f93940f9f95c2541526786f737
+  data.tar.gz: 59ca15c8aee5039fd78639b0f494dfd5f3c889f6b6b145528f57b4e0d25844c445c4c54baa8cc36f3be656fe6d25ea304447b6873fda4581e67dbdf945310a2b

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.2.2
+  - 2.4.9

data/hal_api-rails.gemspec

@@ -23,13 +23,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency "actionpack", ">= 3.0.0"
   spec.add_dependency "rack-test"
   spec.add_dependency "activesupport", ">= 3.0.0"
-  spec.add_dependency "responders", "~> 2.0"
-  spec.add_dependency "roar-rails", "~> 1.0.2"
+  spec.add_dependency "responders", "~> 3.0"
+  spec.add_dependency "roar-rails", "~> 1.1.0"
   spec.add_dependency "multi_json"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rails", "~> 4.2.1"
+  spec.add_development_dependency "rails", "~> 5.2.4"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "kaminari"

data/lib/hal_api/controller/actions.rb

@@ -71,7 +71,9 @@ module HalApi::Controller::Actions
 
   def valid_params_for_action(action)
     (params.permit(*self.class.valid_params_list(action)) || {}).tap do |p|
-      p[:zoom] = zoom_param if zoom_param
+      if zoom_param
+        p[:user_options] = (p[:user_options] || {}).merge(zoom: zoom_param)
+      end
     end.
     to_h
   end

data/lib/hal_api/controller/exceptions.rb

@@ -11,10 +11,10 @@ module HalApi::Controller::Exceptions
               when 5
                 ::ActionDispatch::ExceptionWrapper.new(ActiveSupport::BacktraceCleaner.new, exception)
               else
-                ::ActionDispatch::ExceptionWrapper.new(env, exception)
+                ::ActionDispatch::ExceptionWrapper.new(request.env, exception)
               end
 
-    log_error(env, wrapper)
+    log_error(request.env, wrapper)
 
     error = exception
     if !error.is_a?(HalApi::Errors::ApiError)

data/lib/hal_api/controller/filtering.rb

@@ -53,6 +53,24 @@ module HalApi::Controller::Filtering
     @filters ||= parse_filters_param
   end
 
+  def filter_facets
+  end
+
+  def index_collection
+    collection = defined?(super) ? super : HalApi::PagedCollection.new([])
+
+    # add facets if defined, removing filters/facets with counts of 0
+    non_zero_facets = (filter_facets || {}).with_indifferent_access.tap do |hash|
+      hash.each do |filter_key, facets|
+        hash[filter_key] = facets.try(:select) { |f| f.try(:[], :count) > 0 }
+        hash.delete(filter_key) if hash[filter_key].blank?
+      end
+    end
+    collection.facets = non_zero_facets unless non_zero_facets.blank?
+
+    collection
+  end
+
   private
 
   def parse_filters_param

data/lib/hal_api/controller/resources.rb

@@ -75,6 +75,10 @@ module HalApi::Controller::Resources
     self.class.resource_class.where(nil)
   end
 
+  def resources_query
+    filtered(scoped(resources_base))
+  end
+
   def find_base
     filtered(scoped(included(resources_base)))
   end

data/lib/hal_api/paged_collection.rb

@@ -6,7 +6,7 @@ class HalApi::PagedCollection
   extend ActiveModel::Naming
   extend Forwardable
 
-  attr_accessor :items, :request, :options
+  attr_accessor :items, :request, :options, :facets
 
   def_delegators :items, :total_count, :prev_page, :next_page, :total_pages, :first_page?, :last_page?
   alias_method :total, :total_count

data/lib/hal_api/rails/version.rb

@@ -1,5 +1,5 @@
 module HalApi
   module Rails
-    VERSION = "0.6.0"
+    VERSION = '1.1.2'
   end
 end

data/lib/hal_api/representer.rb

@@ -21,5 +21,6 @@ class HalApi::Representer < Roar::Decorator
   include HalApi::Representer::Caches
   include HalApi::Representer::LinkSerialize
   self_link
+  vary_link
   profile_link
 end

data/lib/hal_api/representer/collection_paging.rb

@@ -7,6 +7,7 @@ module HalApi::Representer::CollectionPaging
     class_eval do
       property :count
       property :total
+      property :facets
 
       embeds :items, decorator: lambda{|*| item_decorator }, class: lambda{|*| item_class }, zoom: :always
 
@@ -36,6 +37,14 @@ module HalApi::Representer::CollectionPaging
     href_url_helper(represented.params)
   end
 
+  def vary_url(represented)
+    href_url_helper(represented.params.except(*vary_params))
+  end
+
+  def vary_params
+    %w(page per zoom filters sorts)
+  end
+
   def profile_url(represented)
     model_uri(:collection, represented.item_class)
   end
@@ -46,6 +55,7 @@ module HalApi::Representer::CollectionPaging
   # if it is a lambda, execute in the context against the represented.parent (if there is one) or represented
   def href_url_helper(options={})
     if represented_url.nil?
+      options = options.except(:format)
       result = url_for(options.merge(only_path: true)) rescue nil
       if represented.parent
         result ||= polymorphic_path([:api, represented.parent, represented.item_class], options) rescue nil

data/lib/hal_api/representer/embeds.rb

@@ -1,39 +1,47 @@
 require 'active_support/concern'
 require 'hal_api/paged_collection'
+require "representable/pipeline_factories"
 
 # expects underlying model to have filename, class, and id attributes
 module HalApi::Representer::Embeds
   extend ActiveSupport::Concern
 
   included do
-    Representable::Mapper.send(:include, Resources) if !Representable::Mapper.include?(Resources)
+    Representable::Binding.send(:include, HalApiRailsRenderPipeline) if !Representable::Binding.include?(HalApiRailsRenderPipeline)
   end
 
-  def normalize_options!(options)
-    propagated_options, private_options = super(options)
-
-    # we want this to propogate, and be available for `skip_property?`, so don't delete
-    private_options[:zoom] = options[:zoom] if options.key?(:zoom)
-
-    [propagated_options, private_options]
-  end
-
-  module Resources
+  module HalApiRailsRenderPipeline
 
     def skip_property?(binding, private_options)
       super(binding, private_options) || suppress_embed?(binding, private_options)
     end
 
+    def render_functions
+      funcs = super
+      f = ->(input, options) do
+        if suppress_embed?(input, options)
+          return Representable::Pipeline::Stop
+        end
+      end
+      [f] + funcs
+    end
+
     # embed if zoomed
-    def suppress_embed?(binding, options)
-      name = binding[:as].evaluate(self).to_s || binding.name
-      embedded = !!binding[:embedded]
+    def suppress_embed?(input, options)
+      binding = options[:binding]
+
+      # guard against non-hal representers
+      return false unless binding[:as].present?
+
+      name = binding.evaluate_option(:as, input, options)
+
+      embedded = binding[:embedded]
 
-      # not embedded, return false - nothing to suppress
       return false if !embedded
 
-      # check if it should be zoomed, suppress if not
-      !embed_zoomed?(name, binding[:zoom], options[:zoom])
+      ## check if it should be zoomed, suppress if not
+      user_zooms = options[:options].try(:[], :user_options).try(:[], :zoom)
+      !embed_zoomed?(name, binding[:zoom], user_zooms)
     end
 
     def embed_zoomed?(name, zoom_def = nil, zoom_param = nil)
@@ -77,7 +85,9 @@ module HalApi::Representer::Embeds
         options[:getter] ||= ->(*) do
           cnt = send(name).count
           per = getter_per == :all ? cnt : getter_per
-          if cnt <= per
+          if cnt == 0
+            items = send(name).page(1).per(Kaminari.config.default_per_page)
+          elsif cnt <= per
             items = Kaminari.paginate_array(send(name)).page(1).per(per)
           else
             items = send(name).page(1).per(per)

data/lib/hal_api/representer/link_serialize.rb

@@ -15,8 +15,9 @@ module HalApi::Representer::LinkSerialize
       if options.is_a?(Hash) && (options.delete(:writeable) || options[:reader])
         name = options[:rel].to_s.split(':').last.split('/').last
         pname = "set_#{name}_uri"
-        reader = options.delete(:reader) || ->(doc, _args) do
+        reader = options.delete(:reader) || ->(represented:, doc:, **) do
           try("#{name}_id=", id_from_url(doc[pname])) if doc[pname]
+          Representable::Pipeline::Stop
         end
 
         property(pname, readable: false, reader: reader)

data/lib/hal_api/representer/uri_methods.rb

@@ -21,6 +21,15 @@ module HalApi::Representer::UriMethods
       end
     end
 
+    def vary_link
+      link(:vary) do
+        {
+          href: vary_url(represented) + vary_query_params,
+          templated: true,
+        } if vary_url(represented).present? && vary_params.present?
+      end
+    end
+
     def profile_link
       link(:profile) { profile_url(represented) }
     end
@@ -46,6 +55,18 @@ module HalApi::Representer::UriMethods
     polymorphic_path([:api, rep])
   end
 
+  def vary_url(represented)
+    self_url(represented)
+  end
+
+  def vary_params
+    []
+  end
+
+  def vary_query_params
+    "{?#{vary_params.join(',')}}"
+  end
+
   def becomes_represented_class(rep)
     return rep unless rep.respond_to?(:becomes)
     klass = rep.try(:item_class) || rep.class.try(:base_class)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_api-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Chris Rhoden
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -73,28 +73,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: roar-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -143,14 +143,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 5.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 5.2.4
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -255,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: JSON HAL APIs on Rails in the style of PRX