typeform_data 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d70cdb5034873b422938f7cf426b0b1341a992ab
-  data.tar.gz: a36e89135238d96c2ebe7ea0466c56fbf2f2b23f
+  metadata.gz: 3da62092341167802dd4565276637320bc9b4239
+  data.tar.gz: c60c7c72ddc21e7732f2ea866639f3c404879706
 SHA512:
-  metadata.gz: 5ec3a03e56573d5b75fed0aff79d2f1a54dfeb176433c7afc1621e6532a76e7fb31a0ca9ca8477ca41c78ba04b9ef8b05ea4b0b5c9c88df2a7e870ea3ea47ed1
-  data.tar.gz: 38532360add588301c0e3c3621088e72dba3ccc7758cecd1a84f43ae4eb27a4824010a32db4ae0d874088573f5a6b3fd1ebf14ec517ed3b869f989124394858a
+  metadata.gz: 0b423251f537bb0b5a2a041fa2a80f57ffceefd70c33c886c0fdfc4c7f8df52770148c021f03b8f7d5ee8fa3cf04b9b673ef1cdc713eeffafe154f082e6ecf72
+  data.tar.gz: 1ce2a17d3b448d5a0fa4a2c8aae6d2dcd22026f0590d9d1aaae0a10b652c8114d6a2be4de0bc1d3ecc5f9d9e64443123b11b56e1a2588aa44976b590b5cb4fad

data/README.md

@@ -68,6 +68,15 @@ Unless you've encountered a bug, all exceptions raised by this gem should extend
 
 If a HTTP request to Typeform fails with an error that we expect to be transient (e.g. a 503) we retry the HTTP request up to 3 times, after waiting 1, 2 and 4 seconds. If you'd prefer a fail-fast approach, send us a PR!
 
+Currently, all 404 errors are retried. This is because Typeform occasionally returns a 404 while it's waiting to achieve consistency. For more, see `lib/typeform_data/requestor.rb`.
+
+### Logging
+
+This gem logs error and warning messages to $stdout by default. If you want to log to elsewhere, or in a different format, you can pass in your own logger object (anything that implements the same interface as the [default Ruby logger](https://ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html)) like this:
+
+```
+TypeformData::Client.new(api_key: 'YOUR API KEY', logger: logger)
+```
 
 ## Notes on the API
 

data/lib/typeform_data/client.rb

@@ -6,13 +6,16 @@ module TypeformData
 
     # For the sake of usability, we're breaking convention here and accepting an API key as the
     # first parameter instead of an instance of TypeformData::Config.
-    def initialize(api_key:)
-      @config = TypeformData::Config.new(api_key: api_key)
+    # @param api_key [String]
+    # @param logger [Object] Should implement the same API as
+    # https://ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html)
+    def initialize(api_key:, logger: nil)
+      @config = TypeformData::Config.new(api_key: api_key, logger: logger)
     end
 
     def self.new_from_config(config)
       raise TypeformData::ArgumentError, 'Missing config' unless config
-      new(api_key: config.api_key)
+      new(api_key: config.api_key, logger: config.logger)
     end
 
     # Your API key will automatically be added to the request URL as a query param, as required by

data/lib/typeform_data/config.rb

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
+require 'logger'
+
 module TypeformData
   class Config
     attr_reader :api_key
+    attr_reader :logger
 
-    def initialize(api_key:)
+    # @param api_key [String]
+    # @param logger [Object] Should implement the same API as
+    # https://ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html
+    def initialize(api_key:, logger: nil)
       unless api_key.is_a?(String) && api_key.length.positive?
         raise TypeformData::ArgumentError, 'An API key (as a nonempty String) is required'
       end
       @api_key = api_key
+      @logger = logger || Logger.new($stdout)
     end
 
     # These values were determined via URI.parse('https://api.typeform.com').

data/lib/typeform_data/requestor.rb

@@ -11,12 +11,19 @@ module TypeformData
 
       Errno::ECONNREFUSED,
       TypeformData::TransientResponseError,
+
+      # Sometimes it takes a while before Typeform's state becomes consistent. In particular, this
+      # can be an issue if you receive a webhook for a form response, then immediately request that
+      # response from Typeform's servers.
+      TypeformData::InvalidEndpointOrMissingResource,
     ].freeze
 
-    RETRY_RESPONSE_CLASSES = [
+    TRANSIENT_RESPONSE_CLASSES = [
       Net::HTTPServiceUnavailable,
       Net::HTTPTooManyRequests,
       Net::HTTPBadGateway,
+      Net::HTTPGatewayTimeOut,
+      Net::HTTPInternalServerError,
     ].freeze
 
     def self.get(config, endpoint, params = nil)
@@ -34,7 +41,7 @@ module TypeformData
       params[:key] = config.api_key
 
       begin
-        Utils.retry_with_exponential_backoff(RETRY_EXCEPTIONS, max_retries: 3) do
+        Utils.retry_with_exponential_backoff(config, RETRY_EXCEPTIONS, max_retries: 3) do
           request_and_validate_response(config, method_class, path, params)
         end
       rescue *RETRY_EXCEPTIONS => error
@@ -58,7 +65,7 @@ module TypeformData
       when Net::HTTPBadRequest
         raise TypeformData::BadRequest, 'Response was a Net::HTTPBadRequest with body: '\
           "#{response.body}. Your request with params: #{params} could not be processed."
-      when *RETRY_RESPONSE_CLASSES
+      when *TRANSIENT_RESPONSE_CLASSES
         raise TypeformData::TransientResponseError, "Response was a #{response.class} "\
           "(code #{response.code}) with message #{response.message}"
       else

data/lib/typeform_data/utils.rb

@@ -3,16 +3,20 @@ module Utils
 
   # Repeats the block until it succeeds or a limit is reached, waiting twice as long as it
   # previously did after each failure.
+  # @param config [TypeformData::Config]
   # @param rescued_exceptions [Class] Subclasses of Exception.
   # @param max_retries [Integer]
   # @param initial_wait [Integer] In seconds.
-  def self.retry_with_exponential_backoff(rescued_exceptions, max_retries: 5, initial_wait: 1)
+  def self.retry_with_exponential_backoff(config, retry_exceptions, max_retries: 5, initial_wait: 1)
     seconds_to_wait = initial_wait
 
     max_retries.times do |iteration|
       begin
         break yield
-      rescue *rescued_exceptions
+      rescue *retry_exceptions
+        config.logger.warn "Retry. Waiting #{seconds_to_wait}s, attempt #{iteration} of "\
+          "#{max_retries}."
+
         sleep seconds_to_wait
         seconds_to_wait *= 2
 

data/lib/typeform_data/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module TypeformData
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typeform_data
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Max Wallace
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler