we-call 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b5f8847896e17a2fec34ca12c0f3de5ac7a3462
-  data.tar.gz: 40f62ebf46c1096cdbb427e9b59314c5cc9b108b
+  metadata.gz: f216ee9568b578d28b28ed06cdb66026434ac417
+  data.tar.gz: b5f3d4649b197e500418a9c2c944d32034349967
 SHA512:
-  metadata.gz: 5b3df1717cb053439ce90d57ce8087014959a47a65ac7b8ea42edf0dc15cbd672f60d0487076a0d3f5c2f30cbfe17711fc53d9e23946ac7a911f0886ec5edb9c
-  data.tar.gz: 28867ed3ab8fc0c9583ce732b288d81fcc50f9e1c802190da690f3ac9727b7074f18e337f3bb890c9cf82736da1e6183b8c45d3c76650e58703c3b42caf9a312
+  metadata.gz: 790f8208d3af59d25eec530ef10569404203bc130075eed55aa9cae5e41981a417b4f8d30c6c67d9134d66fbc0c645524b0d6db088c266a6d8a44d45384b0449
+  data.tar.gz: fe36b03580abac7af2cfc9461bb22a36b183a39696394032daae47e4a09a5deb039fd0bf4380ea2bfd8a21c88da49afb1966be77994e1879a46e926f7e698272

data/CHANGELOG

@@ -5,7 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## Unreleased
+## v0.5.2
+
+### Fixed
+
+- Made Annotations require "ruby_decorators"
+
+## v0.5.1
+
+### Changed
+
+- Switched `config.detect_deprecations` from bool to expect `:active_support` or logger instance
+- Moved `We::Call::Middleware::Client::DetectDeprecations` into its own [faraday-sunset] gem (no BC breaks)
+
+[faraday-sunset]: https://github.com/philsturgeon/faraday-sunset
+
+## v0.5.0
 
 ### Added
 - Configurable `We::Call.configure` which accepts a config block

data/README.md

@@ -6,7 +6,9 @@
 
 ![Call me Maybe](https://cloud.githubusercontent.com/assets/67381/25590846/0c3145ea-2e80-11e7-9166-76448e0134a8.jpeg)
 
-Requires metadata and offers client/server middleware for making HTTP requests, tracking calls, raising deprecations, supporting trace IDs, throttling, etc.
+Requires metadata and offers client/server middleware to help debug HTTP calls, raise warnings for deprecations, supporting trace IDs, etc.
+
+It aims to arm API developers and users with tools to make their calls more robust, and enforces Good Ideas™ with sane defaults whenever possible.
 
 ## Goals
 
@@ -146,7 +148,7 @@ Easy! Check your logs for `user_agent=service-name; app_name=service-name;` The
 
 - **Ruby:** v2.2 - v2.4
 - **Rails:** v4.2 - v5.1
-- **Faraday:** v0.8 - v0.13
+- **Faraday:** v0.9 - v0.13
 
 _For now this gem requires Rails 4.2+ due to some ActiveController functionality we are taking advantage of. Future work will include making this purely rack based._
 
@@ -154,10 +156,12 @@ _For now this gem requires Rails 4.2+ due to some ActiveController functionality
 
 - [ ] Support adding href to Deprecate to make a `Link` with rel=sunset as per Sunset RFC draft 03
 - [ ] Remove Rails as a dependency (soft requirement on `ActiveSupport::Deprecated` is fine)
-- [ ] Split DetectDeprecations into standalone `faraday-sunset` gem
+- [x] Split DetectDeprecations into standalone [faraday-sunset] gem
 - [ ] Pass Trace IDs along
 - [ ] Work on sane defaults for retries and error raising
 
+[faraday-sunset]: https://github.com/philsturgeon/faraday-sunset
+
 ## Testing
 
 To run tests and modify locally, you'll want to `bundle install` in this directory.
@@ -182,8 +186,8 @@ Bug reports and pull requests are welcome on GitHub at [wework/we-call](https://
 [coveralls-image]:https://coveralls.io/repos/github/wework/we-call/badge.svg?branch=master
 [coveralls-url]:https://coveralls.io/github/wework/we-call?branch=master
 
-[travis-url]:https://travis-ci.org/wework/we-js-logger
-[travis-image]: https://travis-ci.org/wework/we-js-logger.svg?branch=master
+[travis-url]:https://travis-ci.org/wework/we-call
+[travis-image]: https://travis-ci.org/wework/we-call.svg?branch=master
 
 [license-url]: LICENSE
 [license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square

data/lib/we/call/annotations.rb

@@ -1,3 +1,5 @@
+require "ruby_decorators"
+
 module We
   module Call
     module Annotations

data/lib/we/call/configuration.rb

@@ -9,7 +9,7 @@ module We
       def initialize
         @app_env_header = 'X-App-Env'
         @app_name_header = 'X-App-Name'
-        @detect_deprecations = true
+        @detect_deprecations = :active_support
       end
     end
   end

data/lib/we/call/connection.rb

@@ -1,11 +1,9 @@
 require 'faraday'
-require 'faraday_middleware'
+require 'faraday-sunset'
 
 module We
   module Call
     module Connection
-      Faraday::Response.register_middleware detect_deprecations: We::Call::Middleware::Client::DetectDeprecations
-
       extend self
 
       OPEN_TIMEOUT = 2
@@ -51,7 +49,7 @@ module We
       def create
         builder = QueryableBuilder.new(&Proc.new { |_| })
 
-        ::Faraday.new(url: host, builder: builder) do |faraday|
+        Faraday.new(url: host, builder: builder) do |faraday|
           faraday.headers['User-Agent'] = app
           faraday.headers[config.app_name_header] = app
           faraday.headers[config.app_env_header] = env
@@ -59,11 +57,7 @@ module We
           faraday.options[:open_timeout] = open_timeout
 
           if config.detect_deprecations
-            if defined? ActiveSupport::Deprecation
-              faraday.response :detect_deprecations, active_support: true
-            else
-              faraday.response :detect_deprecations, logger: ENV['rack.logger']
-            end
+            faraday.response :sunset, setup_sunset_middleware(faraday)
           end
 
           yield faraday if block_given?
@@ -92,6 +86,17 @@ module We
         raise MissingOpenTimeout, 'open_timeout must be set, and defaults to 1 second. This is the time until a connection is established with another server, and after 1 sec it\'s probably not there.'
       end
 
+      def setup_sunset_middleware(faraday)
+        # In v0.5.0 this was a bool switch, now it takes :active_support or an instance of a Logger
+        if config.detect_deprecations == true || config.detect_deprecations == :active_support
+          return { active_support: true }
+
+        # Pass something that might be a logger or anything with a warn method
+        elsif config.detect_deprecations.respond_to?(:warn)
+          return { logger: config.detect_deprecations }
+        end
+      end
+
       # @return [String] Environment (usually 'development', 'staging', 'production', etc.)
       def guess_env
         return config.app_env if config.app_env

data/lib/we/call/deprecated.rb

@@ -3,22 +3,22 @@ require "ruby_decorators"
 module We
   module Call
     class Deprecated < RubyDecorator
-      @@methods = {}
+      class << self
+        private def methods
+          @methods ||= {}
+        end
+      end
 
       def initialize(date:)
         @date = date
       end
 
       def set(method, value)
-        @@methods[method] = value
+        self.class.methods[method] = value
       end
 
       def self.get(method)
-        @@methods[method]
-      end
-
-      def self.methods
-        @@methods
+        methods[method]
       end
 
       # Called when annotation is used

data/lib/we/call/middleware.rb

@@ -1,7 +1,6 @@
 module We
   module Call
     module Middleware
-      autoload :Client, 'we/call/middleware/client'
       autoload :Server, 'we/call/middleware/server'
     end
   end

data/lib/we/call/version.rb

@@ -1,5 +1,5 @@
 module We
   module Call
-    VERSION = "0.5.0"
+    VERSION = "0.5.2"
   end
 end

data/we-call.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["WeWork Engineering"]
   spec.email         = ["engineering@wework.com"]
 
-  spec.summary       = "Making healthy happy HTTP calls"
+  spec.summary       = "Making healthy, happy HTTP calls"
   spec.description   = "Handles conventions of making calls to other services, with required metadata for tracking calls between services, deprecations of endpoints, trace IDs, throttling, etc."
   spec.homepage      = "https://github.com/wework/we-call-gem"
   spec.licenses      = ['MIT']
@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   end
   spec.bindir               = "bin"
   spec.require_paths        = ["lib"]
-  spec.metadata["yard.run"] = "yri"
 
   spec.add_dependency "faraday", ">= 0.9.0", "< 0.14"
   spec.add_dependency "faraday_middleware", '~> 0'
+  spec.add_dependency "faraday-sunset", "~> 0.1.0"
   spec.add_dependency "ruby_decorators", '~> 0.0'
   spec.add_dependency "rails", ">= 4.2"
 
@@ -33,7 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "simplecov", '~> 0.15'
   spec.add_development_dependency "hashie", "~> 3.5"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "yard"
   spec.add_development_dependency "vcr", '~> 3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: we-call
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - WeWork Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-sunset
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: ruby_decorators
   requirement: !ruby/object:Gem::Requirement
@@ -170,34 +184,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -240,8 +226,6 @@ files:
 - lib/we/call/connection.rb
 - lib/we/call/deprecated.rb
 - lib/we/call/middleware.rb
-- lib/we/call/middleware/client.rb
-- lib/we/call/middleware/client/detect_deprecations.rb
 - lib/we/call/middleware/server.rb
 - lib/we/call/middleware/server/log_user_agent.rb
 - lib/we/call/version.rb
@@ -249,8 +233,7 @@ files:
 homepage: https://github.com/wework/we-call-gem
 licenses:
 - MIT
-metadata:
-  yard.run: yri
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -270,5 +253,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Making healthy happy HTTP calls
+summary: Making healthy, happy HTTP calls
 test_files: []

data/lib/we/call/middleware/client/detect_deprecations.rb

@@ -1,58 +0,0 @@
-# This class is going to be split into its own faraday-sunset soon, but I want to get the functionality nailed first
-module We
-  module Call
-    module Middleware
-      module Client
-        class DetectDeprecations < Faraday::Middleware
-          class NoOutputForWarning < StandardError; end
-
-          # Initialize the middleware
-          #
-          # @param [Type] app describe app
-          # @param [Hash] options = {}
-          # @return void
-          def initialize(app, options = {})
-            super(app)
-            @options = options
-          end
-
-          # @param [Faraday::Env] no idea what this does
-          # @return [Faraday::Response] response from the middleware
-          def call(env)
-            @app.call(env).on_complete do |response_env|
-              datetime = sunset_header(response_env.response_headers)
-              report_deprecated_usage(env, datetime) unless datetime.nil?
-            end
-          end
-
-          protected
-
-          # Check to see if there is a Sunset header, which contains deprecation date
-          #
-          # @param [Faraday::Response] response object with headers and whatnot
-          # @return [DateTime|nil] date time object of the expected deprecation date
-          def sunset_header(headers)
-            return if headers[:sunset].nil?
-            DateTime.parse(headers[:sunset])
-          end
-
-          def report_deprecated_usage(env, datetime)
-            if datetime > DateTime.now
-              warning = "Endpoint #{env.url} is deprecated for removal on #{datetime.iso8601}"
-            else
-              warning = "Endpoint #{env.url} was deprecated for removal on #{datetime.iso8601} and could be removed AT ANY TIME"
-            end
-
-            if @options[:active_support]
-              ActiveSupport::Deprecation.warn(warning)
-            elsif @options[:logger] && @options[:logger].respond_to?(:warn)
-              @options[:logger].warn(warning)
-            else
-              raise NoOutputForWarning, "Pass active_support: true or logger: SomeLoggerWithWriteMethod when registering middleware"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/we/call/middleware/client.rb

@@ -1,9 +0,0 @@
-module We
-  module Call
-    module Middleware
-      module Client
-        autoload :DetectDeprecations, "we/call/middleware/client/detect_deprecations"
-      end
-    end
-  end
-end