survey-gizmo-ruby 5.0.4 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2d8dfa46ed2f287166d32c156466b1ff39d84b7
-  data.tar.gz: c22d6cb33d3e3a57fe6d848e33011dd9c5f860ad
+  metadata.gz: 30f8503c9d46c13e9b4e6eb1d4f43b590b3190b9
+  data.tar.gz: 00583ecebd74b93a0d6c9111860f45ef8b79e289
 SHA512:
-  metadata.gz: 89cda081f559f84fb5c19493ddb11e2f48bd0d8c4ff26d76ab6f4d8320428dc5dbfc7561cbbf929a67fb4217cae391414b269eeb6a330c2a7fb3f9549d1986eb
-  data.tar.gz: 06cac087f8f21a42fe5a6e2c535d0e407fac2d86fa39967778942e68ce469419dadb7e56308a47a95e48c1e87d5241788d9465792b7356d48805bf2372995f2d
+  metadata.gz: 4332bf1ec4094d68e58866578c2a1b6a31755e0d59127c162502cf73a7e47d7dab52dddbbce4a1b24dcdbdf0f2070896f4e7c48b283f8780a2c74ebe264dbd87
+  data.tar.gz: 8569ffac734405c8e1d54afbdd2c458dfdbd609a35650b676708c508e64c7d45370e18a49be0ee2b43a691700e2c4ef3077abec2311dcdc5bc57e80613ee85d7

data/README.md

@@ -8,6 +8,10 @@ Currently supports SurveyGizmo API **v4** (default) and **v3**.
 
 ## Versions
 
+### Major Changes in 6.x
+* **BREAKING CHANGE**: SurveyGizmo changed the authentication so you need to configure `api_token` and `api_token_secret` instead of user and password.
+* **BREAKING CHANGE**: Pester has been removed as the retry source in favor of Faraday's `Request::Retry`.
+
 ### Major Changes in 5.x
 
 * **BREAKING CHANGE**: `.all` returns an `Enumerator`, not an `Array`. This will break your code if you are using the return value of `.all` without iterating over it.
@@ -47,8 +51,8 @@ require 'survey-gizmo-ruby'
 
 # Configure your credentials
 SurveyGizmo.configure do |config|
-  config.user = 'still_tippin@woodgraingrip.com'
-  config.password = 'it_takes_grindin_to_be_a_king'
+  config.api_token = 'still_tippin_woodgraingrip'
+  config.api_token_secret = 'it_takes_grindin_to_be_a_king'
 
   # Optional - Defaults to v4, but you can probably set to v3 safely if you suspect a bug in v4
   config.api_version = 'v4'
@@ -61,32 +65,28 @@ 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
 end
 ```
 
-### Retries
+`api_token` and `api_token_secret` can be read from environment variables, in which case you would set them like this:
 
-The [Pester](https://github.com/lumoslabs/pester) gem is used to manage retry strategies.  By default it will be configured to handle 1 retry with a 60 second timeout upon encountering basic net timeouts and rate limit errors, which is enough for most people's needs.
+```bash
+$ export SURVEYGIZMO_API_TOKEN=till_tippin_woodgraingrip
+$ export SURVEYGIZMO_API_TOKEN_SECRET=it_takes_grindin_to_be_a_king
+$ bundle exec ruby whatever
+```
 
-If, however, you want to specify more retries, a longer backoff, new classes to retry on, or otherwise get fancy with the retry strategy, you can configured Pester directly.  SurveyGizmo API calls are executed in Pester's `survey_gizmo_ruby` environment, so anything you configure there will apply to all your requests.
+And then your ruby code just has to make sure to call
 
 ```ruby
-# For example, to change the retry interval, max attempts, or exception classes to be retried:
-Pester.configure do |config|
-  # Retry 10 times
-  config.environments[:survey_gizmo_ruby][:max_attempts] = 10
-  # Backoff for 2 minutes
-  config.environments[:survey_gizmo_ruby][:delay_interval] = 120
-  # Retry different exception classes
-  config.environments[:survey_gizmo_ruby][:retry_error_classes] = [MyExceptionClass, MyOtherExceptionClass]
-end
+SurveyGizmo.configure
+````
 
-# To set Pester to retry on ALL exception classes, do this:
-# (use with caution! Can include exceptions Rails likes to throw on SIGHUP)
-Pester.configure do |config|
-  config.environments[:survey_gizmo_ruby][:retry_error_classes] = nil
-end
-```
+once at some point.
 
 ## Usage
 

data/lib/survey-gizmo-ruby.rb

@@ -11,7 +11,6 @@ require 'digest/md5'
 require 'faraday'
 require 'faraday_middleware'
 require 'logger'
-require 'pester'
 require 'virtus'
 
 path = File.join(File.expand_path(File.dirname(__FILE__)), 'survey_gizmo')

data/lib/survey_gizmo/configuration.rb

@@ -10,48 +10,12 @@ module SurveyGizmo
     def configure
       @configuration ||= Configuration.new
       yield(configuration) if block_given?
-      configure_pester
     end
 
     def reset!
       self.configuration = Configuration.new
-      Pester.configure { |c| c.environments[:survey_gizmo_ruby] = nil }
-      configure_pester
       Connection.reset!
     end
-
-    private
-
-    def configure_pester
-      default_config = {
-        on_retry: Pester::Behaviors::Sleep::Constant,
-        logger: configuration.logger,
-        max_attempts: 2,
-        delay_interval: 60,
-        retry_error_classes: retryables
-      }
-
-      Pester.configure do |c|
-        if c.environments[:survey_gizmo_ruby].nil?
-          c.environments[:survey_gizmo_ruby] = default_config
-        else
-          default_config.each { |k,v| c.environments[:survey_gizmo_ruby][k] ||= v unless k == :retry_error_classes }
-
-          # Don't set :retry_error_classes to something when user has configured nothing
-          if c.environments[:survey_gizmo_ruby][:retry_error_classes].nil? && !c.environments[:survey_gizmo_ruby].has_key?(:retry_error_classes)
-            c.environments[:survey_gizmo_ruby][:retry_error_classes] = retryables
-          end
-        end
-      end
-    end
-
-    def retryables
-      [
-        Net::ReadTimeout,
-        Faraday::Error::TimeoutError,
-        SurveyGizmo::RateLimitExceededError
-      ]
-    end
   end
 
   class Configuration
@@ -59,22 +23,35 @@ module SurveyGizmo
     DEFAULT_API_VERSION = 'v4'
     DEFAULT_RESULTS_PER_PAGE = 50
     DEFAULT_TIMEOUT_SECONDS = 300
+    DEFAULT_RETRIES = 3
+    DEFAULT_RETRY_INTERVAL = 60
 
-    attr_accessor :user
-    attr_accessor :password
+    attr_accessor :api_token
+    attr_accessor :api_token_secret
 
     attr_accessor :api_debug
     attr_accessor :api_url
     attr_accessor :api_version
     attr_accessor :logger
     attr_accessor :results_per_page
+
     attr_accessor :timeout_seconds
+    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_url = DEFAULT_REST_API_URL
       @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
+
       @logger = SurveyGizmo::Logger.new(STDOUT)
       @api_debug = ENV['GIZMO_DEBUG'].to_s =~ /^(true|t|yes|y|1)$/i
     end

data/lib/survey_gizmo/connection.rb

@@ -14,19 +14,37 @@ module SurveyGizmo
       def connection
         options = {
           url: SurveyGizmo.configuration.api_url,
-          params: { 'user:md5' => "#{SurveyGizmo.configuration.user}:#{Digest::MD5.hexdigest(SurveyGizmo.configuration.password)}" },
+          params: {
+            api_token: SurveyGizmo.configuration.api_token,
+            api_token_secret: SurveyGizmo.configuration.api_token_secret
+          },
           request: {
             timeout: SurveyGizmo.configuration.timeout_seconds,
             open_timeout: SurveyGizmo.configuration.timeout_seconds
           }
         }
 
+        retry_options = {
+          max: SurveyGizmo.configuration.retry_attempts,
+          interval: SurveyGizmo.configuration.retry_interval,
+          exceptions: [
+            SurveyGizmo::BadResponseError,
+            SurveyGizmo::RateLimitExceededError,
+            Errno::ETIMEDOUT,
+            Net::ReadTimeout,
+            Faraday::Error::TimeoutError,
+            'Timeout::Error',
+            'Error::TimeoutError'
+          ]
+        }
+
         @connection ||= Faraday.new(options) do |connection|
+          connection.request :retry, retry_options
           connection.request :url_encoded
 
           connection.response :parse_survey_gizmo_data
           connection.response :pester_survey_gizmo
-          connection.response :logger, @logger, bodies: true if SurveyGizmo.configuration.api_debug
+          connection.response :logger, SurveyGizmo.configuration.logger, bodies: true if SurveyGizmo.configuration.api_debug
           connection.response :json, content_type: /\bjson$/
 
           connection.adapter Faraday.default_adapter

data/lib/survey_gizmo/faraday_middleware/pester_survey_gizmo.rb

@@ -6,12 +6,10 @@ module SurveyGizmo
     Faraday::Response.register_middleware(pester_survey_gizmo: self)
 
     def call(environment)
-      Pester.survey_gizmo_ruby.retry do
-        @app.call(environment).on_complete do |response|
-          fail RateLimitExceededError if response.status == 429
-          fail BadResponseError, "Bad response code #{response.status} in #{response.inspect}" unless response.status == 200
-          fail BadResponseError, response.body['message'] unless response.body['result_ok'] && response.body['result_ok'].to_s =~ /^true$/i
-        end
+      @app.call(environment).on_complete do |response|
+        fail RateLimitExceededError if response.status == 429
+        fail BadResponseError, "Bad response code #{response.status} in #{response.inspect}" unless response.status == 200
+        fail BadResponseError, response.body['message'] unless response.body['result_ok'] && response.body['result_ok'].to_s =~ /^true$/i
       end
     end
   end

data/lib/survey_gizmo/logger.rb

@@ -3,6 +3,9 @@ require 'logger'
 module SurveyGizmo
   class Logger < ::Logger
     def format_message(severity, timestamp, progname, msg)
+      msg.gsub!(/#{Regexp.quote(SurveyGizmo.configuration.api_token)}/, '<SG_API_KEY>') if SurveyGizmo.configuration.api_token
+      msg.gsub!(/#{Regexp.quote(SurveyGizmo.configuration.api_token_secret)}/, '<SG_API_SECRET>') if SurveyGizmo.configuration.api_token_secret
+
       "#{timestamp.strftime('%Y-%m-%d %H:%M:%S')} #{severity} #{msg}\n"
     end
   end

data/lib/survey_gizmo/resource.rb

@@ -35,10 +35,10 @@ module SurveyGizmo
       # Properties from the conditions hash (e.g. survey_id) will be added to the returned objects
       def all(conditions = {})
         fail ':all_pages and :page are mutually exclusive' if conditions[:page] && conditions[:all_pages]
-        logger.warn('WARNING: Only retrieving first page of results!') if conditions[:page].nil? && conditions[:all_pages].nil?
+        logger.warn('WARNING: Only retrieving first page of results!') unless conditions[:page] || conditions[:all_pages]
 
         all_pages = conditions.delete(:all_pages)
-        conditions[:resultsperpage] = SurveyGizmo.configuration.results_per_page unless conditions[:resultsperpage]
+        conditions[:resultsperpage] ||= SurveyGizmo.configuration.results_per_page
 
         Enumerator.new do |yielder|
           response = nil
@@ -78,8 +78,8 @@ module SurveyGizmo
       # @route is either a hash to be used directly or a string from which standard routes will be built
       def routes
         fail "route not set in #{name}" unless @route
-
         return @route if @route.is_a?(Hash)
+
         routes = { create: @route }
         [:get, :update, :delete].each { |k| routes[k] = @route + '/:id' }
         routes
@@ -130,7 +130,7 @@ module SurveyGizmo
 
     ### BELOW HERE ARE INSTANCE METHODS ###
 
-    # If we have an id, it's an update, because we already know the surveygizmo assigned id
+    # If we have an id, it's an update because we already know the surveygizmo assigned id
     # Returns itself if successfully saved, but with attributes (like id) added by SurveyGizmo
     def save
       method, path = id ? [:post, :update] : [:put, :create]

data/lib/survey_gizmo/version.rb

@@ -1,3 +1,3 @@
 module SurveyGizmo
-  VERSION = '5.0.4'
+  VERSION = '6.0.2'
 end

data/spec/configuration_spec.rb

@@ -4,8 +4,8 @@ require 'survey_gizmo/configuration'
 describe SurveyGizmo::Configuration do
   before(:each) do
     SurveyGizmo.configure do |config|
-      config.user = 'test@test.com'
-      config.password = 'password'
+      config.api_token = 'token'
+      config.api_token_secret = 'doken'
     end
   end
 
@@ -15,10 +15,10 @@ describe SurveyGizmo::Configuration do
 
   it 'should allow changing user and pass' do
     SurveyGizmo.configure do |config|
-      config.user = 'slimthug'
-      config.password = 'fourfourz'
+      config.api_token = 'slimthug'
+      config.api_token_secret = 'fourfourz'
     end
 
-    expect(SurveyGizmo::Connection.send(:connection).params).to eq({ 'user:md5'=>'slimthug:836fd7e2961a094c01cb7ba78bac6a06' })
+    expect(SurveyGizmo::Connection.send(:connection).params).to eq('api_token' => 'slimthug', 'api_token_secret' => 'fourfourz')
   end
 end

data/spec/spec_helper.rb

@@ -12,13 +12,13 @@ RSpec.configure do |config|
 
   config.before(:each) do
     SurveyGizmo.configure do |config|
-      config.user = 'test@test.com'
-      config.password = 'password'
-      config.logger.level = Logger::FATAL
-    end
+      config.api_token = 'king_of_the_whirled'
+      config.api_token_secret = 'dreamword'
 
-    Pester.configure do |config|
-      config.environments[:survey_gizmo_ruby][:logger] = ::Logger.new(nil)
+      config.retry_attempts = 0
+      config.retry_interval = 0
+
+      config.logger.level = Logger::FATAL
     end
 
     @base = "#{SurveyGizmo.configuration.api_url}/#{SurveyGizmo.configuration.api_version}"

data/survey-gizmo-ruby.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday', '>= 0.9.1', '~> 0.9'
   gem.add_dependency 'faraday_middleware', '~> 0.10'
   gem.add_dependency 'i18n'
-  gem.add_dependency 'pester', '>= 1.0.0'
   gem.add_dependency 'virtus', '>= 1.0.0'
 
   gem.add_development_dependency 'rspec', '~> 2.11.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 5.0.4
+  version: 6.0.2
 platform: ruby
 authors:
 - Kabari Hendrick
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,20 +103,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pester
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement