stitches 3.7.0 → 3.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e779533d1ae845c15bec064ad589e32d2e29bca1b3b966144358735d26026248
-  data.tar.gz: f9af71cd6d2bab7e70ef1d963c25f66a41aa76107b032dc409bb611c30bf7819
+  metadata.gz: ca2ab185c1ce66611e8a5fbf874bbbab5caa5ef2dffc760540401f7d1c03ca10
+  data.tar.gz: '087335206e8309b959da8965482d443db390543163b124a47c28636505a088bb'
 SHA512:
-  metadata.gz: 5145e91908d5cd6f685b7389cf3cf2a17bca9f5355eb513c26f6bb5f2e66270ebdf9c649796b683f470014e12dae4b98b3c2b2ce151afc2c984c96f94aa38a2f
-  data.tar.gz: 921734574b5e142f5786c1c7088e389e0d8d243111d5fcbfe7fded4f6e8dbb85fee11b1a25ffc2017f58c8b270ee46c41a6e0a554c130f9f09fa9c4c960cb544
+  metadata.gz: d42cba4d8621bd45022d12a859b420ac842312a0207dc33590f59eeafc74ef98760011b77169ba7c2408e9e89825c6021f4c44cb449787cd9f316ce1614a093d
+  data.tar.gz: c680ee5c6b9a41f7d9ac281e26a48477e3d7c6920f72334f378686fb4a7d2ae0718728716c8c84bd0c0a07b9a19163fd134ecfdf26f083b6bf3864253b3c456c

data/.circleci/config.yml

@@ -3,9 +3,9 @@
 ---
 version: 2
 jobs:
-  ruby-2.5.1-rails-5.2:
+  ruby-2.5.3-rails-5.2:
     docker:
-    - image: circleci/ruby:2.5.1
+    - image: circleci/ruby:2.5.3
       environment:
         BUNDLE_GEMFILE: Gemfile.rails-5.2
     working_directory: "~/stitches"
@@ -14,15 +14,19 @@ jobs:
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
+    - run:
+        name: Run Additional CI Steps
+        command: if [ -e bin/additional-ci-steps ]; then bin/additional-ci-steps;
+          fi
     - run:
         name: Notify Pager Duty
-        command: bundle exec y-notify eng-platform
+        command: 'bundle exec y-notify #eng-platform'
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
-  ruby-2.4.4-rails-5.2:
+  ruby-2.4.5-rails-5.2:
     docker:
-    - image: circleci/ruby:2.4.4
+    - image: circleci/ruby:2.4.5
       environment:
         BUNDLE_GEMFILE: Gemfile.rails-5.2
     working_directory: "~/stitches"
@@ -31,15 +35,19 @@ jobs:
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
+    - run:
+        name: Run Additional CI Steps
+        command: if [ -e bin/additional-ci-steps ]; then bin/additional-ci-steps;
+          fi
     - run:
         name: Notify Pager Duty
-        command: bundle exec y-notify eng-platform
+        command: 'bundle exec y-notify #eng-platform'
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
-  ruby-2.5.1-rails-5.1:
+  ruby-2.5.3-rails-5.1:
     docker:
-    - image: circleci/ruby:2.5.1
+    - image: circleci/ruby:2.5.3
       environment:
         BUNDLE_GEMFILE: Gemfile.rails-5.1
     working_directory: "~/stitches"
@@ -48,15 +56,19 @@ jobs:
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
+    - run:
+        name: Run Additional CI Steps
+        command: if [ -e bin/additional-ci-steps ]; then bin/additional-ci-steps;
+          fi
     - run:
         name: Notify Pager Duty
-        command: bundle exec y-notify eng-platform
+        command: 'bundle exec y-notify #eng-platform'
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
-  ruby-2.4.4-rails-5.1:
+  ruby-2.4.5-rails-5.1:
     docker:
-    - image: circleci/ruby:2.4.4
+    - image: circleci/ruby:2.4.5
       environment:
         BUNDLE_GEMFILE: Gemfile.rails-5.1
     working_directory: "~/stitches"
@@ -65,9 +77,13 @@ jobs:
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
         --format=doc
+    - run:
+        name: Run Additional CI Steps
+        command: if [ -e bin/additional-ci-steps ]; then bin/additional-ci-steps;
+          fi
     - run:
         name: Notify Pager Duty
-        command: bundle exec y-notify eng-platform
+        command: 'bundle exec y-notify #eng-platform'
         when: on_fail
     - store_test_results:
         path: "/tmp/test-results"
@@ -75,13 +91,13 @@ workflows:
   version: 2
   on-commit:
     jobs:
-    - ruby-2.5.1-rails-5.2:
+    - ruby-2.5.3-rails-5.2:
         context: org-global
-    - ruby-2.4.4-rails-5.2:
+    - ruby-2.4.5-rails-5.2:
         context: org-global
-    - ruby-2.5.1-rails-5.1:
+    - ruby-2.5.3-rails-5.1:
         context: org-global
-    - ruby-2.4.4-rails-5.1:
+    - ruby-2.4.5-rails-5.1:
         context: org-global
   scheduled:
     triggers:
@@ -92,11 +108,11 @@ workflows:
             only:
             - master
     jobs:
-    - ruby-2.5.1-rails-5.2:
+    - ruby-2.5.3-rails-5.2:
         context: org-global
-    - ruby-2.4.4-rails-5.2:
+    - ruby-2.4.5-rails-5.2:
         context: org-global
