grape-app 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feff7b4ee1c4e672754a8e9e85f4c80016e2414a6f81b10d40cb8cea5ccdc900
-  data.tar.gz: 15ede4a9152b0e274041a1f0a94c0edd9eaaaabc3ca6be7fd28e5a50041f54ed
+  metadata.gz: ba29de5fd70e82430c9bedfe0381fbabf43cd420d16c416e162582926f7bbec1
+  data.tar.gz: 71f550566eb3fccf9d66baf45c2e987bef0876a48daf139aac0eedf0746f350e
 SHA512:
-  metadata.gz: adf69f2a62a197ac8393abbf00da46b093313900701cbdb9b3ab76cc21e78331c20ebfbbde3131e023a014b0dae76946a6949f275e0bc8cd5fc7f3ea27c552d0
-  data.tar.gz: b5f4919555de644ba358415a2473ef6ea51d290d32acc82b2e52baf6919a245f3e7fa1bc79ec08b9f7c53a0afacc8ac89d4e62d69eb1b549956111f4c7c4769a
+  metadata.gz: 74835d8b690aacee9164288561974a4954823cb9cac45206e93927c17fbde803f2b13a8bbab437fea84470c36cf518d17c20b00e3459702c965e9c74522ddfd5
+  data.tar.gz: 97cbb35a1ade9fb541759efc71789163161c2bf255b36a94febe0ba1698a364d333dbec8a30a8e923d6f2ecbce80edffa164557737d071ae6a8016db2bde94f4

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.6", "2.7", "3.0"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape-app (0.8.7)
+    grape-app (0.8.8)
       activesupport
       grape (>= 1.2)
       grape-entity
@@ -13,30 +13,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.1)
-      activesupport (= 6.1.1)
-    activerecord (6.1.1)
-      activemodel (= 6.1.1)
-      activesupport (= 6.1.1)
-    activesupport (6.1.1)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    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)
+    ast (2.4.2)
     builder (3.2.4)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.7)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    dry-configurable (0.12.0)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
@@ -44,40 +36,36 @@ GEM
       dry-configurable (~> 0.1, >= 0.1.3)
     dry-core (0.5.0)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-logic (1.1.0)
+    dry-logic (1.1.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
-    dry-types (1.4.0)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    equalizer (0.0.11)
-    grape (1.5.1)
+    grape (1.5.3)
       activesupport
       builder
       dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    grape-entity (0.8.2)
+    grape-entity (0.9.0)
       activesupport (>= 3.0.0)
       multi_json (>= 1.3.2)
-    i18n (1.8.7)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    ice_nine (0.11.2)
-    minitest (5.14.3)
+    minitest (5.14.4)
     multi_json (1.15.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-grape (1.0.1)
       mustermann (>= 1.0.0)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
     rack (2.2.3)
     rack-accept (0.4.5)
@@ -89,8 +77,8 @@ GEM
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -100,11 +88,11 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.8.1)
+    rspec-support (3.10.2)
+    rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -113,15 +101,15 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    rubocop-bsm (0.5.4)
+    rubocop-bsm (0.5.6)
       rubocop (~> 1.0)
       rubocop-performance
       rubocop-rails
       rubocop-rake
       rubocop-rspec
-    rubocop-performance (1.9.2)
+    rubocop-performance (1.10.2)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rails (2.9.1)
@@ -130,22 +118,16 @@ GEM
       rubocop (>= 0.90.0, < 2.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (2.1.0)
+    rubocop-rspec (2.2.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.3)
+    ruby2_keywords (0.0.4)
     sqlite3 (1.4.2)
-    thor (1.0.1)
-    thread_safe (0.3.6)
+    thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.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.4.2)
 
 PLATFORMS
@@ -160,7 +142,6 @@ DEPENDENCIES
   rspec
   rubocop-bsm
   sqlite3
-  virtus
 
 BUNDLED WITH
    2.2.5

data/grape-app.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'grape-app'
-  s.version       = '0.8.7'
+  s.version       = '0.8.8'
   s.authors       = ['Black Square Media Ltd']
   s.email         = ['info@blacksquaremedia.com']
   s.summary       = %(Standalone Grape API apps)
@@ -29,5 +29,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop-bsm'
   s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'virtus'
 end

data/lib/grape/app.rb

@@ -78,10 +78,13 @@ class Grape::App < Grape::API
         elsif config.force_ssl
           use Rack::SslEnforcer
         end
+
         config.middleware.each do |block|
           instance_eval(&block)
         end
 
+        use Grape::App::Middleware::ConnectionManagement if defined?(ActiveRecord)
+
         run Grape::App
       end
     end
@@ -107,3 +110,4 @@ end
 require 'grape/app/configuration'
 require 'grape/app/helpers'
 require 'grape/app/inflector'
+require 'grape/app/middleware'

data/lib/grape/app/middleware.rb

@@ -0,0 +1,5 @@
+module Grape::App::Middleware
+  extend ActiveSupport::Autoload
+
+  autoload :ConnectionManagement
+end

data/lib/grape/app/middleware/connection_management.rb

@@ -0,0 +1,12 @@
+class Grape::App::Middleware::ConnectionManagement
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    @app.call(env)
+  rescue ::ActiveRecord::StatementInvalid
+    ::ActiveRecord::Base.clear_active_connections!
+    raise
+  end
+end

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

@@ -9,6 +9,7 @@ class API::V1 < Grape::API
   #   error_response message: e.message, status: 404
   # end
 
-  # Mount components
+  # Mount components:
+  #
   # mount API::Posts
 end

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

@@ -3,14 +3,46 @@ require 'spec_helper'
 RSpec.describe Grape::App::Helpers::Caching do
   include Rack::Test::Methods
 
-  let(:app) { TestAPI }
+  let :app do
+    helper = described_class
+    Class.new(Grape::API) do
+      format :json
+
+      helpers helper
+
+      get '/articles' do
+        scope = Article.order(:id)
+        opts  = params[:public] ? { public: params[:public] } : {}
+        fresh_when(scope, **opts)
+        scope.to_a
+      end
+
+      get '/articles/never_updated' do
+        article = Article.first
+        article.updated_at = nil
+
+        fresh_when(article, last_modified_field: :created_at)
+      end
+
+      get '/articles/:id' do
+        article = Article.first
+        article if stale?(article, stale_if_error: 5, extras: { a: 1, b: 2 })
+      end
+    end
+  end
+  let(:created_at) { Time.at(1515151500).utc }
+
+  before do
+    Article.create! title: 'Welcome', created_at: created_at, updated_at: created_at + 10
+    Article.create! title: 'Bye', created_at: created_at, updated_at: created_at + 20
+  end
 
   it 'handles fresh-when' do
     get '/articles'
     expect(last_response.status).to eq(200)
     expect(last_response.headers).to include(
       'Content-Type'  => 'application/json',
-      'ETag'          => '975ca8804565c1a569450d61090b2743',
+      'ETag'          => 'a5f6c4b024510c9835d8d70cbd3ed00c',
       'Last-Modified' => 'Fri, 05 Jan 2018 11:25:20 GMT',
     )
     expect(JSON.parse(last_response.body).size).to eq(2)
@@ -52,21 +84,21 @@ RSpec.describe Grape::App::Helpers::Caching do
     expect(last_response.headers).to include(
       'Cache-Control' => 'private, stale-if-error=5, a=1, b=2',
       'Content-Type'  => 'application/json',
-      'ETag'          => 'c4ca4238a0b923820dcc509a6f75849b',
+      'ETag'          => '0154407bafc97186a494a05e0652ff61',
       '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',
-      'created_at' => '2018-01-05 11:25:00 UTC',
+      'updated_at' => '2018-01-05T11:25:10.000Z',
+      'created_at' => '2018-01-05T11:25:00.000Z',
     )
 
     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',
+      'ETag'          => '0154407bafc97186a494a05e0652ff61',
       'Last-Modified' => 'Fri, 05 Jan 2018 11:25:10 GMT',
     )
   end

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

@@ -3,16 +3,32 @@ require 'spec_helper'
 RSpec.describe Grape::App::Helpers::Params do
   include Rack::Test::Methods
 
-  let(:app) { TestAPI }
+  let :app do
+    helper = described_class
+    Class.new(Grape::API) do
+      format :json
+
+      helpers helper
+
+      params do
+        optional :title
+      end
+      post '/articles' do
+        attrs = { id: 9, updated_at: Time.at(1515151515).utc }
+        attrs.update(declared_params)
+        Article.new(attrs)
+      end
+    end
+  end
 
   it 'limits params' do
-    post '/articles', title: 'Today', fresh: true, id: 1234, updated_at: Time.now
+    post '/articles', title: 'Today', 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',
+      'updated_at' => '2018-01-05T11:25:15.000Z',
     )
   end
 end

data/spec/grape/app/middleware/connection_management_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe Grape::App::Middleware::ConnectionManagement do
+  include Rack::Test::Methods
+
+  let :app do
+    failing = ->(_) { raise(ActiveRecord::StatementInvalid) }
+    middleware = described_class
+    Rack::Builder.new do
+      use middleware
+      run failing
+    end
+  end
+
+  it 'clears active connections' do
+    ActiveRecord::Base.connection
+    expect(ActiveRecord::Base.connection_handler).to be_active_connections
+
+    expect { get '/' }.to raise_error(ActiveRecord::StatementInvalid)
+    expect(ActiveRecord::Base.connection_handler).not_to be_active_connections
+  end
+end

data/spec/grape/app_spec.rb

@@ -46,7 +46,7 @@ RSpec.describe Grape::App do
 
   it 'prepares middleware' do
     expect(subject.middleware).to be_instance_of(Rack::Builder)
-    expect(subject.middleware.send(:instance_variable_get, :@use).size).to eq(2)
+    expect(subject.middleware.send(:instance_variable_get, :@use).size).to eq(3)
     expect(subject.middleware.send(:instance_variable_get, :@run)).to be(subject)
   end
 

data/spec/spec_helper.rb

@@ -1,70 +1,16 @@
 ENV['RACK_ENV'] ||= 'test'
 require 'grape-app'
 require 'rack/test'
-require 'virtus'
+require 'active_record'
 
-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, 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
-
-  def self.all
-    Scope.new
-  end
-
-  attribute :id
-  attribute :title
-  attribute :updated_at
-  attribute :created_at
-
-  def to_param
-    id.to_s
+ActiveRecord::Base.configurations = { 'test' => { 'adapter' => 'sqlite3', 'database' => ':memory:' } }
+ActiveRecord::Base.establish_connection :test
+ActiveRecord::Base.connection.instance_eval do
+  create_table :articles do |t|
+    t.string :title
+    t.timestamps
   end
 end
 
-class TestAPI < Grape::API
-  format :json
-
-  helpers Grape::App::Helpers::Caching
-  helpers Grape::App::Helpers::Params
-
-  get '/articles' do
-    scope = Article.all
-    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 })
-  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
+class Article < ActiveRecord::Base
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-app
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.8
 platform: ruby
 authors:
 - Black Square Media Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -206,20 +206,6 @@ 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
@@ -229,9 +215,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -250,6 +236,8 @@ files:
 - lib/grape/app/inflector.rb
 - lib/grape/app/initializers/post.rb
 - lib/grape/app/initializers/pre.rb
+- lib/grape/app/middleware.rb
+- lib/grape/app/middleware/connection_management.rb
 - lib/grape/app/tasks.rb
 - lib/grape/app/tasks/core.rake
 - lib/grape/app/tasks/databases.rake
@@ -269,6 +257,7 @@ files:
 - lib/grape_app.rb
 - spec/grape/app/helpers/caching_spec.rb
 - spec/grape/app/helpers/params_spec.rb
+- spec/grape/app/middleware/connection_management_spec.rb
 - spec/grape/app_spec.rb
 - spec/scenario/Gemfile
 - spec/scenario/app/api.rb
@@ -305,6 +294,7 @@ summary: Standalone Grape API apps
 test_files:
 - spec/grape/app/helpers/caching_spec.rb
 - spec/grape/app/helpers/params_spec.rb
+- spec/grape/app/middleware/connection_management_spec.rb
 - spec/grape/app_spec.rb
 - spec/scenario/Gemfile
 - spec/scenario/app/api.rb

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.6
-  - 2.7
-before_install:
-  - gem install bundler