ws-net_documents-use_token 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c04281820113c57642e727a864574408d7cbb65733389bc058f9e9df5d8ea563
+  data.tar.gz: f51708c5c693f0c9b82e462b03cbfece024fa7ee42a5f4a915e7797534e8465f
+SHA512:
+  metadata.gz: af7f51a679cb0930e6363451e7a3ee1fe79cf325261ba3f467fe6a1fc82f1352ec5786ab8170237ba8b126c212390ee8d24b8f1ff80dd5d6c2bacf3fe53e8d90
+  data.tar.gz: e73b1490b63804acd85fa3aebc60e5a9e936ced4cae33d72c5d815445f75a0b619fb3fee71252b5b460bb4aeeab0641cb2b46f690e2d35e65542b78c0b18fded

data/lib/net_documents/use_token/controls/access_token.rb

@@ -0,0 +1,7 @@
+module NetDocuments
+  class UseToken
+    module Controls
+      AccessToken = NetDocuments::Client::Controls::AccessToken
+    end
+  end
+end

data/lib/net_documents/use_token/controls/id.rb

@@ -0,0 +1,10 @@
+module NetDocuments
+  class UseToken
+    module Controls
+      module ID
+        def self.example(...) = Identifier::UUID::Controls::Incrementing.example(...)
+        def self.random = Identifier::UUID::Random.get
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/controls/provider.rb

@@ -0,0 +1,11 @@
+module NetDocuments
+  class UseToken
+    module Controls
+      module Provider
+        def self.example
+          UseToken::Provider.name
+        end
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/controls/refresh_token.rb

@@ -0,0 +1,7 @@
+module NetDocuments
+  class UseToken
+    module Controls
+      RefreshToken = NetDocuments::Client::Controls::RefreshToken
+    end
+  end
+end

data/lib/net_documents/use_token/controls/time.rb

@@ -0,0 +1,11 @@
+module NetDocuments
+  class UseToken
+    module Controls
+      Time = NetDocuments::Client::Controls::Time
+
+      module Time
+        Expiration = GetToken::Controls::Time::Expiration
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/controls/token.rb

@@ -0,0 +1,64 @@
+module NetDocuments
+  class UseToken
+    module Controls
+      module Token
+        User = NetDocuments::Client::Controls::Token::User
+
+        def self.example(provider: nil, user_id: nil, access_token: nil, refresh_token: nil, version: nil, expiration_time: nil)
+          provider ||= self.provider
+          user_id ||= self.user_id
+          access_token ||= self.access_token
+          refresh_token ||= self.refresh_token
+          version ||= self.version
+          expiration_time ||= self.expiration_time
+
+          token = UseToken::Token.new
+          token.provider = provider
+          token.user_id = user_id
+          token.access_token = access_token
+          token.refresh_token = refresh_token
+          token.version = version
+          token.expiration_time = expiration_time
+
+          token
+        end
+
+        def self.provider
+          Provider.example
+        end
+
+        def self.user_id
+          ID.example
+        end
+
+        def self.access_token
+          AccessToken.example
+        end
+
+        def self.refresh_token
+          RefreshToken.example
+        end
+
+        def self.version
+          TokenVersion.example
+        end
+
+        def self.expiration_time
+          Time::Expiration.example
+        end
+
+        module Expired
+          def self.example(expiration_time: nil, refresh_token: nil)
+            expiration_time ||= Controls::Time::Offset.example(offset_milliseconds:)
+
+            Token.example(expiration_time:, refresh_token:)
+          end
+
+          def self.offset_milliseconds
+            -1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/controls/token_version.rb

@@ -0,0 +1,7 @@
+module NetDocuments
+  class UseToken
+    module Controls
+      TokenVersion = GetToken::Controls::TokenVersion
+    end
+  end
+end

data/lib/net_documents/use_token/controls/write/granted.rb

@@ -0,0 +1,9 @@
+module NetDocuments
+  class UseToken
+    module Controls
+      module Write
+        Granted = TokenComponent::Controls::Write::Events::Granted
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/controls/write/issued.rb

@@ -0,0 +1,9 @@
+module NetDocuments
+  class UseToken
+    module Controls
+      module Write
+        Issued = TokenComponent::Controls::Write::Events::Issued
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/controls.rb

@@ -0,0 +1,15 @@
+require "identifier/uuid/controls"
+
+require "net_documents/client/controls"
+require "token_component/controls"
+require "get_token/controls"
+
+require "net_documents/use_token/controls/time"
+require "net_documents/use_token/controls/id"
+require "net_documents/use_token/controls/provider"
+require "net_documents/use_token/controls/token_version"
+require "net_documents/use_token/controls/access_token"
+require "net_documents/use_token/controls/refresh_token"
+require "net_documents/use_token/controls/token"
+require "net_documents/use_token/controls/write/issued"
+require "net_documents/use_token/controls/write/granted"

data/lib/net_documents/use_token/log.rb

@@ -0,0 +1,11 @@
+module NetDocuments
+  class UseToken
+    class Log < Log::Structured
+      def tag!(tags)
+        tags << :net_documents_use_token
+        tags << :net_documents
+        tags << :token
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/provider.rb

@@ -0,0 +1,9 @@
+module NetDocuments
+  class UseToken
+    module Provider
+      def self.name
+        TokenProvider.net_documents
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/result.rb

@@ -0,0 +1,26 @@
+module NetDocuments
+  class UseToken
+    class Result
+      attr_accessor :value
+
+      def success
+        @success ||= false
+      end
+      attr_writer :success
+      alias :success? :success
+
+      def self.failure
+        result = Result.new
+        result.success = false
+        result
+      end
+
+      def self.success(value)
+        result = Result.new
+        result.value = value
+        result.success = true
+        result
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/token.rb

@@ -0,0 +1,5 @@
+module NetDocuments
+  class UseToken
+    Token = GetToken::Token
+  end
+end

data/lib/net_documents/use_token/use_token/substitute.rb

@@ -0,0 +1,34 @@
+module NetDocuments
+  class UseToken
+    module Substitute
+      def self.build
+        UseToken.new
+      end
+
+      class UseToken
+        attr_accessor :access_token
+        alias :set_access_token :access_token=
+
+        def failure
+          @failure ||= false
+        end
+        alias :failure? :failure
+        attr_writer :failure
+
+        def set_failure
+          self.failure = true
+        end
+
+        def call(user_id, &block)
+          if failure?
+            return Result.failure
+          end
+
+          value = block.call(access_token)
+
+          Result.success(value)
+        end
+      end
+    end
+  end
+end

data/lib/net_documents/use_token/use_token.rb

@@ -0,0 +1,145 @@
+module NetDocuments
+  class UseToken
+    TokenExpiredError = Class.new(RuntimeError)
+
+    include Dependency
+    include Initializer
+    include Log::Dependency
+
+    initializer :user_id
+
+    dependency :get_token, GetToken
+    dependency :refresh, NetDocuments::Client::Token::User::Refresh
+    dependency :issue, TokenComponent::Client::Issue
+    dependency :request, TokenComponent::Client::Request
+    dependency :clock, Clock::UTC
+
+    def self.provider
+      Provider.name
+    end
+
+    def self.build(user_id)
+      instance = new(user_id)
+
+      GetToken.configure(instance, provider)
+      NetDocuments::Client::Token::User::Refresh.configure(instance, attr_name: :refresh)
+      TokenComponent::Client::Issue.configure(instance, provider)
+      TokenComponent::Client::Request.configure(instance)
+      Clock::UTC.configure(instance)
+
+      instance
+    end
+
+    def self.configure(receiver, user_id, attr_name: nil)
+      attr_name ||= :use_net_documents_token
+      instance = build(user_id)
+      receiver.public_send(:"#{attr_name}=", instance)
+    end
+
+    def self.call(user_id, &block)
+      instance = build(user_id)
+      instance.(&block)
+    end
+
+    def call(&block)
+      token = get_token.(user_id)
+
+      result = Result.new
+
+      if token.nil?
+        logger.info("Missing NetDocuments token", { user_id: user_id })
+        return result
+      end
+
+      access_token = token.access_token
+      refresh_token = token.refresh_token
+      token_version = token.version
+
+      if token.expired?(clock.now)
+        logger.debug("NetDocuments token is expired", { user_id: user_id, expiration_time: token.expiration_time })
+        access_token = refresh_access_token(refresh_token, token_version)
+
+        if access_token.nil?
+          return result
+        end
+      end
+
+      begin
+        result.value = block.call(access_token)
+        result.success = true
+
+      rescue ::NetDocuments::Client::TokenRejectedError
+        logger.debug("NetDocuments token is rejected", { user_id: user_id, expiration_time: token.expiration_time })
+
+        access_token = refresh_access_token(refresh_token, token_version)
+
+        if not access_token.nil?
+          retry
+        end
+      end
+
+      result
+    end
+
+    def refresh_access_token(refresh_token, token_version)
+      logger.trace("Refreshing NetDocuments token", { user_id: user_id })
+
+      begin
+        refresh_token_response = refresh.(refresh_token)
+      rescue ::NetDocuments::Client::Token::InvalidGrantError
+        logger.debug("NetDocuments token refresh failed", { user_id: user_id })
+
+        request_new_token(token_version)
+        return nil
+      end
+
+      issued_time = clock.now
+      user_token = ::NetDocuments::Client::Token::User::Token.import(refresh_token_response, issued_time)
+      access_token = user_token.access_token
+
+      issue_token(user_token)
+
+      logger.debug("Refreshed NetDocuments token", { user_id: user_id })
+
+      access_token
+    end
+
+    def issue_token(user_token)
+      logger.trace("Issuing new NetDocuments token", { user_id: user_id })
+
+      issue_id = Identifier::UUID.random
+
+      access_token = user_token.access_token
+      refresh_token = user_token.refresh_token
+      expiration_time = user_token.expiration_time
+
+      issue.(
+        user_id: user_id,
+        issue_id: issue_id,
+        access_token: access_token,
+        refresh_token: refresh_token,
+        expiration_time: expiration_time
+      )
+
+      logger.debug("Issued new NetDocuments token", { user_id: user_id, issue_id: issue_id })
+    end
+
+    def request_new_token(obsolete_token_version)
+      logger.trace("Requesting new NetDocuments token", { user_id: user_id })
+
+      request_id = Identifier::UUID::Random.get
+      correlation_stream_name = nil
+
+      request.(
+        user_id: user_id,
+        request_id: request_id,
+        provider: self.class.provider,
+        obsolete_token_version: obsolete_token_version,
+        correlation_stream_name: correlation_stream_name,
+        previous_message: nil
+      )
+
+      logger.debug("Requested new NetDocuments token", { user_id: user_id, request_id: request_id })
+    end
+  end
+end

data/lib/net_documents/use_token.rb

@@ -0,0 +1,15 @@
+require "identifier/uuid"
+require "message_store/postgres"
+
+require "log/structured"
+require "substitute/record"
+require "net_documents/client"
+require "token_provider"
+require "get_token"
+
+require "net_documents/use_token/log"
+require "net_documents/use_token/token"
+require "net_documents/use_token/provider"
+require "net_documents/use_token/result"
+require "net_documents/use_token/use_token"
+require "net_documents/use_token/use_token/substitute"

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: ws-net_documents-use_token
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+platform: ruby
+authors:
+- WSGR
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ws-get_token
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ws-net_documents-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ws-token_provider
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ws-substitute-record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ws-log-structured
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-clock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-identifier-uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-message_store-postgres
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: no-reply@wsgr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/net_documents/use_token.rb
+- lib/net_documents/use_token/controls.rb
+- lib/net_documents/use_token/controls/access_token.rb
+- lib/net_documents/use_token/controls/id.rb
+- lib/net_documents/use_token/controls/provider.rb
+- lib/net_documents/use_token/controls/refresh_token.rb
+- lib/net_documents/use_token/controls/time.rb
+- lib/net_documents/use_token/controls/token.rb
+- lib/net_documents/use_token/controls/token_version.rb
+- lib/net_documents/use_token/controls/write/granted.rb
+- lib/net_documents/use_token/controls/write/issued.rb
+- lib/net_documents/use_token/log.rb
+- lib/net_documents/use_token/provider.rb
+- lib/net_documents/use_token/result.rb
+- lib/net_documents/use_token/token.rb
+- lib/net_documents/use_token/use_token.rb
+- lib/net_documents/use_token/use_token/substitute.rb
+homepage: https://github.com/wsgr-neuron/net-documents-use-token
+licenses:
+- Proprietary
+metadata:
+  github_repo: ssh://github.com/wsgr-neuron/net-documents-use-token
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []