spokes 0.1.1

data/spec/middleware/request_id_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Spokes::Middleware::RequestID, modules: true, middleware: true do
+  let(:app) { proc { [200, {}, []] } }
+  let(:service_name) { 'nerds' }
+  let(:stack) { Spokes::Middleware::RequestID.new(app, service_name: service_name) }
+  let(:request) { Rack::MockRequest.new(stack) }
+  let(:env_header_name) { 'action_dispatch.request_id' }
+
+  it 'accepts incoming request ID' do
+    response = request.options('/', env_header_name => 'aaaa')
+    expect(response.status).to eq(200)
+  end
+
+  it 'generates request id when not present' do
+    response = request.options('/')
+    expect(response.status).to eq(200)
+  end
+end

data/spec/middleware/service_name_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Spokes::Middleware::ServiceName, modules: true, middleware: true do
+  let(:app) { proc { [200, {}, []] } }
+  let(:service_name) { 'nerds' }
+  let(:stack) { Spokes::Middleware::ServiceName.new(app, service_name: service_name) }
+  let(:stack_exclude_paths) do
+    Spokes::Middleware::ServiceName.new(app,
+                                        service_name: service_name,
+                                        exclude_paths: ['/match/:id'])
+  end
+  let(:request) { Rack::MockRequest.new(stack) }
+  let(:request_exclude_paths) { Rack::MockRequest.new(stack_exclude_paths) }
+  let(:env_header_name) { 'HTTP_SERVICE_NAME' }
+
+  it 'errors when the header is not present' do
+    response = request.get('/')
+    json     = MultiJson.load(response.body)
+
+    expect(response.status).to eq(400)
+    expect(response.content_type).to eq('application/json; charset=utf-8')
+    expect(json).to have_key('errors')
+    expect(json['errors'][0]).to eq('Service-Name is required')
+  end
+
+  it 'errors when the header is invalid' do
+    response = request.options('/', env_header_name => 'not,valid')
+    json     = MultiJson.load(response.body)
+
+    expect(response.status).to eq(400)
+    expect(response.content_type).to eq('application/json; charset=utf-8')
+    expect(json).to have_key('errors')
+    expect(json['errors'][0]).to eq('Service-Name is invalid')
+  end
+
+  it 'responds normally when the header is valid' do
+    response = request.options('/', env_header_name => 'valid')
+    expect(response.status).to eq(200)
+  end
+
+  it 'respond with valid if header is invalid but exclude path includes path' do
+    response = request_exclude_paths.options('/match/abcd')
+    expect(response.status).to eq(200)
+  end
+
+  it 'responds with error 400 if path not included in excludes paths' do
+    response = request_exclude_paths.options('/match')
+    expect(response.status).to eq(400)
+  end
+
+  it 'responds with error 400 if path not included in excludes paths' do
+    response = request_exclude_paths.options('/match?param=1')
+    expect(response.status).to eq(400)
+  end
+
+  it 'responds with error 400 if path not included in excludes paths' do
+    response = request_exclude_paths.options('/match/')
+    expect(response.status).to eq(400)
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,3 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+require 'spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+ENV['RAILS_ENV'] = 'test'
+$TEST = true
+
+require 'bundler'
+require 'simplecov'
+require 'fileutils'
+require 'rack/test'
+require 'factory_bot'
+require 'multi_json'
+
+SimpleCov.start do
+  add_filter '.gems'
+  add_filter 'spec'
+  add_group 'Middleware', ['/spokes/middleware/*']
+  add_group 'Config', ['/spokes/config/*']
+  add_group 'Versioning', ['/spokes/versioning/*']
+end
+
+require_relative '../lib/spokes'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.include FactoryBot::Syntax::Methods
+  config.order = 'random'
+end

data/spec/versioning/minor_versioning_spec.rb

@@ -0,0 +1,45 @@
+require 'rails_helper'
+
+describe Spokes::Versioning::MinorVersioning do
+  let(:klass) do
+    klass = Class.new
+    expect(klass).to receive(:after_filter)
+    klass.send(:include, Spokes::Versioning::MinorVersioning)
+    klass
+  end
+
+  let(:controller) do
+    controller = klass.new
+    allow(controller).to receive(:all_minor_versions).and_return(minor_versions)
+    controller
+  end
+
+  let(:header_name) { 'API-Version' }
+  let(:default_version) { '2015-03-25' }
+  let(:minor_versions) do
+    {
+      '2015-07-07'    => {},
+      default_version => { default: true }
+    }
+  end
+  let(:empty_info) { double('request/response info', headers: {}) }
+
+  it 'uses default version if no version is specified in the header' do
+    expect(controller).to receive(:request).and_return(empty_info)
+    expect(controller.minor_version).to eq default_version
+  end
+
+  it 'uses the version specified in the header' do
+    expected     = '2015-07-07'
+    request_info = double('request', headers: { header_name => expected })
+    expect(controller).to receive(:request).and_return(request_info)
+    expect(controller.minor_version).to eq expected
+  end
+
+  it 'sets response header to current version' do
+    allow(controller).to receive(:response).and_return(empty_info)
+    expect(controller).to receive(:minor_version).and_return(default_version)
+    controller.set_minor_version_response_header
+    expect(controller.response.headers[header_name]).to eq(default_version)
+  end
+end

data/spokes.gemspec

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'spokes/version'
+
+Gem::Specification.new do |gem|
+  gem.name    = 'spokes'
+  gem.version = Spokes::VERSION
+
+  gem.authors     = ['Brett Buddin', 'Kevin Haight']
+  gem.email       = ['kevinjhaight@gmail.com']
+  gem.homepage    = 'https://github.com/khaight/spokes'
+  gem.summary     = 'A set of utilities for helping creating apis'
+  gem.description = 'Setting up configuration of environment variables, versioning, & other middleware should be easier.  This is is a set of utilities to help.'
+  gem.license = 'MIT'
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  gem.add_dependency 'activesupport', '~> 5.1', '>= 5.1.0'
+  gem.add_dependency 'multi_json', '~> 1.12', '>= 1.12.1'
+
+  gem.add_development_dependency 'factory_bot', '~> 4.8'
+  gem.add_development_dependency 'rack-test', '~> 0.6', '>= 0.6.2'
+  gem.add_development_dependency 'rake', '~> 0.8', '>= 0.8.7'
+  gem.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+  gem.add_development_dependency 'rspec-rails', '~> 3.6', '>= 3.6.0'
+  gem.add_development_dependency 'rubocop', '~> 0.48.1'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2.4'
+  gem.add_development_dependency 'simplecov', '~> 0.14.1'
+end

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: spokes
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Brett Buddin
+- Kevin Haight
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+description: Setting up configuration of environment variables, versioning, & other
+  middleware should be easier.  This is is a set of utilities to help.
+email:
+- kevinjhaight@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- lib/spokes.rb
+- lib/spokes/config/env.rb
+- lib/spokes/middleware/concerns/bad_request.rb
+- lib/spokes/middleware/concerns/header_validation.rb
+- lib/spokes/middleware/cors.rb
+- lib/spokes/middleware/health.rb
+- lib/spokes/middleware/request_id.rb
+- lib/spokes/middleware/service_name.rb
+- lib/spokes/version.rb
+- lib/spokes/versioning/config/minor_versions.yml
+- lib/spokes/versioning/minor_versioning.rb
+- lib/spokes/versioning/railtie.rb
+- lib/spokes/versioning/tasks/minor_versioning.rake
+- logo/spokes_logo.png
+- script/cibuild
+- script/postbuild
+- script/test
+- spec/config/env_spec.rb
+- spec/middleware/cors_spec.rb
+- spec/middleware/health_spec.rb
+- spec/middleware/request_id_spec.rb
+- spec/middleware/service_name_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/versioning/minor_versioning_spec.rb
+- spokes.gemspec
+homepage: https://github.com/khaight/spokes
+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: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A set of utilities for helping creating apis
+test_files: []