naranya_ecm-sdk 0.0.43 → 0.0.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 183c574009558b2788b71cce8899e52e9a948344
-  data.tar.gz: d1ffcd41db7e78e43251c7714c7e7ec686223b15
+  metadata.gz: 2dc8adf4cc4abab1676463cd4c3c6075793c45c0
+  data.tar.gz: 4cc18d8ae9c0191a4b574454027dfb553f486040
 SHA512:
-  metadata.gz: c010113401ef577a7b24a41e50614c4d98c77c91eba374f421279e224aa2529fac258423b9e2d19f00451d7950a7dad90f8a7e209f2dee6ddc230a6a60dae6e7
-  data.tar.gz: 5fd603773082dbcd115d97e36b1ab9f68649c3ae3bd81b1e717ea43b32f87389fdda26188de350378337c133ebd2511fea3560c9cf6e49de44b4965521f90d70
+  metadata.gz: abc347b3b30e4ff20d0f2899b3420e4f8d5e0155453dc9bca2402061635d5b868443a7a3bbdf7cda0827e930c1db3893bc806bdf84f449445f54e003bf881472
+  data.tar.gz: eec0f1877d9e19da52d4de1e04357dfe3c4833a0f584c73176555cb37e3d7072bb6a28889b4b8f841dd8617ccb70ceda8b915bc852961291a7d0c70ed03c5ee7

data/dev/thread-safety-tests.rb

@@ -0,0 +1,23 @@
+NContent::SDK.logger.level = Logger::INFO
+# Launch n threads:
+10.times.map do |i|
+  sleep 0.3
+
+  Thread.new do
+
+    10.times.map do |reqno|
+      a = NaranyaEcm::Category.find "53367aa33535660003000000"
+      sleep 5
+    end
+
+  end
+end.each(&:join)
+
+puts "\nFinished!"
+puts "\nFinished!"
+puts "\nFinished!"
+puts "\nFinished!"
+puts "\nFinished!"
+puts "\nFinished!"
+
+NContent::SDK.logger.level = Logger::DEBUG

data/lib/naranya_ecm-sdk/version.rb

@@ -1,3 +1,3 @@
 module NaranyaEcm
-  VERSION = "0.0.43"
+  VERSION = "0.0.44"
 end

data/lib/ncontent/sdk/rest_client.rb

@@ -1,5 +1,6 @@
 require 'oauth2'
 require 'ncontent/sdk/faraday_middleware'
+require 'singleton'
 
 module NContent
 
@@ -7,22 +8,14 @@ module NContent
 
     class RESTClient
 
+      include Singleton
+
       CLIENT_TOKEN_CACHE_KEY = "ncontent/api_client/client_token".freeze
 
-      class << self
-        delegate :config, :logger, :cache, to: NContent::SDK
-      end
+      delegate :config, :logger, :cache, to: NContent::SDK
 
-      # Returns the thread's OAuth2 client instance.
-      #
-      # In multi-thread environments, each thread will have it's own client
-      # instance object - since it's saved as a @instance_variable - but
-      # shouldn't be a problem since the mutable data is actually the
-      # client_token (see self.client_token).
-      def self.instance
-        @instance ||= OAuth2::Client.new(
-          config.api_key, config.api_secret, site: config.api_host
-        ) do |faraday|
+      def initialize
+        @client = OAuth2::Client.new(config.api_key, config.api_secret, site: config.api_host) do |faraday|
           ### Oauth2 Client (Faraday) builder:
 
           faraday.request :url_encoded # them posts...
@@ -39,33 +32,24 @@ module NContent
             faraday.adapter Faraday.default_adapter  # make requests with Net::HTTP
           end
         end
+        @client_token = get_token
+        @mutex  = Mutex.new
       end
 
-      # Returns a client_token initialized from cache.
-      #
-      # In multi-thread environments, each thread will have it's own
-      # client_token object - since it's saved as a @instance_variable -, but
-      # all of them should have the same token data - since it's initialized
-      # from cache (We're assuming a thread-safe cache such as redis gem).
-      def self.client_token
-        @client_token ||= begin
-          cached_token_data = cache.read CLIENT_TOKEN_CACHE_KEY
-          if cached_token_data.present?
-            OAuth2::AccessToken.from_hash instance, cached_token_data
+      def reset_client_token!
+        with_mutex do
+          if cached = cache.read(CLIENT_TOKEN_CACHE_KEY) and cached['access_token'] == @client_token.token
+            logger.debug "Deleting cache key #{CLIENT_TOKEN_CACHE_KEY}"
+            cache.delete CLIENT_TOKEN_CACHE_KEY
           else
-            new_token = instance.client_credentials.get_token
-            cache.write CLIENT_TOKEN_CACHE_KEY, new_token.to_hash
-            new_token
+            logger.debug "Not deleting cache key #{CLIENT_TOKEN_CACHE_KEY}"
           end
+          @client_token = get_token
         end
       end
 
-      # Clears the thread's token object. If called with 'true', it also
-      # clears the token data from the cache.
-      def self.clear_client_token!(clear_from_cache = false)
-        cache.delete CLIENT_TOKEN_CACHE_KEY if clear_from_cache
-        @client_token = nil
-        true
+      def client_token
+        with_mutex { @client_token }
       end
 
       # Make a request to the API:
@@ -73,17 +57,15 @@ module NContent
       # @param [Symbol] verb the HTTP request method
       # @param [String] path the HTTP URL path of the request
       # @param [Hash] opts the options to make the request with
-      def self.request(verb, path=nil, opts = {}, &block)
+      def request(verb, path=nil, opts = {}, &block)
 
-        cleared_cached_token_data = false
+        retrying = false
 
         begin
 
-          # If we beforehand know that the current token expired then clear the
-          # token object from the current thread. We'll not clear it from the
-          # cache store here, as maybe another thread has already updated the
-          # cached token data:
-          clear_client_token! if client_token.expired?
+          # If we beforehand know that the current token expired then the client
+          # token should be re-generated.
+          reset_client_token! if client_token.expired?
 
           client_token.request(verb, path, opts) do |req|
             req.options.timeout = config.api_call_timeout
@@ -93,37 +75,64 @@ module NContent
 
         rescue OAuth2::Error => error
 
-          if error.response.status == 401 && !cleared_cached_token_data
-            # Here the cached token data is stale, so we'll force the cached
-            # token data to be cleared:
-            cleared_cached_token_data = clear_client_token!(true)
+          if error.response.status == 401 && !retrying
+            reset_client_token!
+            retrying = true
+            logger.info "Retrying response #{verb.upcase} #{path} with a fresh nContent token."
             retry
           else
-            ::NaranyaEcm::Rest::RestError.raise_by_failed_response(error.response)
+            NaranyaEcm::Rest::RestError.raise_by_failed_response(error.response)
           end
         end
       end
 
-      def self.get(path=nil, opts = {}, &block)
+      def get(path=nil, opts = {}, &block)
         request(:get, path, opts, &block)
       end
 
-      def self.post(path=nil, opts = {}, &block)
+      def post(path=nil, opts = {}, &block)
         request(:post, path, opts, &block)
       end
 
-      def self.put(path=nil, opts = {}, &block)
+      def put(path=nil, opts = {}, &block)
         request(:put, path, opts, &block)
       end
 
-      def self.patch(path=nil, opts = {}, &block)
+      def patch(path=nil, opts = {}, &block)
         request(:patch, path, opts, &block)
       end
 
-      def self.delete(path=nil, opts = {}, &block)
+      def delete(path=nil, opts = {}, &block)
         request(:delete, path, opts, &block)
       end
 
+      class << self
+        delegate :client_token, :reset_client_token!, :request, :get, :post,
+                 :put, :patch, :delete, to: :instance
+      end
+
+      private
+
+        def get_token
+          cached = cache.read CLIENT_TOKEN_CACHE_KEY
+
+          returned_token = if cached.present?
+            logger.debug "Generating client token from cached data: #{cached.inspect}"
+            OAuth2::AccessToken.from_hash @client, cached
+          else
+            logger.info "Requesting new client token from nContent server"
+            new_token = @client.client_credentials.get_token
+            cache.write CLIENT_TOKEN_CACHE_KEY, new_token.to_hash.with_indifferent_access
+            logger.debug "Data #{new_token.token.inspect} written to cache key #{CLIENT_TOKEN_CACHE_KEY}."
+            new_token
+          end
+          returned_token
+        end
+
+        def with_mutex
+          @mutex.synchronize { yield }
+        end
+
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naranya_ecm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.43
+  version: 0.0.44
 platform: ruby
 authors:
 - Roberto Quintanilla
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -233,6 +233,7 @@ files:
 - dev/init.rb
 - dev/load_cvm.rb
 - dev/search.rb
+- dev/thread-safety-tests.rb
 - doc/media_processing.md
 - lib/aasm/persistence/rest_persistence.rb
 - lib/naranya_ecm-sdk.rb