duffel_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f34f8f28b32ebbcce50624f302a8c571322804417841653645dd6ea659f8a22
-  data.tar.gz: fab5945c12ed6054f01330dc2bd62cb814cd90f486b7dc36ed4caa0c8197617c
+  metadata.gz: c46f165ae24365df8a17eb35d99ddb7ffed2a5dc170d84e8258d17c1f120c62f
+  data.tar.gz: 9e566d5f0b79b9dd13d5ac873f095a575ea4a23c11dbcae00d91f13940816330
 SHA512:
-  metadata.gz: 89708a5b441623dfecaee21f06bfba8da70e93b251d2587895a1b7ea3a9df1375251ae5a85de0a4550bf96ef46249a3c8d341f85c187d268cdf4fc6c6029c2da
-  data.tar.gz: c0e3165cf5a164dab4d2da40e9171fc2c680800be4a2f43c96e18556c75c9890555bec6cd3455c90de3c8141347bd32fc13d50eb78e33336ce8954a38387633e
+  metadata.gz: e03f1705659ccd04c14cc5d479f8ca13f9ec9a67338eb64aa824a9ac72ee2e21133e0725bc04d7d5772343ce3dc7d4e146184400836535ef49b0edd077b39514
+  data.tar.gz: f99d04e62d5d518affba0baa592c5f10a118bc1b7cac8bcb1ada16c778a2dceb7e4cc0c16be80bc80be9bd56cf3e7df6e46bc80736019a299db04824ca62ec4c

data/.rubocop.yml

@@ -11,3 +11,6 @@ RSpec/ExampleLength:
 
 RSpec/MultipleExpectations:
   Enabled: false
+
+Rails:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.3.0] - 2022-02-15
+
+- Automatically retry rate-limited requests (thanks to @ferrisoxide for the contribution!)
+- Paginate through records with `#all` 200 records at a time by default, rather than 50 records at a time
+
 ## [0.2.0] - 2022-01-11
 
 - Add `WebhookEvent.genuine?` for checking whether a webhook event was genuinely sent by Duffel

data/Gemfile

@@ -6,13 +6,13 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
-  gem "gc_ruboconfig", "~> 2.30.0"
+  gem "gc_ruboconfig", "~> 3.0.0"
   gem "pry", "~> 0.14.1"
   gem "rake", "~> 13.0"
-  gem "rspec", "~> 3.10.0"
+  gem "rspec", "~> 3.11.0"
   gem "rspec-its", "~> 1.3.0"
   gem "rspec_junit_formatter", "~> 0.5.0"
-  gem "rubocop", "~> 1.24.0"
+  gem "rubocop", "~> 1.25.0"
   gem "rubocop-rake", "~> 0.6.0"
   gem "simplecov", "~> 0.21.2"
   gem "webmock", "~> 3.14.0"

data/README.md

@@ -20,7 +20,7 @@ A Ruby client library for the [Duffel API](https://duffel.com/docs/api).
 In most cases, you'll want to add `duffel_api` to your project as a dependency by listing it in your `Gemfile`, and then running `bundle`:
 
 ```ruby
-gem "duffel_api", "~> 0.2.0"
+gem "duffel_api", "~> 0.3.0"
 ```
 
 You can install `duffel_api` outside of the context of a project by running `gem install duffel_api` - for example if you want to play with the client library in `irb`.

data/examples/book_with_extra_baggage.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "duffel_api"
+require "bigdecimal"
 
 client = DuffelAPI::Client.new(
   access_token: ENV["DUFFEL_ACCESS_TOKEN"],
@@ -50,8 +51,9 @@ puts "Adding #{available_baggage['metadata']['maximum_weight_kg']}kg extra bagga
      "#{available_baggage['total_amount']} " \
      "#{available_baggage['total_currency']}"
 
-total_amount = priced_offer.total_amount.to_f +
-  available_baggage["total_amount"].to_f
+total_amount = (
+  BigDecimal(priced_offer.total_amount) + BigDecimal(available_baggage["total_amount"])
+).to_s("F")
 
 order = client.orders.create(params: {
   selected_offers: [priced_offer.id],

data/examples/book_with_seat.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "duffel_api"
+require "bigdecimal"
 
 client = DuffelAPI::Client.new(
   access_token: ENV["DUFFEL_ACCESS_TOKEN"],
@@ -57,8 +58,10 @@ puts "Adding seat #{available_seat['designator']} costing " \
      "#{available_seat_service['total_amount']} " \
      "#{available_seat_service['total_currency']}"
 
-total_amount = priced_offer.total_amount.to_f +
-  available_seat_service["total_amount"].to_f
+total_amount = (
+  BigDecimal(priced_offer.total_amount) +
+  BigDecimal(available_seat_service["total_amount"])
+).to_s("F")
 
 order = client.orders.create(params: {
   selected_offers: [priced_offer.id],

data/examples/search_and_book.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "duffel_api"
+require "bigdecimal"
 
 client = DuffelAPI::Client.new(
   access_token: ENV["DUFFEL_ACCESS_TOKEN"],
@@ -47,7 +48,9 @@ available_service = priced_offer.available_services.first
 puts "Adding an extra bag with service #{available_service['id']}, " \
      "costing #{available_service['total_amount']} #{available_service['total_currency']}"
 
-total_amount = priced_offer.total_amount.to_f + available_service["total_amount"].to_f
+total_amount = (
+  BigDecimal(priced_offer.total_amount) + BigDecimal(available_service["total_amount"])
+).to_s("F")
 
 order = client.orders.create(params: {
   selected_offers: [priced_offer.id],

data/lib/duffel_api/api_service.rb

@@ -19,6 +19,7 @@ module DuffelAPI
       root_url, @path_prefix = unpack_url(base_url)
 
       @connection = Faraday.new(root_url) do |faraday|
+        faraday.request :rate_limiter
         faraday.response :raise_duffel_errors
 
         faraday.adapter(:net_http)

data/lib/duffel_api/middlewares/raise_duffel_errors.rb

@@ -8,7 +8,6 @@ module DuffelAPI
       UNEXPECTED_ERROR_STATUSES = (501..599).freeze
       EXPECTED_ERROR_STATUSES = (400..500).freeze
 
-      # rubocop:disable Metrics/AbcSize
       # Handles a completed (Faraday) request and raises an error, if appropriate
       #
       # @param [Faraday::Env] env
@@ -30,7 +29,6 @@ module DuffelAPI
           raise error_class.new(error, response)
         end
       end
-      # rubocop:enable Metrics/AbcSize
 
       private
 

data/lib/duffel_api/middlewares/rate_limiter.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "logger"
+
+module DuffelAPI
+  module Middlewares
+    class RateLimiter < Faraday::Middleware
+      class << self
+        attr_accessor :ratelimit_limit, :ratelimit_remaining, :ratelimit_reset
+
+        def mutex
+          @mutex ||= Mutex.new
+        end
+      end
+
+      def initialize(app, options = {})
+        super(app, options)
+      end
+
+      def call(env)
+        sleep_until_ratelimit_reset if rate_limited?
+
+        app.call(env).tap do |response|
+          headers = response.env.response_headers
+
+          RateLimiter.mutex.synchronize do
+            RateLimiter.ratelimit_limit = new_ratelimit_limit(headers)
+            RateLimiter.ratelimit_remaining = new_ratelimit_remaining(headers)
+            RateLimiter.ratelimit_reset = new_ratelimit_reset(headers)
+          end
+        end
+      end
+
+      private
+
+      # NOTE: The check for 'ratelimit-limit' vs 'Ratelimit-Limit' is required
+      # because RSpec and Rails proper handle HTTP headers differently.
+      # WebMock converts the header to the latter style, whereas when running
+      # through Rails it will be converted to the former.
+      def header_value_with_indifferent_key(headers, key)
+        headers.find { |k, _v| k.casecmp(key).zero? }&.at(1)
+      end
+
+      def new_ratelimit_limit(headers)
+        header_value_with_indifferent_key(headers, "ratelimit-limit")&.to_i
+      end
+
+      def new_ratelimit_remaining(headers)
+        header_value_with_indifferent_key(headers, "ratelimit-remaining")&.to_i
+      end
+
+      def new_ratelimit_reset(headers)
+        reset_time = header_value_with_indifferent_key(headers, "ratelimit-reset")
+        reset_time.nil? ? nil : DateTime.parse(reset_time).to_time
+      end
+
+      def rate_limited?
+        return false if RateLimiter.ratelimit_reset.nil?
+        return false if RateLimiter.ratelimit_remaining.nil?
+
+        RateLimiter.ratelimit_remaining.zero?
+      end
+
+      def sleep_until_ratelimit_reset
+        sleep_time = (RateLimiter.ratelimit_reset.to_i - Time.now.to_i) + 1
+        return unless sleep_time.positive?
+
+        ::Logger.new($stdout).info(
+          "Duffel rate-limit hit. Sleeping for #{sleep_time} seconds",
+        )
+        Kernel.sleep(sleep_time)
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware rate_limiter: DuffelAPI::Middlewares::RateLimiter

data/lib/duffel_api/resources/offer.rb

@@ -25,7 +25,6 @@ module DuffelAPI
       attr_reader :total_emissions_kg
       attr_reader :updated_at
 
-      # rubocop:disable Metrics/AbcSize
       def initialize(object, response = nil)
         @object = object
 
@@ -54,7 +53,6 @@ module DuffelAPI
 
         super(object, response)
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/duffel_api/resources/order.rb

@@ -25,7 +25,6 @@ module DuffelAPI
       attr_reader :total_amount
       attr_reader :total_currency
 
-      # rubocop:disable Metrics/AbcSize
       def initialize(object, response = nil)
         @object = object
 
@@ -52,7 +51,6 @@ module DuffelAPI
 
         super(object, response)
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/duffel_api/resources/order_change.rb

@@ -19,7 +19,6 @@ module DuffelAPI
       attr_reader :refund_to
       attr_reader :slices
 
-      # rubocop:disable Metrics/AbcSize
       def initialize(object, response = nil)
         @object = object
 
@@ -40,7 +39,6 @@ module DuffelAPI
 
         super(object, response)
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/duffel_api/resources/order_change_offer.rb

@@ -19,7 +19,6 @@ module DuffelAPI
       attr_reader :slices
       attr_reader :updated_at
 
-      # rubocop:disable Metrics/AbcSize
       def initialize(object, response = nil)
         @object = object
 
@@ -40,7 +39,6 @@ module DuffelAPI
 
         super(object, response)
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/duffel_api/resources/payment_intent.rb

@@ -22,7 +22,6 @@ module DuffelAPI
       attr_reader :status
       attr_reader :updated_at
 
-      # rubocop:disable Metrics/AbcSize
       def initialize(object, response = nil)
         @object = object
 
@@ -46,7 +45,6 @@ module DuffelAPI
 
         super(object, response)
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/duffel_api/resources/refund.rb

@@ -17,7 +17,6 @@ module DuffelAPI
       attr_reader :status
       attr_reader :updated_at
 
-      # rubocop:disable Metrics/AbcSize
       def initialize(object, response = nil)
         @object = object
 
@@ -36,7 +35,6 @@ module DuffelAPI
 
         super(object, response)
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/duffel_api/services/aircraft_service.rb

@@ -22,13 +22,18 @@ module DuffelAPI
       end
 
       # Returns an `Enumerator` which can automatically cycle through multiple
-      # pages of `Resources;:Aircraft`
+      # pages of `Resources::Aircraft`.
+      #
+      # By default, this will use pages of 200 results under the hood, but this
+      # can be customised by specifying the `:limit` option in the `:params`.
       #
       # @param options [Hash] options passed to `#list`, for example `:params` to
       #   send an HTTP querystring with filters
       # @return [Enumerator]
       # @raise [Errors::Error] when the Duffel API returns an error
       def all(options = {})
+        options[:params] = DEFAULT_ALL_PARAMS.merge(options[:params] || {})
+
         DuffelAPI::Paginator.new(
           service: self,
           options: options,

data/lib/duffel_api/services/airlines_service.rb

@@ -21,13 +21,18 @@ module DuffelAPI
       end
 
       # Returns an `Enumerator` which can automatically cycle through multiple
-      # pages of `Resources;:Airline`s
+      # pages of `Resources::Airline`s.
+      #
+      # By default, this will use pages of 200 results under the hood, but this
+      # can be customised by specifying the `:limit` option in the `:params`.
       #
       # @param options [Hash] options passed to `#list`, for example `:params` to
       #   send an HTTP querystring with filters
       # @return [Enumerator]
       # @raise [Errors::Error] when the Duffel API returns an error
       def all(options = {})
+        options[:params] = DEFAULT_ALL_PARAMS.merge(options[:params] || {})
+
         DuffelAPI::Paginator.new(
           service: self,
           options: options,

data/lib/duffel_api/services/airports_service.rb

@@ -22,13 +22,18 @@ module DuffelAPI
       end
 
       # Returns an `Enumerator` which can automatically cycle through multiple
-      # pages of `Resources;:Airport`s
+      # pages of `Resources::Airport`s.
+      #
+      # By default, this will use pages of 200 results under the hood, but this
+      # can be customised by specifying the `:limit` option in the `:params`.
       #
       # @param options [Hash] options passed to `#list`, for example `:params` to
       #   send an HTTP querystring with filters
       # @return [Enumerator]
       # @raise [Errors::Error] when the Duffel API returns an error
       def all(options = {})
+        options[:params] = DEFAULT_ALL_PARAMS.merge(options[:params] || {})
+
         DuffelAPI::Paginator.new(
           service: self,
           options: options,

data/lib/duffel_api/services/base_service.rb

@@ -7,6 +7,9 @@ module DuffelAPI
     class BaseService
       extend Forwardable
 
+      # Default params to use with the auto-paginating `#all` method
+      DEFAULT_ALL_PARAMS = { limit: 200 }.freeze
+
       # Sets up a resource-specific service based on an API service
       #
       # @param api_service [APIService]

data/lib/duffel_api/services/offer_requests_service.rb

@@ -59,13 +59,18 @@ module DuffelAPI
       end
 
       # Returns an `Enumerator` which can automatically cycle through multiple
-      # pages of `Resources;:OfferRequest`s
+      # pages of `Resources::OfferRequest`s.
+      #
+      # By default, this will use pages of 200 results under the hood, but this
+      # can be customised by specifying the `:limit` option in the `:params`.
       #
       # @param options [Hash] options passed to `#list`, for example `:params` to
       #   send an HTTP querystring with filters
       # @return [Enumerator]
       # @raise [Errors::Error] when the Duffel API returns an error
       def all(options = {})
+        options[:params] = DEFAULT_ALL_PARAMS.merge(options[:params] || {})
+
         Paginator.new(
           service: self,
           options: options,

data/lib/duffel_api/services/offers_service.rb

@@ -22,13 +22,18 @@ module DuffelAPI
       end
 
       # Returns an `Enumerator` which can automatically cycle through multiple
-      # pages of `Resources;:Offers`s
+      # pages of `Resources::Offers`s.
+      #
+      # By default, this will use pages of 200 results under the hood, but this
+      # can be customised by specifying the `:limit` option in the `:params`.
       #
       # @param options [Hash] options passed to `#list`, for example `:params` to
       #   send an HTTP querystring with filters
       # @return [Enumerator]
       # @raise [Errors::Error] when the Duffel API returns an error
       def all(options = {})
+        options[:params] = DEFAULT_ALL_PARAMS.merge(options[:params] || {})
+
         Paginator.new(
           service: self,
           options: options,

data/lib/duffel_api/services/order_cancellations_service.rb

@@ -71,13 +71,18 @@ module DuffelAPI
       end
 
       # Returns an `Enumerator` which can automatically cycle through multiple
-      # pages of `Resources;:OrderCancellation`s
+      # pages of `Resources::OrderCancellation`s.
+      #
+      # By default, this will use pages of 200 results under the hood, but this
+      # can be customised by specifying the `:limit` option in the `:params`.
       #
       # @param options [Hash] options passed to `#list`, for example `:params` to
       #   send an HTTP querystring with filters
       # @return [Enumerator]
       # @raise [Errors::Error] when the Duffel API returns an error
       def all(options = {})
+        options[:params] = DEFAULT_ALL_PARAMS.merge(options[:params] || {})
+
         Paginator.new(
           service: self,
           options: options,

data/lib/duffel_api/services/order_change_offers_service.rb

@@ -22,13 +22,18 @@ module DuffelAPI
       end
 
       # Returns an `Enumerator` which can automatically cycle through multiple
-      # pages of `Resources;:OrderChangeOffer`s
+      # pages of `Resources::OrderChangeOffer`s.
+      #
+      # By default, this will use pages of 200 results under the hood, but this
+      # can be customised by specifying the `:limit` option in the `:params`.
       #
       # @param options [Hash] options passed to `#list`, for example `:params` to
       #   send an HTTP querystring with filters
       # @return [Enumerator]
       # @raise [Errors::Error] when the Duffel API returns an error
       def all(options = {})
+        options[:params] = DEFAULT_ALL_PARAMS.merge(options[:params] || {})
+
         Paginator.new(
           service: self,
           options: options,

data/lib/duffel_api/services/orders_service.rb

@@ -70,13 +70,18 @@ module DuffelAPI
       end
 
       # Returns an `Enumerator` which can automatically cycle through multiple
-      # pages of `Resources;:Order`s
+      # pages of `Resources::Order`s.
+      #
+      # By default, this will use pages of 200 results under the hood, but this
+      # can be customised by specifying the `:limit` option in the `:params`.
       #
       # @param options [Hash] options passed to `#list`, for example `:params` to
       #   send an HTTP querystring with filters
       # @return [Enumerator]
       # @raise [Errors::Error] when the Duffel API returns an error
       def all(options = {})
+        options[:params] = DEFAULT_ALL_PARAMS.merge(options[:params] || {})
+
         Paginator.new(
           service: self,
           options: options,

data/lib/duffel_api/version.rb

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

data/lib/duffel_api.rb

@@ -10,6 +10,7 @@ require_relative "duffel_api/errors/invalid_state_error"
 require_relative "duffel_api/errors/rate_limit_error"
 require_relative "duffel_api/errors/validation_error"
 require_relative "duffel_api/middlewares/raise_duffel_errors"
+require_relative "duffel_api/middlewares/rate_limiter"
 require_relative "duffel_api/resources/base_resource"
 require_relative "duffel_api/resources/aircraft"
 require_relative "duffel_api/resources/airline"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duffel_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - The Duffel team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base16
@@ -65,7 +65,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -99,6 +98,7 @@ files:
 - lib/duffel_api/errors/validation_error.rb
 - lib/duffel_api/list_response.rb
 - lib/duffel_api/middlewares/raise_duffel_errors.rb
+- lib/duffel_api/middlewares/rate_limiter.rb
 - lib/duffel_api/paginator.rb
 - lib/duffel_api/request.rb
 - lib/duffel_api/resources/aircraft.rb