the_garage 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df6a793861e979f1a7849b0d6ef3ef5764757980
-  data.tar.gz: df87e84d9f87372c8c2061d4aafabd6849d89b52
+SHA256:
+  metadata.gz: 8a8b827892d32f5517d67991bfc76a4832eba4f3aa5b1c1d1cd1f76141bc3422
+  data.tar.gz: fce58bbb7be2ef82e68416650419d88e3bf10205c011806660081a594cf29d6a
 SHA512:
-  metadata.gz: 996522903af5c5b250cb7a99f41a8ed095a23c17b36076cd8bf34409b16d02b4f5ec6196b357238b1726452d8ceba415b481d4f2f56abbc7c19997972a557c97
-  data.tar.gz: c96ace465cac6ade9d7b477ab3c58b457b660e709067490213154f5b017392ca717b87980dd7058ada25ede679ad2de6c2d17ab43b20dbaf9259264c58e5b6a6
+  metadata.gz: d691e438110eabee1b14a9f011067f67f4cf5119f248843d6c4d8d3f44125e7f7a76f0b56d12cac53770238425c6a2d5f62c4321e8273264ce4306e6f943c0e8
+  data.tar.gz: d408e49c73f46d1fcda1d3d8f9a61a76b8a7e6411172bf4eace5c38c4572be838e4c0f65e1f8dea5006949532b741fc19de4600d72fccde4a49dc8bc7468f810

data/README.md

@@ -52,7 +52,7 @@ In your controller classes:
 ```ruby
 class ApplicationController < ActionController::Base
   include Garage::ControllerHelper
-  
+
   # ...
 end
 
@@ -65,6 +65,18 @@ class EmployeesController < ApplicationController
 end
 ```
 
+Resources are rendered with [respond_with (responders gem)](https://github.com/heartcombo/responders).
+Additional options can be passed to respond_with by implementing `respond_with_resources_options` (index action)
+and `respond_with_resource_options` (show, update destroy actions).
+
+Available options
+* `:paginate` - (Boolean) Enable pagination when `true`. Paginates with the `per_page` and `page` params
+* `:per_page` - (Integer) value for default number of resources per page when paginating
+* `:max_per_page` - (Integer) Maximum resources per page, irrespective of requested per_page
+* `:hard_limit` - (Integer) Limit of retrievable records when paginating. Also hides total records.
+* `:distinct_by` - (Symbol) Specify a property to count by for total page count
+* `:to_resource_options` - (Hash) Options to pass as argument to `to_resource(options)`
+
 ## Create decorator for your AR models
 With not small application, you may add a presentation layer to build API responses.
 Define a decorator class with `Resource` suffix and define `#to_resource` in
@@ -197,7 +209,7 @@ Currently, we support following tracers:
 
 ```ruby
 # e.g. aws-xray tracer
-require 'aws/xray'
+require 'aws/xray/hooks/net_http'
 Garage::Tracer::AwsXrayTracer.service = 'your-auth-server-name'
 Garage.configuration.tracer = Garage::Tracer::AwsXrayTracer
 ```

data/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/app/views/layouts/garage/application.html.haml

@@ -6,7 +6,7 @@
     = csrf_meta_tags
     = stylesheet_link_tag "garage/application", :media => "all"
     = javascript_include_tag "garage/application"
-    = favicon_link_tag "favicon.ico"
+    = favicon_link_tag "favicon.ico", skip_pipeline: true
 
   %body{ class: action_classes }
     .navbar.navbar-default.navbar-static-top
@@ -19,7 +19,7 @@
             %li= link_to "Console", console_resources_path
           %ul.nav.navbar-nav.navbar-right
             - if _current_user
-              %li= link_to "Signout", "/signout", method: :post
+              %li= link_to "Signout", Garage.configuration.docs.signout_path, method: Garage.configuration.docs.signout_request_method
 
     .main
       .container

data/lib/garage/config.rb

@@ -49,11 +49,13 @@ module Garage
     end
 
     def cast_resource
-      @cast_resource ||= proc { |resource|
+      @cast_resource ||= proc { |resource, options|
+        options ||= {}
+        to_resource_args = [options[:to_resource_options]].compact
         if resource.respond_to?(:map) && resource.respond_to?(:to_a)
-          resource.map(&:to_resource)
+          resource.map { |r| r.to_resource(*to_resource_args) }
         else
-          resource.to_resource
+          resource.to_resource(*to_resource_args)
         end
       }
     end

data/lib/garage/docs/config.rb

@@ -3,7 +3,8 @@ module Garage
     class Config
       attr_accessor :document_root, :current_user_method, :authenticate,
         :console_app_uid, :console_app_secret, :remote_server,
-        :docs_authorization_method, :docs_cache_enabled
+        :docs_authorization_method, :docs_cache_enabled,
+        :signout_path, :signout_request_method
 
       def initialize
         reset
@@ -17,6 +18,8 @@ module Garage
         @remote_server = Proc.new {|request| "#{request.protocol}#{request.host_with_port}" }
         @docs_authorization_method = nil
         @docs_cache_enabled = true
+        @signout_path = '/signout'
+        @signout_request_method = :post
       end
 
       class Builder
@@ -55,6 +58,14 @@ module Garage
         def docs_authorization_method(&block)
           @config.docs_authorization_method = block
         end
+
+        def signout_path=(value)
+          @config.signout_path = value
+        end
+
+        def signout_request_method=(value)
+          @config.signout_request_method = value.to_sym
+        end
       end
     end
   end

data/lib/garage/hypermedia_responder.rb

@@ -24,7 +24,9 @@ module Garage
     # `#resource_identifier` or `#id`.
     def encode_to_hash(resource, *args)
       if id = get_resource_identifier(resource)
-        cache_key = "#{resource.class.name}:#{id}"
+        options = args[0] || {}
+        selector = options[:selector] || controller.field_selector
+        cache_key = "#{resource.class.name}:#{id}:#{selector.canonical}"
         cache[cache_key] ||= _encode_to_hash(resource, *args)
       else
         _encode_to_hash(resource, *args)

data/lib/garage/representer.rb

@@ -51,7 +51,7 @@ module Garage::Representer
     self.class
   end
 
-  def to_resource
+  def to_resource(options = {})
     self
   end
 

data/lib/garage/resource_casting_responder.rb

@@ -6,7 +6,7 @@ module Garage::ResourceCastingResponder
 
   def display(resource, given_options={})
     if @caster
-      resource = @caster.call(resource)
+      resource = @caster.call(resource, @options)
     end
     super(resource, given_options)
   end

data/lib/garage/tracer.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module Garage
   module Tracer
     extend self
@@ -45,44 +47,17 @@ module Garage
       end
 
       def self.start(&block)
-        if Aws::Xray::Context.started?
-          Aws::Xray::Context.current.child_trace(remote: true, name: service) do |sub|
-            yield new(sub)
-          end
-        else
-          yield NullTracer.new
-        end
-      end
-
-      def initialize(sub_segment)
-        @sub = sub_segment
+        yield new
       end
 
       def inject_trace_context(header)
-        header.merge('X-Amzn-Trace-Id' => @sub.generate_trace.to_header_value)
+        header.merge('X-Aws-Xray-Name' => self.class.service)
       end
 
       def record_http_request(method, url, user_agent)
-        request = Aws::Xray::Request.build(method: method.to_s.upcase, url: url, user_agent: user_agent)
-        @sub.set_http_request(request)
       end
 
       def record_http_response(status, content_length)
-        @sub.set_http_response(status, content_length || 0)
-
-        case status
-        when 499
-          cause = Aws::Xray::Cause.new(stack: caller, message: 'Got 499', type: 'http_request_error')
-          @sub.set_error(error: true, throttle: true, cause: cause)
-        when 400..498
-          cause = Aws::Xray::Cause.new(stack: caller, message: 'Got 4xx', type: 'http_request_error')
-          @sub.set_error(error: true, cause: cause)
-        when 500..599
-          cause = Aws::Xray::Cause.new(stack: caller, message: 'Got 5xx', type: 'http_request_error')
-          @sub.set_error(fault: true, remote: true, cause: cause)
-        else
-          # pass
-        end
       end
     end
   end

data/lib/garage/version.rb

@@ -1,3 +1,3 @@
 module Garage
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_garage
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Tatsuhiko Miyagawa
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-07 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -188,6 +188,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/config/manifest.js
 - app/assets/javascripts/garage/application.js
 - app/assets/javascripts/garage/docs/console.js.coffee
 - app/assets/javascripts/garage/docs/jquery.colorbox.js
@@ -255,7 +256,7 @@ homepage: https://github.com/cookpad/garage
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -270,9 +271,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Garage Platform Engine
 test_files: []