grape-security 0.8.0

data/spec/shared/versioning_examples.rb

@@ -0,0 +1,121 @@
+shared_examples_for 'versioning' do
+  it 'sets the API version' do
+    subject.format :txt
+    subject.version 'v1', macro_options
+    subject.get :hello do
+      "Version: #{request.env['api.version'] }"
+    end
+    versioned_get '/hello', 'v1', macro_options
+    expect(last_response.body).to eql "Version: v1"
+  end
+
+  it 'adds the prefix before the API version' do
+    subject.format :txt
+    subject.prefix 'api'
+    subject.version 'v1', macro_options
+    subject.get :hello do
+      "Version: #{request.env['api.version'] }"
+    end
+    versioned_get '/hello', 'v1', macro_options.merge(prefix: 'api')
+    expect(last_response.body).to eql "Version: v1"
+  end
+
+  it 'is able to specify version as a nesting' do
+    subject.version 'v2', macro_options
+    subject.get '/awesome' do
+      "Radical"
+    end
+
+    subject.version 'v1', macro_options do
+      get '/legacy' do
+        "Totally"
+      end
+    end
+
+    versioned_get '/awesome', 'v1', macro_options
+    expect(last_response.status).to eql 404
+
+    versioned_get '/awesome', 'v2', macro_options
+    expect(last_response.status).to eql 200
+    versioned_get '/legacy', 'v1', macro_options
+    expect(last_response.status).to eql 200
+    versioned_get '/legacy', 'v2', macro_options
+    expect(last_response.status).to eql 404
+  end
+
+  it 'is able to specify multiple versions' do
+    subject.version 'v1', 'v2', macro_options
+    subject.get 'awesome' do
+      "I exist"
+    end
+
+    versioned_get '/awesome', 'v1', macro_options
+    expect(last_response.status).to eql 200
+    versioned_get '/awesome', 'v2', macro_options
+    expect(last_response.status).to eql 200
+    versioned_get '/awesome', 'v3', macro_options
+    expect(last_response.status).to eql 404
+  end
+
+  context 'with different versions for the same endpoint' do
+    context 'without a prefix' do
+      it 'allows the same endpoint to be implemented' do
+        subject.format :txt
+        subject.version 'v2', macro_options
+        subject.get 'version' do
+          request.env['api.version']
+        end
+
+        subject.version 'v1', macro_options do
+          get 'version' do
+            "version " + request.env['api.version']
+          end
+        end
+
+        versioned_get '/version', 'v2', macro_options
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('v2')
+        versioned_get '/version', 'v1', macro_options
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('version v1')
+      end
+    end
+
+    context 'with a prefix' do
+      it 'allows the same endpoint to be implemented' do
+        subject.format :txt
+        subject.prefix 'api'
+        subject.version 'v2', macro_options
+        subject.get 'version' do
+          request.env['api.version']
+        end
+
+        subject.version 'v1', macro_options do
+          get 'version' do
+            "version " + request.env['api.version']
+          end
+        end
+
+        versioned_get '/version', 'v1', macro_options.merge(prefix: subject.prefix)
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('version v1')
+
+        versioned_get '/version', 'v2', macro_options.merge(prefix: subject.prefix)
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('v2')
+      end
+    end
+  end
+
+  it 'does not overwrite version parameter with API version' do
+    subject.format :txt
+    subject.version 'v1', macro_options
+    subject.params { requires :version }
+    subject.get :api_version_with_version_param do
+      params[:version]
+    end
+    versioned_get '/api_version_with_version_param?version=1', 'v1', macro_options
+    expect(last_response.body).to eql '1'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
+
+require 'grape'
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :test
+
+require 'json'
+require 'rack/test'
+require 'base64'
+require 'cookiejar'
+require 'json'
+require 'mime/types'
+
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
+  require file
+end
+
+I18n.enforce_available_locales = false
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end

data/spec/support/basic_auth_encode_helpers.rb

@@ -0,0 +1,3 @@
+def encode_basic_auth(username, password)
+  "Basic " + Base64.encode64("#{username}:#{password}")
+end

data/spec/support/content_type_helpers.rb

@@ -0,0 +1,11 @@
+module ContentTypeHelpers
+  %w(put patch post delete).each do |method|
+    define_method :"#{method}_with_json" do |uri, params = {}, env = {}, &block|
+      params = params.to_json
+      env["CONTENT_TYPE"] ||= "application/json"
+      send(method, uri, params, env, &block)
+    end
+  end
+end
+
+include(ContentTypeHelpers)

data/spec/support/versioned_helpers.rb

@@ -0,0 +1,50 @@
+# Versioning
+
+# Returns the path with options[:version] prefixed if options[:using] is :path.
+# Returns normal path otherwise.
+def versioned_path(options = {})
+  case options[:using]
+  when :path
+    File.join('/', options[:prefix] || '', options[:version], options[:path])
+  when :param
+    File.join('/', options[:prefix] || '', options[:path])
+  when :header
+    File.join('/', options[:prefix] || '', options[:path])
+  when :accept_version_header
+    File.join('/', options[:prefix] || '', options[:path])
+  else
+    raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
+  end
+end
+
+def versioned_headers(options)
+  case options[:using]
+  when :path
+    {}  # no-op
+  when :param
+    {}  # no-op
+  when :header
+    {
+      'HTTP_ACCEPT' => [
+        "application/vnd.#{options[:vendor] }-#{options[:version] }",
+        options[:format]
+     ].compact.join("+")
+    }
+  when :accept_version_header
+    {
+      'HTTP_ACCEPT_VERSION' => "#{options[:version] }"
+    }
+  else
+    raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
+  end
+end
+
+def versioned_get(path, version_name, version_options = {})
+  path    = versioned_path(version_options.merge(version: version_name, path: path))
+  headers = versioned_headers(version_options.merge(version: version_name))
+  params = {}
+  if version_options[:using] == :param
+    params = { version_options[:parameter] => version_name }
+  end
+  get path, params, headers
+end

metadata

