survey-gizmo-ruby 6.1.2 → 6.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f278de3b358b26c742f439c74da14b9cede1df7
-  data.tar.gz: f2fa277155e842c93dc98c9b927cb129893b2311
+  metadata.gz: 0d6ac831f23cde9a33a402318e0156e444e8a4fe
+  data.tar.gz: 26c120f520f737920fb22d55344210dd06b31875
 SHA512:
-  metadata.gz: bec15907fc482a6ae12fd09aff10a7eb68723eb8ec4cbdc38234348da4c52aa6ecc80eac0877c78d9ef6fec4a797672a5c81f05e6969e853a58c2eed8b8c6c44
-  data.tar.gz: 698358708e14e25993e1ff3bc075c66f3f9202d44054dddbce29f770ae76bbd0c4618c89eac6d663f8997a78a02ee2b75b0d1cff619223bc627f0c0744265c8e
+  metadata.gz: f39778fccf60c152b5b53856f7289382b95a727da34900f6bc8ebcba4be621a8943b3c7d4c5f86e9b12ca439668d8423b66471dfcc86f0f29f93a5356032db93
+  data.tar.gz: fa8e6251c2634bba965bf2097be1f9f5937acb2c28f339733a5ccb6c889cfaf6dd3d18d26c19b7dd13b17a29cb4dceaef63d99fdce7fab77e8aaec93ef90e6e3

data/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 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 `Retriable`.
+* FEATURE: `Configuration#region` will configure the region to use the corresponding api and time zone.
 
 ## Major Changes in 5.x
 

data/README.md

@@ -29,8 +29,8 @@ SurveyGizmo.configure do |config|
   # Optional - Defaults to v4, but you can probably set to v3 safely if you suspect a bug in v4
   config.api_version = 'v4'
 
-  # Optional - Set if you need to hit a different base URL (e.g. the .eu domain)
-  config.api_url = 'https://restapi.surveygizmo.eu'
+  # Optional - Set if you need to hit a different region (e.g. the .eu domain)
+  config.region = :eu
 
   # Optional - Defaults to 50, maximum 500. Setting too high may cause SurveyGizmo to start throwing timeouts.
   config.results_per_page = 100

data/lib/survey-gizmo-ruby.rb

@@ -11,6 +11,7 @@ require 'digest/md5'
 require 'faraday'
 require 'faraday_middleware'
 require 'logger'
+require 'net/http'
 require 'retriable'
 require 'virtus'
 

data/lib/survey_gizmo/api/response.rb

@@ -10,7 +10,7 @@ module SurveyGizmo::API
       {
         field: 'datesubmitted',
         operator: '>=',
-        value: time.in_time_zone(SurveyGizmo::Configuration::SURVEYGIZMO_TIME_ZONE).strftime('%Y-%m-%d %H:%M:%S')
+        value: time.in_time_zone(SurveyGizmo.configuration.api_time_zone).strftime('%Y-%m-%d %H:%M:%S')
       }
     end
 

data/lib/survey_gizmo/configuration.rb

@@ -19,19 +19,30 @@ module SurveyGizmo
   end
 
   class Configuration
-    DEFAULT_REST_API_URL = 'https://restapi.surveygizmo.com'
     DEFAULT_API_VERSION = 'v4'
     DEFAULT_RESULTS_PER_PAGE = 50
     DEFAULT_TIMEOUT_SECONDS = 300
     DEFAULT_RETRIES = 3
     DEFAULT_RETRY_INTERVAL = 60
-    SURVEYGIZMO_TIME_ZONE = 'Eastern Time (US & Canada)'
+    DEFAULT_REGION = :us
+
+    REGION_INFO = {
+      us: {
+        url: 'https://restapi.surveygizmo.com',
+        locale: 'Eastern Time (US & Canada)'
+      },
+      eu: {
+        url: 'https://restapi.surveygizmo.eu',
+        locale: 'Berlin'
+      }
+    }
 
     attr_accessor :api_token
     attr_accessor :api_token_secret
 
     attr_accessor :api_debug
     attr_accessor :api_url
+    attr_accessor :api_time_zone
     attr_accessor :api_version
     attr_accessor :logger
     attr_accessor :results_per_page
@@ -45,16 +56,25 @@ module SurveyGizmo
       @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
+      self.region = DEFAULT_REGION
 
       @logger = SurveyGizmo::Logger.new(STDOUT)
       @api_debug = ENV['GIZMO_DEBUG'].to_s =~ /^(true|t|yes|y|1)$/i
     end
+
+    def region=(region)
+      region_infos = REGION_INFO[region]
+      ArgumentError.new("Unknown region: #{region}") unless region_infos
+
+      @api_url = region_infos[:url]
+      @api_time_zone = region_infos[:locale]
+    end
   end
+
 end

data/lib/survey_gizmo/faraday_middleware/parse_survey_gizmo.rb

@@ -42,7 +42,7 @@ module SurveyGizmo
         # SurveyGizmo returns date information using US/Eastern timezone but does not provide time zone information.
         # See https://apihelp.surveygizmo.com/help/article/link/surveyresponse-returned-fields#examplereturns
         TIME_FIELDS.each do |time_key|
-          datum[time_key] = ActiveSupport::TimeZone.new(SurveyGizmo::Configuration::SURVEYGIZMO_TIME_ZONE).parse(datum[time_key]) unless datum[time_key].blank?
+          datum[time_key] = ActiveSupport::TimeZone.new(SurveyGizmo.configuration.api_time_zone).parse(datum[time_key]) unless datum[time_key].blank?
         end
 
         datum.keys.grep(/^\[/).each do |key|

data/lib/survey_gizmo/version.rb

@@ -1,3 +1,3 @@
 module SurveyGizmo
-  VERSION = '6.1.2'
+  VERSION = '6.1.3'
 end

data/spec/configuration_spec.rb

@@ -24,4 +24,39 @@ describe SurveyGizmo::Configuration do
 
     expect(SurveyGizmo::Connection.send(:connection).params).to eq('api_token' => 'slimthug', 'api_token_secret' => 'fourfourz')
   end
+
+  describe '#region=' do
+    it 'should set US region by default' do
+      SurveyGizmo.configure
+      expect(SurveyGizmo.configuration.api_url).to eq('https://restapi.surveygizmo.com')
+      expect(SurveyGizmo.configuration.api_time_zone).to eq('Eastern Time (US & Canada)')
+    end
+
+    it 'should set US region with :us symbol specified' do
+      SurveyGizmo.configure do |config|
+        config.region = :us
+      end
+
+      expect(SurveyGizmo.configuration.api_url).to eq('https://restapi.surveygizmo.com')
+      expect(SurveyGizmo.configuration.api_time_zone).to eq('Eastern Time (US & Canada)')
+    end
+
+    it 'should set EU region with :eu symbol specified' do
+      SurveyGizmo.configure do |config|
+        config.region = :eu
+      end
+
+      expect(SurveyGizmo.configuration.api_url).to eq('https://restapi.surveygizmo.eu')
+      expect(SurveyGizmo.configuration.api_time_zone).to eq('Berlin')
+    end
+
+    it 'should fail with an unavailable region' do
+      expect {
+        SurveyGizmo.configure do |config|
+          config.region = :cz
+        end
+      }.to raise_error
+    end
+
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 6.1.2
+  version: 6.1.3
 platform: ruby
 authors:
 - Kabari Hendrick
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -267,4 +267,3 @@ test_files:
 - spec/test_json/page.json
 - spec/test_json/question.json
 - spec/test_json/survey.json
-has_rdoc: