grape-app 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db0ee047b4c798e50070b6453ca7b478d7373228
-  data.tar.gz: 49fba6382a15f6b213fa7542a46a249f2a2c66a7
+  metadata.gz: d769186af82c987daacf3e75c394b06204bc16c2
+  data.tar.gz: f770e69d47c41f0592d8cf2e7d148152a860966f
 SHA512:
-  metadata.gz: 5ba2fffb0b8629eaad6749aeb6d075ea77eb638f1ea434547796f59ab648671a4a021ae06032c956f7e9d3a2ea384c525cfe2e2fcca80eb9efd60ab3cbef152e
-  data.tar.gz: da6e86e39a86d94ee7f87def7d6d5cd69b7ec1f74f0e337cd01d90c20dfef1ee5f5b1c8539c8ce651a7da86c74d9262950822e220bddd987af81f03ee077d6d7
+  metadata.gz: d41db62c0ff28452f9182e779c2f54cf78475d489d50ad761bd128a779e304d6a8b38aabab3dae6f44b71de804aef051ccbbd57eda0f1b0c67ac8a9024fc38e4
+  data.tar.gz: ad80c70d20a27d4abeb444ab29cec562c72117d5567ec22aa7f072c81ee65de21fbfed7598834183abd5b476dfcd71450ba021a92c0e329e4e675f35ede9936d

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.3.3
-  - 2.2.6
-  - 2.4.0
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape-app (0.4.3)
+    grape-app (0.5.0)
       activesupport
       grape
       grape-entity
@@ -36,35 +36,37 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
     equalizer (0.0.11)
-    grape (1.0.1)
+    grape (1.0.2)
       activesupport
       builder
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
       virtus (>= 1.0.0)
-    grape-entity (0.6.1)
-      activesupport (>= 5.0.0)
+    grape-entity (0.7.1)
+      activesupport (>= 4.0)
       multi_json (>= 1.3.2)
-    i18n (0.9.1)
+    i18n (0.9.3)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    minitest (5.10.3)
-    multi_json (1.12.2)
+    minitest (5.11.3)
+    multi_json (1.13.1)
     mustermann (1.0.1)
     mustermann-grape (1.0.0)
       mustermann (~> 1.0.0)
