grape-app 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbe3e3723dc43a07adf70cb9803a3f679930d6de5e3ddeeb9737e4ce4547898a
-  data.tar.gz: 1d5b409da0440ae34f48967f5a3fb3845ff542f20c160d561911f63b7f6a968c
+  metadata.gz: 77187b9f038601c08edaa41385655236b13907e88a22baa30cdc037641ebb214
+  data.tar.gz: c21cce56ec2393c67ef7885c01c187641205367b44b2624c0944b560f6aeb954
 SHA512:
-  metadata.gz: ed20c0d9a5ed53765e44111ffda80b362c1c2911b4a7f769422e2c67a78741628a91b800003e46b3cff76346282d019343cfa51d898d11d944530b80dcba77a3
-  data.tar.gz: 2a30feaecf44c728cd1f28d6612aa239fbefd5bb2fad2a6d6ee3ef622af82c9b14ed97751c54e4dbb6697e4c3e71a50dce3d07670883fc4063ec93978145ffc0
+  metadata.gz: b29b7f6971e417b1d5d2a0e396eb456c37a5b0cee7ae3b9716faf8adc96a4321df510b9809dd457b5f37e3a70af2ee6e708eb1ffbc140daa5c5455266ad560bb
+  data.tar.gz: dd6e2198260a448270026d13776c2fb0b26f8e236349491fbde0438b5495d959a044361555efc6e7a03bffcf7e4c0f88d0aab0397870ec01e70253ac68fd726a

data/.rubocop.yml

@@ -3,3 +3,6 @@ inherit_from:
 
 AllCops:
   TargetRubyVersion: "2.5"
+Metrics/ParameterLists:
+  Exclude:
+    - lib/grape/app/helpers/caching.rb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape-app (0.8.0)
+    grape-app (0.8.1)
       activesupport
       grape (>= 1.2)
       grape-entity
@@ -13,17 +13,17 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    activemodel (6.0.1)
+      activesupport (= 6.0.1)
+    activerecord (6.0.1)
+      activemodel (= 6.0.1)
+      activesupport (= 6.0.1)
+    activesupport (6.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2)
     ast (2.4.0)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
@@ -47,17 +47,17 @@ GEM
     grape-entity (0.7.1)
       activesupport (>= 4.0)
       multi_json (>= 1.3.2)
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    multi_json (1.13.1)
+    jaro_winkler (1.5.4)
+    minitest (5.13.0)
+    multi_json (1.14.1)
     mustermann (1.0.3)
     mustermann-grape (1.0.0)
       mustermann (~> 1.0.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    parallel (1.18.0)
+    parser (2.6.5.0)
       ast (~> 2.4.0)
     rack (2.0.7)
     rack-accept (0.4.5)
@@ -67,21 +67,21 @@ GEM
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
-    rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.0)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.74.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
@@ -100,7 +100,7 @@ GEM
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
-    zeitwerk (2.1.9)
+    zeitwerk (2.2.1)
 
 PLATFORMS
   ruby
@@ -116,4 +116,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/grape-app.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'grape-app'
-  s.version       = '0.8.0'
+  s.version       = '0.8.1'
   s.authors       = ['Black Square Media Ltd']
   s.email         = ['info@blacksquaremedia.com']
   s.summary       = %(Stanalone Grape API apps)

data/lib/grape/app/helpers.rb

@@ -1,6 +1,7 @@
 module Grape::App::Helpers
   extend ActiveSupport::Autoload
 
+  autoload :Caching
   autoload :Params
   autoload :RespondWith
 end

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

@@ -0,0 +1,107 @@
+require 'digest'
+require 'active_support/digest'
+require 'active_support/cache'
+
+# Caching support for Grape.
+# "Borrowed" from [Ruby on Rails](https://github.com/rails/rails/blob/66cabeda2c46c582d19738e1318be8d59584cc5b/actionpack/lib/action_controller/metal/conditional_get.rb)
+module Grape::App::Helpers::Caching
+  # Sets the `etag`, or `last_modified`, or both on the response and renders a
+  # "304 Not Modified" response if the request is already fresh.
+  #
+  # @example
+  #
+  #   get '/articles/:id' do
+  #     article = Article.find(params[:id])
+  #     fresh_when(article, public: true)
+  #
+  #     article
+  #   end
+  #
+  def fresh_when(object=nil, etag: nil, last_modified: nil, **cache_control)
+    etag ||= object
+    last_modified ||= object.try(:updated_at) || object.try(:maximum, :updated_at)
+
+    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)
+
+    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
+    if_none_match     = headers['If-None-Match']
+    return unless if_modified_since || if_none_match
+
+    fresh = true
+    fresh &&= last_modified && if_modified_since >= last_modified if if_modified_since
+    fresh &&= if_none_match == etag if if_none_match
+    error! 'Not Modified', 304 if fresh
+  end
+
+  # Sets the `etag` and/or `last_modified` on the response and checks it against
+  # the client request. If the request doesn't match the options provided, the
+  # request is considered stale and should be generated from scratch.
+  # Otherwise, it's fresh and we don't need to generate anything and reply with `304 Not Modified`.
+  #
+  # @example:
+  #
+  #   get '/articles/:id' do
+  #     article = Article.find(params[:id])
+  #     stats = article.really_expensive_call if stale?(article)
+  #   end
+  #
+  def stale?(object=nil, **freshness_opts)
+    fresh_when(object, **freshness_opts)
+    true
+  end
+
+  # Sets an HTTP 1.1 Cache-Control header. Defaults to `private`.
+  #
+  # @example
+  #
+  #   expires_in 20.minutes
+  #   expires_in 3.hours, public: true
+  #   expires_in 3.hours, public: true, must_revalidate: true
+  #
+  # This method will overwrite an existing Cache-Control header.
+  # See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for more possibilities.
+  #
+  # The method will also ensure an HTTP Date header for client compatibility.
+  def expires_in(seconds, public: false, must_revalidate: false, stale_while_revalidate: nil, stale_if_error: nil, extras: {})
+    header 'Date', Time.now.httpdate
+
+    cache_control(
+      max_age: seconds,
+      public: public,
+      must_revalidate: must_revalidate,
+      stale_while_revalidate: stale_while_revalidate,
+      stale_if_error: stale_if_error,
+      extras: extras,
+    )
+  end
+
+  # Sets an HTTP 1.1 Cache-Control header of `no-cache`. This means the
+  # resource will be marked as stale, so clients must always revalidate.
+  # Intermediate/browser caches may still store the asset.
+  def expires_now(public: false)
+    cache_control(no_cache: true, public: public)
+  end
+
+  def cache_control(max_age: nil, no_cache: false, public: false, must_revalidate: false, stale_while_revalidate: nil, stale_if_error: nil, extras: nil)
+    extras = extras.map {|k, v| "#{k}=#{v}" } if extras.is_a?(Hash)
+    opts   = []
+
+    if no_cache
+      opts << 'public' if public
+      opts << 'no-cache'
+    else
+      opts << "max-age=#{max_age.to_i}" if max_age
+      opts << (public ? 'public' : 'private')
+      opts << 'must-revalidate' if must_revalidate
+      opts << "stale-while-revalidate=#{stale_while_revalidate.to_i}" if stale_while_revalidate
+      opts << "stale-if-error=#{stale_if_error.to_i}" if stale_if_error
+    end
+    opts.concat(extras) if extras
+
+    header 'Cache-Control', opts.join(', ')
+  end
+end

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

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe Grape::App::Helpers::Caching do
+  include Rack::Test::Methods
+
+  let(:app) { TestAPI }
+
+  it 'should handle fresh-when' 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',
+    )
+    expect(JSON.parse(last_response.body).size).to eq(2)
+
+    get '/articles', {}, 'HTTP_IF_NONE_MATCH' => last_response.headers['ETag']
+    expect(last_response.status).to eq(304)
+    get '/articles', {}, 'HTTP_IF_MODIFIED_SINCE' => 'Fri, 05 Jan 2018 11:25:20 GMT'
+    expect(last_response.status).to eq(304)
+    get '/articles', {}, 'HTTP_IF_NONE_MATCH' => last_response.headers['ETag'], 'HTTP_IF_MODIFIED_SINCE' => 'Fri, 05 Jan 2018 11:25:21 GMT'
+    expect(last_response.status).to eq(304)
+
+    get '/articles', {}, 'HTTP_IF_MODIFIED_SINCE' => 'Fri, 05 Jan 2018 11:25:19 GMT'
+    expect(last_response.status).to eq(200)
+    get '/articles', {}, 'HTTP_IF_MODIFIED_SINCE' => 'Fri, 05 Jan 2018 11:25:19 GMT', 'HTTP_IF_NONE_MATCH' => last_response.headers['ETag']
+    expect(last_response.status).to eq(200)
+    get '/articles', {}, 'HTTP_IF_MODIFIED_SINCE' => 'Fri, 05 Jan 2018 11:25:20 GMT', 'HTTP_IF_NONE_MATCH' => 'other'
+    expect(last_response.status).to eq(200)
+  end
+
+  it 'should handle stale? (with cache-control)' do
+    get '/articles/1'
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers).to include(
+      'Cache-Control' => 'private, stale-if-error=5, a=1, b=2',
+      'Content-Type'  => 'application/json',
+      'ETag'          => 'c4ca4238a0b923820dcc509a6f75849b',
+      'Last-Modified' => 'Fri, 05 Jan 2018 11:25:10 GMT',
+    )
+    expect(JSON.parse(last_response.body)).to eq(
+      'id'         => 1,
+      'title'      => 'Welcome',
+      'updated_at' => '2018-01-05 11:25:10 UTC',
+    )
+
+    get '/articles/1', {}, 'HTTP_IF_NONE_MATCH' => last_response.headers['ETag']
+    expect(last_response.status).to eq(304)
+    expect(last_response.headers).to include(
+      'Cache-Control' => 'private, stale-if-error=5, a=1, b=2',
+      'ETag'          => 'c4ca4238a0b923820dcc509a6f75849b',
+      'Last-Modified' => 'Fri, 05 Jan 2018 11:25:10 GMT',
+    )
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe Grape::App::Helpers::Params do
+  include Rack::Test::Methods
+
+  let(:app) { TestAPI }
+
+  it 'should limit 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(
+      'id'         => 9,
+      'title'      => 'Today',
+      'updated_at' => '2018-01-05 11:25:15 UTC',
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,60 @@
 ENV['RACK_ENV'] ||= 'test'
 require 'grape-app'
 require 'rack/test'
+
+class Article
+  include Virtus.model
+
+  class Scope
+    include Enumerable
+
+    def maximum(*)
+      map(&:updated_at).max
+    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)
+    end
+  end
+
+  def self.all
+    Scope.new
+  end
+
+  attribute :id
+  attribute :title
+  attribute :updated_at
+
+  def to_param
+    id.to_s
+  end
+end
+
+class TestAPI < Grape::API::Instance
+  format :json
+
+  helpers Grape::App::Helpers::Caching
+  helpers Grape::App::Helpers::Params
+
+  get '/articles' do
+    scope = Article.all
+    fresh_when(scope, public: true)
+    scope.map(&:to_hash)
+  end
+
+  get '/articles/:id' do
+    article = Article.all.first
+    article.to_hash if stale?(article, stale_if_error: 5, extras: { a: 1, b: 2 })
+  end
+
+  params do
+    requires :title
+    optional :fresh
+  end
+  post '/articles' do
+    attrs = { id: 9, updated_at: Time.at(1515151515).utc }
+    attrs.update(declared_params)
+    Article.new(attrs).to_hash
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-app
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Black Square Media Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2019-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -230,6 +230,7 @@ files:
 - lib/grape/app/cli.rb
 - lib/grape/app/configuration.rb
 - lib/grape/app/helpers.rb
+- lib/grape/app/helpers/caching.rb
 - lib/grape/app/helpers/params.rb
 - lib/grape/app/helpers/respond_with.rb
 - lib/grape/app/inflector.rb
@@ -252,6 +253,8 @@ files:
 - lib/grape/app/templates/db/seeds.rb
 - lib/grape/app/templates/spec/spec_helper.rb
 - lib/grape_app.rb
+- spec/grape/app/helpers/caching_spec.rb
+- spec/grape/app/helpers/params_spec.rb
 - spec/grape/app_spec.rb
 - spec/scenario/Gemfile
 - spec/scenario/app/api.rb
@@ -281,11 +284,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Stanalone Grape API apps
 test_files:
+- spec/grape/app/helpers/caching_spec.rb
+- spec/grape/app/helpers/params_spec.rb
 - spec/grape/app_spec.rb
 - spec/scenario/Gemfile
 - spec/scenario/app/api.rb