stitches 4.2.0.RC2 → 4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 781cc5ec8996b5c726e7e214d69c5d780ddbf4818fb9b0cb5ce15de6bb6e829c
-  data.tar.gz: f482c0e9a21b84330add05e8c9a2bfd3ef5986ac60f7f22766f79f480d1e2a4b
+  metadata.gz: 31a88657d0835e4d9dae083be3a5351e0cfe719dc0c930def115d0a1d9749849
+  data.tar.gz: 4f873d97147ef91da025f0f06eb29c0c800f6a2f6410739cc64c7050b17fbb4b
 SHA512:
-  metadata.gz: d71dfb5cc76e1d753d1b25e3a8e278097167f07e8f43e7f276041c043960bf3ba551d47cd3ba90a4d94d56538a217d4c55156b5d5cb59273aa104086852d4a26
-  data.tar.gz: fb6c236f22a81f1cb7373f3d50d6dc907e7ba2c684a07dc1f5ce94ac7e9b6039dda780821d763912dbb39139fc00b27e2d254c525b7ac9da3d1011a5f4bec9b3
+  metadata.gz: 9c78c55c6a88cf128e1d58e9fce561f32f53207c0de2f8ddb107449fe2de2638e73f76e842aece05b1d5431072459bf7747dd736746d7ad81f3c153841f00627
+  data.tar.gz: 0ae33e523eb0f782f6cdf3a0bc457c8f09fa3a140759e344f8fe07b6a9b209dfcb119df77abe167017a491462bb83db9f10ce7f1aae7d82aa5c8b9b7046ef1bb

data/lib/stitches/api_client_access_wrapper.rb

@@ -33,7 +33,7 @@ module Stitches::ApiClientAccessWrapper
 
     disabled_at = api_client.respond_to?(:disabled_at) ? api_client.disabled_at : nil
     if disabled_at && disabled_at > configuration.disabled_key_leniency_in_seconds.seconds.ago
-      message = "Allowing disabled ApiClient: #{api_client.name} with key #{api_client.key} disabled at #{disabled_at}"
+      message = "Allowing disabled ApiClient: #{api_client.name} with key #{redact_key(api_client)} disabled at #{disabled_at}"
       if disabled_at > configuration.disabled_key_leniency_error_log_threshold_in_seconds.seconds.ago
         logger.warn(message)
       else
@@ -41,11 +41,15 @@ module Stitches::ApiClientAccessWrapper
       end
       return api_client
     else
-      logger.error("Rejecting disabled ApiClient: #{api_client.name} with key #{api_client.key}")
+      logger.error("Rejecting disabled ApiClient: #{api_client.name} with key #{redact_key(api_client)}")
     end
     nil
   end
 
+  def self.redact_key(api_client)
+    "*****#{api_client.key.to_s[-8..-1]}"
+  end
+
   def self.logger
     if defined?(StitchFix::Logger::LogWriter)
       StitchFix::Logger::LogWriter

data/lib/stitches/api_generator.rb

@@ -12,7 +12,6 @@ module Stitches
 
     desc "Bootstraps your API service with a basic ping controller and spec to ensure everything is setup properly"
     def bootstrap_api
-      gem "apitome"
       gem_group :development, :test do
         gem "rspec"
         gem "rspec-rails"
@@ -22,12 +21,8 @@ module Stitches
       Bundler.with_clean_env do
         run "bundle install"
       end
-      generate "apitome:install"
       generate "rspec:install"
 
-      gsub_file 'config/initializers/apitome.rb', /config.mount_at = .*$/, "config.mount_at = nil"
-      gsub_file 'config/initializers/apitome.rb', /config.title = .*$/, "config.title = 'Service Documentation'"
-
       inject_into_file "config/routes.rb", before: /^end/ do<<-ROUTES
 namespace :api do
   scope module: :v1, constraints: Stitches::ApiVersionConstraint.new(1) do
@@ -40,11 +35,6 @@ namespace :api do
     # as well as for your client to be able to validate this as well.
   end
 end
-
-api_docs = Rack::Auth::Basic.new(Apitome::Engine) do |_, password|
-  password == ENV['HTTP_AUTH_PASSWORD']
-end
-mount api_docs, at: "docs"
       ROUTES
       end
 
@@ -77,7 +67,7 @@ require 'stitches/spec'
 require 'rspec_api_documentation'
 
 RspecApiDocumentation.configure do |config|
-  config.format = :json
+  config.format = [:json, :html]
   config.request_headers_to_include = %w(
     Accept
     Content-Type

data/lib/stitches/generator_files/db/migrate/add_disabled_at_to_api_clients.rb

@@ -1,8 +1,4 @@
-<% if Rails::VERSION::MAJOR >= 5 %>
-class AddDisabledAtToApiClients < ActiveRecord::Migration[<%= Rails::VERSION::MAJOR %>.<%= Rails::VERSION::MINOR %>]
-<% else %>
-class AddDisabledAtToApiClients < ActiveRecord::Migration
-<% end %>
+class AddDisabledAtToApiClients < ActiveRecord::Migration<% if Rails::VERSION::MAJOR >= 5 %>[<%= Rails::VERSION::MAJOR %>.<%= Rails::VERSION::MINOR %>]<% end %>
   def change
     add_column :api_clients, :disabled_at, "timestamp with time zone", null: true
   end

data/lib/stitches/generator_files/db/migrate/add_enabled_to_api_clients.rb

@@ -1,8 +1,4 @@
-<% if Rails::VERSION::MAJOR >= 5 %>
-class AddEnabledToApiClients < ActiveRecord::Migration[<%= Rails::VERSION::MAJOR %>.<%= Rails::VERSION::MINOR %>]
-<% else %>
-class AddEnabledToApiClients < ActiveRecord::Migration
-<% end %>
+class AddEnabledToApiClients < ActiveRecord::Migration<% if Rails::VERSION::MAJOR >= 5 %>[<%= Rails::VERSION::MAJOR %>.<%= Rails::VERSION::MINOR %>]<% end %>
   def change
     add_column :api_clients, :enabled, :bool, null: false, default: true
     remove_index :api_clients, [:name ] # existing one would be unique

data/lib/stitches/generator_files/db/migrate/create_api_clients.rb

@@ -1,8 +1,4 @@
-<% if Rails::VERSION::MAJOR >= 5 %>
-class CreateApiClients < ActiveRecord::Migration[<%= Rails::VERSION::MAJOR %>.<%= Rails::VERSION::MINOR %>]
-<% else %>
-class CreateApiClients < ActiveRecord::Migration
-<% end %>
+class CreateApiClients < ActiveRecord::Migration<% if Rails::VERSION::MAJOR >= 5 %>[<%= Rails::VERSION::MAJOR %>.<%= Rails::VERSION::MINOR %>]<% end %>
   def change
     create_table :api_clients do |t|
       t.string :name, null: false

data/lib/stitches/generator_files/db/migrate/enable_uuid_ossp_extension.rb

@@ -1,8 +1,4 @@
-<% if Rails::VERSION::MAJOR >= 5 %>
-class EnableUuidOsspExtension < ActiveRecord::Migration[<%= Rails::VERSION::MAJOR %>.<%= Rails::VERSION::MINOR %>]
-<% else %>
-class EnableUuidOsspExtension < ActiveRecord::Migration
-<% end %>
+class EnableUuidOsspExtension < ActiveRecord::Migration<% if Rails::VERSION::MAJOR >= 5 %>[<%= Rails::VERSION::MAJOR %>.<%= Rails::VERSION::MINOR %>]<% end %>
   def change
     enable_extension 'uuid-ossp'
   end

data/lib/stitches/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stitches
-  VERSION = '4.2.0.RC2'
+  VERSION = '4.2.2'
 end

data/spec/api_key_middleware_spec.rb

@@ -102,10 +102,11 @@ RSpec.describe "/api/hellos", type: :request do
         context "when disabled_at is set to a time older than three days ago" do
           let(:disabled_at) { 4.day.ago }
 
-          it "allows the call" do
+          it "does not allow the call" do
             execute_call
 
             expect_unauthorized
+
           end
         end
 
@@ -162,7 +163,9 @@ RSpec.describe "/api/hellos", type: :request do
 
           it "logs error about the disabled key to the Rails.logger" do
             allow(Rails.logger).to receive(:warn)
-            allow(Rails.logger).to receive(:error)
+            allow(Rails.logger).to receive(:error) do |message1|
+              expect(message1).not_to include uuid
+            end
 
             execute_call
 
@@ -210,7 +213,10 @@ RSpec.describe "/api/hellos", type: :request do
             let(:disabled_at) { 101.seconds.ago }
 
             it "forbids the call" do
-              allow(Rails.logger).to receive(:error)
+              allow(Rails.logger).to receive(:error) do |message1|
+                expect(message1).not_to include uuid
+              end
+
               execute_call
 
               expect_unauthorized
@@ -235,7 +241,9 @@ RSpec.describe "/api/hellos", type: :request do
             let(:disabled_at) { 25.seconds.ago }
 
             it "allows the call" do
-              allow(Rails.logger).to receive(:warn)
+              allow(Rails.logger).to receive(:warn) do |message1|
+                expect(message1).not_to include uuid
+              end
 
               execute_call
 

data/spec/fake_app/Gemfile

@@ -44,7 +44,6 @@ end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
-gem 'apitome'
 
 group :development, :test do
   gem 'rspec'

data/spec/integration/add_to_rails_app_spec.rb

@@ -51,7 +51,7 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
           run use_local_stitches
           # It's unclear why, but on CI the gems are not found when installed
           # through bundler however installing them explicitly first fixes it.
-          run "gem install apitome rspec-rails rspec_api_documentation"
+          run "gem install rspec-rails rspec_api_documentation"
           run "bundle install"
           example.run
         end
@@ -69,11 +69,9 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
     # It's also in one big block because making a new rails app and running the generator multiple times seems bad.
     aggregate_failures do
       expect(File.exist?(rails_root / "app" / "controllers" / "api" / "api_controller.rb")).to eq(true)
-      expect(rails_root / "Gemfile").to contain_gem("apitome")
       expect(rails_root / "Gemfile").to contain_gem("rspec_api_documentation")
       expect(rails_root / "config" / "routes.rb").to have_route(namespace: :api, module_scope: :v1, resource: 'ping')
       expect(rails_root / "config" / "routes.rb").to have_route(namespace: :api, module_scope: :v2, resource: 'ping')
-      expect(rails_root / "config" / "routes.rb").to have_mounted_engine("Apitome::Engine")
       migrations = Dir["#{rails_root}/db/migrate/*.rb"].sort
       expect(migrations.size).to eq(2)
       expect(migrations[0]).to match(/\/\d+_enable_uuid_ossp_extension.rb/)
@@ -81,8 +79,6 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
       expect(File.read(rails_root / "spec" / "rails_helper.rb")).to include("config.include RSpec::Rails::RequestExampleGroup, type: :feature")
       expect(File.read(rails_root / "spec" / "rails_helper.rb")).to include("require 'stitches/spec'")
       expect(File.read(rails_root / "spec" / "rails_helper.rb")).to include("require 'rspec_api_documentation'")
-      expect(File.read(rails_root / "config" / "initializers" / "apitome.rb")).to include("config.mount_at = nil")
-      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")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stitches
 version: !ruby/object:Gem::Version
-  version: 4.2.0.RC2
+  version: 4.2.2
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -251,7 +251,6 @@ files:
 - 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
@@ -289,11 +288,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: You'll be in stitches at how easy it is to create a service at Stitch Fix
@@ -352,7 +351,6 @@ test_files:
 - 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

data/spec/fake_app/doc/api.md

@@ -1,4 +0,0 @@
-Apitome Documentation
-=====================
-
-This file was automatically generated, and can be found at `doc/api.md`.