we-call 0.7.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30bad41ed6b34f69292a161663ef04653ae592ec
-  data.tar.gz: a8d187c323a32f8c73172ee0ab949f76540f3704
+SHA256:
+  metadata.gz: dbf74dcbe416b443f5822de5e4dc5244b5448184263b9956329cb6c1129870ed
+  data.tar.gz: 58f39eb8e256d379360452dcc60debe784d5817d74f2215dae9b1f30a5c2d6ac
 SHA512:
-  metadata.gz: 639f9f9c2c1d5d01435c0e3a293ae27236a48a83dd456438662c3829fcf04d0b032356b52a9af933b41c616420e84e3a879cd7df4418230ecea2977359006bd8
-  data.tar.gz: e4aa1848b875d23a53510066e7b8ca199e7278a84d92fb76ed3e711e513546c978cdc0942e2888ff106e7225fdba4aa48da9c074b7fe6d1093b662ed6aa9bc82
+  metadata.gz: '0875da2fd0d502d5eceaf7f9121242adee5ac7884854edf6bddcd75b06572286e86520e39af3c6ef7a9ad46eec9e7f06c1ee52370bc8b3d5d2ca75549fed8da0'
+  data.tar.gz: 37068e825ace749bfdb15165df035024ccd541278b2fa4f1911e307c1ecfbc1cedf298db41c2df5f365b1fe45cec30a60612338c6206c31205ee511b0d715457

data/.circleci/config.yml

@@ -0,0 +1,42 @@
+version: 2.1
+
+x-shared: &x-shared
+  docker:
+    - image: circleci/ruby:2.6.3-stretch-node
+
+jobs:
+  build:
+    <<: *x-shared
+    steps:
+      - checkout
+      - run:
+          name: Build
+          command: ./script/cibuild
+      - persist_to_workspace:
+          root: .
+          paths: .
+  publish-gem:
+    <<: *x-shared
+    steps:
+      - attach_workspace:
+          at: ~/project # circleci default working directory
+      - run:
+          name: Publish Gem
+          command: ./script/publish_gem
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build:
+          filters:
+            tags:
+              only: /v[0-9]+(\.[0-9]+)+/
+      - publish-gem:
+          requires:
+            - build
+          filters:
+            branches:
+              ignore:
+                - /.*/
+            tags:
+              only: /v[0-9]+(\.[0-9]+)+/

data/.coveralls.yml

@@ -1 +1 @@
-service_name: travis-ci
+service_name: circleci

data/.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ $default-branch ]
+  pull_request:
+    branches: [ $default-branch ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Generate gemfiles
+      run: bundle exec appraisal install
+    - name: Run tests
+      run: bundle exec appraisal rspec

data/.travis.yml

@@ -6,18 +6,21 @@ before_script:
 script:
   - bundle exec appraisal rspec
 gemfiles:
-  - faraday_0.9.gemfile
   - faraday_0.10.gemfile
   - faraday_0.11.gemfile
   - faraday_0.12.gemfile
   - faraday_0.13.gemfile
+  - faraday_0.15.gemfile
+  - faraday_0.14.gemfile
   - rails_4.2.gemfile
   - rails_5.0.gemfile
   - rails_5.1.gemfile
+  - rails_5.2.gemfile
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
   - ruby-head
 matrix:
   allow_failures:

data/Appraisals

@@ -1,3 +1,11 @@
+appraise "faraday-0.15" do
+  gem "faraday", "~> 0.15.0"
+end
+
+appraise "faraday-0.14" do
+  gem "faraday", "~> 0.14.0"
+end
+
 appraise "faraday-0.13" do
   gem "faraday", "~> 0.13.0"
 end
@@ -14,8 +22,8 @@ appraise "faraday-0.10" do
   gem "faraday", "~> 0.10.0"
 end
 
-appraise "faraday-0.9" do
-  gem "faraday", "~> 0.9.0"
+appraise "rails-5.2" do
+  gem "rails", "~> 5.2.0"
 end
 
 appraise "rails-5.1" do

data/CHANGELOG.md

@@ -5,6 +5,43 @@ 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.12.0] - 2020-12-17
+### Added
+- Bump version to fix incorrect tag
+
+## [v0.11.0] - 2020-12-08
+### Added
+- Allow to set retry options on a connection([#36])
+
+
+## [v0.9.1] - 2020-11-20
+### Added
+- Automatically retry on network errors([#31])
+
+[activesupport]: https://github.com/rails/rails/tree/master/activesupport
+[#31]: https://github.com/wework/we-call-gem/pull/31
+
+## [v0.9.0] - 2018-09-18
+### Added
+- Automatically reports deprecations to ActiveSupport if [activesupport] gem exists ([#21])
+- Defaults detect_deprecations to nil instead of :active_support
+
+[activesupport]: https://github.com/rails/rails/tree/master/activesupport
+[#21]: https://github.com/wework/we-call-gem/pull/21
+
+## [v0.8.0] - 2018-08-27
+### Added
+- Support for Ruby v2.5
+- Support for Rails v5.2
+- Support for Faraday v0.14 and v0.15
+- Automatically reports deprecations to Rollbar if [rollbar] gem exists ([#17])
+
+[rollbar]: https://github.com/rollbar/rollbar-gem
+[#17]: https://github.com/wework/we-call-gem/pull/17
+
+### Breaking
+- Dropped support for Faraday v0.9 (may still work but its no longer tested or recommended)
+
 ## [v0.7.1] - 2018-02-20
 ### Fixed
 - Call the gzip middleware to handle gzipped responses, which have been broken since v0.7 for typhoeus users

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+ruby '~> 2.2'
+
 # Specify your gem's dependencies in we-call.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # We::Call
 
-[![Build Status][travis-image]][travis-url]
+[![Build Status][ci-image]][ci-url]
 [![Coverage Status][coveralls-image]][coveralls-url]
 [![MIT License][license-image]][license-url]
 
@@ -102,6 +102,42 @@ As well as `timeout: num_seconds` which can set the entire open/read (essentiall
 
 ### Client
 
+**Retry**
+
+Automatically enabled, the retry middleware will retry the request in case of network errors. By default, the middleware will retry up to 3 times, waiting 1 second between the retries.
+
+Disable the middleware:
+
+```ruby
+We::Call.configure do |config|
+  config.retry = false
+end
+
+# Provided at initialization
+connection = We::Call::Connection.new(retry_options: false)
+```
+
+Adjust the middleware:
+
+```ruby
+We::Call.configure do |config|
+  config.retry_options = { interval: 0.5 }
+end
+
+# Provided at initialization
+connection = We::Call::Connection.new(retry_options: { interval: 0.5 })
+```
+
+The gem smartly merges the options passed, so you can specify your own list of exceptions without being afraid to override the default ones:
+
+```ruby
+We::Call.configure do |config|
+  config.retry_options = { exceptions: [Faraday::ResourceNotFound] }
+end
+```
+
+Check [Faraday's Retry Docs](https://github.com/lostisland/faraday/blob/master/docs/middleware/request/retry.md) for a list of available options.
+
 **DetectDeprecations**
 
 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']`.
@@ -122,9 +158,10 @@ Easy! Check your logs for `user_agent=service-name; app_name=service-name;` The
 
 ## Requirements
 
-- **Ruby:** v2.2 - v2.4
-- **Faraday:** v0.9 - v0.13
+- **Ruby:** v2.2 - v2.5
+- **Faraday:** v0.10 - v0.15
 
+_**Note:** Other versions of Faraday may work, but we can't test against all of them forever._
 
 ## TODO
 
@@ -154,10 +191,10 @@ Bug reports and pull requests are welcome on GitHub at [wework/we-call](https://
 
 
 [coveralls-image]:https://coveralls.io/repos/github/wework/we-call-gem/badge.svg?branch=master
-[coveralls-url]:https://coveralls.io/github/wework/we-call-gem?branch=master
+[coveralls-url]:https://coveralls.io/github/wework/we-call-gem?branch=main
 
-[travis-url]:https://travis-ci.org/wework/we-call-gem
-[travis-image]: https://travis-ci.org/wework/we-call-gem.svg?branch=master
+[ci-url]:https://app.circleci.com/pipelines/github/wework/we-call-gem
+[ci-image]:https://circleci.com/gh/wework/we-call-gem.svg?style=shield
 
 [license-url]: LICENSE
 [license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square

data/lib/we/call/configuration.rb

@@ -4,12 +4,14 @@ require 'faraday_middleware'
 module We
   module Call
     class Configuration
-      attr_accessor :app_env, :app_env_header, :app_name, :app_name_header, :detect_deprecations
+      attr_accessor :app_env, :app_env_header, :app_name, :app_name_header, :detect_deprecations,
+                    :retry, :retry_options
 
       def initialize
         @app_env_header = 'X-App-Env'
         @app_name_header = 'X-App-Name'
-        @detect_deprecations = :active_support
+        @retry = true
+        @retry_options = {}
       end
     end
   end

data/lib/we/call/connection.rb

@@ -14,6 +14,12 @@ module We
       DEFAULT_ADAPTER_CLASS = Faraday::Adapter::Typhoeus
       DEFAULT_ADAPTER = :typhoeus
 
+      DEFAULT_RETRY_OPTIONS = {
+        max: 3,
+        interval: 1,
+        exceptions: [Faraday::ConnectionFailed, Faraday::TimeoutError]
+      }
+
       class MissingApp < ArgumentError; end
       class MissingEnv < ArgumentError; end
       class MissingTimeout < ArgumentError; end
@@ -40,8 +46,9 @@ module We
       # @param [String] app
       # @param [String] env
       # @yieldparam [Faraday::Connection] Faraday connection object is yielded to a block
-      def new(host:, timeout: nil, open_timeout: OPEN_TIMEOUT, app: guess_app, env: guess_env, &block)
+      def new(host:, timeout: nil, open_timeout: OPEN_TIMEOUT, app: guess_app, env: guess_env, retry_options: {}, &block)
         @host = host
+        @retry_options = retry_options
         @app = app or raise_missing_app!
         @env = env or raise_missing_env!
         @timeout = timeout or raise_missing_timeout!
@@ -51,7 +58,7 @@ module We
 
       private
 
-      attr_reader :app, :env, :host, :timeout, :open_timeout
+      attr_reader :app, :env, :host, :timeout, :open_timeout, :retry_options
 
       # @return [Faraday::Connection] Preconfigured Faraday Connection object, for hitting get, post, etc.
       def create
@@ -72,6 +79,9 @@ module We
           if config.detect_deprecations
             faraday.response :sunset, setup_sunset_middleware(faraday)
           end
+          if should_retry?
+            faraday.request :retry, fetch_retry_options
+          end
 
           yield faraday if block_given?
 
@@ -110,13 +120,27 @@ module We
       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 }
-
+        options = { rollbar: :auto, active_support: :auto }
         # 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 }
+        if config.detect_deprecations.respond_to?(:warn)
+          options = options.merge({ logger: config.detect_deprecations })
+        end
+        options
+      end
+
+      def should_retry?
+        retry_options.any? || config.retry
+      end
+
+      def fetch_retry_options
+        client_options = retry_options.any? ? retry_options : config.retry_options
+
+        DEFAULT_RETRY_OPTIONS.merge(client_options) do |key, default_val, new_val|
+          if key == :exceptions
+            default_val + Array(new_val)
+          else
+            new_val
+          end
         end
       end
 

data/lib/we/call/version.rb

@@ -1,5 +1,5 @@
 module We
   module Call
-    VERSION = "0.7.1"
+    VERSION = '0.12.0'
   end
 end

data/script/cibuild

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+cd "$(dirname "$0")/.."
+
+bundle install
+bundle exec appraisal install
+bundle exec appraisal rspec

data/script/publish_gem

@@ -0,0 +1,18 @@
+#!/bin/bash
+set -eox pipefail
+
+mkdir -p ~/.gem
+echo :rubygems_api_key: $RUBYGEMS_APIKEY > ~/.gem/credentials
+chmod 0600 ~/.gem/credentials
+
+VERSION_FILE="lib/we/call/version.rb"
+if [[ -n $CIRCLE_TAG ]]; then
+  # Determine the version from the tag; remove the leading v "v3.3.0" -> "3.3.0"
+  VERSION=$(echo "${CIRCLE_TAG}" | sed 's/^v//')
+  # Replace the version for the gemspec with the tag version
+  sed -i.bak -E "s/VERSION = .*/VERSION = '$VERSION'/" $VERSION_FILE
+fi
+
+gem build *.gemspec
+
+gem push *.gem

data/we-call.gemspec

@@ -23,15 +23,15 @@ Gem::Specification.new do |spec|
   spec.add_dependency "typhoeus", "~> 1.3"
   spec.add_dependency "faraday", ">= 0.9.0", "< 1"
   spec.add_dependency "faraday_middleware", '~> 0.10'
-  spec.add_dependency "faraday-sunset", "~> 0.1.0"
+  spec.add_dependency "faraday-sunset", '~> 0.2'
 
   spec.add_development_dependency "appraisal", "~> 2.0"
-  spec.add_development_dependency "coveralls", '~> 0.7'
+  spec.add_development_dependency "coveralls_reborn", '~> 0.13'
   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"
-  spec.add_development_dependency "vcr", '~> 3.0'
+  spec.add_development_dependency "vcr", '~> 4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: we-call
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.12.0
 platform: ruby
 authors:
 - WeWork Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -87,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +190,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 description: Handles conventions of making calls to other services, with required
   metadata for tracking calls between services, deprecations of endpoints, trace IDs,
   throttling, etc.
@@ -207,7 +207,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".coveralls.yml"
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -227,6 +229,8 @@ files:
 - lib/we/call/middleware/server.rb
 - lib/we/call/middleware/server/log_user_agent.rb
 - lib/we/call/version.rb
+- script/cibuild
+- script/publish_gem
 - we-call.gemspec
 homepage: https://github.com/wework/we-call-gem
 licenses:
@@ -247,8 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Making healthy, happy HTTP calls