hal_api-rails 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f8ad6ad0044a8438881c35775259d46cce7448d
-  data.tar.gz: c4dd5e6a42a4cca9d744e7050a91dc6d06e335f9
+  metadata.gz: e8ca09414db3082766a5b86ee83310563af05628
+  data.tar.gz: 002aceca75878356759760d73f5dd68cd6dc03d4
 SHA512:
-  metadata.gz: ae0cf7fc44f171df5972c660d732cbd837f89216e001ef76f8b9aa97a0cc25b8581e975a90efdfdee7401cc7e9ae3ad947442239119828a374806ac023b3ce3a
-  data.tar.gz: 9d8eb8563e870a584b7eb69696a8d205cbb03b5b6ea68b33c64913ced078a158cfc21a37fb62a0c349b2a66c4cb026a8e3448080139f27ec88bc939ebd6e0d12
+  metadata.gz: 25f710db7f628fbbd0b708c06e04f4b1f2eb8335ecbb8a48311e68ac4259ad5cfe80d5bbbd02df41d55ea846c8b0d4423055cf1fcbe64f09e37217d1d7c92d33
+  data.tar.gz: df4c7da616d62d01b5dddeb031b2e2c7bd94b61e6399452ab17fbe7a43ffe12c1909e5b138821de4e74dad83ac98295355a1550729a5a4220508f24faaa9f849

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 = "0.7.0"
   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/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: 0.7.0
 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: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel