quandl_client 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbd142f2168c56abfd65d09f7a6b3c0d3000d949
-  data.tar.gz: 247b1975234bf1fa653365f4f584d7a3913ef787
+  metadata.gz: c216058327d626f746fc0107f2f0f90dbcc9bbaf
+  data.tar.gz: 1fbe183c0fde9cad61dd00e617620b57d0289024
 SHA512:
-  metadata.gz: 5e2cbf227a742be61d9df1163e0f3ac4e751af8032e727e2f4e123bf4b3bd068619732c5ea829022beb8153c0afbee03198083248f342dc75f7ea45d86ec2539
-  data.tar.gz: 8d9cd5d32c55cf39912821c1e4b6f714f6f4f13d9169761bc1c22e3943d330e69f1c25832f24fccd936a86d048d719e94572b8e6ee719460d4ccab1cf6665fb7
+  metadata.gz: 11cb43b358f0ef63ffe3a6e3de4988e411414c51a76f5911580e843f97d4dd306e397db753faaa62060a3689ab38bed3b97d105caf26d0b510d4efd8ea89e5f9
+  data.tar.gz: 8a2ea5751751a5495ae71cf980d19647149aa6f42405609fef6d8309c927f7d9207dca73740874c009c294aa7971c5261c7b637c6cc1f049eb9081fcd718016a

data/Gemfile

@@ -1,12 +1,2 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec
-
-use_local_gems = ENV['BUNDLE_LOCAL_GEMS'] == "true" && ENV['BUNDLE_LOCAL_DIR']
-local_gem_dir = ENV['BUNDLE_LOCAL_DIR']
-
-if use_local_gems
-  # gem 'her', path: "#{local_gem_dir}/her"
-  gem 'quandl_data', path: "#{local_gem_dir}/quandl/data"
-  gem 'quandl_operation', path: "#{local_gem_dir}/quandl/operation"
-  gem 'quandl_babelfish', path: "#{local_gem_dir}/quandl/babelfish"
-end

data/UPGRADE.md

@@ -1,3 +1,7 @@
+## 2.13.0
+
+* Add threadsafe_token option
+
 ## 2.12.0
 
 * Add redirect_path attribute to Sheets

data/lib/quandl/client.rb

@@ -24,15 +24,13 @@ require 'quandl/client/models/superset'
 
 module Quandl
   module Client
-    
     class << self
-    
       attr_accessor :request_source, :request_version, :request_platform
-    
+
       def request_source
         @request_source ||= "quandl_client"
       end
-    
+
       def request_version
         @request_version ||= Quandl::Client::VERSION
       end
@@ -40,17 +38,22 @@ module Quandl
       def request_platform
         @request_platform ||= RUBY_PLATFORM
       end
-    
+
+    end
+
+    def self.threadsafe_token!
+      Quandl::Client::Base.threadsafe_token!
     end
-    
+
     def self.use(url)
       Quandl::Client::Base.use(url)
     end
+
     def self.token=(value)
       Quandl::Client::Base.token = value
     end
-    
+
     HTTP_STATUS_CODES = {100=>"Continue", 101=>"Switching Protocols", 102=>"Processing", 200=>"OK", 201=>"Created", 202=>"Accepted", 203=>"Non-Authoritative Information", 204=>"No Content", 205=>"Reset Content", 206=>"Partial Content", 207=>"Multi-Status", 208=>"Already Reported", 226=>"IM Used", 300=>"Multiple Choices", 301=>"Moved Permanently", 302=>"Found", 303=>"See Other", 304=>"Not Modified", 305=>"Use Proxy", 306=>"Reserved", 307=>"Temporary Redirect", 308=>"Permanent Redirect", 400=>"Bad Request", 401=>"Unauthorized", 402=>"Payment Required", 403=>"Forbidden", 404=>"Not Found", 405=>"Method Not Allowed", 406=>"Not Acceptable", 407=>"Proxy Authentication Required", 408=>"Request Timeout", 409=>"Conflict", 410=>"Gone", 411=>"Length Required", 412=>"Precondition Failed", 413=>"Request Entity Too Large", 414=>"Request-URI Too Long", 415=>"Unsupported Media Type", 416=>"Requested Range Not Satisfiable", 417=>"Expectation Failed", 422=>"Unprocessable Entity", 423=>"Locked", 424=>"Failed Dependency", 425=>"Reserved for WebDAV advanced collections expired proposal", 426=>"Upgrade Required", 427=>"Unassigned", 428=>"Precondition Required", 429=>"Too Many Requests", 430=>"Unassigned", 431=>"Request Header Fields Too Large", 500=>"Internal Server Error", 501=>"Not Implemented", 502=>"Bad Gateway", 503=>"Service Unavailable", 504=>"Gateway Timeout", 505=>"HTTP Version Not Supported", 506=>"Variant Also Negotiates (Experimental)", 507=>"Insufficient Storage", 508=>"Loop Detected", 509=>"Unassigned", 510=>"Not Extended", 511=>"Network Authentication Required"}
-    
+
   end
 end

data/lib/quandl/client/base.rb

@@ -11,84 +11,106 @@ require 'quandl/client/base/search'
 
 I18n.enforce_available_locales = false
 
-class Quandl::Client::Base
-  
-  class << self
-    
-    attr_accessor :url, :token
-  
-    def use(url)
-      self.url = url
-      models_use_her_api!
-    end
-    
-    def token=(token)
-      @token = token
-      models_use_her_api!
-    end
-    
-    def her_api
-      Her::API.new.setup url: url_with_version do |c|
-        c.use TokenAuthentication
-        c.use TrackRequestSource
-        c.use Faraday::Request::Multipart
-        c.use Faraday::Request::UrlEncoded
-        c.use Quandl::Client::Middleware::ParseJSON
-        c.use Faraday::Adapter::NetHttp
-      end
-    end
+module Quandl
+  module Client
+    class Base
+      TOKEN_THREAD_KEY = 'quandl_client_token'
 
-    def url
-      @url ||= "https://www.quandl.com/api/"
-    end
+      class << self
+        attr_accessor :url, :token
 
-    def url_with_version
-      File.join( url.to_s, Quandl::Client.api_version.to_s )
-    end
-    
-    def inherited(subclass)
-      # remember models that inherit from base
-      models << subclass unless models.include?(subclass)
-      # include model behaviour
-      subclass.class_eval do
-        include Quandl::Client::Base::Model
-        include Quandl::Client::Base::Benchmark
-        include Quandl::Client::Base::Attributes
-        include Quandl::Client::Base::Validation
-        include Quandl::Client::Base::Search
-      end
-    end
-    
-    def models
-      @@models ||= []
-    end
-    
-    protected
-    
-    def models_use_her_api!
-      models.each{|m|
-        m.url = url_with_version
-        m.use_api( her_api ) 
-      }
-    end
-    
-    class TokenAuthentication < Faraday::Middleware
-      def call(env)
-        env[:request_headers]["X-API-Token"] = Quandl::Client::Base.token if Quandl::Client::Base.token.present?
-        @app.call(env)
-      end
-    end
-    
-    class TrackRequestSource < Faraday::Middleware
-      def call(env)
-        env[:body] ||= {}
-        env[:body][:request_source] = Quandl::Client.request_source
-        env[:body][:request_version] = Quandl::Client.request_version
-        env[:body][:request_platform] = Quandl::Client.request_platform
-        @app.call(env)
+        def threadsafe_token!
+          @threadsafe_token = true
+        end
+
+        def threadsafe_token?
+          @threadsafe_token || false
+        end
+
+        def use(url)
+          self.url = url
+          models_use_her_api!
+        end
+
+        def token=(token)
+          if threadsafe_token?
+            Thread.current[TOKEN_THREAD_KEY] = token
+          else
+            @token = token
+          end
+          models_use_her_api!
+        end
+
+        def token
+          if threadsafe_token?
+            Thread.current[TOKEN_THREAD_KEY]
+          else
+            @token
+          end
+        end
+
+        def her_api
+          Her::API.new.setup url: url_with_version do |c|
+            c.use TokenAuthentication
+            c.use TrackRequestSource
+            c.use Faraday::Request::Multipart
+            c.use Faraday::Request::UrlEncoded
+            c.use Quandl::Client::Middleware::ParseJSON
+            c.use Faraday::Adapter::NetHttp
+          end
+        end
+
+        def url
+          @url ||= "https://www.quandl.com/api/"
+        end
+
+        def url_with_version
+          File.join( url.to_s, Quandl::Client.api_version.to_s )
+        end
+
+        def inherited(subclass)
+          # remember models that inherit from base
+          models << subclass unless models.include?(subclass)
+          # include model behaviour
+          subclass.class_eval do
+            include Quandl::Client::Base::Model
+            include Quandl::Client::Base::Benchmark
+            include Quandl::Client::Base::Attributes
+            include Quandl::Client::Base::Validation
+            include Quandl::Client::Base::Search
+          end
+        end
+
+        def models
+          @@models ||= []
+        end
+
+        protected
+
+        def models_use_her_api!
+          models.each  do |m|
+            m.url = url_with_version
+            m.use_api(her_api)
+          end
+        end
+
+        class TokenAuthentication < Faraday::Middleware
+          def call(env)
+            env[:request_headers]["X-API-Token"] = Quandl::Client::Base.token if Quandl::Client::Base.token.present?
+            @app.call(env)
+          end
+        end
+
+        class TrackRequestSource < Faraday::Middleware
+          def call(env)
+            env[:body] ||= {}
+            env[:body][:request_source] = Quandl::Client.request_source
+            env[:body][:request_version] = Quandl::Client.request_version
+            env[:body][:request_platform] = Quandl::Client.request_platform
+            @app.call(env)
+          end
+        end
       end
     end
-    
   end
-  
 end

data/lib/quandl/client/models/dataset/data.rb

@@ -10,7 +10,7 @@ class Quandl::Client::Dataset::Data < Quandl::Client::Base
   end
   
   scope *[:row, :rows, :limit, :offset, :accuracy, :column, :order, 
-    :transform, :collapse, :exclude_headers]
+    :transformation, :collapse, :exclude_headers]
 
   scope :trim_start,  ->(date){ date = parse_date(date); where( trim_start: date ) if date }
   scope :trim_end,    ->(date){ date = parse_date(date); where( trim_end:   date ) if date }

data/lib/quandl/client/models/source.rb

@@ -40,7 +40,7 @@ module Quandl
       # PROPERTIES #
       ##############
 
-      attributes :code, :name, :host, :description, :datasets_count, :use_proxy, :type, :concurrency
+      attributes :code, :name, :host, :description, :datasets_count, :use_proxy, :type, :concurrency, :documentation
 
     end
   end

data/lib/quandl/client/version.rb

@@ -1,6 +1,6 @@
 module Quandl
   module Client
-    VERSION = '2.12.0'
+    VERSION = '2.13.0'
     API_VERSION = 'v2'
 
     class << self

data/spec/lib/quandl/client/base_spec.rb

@@ -5,4 +5,86 @@ describe Base do
   it "should have https in base url by default" do
     Quandl::Client::Base.url.should include 'https://www.'
   end
+
+  describe '.token' do
+    let(:base_token) { 'foo' }
+
+    context 'token threadsaftey disabled' do
+      before(:each) do
+        Quandl::Client::Base.token = base_token
+      end
+
+      context 'original thread' do
+        it 'should have base value' do
+          expect(Quandl::Client::Base.token).to eq(base_token)
+        end
+
+        it 'should inherit thread values' do
+          thread_token = 'foobar'
+          t = Thread.new do
+            Quandl::Client::Base.token = thread_token
+          end
+          t.join
+          expect(Quandl::Client::Base.token).to eq(thread_token)
+        end
+      end
+
+      context 'new thread' do
+        it 'should inherit base value' do
+          t = Thread.new do
+            expect(Quandl::Client::Base.token).to eq(base_token)
+          end
+          t.join
+        end
+
+        it 'should override with thread value' do
+          thread_token = 'foobarbaz'
+          t = Thread.new do
+            Quandl::Client::Base.token = thread_token
+            expect(Quandl::Client::Base.token).to eq(thread_token)
+          end
+          t.join
+        end
+      end
+    end
+
+
+    context 'token threadsafety enabled' do
+      before(:each) do
+        Quandl::Client.threadsafe_token!
+        Quandl::Client::Base.token = base_token
+     end
+
+      context 'original thread' do
+        it 'should have base value' do
+          expect(Quandl::Client::Base.token).to eq(base_token)
+        end
+
+        it 'should not inherit thread values' do
+          t = Thread.new do
+            Quandl::Client::Base.token = 'hello_world!'
+          end
+          t.join
+          expect(Quandl::Client::Base.token).to eq(base_token)
+        end
+      end
+      context 'new thread' do
+        it 'should not inherit parent value' do
+          t = Thread.new do
+            expect(Quandl::Client::Base.token).to be_nil
+          end
+          t.join
+        end
+
+        it 'should contain thread value for token' do
+          thread_token = 'this_is_a_token!'
+          t = Thread.new do
+            Quandl::Client::Base.token = thread_token
+            expect(Quandl::Client::Base.token).to eq(thread_token)
+          end
+          t.join
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl_client
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Blake Hilscher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-02 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quandl_data