ffccmmx 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f3a989f55da2e1b9187f012bb1bf4571504f0e8dd1cacab4c8ac3e8bd26648b
-  data.tar.gz: 38cbd21555d467bb2c3f023c102e810a87dea0ac2357eac7405874d924d2b8f0
+  metadata.gz: '09626f45c71c010b2ce077e7d157fb44303f4a6ae4d665495777fd5e55a3db8c'
+  data.tar.gz: 869d953e07906287046ae010af36b28e829c0ded358866eccd794c9ef77436c3
 SHA512:
-  metadata.gz: f433427d542b61b7c959994cb3420bd6eccf4228306a786ef48baf72918cbe3d22aa67bb2c5fbc86e7caf54d030f07ff5fc9c568b97063dd5ce7a3f82f1f90f2
-  data.tar.gz: c5cca8df39b59e5abfb61e1a934588cd547615c3861ede7b8ba7feb032441de5bfc073f9d865075819ddec1ec50442beef07e730e8fd80b07e06fb11b80bf97c
+  metadata.gz: f4117c3bf719196e8eeaa9b63b08c289d4f1404f351c5470558ad0b22cdc9f75959ca033d3dd559121a363597d899fac8b86fd2a8f95ad587d1429c46d0f337e
+  data.tar.gz: '0956a194ad06f27940b5e50d06b7d72e48004fbe9d7fbc51efcc62474fef1c7b1cc1164b3bb23f6da568791a3e65ca6094248ea5d971e986cbe5f8510370f998'

data/.rubocop.yml

@@ -16,3 +16,13 @@ Metrics/ClassLength:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+    - 'ffccmmx.gemspec'
+
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/MultilineBlockChain:
+  Exclude:
+    - 'spec/**/*'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2025-07-18
+
+- Add HTTPXRetryableError
+
 ## [0.1.0] - 2025-06-20
 
 - Initial release

data/README.md

@@ -7,18 +7,16 @@ By leveraging httpx, this gem enables HTTP/2 communication while maintaining an
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add ffccmmx
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install ffccmmx
 ```
 
 ## Usage
@@ -137,6 +135,19 @@ response = @client.unsubscribe('/topics/test_topic', device_token)
 response = @client.unsubscribe('/topics/test_topic', *device_tokens)
 ```
 
+## Error Response
+
+`Ffccmmx::HTTPXRetryableError` is returned, you can use the retry_time method to get a Time object indicating when the next request can be executed. 
+If the request has already been attempted multiple times, you can pass the attempt count as an argument, and it will be taken into account even if the Retry-After header is not present in the response.
+
+```ruby
+begin
+  @client.push(notification_message)
+rescue Ffccmmx::HTTPXRetryableError => e
+    puts "Retry after: #{e.retry_time}"
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ffccmmx/client.rb

@@ -139,6 +139,10 @@ module Ffccmmx
     def send_post_request(uri, json, headers)
       httpx.bearer_auth(access_token).post(uri.to_s, json:, headers:).raise_for_status
     rescue HTTPX::Error => e
+      if Ffccmmx::HTTPXRetryableError.retryable_error?(e)
+        raise Ffccmmx::HTTPXRetryableError, response: e.response, cause: e
+      end
+
       raise Ffccmmx::HTTPXError, cause: e
     rescue StandardError => e
       raise Ffccmmx::Error, cause: e

data/lib/ffccmmx/exceptions.rb

@@ -4,4 +4,27 @@ module Ffccmmx
   class Error < StandardError; end
 
   class HTTPXError < Error; end
+
+  class HTTPXRetryableError < HTTPXError
+    attr_reader :response
+
+    RETRYABLE_STATUS_CODES = [408, 429, 500, 502, 503, 504].freeze
+    private_constant :RETRYABLE_STATUS_CODES
+    def self.retryable_error?(error)
+      return false unless error.respond_to?(:response)
+      return false if error.response.nil?
+
+      RETRYABLE_STATUS_CODES.include?(error.response.status)
+    end
+
+    def initialize(response)
+      @response = response
+      super()
+    end
+
+    def retry_time(count: 1)
+      retry_seconds = response.headers["retry-after"] ? response.headers["retry-after"].to_i : 2**count
+      Time.now + retry_seconds
+    end
+  end
 end

data/lib/ffccmmx/response.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "ffccmmx/exceptions"
+
 module Ffccmmx
   class Response
     def initialize(response)
@@ -9,6 +11,10 @@ module Ffccmmx
     def value
       @response.raise_for_status
     rescue HTTPX::Error => e
+      if Ffccmmx::HTTPXRetryableError.retryable_error?(e)
+        raise Ffccmmx::HTTPXRetryableError, response: e.response, cause: e
+      end
+
       raise Ffccmmx::HTTPXError, cause: e
     rescue StandardError => e
       raise Ffccmmx::Error, cause: e

data/lib/ffccmmx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ffccmmx
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/sig/ffccmmx/client.rbs

@@ -7,10 +7,10 @@ module Ffccmmx
 
     def subscribe: (String, *String,?query: Enumerable[untyped], ?headers: Hash[Symbol,untyped] ) -> HTTPX::Response
 
-    def concurrent_subscribe: (Array[String], *String,?query: Enumerable[untyped], ?headers: Hash[Symbol,untyped] ) -> HTTPX::Response
+    def concurrent_subscribe: (String, *String,?query: Enumerable[untyped], ?headers: Hash[Symbol,untyped] ) -> HTTPX::Response
 
     def unsubscribe: (String, *String ,?query: Enumerable[untyped], ?headers: Hash[Symbol,untyped] ) -> HTTPX::Response
 
-    def concurrent_unsubscribe: (Array[String], *String,?query: Enumerable[untyped], ?headers: Hash[Symbol,untyped] ) -> HTTPX::Response
+    def concurrent_unsubscribe: (String, *String,?query: Enumerable[untyped], ?headers: Hash[Symbol,untyped] ) -> HTTPX::Response
   end
 end

data/sig/ffccmmx/exceptions.rbs

@@ -0,0 +1,9 @@
+module Ffccmmx
+  class HTTPXRetryableError < HTTPX::Error
+    attr_reader response: HTTPX::Response
+
+    def self.retryable_error?:(HTTPX::Error) -> bool
+
+    def retry_time:(?count: Integer) -> Time
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffccmmx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - anatofuz
@@ -37,6 +37,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.25'
 description: FCM API wrapper, supports HTTP/2 using httpx gem. This gem is based on
   fcmpush gem.
 email:
@@ -61,6 +89,7 @@ files:
 - sig/ffccmmx.rbs
 - sig/ffccmmx/client.rbs
 - sig/ffccmmx/configuration.rbs
+- sig/ffccmmx/exceptions.rbs
 - sig/ffccmmx/response.rbs
 homepage: https://github.com/AnaTofuZ/ffccmmx
 licenses: