the_garage 2.4.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 40c843f3541b358a20f20fce55a9e09913d75722
-  data.tar.gz: 17d0231446753d51c7bbebd42bcf9c5f348e49e8
+SHA256:
+  metadata.gz: cc60156398751cb043b40c324f50cd90cd4beaf92600cb5de192a087875716df
+  data.tar.gz: b7421b618063e678141521822c7f4b5e1a9af1bf7edaa714889fb9f824c63be6
 SHA512:
-  metadata.gz: f46a8245d7e9df31072d13b3607df7bdcf9e7a91b03b3e3e67460f9d2240f00086d366acf126cc580520d7073365b28a7e9e73012093eaa0b56783129c920dfb
-  data.tar.gz: 93e345d15e4d1126e761be0e379e7346f3607d7675b77e41ff46363e5e70a0aa8a7c0f20a26595caea2510cde2a6e29d8f2488de466ea99f48c825345bac533c
+  metadata.gz: 771c78fdc46b938e26f6009d1a4b673afddb52632080a12dede7c906dfe1a1fde8faf2c1ba47c69b48168315106e0ef2bd5c2c9aef2d4a79837a749aa2f6282a
+  data.tar.gz: ebbbf30696f2e46b5c7eb34b0ab2d54d13e0d5d9c6b73666bead201c6a0be4f7f0ea412032c7e263fe30b8978514fad469c640260c63e974c12e48ad591dccc3

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/javascripts/garage/docs/console.js.coffee

@@ -9,14 +9,6 @@ jQuery ()->
     $.colorbox.close()
     ev.preventDefault()
 
-  buildAuthorizedUrl = (base, location, token) ->
-    url = base + location
-    if url.indexOf('?') > 0
-      url += '&'
-    else
-      url += '?'
-    url + 'access_token=' + token
-
   addNewParamField = (container) ->
     nextId = "parameter-" + $('.parameter', container).length
     copy = $('.template .parameter').clone().attr('id', nextId)
@@ -52,11 +44,11 @@ jQuery ()->
     $('#api-headers').text ''
     $('#api-response').text ''
 
-    url = buildAuthorizedUrl $('#base').val(), $('#location').val(), $('#access_token').val()
     console.log buildData($('.parameters'))
     $.ajax
       type: $('#method').val(),
-      url: url,
+      url: $('#base').val() + $('#location').val(),
+      headers: {'Authorization': 'Bearer ' + $('#access_token').val()},
       cache: false,
       data: buildData($('.parameters')),
       dataType: 'json',

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/paginating_responder.rb

@@ -90,7 +90,7 @@ module Garage
         links[:next] = rs.current_page + 1
       end
 
-      unless rs.last_page? || hide_total?
+      unless rs.last_page? || hide_total? || rs.total_pages.zero?
         links[:last] = rs.total_pages
       end
     end

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/strategy/auth_server.rb

@@ -89,6 +89,8 @@ module Garage
             'Resource-Owner-Id' => @request.headers['Resource-Owner-Id'],
             'Scopes' => @request.headers['Scopes'],
             'User-Agent' => USER_AGENT,
+            # ActionDispatch::Request#request_id is only available in Rails 5.0 or later.
+            'X-Request-Id' => @request.uuid,
           }.reject {|_, v| v.nil? }
         end
 

data/lib/garage/tracer.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module Garage
   module Tracer
     extend self
@@ -45,48 +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|
-            if Aws::Xray::Context.current.respond_to?(:disable_trace)
-              Aws::Xray::Context.current.disable_trace(:net_http) { yield new(sub) }
-            else
-              yield new(sub)
-            end
-          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.1'
+  VERSION = '2.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_garage
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Tatsuhiko Miyagawa
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -255,7 +255,7 @@ homepage: https://github.com/cookpad/garage
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -270,9 +270,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: []