survey-gizmo-ruby 6.2.13 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b25acfdc20cabb433979144294134993709267e
-  data.tar.gz: c493b664112b437a7a738c9e9354c06fd5df658c
+  metadata.gz: e99c0f495a8bbdda92408e8392e5d5b1d5b45458
+  data.tar.gz: af1e998bae5ba6ec339bf5deee9c62d55bfacdab
 SHA512:
-  metadata.gz: 32d1d64a9effda473130a1edb11360f3c22533a61aa023cf5e2928ae7591deee514bcae2df6c081c110e32814509623ae21821c3658842ee5a29cb9776a075d1
-  data.tar.gz: 310a3e65c817b0253441eb0db89a836c9bcfb36b1f80281befa6bdd28cbe31c621b0e8c002712392f208bc49b9b693f56f52fddf523e6b0d9043e3e49e3e1bcb
+  metadata.gz: 212d6dbff7ed1156c1ede83363ed6be79c33170eecfc5bef38437db5909d1429e6267206e2c0c2b832661ef2b2ca0773ebc05193e3d7d33c37e1609b28a4c664
+  data.tar.gz: 8ff36651178e6576aa23ff43ef67fa1cd01595d3b34fc6fb83b3d544fafc3df56bab1d4e0046f2afbc8657de6cfe2ae799b0f8aadee40ba79ad221187d42f410

data/CHANGELOG.md

@@ -1,7 +1,11 @@
 # Versions
 
+## 6.3.0
+* Deprecate `retry_attempts` and `retry_interval` configuration options
+* Add ability to set the entire `Retriable` hash directly by configuring `retriable_params`
+
 ## 6.2.13
-* max_elapsed_time of 1 hour for retriable
+* max_elapsed_time of 1 hour for `Retriable`
 
 ## 6.2.12
 * Bugfix: Don't allow option_ids of 0

data/README.md

@@ -38,12 +38,14 @@ SurveyGizmo.configure do |config|
   # Optional - Defaults to 300 seconds
   config.timeout_seconds = 600
 
-  # Optional - Defaults to 3 retries with a 60 second delay interval
-  config.retry_attempts = 3
-  config.retry_interval = 60
+  # Optional - Configure arguments to the Retriable gem directly that will be merged into the defaults
+  config.retriable_params = { tries: 30, max_elapsed_time: 3600 }
 end
 ```
 
+Check the [Retriable](https://github.com/kamui/retriable) documentation for how to configure the `retriable_params` hash.
+The default is to retry 3 times, with 60 seconds before the first retry and a slow exponential backoff after that.
+
 `api_token` and `api_token_secret` can be read from environment variables, in which case you would set them like this:
 
 ```bash

data/lib/survey_gizmo/configuration.rb

@@ -1,3 +1,5 @@
+require 'survey_gizmo/faraday_middleware/parse_survey_gizmo'
+
 module SurveyGizmo
   class << self
     attr_writer :configuration
@@ -10,6 +12,18 @@ module SurveyGizmo
     def configure
       reset!
       yield(@configuration) if block_given?
+
+      if @configuration.retry_attempts
+        @configuration.logger.warn('Configuring retry_attempts is deprecated; pass a retriable_params hash instead.')
+        @configuration.retriable_params[:tries] = @configuration.retry_attempts + 1
+      end
+
+      if @configuration.retry_interval
+        @configuration.logger.warn('Configuring retry_interval is deprecated; pass a retriable_params hash instead.')
+        @configuration.retriable_params[:base_interval] = @configuration.retry_interval
+      end
+
+      @configuration.retriable_params = Configuration::DEFAULT_RETRIABLE_PARAMS.merge(@configuration.retriable_params)
     end
 
     def reset!
@@ -22,8 +36,6 @@ module SurveyGizmo
     DEFAULT_API_VERSION = 'v4'
     DEFAULT_RESULTS_PER_PAGE = 50
     DEFAULT_TIMEOUT_SECONDS = 300
-    DEFAULT_RETRIES = 3
-    DEFAULT_RETRY_INTERVAL = 60
     DEFAULT_REGION = :us
 
     REGION_INFO = {
@@ -37,6 +49,23 @@ module SurveyGizmo
       }
     }
 
+    DEFAULT_RETRIABLE_PARAMS = {
+      base_interval: 60,
+      max_interval: 300,
+      rand_factor: 0,
+      tries: 4,
+      on: [
+        Errno::ETIMEDOUT,
+        Faraday::Error::ClientError,
+        Net::ReadTimeout,
+        SurveyGizmo::BadResponseError,
+        SurveyGizmo::RateLimitExceededError
+      ],
+      on_retry: Proc.new do |exception, tries|
+        SurveyGizmo.configuration.logger.warn("Retrying after #{exception.class}: #{tries} attempts.")
+      end
+    }
+
     attr_accessor :api_token
     attr_accessor :api_token_secret
 
@@ -46,22 +75,21 @@ module SurveyGizmo
     attr_accessor :api_version
     attr_accessor :logger
     attr_accessor :results_per_page
-
     attr_accessor :timeout_seconds
+    attr_accessor :retriable_params
+
+    # TODO Deprecated; remove in 7.0
     attr_accessor :retry_attempts
     attr_accessor :retry_interval
 
-
     def initialize
       @api_token = ENV['SURVEYGIZMO_API_TOKEN'] || nil
       @api_token_secret = ENV['SURVEYGIZMO_API_TOKEN_SECRET'] || nil
 
       @api_version = DEFAULT_API_VERSION
       @results_per_page = DEFAULT_RESULTS_PER_PAGE
-
       @timeout_seconds = DEFAULT_TIMEOUT_SECONDS
-      @retry_attempts = DEFAULT_RETRIES
-      @retry_interval = DEFAULT_RETRY_INTERVAL
+      @retriable_params = DEFAULT_RETRIABLE_PARAMS
       self.region = DEFAULT_REGION
 
       @logger = SurveyGizmo::Logger.new(STDOUT)
@@ -76,5 +104,4 @@ module SurveyGizmo
       @api_time_zone = region_infos[:locale]
     end
   end
-
 end

data/lib/survey_gizmo/connection.rb

@@ -4,19 +4,19 @@ module SurveyGizmo
   class Connection
     class << self
       def get(route)
-        Retriable.retriable(retriable_args) { connection.get(route) }
+        Retriable.retriable(SurveyGizmo.configuration.retriable_params) { connection.get(route) }
       end
 
       def post(route, params)
-        Retriable.retriable(retriable_args) { connection.post(route, params) }
+        Retriable.retriable(SurveyGizmo.configuration.retriable_params) { connection.post(route, params) }
       end
 
       def put(route, params)
-        Retriable.retriable(retriable_args) { connection.put(route, params) }
+        Retriable.retriable(SurveyGizmo.configuration.retriable_params) { connection.put(route, params) }
       end
 
       def delete(route)
-        Retriable.retriable(retriable_args) { connection.delete(route) }
+        Retriable.retriable(SurveyGizmo.configuration.retriable_params) { connection.delete(route) }
       end
 
       def reset!
@@ -48,24 +48,6 @@ module SurveyGizmo
           connection.adapter Faraday.default_adapter
         end
       end
-
-      def retriable_args
-        {
-          base_interval: SurveyGizmo.configuration.retry_interval,
-          tries: SurveyGizmo.configuration.retry_attempts + 1,
-          max_elapsed_time: 3600,
-          on: [
-            Errno::ETIMEDOUT,
-            Faraday::Error::ClientError,
-            Net::ReadTimeout,
-            SurveyGizmo::BadResponseError,
-            SurveyGizmo::RateLimitExceededError
-          ],
-          on_retry: Proc.new do |exception, tries|
-            SurveyGizmo.configuration.logger.warn("Retrying after #{exception.class}: #{tries} attempts.")
-          end
-        }
-      end
     end
   end
 end

data/lib/survey_gizmo/logger.rb

@@ -17,7 +17,7 @@ module SurveyGizmo
         )
       end
 
-      "#{timestamp.strftime('%Y-%m-%d %H:%M:%S')} #{severity} #{message}\n"
+      "[#{timestamp.strftime('%Y-%m-%d %H:%M:%S')} #{severity} (#{Process.pid})] #{message}\n"
     end
   end
 end

data/lib/survey_gizmo/version.rb

@@ -1,3 +1,3 @@
 module SurveyGizmo
-  VERSION = '6.2.13'
+  VERSION = '6.3.0'
 end

data/spec/logger_spec.rb

@@ -1,14 +1,15 @@
 require 'spec_helper'
 
-describe SurveyGizmo::Configuration do
+describe SurveyGizmo::Logger do
+  let(:progname)    { 'TEST' }
+  let(:severity)    { 'INFO' }
+  let(:time_string) { '2015-04-15 05:46:30' }
+
   before(:each) do
     SurveyGizmo.configure do |config|
       config.api_token = 'king_of_the&whirled$'
       config.api_token_secret = 'dream/word'
     end
-    @severity = 'INFO'
-    @time_string = '2015-04-15 05:46:30'
-    @progname = 'TEST'
   end
 
   after(:each) do
@@ -18,60 +19,60 @@ describe SurveyGizmo::Configuration do
   it 'should mask unencoded api token' do
     config = SurveyGizmo.configuration
     formatted_message = config.logger.format_message(
-      @severity,
-      @time_string.to_time,
-      @progname,
+      severity,
+      time_string.to_time,
+      progname,
       config.api_token
     )
     expect(
       formatted_message
-    ).to eq(
-      "#{@time_string} #{@severity} <SG_API_KEY>\n"
+    ).to match(
+      /\[#{time_string} #{severity} \(\d+\)\] <SG_API_KEY>/
     )
   end
 
   it 'should mask percent encoded api token' do
     config = SurveyGizmo.configuration
     formatted_message = config.logger.format_message(
-      @severity,
-      @time_string.to_time,
-      @progname,
+      severity,
+      time_string.to_time,
+      progname,
       CGI.escape(config.api_token)
     )
     expect(
       formatted_message
-    ).to eq(
-      "#{@time_string} #{@severity} <SG_API_KEY>\n"
+    ).to match(
+      /\[#{time_string} #{severity} \(\d+\)\] <SG_API_KEY>/
     )
   end
 
   it 'should mask unencoded api token secret' do
     config = SurveyGizmo.configuration
     formatted_message = config.logger.format_message(
-      @severity,
-      @time_string.to_time,
-      @progname,
+      severity,
+      time_string.to_time,
+      progname,
       config.api_token_secret
     )
     expect(
       formatted_message
-    ).to eq(
-      "#{@time_string} #{@severity} <SG_API_SECRET>\n"
+    ).to match(
+      /\[#{time_string} #{severity} \(\d+\)\] <SG_API_SECRET>/
     )
   end
 
   it 'should mask percent encoded api token secret' do
     config = SurveyGizmo.configuration
     formatted_message = config.logger.format_message(
-      @severity,
-      @time_string.to_time,
-      @progname,
+      severity,
+      time_string.to_time,
+      progname,
       CGI.escape(config.api_token_secret)
     )
     expect(
       formatted_message
-    ).to eq(
-      "#{@time_string} #{@severity} <SG_API_SECRET>\n"
+    ).to match(
+      /\[#{time_string} #{severity} \(\d+\)\] <SG_API_SECRET>/
     )
   end
 end

data/spec/spec_helper.rb

@@ -14,10 +14,7 @@ RSpec.configure do |config|
     SurveyGizmo.configure do |config|
       config.api_token = 'king_of_the_whirled'
       config.api_token_secret = 'dreamword'
-
-      config.retry_attempts = 0
-      config.retry_interval = 0
-
+      config.retriable_params = { tries: 1, base_interval: 0 }
       config.logger.level = Logger::FATAL
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 6.2.13
+  version: 6.3.0
 platform: ruby
 authors:
 - Kabari Hendrick
@@ -259,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Gem to use the SurveyGizmo.com REST API, v3+
@@ -275,4 +275,3 @@ test_files:
 - spec/test_json/page.json
 - spec/test_json/question.json
 - spec/test_json/survey.json
-has_rdoc: