stitches 4.0.0 → 4.2.0.RC1

data/spec/fake_app/test/application_system_test_case.rb

@@ -0,0 +1,5 @@
+require "test_helper"
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+end

data/spec/fake_app/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV['RAILS_ENV'] ||= 'test'
+require_relative "../config/environment"
+require "rails/test_help"
+
+class ActiveSupport::TestCase
+  # Run tests in parallel with specified workers
+  parallelize(workers: :number_of_processors)
+
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/spec/fake_app/tmp/development_secret.txt

@@ -0,0 +1 @@
+5555d81df49718e5b9412e544323f9cebcadf7ab825e9ac15b35c57091b4d9a0731033d343b6532c1e08de53f265ae2c0268f67bf65eb1ddc8b230716179d50a

data/spec/integration/add_to_rails_app_spec.rb

@@ -63,7 +63,7 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
     run "bin/rails generate stitches:api"
 
     # Yuck!  So much duplication!  BUT: Rails app templates have a notoriously silent failure mode, so mostly
-    # what this is doing is ensuring that the generator inserted stuff when asked and that the very basics of what happens 
+    # what this is doing is ensuring that the generator inserted stuff when asked and that the very basics of what happens
     # during generation are there.  It's gross, and I'm sorry.
     #
     # It's also in one big block because making a new rails app and running the generator multiple times seems bad.
@@ -85,6 +85,14 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
       expect(File.read(rails_root / "config" / "initializers" / "apitome.rb")).to include("config.title = 'Service Documentation'")
       expect(File.read(rails_root / "app" / "controllers" / "api" / "api_controller.rb")).to include("rescue_from StandardError")
       expect(File.read(rails_root / "app" / "controllers" / "api" / "api_controller.rb")).to include("rescue_from ActiveRecord::RecordNotFound")
+
+      run "bin/rails generate stitches:add_enabled_to_api_clients"
+      migrations = Dir["#{rails_root}/db/migrate/*.rb"].sort
+      expect(migrations.size).to eq(3)
+
+      run "bin/rails generate stitches:add_disabled_at_to_api_clients"
+      migrations = Dir["#{rails_root}/db/migrate/*.rb"].sort
+      expect(migrations.size).to eq(4)
     end
   end
 

data/spec/rails_helper.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require "rails_helper"
+ENV["RAILS_ENV"] ||= "test"
+
+require File.expand_path("fake_app/config/environment.rb", __dir__)
+
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require "rspec/rails"
+# Add additional requires below this line. Rails is not loaded until this point!
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+load 'fake_app/db/schema_modern.rb'
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Rails.root is /spec/fake_app_x so going up one dir to the support dir
+Dir[Rails.root.join("../", "support", "**", "*.rb")].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  # Remove this line to enable support for ActiveRecord
+  config.use_active_record = false
+
+  # If you enable ActiveRecord support you should unncomment these lines,
+  # note if you'd prefer not to run each example within a transaction, you
+  # should set use_transactional_fixtures to false.
+  #
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  # config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, type: :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/spec/valid_mime_type_middleware_spec.rb

@@ -0,0 +1,59 @@
+require 'rails_helper'
+require 'securerandom'
+
+RSpec.describe "/api/hellos", type: :request do
+  let!(:api_client) {
+    uuid = SecureRandom.uuid
+    ApiClient.create(name: "MyApiClient", key: uuid, enabled: true, created_at: Time.now())
+  }
+  let(:uuid) { api_client.key }
+  let(:auth_header) { "MyAwesomeInternalScheme key=#{uuid}" }
+  let(:accept_header) { "application/json; version=1" }
+  let(:headers) {
+    h = {
+      "Authorization" => auth_header
+    }
+    h["Accept"] = accept_header if accept_header
+    h
+  }
+  let(:allowlist) { nil }
+
+  before do
+    Stitches.configuration.reset_to_defaults!
+    Stitches.configuration.custom_http_auth_scheme = 'MyAwesomeInternalScheme'
+    Stitches::ApiClientAccessWrapper.clear_api_cache
+  end
+
+  def execute_call(accept_header:)
+    headers = {
+      "Authorization" => auth_header
+    }
+    headers["Accept"] = accept_header if accept_header
+
+    get "/api/hellos", headers: headers
+  end
+
+  it "returns good result when no problems exist in accept_header" do
+    execute_call(accept_header: "application/json; version=1")
+
+    expect(response.status).to eq 200
+  end
+
+  it "fails accept header has missing version" do
+    execute_call(accept_header: "application/json")
+
+    expect(response.status).to eq 406
+  end
+
+  it "fails accept header has bad version" do
+    execute_call(accept_header: "application/json; version=nan")
+
+    expect(response.status).to eq 406
+  end
+
+  it "fails when mime type is bad" do
+    execute_call(accept_header: "application/xml; version=1")
+
+    expect(response.status).to eq 406
+  end
+end

