we-call 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f43c92c0bef85414c9bc30d6a6e36000a608e08d
-  data.tar.gz: afe98f764a7d361dbe7c4780532fd88a55285014
+SHA256:
+  metadata.gz: 83cdb2541d4d694624f06d63e03dce612db88ce09e0ff7532c4d701424aedb46
+  data.tar.gz: a3862e1f9f6f4f1685ab2c7c8077e4a166ab3ebfa8a017fb32aa701d7dc68705
 SHA512:
-  metadata.gz: a80e16265011e07665a6b44254f43bb2b42bce005c6ade5871b2e97aa240d90f4372008d5a9e1fac91c756867d8c85d69263d3879c6174fe4ee6cda2e92726a2
-  data.tar.gz: de12d557bcbf695f7e13997fe84cd78fbd25339f7ce5f3075f832d3b4e410aadbca41a1d4e288d8ac58513ae3a366b9e0b5a46e33777347769927c3a5cabca58
+  metadata.gz: 1e8f5628d633564aaf0183a89ebebb9e9c4ee82d298d2deee8513b26dd5f8a52326ce57278c3f9782986def685212995f034a3e18d65321a34081689d248ca2a
+  data.tar.gz: 3792fa6710c0e4fcca018ad96464772d5776864bea0fc19e2c493bd871a9008eb09f6a675892008df4b9fe8454cdda66eca8a0e09d38dee5018428c8fa985b49

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/CHANGELOG.md

@@ -5,6 +5,13 @@ 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.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])

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,36 @@ 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
+```
+
+Adjust the middleware:
+
+```ruby
+We::Call.configure do |config|
+  config.retry_options = { interval: 0.5 }
+end
+```
+
+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']`.
@@ -155,10 +185,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,11 +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'
+        @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
@@ -72,6 +78,9 @@ module We
           if config.detect_deprecations
             faraday.response :sunset, setup_sunset_middleware(faraday)
           end
+          if config.retry
+            faraday.request :retry, fetch_retry_options
+          end
 
           yield faraday if block_given?
 
@@ -118,6 +127,16 @@ module We
         options
       end
 
+      def fetch_retry_options
+        DEFAULT_RETRY_OPTIONS.merge(config.retry_options) do |key, default_val, new_val|
+          if key == :exceptions
+            default_val + Array(new_val)
+          else
+            new_val
+          end
+        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/version.rb

@@ -1,5 +1,5 @@
 module We
   module Call
-    VERSION = "0.9.0"
+    VERSION = '0.9.1'
   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

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: we-call
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - WeWork Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -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
@@ -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.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Making healthy, happy HTTP calls