survey-gizmo-ruby 6.7.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f7c1b7c1989e807e2aad794b3b55836382ce2a667ef1fca0c60dbd1ca6045c8
-  data.tar.gz: 1c91c4b30cfb6af1485f92051a023115d146c8e5b03f8079a84b013e45560768
+  metadata.gz: 2a08475717245ba2f53f58bf497f7b18fd8bab1f61554e73862c83fafb8fa8c6
+  data.tar.gz: eb9c8b9f1591d2a381bd926fe61d8649290aeee8ea22a1c879d37c845610e132
 SHA512:
-  metadata.gz: 762529071658cb08a7cc48be9872bc8b11a8ba647925951254aa55c7584947c4a8d0df248003cd753247f7ee90c6a15ae74a6d972a1f2edf7be03cf01e8535c1
-  data.tar.gz: a82828bca4c4c2a45051149ce9d1ae0cdecf3e7f1291287c2aadec97de1ea2b81c039082baab264f849d1fc76fe092230ad0e8a6504ed2705dfe97f519adfa8d
+  metadata.gz: 75a62b2a9af99e373beca17f5f2c4bef2ff9ee1a1b047b01a2110fc22109bcf5bf63fc50d11b0760c939c84c7475bd2d3a69956d49913ecbe3dc4c7961247db6
+  data.tar.gz: 718d88e0d421b56ae97467cb078f69bf5230337db62e387bf42dddb5c2aa2d308c4c4a5fd2e39834323658898ad5b5f43cd589e0f616c4e47eb83c168c813bf4

data/CHANGELOG.md

@@ -1,4 +1,6 @@
 # Versions
+## 7.0.0
+* Makes configuration thread safe. When a new thread is created, the last configuration set through `SurveyGizmo.configure` will be used.
 
 ## 6.7.0
 * Change timezone for EU servers to UTC (#103)

data/README.md

@@ -18,6 +18,10 @@ gem 'survey-gizmo-ruby'
 
 ## Configuration
 
+The configuration is thread safe.
+When a new thread is created, the last configuration set through `SurveyGizmo.configure` or `SurveyGizmo.configuration=` will be used.
+When `SurveyGizmo.reset!` is called, only the current thread configuration will be reset.
+
 ```ruby
 require 'survey-gizmo-ruby'
 

data/lib/survey_gizmo/configuration.rb

@@ -1,33 +1,41 @@
 require 'survey_gizmo/faraday_middleware/parse_survey_gizmo'
 
 module SurveyGizmo
-  class << self
-    attr_writer :configuration
 
+  CONFIG_THREAD_VARIABLE_NAME = :survey_gizmo_configuration
+
+  class << self
     def configuration
-      fail 'Not configured!' unless @configuration
-      @configuration
+      fail 'Not configured!' unless Thread.current[CONFIG_THREAD_VARIABLE_NAME] || @global_config
+      Thread.current[CONFIG_THREAD_VARIABLE_NAME] ||= @global_config.dup
+    end
+
+    def configuration=(new_config)
+      @global_config = new_config.dup
+      Thread.current[CONFIG_THREAD_VARIABLE_NAME] = new_config
     end
 
     def configure
       reset!
-      yield(@configuration) if block_given?
+      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
+      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
+      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)
+      configuration.retriable_params = Configuration::DEFAULT_RETRIABLE_PARAMS.merge(configuration.retriable_params)
+
+      @global_config = configuration
     end
 
     def reset!
-      @configuration = Configuration.new
+      Thread.current[CONFIG_THREAD_VARIABLE_NAME] = Configuration.new
       Connection.reset!
     end
   end

data/lib/survey_gizmo/version.rb

@@ -1,3 +1,3 @@
 module SurveyGizmo
-  VERSION = '6.7.0'
+  VERSION = '7.0.0'
 end

data/spec/configuration_spec.rb

@@ -2,10 +2,14 @@ require 'spec_helper'
 require 'survey_gizmo/configuration'
 
 describe SurveyGizmo::Configuration do
+
+  let(:api_token) { "token" }
+  let(:api_token_secret) { "doken" }
+
   before(:each) do
     SurveyGizmo.configure do |config|
-      config.api_token = 'token'
-      config.api_token_secret = 'doken'
+      config.api_token = api_token
+      config.api_token_secret = api_token_secret
     end
   end
 
@@ -13,16 +17,90 @@ describe SurveyGizmo::Configuration do
     SurveyGizmo.reset!
   end
 
-  it 'should allow changing user and pass' do
+  it "should allow changing user and pass" do
     # preload connection to verify that memoization is purged
     SurveyGizmo::Connection.send(:connection)
 
     SurveyGizmo.configure do |config|
-      config.api_token = 'slimthug'
-      config.api_token_secret = 'fourfourz'
+      config.api_token = "slimthug"
+      config.api_token_secret = "fourfourz"
+    end
+
+    expect(SurveyGizmo::Connection.send(:connection).params).to eq("api_token" => "slimthug", "api_token_secret" => "fourfourz")
+  end
+
+  context "thread safety" do
+    it "is set from the last known configuration" do
+      expect(SurveyGizmo.configuration.api_token).to eq(api_token)
+
+      Thread.new do
+        expect(SurveyGizmo.configuration.api_token).to eq(api_token)
+      end
+    end
+
+    it "is not affected by a change in another thread" do
+      expect(SurveyGizmo.configuration.api_token).to eq(api_token)
+
+      Thread.new do
+        SurveyGizmo.configure {|c| c.api_token = "new_token"}
+        expect(SurveyGizmo.configuration.api_token).to eq("new_token")
+      end.join
+
+      expect(SurveyGizmo.configuration.api_token).to eq(api_token)
+    end
+
+    it "is not affected by a reset in another thread" do
+      expect(SurveyGizmo.configuration.api_token).to eq(api_token)
+
+      Thread.new do
+        SurveyGizmo.reset!
+        expect(SurveyGizmo.configuration.api_token).to eq(nil)
+      end.join
+
+      expect(SurveyGizmo.configuration.api_token).to eq(api_token)
     end
 
-    expect(SurveyGizmo::Connection.send(:connection).params).to eq('api_token' => 'slimthug', 'api_token_secret' => 'fourfourz')
+    it "updates the last known configuration" do
+      expect(SurveyGizmo.configuration.api_token).to eq(api_token)
+
+      Thread.new do
+        SurveyGizmo.configure {|c| c.api_token = "new_token"}
+        expect(SurveyGizmo.configuration.api_token).to eq("new_token")
+      end.join
+      Thread.new do
+        expect(SurveyGizmo.configuration.api_token).to eq("new_token")
+      end.join
+    end
+
+    describe ".configuration=" do
+      let(:new_config) { SurveyGizmo::Configuration.new.tap { |c| c.api_token = "new_token" } }
+
+      it "sets the configuration" do
+        expect{
+          SurveyGizmo.configuration = new_config
+        }.to change {
+          SurveyGizmo.configuration.api_token
+        }.from(api_token).to("new_token")
+      end
+
+      it "does not affect other threads" do
+        expect {
+          Thread.new do
+            SurveyGizmo.configuration = new_config
+            expect(SurveyGizmo.configuration.api_token).to eq("new_token")
+          end.join
+        }.not_to change {
+          SurveyGizmo.configuration.api_token
+        }.from(api_token)
+      end
+
+      it "updates the last known configuration" do
+        SurveyGizmo.configuration = new_config
+        Thread.new do
+          expect(SurveyGizmo.configuration.api_token).to eq("new_token")
+        end.join
+      end
+    end
   end
 
   describe '#region=' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 6.7.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Kabari Hendrick
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2019-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport