payjp 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 27457effbc47ae96c13305248fc780f9e2f1ca00
-  data.tar.gz: 4a06532b2b0eaf162e2db5b3795584f92d98d3ef
+SHA256:
+  metadata.gz: 21b1328487d0db17d3b7e78afe2b1a9f00df6506c2da1b896c216eec238b4936
+  data.tar.gz: 6416cc480d88f3fcf135ed0005ee37a2d2d8d70e4d10c7ed4fa68f9a408dbe78
 SHA512:
-  metadata.gz: b65d4c3f8df6e10e198dc8a289210adbd06098d8e8220497d2d1f40d5315c6bb775ab7ecb73d94b87b6374bbb6b6116fdeae486ddab71512c95311b64e3556bd
-  data.tar.gz: ee4ee024077834fd5d9840a251784dd568ea4e0c33e2893c663d100b91cf8c6f89951e49d604c57641819ba82304ece75bb62619524a10ec6165fc04187a4612
+  metadata.gz: 9d907d975eb58780bd31183c3e6fd68fa99c21fa34bcbe545be98b8d9f18453d822c1cb98e7f6020235dbcf70aeedaf3e2b5022132b97c62671be847d5326923
+  data.tar.gz: 0be34aabaceb678126e61f71d8a0832140972f554789e135e043693996cf288875aa196383fe3f97b87073e448df265ed028ffc32c3bf26ac1a3ce10226a7be7

data/.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Ruby Build Test
+
+on: push
+
+jobs:
+  build-test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.0.0, 2.1, 2.2, 2.3.0, jruby-9.2.17.0]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/lib/payjp/version.rb

@@ -1,3 +1,3 @@
 module Payjp
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/payjp.rb

@@ -50,23 +50,39 @@ module Payjp
   @ssl_ca_file = nil
   @ssl_ca_path = nil
   @ssl_cert_store = nil
+  @max_retry = 0
+  @retry_initial_delay = 2
+  @retry_max_delay = 32
 
   class << self
     attr_accessor :api_key, :api_base, :api_version, :connect_base, :uploads_base,
-                  :open_timeout, :read_timeout, :ssl_ca_file, :ssl_ca_path, :ssl_cert_store
+                  :open_timeout, :read_timeout, :ssl_ca_file, :ssl_ca_path, :ssl_cert_store, :max_retry, :retry_initial_delay, :retry_max_delay
   end
 
   def self.api_url(url = '', api_base_url = nil)
     (api_base_url || @api_base) + url
   end
 
-  def self.request(method, url, api_key, params = {}, headers = {}, api_base_url = nil, open_timeout = nil, read_timeout = nil, ssl_ca_file = nil, ssl_ca_path = nil, ssl_cert_store = nil)
+  def self.get_retry_delay(retry_count, retry_initial_delay, retry_max_delay)
+    # Get retry delay seconds.
+    # Based on "Exponential backoff with equal jitter" algorithm.
+    # https://aws.amazon.com/jp/blogs/architecture/exponential-backoff-and-jitter/
+
+    wait = [retry_max_delay, retry_initial_delay * 2 ** retry_count].min
+    random = Random.new()
+    (wait / 2) + (random.rand(wait / 2.0))
+  end
+
+  def self.request(method, url, api_key, params = {}, headers = {}, api_base_url = nil, open_timeout = nil, read_timeout = nil, ssl_ca_file = nil, ssl_ca_path = nil, ssl_cert_store = nil, max_retry = nil, retry_initial_delay= nil, retry_max_delay = nil)
     api_base_url ||= @api_base
     open_timeout ||= @open_timeout
     read_timeout ||= @read_timeout
     ssl_ca_file ||= @ssl_ca_file
     ssl_ca_path ||= @ssl_ca_path
     ssl_cert_store ||= @ssl_cert_store
+    max_retry ||= @max_retry
+    retry_initial_delay ||= @retry_initial_delay
+    retry_max_delay ||= @retry_max_delay
 
     unless api_key ||= @api_key
       raise AuthenticationError.new('No API key provided. ' \
@@ -107,6 +123,8 @@ module Payjp
                         :ssl_ca_file => ssl_ca_file, :ssl_ca_path => ssl_ca_path,
                         :ssl_cert_store => ssl_cert_store)
 
+    retry_count = 1
+
     begin
       # $stderr.puts request_opts
 
@@ -122,6 +140,12 @@ module Payjp
         raise
       end
     rescue RestClient::ExceptionWithResponse => e
+      if e.http_code == 429 and retry_count <= max_retry then
+        sleep get_retry_delay(retry_count, retry_initial_delay, retry_max_delay)
+        retry_count += 1
+        retry
+      end
+
       if rcode = e.http_code and rbody = e.http_body
         handle_api_error(rcode, rbody)
       else
@@ -239,6 +263,8 @@ module Payjp
       raise authentication_error error, rcode, rbody, error_obj
     when 402
       raise card_error error, rcode, rbody, error_obj
+    when 429
+      raise api_error error, rcode, rbody, error_obj
     else
       raise api_error error, rcode, rbody, error_obj
     end

data/payjp.gemspec

@@ -23,5 +23,8 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = ['lib']
+  s.require_paths = ['lib']  
+  s.metadata = {
+    "source_code_uri" => "https://github.com/payjp/payjp-ruby",
+  }
 end

data/test/payjp/api_resource_test.rb

@@ -411,6 +411,25 @@ module Payjp
 
           assert_equal true, rescued
         end
+
+        should "429s should raise a APIError of over capacity error code" do
+          response = test_response(test_over_capacity_error, 429)
+          @mock.expects(:get).once.raises(RestClient::ExceptionWithResponse.new(response, 429))
+
+          rescued = false
+          begin
+            Payjp::Customer.new("test_customer").refresh
+            assert false # shouldn't get here either
+          rescue Payjp::APIError => e # we don't use assert_raises because we want to examine e
+            rescued = true
+            assert e.is_a? Payjp::APIError
+            assert_equal(429, e.http_status)
+            assert_equal(true, !!e.http_body)
+            assert_equal("over_capacity", e.json_body[:error][:code])
+          end
+
+          assert_equal true, rescued
+        end
       end
 
       should 'save nothing if nothing changes' do
@@ -442,4 +461,120 @@ module Payjp
       end
     end
   end
+
+  class APIRequestorRetryTest < Test::Unit::TestCase
+
+    setup do
+      Payjp.max_retry = 0
+      Payjp.retry_initial_delay = 0.1
+    end
+
+    def mock_exceptions(error_codes, call_count)
+      exception_mock = nil
+      error_codes.with_index(1) { |code, id|
+        if id == 1
+          exception_mock = @mock.expects(:get).raises(RestClient::ExceptionWithResponse.new(test_response(test_api_error, code)))
+        else
+          exception_mock = exception_mock.then.raises(RestClient::ExceptionWithResponse.new(test_response(test_api_error, code)))
+        end
+      }
+      exception_mock.at_least(call_count)
+    end
+
+    context "checking retry" do
+      should "over capacity retry disabled" do
+        error_codes = [429, 599].to_enum
+        # returns 599 at 2nd try but max_retry 0 then retry disabled
+        mock_exceptions(error_codes, 1)
+        rescued = false
+
+        begin
+          Payjp::Charge.retrieve("test_charge")
+        rescue Payjp::APIError => e # we don't use assert_raises because we want to examine e
+          assert e.is_a? Payjp::APIError
+          assert_equal(429, e.http_status)
+          rescued = true
+        end
+        assert_equal true, rescued
+      end
+
+      should "no retry" do
+        Payjp.max_retry = 2
+        Payjp.retry_initial_delay = 0.1
+        error_codes = [599, 429, 429, 429].to_enum
+        # returns 599 at first try
+        mock_exceptions(error_codes, 1)
+        rescued = false
+
+        begin
+          Payjp::Charge.retrieve("test_charge")
+        rescue Payjp::APIError => e # we don't use assert_raises because we want to examine e
+          assert e.is_a? Payjp::APIError
+          assert_equal(599, e.http_status)
+          assert_equal(true, !!e.http_body)
+          rescued = true
+        end
+        assert_equal true, rescued
+      end
+
+      should "over capacity full retry" do
+        Payjp.max_retry = 2
+        Payjp.retry_initial_delay = 0.1
+        error_codes = [429, 429, 429, 429, 599].to_enum
+
+        # first try + 2 retries + unexpected 599
+        mock_exceptions(error_codes, 3)
+        rescued = false
+
+        begin
+          Payjp::Charge.retrieve("test_charge")
+        rescue Payjp::APIError => e # we don't use assert_raises because we want to examine e
+          assert e.is_a? Payjp::APIError
+          assert_equal(429, e.http_status)
+          rescued = true
+        end
+
+        assert_equal true, rescued
+      end
+
+      should "over capacity halfway of retries" do
+        Payjp.max_retry = 5
+        Payjp.retry_initial_delay = 0.1
+
+        error_codes = [429, 599, 429, 429, 429].to_enum
+        rescued = false
+
+        # returns not 429 status at 2nd try
+        mock_exceptions(error_codes, 2)
+        begin
+          Payjp::Charge.retrieve("test_charge")
+        rescue Payjp::APIError => e # we don't use assert_raises because we want to examine e
+          assert e.is_a? Payjp::APIError
+          assert_equal(599, e.http_status)
+          rescued = true
+        end
+
+        assert_equal true, rescued
+      end
+    end
+
+    context "retry interval" do
+      should "retry initial delay" do
+        retry_initial_delay = 2
+        retry_max_delay = 32
+
+        assert_equal(true, Payjp.get_retry_delay(0, retry_initial_delay, retry_max_delay).between?(1, 2))
+        assert_equal(true, Payjp.get_retry_delay(1, retry_initial_delay, retry_max_delay).between?(2, 4))
+        assert_equal(true, Payjp.get_retry_delay(2, retry_initial_delay, retry_max_delay).between?(4, 8))
+        # cap
+        assert_equal(true, Payjp.get_retry_delay(4, retry_initial_delay, retry_max_delay).between?(16, 32))
+        assert_equal(true, Payjp.get_retry_delay(10, retry_initial_delay, retry_max_delay).between?(16, 32))
+      end
+    end
+
+    teardown do
+      Payjp.max_retry = 0
+      Payjp.retry_initial_delay = 0.1
+    end
+  end
 end

data/test/test_data.rb

@@ -287,5 +287,14 @@ module Payjp
         }
       }
     end
+
+    def test_over_capacity_error
+      {
+        :error => {
+          :code => "over_capacity",
+          :type => "api_error"
+        }
+      }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: payjp
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - PAY.JP
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-22 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -107,10 +107,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CONTRIBUTORS
 - Gemfile
 - History.txt
@@ -163,8 +163,9 @@ files:
 homepage: https://pay.jp
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/payjp/payjp-ruby
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,9 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby bindings for the Payjp API
 test_files:

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - 2.3.0
-  - jruby-9.0.5.0
-
-sudo: false