the_garage 2.4.4 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c4e3dd92f5413a3042cd8e54590a5028ba27b6ec01ec2776bbe0d950693ccca
-  data.tar.gz: f03ef645cf85bcfd54a416fb06f9d985d7515e8dfda1e2e445da5c4cf5d9239b
+  metadata.gz: 80169386da45b2a7fa5b98e3f855e9df7a49e9fac6357cd894bc26eb24d45a95
+  data.tar.gz: 0d7dd3a20e97a8aeeebdd79e52b99e8ddf4291b6eba0885b1d7a5cf453265792
 SHA512:
-  metadata.gz: 834480a2f01fdbe73e607483b6faddae9cafecc29b6a18d617b7ad221c783b12e5c92471a52188bb54cdf056d8abbdf3f98f20c73dd34fbb6fc3cd3a511ca549
-  data.tar.gz: d31177fc305961dd0dab978a71e0db3f51eef09460d18dfab0580ed07fd4704cd75888bfec0e2d86f215aa845ad3fd6acd8ac97a65e2023e89c1fb60bff06180
+  metadata.gz: a68873fd908fc82273b263f0234a852bf1537e3c6cce7a0ef957652ec773b711f2b7ee28cb1f183644e8f4bb9421c1c2a60fc5caf1ba567d5cf5e5c630fb00dc
+  data.tar.gz: 53ba2171e6f6b1c4eebd3bdc6158e932fea15780a2caecc2b19d5148dfe658c11fb0627cc8bd0c46ba232f29be6d287f9669f3da48a3e595d896df550d8f6aa1

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
@@ -141,7 +153,7 @@ Then configure auth server strategy:
 
 The OAuth server must response a json with following structure.
 
-- `token`(string) - OAuth access token value.
+- `token` (string, null) - OAuth access token value.
 - `token_type` (string) - OAuth access token value. i.e. `bearer` type.
 - `scope` (string) - OAuth scopes separated by spaces. i.e. `public read_user`.
 - `application_id` (integer) - OAuth application id of the access token.

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/controllers/garage/docs/resources_controller.rb

@@ -86,7 +86,7 @@ class Garage::Docs::ResourcesController < Garage::ApplicationController
   def require_console_application
     @app = console_application
     if @app[:uid].blank? || @app[:secret].blank?
-      render(text: 'Configuration for console application is missing.', status: :forbidden)
+      render(plain: 'Configuration for console application is missing.', status: :forbidden)
     end
   end
 

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/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

@@ -1,3 +1,5 @@
+require 'active_support/time_with_zone'
+
 module Garage::Representer
   attr_accessor :params, :representer_attrs, :partial, :selector
 
@@ -51,7 +53,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/access_token.rb

@@ -1,7 +1,8 @@
 module Garage
   module Strategy
     class AccessToken
-      attr_reader :scope, :token, :token_type, :raw_response
+      attr_accessor :token
+      attr_reader :scope, :token_type, :raw_response
 
       def initialize(attrs)
         @raw_response = attrs

data/lib/garage/strategy/auth_server.rb

@@ -58,10 +58,8 @@ module Garage
 
         def fetch
           if has_any_valid_credentials?
-            if has_cacheable_credentials?
-              fetch_with_cache
-            else
-              fetch_without_cache
+            fetch_access_token&.tap do |access_token|
+              access_token.token ||= token_string
             end
           else
             nil
@@ -89,6 +87,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
 
@@ -142,6 +142,14 @@ module Garage
           @bearer_token ||= @request.authorization.try {|o| o.slice(/\ABearer\s+(.+)\z/, 1) }
         end
 
+        def fetch_access_token
+          if has_cacheable_credentials?
+            fetch_with_cache
+          else
+            fetch_without_cache
+          end
+        end
+
         def fetch_with_cache
           Cache.with_cache("garage_gem/token_cache/#{Garage::VERSION}/#{bearer_token}") do
             fetch_without_cache
@@ -160,6 +168,12 @@ module Garage
             end
           end
         end
+
+        def token_string
+          bearer_token.presence ||
+            @request.params[:access_token].presence ||
+            @request.params[:bearer_token].presence
+        end
       end
 
       class Response

data/lib/garage/version.rb

@@ -1,3 +1,3 @@
 module Garage
-  VERSION = '2.4.4'
+  VERSION = '2.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_garage
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.7.0
 platform: ruby
 authors:
 - Tatsuhiko Miyagawa
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rack-accept-default
   requirement: !ruby/object:Gem::Requirement
@@ -164,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Garage extends your RESTful, Hypermedia APIs as a Platform
 email:
 - miyagawa@bulknews.net
@@ -255,7 +241,7 @@ homepage: https://github.com/cookpad/garage
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -270,8 +256,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Garage Platform Engine
 test_files: []