rs4 0.2.1 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e8e2fd74b61acb79edb0d4fbc64e49ef1c0fad6b8696d466b83a0cec8e6bab9
-  data.tar.gz: 2b611b82edec6aa6c897472a2163110cd8a1d01a8cb39cc85a47e1628de7d955
+  metadata.gz: 22cb71a5eaa8f0c8719e5865fd5ac49b47777e482bd992c51fbd54032be650eb
+  data.tar.gz: 44d751a6a1eb28e598113b6056964a0204bfd7dc7822378210372e3c89450805
 SHA512:
-  metadata.gz: '0975d5000647806f81c71796563a0f13857093da7e4e18518c02bce918ce293e2247f50f08cc03a831bb0eca2dfaaf4f77b2784eafaf5032230f42773ebcf7b4'
-  data.tar.gz: 3bccea9722d64d825e1dc8aa5e542fc7bc6fd98b5ff521e3bd93661b8e2f56a2af8fbfd7ccaf9cf6b82252cde7dbbb868c0fe0af910e0c7214426e50e45bece7
+  metadata.gz: 58ba86bdae0ee04e01a4f5633237442e208f32b000719e6717bd4d6aa4055d40da0885f6a49ab836f98209cbbcc6a8da849eddcf7445118a7037b0334fc07291
+  data.tar.gz: 6d8a3142513f6a52d80483186fdcd0cfbcce7f85a09d8290846baacc1ca8d6f0e95249d02da88e66927b49334650ff5953000f9de0ac261b8293c343b6000510

data/lib/rs4.rb

@@ -6,6 +6,7 @@ require 'rs4/request.rb'
 require 'rs4/document.rb'
 require 'rs4/configuration.rb'
 require 'rs4/request_error.rb'
+require 'rs4/configuration_error.rb'
 require 'rs4/reusable_template.rb'
 
 require 'test/mock_request.rb'

data/lib/rs4/configuration.rb

@@ -14,5 +14,20 @@ module RS4
     attr_accessor :request_handler
     attr_accessor :private_api_key
     attr_accessor :api_host
+    attr_accessor :errors
+
+    def valid?
+      @errors = []
+
+      @errors << '`private_api_key` not set' unless private_api_key.present?
+      @errors << '`api_host` not set' unless api_host.present?
+
+      if @errors.any?
+        Rails.logger.error("RS4 Configuration Invalid: #{@errors.join(',')}")
+        return false
+      else
+        return true
+      end
+    end
   end
 end

data/lib/rs4/configuration_error.rb

@@ -0,0 +1,15 @@
+require 'rs4/error.rb'
+
+module RS4
+  # Error should be returned when the module has been
+  # improperly configured
+  class ConfigurationError < Error
+    attr_accessor :error_fields
+
+    def initialize(error_fields = [], message)
+      super(message)
+
+      @error_fields = error_fields
+    end
+  end
+end

data/lib/rs4/document.rb

@@ -9,6 +9,7 @@ module RS4
     EXECUTED_STATE = :executed
 
     attr_accessor :id
+    attr_accessor :original_guid
     attr_accessor :current_signer_id
     attr_accessor :name
     attr_accessor :filename
@@ -82,14 +83,28 @@ module RS4
     end
 
     class << self
+      def get_archive_document(document_guid)
+        return unless document_guid.present?
+
+        path = "archived_documents_by_original_guid/#{document_guid}"
+
+        response = RS4.configuration.request_handler.execute(path, :get)
+
+        unless response.is_a?(RS4::Error) || response.nil?
+          archived_document = response.dig(:archived_document)
+
+          Document.new(archived_document) if archived_document
+        end
+      end
+
       def get_document(document_guid)
-        return unless document_guid
+        return unless document_guid.present?
 
         path = "documents/#{document_guid}"
 
         response = RS4.configuration.request_handler.execute(path, :get)
 
-        unless response.class == RS4::RequestError || response.nil? # .class == Net::HTTPOK
+        unless response.is_a?(RS4::Error) || response.nil? # .class == Net::HTTPOK
           raw_document = response.dig(:document) # JSON.parse(response.body, symbolize_names: true)
 
           # Document.new(raw_document[:document])
@@ -101,7 +116,7 @@ module RS4
         path = 'documents'
         response = RS4.configuration.request_handler.execute(path, :get)
 
-        unless response.class == RS4::RequestError || response.nil?
+        unless response.is_a?(RS4::Error) || response.nil?
           documents = []
 
           response.dig(:documents).each do |document_hash|

data/lib/rs4/error.rb

@@ -0,0 +1,12 @@
+module RS4
+  # Standard Error returning a simple message
+  # Should be extended by additional classes
+  # to provide needed behavior
+  class Error
+    attr_accessor :message
+
+    def initialize(message)
+      @message = message
+    end
+  end
+end

data/lib/rs4/request.rb

@@ -7,6 +7,11 @@ module RS4
 
     class << self
       def execute(path, method = :get, body = {})
+        # Check required keys exist before continuing
+        unless RS4.configuration.valid?
+          return RS4::ConfigurationError.new(RS4.configuration.errors, 'Invalid Configuration')
+        end
+
         url = URI(RS4.configuration.api_host + '/public/v1/' + path)
 
         http = Net::HTTP.new(url.host, url.port)

data/lib/rs4/request_error.rb

@@ -1,18 +1,20 @@
+require 'rs4/error.rb'
+
 module RS4
   # The standard error returned when a request to the RS4
   # API fails
   # code - the NetHTTP response code as a number (eg - 200)
   # error_class - which NetHTTP class was returned by the response
   # message - the error message (if any) returned in the response
-  class RequestError
+  class RequestError < Error
     attr_accessor :code
     attr_accessor :error_class
-    attr_accessor :message
 
     def initialize(code, error_class, message)
+      super(message)
+
       @code = code
       @error_class = error_class
-      @message = message
     end
   end
 end

data/lib/rs4/reusable_template.rb

@@ -50,7 +50,7 @@ module RS4
 
         response = RS4.configuration.request_handler.execute(path, :get)
 
-        unless response.class == RS4::RequestError || response.nil?
+        unless response.is_a?(RS4::Error) || response.nil?
           # parsed_response = JSON.parse(response.read_body, symbolize_names: true)
 
           template_hash = response.dig(:reusable_template)
@@ -74,13 +74,11 @@ module RS4
 
         body = options
 
-        body[:in_person] = true
-
         response = RS4.configuration.request_handler.execute(path, :post, body)
 
         Rails.logger.info("RS4::ReusableTemplate::send_document:: #{response.inspect}")
 
-        unless response.class == RS4::RequestError || response.nil?
+        unless response.is_a?(RS4::Error) || response.nil?
           # parsed_response = JSON.parse(response.read_body, symbolize_names: true)
 
           document_hash = response.dig(:document)

data/lib/rs4/version.rb

@@ -1,3 +1,3 @@
 module RS4
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.8'.freeze
 end

data/lib/test/mock_request.rb

@@ -0,0 +1,114 @@
+module RS4
+  class MockRequest
+    class << self
+      def execute(path, method = :get, _body = {})
+        mockument = {
+          id: SecureRandom.uuid,
+          current_signer_id: 0,
+          name: 'noname',
+          filename: 'noname.pdf',
+          executed_at: Date.today,
+          expired_at: Date.today + 1.day,
+          sent_at: Date.today,
+          state: 'draft',
+          thumbnail_url: 'google.com',
+          sender: 'sender',
+          recipients: [
+            {
+              role_name: 'Investor',
+              sign_url: 'www.google.com'
+            }
+          ],
+          audits: nil,
+          page_image_urls: 'google.com',
+          signed_pdf_url: 'google.com/pdf.pdf',
+          tags: nil,
+          merge_field_values: nil,
+          embed_codes: nil,
+          in_person: true,
+          shared_with: nil,
+          identity_method: nil,
+          passcode_pin_enabled: false,
+          original_file_url: 'google.com'
+        }
+
+        if _body&.dig(:roles)&.any?
+
+          mockument[:recipients] = []
+
+          _body[:roles].each do |role|
+            mockument[:recipients] << {
+              role_name: role[:name],
+              sign_url: 'www.google.com'
+            }
+          end
+        end
+
+        mockplate = {
+          id: SecureRandom.uuid,
+          name: 'template',
+          creator: 'creator',
+          expires_in: Date.today + 1.day,
+          signer_sequencing: false,
+          shared_with: nil,
+          distribution_method: nil,
+          identity_method: nil,
+          kba: nil,
+          passcode: nil,
+          filename: 'template.pdf',
+          tags: nil,
+          user_id: 1,
+          roles: [],
+          merge_field_components: [],
+          created_at: Date.today,
+          updated_at: Date.today,
+          thumbnail_url: 'google.com/pdf.pdf',
+          page_image_urls: 'google.com/image'
+        }
+
+        case path
+        when %r{reusable_templates/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/send_document}
+          return {
+            document: mockument
+          }
+        when %r{reusable_templates/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}}
+          return {
+            reusable_template: mockplate
+          }
+        when /reusable_templates/
+          results = {
+            reusable_templates: []
+          }
+
+          i = 0
+          while i < 3
+            mockplate[:id] = SecureRandom.uuid
+            results[:reusable_templates] << mockplate
+            i += 1
+          end
+
+          return results
+        when %r{documents/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}}
+          return {
+            document: mockument
+          }
+
+        when /documents/
+          Rails.logger.info("#{method} documents")
+
+          results = {
+            documents: []
+          }
+          i = 0
+          while i < 3
+            results[:documents] << mockument
+            i += 1
+          end
+
+          return results
+
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rs4
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.8
 platform: ruby
 authors:
 - donny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies: []
 description: Provides ruby access to CRUD operations for RightSignature documents
   and reusable templates
@@ -29,11 +29,14 @@ files:
 - bin/setup
 - lib/rs4.rb
 - lib/rs4/configuration.rb
+- lib/rs4/configuration_error.rb
 - lib/rs4/document.rb
+- lib/rs4/error.rb
 - lib/rs4/request.rb
 - lib/rs4/request_error.rb
 - lib/rs4/reusable_template.rb
 - lib/rs4/version.rb
+- lib/test/mock_request.rb
 - license.txt
 - rs4.gemspec
 homepage: https://github.com/equitymultiple/rs4