grape-app 0.8.1 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77187b9f038601c08edaa41385655236b13907e88a22baa30cdc037641ebb214
-  data.tar.gz: c21cce56ec2393c67ef7885c01c187641205367b44b2624c0944b560f6aeb954
+  metadata.gz: 9b76f380cd6957fb37025cb07c4343471d9fa892f387c9f5110eb5a713f7a5bc
+  data.tar.gz: 34b4f3c1c0912fac71bed2d75448f90bf6aba60ec96300c208c13aca324a19a7
 SHA512:
-  metadata.gz: b29b7f6971e417b1d5d2a0e396eb456c37a5b0cee7ae3b9716faf8adc96a4321df510b9809dd457b5f37e3a70af2ee6e708eb1ffbc140daa5c5455266ad560bb
-  data.tar.gz: dd6e2198260a448270026d13776c2fb0b26f8e236349491fbde0438b5495d959a044361555efc6e7a03bffcf7e4c0f88d0aab0397870ec01e70253ac68fd726a
+  metadata.gz: f2325d245dba242af124309a3a9193e9c4af1fe17fb9e611650a1230b453b4086a3870073690e60911141e9e10696db9f416c49f530f95d6a9a6e818d70e0822
+  data.tar.gz: c1415686241fffa006cfb36b4518b2342e2fa889e175beae428659acf0b4dbd4a8f934eb89cf734fba729189d640d6377cd3fe6fabebc4d5cc72517c296fbfd0

data/.travis.yml

@@ -2,5 +2,6 @@ language: ruby
 rvm:
   - 2.5
   - 2.6
+  - 2.7
 before_install:
   - gem install bundler

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    grape-app (0.8.1)
+    grape-app (0.8.6)
       activesupport
       grape (>= 1.2)
       grape-entity
-      rack-cors
+      rack-cors (>= 1.1)
       rack-ssl-enforcer
       thor
       zeitwerk (>= 2.1)
@@ -13,94 +13,124 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.1)
-      activesupport (= 6.0.1)
-    activerecord (6.0.1)
-      activemodel (= 6.0.1)
-      activesupport (= 6.0.1)
-    activesupport (6.0.1)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    ast (2.4.0)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    builder (3.2.3)
+    builder (3.2.4)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
+    dry-configurable (0.11.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
     equalizer (0.0.11)
-    grape (1.2.4)
+    grape (1.3.3)
       activesupport
       builder
+      dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-      virtus (>= 1.0.0)
-    grape-entity (0.7.1)
-      activesupport (>= 4.0)
+    grape-entity (0.8.0)
+      activesupport (>= 3.0.0)
       multi_json (>= 1.3.2)
-    i18n (1.7.0)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    jaro_winkler (1.5.4)
-    minitest (5.13.0)
+    minitest (5.14.1)
     multi_json (1.14.1)
-    mustermann (1.0.3)
-    mustermann-grape (1.0.0)
-      mustermann (~> 1.0.0)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    rack (2.0.7)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.1)
+      mustermann (>= 1.0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rack (2.2.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
-    rack-cors (1.0.3)
+    rack-cors (1.1.1)
+      rack (>= 2.0.0)
     rack-ssl-enforcer (0.2.9)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
-    rake (13.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.76.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.86.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
-    sqlite3 (1.4.1)
-    thor (0.20.3)
+    ruby2_keywords (0.0.2)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
     virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
-    zeitwerk (2.2.1)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby
@@ -114,6 +144,7 @@ DEPENDENCIES
   rspec
   rubocop
   sqlite3
+  virtus
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/grape-app.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name          = 'grape-app'
-  s.version       = '0.8.1'
+  s.version       = '0.8.6'
   s.authors       = ['Black Square Media Ltd']
   s.email         = ['info@blacksquaremedia.com']
-  s.summary       = %(Stanalone Grape API apps)
+  s.summary       = %(Standalone Grape API apps)
   s.description   = %()
   s.homepage      = 'https://github.com/bsm/grape-app'
   s.license       = 'MIT'
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport'
   s.add_dependency 'grape', '>= 1.2'
   s.add_dependency 'grape-entity'
-  s.add_dependency 'rack-cors'
+  s.add_dependency 'rack-cors', '>= 1.1'
   s.add_dependency 'rack-ssl-enforcer'
   s.add_dependency 'thor'
   s.add_dependency 'zeitwerk', '>= 2.1'
@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'virtus'
 end

data/lib/grape/app.rb

@@ -8,11 +8,10 @@ require 'rack/cors'
 require 'rack/ssl-enforcer'
 require 'zeitwerk'
 
-class Grape::App < Grape::API::Instance
+class Grape::App < Grape::API
   class << self
-
     # Run initializers
-    def init!(root=nil)
+    def init!(root = nil)
       @root = Pathname.new(root) if root
 
       # Require bundle

data/lib/grape/app/cli.rb

@@ -24,14 +24,13 @@ module Grape::App::CLI
     def init_lib
       empty_directory File.join(name, 'lib', name)
     end
-
   end
 
   class Runner < Thor
     register Builder, :new, 'new NAME', 'create a new application'
 
     desc 'console ENV', 'Launch console'
-    def console(env='development')
+    def console(env = 'development')
       ENV['GRAPE_ENV'] = env
       require File.expand_path('config/environment', Dir.pwd)
 

data/lib/grape/app/configuration.rb

@@ -1,5 +1,4 @@
 class Grape::App::Configuration < ActiveSupport::InheritableOptions
-
   def middleware(&block)
     self[:middleware] ||= []
     self[:middleware].push(block) if block
@@ -22,5 +21,4 @@ class Grape::App::Configuration < ActiveSupport::InheritableOptions
       end
     end
   end
-
 end

data/lib/grape/app/helpers/caching.rb

@@ -17,14 +17,13 @@ module Grape::App::Helpers::Caching
   #     article
   #   end
   #
-  def fresh_when(object=nil, etag: nil, last_modified: nil, **cache_control)
+  def fresh_when(object = nil, etag: nil, last_modified: nil, last_modified_field: :updated_at, **cache_control)
     etag ||= object
-    last_modified ||= object.try(:updated_at) || object.try(:maximum, :updated_at)
-
+    last_modified = object.try(last_modified_field) || object.try(:maximum, last_modified_field) if last_modified.nil?
     etag = ActiveSupport::Digest.hexdigest(ActiveSupport::Cache.expand_cache_key(etag))
     header 'ETag', etag
     header 'Last-Modified', last_modified.httpdate if last_modified
-    cache_control(cache_control)
+    cache_control(**cache_control) unless cache_control.empty?
 
     if_modified_since = headers['If-Modified-Since']
     if_modified_since = Time.rfc2822(if_modified_since) rescue nil if if_modified_since # rubocop:disable Style/RescueModifier
@@ -49,7 +48,7 @@ module Grape::App::Helpers::Caching
   #     stats = article.really_expensive_call if stale?(article)
   #   end
   #
-  def stale?(object=nil, **freshness_opts)
+  def stale?(object = nil, **freshness_opts)
     fresh_when(object, **freshness_opts)
     true
   end

data/lib/grape/app/helpers/respond_with.rb

@@ -6,7 +6,7 @@ module Grape::App::Helpers::RespondWith
   end
 
   # @param [ActiveRecord::Base] record validated record
-  def respond_with(record, opts={})
+  def respond_with(record, opts = {})
     unless record.errors.empty?
       opts[:with] = Errors
       status 400

data/lib/grape/app/tasks/databases.rake

@@ -11,7 +11,6 @@ ActiveRecord::Tasks::DatabaseTasks.tap do |config|
 end
 
 namespace :db do
-
   Rake::Task['load_config'].clear
 
   task load_config: :environment do
@@ -34,12 +33,12 @@ namespace :db do
     ar_version = [ActiveRecord::VERSION::MAJOR, ActiveRecord::VERSION::MINOR].join('.')
 
     FileUtils.mkdir_p(migrations_path)
-    File.write path, <<-MIGRATION.strip_heredoc
+    File.write path, <<~RUBY
       class #{name.camelize} < ActiveRecord::Migration[#{ar_version}]
         def change
         end
       end
-    MIGRATION
+    RUBY
     puts path
   end
 
@@ -47,5 +46,4 @@ namespace :db do
     desc 'Prepare test DB'
     task :prepare
   end
-
 end

data/lib/grape/app/templates/app/api/v1.rb

@@ -1,4 +1,4 @@
-class API::V1 < Grape::API::Instance
+class API::V1 < Grape::API
   version 'v1'
   prefix  'api'
   format  :json
@@ -11,5 +11,4 @@ class API::V1 < Grape::API::Instance
 
   # Mount components
   # mount API::Posts
-
 end

data/spec/grape/app/helpers/caching_spec.rb

@@ -9,7 +9,6 @@ RSpec.describe Grape::App::Helpers::Caching do
     get '/articles'
     expect(last_response.status).to eq(200)
     expect(last_response.headers).to include(
-      'Cache-Control' => 'public',
       'Content-Type'  => 'application/json',
       'ETag'          => '975ca8804565c1a569450d61090b2743',
       'Last-Modified' => 'Fri, 05 Jan 2018 11:25:20 GMT',
@@ -31,6 +30,22 @@ RSpec.describe Grape::App::Helpers::Caching do
     expect(last_response.status).to eq(200)
   end
 
+  it 'should handle fresh_when for records that were never updated' do
+    get '/articles/never_updated'
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers).to include(
+      'Last-Modified' => 'Fri, 05 Jan 2018 11:25:00 GMT',
+    )
+  end
+
+  it 'should support cache-control' do
+    get '/articles?public=true'
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers).to include(
+      'Cache-Control' => 'public',
+    )
+  end
+
   it 'should handle stale? (with cache-control)' do
     get '/articles/1'
     expect(last_response.status).to eq(200)
@@ -44,6 +59,7 @@ RSpec.describe Grape::App::Helpers::Caching do
       'id'         => 1,
       'title'      => 'Welcome',
       'updated_at' => '2018-01-05 11:25:10 UTC',
+      'created_at' => '2018-01-05 11:25:00 UTC',
     )
 
     get '/articles/1', {}, 'HTTP_IF_NONE_MATCH' => last_response.headers['ETag']

data/spec/grape/app/helpers/params_spec.rb

@@ -9,6 +9,7 @@ RSpec.describe Grape::App::Helpers::Params do
     post '/articles', title: 'Today', fresh: true, id: 1234, updated_at: Time.now
     expect(last_response.status).to eq(201)
     expect(JSON.parse(last_response.body)).to eq(
+      'created_at' => nil,
       'id'         => 9,
       'title'      => 'Today',
       'updated_at' => '2018-01-05 11:25:15 UTC',

data/spec/grape/app_spec.rb

@@ -20,7 +20,7 @@ RSpec.describe Grape::App do
   end
 
   it 'should be an API instance' do
-    expect(subject).to be < Grape::API::Instance
+    expect(subject).to be < Grape::API
   end
 
   it 'should init with default time zone' do

data/spec/scenario/app/api/posts.rb

@@ -1,4 +1,4 @@
-class API::Posts < Grape::API::Instance
+class API::Posts < Grape::API
   get '/posts' do
     []
   end

data/spec/scenario/app/api/v1.rb

@@ -1,4 +1,4 @@
-class API::V1 < Grape::API::Instance
+class API::V1 < Grape::API
   version 'v1'
   format  :json
 

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 ENV['RACK_ENV'] ||= 'test'
 require 'grape-app'
 require 'rack/test'
+require 'virtus'
 
 class Article
   include Virtus.model
@@ -13,8 +14,8 @@ class Article
     end
 
     def each
-      yield Article.new(id: 1, title: 'Welcome', updated_at: Time.at(1515151510).utc)
-      yield Article.new(id: 2, title: 'Bye', updated_at: Time.at(1515151520).utc)
+      yield Article.new(id: 1, title: 'Welcome', updated_at: Time.at(1515151510).utc, created_at: Time.at(1515151500).utc)
+      yield Article.new(id: 2, title: 'Bye', updated_at: Time.at(1515151520).utc, created_at: Time.at(1515151500).utc)
     end
   end
 
@@ -25,13 +26,14 @@ class Article
   attribute :id
   attribute :title
   attribute :updated_at
+  attribute :created_at
 
   def to_param
     id.to_s
   end
 end
 
-class TestAPI < Grape::API::Instance
+class TestAPI < Grape::API
   format :json
 
   helpers Grape::App::Helpers::Caching
@@ -39,10 +41,18 @@ class TestAPI < Grape::API::Instance
 
   get '/articles' do
     scope = Article.all
-    fresh_when(scope, public: true)
+    opts  = params[:public] ? { public: params[:public] } : {}
+    fresh_when(scope, **opts)
     scope.map(&:to_hash)
   end
 
+  get '/articles/never_updated' do
+    article = Article.all.first
+    article.updated_at = nil
+
+    fresh_when(article, last_modified_field: :created_at)
+  end
+
   get '/articles/:id' do
     article = Article.all.first
     article.to_hash if stale?(article, stale_if_error: 5, extras: { a: 1, b: 2 })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-app
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.6
 platform: ruby
 authors:
 - Black Square Media Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rack-ssl-enforcer
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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: ''
 email:
 - info@blacksquaremedia.com
@@ -284,10 +298,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Stanalone Grape API apps
+summary: Standalone Grape API apps
 test_files:
 - spec/grape/app/helpers/caching_spec.rb
 - spec/grape/app/helpers/params_spec.rb