-    rack (2.0.3)
+    rack (2.0.4)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-cors (1.0.2)
     rack-ssl-enforcer (0.2.9)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
     rake (12.3.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
       rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
+    rspec-core (3.7.1)
       rspec-support (~> 3.7.0)
     rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -72,7 +74,7 @@ GEM
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+    rspec-support (3.7.1)
     sqlite3 (1.3.13)
     thor (0.20.0)
     thread_safe (0.3.6)
@@ -91,9 +93,10 @@ DEPENDENCIES
   activerecord
   bundler
   grape-app!
+  rack-test
   rake
   rspec
   sqlite3
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Black Square Media
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -29,27 +29,3 @@ $ bundle install
   Use `bundle show [gemname]` to see where a bundled gem is installed.
 ```
 
-## Licence
-
-```
-Copyright (c) 2015 Black Square Media
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-```

data/grape-app.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'grape-app'
-  s.version       = '0.4.3'
+  s.version       = '0.5.0'
   s.authors       = ['Black Square Media Ltd']
   s.email         = ['info@blacksquaremedia.com']
   s.summary       = %{Stanalone Grape API apps}
@@ -28,6 +28,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'activerecord'
   s.add_development_dependency 'sqlite3'
-
+  s.add_development_dependency 'rack-test'
 end
 

data/lib/grape/app.rb

@@ -9,8 +9,6 @@ require 'rack/cors'
 require 'rack/ssl-enforcer'
 
 class Grape::App < Grape::API
-  include ActiveSupport::Configurable
-
   class << self
 
     # Run initializers
@@ -36,6 +34,20 @@ class Grape::App < Grape::API
       require_one 'app', 'api'
     end
 
+    # @return [Grape::App::Configuration] the configuration
+    def config
+      @_config ||= if respond_to?(:superclass) && superclass.respond_to?(:config)
+        superclass.config.inheritable_copy
+      else
+        Class.new(Grape::App::Configuration).new
+      end
+    end
+
+    # Configure the app
+    def configure
+      yield config
+    end
+
     # @return [Pathname] root path
     def root
       @root ||= Bundler.root.dup
@@ -55,13 +67,9 @@ class Grape::App < Grape::API
     def middleware
       config = self.config
       @middleware ||= Rack::Builder.new do
+        use Rack::Cors, &config.cors if config.cors
         use Rack::SslEnforcer if config.force_ssl
-        use Rack::Cors do
-          allow do
-            origins   *Array.wrap(config.cors_allow_origins)
-            resource  '*', headers: :any, methods: [:get, :post, :options, :delete, :put]
-          end
-        end if config.cors_allow_origins
+        instance_eval(&config.middleware) if config.middleware
 
         run Grape::App
       end
@@ -82,4 +90,5 @@ class Grape::App < Grape::API
   end
 end
 
+require 'grape/app/configuration'
 require 'grape/app/helpers'

data/lib/grape/app/configuration.rb

@@ -0,0 +1,25 @@
+class Grape::App::Configuration < ActiveSupport::InheritableOptions
+
+  def middleware(&block)
+    self.middleware = block if block
+    super
+  end
+
+  def cors(&block)
+    self.cors = block if block
+    super
+  end
+
+  def cors_allow_origins=(value)
+    warn "[DEPRECATION] setting `config.cors_allow_origins` is deprecated. Please use `config.cors` with a block instead. [#{caller[0]}]"
+
+    value = Array.wrap(value)
+    self.cors do
+      allow do
+        origins   *value
+        resource  '*', headers: :any, methods: [:get, :post, :options, :delete, :put]
+      end
+    end
+  end
+
+end

data/lib/grape/app/templates/config/environments/production.rb

@@ -3,8 +3,22 @@ Grape::App.configure do |config|
   # Force SSL
   # config.force_ssl = true
 
-  # CORS is disabled by default, set to ['*'] to enable for all
-  # config.cors_allow_origins = nil
+  # CORS is disabled by default, please see https://github.com/cyu/rack-cors
+  # for configuration options.
+  #
+  # config.cors do
+  #   allow do
+  #     origins   '*'
+  #     resource  '*', headers: :any, methods: [:get, :post, :options]
+  #   end
+  # end
+
+  # Enable custom middleware:
+  #
+  # config.middleware do
+  #   use Rack::ETag
+  #   insert_before Rack::Cors, Rack::ContentLength
+  # end
 
   # Don't raise errors on missing translations
   # config.raise_on_missing_translations = false

data/spec/grape/app_spec.rb

@@ -1,10 +1,15 @@
 require 'spec_helper'
 
 RSpec.describe Grape::App do
+  include Rack::Test::Methods
 
   subject { described_class }
   before  { subject.init! File.expand_path('../../scenario', __FILE__) }
 
+  def app
+    subject.middleware
+  end
+
   it 'should have an env' do
     expect(subject.env).to be_instance_of(ActiveSupport::StringInquirer)
     expect(subject.env).to eq("test")
@@ -30,17 +35,38 @@ RSpec.describe Grape::App do
   end
 
   it 'should read env specific initializers' do
-    expect(subject.config).to eq(
-      test_specific: true,
-      raise_on_missing_translations: true,
-      cors_allow_origins: ["example.com"],
+    expect(subject.config).to include(
+      :test_specific,
+      :raise_on_missing_translations,
+      :cors,
+      :middleware,
     )
   end
 
   it 'should prepare middleware' do
     expect(subject.middleware).to be_instance_of(Rack::Builder)
-    expect(subject.middleware.send(:instance_variable_get, :@use).size).to eq(1)
+    expect(subject.middleware.send(:instance_variable_get, :@use).size).to eq(2)
     expect(subject.middleware.send(:instance_variable_get, :@run)).to eq(subject)
   end
 
+  it 'should apply middleware' do
+    header 'Origin', 'test.host'
+    get '/v1/ok'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq(%({"status":"OK"}))
+    expect(last_response.headers).to include(
+      "Access-Control-Allow-Origin" => "*",
+      "X-MyApp" => "true",
+    )
+
+    header 'Origin', 'test.host'
+    get '/v1/failing'
+    expect(last_response).to be_bad_request
+    expect(last_response.body).to eq(%({"error":"bad request"}))
+    expect(last_response.headers).to include(
+      "Access-Control-Allow-Origin" => "*",
+      "X-MyApp" => "true",
+    )
+  end
+
 end

data/spec/scenario/app/api.rb

@@ -0,0 +1,10 @@
+require 'my_lib'
+
+module API
+  extend ActiveSupport::Autoload
+
+  autoload :V1
+end
+
+# Mount root API to app
+Grape::App.mount API::V1

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

@@ -0,0 +1,17 @@
+class API::V1 < Grape::API
+  version 'v1'
+  format  :json
+
+  rescue_from MyLib::BadRequest do |e|
+    error!({error: e}, 400)
+  end
+
+  get '/ok' do
+    {status: 'OK'}
+  end
+
+  get '/failing' do
+    raise MyLib::BadRequest, "bad request"
+  end
+
+end

data/spec/scenario/config/environments/test.rb

@@ -1,5 +1,14 @@
 Grape::App.configure do |c|
   c.test_specific = true
   c.raise_on_missing_translations = true
-  c.cors_allow_origins = ['example.com']
+  c.cors_allow_origins = "x"
+  c.cors do
+    allow do
+      origins '*'
+      resource '*', headers: :any, methods: [:get, :post, :options]
+    end
+  end
+  c.middleware do
+    use MyLib::Middleware
+  end
 end

data/spec/scenario/lib/my_lib.rb

@@ -1,2 +1,18 @@
 class MyLib
+  class BadRequest < StandardError
+  end
+
+  class Middleware
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      headers['X-MyApp'] = 'true'
+      [status, headers, body]
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 ENV['RACK_ENV'] ||= "test"
 require 'grape-app'
+require "rack/test"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-app
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Black Square Media Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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
@@ -177,6 +191,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bin/grape-app
@@ -184,6 +199,7 @@ files:
 - lib/grape-app.rb
 - lib/grape/app.rb
 - lib/grape/app/cli.rb
+- lib/grape/app/configuration.rb
 - lib/grape/app/helpers.rb
 - lib/grape/app/helpers/params.rb
 - lib/grape/app/helpers/respond_with.rb
@@ -210,6 +226,8 @@ files:
 - lib/grape_app.rb
 - spec/grape/app_spec.rb
 - spec/scenario/Gemfile
+- spec/scenario/app/api.rb
+- spec/scenario/app/api/v1.rb
 - spec/scenario/config/database.yml
 - spec/scenario/config/environments/test.rb
 - spec/scenario/config/locales/en.yml
@@ -242,6 +260,8 @@ summary: Stanalone Grape API apps
 test_files:
 - spec/grape/app_spec.rb
 - spec/scenario/Gemfile
+- spec/scenario/app/api.rb
+- spec/scenario/app/api/v1.rb
 - spec/scenario/config/database.yml
 - spec/scenario/config/environments/test.rb
 - spec/scenario/config/locales/en.yml