springcm-sdk 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bcbec6f89c659710286d4dac5b6e6197272ca2b90a20202807d68a953bfd4ee
-  data.tar.gz: c8e2f2e943de9719f61d47dec3a5f3c247cbb99ce4b33e852da986a4acd595e2
+  metadata.gz: 4ede0e8cbe39a1ba56490a8747d394136877c4ba297f42bc618d665a37822b5b
+  data.tar.gz: 2c6c5bf9194b9f63f937f491cd3522d8175db3d8aabd5cf799b8a09aba7689e6
 SHA512:
-  metadata.gz: be09de4cbef4485fd4ae2749f158f12cb23f5bfbdb7377a81fe989f793fab61c4dadd6948241646adf8a6bcd8870c2da300a361208115477e791396ffb4ba10e
-  data.tar.gz: 336f3fd0bf01bd1b6a89db940a76260aca9a25b5fdc2561de1516336832b7124c9ff8e946770eda7331d727746d84af1a243c72de9920dad0350021feb796a1e
+  metadata.gz: 9aee61e667d073e51bc57f7e8aa00c67e6f47067cc106b11e1caee6306836e390035df29d63714f7f10c8d6351bbca8eaabca34ef95a65a4cc71eecbd60f9874
+  data.tar.gz: 40aeda6cd074142c6546a3451fd29c495dc1f1a73bebce8dab2d2382f730e268cc5690de41d9c89b7b5203d149a5915a7997802e871b7bc559c3e70558271512

data/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to springcm-sdk will be documented in this file.
 
 ## [Unreleased]
 
+## [0.4.0] - 2019-12-27
+### Added
+* Faraday middleware for authorization expiration and rate limit handling.
+* Faraday middleware for retrying on Faraday::ConnectionFailed. Can be
+  disabled via new Client options.
+
+### Changed
+* Adjust auth window to re-authenticate no more than 5 minutes before
+  access token expiration.
+
 ## [0.3.6] - 2019-12-23
 ### Changed
 * Fix resource list behavior for history items. Was returning the document's
@@ -79,7 +89,7 @@ All notable changes to springcm-sdk will be documented in this file.
 ### Added
 * Initial release to reserve gem name
 
-[Unreleased]: https://github.com/paulholden2/springcm-sdk/compare/0.3.6...HEAD
+[Unreleased]: https://github.com/paulholden2/springcm-sdk/compare/0.4.0...HEAD
 [0.1.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.1.0
 [0.1.1]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.1.1
 [0.1.2]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.1.2
@@ -91,3 +101,4 @@ All notable changes to springcm-sdk will be documented in this file.
 [0.3.4]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.4
 [0.3.5]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.5
 [0.3.6]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.6
+[0.4.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.4.0

data/lib/springcm-sdk/client.rb

@@ -3,19 +3,31 @@ require "json"
 require "springcm-sdk/account"
 require "springcm-sdk/folder"
 require "springcm-sdk/document"
+require "springcm-sdk/middleware"
 
 module Springcm
   class Client
+    # Default API client options
+    DEFAULT_OPTIONS = {
+      # If true, the client will use a simple retry mechanism when connection
+      # to the API server fails due to e.g. temporary Internet service outage.
+      # The connection is re-attempted up to five times, delaying 2 ** n
+      # seconds between attempts, where n is the number of previous attempts.
+      retry_connection_failed: true
+    }.freeze
+
     attr_reader :access_token
 
     # @param data_center [String] Data center name, e.g. uatna11
     # @param client_id [String] Your API client ID
     # @param client_secret [String] Your API client secret
-    def initialize(data_center, client_id, client_secret)
+    # @parma options [Hash] API client options
+    def initialize(data_center, client_id, client_secret, options=DEFAULT_OPTIONS)
       if !["na11", "uatna11", "eu11", "eu21", "na21", "us11"].include?(data_center)
         raise Springcm::ConnectionInfoError.new("Invalid data center '#{data_center.to_s}'")
       end
 
+      @options = options
       @data_center = data_center
       @client_id = client_id
       @client_secret = client_secret
@@ -28,7 +40,12 @@ module Springcm
     # @param safe If truthy, connection failure does not raise an exception
     # @return [Boolean] Whether connection was successful
     def connect(safe=true)
-      conn = Faraday.new(url: auth_url)
+      conn = Faraday.new(url: auth_url) do |conn|
+        conn.request :retry, retry_statuses: [429], exceptions: [Springcm::RateLimitExceededError]
+        conn.use Springcm::Middleware::RateLimit
+        conn.use Springcm::Middleware::RetryConnectionFailed if @options[:retry_connection_failed]
+        conn.adapter :net_http
+      end
       res = conn.post do |req|
         req.headers['Content-Type'] = 'application/json'
         req.body = {
@@ -39,7 +56,7 @@ module Springcm
       if res.success?
         data = JSON.parse(res.body)
         @access_token = data.fetch("access_token")
-        @expiry = Time.now + data.fetch("expires_in")
+        @expiry = Time.now + data.fetch("expires_in") - 300
       else
         @access_token = nil
         @expiry = nil
@@ -169,15 +186,29 @@ module Springcm
     end
 
     def authorized_connection(*options)
+      if !authenticated?
+        connect!
+      end
+
       Faraday.new(*options) do |conn|
         options = [{
           max: 10,
           interval: 1,
           interval_randomness: 0.5,
           backoff_factor: 2,
-          retry_statuses: [429]
+          retry_statuses: [401, 429],
+          exceptions: [Springcm::AuthExpiredError, Springcm::RateLimitExceededError],
+          retry_block: -> (env, options, retries, exception) {
+            if exception.class == Springcm::AuthExpiredError
+              connect!
+              env.request_headers['Authorization'] = "bearer #{@access_token}"
+            end
+          }
         }]
         conn.request :retry, *options
+        conn.use Springcm::Middleware::RateLimit
+        conn.use Springcm::Middleware::AuthExpire
+        conn.use Springcm::Middleware::RetryConnectionFailed if @options[:retry_connection_failed]
         conn.adapter :net_http
         conn.authorization('bearer', @access_token)
       end

data/lib/springcm-sdk/middleware/auth_expired.rb

@@ -0,0 +1,20 @@
+module Springcm
+  module Middleware
+    class AuthExpire
+      attr_reader :options
+
+      def initialize(app, options={})
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        @app.call(env).on_complete do |response_env|
+          if response_env[:status] == 401
+            raise Springcm::AuthExpiredError.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/springcm-sdk/middleware/rate_limit.rb

@@ -0,0 +1,21 @@
+module Springcm
+  module Middleware
+    class RateLimit
+      attr_reader :options
+
+      def initialize(app, options={})
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        @app.call(env).on_complete do |response_env|
+          body = JSON.parse(response_env[:body])
+          if body.fetch("Error", {}).fetch("ErrorCode", nil) == 103
+            raise Springcm::RateLimitExceededError.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/springcm-sdk/middleware/retry_connection_failed.rb

@@ -0,0 +1,30 @@
+module Springcm
+  module Middleware
+    class RetryConnectionFailed
+      attr_reader :options
+
+      def initialize(app, options={ retries: 5 })
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        retries = @options[:retries]
+        delay = 1
+        begin
+          @app.call(env).on_complete do |response_env|
+          end
+        rescue Faraday::ConnectionFailed => err
+          if retries > 0
+            retries -= 1
+            sleep delay
+            delay *= 2
+            retry
+          else
+            raise err
+          end
+        end
+      end
+    end
+  end
+end

data/lib/springcm-sdk/middleware.rb

@@ -0,0 +1,3 @@
+require "springcm-sdk/middleware/rate_limit"
+require "springcm-sdk/middleware/auth_expired"
+require "springcm-sdk/middleware/retry_connection_failed"

data/lib/springcm-sdk/version.rb

@@ -1,3 +1,3 @@
 module Springcm
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

data/lib/springcm-sdk.rb

@@ -20,4 +20,16 @@ module Springcm
       super("Invalid Client Id or Client Secret")
     end
   end
+
+  class AuthExpiredError < Error
+    def initialize
+      super("Authorization expired")
+    end
+  end
+
+  class RateLimitExceededError < Error
+    def initialize
+      super("Rate limit exceeded")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springcm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-24 00:00:00.000000000 Z
+date: 2019-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -167,6 +167,10 @@ files:
 - lib/springcm-sdk/folder.rb
 - lib/springcm-sdk/helpers.rb
 - lib/springcm-sdk/history_item.rb
+- lib/springcm-sdk/middleware.rb
+- lib/springcm-sdk/middleware/auth_expired.rb
+- lib/springcm-sdk/middleware/rate_limit.rb
+- lib/springcm-sdk/middleware/retry_connection_failed.rb
 - lib/springcm-sdk/mixins/access_level.rb
 - lib/springcm-sdk/mixins/attributes.rb
 - lib/springcm-sdk/mixins/documents.rb
@@ -183,7 +187,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/paulholden2/springcm-sdk
   source_code_uri: https://github.com/paulholden2/springcm-sdk
-  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/0.3.6
+  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/0.4.0
   changelog_uri: https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []