faraday-sunset 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca7a69dd039247efb627b578875fcc563caa08b5
+  data.tar.gz: e9bf16a1868e2ad2cf37716a30e708559f9abbb8
+SHA512:
+  metadata.gz: 4619ad82d7c72aeee7acb90c8c8ab1cad4919d234247f0dce99bf4a52075ce24f29aec26f2ac85e971cb9656760ea010296880c47c13d0d7e52c50118e6cea5a
+  data.tar.gz: 2644f3e42f0ba14b4193ae9e82d01b2d35f0a69348b3b654e77874e6f685b49430cea63e394551873c13488cc4a3657a22f89db10b6f21cb4fe5a29a33cf47f4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 WeWork Projects
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Faraday Sunset
+
+[![Build Status][travis-image]][travis-url]
+[![Coverage Status][coveralls-image]][coveralls-url]
+[![MIT License][license-image]][license-url]
+
+Watch out for Sunset headers on HTTP responses, as they signify the deprecation (and eventual removal) of an endpoint.
+
+## Usage
+
+Add gem to Gemfile:
+
+```ruby
+gem 'faraday-sunset'
+```
+
+Enabling Sunset detection is as simple as referencing the middleware in your Faraday connection block:
+
+``` ruby
+connection = Faraday::Connection.new(url: '...') do |conn|
+  conn.response :sunset, active_support: true
+  # or
+  conn.response :sunset, logger: Rails.logger
+end
+```
+
+You can [configure `ActiveSupport::Deprecation`](TODO LINK TO DOCS) to warn in a few different ways, or pass in any object that acts a bit like a Rack logger, Rails logger, or anything with a `warn` method that takes a string.
+
+## Requirements
+
+- **Ruby:** v2.2 - v2.4
+- **Faraday:** v0.8 - v0.13
+
+## TODO
+
+- [ ] Surface `Link` with rel=sunset as per Sunset RFC draft 03
+
+## Testing
+
+To run tests and modify locally, you'll want to `bundle install` in this directory.
+
+```
+bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [philsturgeon/faraday-sunset](https://github.com/philsturgeon/faraday-sunset). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+[coveralls-image]:https://coveralls.io/repos/github/philsturgeon/faraday-sunset/badge.svg?branch=master
+[coveralls-url]:https://coveralls.io/github/philsturgeon/faraday-sunset?branch=master
+
+[travis-url]:https://travis-ci.org/philsturgeon/faraday-sunset
+[travis-image]: https://travis-ci.org/philsturgeon/faraday-sunset.svg?branch=master
+
+[license-url]: LICENSE
+[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square

data/lib/faraday-sunset.rb

@@ -0,0 +1 @@
+require 'faraday/sunset'

data/lib/faraday/sunset.rb

@@ -0,0 +1,64 @@
+require 'faraday'
+
+module Faraday
+  class Sunset < Faraday::Middleware
+    class NoOutputForWarning < StandardError; end
+
+    # Initialize the middleware
+    #
+    # @param [Type] app describe app
+    # @param [Hash] options = {}
+    # @return void
+    def initialize(app, active_support: nil, logger: nil)
+      super(app)
+      @active_support = active_support
+      @logger = logger
+    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
+      send_warning!(warning)
+    end
+
+    def send_warning!(warning)
+      warned = false
+      if @active_support
+        ActiveSupport::Deprecation.warn(warning)
+        warned = true
+      end
+      if @logger && @logger.respond_to?(:warn)
+        @logger.warn(warning)
+        warned = true
+      end
+      unless warned
+        raise NoOutputForWarning, "Pass active_support: true, or logger: ::Logger.new when registering middleware"
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware sunset: Faraday::Sunset

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: faraday-sunset
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Phil Sturgeon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: Faraday middleware that sniffs responses for Sunset headers
+email:
+- me@philsturgeon.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/faraday-sunset.rb
+- lib/faraday/sunset.rb
+homepage: https://github.com/philsturgeon/faraday-sunset
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Automatically detect deprecated HTTP endpoints
+test_files: []