-    - ruby-2.5.1-rails-5.1:
+    - ruby-2.5.3-rails-5.1:
         context: org-global
-    - ruby-2.4.4-rails-5.1:
+    - ruby-2.4.5-rails-5.1:
         context: org-global

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.5.3

data/README.md

@@ -100,7 +100,7 @@ See [the wiki](https://github.com/stitchfix/stitches/wiki/Setup) for how to setu
   - Deprecation using the `Sunset` header
 * The [Generator](https://github.com/stitchfix/stitches/wiki/Generator) sets up some code in your app, so you can start writing
 APIs using vanilla Rails idioms:
-  - a "ping" controller that can vaidate your app is working
+  - a "ping" controller that can validate your app is working
   - version routing based on content-type (requests for V2 use the same URL, but are serviced by a different controller)
   - An ApiClient Active Record
   - Acceptance tests that can produce API documentation as they test your app.
@@ -118,5 +118,3 @@ any fancy refactors here, just keep it up to date.
 ---
 
 Provided with love by your friends at [Stitch Fix Engineering](http://technology.stitchfix.com)
-
-![stitches](https://s3.amazonaws.com/stitchfix-stitches/stitches.png)

data/lib/stitches/deprecation.rb

@@ -19,7 +19,7 @@ module Stitches
     #     end
     def deprecated(gone_on:,&block)
       response.set_header("Sunset",Date.parse(gone_on).in_time_zone("GMT").midnight.strftime("%a, %e %b %Y %H:%M:%S %Z"))
-      Rails.logger.info("Deprecated endpoint #{request.method} #{request.fullpath} requested by #{current_user.id}")
+      Rails.logger.info("DEPRECATED ENDPOINT #{request.method} to #{request.fullpath} requested by #{current_user.id}")
       block.()
     end
   end

data/lib/stitches/errors.rb

@@ -70,7 +70,7 @@ module Stitches
     def self.from_active_record_object(object)
       errors = object.errors.to_hash.map { |field,errors|
         code = "#{field}_invalid".parameterize
-        message = if object.send(field).respond_to?(:errors)
+        message = if object.respond_to?(field) && object.send(field).respond_to?(:errors)
                     object.send(field).errors.full_messages.sort.join(', ')
                   else
                     object.errors.full_messages_for(field).sort.join(', ')

data/lib/stitches/generator_files/app/controllers/api/api_controller.rb

@@ -1,10 +1,19 @@
 class Api::ApiController < ActionController::Base
   include Stitches::Deprecation
+  #
+  # The order of the rescue_from blocks is important - ActiveRecord::RecordNotFound must come after StandardError,
+  # otherwise ActiveRecord::RecordNotFound exceptions will get rescued in the StandardError block.
+  # See the documentation for rescue_from for further explanation:
+  # https://apidock.com/rails/ActiveSupport/Rescuable/ClassMethods/rescue_from
+  # Specifically, this part: "Handlers are inherited. They are searched from right to left, from bottom to top, and up
+  # the hierarchy."
+  #
+  rescue_from StandardError do |exception|
+    render json: { errors: Stitches::Errors.from_exception(exception) }, status: :internal_server_error
+  end
+
   rescue_from ActiveRecord::RecordNotFound do |exception|
-    respond_to do |type|
-      type.json { render json: { errors: Stitches::Errors.new([ Stitches::Error.new(code: "not_found", message: exception.message) ]) }, status: 404 }
-      type.all  { render :nothing => true, :status => 404 }
-    end
+    render json: { errors: Stitches::Errors.from_exception(exception) }, status: :not_found
   end
 
   def current_user

data/lib/stitches/version.rb

@@ -1,3 +1,3 @@
 module Stitches
-  VERSION = '3.7.0'
+  VERSION = '3.7.2'
 end

data/spec/deprecation_spec.rb

@@ -32,7 +32,7 @@ describe Stitches::Deprecation do
     end
     it "logs about the request and current API key id" do
       fake_controller.deprecated(gone_on: "2018-01-01") {}
-      expect(logger).to have_received(:info).with(/deprecated.*#{Regexp.escape(request.method)}.*#{Regexp.escape(request.fullpath)}.*#{Regexp.escape(api_client.id.to_s)}/i)
+      expect(logger).to have_received(:info).with(/DEPRECATED.*#{Regexp.escape(request.method)}.*#{Regexp.escape(request.fullpath)}.*#{Regexp.escape(api_client.id.to_s)}/i)
     end
     it "executes and returns the block" do
       block_executed = false

data/spec/errors_spec.rb

@@ -94,6 +94,13 @@ describe Stitches::Errors do
       expect(errors_hash[1]["code"]).to eq("person_invalid")
       expect(errors_hash[1]["message"]).to eq("Age is not a number, First name can't be blank, Last name starts with z.")
     end
+
+    it "works with nested attributes" do
+      object.errors.add("something.nested", "is required")
+      errors = Stitches::Errors.from_active_record_object(object)
+      errors_hash = JSON.parse(errors.to_json).sort_by {|_| _["code"] }
+      expect(errors_hash[0]["code"]).to eq("something-nested_invalid")
+      expect(errors_hash[0]["message"]).to eq("Something nested is required")
+    end
   end
 end
-

data/spec/integration/add_to_rails_app_spec.rb

@@ -75,6 +75,8 @@ RSpec.describe "Adding Stitches to a New Rails App", :integration do
       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")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stitches
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.7.2
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-26 00:00:00.000000000 Z
+date: 2019-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -210,8 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: You'll be in stitches at how easy it is to create a service at Stitch Fix