hal_api-rails 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 179cbb4fbac529e58ced08b20fb02ca82bf77bba
-  data.tar.gz: 1218e1583824ce7f04f686edac03e68bc5e4fa54
+  metadata.gz: d5fd9d4857d9ce82ac91cae49c2b239e1ed4ebac
+  data.tar.gz: 9f19281381dbdfc58f76b942421c36a7531aacac
 SHA512:
-  metadata.gz: 4396211e73d1d968b088a08d7f0d0d6d4ba74f267a2112897393299d94466d72c7e82d17dec1a0b872f59e4fee12913a48b812bfbb63280251cde0d4b98c6d12
-  data.tar.gz: 32a4f303b627198c99a6d97bc21846dae4283431e08da917b027b85ad648c647e4acc8d4803df59aba8ee18847c9b1df6384fae28a0476900b3612b4ca37283e
+  metadata.gz: c8f2041c5eceda12f490af0169b5058ea32b9f782fddeb0c1bbf15ad19973fe2a08dc38f90956accf7557160393a24709e20744ecf53dd4b7fb18d9aee5d60d7
+  data.tar.gz: c6c89868387c3416b6ea2ca71114e46a13b33f9a20552a47fab404e31dac0bec96f8af99c97b0f02f4e59d1a072829e0541aa3acd17e0604ccd403a5e8124524

data/README.md

@@ -24,7 +24,51 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem provides a number of additions to the `roar` gem HAL support.
+
+There are several parts of it that need to be used in your apps:
+
+1) Add to your API controllers:
+
+```ruby
+require 'hal_api/rails'
+
+class Api::BaseController < ApplicationController
+  include HalApi::Controller
+  ...
+end
+```
+
+2) Add to your `ActiveRecord` models used in your API (perhaps in a base model class):
+```ruby
+class BaseModel < ActiveRecord::Base
+  self.abstract_class = true
+
+  include RepresentedModel
+end
+```
+
+3) Use the base representer, define your own CURIEs:
+```ruby
+class Api::BaseRepresenter < HalApi::Representer
+  curies(:prx) do
+    [{
+      name: :foo,
+      href: "http://foo.bar/relation/{rel}",
+      templated: true
+    }]
+  end
+
+  def index_url_params
+    '{?page,per,zoom}'
+  end
+
+  def show_url_params
+    '{?zoom}'
+  end
+end
+```
+
 
 ## Development
 

data/lib/hal_api/controller/actions.rb

@@ -50,7 +50,7 @@ module HalApi::Controller::Actions
   def index_options
     valid_params_for_action(:index).tap do |options|
       options[:_keys] = options.keys
-      options[:represent_with] = Api::PagedCollectionRepresenter
+      options[:represent_with] = HalApi::PagedCollection.representer
     end
   end
 
@@ -77,8 +77,8 @@ module HalApi::Controller::Actions
 
   def zoom_param
     @zoom_param ||= begin
-      if (zp = params[:zoom]) && zp.present?
-        zp.split(',').map(&:strip).compact.sort
+      if (zp = params[:zoom]) && !zp.nil?
+        Array(zp.split(',')).map(&:strip).compact.sort
       end
     end
   end

data/lib/hal_api/controller/exceptions.rb

@@ -10,13 +10,12 @@ module HalApi::Controller::Exceptions
     wrapper = ::ActionDispatch::ExceptionWrapper.new(env, exception)
     log_error(env, wrapper)
 
-    error = if exception.is_a?(HalApi::Errors::ApiError)
-              exception
-            else
-              e = HalApi::Errors::ApiError.new(exception.message)
-              e.set_backtrace(exception.backtrace)
-              e
-            end
+    error = exception
+    if !error.is_a?(HalApi::Errors::ApiError)
+      error = HalApi::Errors::ApiError.new(error.message).tap do |e|
+        e.set_backtrace(error.backtrace)
+      end
+    end
 
     respond_with(
       error,

data/lib/hal_api/controller/resources.rb

@@ -82,15 +82,12 @@ module HalApi::Controller::Resources
   # Decorations
 
   def decorate_query(res)
-    filtered(paged(sorted(scoped(res))))
+    filtered(paged(sorted(scoped(included(res)))))
   end
 
   def filtered(arel)
     keys = self.class.resources_params || []
     where_hash = params.slice(*keys)
-    if where_hash.key?('story_id')
-      where_hash['piece_id'] = where_hash.delete('story_id')
-    end
     where_hash = where_hash.permit(where_hash.keys)
     arel = arel.where(where_hash) unless where_hash.blank?
     arel

data/lib/hal_api/paged_collection.rb

@@ -13,6 +13,12 @@ class HalApi::PagedCollection
 
   def_delegators :request, :params
 
+  class_attribute :representer_class
+
+  def self.representer
+    representer_class || HalApi::PagedCollectionRepresenter
+  end
+
   def to_model
     self
   end

data/lib/hal_api/paged_collection_representer.rb

@@ -0,0 +1,63 @@
+require 'hal_api/representer'
+
+class HalApi::PagedCollectionRepresenter < HalApi::Representer
+  property :count
+  property :total
+
+  embeds :items, decorator: lambda{|*| item_decorator }, class: lambda{|*| item_class }, zoom: :always
+
+  link :prev do
+    href_url_helper(params.merge(page: represented.prev_page)) unless represented.first_page?
+  end
+
+  link :next do
+    href_url_helper(params.merge(page: represented.next_page)) unless represented.last_page?
+  end
+
+  link :first do
+    href_url_helper(params.merge(page: nil)) if represented.total_pages > 1
+  end
+
+  link :last do
+    href_url_helper(params.merge(page: represented.total_pages)) if represented.total_pages > 1
+  end
+
+  def params
+    represented.params
+  end
+
+  def self_url(represented)
+    href_url_helper(represented.params)
+  end
+
+  def profile_url(represented)
+    model_uri(:collection, represented.item_class)
+  end
+
+  # refactor to use single property, :url, that can be a method name, a string, or a lambda
+  # if it is a method name, execute against self - the representer - which has local url helpers methods
+  # if it is a sym/string, but self does not respond to it, then just use that string
+  # 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?
+      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
+      end
+      result ||= polymorphic_path([:api, represented.item_class], options) rescue nil
+      return result
+    end
+
+    if represented_url.respond_to?(:call)
+      self.instance_exec(options, &represented_url)
+    elsif self.respond_to?(represented_url)
+      self.send(represented_url, options)
+    else
+      represented_url.to_s
+    end
+  end
+
+  def represented_url
+    @represented_url ||= represented.try(:url)
+  end
+end

data/lib/hal_api/rails/version.rb

@@ -1,5 +1,5 @@
 module HalApi
   module Rails
-    VERSION = "0.2.9"
+    VERSION = "0.3.0"
   end
 end

data/lib/hal_api/represented_model.rb

@@ -15,6 +15,10 @@ module HalApi::RepresentedModel
     is_root_resource
   end
 
+  def id_from_url(url)
+    Rails.application.routes.recognize_path(url)[:id]
+  end
+
   included do
     extend ActiveModel::Naming unless (method(:model_name) rescue nil)
   end

data/lib/hal_api/representer/embeds.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'active_support/concern'
 require 'hal_api/paged_collection'
 
@@ -10,15 +9,24 @@ module HalApi::Representer::Embeds
     Representable::Mapper.send(:include, Resources) if !Representable::Mapper.include?(Resources)
   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
 
-    def skip_property?(binding, options)
-      super(binding, options) || suppress_embed?(binding, options)
+    def skip_property?(binding, private_options)
+      super(binding, private_options) || suppress_embed?(binding, private_options)
     end
 
     # embed if zoomed
     def suppress_embed?(binding, options)
-      name     = (binding[:as] || binding.name).to_s
+      name = binding[:as].evaluate(self).to_s || binding.name
       embedded = !!binding[:embedded]
 
       # not embedded, return false - nothing to suppress
@@ -28,7 +36,7 @@ module HalApi::Representer::Embeds
       !embed_zoomed?(name, binding[:zoom], options[:zoom])
     end
 
-    def embed_zoomed?(name, zoom_def=nil, zoom_param=nil)
+    def embed_zoomed?(name, zoom_def = nil, zoom_param = nil)
       # if the embed in the representer definition has `zoom: :always` defined
       # always embed it, even if it is in another embed
       # (this is really meant for collections where embedded items must be included)
@@ -70,7 +78,7 @@ module HalApi::Representer::Embeds
           per = getter_per == :all ? send(name).count : getter_per
           HalApi::PagedCollection.new(send(name).page(1).per(per), nil, opts.merge(parent: self))
         end
-        options[:decorator] = Api::PagedCollectionRepresenter
+        options[:decorator] = HalApi::PagedCollection.representer
       end
 
       property(name, options)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_api-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Rhoden
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -219,6 +219,7 @@ files:
 - lib/hal_api/controller/resources.rb
 - lib/hal_api/errors.rb
 - lib/hal_api/paged_collection.rb
+- lib/hal_api/paged_collection_representer.rb
 - lib/hal_api/rails.rb
 - lib/hal_api/rails/version.rb
 - lib/hal_api/represented_model.rb
@@ -250,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: JSON HAL APIs on Rails in the style of PRX