@@ -0,0 +1,421 @@
+--- !ruby/object:Gem::Specification
+name: grape-security
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rack-mount
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-accept
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape-entity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: maruku
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: "[Backported security patched version] A Ruby framework for rapid API
+  development with great conventions."
+email:
+- michael@intridea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- RELEASING.md
+- Rakefile
+- UPGRADING.md
+- grape-security.gemspec
+- grape.png
+- lib/grape.rb
+- lib/grape/api.rb
+- lib/grape/cookies.rb
+- lib/grape/endpoint.rb
+- lib/grape/error_formatter/base.rb
+- lib/grape/error_formatter/json.rb
+- lib/grape/error_formatter/txt.rb
+- lib/grape/error_formatter/xml.rb
+- lib/grape/exceptions/base.rb
+- lib/grape/exceptions/incompatible_option_values.rb
+- lib/grape/exceptions/invalid_formatter.rb
+- lib/grape/exceptions/invalid_versioner_option.rb
+- lib/grape/exceptions/invalid_with_option_for_represent.rb
+- lib/grape/exceptions/missing_mime_type.rb
+- lib/grape/exceptions/missing_option.rb
+- lib/grape/exceptions/missing_vendor_option.rb
+- lib/grape/exceptions/unknown_options.rb
+- lib/grape/exceptions/unknown_validator.rb
+- lib/grape/exceptions/validation.rb
+- lib/grape/exceptions/validation_errors.rb
+- lib/grape/formatter/base.rb
+- lib/grape/formatter/json.rb
+- lib/grape/formatter/serializable_hash.rb
+- lib/grape/formatter/txt.rb
+- lib/grape/formatter/xml.rb
+- lib/grape/http/request.rb
+- lib/grape/locale/en.yml
+- lib/grape/middleware/auth/base.rb
+- lib/grape/middleware/auth/basic.rb
+- lib/grape/middleware/auth/digest.rb
+- lib/grape/middleware/auth/oauth2.rb
+- lib/grape/middleware/base.rb
+- lib/grape/middleware/error.rb
+- lib/grape/middleware/filter.rb
+- lib/grape/middleware/formatter.rb
+- lib/grape/middleware/globals.rb
+- lib/grape/middleware/versioner.rb
+- lib/grape/middleware/versioner/accept_version_header.rb
+- lib/grape/middleware/versioner/header.rb
+- lib/grape/middleware/versioner/param.rb
+- lib/grape/middleware/versioner/path.rb
+- lib/grape/namespace.rb
+- lib/grape/parser/base.rb
+- lib/grape/parser/json.rb
+- lib/grape/parser/xml.rb
+- lib/grape/path.rb
+- lib/grape/route.rb
+- lib/grape/util/content_types.rb
+- lib/grape/util/deep_merge.rb
+- lib/grape/util/hash_stack.rb
+- lib/grape/validations.rb
+- lib/grape/validations/coerce.rb
+- lib/grape/validations/default.rb
+- lib/grape/validations/exactly_one_of.rb
+- lib/grape/validations/mutual_exclusion.rb
+- lib/grape/validations/presence.rb
+- lib/grape/validations/regexp.rb
+- lib/grape/validations/values.rb
+- lib/grape/version.rb
+- spec/grape/api_spec.rb
+- spec/grape/endpoint_spec.rb
+- spec/grape/entity_spec.rb
+- spec/grape/exceptions/invalid_formatter_spec.rb
+- spec/grape/exceptions/invalid_versioner_option_spec.rb
+- spec/grape/exceptions/missing_mime_type_spec.rb
+- spec/grape/exceptions/missing_option_spec.rb
+- spec/grape/exceptions/unknown_options_spec.rb
+- spec/grape/exceptions/unknown_validator_spec.rb
+- spec/grape/exceptions/validation_errors_spec.rb
+- spec/grape/middleware/auth/basic_spec.rb
+- spec/grape/middleware/auth/digest_spec.rb
+- spec/grape/middleware/auth/oauth2_spec.rb
+- spec/grape/middleware/base_spec.rb
+- spec/grape/middleware/error_spec.rb
+- spec/grape/middleware/exception_spec.rb
+- spec/grape/middleware/formatter_spec.rb
+- spec/grape/middleware/versioner/accept_version_header_spec.rb
+- spec/grape/middleware/versioner/header_spec.rb
+- spec/grape/middleware/versioner/param_spec.rb
+- spec/grape/middleware/versioner/path_spec.rb
+- spec/grape/middleware/versioner_spec.rb
+- spec/grape/path_spec.rb
+- spec/grape/util/hash_stack_spec.rb
+- spec/grape/validations/coerce_spec.rb
+- spec/grape/validations/default_spec.rb
+- spec/grape/validations/exactly_one_of_spec.rb
+- spec/grape/validations/mutual_exclusion_spec.rb
+- spec/grape/validations/presence_spec.rb
+- spec/grape/validations/regexp_spec.rb
+- spec/grape/validations/values_spec.rb
+- spec/grape/validations/zh-CN.yml
+- spec/grape/validations_spec.rb
+- spec/shared/versioning_examples.rb
+- spec/spec_helper.rb
+- spec/support/basic_auth_encode_helpers.rb
+- spec/support/content_type_helpers.rb
+- spec/support/versioned_helpers.rb
+homepage: https://github.com/intridea/grape
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: grape
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Backported security patched version] A simple Ruby framework for building
+  REST-like APIs.
+test_files:
+- spec/grape/api_spec.rb
+- spec/grape/endpoint_spec.rb
+- spec/grape/entity_spec.rb
+- spec/grape/exceptions/invalid_formatter_spec.rb
+- spec/grape/exceptions/invalid_versioner_option_spec.rb
+- spec/grape/exceptions/missing_mime_type_spec.rb
+- spec/grape/exceptions/missing_option_spec.rb
+- spec/grape/exceptions/unknown_options_spec.rb
+- spec/grape/exceptions/unknown_validator_spec.rb
+- spec/grape/exceptions/validation_errors_spec.rb
+- spec/grape/middleware/auth/basic_spec.rb
+- spec/grape/middleware/auth/digest_spec.rb
+- spec/grape/middleware/auth/oauth2_spec.rb
+- spec/grape/middleware/base_spec.rb
+- spec/grape/middleware/error_spec.rb
+- spec/grape/middleware/exception_spec.rb
+- spec/grape/middleware/formatter_spec.rb
+- spec/grape/middleware/versioner/accept_version_header_spec.rb
+- spec/grape/middleware/versioner/header_spec.rb
+- spec/grape/middleware/versioner/param_spec.rb
+- spec/grape/middleware/versioner/path_spec.rb
+- spec/grape/middleware/versioner_spec.rb
+- spec/grape/path_spec.rb
+- spec/grape/util/hash_stack_spec.rb
+- spec/grape/validations/coerce_spec.rb
+- spec/grape/validations/default_spec.rb
+- spec/grape/validations/exactly_one_of_spec.rb
+- spec/grape/validations/mutual_exclusion_spec.rb
+- spec/grape/validations/presence_spec.rb
+- spec/grape/validations/regexp_spec.rb
+- spec/grape/validations/values_spec.rb
+- spec/grape/validations/zh-CN.yml
+- spec/grape/validations_spec.rb
+- spec/shared/versioning_examples.rb
+- spec/spec_helper.rb
+- spec/support/basic_auth_encode_helpers.rb
+- spec/support/content_type_helpers.rb
+- spec/support/versioned_helpers.rb