stitches 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a861f11796bfcc697ded1857fe96d0b0dfbc73ab
-  data.tar.gz: 831d978bdf931a550a6af1fe1779e8216f6f56b0
+  metadata.gz: 9e87e719f34bc52ddf14d46560ca160b073648c8
+  data.tar.gz: 5919ab13f6949c37fb1be76f93883176d5a49a49
 SHA512:
-  metadata.gz: fd50b87dbe2f27d96d287de362ff8ae19479b3c47793d1700d988597b88b408f2ffa56fd4d29ab5a905336fce67fab4824b6caf342d9175f8ad8e11dad702240
-  data.tar.gz: 1df173eeecc1a8e16640ab1b50c5fe2d406180f381414c6fd1ff606a2a959f56970377f99236c0b9c456b8a1a233c5aa95923af5d5b955cf828bc29cc7951a53
+  metadata.gz: 123e883d8a697b656ce8c75c6a1b7fd270bfc7eba4df3b091fe12cfa17dda35f32c15b15e09a981d17bdc1564b19a265f3f01d746825b9bac80f56ba27dd54a4
+  data.tar.gz: 8ed0e45e556b957750cf7c6eb3cb93a608909576a22e52fcd1f440be5ebeea5d19017cc40696ff9fdc3dc20067f01f4b5f8b9a23e1155df6f00ec669e4759267

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.3.1

data/.travis.yml

@@ -1,9 +1,7 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.1.0
-  - 2.0.0
-  - 2.2.0
+  - 2.2.2
+  - 2.3.1
   - ruby-head
 notifications:
-  email: false
+  email: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stitches (3.2.3)
+    stitches (3.3.0)
       apitome
       pg
       rails
@@ -11,124 +11,129 @@ PATH
 GEM
   remote: https://www.rubygems.org/
   specs:
-    actionmailer (4.2.5.2)
-      actionpack (= 4.2.5.2)
-      actionview (= 4.2.5.2)
-      activejob (= 4.2.5.2)
+    actioncable (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
       mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.5.2)
-      actionview (= 4.2.5.2)
-      activesupport (= 4.2.5.2)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.0.1)
+      actionview (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.5.2)
-      activesupport (= 4.2.5.2)
+    actionview (5.0.0.1)
+      activesupport (= 5.0.0.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.5.2)
-      activesupport (= 4.2.5.2)
-      globalid (>= 0.3.0)
-    activemodel (4.2.5.2)
-      activesupport (= 4.2.5.2)
-      builder (~> 3.1)
-    activerecord (4.2.5.2)
-      activemodel (= 4.2.5.2)
-      activesupport (= 4.2.5.2)
-      arel (~> 6.0)
-    activesupport (4.2.5.2)
+    activejob (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     apitome (0.1.0)
       kramdown
       railties
       rspec_api_documentation
-    arel (6.0.3)
+    arel (7.1.1)
     builder (3.2.2)
-    concurrent-ruby (1.0.1)
+    concurrent-ruby (1.0.2)
     diff-lcs (1.2.5)
     erubis (2.7.0)
-    globalid (0.3.6)
+    globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
-    json (1.8.3)
-    kramdown (1.10.0)
+    kramdown (1.12.0)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
-    mail (2.6.3)
-      mime-types (>= 1.16, < 3)
-    mime-types (2.99.1)
-    mini_portile2 (2.0.0)
-    minitest (5.8.4)
-    mustache (0.99.8)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    mustache (1.0.3)
+    nio4r (1.2.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
     pg (0.18.4)
-    rack (1.6.4)
+    pkg-config (1.1.7)
+    rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (4.2.5.2)
-      actionmailer (= 4.2.5.2)
-      actionpack (= 4.2.5.2)
-      actionview (= 4.2.5.2)
-      activejob (= 4.2.5.2)
-      activemodel (= 4.2.5.2)
-      activerecord (= 4.2.5.2)
-      activesupport (= 4.2.5.2)
+    rails (5.0.0.1)
+      actioncable (= 5.0.0.1)
+      actionmailer (= 5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activerecord (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.5.2)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
+      railties (= 5.0.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
       nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (4.2.5.2)
-      actionpack (= 4.2.5.2)
-      activesupport (= 4.2.5.2)
+    railties (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.3)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-rails (3.4.2)
-      actionpack (>= 3.0, < 4.3)
-      activesupport (>= 3.0, < 4.3)
-      railties (>= 3.0, < 4.3)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    rspec_api_documentation (4.7.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rspec_api_documentation (4.8.0)
       activesupport (>= 3.0.0)
-      json (~> 1.4, >= 1.4.6)
-      mustache (~> 0.99, >= 0.99.4)
-      rspec (>= 3.0.0)
-    sprockets (3.5.2)
+      mustache (~> 1.0, >= 0.99.4)
+      rspec (~> 3.0, >= 3.0.0)
+    sprockets (3.7.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.0.4)
+    sprockets-rails (3.2.0)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -136,6 +141,9 @@ GEM
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
 
 PLATFORMS
   ruby
@@ -145,4 +153,4 @@ DEPENDENCIES
   stitches!
 
 BUNDLED WITH
-   1.11.2
+   1.13.6

data/README.md

@@ -41,6 +41,20 @@ Run database migrations (do `rake db:create` first if you haven't yet set up a d
 rake db:migrate
 ```
 
+### Upgrading from older verison of Stitches
+
+If you have used stitches before the `enabled` field was added to `ApiClients`, you need to add that field to your database.  You can do this by running
+the included generator:
+
+```
+rails g stitches:add_enabled_to_api_clients
+```
+
+And then:
+
+```
+rake db:migrate
+```
 
 ## Test the install
 

data/lib/stitches/add_enabled_to_api_clients_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+
+module Stitches
+  class AddEnabledToApiClientsGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root(File.expand_path(File.join(File.dirname(__FILE__),"generator_files")))
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    desc "Upgrade your api_clients table so it uses the `enabled` field"
+    def update_api_clients_table
+      migration_template "db/migrate/add_enabled_to_api_clients.rb", "db/migrate/add_enabled_to_api_clients.rb"
+    end
+
+  end
+end

data/lib/stitches/api_key.rb

@@ -32,7 +32,14 @@ module Stitches
       if authorization
         if authorization =~ /#{@configuration.custom_http_auth_scheme}\s+key=(.*)\s*$/
           key = $1
-          client = ::ApiClient.where(key: key).first
+
+          if ApiClient.column_names.include?("enabled")
+            client = ApiClient.where(key: key, enabled: true).first
+          else
+            ActiveSupport::Deprecation.warn('api_keys is missing "enabled" column.  Run "rails g stitches:add_enabled_to_api_clients"')
+            client = ApiClient.where(key: key).first
+          end
+
           if client.present?
             env[@configuration.env_var_to_hold_api_client_primary_key] = client.id
             env[@configuration.env_var_to_hold_api_client] = client

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

@@ -0,0 +1,7 @@
+class AddEnabledToApiClients < ActiveRecord::Migration
+  def change
+    add_column :api_clients, :enabled, :bool, null: false, default: true
+    remove_index :api_clients, [:name ] # existing one would be unique
+    add_index :api_clients, [:name ]
+  end
+end

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

@@ -3,9 +3,10 @@ class CreateApiClients < ActiveRecord::Migration
     create_table :api_clients do |t|
       t.string :name, null: false
       t.column :key, "uuid default uuid_generate_v4()", null: false
+      t.column :enabled, :bool, null: false, default: true
       t.column :created_at, "timestamp with time zone default now()", null: false
     end
-    add_index :api_clients, [:name], unique: true
+    add_index :api_clients, [:name]
     add_index :api_clients, [:key], unique: true
   end
 end

data/lib/stitches/version.rb

@@ -1,3 +1,3 @@
 module Stitches
-  VERSION = '3.2.3'
+  VERSION = '3.3.0'
 end

data/lib/stitches_norailtie.rb

@@ -12,6 +12,7 @@ require 'stitches/render_timestamps_in_iso8601_in_json'
 require 'stitches/error'
 require 'stitches/errors'
 require 'stitches/api_generator'
+require 'stitches/add_enabled_to_api_clients_generator'
 require 'stitches/api_version_constraint'
 require 'stitches/api_key'
 require 'stitches/valid_mime_type'

data/spec/api_key_spec.rb

@@ -7,6 +7,9 @@ end
 
 unless defined? ApiClient
   class ApiClient
+    def self.column_names
+      ["enabled"]
+    end
   end
 end
 
@@ -17,7 +20,7 @@ describe Stitches::ApiKey do
       double(ApiClient, id: 42)
     ]
   }
-  
+
   before do
     Stitches.configuration.reset_to_defaults!
     Stitches.configuration.custom_http_auth_scheme = 'MyAwesomeInternalScheme'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stitches
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.3.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-06 00:00:00.000000000 Z
+date: 2017-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -120,6 +120,7 @@ files:
 - README.md
 - Rakefile
 - lib/stitches.rb
+- lib/stitches/add_enabled_to_api_clients_generator.rb
 - lib/stitches/api_generator.rb
 - lib/stitches/api_key.rb
 - lib/stitches/api_version_constraint.rb
@@ -134,6 +135,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_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
 - lib/stitches/generator_files/lib/tasks/generate_api_key.rake
@@ -179,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: You'll be in stitches at how easy it is to create a service at Stitch Fix