typeform_data 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edd3d6b08e718fd4c2429253873d9c5b269774d6
-  data.tar.gz: 8939f372f3a5fba107d4879b56ee04c02c2a885b
+  metadata.gz: d70cdb5034873b422938f7cf426b0b1341a992ab
+  data.tar.gz: a36e89135238d96c2ebe7ea0466c56fbf2f2b23f
 SHA512:
-  metadata.gz: d54650fab170d77b860f49d9839d88039f2280ccf24401272f089ba303ce51cc1839628f8980bb2e5bb35256d481318c5cccd4ceb6672c42b821980c4d534111
-  data.tar.gz: dd0308219f6e615bb0ac9e2218b450246c116212ac54fc1876261f4432aee99e53c9621ad9cb7fd4127b02ffc15e90631f65189e2a9ed45a85dce8bb17156b95
+  metadata.gz: 5ec3a03e56573d5b75fed0aff79d2f1a54dfeb176433c7afc1621e6532a76e7fb31a0ca9ca8477ca41c78ba04b9ef8b05ea4b0b5c9c88df2a7e870ea3ea47ed1
+  data.tar.gz: 38532360add588301c0e3c3621088e72dba3ccc7758cecd1a84f43ae4eb27a4824010a32db4ae0d874088573f5a6b3fd1ebf14ec517ed3b869f989124394858a

data/.rubocop.yml

@@ -152,3 +152,6 @@ Style/DoubleNegation:
 # trusted source.
 Security/MarshalLoad:
   Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false

data/README.md

@@ -62,6 +62,13 @@ deserialized = client.load(serialized)
 => true
 ```
 
+### Error-handling
+
+Unless you've encountered a bug, all exceptions raised by this gem should extend from `TypeformData::Error`. For the full exception hierarchy, see `lib/typeform_data/errors`.
+
+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!
+
+
 ## Notes on the API
 
 So far, we've found Typeform's current Data API to be confusing. In particular, there are a couple design decisions that have been a source of friction for us:

data/Rakefile

@@ -2,8 +2,7 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs = ['test', 'lib']
   t.test_files = FileList['test/**/*_test.rb']
 end
 

data/lib/typeform_data.rb

@@ -5,6 +5,7 @@ require 'net/https'
 require 'uri'
 require 'json'
 
+require 'typeform_data/utils'
 require 'typeform_data/version'
 require 'typeform_data/client'
 require 'typeform_data/errors'

data/lib/typeform_data/client.rb

@@ -11,7 +11,7 @@ module TypeformData
     end
 
     def self.new_from_config(config)
-      raise ArgumentError, 'Missing config' unless config
+      raise TypeformData::ArgumentError, 'Missing config' unless config
       new(api_key: config.api_key)
     end
 
@@ -27,12 +27,12 @@ module TypeformData
 
     def all_typeforms
       get('forms').parsed_json.map do |form_hash|
-        ::TypeformData::Typeform.new(@config, form_hash)
+        TypeformData::Typeform.new(@config, form_hash)
       end
     end
 
     def typeform(id)
-      ::TypeformData::Typeform.new(@config, id: id)
+      TypeformData::Typeform.new(@config, id: id)
     end
 
     def dump(object)

data/lib/typeform_data/comparable_by_id_and_config.rb

@@ -10,14 +10,14 @@ module TypeformData
 
     def ==(other)
       unless other.respond_to?(:sort_key, true) && other.respond_to?(:config, true)
-        raise ArgumentError, "#{other.inspect} does not specify a sort key and config"
+        raise TypeformData::ArgumentError, "#{other.inspect} does not specify a sort key and config"
       end
       other.sort_key == sort_key && other.config == config
     end
 
     def <=>(other)
       unless other.respond_to?(:sort_key)
-        raise ArgumentError, "#{other.inspect} does not specify a sort key"
+        raise TypeformData::ArgumentError, "#{other.inspect} does not specify a sort key"
       end
       other.sort_key <=> sort_key
     end

data/lib/typeform_data/config.rb

@@ -5,7 +5,7 @@ module TypeformData
 
     def initialize(api_key:)
       unless api_key.is_a?(String) && api_key.length.positive?
-        raise ArgumentError, 'An API key (as a nonempty String) is required'
+        raise TypeformData::ArgumentError, 'An API key (as a nonempty String) is required'
       end
       @api_key = api_key
     end

data/lib/typeform_data/errors.rb

@@ -1,13 +1,28 @@
 # frozen_string_literal: true
 module TypeformData
+
   class Error < StandardError; end
-  class InvalidApiKey < Error; end
-  class ConnectionRefused < Error; end
-  class BadRequest < Error; end
+
   class ArgumentError < Error; end
+
+  class InvalidApiKey < Error; end
+
   class UnexpectedError < Error; end
 
+  class UnexpectedHttpError < UnexpectedError; end
+  class UnexpectedHttpResponse < UnexpectedHttpError; end
+  class BadRequest < UnexpectedHttpResponse; end
+  class TransientResponseError < UnexpectedHttpResponse; end
+
   # When using the 'token' field in requests, the API may return a 404 even if the endpoint path
   # is correct.
   class InvalidEndpointOrMissingResource < Error; end
+
+  module Errors
+    def self.stringify_error(error)
+      "#{error.backtrace.first}: #{error.message} (#{error.class})\n" +
+        error.backtrace.drop(1).map { |line| "\t#{line}\n" }.join
+    end
+  end
+
 end

data/lib/typeform_data/requestor.rb

@@ -1,25 +1,74 @@
 # frozen_string_literal: true
+require 'typeform_data/utils'
 
 module TypeformData
   module Requestor
 
+    RETRY_EXCEPTIONS = [
+      # We wouldn't ordinarily retry in this case, but Typeform appears to have transient issues
+      # with their SSL.
+      OpenSSL::SSL::SSLError,
+
+      Errno::ECONNREFUSED,
+      TypeformData::TransientResponseError,
+    ].freeze
+
+    RETRY_RESPONSE_CLASSES = [
+      Net::HTTPServiceUnavailable,
+      Net::HTTPTooManyRequests,
+      Net::HTTPBadGateway,
+    ].freeze
+
     def self.get(config, endpoint, params = nil)
       request(config, Net::HTTP::Get, request_path(config, endpoint), params)
     end
 
-    def self.request_path(config, endpoint)
+    private_class_method def self.request_path(config, endpoint)
       "/v#{config.api_version}/#{endpoint}"
     end
 
-    private_class_method :request_path
-
-    # rubocop:disable Metrics/MethodLength
+    # @raise TypeformData::Error
     # @return TypeformData::ApiResponse
-    def self.request(config, method_class, path, input_params = {})
+    private_class_method def self.request(config, method_class, path, input_params = {})
       params = input_params.dup
       params[:key] = config.api_key
 
-      response = Net::HTTP.new(config.host, config.port).tap { |http|
+      begin
+        Utils.retry_with_exponential_backoff(RETRY_EXCEPTIONS, max_retries: 3) do
+          request_and_validate_response(config, method_class, path, params)
+        end
+      rescue *RETRY_EXCEPTIONS => error
+        raise UnexpectedHttpError, 'Unexpected HTTP error (retried 3 times): ' +
+                                   TypeformData::Errors.stringify_error(error)
+      end
+    end
+
+    # @return TypeformData::ApiResponse
+    private_class_method def self.request_and_validate_response(config, method_class, path, params)
+      response = request_response(config, method_class, path, params)
+
+      case response
+      when Net::HTTPSuccess
+        return TypeformData::ApiResponse.new(response)
+
+      when Net::HTTPNotFound
+        raise TypeformData::InvalidEndpointOrMissingResource, path
+      when Net::HTTPForbidden
+        raise TypeformData::InvalidApiKey, "Invalid api key: #{config.api_key}"
+      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
+        raise TypeformData::TransientResponseError, "Response was a #{response.class} "\
+          "(code #{response.code}) with message #{response.message}"
+      else
+        raise TypeformData::UnexpectedHttpResponse, 'Unexpected HTTP response with code: '\
+          "#{response.code} and message: #{response.message}"
+      end
+    end
+
+    private_class_method def self.request_response(config, method_class, path, params)
+      Net::HTTP.new(config.host, config.port).tap { |http|
         http.use_ssl = true
 
         # Uncomment this line for debugging:
@@ -30,28 +79,14 @@ module TypeformData
           'Content-Type' => 'application/json'
         )
       )
+    rescue *RETRY_EXCEPTIONS
+      raise # So retry_with_exponential_backoff can catch the exception and retry.
 
-      case response
-      when Net::HTTPNotFound then
-        raise TypeformData::InvalidEndpointOrMissingResource, path
-      when Net::HTTPForbidden then
-        raise TypeformData::InvalidApiKey, "Invalid api key: #{config.api_key}"
-      when Net::HTTPBadRequest then
-        raise TypeformData::BadRequest, 'There was an error processing your request: '\
-          "#{response.body}, with params: #{params}"
-      when Net::HTTPSuccess
-        return TypeformData::ApiResponse.new(response)
-      else
-        raise TypeformData::UnexpectedError, "A #{response.code} error has occurred: "\
-          "'#{response.message}'"
-      end
-
-    rescue Errno::ECONNREFUSED
-      raise TypeformData::ConnectionRefused, 'The connection was refused'
+    # Why are we rescuing StandardError? See http://stackoverflow.com/a/11802674/1067145
+    rescue StandardError => error
+      raise UnexpectedHttpError, 'Unexpected HTTP error: ' +
+                                 TypeformData::Errors.stringify_error(error)
     end
-    # rubocop:enable Metrics/MethodLength
-
-    private_class_method :request
 
   end
 end

data/lib/typeform_data/typeform.rb

@@ -142,24 +142,24 @@ module TypeformData
       params = input_params.dup
 
       params.keys.select { |key| key.is_a?(Symbol) }.each do |sym|
-        raise ::TypeformData::ArgumentError, 'Duplicate keys' if params.key?(sym.to_s)
+        raise TypeformData::ArgumentError, 'Duplicate keys' if params.key?(sym.to_s)
         params[sym.to_s] = params[sym]
         params.delete(sym)
       end
 
       params.keys.each do |key|
         next if PERMITTED_KEYS.key?(key) && params[key].is_a?(PERMITTED_KEYS[key])
-        raise ::TypeformData::ArgumentError, "Invalid/unsupported param: #{key}"
+        raise TypeformData::ArgumentError, "Invalid/unsupported param: #{key}"
       end
 
       if params['limit'] && params['limit'] > MAX_PAGE_SIZE
-        raise ::TypeformData::ArgumentError, "The maximum limit is #{MAX_PAGE_SIZE}. You "\
+        raise TypeformData::ArgumentError, "The maximum limit is #{MAX_PAGE_SIZE}. You "\
           "provided: #{params['limit']}"
       end
 
       if params['token']
         if params.keys.length > 1
-          raise ::TypeformData::ArgumentError, "'token' may not be combined with other filters"
+          raise TypeformData::ArgumentError, "'token' may not be combined with other filters"
         end
       else
         params['offset'] ||= 0

data/lib/typeform_data/utils.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+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 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)
+    seconds_to_wait = initial_wait
+
+    max_retries.times do |iteration|
+      begin
+        break yield
+      rescue *rescued_exceptions
+        sleep seconds_to_wait
+        seconds_to_wait *= 2
+
+        raise if iteration == max_retries - 1
+      end
+    end
+  end
+
+end

data/lib/typeform_data/value_class.rb

@@ -6,7 +6,8 @@ module TypeformData
 
     def initialize(config, attrs)
       unless config && config.is_a?(TypeformData::Config)
-        raise ArgumentError, 'Expected a TypeformData::Config instance as the first argument'
+        raise TypeformData::ArgumentError, 'Expected a TypeformData::Config instance as the first '\
+          'argument'
       end
       @config = config
 

data/lib/typeform_data/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typeform_data
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Max Wallace
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,6 +169,7 @@ files:
 - lib/typeform_data/typeform/question.rb
 - lib/typeform_data/typeform/response.rb
 - lib/typeform_data/typeform/stats.rb
+- lib/typeform_data/utils.rb
 - lib/typeform_data/value_class.rb
 - lib/typeform_data/version.rb
 - typeform_data.gemspec