data/spec/valid_mime_type_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper.rb'
+require 'rails_helper'
 
 describe Stitches::ValidMimeType do
   let(:app) { double("rack app") }
-  
+
   before do
     allow(app).to receive(:call).with(env)
   end
@@ -132,6 +132,24 @@ describe Stitches::ValidMimeType do
       end
     end
 
+    # The only remaining thing being tested outside the integration test is the little hole opened up to allow
+    # protobuf services to function
+    context "protbuf mime type" do
+      let(:env) {
+        {
+          "PATH_INFO" => "/api/ping",
+          "HTTP_ACCEPT" => "application/protobuf",
+        }
+      }
+
+      before do
+        @response = middleware.call(env)
+      end
+      it "calls through to the rest of the chain" do
+        expect(app).to have_received(:call).with(env)
+      end
+    end
+
     context "unacceptable responses" do
       before do
         @response = middleware.call(env)
@@ -144,7 +162,7 @@ describe Stitches::ValidMimeType do
         }
         it_behaves_like "an unacceptable response"
       end
-      context "bad mime type" do
+      context "bad version" do
         let(:env) {
           {
             "PATH_INFO" => "/api/ping",
@@ -153,7 +171,7 @@ describe Stitches::ValidMimeType do
         }
         it_behaves_like "an unacceptable response"
       end
-      context "bad version" do
+      context "bad mime type" do
         let(:env) {
           {
             "PATH_INFO" => "/api/ping",

data/stitches.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("lru_redux")
 
   s.add_development_dependency("rspec", ">= 3")
+  s.add_development_dependency("rspec-rails")
+  s.add_development_dependency("sqlite3")
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec_junit_formatter")
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: stitches
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.2.0.RC1
 platform: ruby
 authors:
 - Stitch Fix Engineering
 - Andrew Peterson
 - Dave Copeland
 - Jonathan Dean
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,6 +69,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: sqlite3
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -123,12 +151,14 @@ files:
 - Gemfile.rails-5.1
 - Gemfile.rails-5.2
 - Gemfile.rails-6.0
+- Gemfile.rails-6.1
 - LICENSE.txt
 - README.md
 - Rakefile
 - build-matrix.json
 - lib/stitches.rb
 - lib/stitches/add_deprecation_generator.rb
+- lib/stitches/add_disabled_at_to_api_clients_generator.rb
 - lib/stitches/add_enabled_to_api_clients_generator.rb
 - lib/stitches/allowlist_middleware.rb
 - lib/stitches/api_client_access_wrapper.rb
@@ -147,6 +177,7 @@ files:
 - lib/stitches/generator_files/app/controllers/api/v2/pings_controller.rb
 - lib/stitches/generator_files/app/models/api_client.rb
 - lib/stitches/generator_files/config/initializers/stitches.rb
+- lib/stitches/generator_files/db/migrate/add_disabled_at_to_api_clients.rb
 - lib/stitches/generator_files/db/migrate/add_enabled_to_api_clients.rb
 - lib/stitches/generator_files/db/migrate/create_api_clients.rb
 - lib/stitches/generator_files/db/migrate/enable_uuid_ossp_extension.rb
@@ -166,25 +197,88 @@ files:
 - lib/stitches/version.rb
 - lib/stitches_norailtie.rb
 - owners.json
-- spec/api_client_access_wrapper_spec.rb
-- spec/api_key_spec.rb
-- spec/api_version_constraint_spec.rb
+- spec/api_key_middleware_spec.rb
+- spec/api_version_constraint_middleware_spec.rb
 - spec/configuration_spec.rb
 - spec/deprecation_spec.rb
 - spec/error_spec.rb
 - spec/errors_spec.rb
+- spec/fake_app/.rspec
+- spec/fake_app/.ruby-version
+- spec/fake_app/Gemfile
+- spec/fake_app/README.md
+- spec/fake_app/Rakefile
+- spec/fake_app/app/assets/config/manifest.js
+- spec/fake_app/app/assets/stylesheets/application.css
+- spec/fake_app/app/controllers/api.rb
+- spec/fake_app/app/controllers/api/api_controller.rb
+- spec/fake_app/app/controllers/api/v1.rb
+- spec/fake_app/app/controllers/api/v1/hellos_controller.rb
+- spec/fake_app/app/controllers/api/v1/pings_controller.rb
+- spec/fake_app/app/controllers/api/v2.rb
+- spec/fake_app/app/controllers/api/v2/hellos_controller.rb
+- spec/fake_app/app/controllers/api/v2/pings_controller.rb
+- spec/fake_app/app/controllers/application_controller.rb
+- spec/fake_app/app/helpers/application_helper.rb
+- spec/fake_app/app/models/api_client.rb
+- spec/fake_app/app/models/application_record.rb
+- spec/fake_app/bin/rails
+- spec/fake_app/bin/rake
+- spec/fake_app/bin/setup
+- spec/fake_app/config.ru
+- spec/fake_app/config/application.rb
+- spec/fake_app/config/boot.rb
+- spec/fake_app/config/credentials.yml.enc
+- spec/fake_app/config/database.yml
+- spec/fake_app/config/environment.rb
+- spec/fake_app/config/environments/development.rb
+- spec/fake_app/config/environments/production.rb
+- spec/fake_app/config/environments/test.rb
+- spec/fake_app/config/initializers/assets.rb
+- spec/fake_app/config/initializers/cookies_serializer.rb
+- spec/fake_app/config/initializers/filter_parameter_logging.rb
+- spec/fake_app/config/initializers/stitches.rb
+- spec/fake_app/config/locales/en.yml
+- spec/fake_app/config/master.key
+- spec/fake_app/config/puma.rb
+- spec/fake_app/config/routes.rb
+- spec/fake_app/config/storage.yml
+- spec/fake_app/db/development.sqlite3
+- spec/fake_app/db/migrate/20210802153118_enable_uuid_ossp_extension.rb
+- spec/fake_app/db/migrate/20210802153119_create_api_clients.rb
+- spec/fake_app/db/schema_missing_disabled_at.rb
+- spec/fake_app/db/schema_missing_enabled.rb
+- spec/fake_app/db/schema_modern.rb
+- spec/fake_app/db/seeds.rb
+- spec/fake_app/db/test.sqlite3
+- spec/fake_app/doc/api.md
+- spec/fake_app/lib/tasks/generate_api_key.rake
+- spec/fake_app/public/404.html
+- spec/fake_app/public/422.html
+- spec/fake_app/public/500.html
+- spec/fake_app/public/apple-touch-icon-precomposed.png
+- spec/fake_app/public/apple-touch-icon.png
+- spec/fake_app/public/favicon.ico
+- spec/fake_app/public/javascripts/apitome/application.js
+- spec/fake_app/public/robots.txt
+- spec/fake_app/public/stylesheets/apitome/application.css
+- spec/fake_app/test/application_system_test_case.rb
+- spec/fake_app/test/test_helper.rb
+- spec/fake_app/tmp/development_secret.txt
 - spec/integration/add_to_rails_app_spec.rb
+- spec/rails_helper.rb
 - spec/spec/be_gone_spec.rb
 - spec/spec/have_api_error_spec.rb
 - spec/spec/show_deprecation_spec.rb
 - spec/spec_helper.rb
+- spec/valid_mime_type_middleware_spec.rb
 - spec/valid_mime_type_spec.rb
 - stitches.gemspec
 homepage: https://github.com/stitchfix/stitches
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,25 +289,88 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.20
+signing_key:
 specification_version: 4
 summary: You'll be in stitches at how easy it is to create a service at Stitch Fix
 test_files:
-- spec/api_client_access_wrapper_spec.rb
-- spec/api_key_spec.rb
-- spec/api_version_constraint_spec.rb
+- spec/api_key_middleware_spec.rb
+- spec/api_version_constraint_middleware_spec.rb
 - spec/configuration_spec.rb
 - spec/deprecation_spec.rb
 - spec/error_spec.rb
 - spec/errors_spec.rb
+- spec/fake_app/.rspec
+- spec/fake_app/.ruby-version
+- spec/fake_app/Gemfile
+- spec/fake_app/README.md
+- spec/fake_app/Rakefile
+- spec/fake_app/app/assets/config/manifest.js
+- spec/fake_app/app/assets/stylesheets/application.css
+- spec/fake_app/app/controllers/api.rb
+- spec/fake_app/app/controllers/api/api_controller.rb
+- spec/fake_app/app/controllers/api/v1.rb
+- spec/fake_app/app/controllers/api/v1/hellos_controller.rb
+- spec/fake_app/app/controllers/api/v1/pings_controller.rb
+- spec/fake_app/app/controllers/api/v2.rb
+- spec/fake_app/app/controllers/api/v2/hellos_controller.rb
+- spec/fake_app/app/controllers/api/v2/pings_controller.rb
+- spec/fake_app/app/controllers/application_controller.rb
+- spec/fake_app/app/helpers/application_helper.rb
+- spec/fake_app/app/models/api_client.rb
+- spec/fake_app/app/models/application_record.rb
+- spec/fake_app/bin/rails
+- spec/fake_app/bin/rake
+- spec/fake_app/bin/setup
+- spec/fake_app/config.ru
+- spec/fake_app/config/application.rb
+- spec/fake_app/config/boot.rb
+- spec/fake_app/config/credentials.yml.enc
+- spec/fake_app/config/database.yml
+- spec/fake_app/config/environment.rb
+- spec/fake_app/config/environments/development.rb
+- spec/fake_app/config/environments/production.rb
+- spec/fake_app/config/environments/test.rb
+- spec/fake_app/config/initializers/assets.rb
+- spec/fake_app/config/initializers/cookies_serializer.rb
+- spec/fake_app/config/initializers/filter_parameter_logging.rb
+- spec/fake_app/config/initializers/stitches.rb
+- spec/fake_app/config/locales/en.yml
+- spec/fake_app/config/master.key
+- spec/fake_app/config/puma.rb
+- spec/fake_app/config/routes.rb
+- spec/fake_app/config/storage.yml
+- spec/fake_app/db/development.sqlite3
+- spec/fake_app/db/migrate/20210802153118_enable_uuid_ossp_extension.rb
+- spec/fake_app/db/migrate/20210802153119_create_api_clients.rb
+- spec/fake_app/db/schema_missing_disabled_at.rb
+- spec/fake_app/db/schema_missing_enabled.rb
+- spec/fake_app/db/schema_modern.rb
+- spec/fake_app/db/seeds.rb
+- spec/fake_app/db/test.sqlite3
+- spec/fake_app/doc/api.md
+- spec/fake_app/lib/tasks/generate_api_key.rake
+- spec/fake_app/public/404.html
+- spec/fake_app/public/422.html
+- spec/fake_app/public/500.html
+- spec/fake_app/public/apple-touch-icon-precomposed.png
+- spec/fake_app/public/apple-touch-icon.png
+- spec/fake_app/public/favicon.ico
+- spec/fake_app/public/javascripts/apitome/application.js
+- spec/fake_app/public/robots.txt
+- spec/fake_app/public/stylesheets/apitome/application.css
+- spec/fake_app/test/application_system_test_case.rb
+- spec/fake_app/test/test_helper.rb
+- spec/fake_app/tmp/development_secret.txt
 - spec/integration/add_to_rails_app_spec.rb
+- spec/rails_helper.rb
 - spec/spec/be_gone_spec.rb
 - spec/spec/have_api_error_spec.rb
 - spec/spec/show_deprecation_spec.rb
 - spec/spec_helper.rb
+- spec/valid_mime_type_middleware_spec.rb
 - spec/valid_mime_type_spec.rb