stitches 4.0.0.RC1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d181adb5b8ed9642468e2a8c75ab5ed2cbb01756458885410c8538c0b0a51890
-  data.tar.gz: 95a4105d911e4e4ebbf927d2bf87efb8bc6dfb1d2537e4f0ebc42caf8569c44d
+  metadata.gz: 3ea8633778064ab7646860c9a0682a7290bfbea3d6f3f091c290f50d22f97de2
+  data.tar.gz: 0eb1d04f15fc37ab0b0484ae6a73f953426cc5dd1b9efd056e42300caa4c2d04
 SHA512:
-  metadata.gz: 442b3c89184c500c7036bb06a355c0df478ea16089777d920aefc62c94dedb37ad0be40a4a46dc558509148b0f08feb335cece9e8e79ac732482977876931d99
-  data.tar.gz: aeaf701f19b4e8962227cccd7421f3452bf7e2dde77bfa2e7ecce735883adade7903a3392009d351e48258d2b6f231f36d36190a8e65c184e8ad5b9681d94f7f
+  metadata.gz: f854d4c3feca2e48b6edfde3174564112b2c0c1d6cb6b93bed960985cc779c1119bcf5ddb65d43d85d3c349d9f440b61e14b1cef27aa6f8c1701768ab5ac1dd5
+  data.tar.gz: b19d1b967d4a5e0dc57265475683bbfd8e9f255d15ee0af1a8130832d16e73e54b52b7e34fc025fe170a4322cb30cbddb6f2e631f7c81521953e4e48514bb547

data/README.md

@@ -117,6 +117,24 @@ See [the wiki](https://github.com/stitchfix/stitches/wiki/Setup) for how to setu
   - Acceptance tests that can produce API documentation as they test your app.
 - Stitches provides [testing support](https://github.com/stitchfix/stitches/wiki/Testing)
 
+## API Key Caching
+
+Since version 4.0.0, stitches now has the ability to cache API keys in
+memory for a configurable amount of time. This may be an improvement for
+some applications.
+
+You must configure the API Cache for it be used.
+
+```ruby
+Stitches.configure do |config|
+  config.max_cache_ttl = 5  # seconds
+  config.max_cache_size = 100  # how many keys to cache
+end
+```
+
+Your cache size should be
+larger then the number of consumer keys your service has.
+
 ## Developing
 
 Although `Stitches.configuration` is global, do not depend directly on that in your logic. Instead, allow all classes to receive a configuration object in their constructor. This makes the classes easier to deal with and change, without incurring much of a real cost to development. Global symbols suck, but are convenient. This is how you make the most of it.

data/lib/stitches/configuration.rb

@@ -27,11 +27,6 @@ class Stitches::Configuration
     @allowlist_regexp = new_allowlist_regexp
   end
 
-  def whitelist_regexp=(new_allowlist_regexp)
-    self.allowlist_regexp = new_allowlist_regexp
-    warn("⚠️ 'whitelist' is deprecated in stitches configuration, please use 'allowlist' or auto-update with:\n\n  bin/rails g stitches:update_configuration\n\n⚠️  'whitelist' will be removed in 4.0")
-  end
-
   # The name of your custom http auth scheme.  This must be set, and has no default
   def custom_http_auth_scheme
     @custom_http_auth_scheme.to_s

data/lib/stitches/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stitches
-  VERSION = '4.0.0.RC1'
+  VERSION = '4.0.0'
 end

data/lib/stitches_norailtie.rb

@@ -14,7 +14,6 @@ require 'stitches/errors'
 require 'stitches/api_generator'
 require 'stitches/add_deprecation_generator'
 require 'stitches/add_enabled_to_api_clients_generator'
-require 'stitches/update_configuration_generator'
 require 'stitches/api_version_constraint'
 require 'stitches/api_key'
 require 'stitches/deprecation'

data/spec/configuration_spec.rb

@@ -146,20 +146,4 @@ describe Stitches::Configuration do
       }.to raise_error(/max_cache_size must be an Integer, not a NilClass/)
     end
   end
-
-  context "deprecated options we want to support for backwards compatibility" do
-
-    let(:logger) { double("logger") }
-    before do
-      allow(Rails).to receive(:logger).and_return(logger)
-      allow(logger).to receive(:info)
-    end
-
-    it "'whitelist' still works for allowlist" do
-      Stitches.configure do |config|
-        config.whitelist_regexp = /foo/
-      end
-      expect(Stitches.configuration.allowlist_regexp).to eq(/foo/)
-    end
-  end
 end

data/spec/integration/add_to_rails_app_spec.rb

@@ -109,35 +109,6 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
     expect(include_line).to_not be_nil,lines.inspect
   end
 
-  it "inserts can update old configuration" do
-    run "bin/rails generate stitches:api"
-
-    initializer = rails_root / "config" / "initializers" / "stitches.rb"
-
-    initializer_contents = File.read(initializer).split(/\n/)
-    found_initializer = false
-    File.open(initializer,"w") do |file|
-      initializer_contents.each do |line|
-        if line =~ /allowlist/
-          line = line.gsub("allowlist","whitelist")
-          found_initializer = true
-        end
-        file.puts line
-      end
-    end
-
-    raise "Didn't find 'allowlist' in the initializer?!" if !found_initializer
-
-    run "bin/rails generate stitches:update_configuration"
-
-    lines =  File.read(initializer).split(/\n/)
-    include_line = lines.detect { |line|
-      line =~ /whitelist/
-    }
-
-    expect(include_line).to be_nil,lines.inspect
-  end
-
   class RoutesFileAnalysis
     attr_reader :routes_file
     def initialize(routes_file, namespace: nil, module_scope: nil, resource: nil, mounted_engine: nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stitches
 version: !ruby/object:Gem::Version
-  version: 4.0.0.RC1
+  version: 4.0.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,10 +162,8 @@ files:
 - lib/stitches/spec/have_api_error.rb
 - lib/stitches/spec/show_deprecation.rb
 - lib/stitches/spec/test_headers.rb
-- lib/stitches/update_configuration_generator.rb
 - lib/stitches/valid_mime_type.rb
 - lib/stitches/version.rb
-- lib/stitches/whitelisting_middleware.rb
 - lib/stitches_norailtie.rb
 - owners.json
 - spec/api_client_access_wrapper_spec.rb
@@ -197,9 +195,9 @@ 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.1.2
 signing_key: 

data/lib/stitches/update_configuration_generator.rb

@@ -1,16 +0,0 @@
-require 'rails/generators'
-
-module Stitches
-  class UpdateConfigurationGenerator < Rails::Generators::Base
-    include Rails::Generators::Migration
-
-    source_root(File.expand_path(File.join(File.dirname(__FILE__),"generator_files")))
-
-    desc "Change your configuration to use 'allowlist' so you'll be ready for 4.x"
-    def update_to_allowlist
-      gsub_file "config/initializers/stitches.rb", /whitelist/, "allowlist"
-      puts "🎉 You are now good to go!"
-    end
-
-  end
-end

data/lib/stitches/whitelisting_middleware.rb

@@ -1,5 +0,0 @@
-require_relative "allowlist_middleware"
-
-module Stitches
-  WhitelistingMiddleware = AllowlistMiddleware
-end