rs4 0.1.5 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23c0458d33cdeff50946463cabf059af6303f5e109e6b3d1b3a320ef3d31dd72
-  data.tar.gz: 5148a81842c3de6a3b54d2d5b8d8df44faada800eb1ab7a0709f9be03a297479
+  metadata.gz: 98cdd324402202c22dced91d438c470bb032f16c689155b6e73bf6932a459094
+  data.tar.gz: 13c521a87135c796fec0aa2f6df17a1812452cbb7fee182607ebca47f5bc6873
 SHA512:
-  metadata.gz: 224653c586d33495acc5e5e1bfbec5356409a8a4457740f92f796d8c3c373b5933c99128ebaab07450b653ae7efa5c932da74aa23b45948bb733165a8f8fd11b
-  data.tar.gz: 79b467f38c8a43c3ca3fa32932aea5f8015e8ae734e8b4e53be9dbcaf7da59912f9968aaee6af5b396238fa217695c877ff4d9b5d3e9cda1ea4c1db1a43f5040
+  metadata.gz: '097d79e1a17b7b56e57a96031cf7d1e3afe80ad60c9dd2f09f92ae209dd7d90acddc56f4728cc2e5605977552bcef3739d1fffb9f0f77a410e5d8de8508b5965'
+  data.tar.gz: d24c5abb6e34b9b780b9dfe3cdb1e70aeb8128fec520d24bc9f16e8a65796d9762124cebad3ab5ae25fb99e7a74c2e834d0e64638af01a3fb104e9bb868950a5

data/lib/rs4.rb

@@ -6,7 +6,10 @@ 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'
+
 module RS4
 end

data/lib/rs4/configuration.rb

@@ -11,7 +11,23 @@ module RS4
   end
 
   class Configuration
+    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,47 +83,49 @@ 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::Request.execute(path, :get)
+        response = RS4.configuration.request_handler.execute(path, :get)
 
-        if response.class == Net::HTTPOK
-          raw_document = JSON.parse(response.body, symbolize_names: true)
+        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])
-        else
-          Rails.logger.error("Unable to get document #{document_guid}")
-          RS4::RequestError.new(
-            response.code,
-            response.class,
-            JSON.parse(response.read_body)
-          )
+          # Document.new(raw_document[:document])
+          Document.new(raw_document) if raw_document
         end
       end
 
       def get_documents
         path = 'documents'
-        response = RS4::Request.execute(path, :get)
+        response = RS4.configuration.request_handler.execute(path, :get)
 
-        if response.class == Net::HTTPOK
+        unless response.is_a?(RS4::Error) || response.nil?
           documents = []
 
-          raw_documents = JSON.parse(response.body, symbolize_names: true)
-
-          raw_documents.each do |raw_document|
-            documents << Document.new(raw_document[:document])
+          response.dig(:documents).each do |document_hash|
+            # document_hash = raw_document.pluck(:document)
+            documents << Document.new(document_hash)
           end
-        else
-          Rails.logger.error('Unable to get documents')
-          RS4::RequestError.new(
-            response.code,
-            response.class,
-            JSON.parse(response.read_body)
-          )
         end
+
+        documents
       end
     end
   end

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)
@@ -30,7 +35,19 @@ module RS4
         # https://stackoverflow.com/questions/5370697/what-s-the-best-way-to-handle-exceptions-from-nethttp#answer-11802674
         begin
           retries ||= 0
-          http.request(request)
+          response = http.request(request)
+
+          result = if response.class == Net::HTTPOK
+                     JSON.parse(response.body, symbolize_names: true)
+                   else
+                     RS4::RequestError.new(
+                       response.code,
+                       response.class,
+                       JSON.parse(response.read_body)
+                     )
+                   end
+
+          result
         rescue StandardError => e
           Rails.logger.error(e)
           retry if (retries += 1) < MAX_RETRIES

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

@@ -42,62 +42,51 @@ module RS4
       @page_image_urls = options[:page_image_urls]
     end
 
-    def get_reusable_template(template_guid)
-      return unless template_guid
+    class << self
+      def get_reusable_template(template_guid)
+        return unless template_guid
 
-      path = "reusable_templates/#{template_guid}"
+        path = "reusable_templates/#{template_guid}"
 
-      response = RS4::Request.execute(path, :get)
+        response = RS4.configuration.request_handler.execute(path, :get)
 
-      if response.class == Net::HTTPOK
-        parsed_response = JSON.parse(response.read_body, symbolize_names: true)
+        unless response.is_a?(RS4::Error) || response.nil?
+          # parsed_response = JSON.parse(response.read_body, symbolize_names: true)
 
-        template_hash = parsed_response[:reusable_template]
+          template_hash = response.dig(:reusable_template)
 
-        RS4::ReusableTemplate.new(template_hash)
-      else
-        RS4::RequestError.new(
-          response.code,
-          response.class,
-          JSON.parse(response.read_body)
-        )
+          RS4::ReusableTemplate.new(template_hash)
+        end
       end
-    end
-
-    def get_reusable_templates(options = {})
-      base_path = 'reusable_templates'
 
-      query = CGI.unescape(options.to_query)
+      def get_reusable_templates(options = {})
+        base_path = 'reusable_templates'
 
-      path = query.empty? ? base_path : "#{base_path}?#{query}"
+        query = CGI.unescape(options.to_query)
 
-      RS4::Request.execute(path, :get)
-    end
+        path = query.empty? ? base_path : "#{base_path}?#{query}"
 
-    def send_document(template_guid, options = {})
-      path = "reusable_templates/#{template_guid}/send_document"
+        RS4.configuration.request_handler.execute(path, :get)
+      end
 
-      body = options
+      def send_document(template_guid, options = {})
+        path = "reusable_templates/#{template_guid}/send_document"
 
-      body[:in_person] = true
+        body = options
 
-      response = RS4::Request.execute(path, :post, body)
+        body[:in_person] = true
 
-      Rails.logger.info("RS4::ReusableTemplate::send_document:: #{response.inspect}")
+        response = RS4.configuration.request_handler.execute(path, :post, body)
 
-      if response.class == Net::HTTPOK
-        parsed_response = JSON.parse(response.read_body, symbolize_names: true)
+        Rails.logger.info("RS4::ReusableTemplate::send_document:: #{response.inspect}")
 
-        document_hash = parsed_response[:document]
+        unless response.is_a?(RS4::Error) || response.nil?
+          # parsed_response = JSON.parse(response.read_body, symbolize_names: true)
 
-        return RS4::Document.new(document_hash)
+          document_hash = response.dig(:document)
 
-      else
-        return RS4::RequestError.new(
-          response.code,
-          response.class,
-          JSON.parse(response.read_body)
-        )
+          return RS4::Document.new(document_hash)
+        end
       end
     end
   end

data/lib/rs4/version.rb

@@ -1,3 +1,3 @@
 module RS4
-  VERSION = "0.1.5"
+  VERSION = '0.2.4'.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.1.5
+  version: 0.2.4
 platform: ruby
 authors:
 - donny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-21 00:00:00.000000000 Z
+date: 2020-07-02 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