we-call 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 818658bcfaa76714ed892bce20c4b898c227f491
-  data.tar.gz: 5900aa3642e7e4974bfb009c3e72fb3f16b6392a
+  metadata.gz: 2f6b6c396092e080b179bf2811abd96992fd7e1a
+  data.tar.gz: f3d35f54e93e60b405e28a732766155d2110d209
 SHA512:
-  metadata.gz: a46856d6ab8cef1860042add50972268f75f335a63c3d86389ab9ad202d8ead4559b25392d995a3c7f7b41ed969b9f2283f395e087a18ed3c47059f0eeaebb4a
-  data.tar.gz: fa184f54408630869ab3429d59cffc9e8d1d8ea59afe9f1a2b71550a603d82840f29683ea4e2e4f09c0217e2b86aca475f8bf084ac6381076de725f70ecd5727
+  metadata.gz: aa4b02af461ee342404ba0bd2ef959cbd1728cc89208fa1574fe6510b8daa85e80aa9111fe04729c57124ad2bae0bdaa736bddb800755affa0b484bfa457efe1
+  data.tar.gz: b13a9ecdc979fdddc1d1cd3fd3be82eac6288d9be470e54414c46b3e2f7b39c261a0725a91bab51ab74578581fcade181295cb953e1ce6311057e3b6d7aa82a9

data/CHANGELOG.md

@@ -5,46 +5,49 @@ 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/).
 
-## v0.6.1
+## [v0.7.0] - 2017-10-07
+### Breaking Changes
+- Removed `We::Call::Deprecated` and `We::Call::Annotations`. Deprecation logic is now handled by [rails-sunset] instead. I fully understand the irony of removing deprecation logic without deprecation
+
+[rails-sunset]: https://github.com/wework/rails-sunset
+
+## [v0.6.1] - 2017-10-03
 ### Fixed
 - Required typhoeus in We::Call instead of connection, which loads it early enough for NewRelic tracing to kick in if you use that
 
 ### Changed
 - Reduced open timeout default to 1 second
 
-### Changed
-- Reduced open timeout default to 1 second
-
-## v0.6.0
+## [v0.6.0]
 ### Changed
 - Use typhoeus instead of NetHTTP for a [series of reasons]
 
 [typhoeus]: https://github.com/typhoeus/typhoeus
 [series of reasons]: https://github.com/wework/we-call-gem/pull/7
 
-## v0.5.4
+## [v0.5.4]
 ### Fixed
 - Connection checks `Rails.env` instead of `ENV['RAILS_ENV']` as most people dont have RAILS_ENV in their `.env` file
 
-## v0.5.3
+## [v0.5.3]
 
 ### Fixed
 - Deprecations were calling a private method and failing
 
-## v0.5.2
+## [v0.5.2]
 
 ### Fixed
 - Made Annotations require "ruby_decorators"
 
-## v0.5.1
+## [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
+[faraday-sunset]: https://github.com/wework/faraday-sunset
 
-## v0.5.0
+## [v0.5.0]
 
 ### Added
 - Configurable `We::Call.configure` which accepts a config block
@@ -60,17 +63,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 - Switched from manually requiring to using module autoload to reduce memory footprint
 
-## v0.4.2
+## [v0.4.2]
 
 ### Fixed
 - Manually setting `conn.adapter` would result in double adapters (two requests made!)
 
-## v0.4.1
+## [v0.4.1]
 
 ### Fixed
 - Improved support for Faraday 0.8 - 0.9.
 
-## v0.4.0
+## [v0.4.0]
 
 ### Added
 - `We::Call::Connection.new` requires `timeout: 1` where 1 is seconds.

data/README.md

@@ -97,32 +97,6 @@ Timeouts can only be provided at initialization of a connection, as they should
 
 As well as `timeout: num_seconds` which can set the entire open/read (essentially the total response time of the server), another optional argument exists for `open_timeout: numseconds`. This is how long We::Call should spend waiting for a vague sign of life from the server, which by default is 1.
 
-### Deprecations
-
-We::Call helps with a bunch of things, such as the logic to go on client and server side to handle deprecations, both logging calls made to this servies deprecated endpoints, and alerting services when they make calls to deprecated endpoints.
-
-Currently this is done using a simple annotation.
-
-```ruby
-# app/controllers/api_controller.rb
-
-extend We::Call::Annotations
-```
-
-Then a controller can be annotated as such:
-
-```ruby
-# app/controllers/foo_controller.rb
-
-class FooController < ApiController
-  +We::Call::Deprecated.new(date: '2018-01-07 00:00:00 EDT')
-  def show
-    # ...
-  end
-end
-```
-
-It's as simple as that. This annotation will inject a [Sunset header](https://tools.ietf.org/html/draft-wilde-sunset-header-03) and everyone will know its being deprecated.
 
 ## Middleware
 
@@ -130,7 +104,9 @@ It's as simple as that. This annotation will inject a [Sunset header](https://to
 
 **DetectDeprecations**
 
-Automatically enabled, this Faraday middleware will watch for the [Sunset header](https://tools.ietf.org/html/draft-wilde-sunset-header-03) and send warning to `ActiveSupport::Deprecation` if enabled, or to whatever is in `ENV['rake.logger']`.
+Automatically enabled, the faraday-sunset middleware will watch for the [Sunset header](https://tools.ietf.org/html/draft-wilde-sunset-header-03) and send warning to `ActiveSupport::Deprecation` if enabled, or to whatever is in `ENV['rake.logger']`.
+
+[faraday-sunset]: https://github.com/wework/faraday-sunset
 
 ### Server
 
@@ -147,19 +123,14 @@ Easy! Check your logs for `user_agent=service-name; app_name=service-name;` The
 ## Requirements
 
 - **Ruby:** v2.2 - v2.4
-- **Rails:** v4.2 - v5.1
 - **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._
 
 ## TODO
 
-- [ ] 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)
 - [x] Split DetectDeprecations into standalone [faraday-sunset] gem
 - [ ] Work on sane defaults for retries and error raising
 
-[faraday-sunset]: https://github.com/philsturgeon/faraday-sunset
 
 ## Testing
 

data/lib/we/call/version.rb

@@ -1,5 +1,5 @@
 module We
   module Call
-    VERSION = "0.6.1"
+    VERSION = "0.7.0"
   end
 end

data/we-call.gemspec

@@ -24,13 +24,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday", ">= 0.9.0", "< 1.0"
   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"
 
   spec.add_development_dependency "appraisal", "~> 2"
   spec.add_development_dependency "coveralls", '~> 0.7'
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rails", ">= 4.2"
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "simplecov", '~> 0.15'
   spec.add_development_dependency "hashie", "~> 3.5"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: we-call
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - WeWork Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2017-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -72,34 +72,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
-- !ruby/object:Gem::Dependency
-  name: ruby_decorators
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -235,10 +221,8 @@ files:
 - bin/setup
 - lib/we-call.rb
 - lib/we/call.rb
-- lib/we/call/annotations.rb
 - lib/we/call/configuration.rb
 - lib/we/call/connection.rb
-- lib/we/call/deprecated.rb
 - lib/we/call/middleware.rb
 - lib/we/call/middleware/server.rb
 - lib/we/call/middleware/server/log_user_agent.rb

data/lib/we/call/annotations.rb

@@ -1,36 +0,0 @@
-require "ruby_decorators"
-
-module We
-  module Call
-    module Annotations
-      # Enable annotations
-      include RubyDecorators
-
-      def self.extended(base)
-        base.class_eval do
-          # TODO Maybe this after_action could be a really simple call in base controllers
-          # Having it here obviously ties We::Call to Rails, and is probably more than the annotations
-          # class should be doing
-          after_action do |controller|
-
-            # TODO Maybe controller.class and params action could be passed to something in We::Call::Deprecated
-            klass = controller.class
-            method = params['action']
-            deprecation = We::Call::Deprecated.get("#{klass}##{method}")
-
-            if deprecation.present?
-              # Shove a deprecation warning into the console or wherever it goes
-              if defined? ActiveSupport
-                ActiveSupport::Deprecation.warn("#{klass}##{method} is deprecated for removal on #{deprecation[:date].iso8601}")
-              end
-
-              # Shove a Sunset header into HTTP Response for clients to sniff on
-              # https://tools.ietf.org/html/draft-wilde-sunset-header-03
-              response.headers['Sunset'] = deprecation[:date].httpdate
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/we/call/deprecated.rb

@@ -1,40 +0,0 @@
-require "ruby_decorators"
-
-module We
-  module Call
-    class Deprecated < RubyDecorator
-      class << self
-        def methods
-          @methods ||= {}
-        end
-      end
-
-      def initialize(date:)
-        @date = date
-      end
-
-      def set(method, value)
-        self.class.methods[method] = value
-      end
-
-      def self.get(method)
-        methods[method]
-      end
-
-      # Called when annotation is used
-      def call(this, *args, &blk)
-        set("#{this.owner}##{this.name}", date: normalize_datetime(@date))
-        this.call(*args, &blk)
-      end
-
-      protected
-
-      def normalize_datetime(datetime)
-        datetime = DateTime.parse(datetime) if datetime.is_a? String
-        datetime = datetime.to_datetime if datetime.respond_to? :to_datetime
-        return datetime if datetime.respond_to? :httpdate
-        raise TypeError, 'The date should be a Date, DateTime, Time or string containing a valid date and time'
-      end
-    end
-  end
-end