stitches 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea8633778064ab7646860c9a0682a7290bfbea3d6f3f091c290f50d22f97de2
-  data.tar.gz: 0eb1d04f15fc37ab0b0484ae6a73f953426cc5dd1b9efd056e42300caa4c2d04
+  metadata.gz: 1224843bf19c711e4058e54025f2507fe4dd0085fb5afdd57d5d383bf8d1b03e
+  data.tar.gz: 8f2c1f7f053d711e6419b8e19c23cc123ce7164513b7cb3978091d081612001a
 SHA512:
-  metadata.gz: f854d4c3feca2e48b6edfde3174564112b2c0c1d6cb6b93bed960985cc779c1119bcf5ddb65d43d85d3c349d9f440b61e14b1cef27aa6f8c1701768ab5ac1dd5
-  data.tar.gz: b19d1b967d4a5e0dc57265475683bbfd8e9f255d15ee0af1a8130832d16e73e54b52b7e34fc025fe170a4322cb30cbddb6f2e631f7c81521953e4e48514bb547
+  metadata.gz: f16b168bf89994f06816661fb0dda066c248a3c55a22bdeebebf32d4a0e784368b41a460f25a84c9e0c4a694b37d372a24cf739171191925f31df7df7a562be6
+  data.tar.gz: 053d0ae0e44945437218bc87206038029065b0ff8b6f8321bbad8b878024bddb16432b0f23136286e6019805a716d541a37a2d5382479b9216a9cde0104bf5d9

data/.circleci/config.yml

@@ -3,9 +3,33 @@
 ---
 version: 2
 jobs:
+  generate-and-push-docs:
+    docker:
+    - image: circleci/ruby:2.7.2
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
+    steps:
+    - checkout
+    - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
+    - run: bundle install --full-index
+    - run:
+        name: Generate documentation
+        command: ' if [[ $(bundle exec rake -T docs:generate:custom) ]]; then echo
+          "Generating docs using rake task docs:generate:custom" ; bundle exec rake
+          docs:generate:custom ; elif [[ $(bundle exec rake -T docs:generate) ]];
+          then echo "Generating docs using rake task docs:generate" ; bundle exec
+          rake docs:generate ; else echo "Skipping doc generation" ; exit 0 ; fi '
+    - run:
+        name: Push documentation to Unwritten
+        command: if [[ $(bundle exec rake -T docs:push) ]]; then bundle exec rake
+          docs:push; fi
   release:
     docker:
-    - image: circleci/ruby:2.7.1
+    - image: circleci/ruby:2.7.2
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
     steps:
     - checkout
     - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
@@ -17,14 +41,22 @@ jobs:
     - run:
         name: Build/release gem to artifactory
         command: bundle exec rake push_artifactory
-  ruby-2.7.1-rails-6.0:
+  ruby-2.7.2-rails-6.0:
     docker:
-    - image: circleci/ruby:2.7.1
+    - image: circleci/ruby:2.7.2
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
       environment:
         BUNDLE_GEMFILE: Gemfile.rails-6.0
     working_directory: "~/stitches"
     steps:
     - checkout
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/master/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
     - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
@@ -42,11 +74,19 @@ jobs:
   ruby-2.6.6-rails-6.0:
     docker:
     - image: circleci/ruby:2.6.6
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
       environment:
         BUNDLE_GEMFILE: Gemfile.rails-6.0
     working_directory: "~/stitches"
     steps:
     - checkout
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/master/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
     - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
@@ -61,14 +101,22 @@ jobs:
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
-  ruby-2.7.1-rails-5.2:
+  ruby-2.7.2-rails-5.2:
     docker:
-    - image: circleci/ruby:2.7.1
+    - image: circleci/ruby:2.7.2
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
       environment:
         BUNDLE_GEMFILE: Gemfile.rails-5.2
     working_directory: "~/stitches"
     steps:
     - checkout
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/master/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
     - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
@@ -86,11 +134,19 @@ jobs:
   ruby-2.6.6-rails-5.2:
     docker:
     - image: circleci/ruby:2.6.6
+      auth:
+        username: "$DOCKERHUB_USERNAME"
+        password: "$DOCKERHUB_PASSWORD"
       environment:
         BUNDLE_GEMFILE: Gemfile.rails-5.2
     working_directory: "~/stitches"
     steps:
     - checkout
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/master/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
     - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
@@ -112,16 +168,25 @@ workflows:
     - release:
         context: org-global
         requires:
-        - ruby-2.7.1-rails-6.0
+        - ruby-2.7.2-rails-6.0
         - ruby-2.6.6-rails-6.0
-        - ruby-2.7.1-rails-5.2
+        - ruby-2.7.2-rails-5.2
         - ruby-2.6.6-rails-5.2
         filters:
           tags:
-            only: /^[0-9]+\.[0-9]+\.[0-9]+(\.?(RC|rc)[-\.]?\d*)?$/
+            only: /^[0-9]+\.[0-9]+\.[0-9]+(\.?(RC|rc)[-\.]?\w*)?$/
+          branches:
+            ignore: /.*/
+    - generate-and-push-docs:
+        context: org-global
+        requires:
+        - release
+        filters:
+          tags:
+            only: /^[0-9]+\.[0-9]+\.[0-9]+(\.?(RC|rc)[-\.]?\w*)?$/
           branches:
             ignore: /.*/
-    - ruby-2.7.1-rails-6.0:
+    - ruby-2.7.2-rails-6.0:
         context: org-global
         filters:
           tags:
@@ -131,7 +196,7 @@ workflows:
         filters:
           tags:
             only: *1
-    - ruby-2.7.1-rails-5.2:
+    - ruby-2.7.2-rails-5.2:
         context: org-global
         filters:
           tags:
@@ -150,11 +215,11 @@ workflows:
             only:
             - master
     jobs:
-    - ruby-2.7.1-rails-6.0:
+    - ruby-2.7.2-rails-6.0:
         context: org-global
     - ruby-2.6.6-rails-6.0:
         context: org-global
-    - ruby-2.7.1-rails-5.2:
+    - ruby-2.7.2-rails-5.2:
         context: org-global
     - ruby-2.6.6-rails-5.2:
         context: org-global

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+2.7.2

data/lib/stitches/valid_mime_type.rb

@@ -1,19 +1,26 @@
 require_relative 'allowlist_middleware'
 module Stitches
-  # A middleware that requires all API calls to be for versioned JSON.  This means that the Accept
-  # header (available to Rack apps as HTTP_ACCEPT) should be like so:
+  # A middleware that requires all API calls to be for versioned JSON or Protobuf.
+  #
+  # This means that the Accept header (available to Rack apps as HTTP_ACCEPT) should be like so:
   #
   #     application/json; version=1
   #
   # This just checks that you've specified some numeric version.  ApiVersionConstraint should be used
   # to "lock down" the versions you accept.
+  # 
+  # Or in the case of a protobuf encoded payload the header should be like so:
+  #
+  #     application/protobuf
+  #
+  # There isn't an accepted standard for protobuf encoded payloads but this form is common.
   class ValidMimeType < Stitches::AllowlistMiddleware
 
   protected
 
     def do_call(env)
       accept = String(env["HTTP_ACCEPT"])
-      if accept =~ %r{application/json} && accept =~ %r{version=\d+}
+      if (accept =~ %r{application/json} && accept =~ %r{version=\d+}) || accept =~ %r{application/protobuf}
         @app.call(env)
       else
         not_acceptable_response(accept)
@@ -24,7 +31,7 @@ module Stitches
 
     def not_acceptable_response(accept_header)
       status = 406
-      body = "Not Acceptable - '#{accept_header}' didn't have the right mime type or version number. We only accept application/json with a version"
+      body = "Not Acceptable - '#{accept_header}' didn't have the right mime type or version number. We only accept application/json with a version or application/protobuf"
       header = { "WWW-Authenticate" => accept_header }
       Rack::Response.new(body, status, header).finish
     end

data/lib/stitches/version.rb

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

data/spec/valid_mime_type_spec.rb

@@ -132,6 +132,22 @@ describe Stitches::ValidMimeType do
       end
     end
 
+    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)

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: stitches
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 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: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -184,7 +184,7 @@ homepage: https://github.com/stitchfix/stitches
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -199,8 +199,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+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
 test_files: