rs4 0.2.2 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8edb979aea62c9329b7a46903ecbcd1821a6c06095529ae43706b87f4035a944
-  data.tar.gz: 8bf89c83e2c4c62a4c3cbbe5b1706e3e330e62fbfbda634da22d10cc2deb7355
+  metadata.gz: 58c1470115558a69ec369b78be72bb1c7913e13ccbf29c64931d2020edfe8d5f
+  data.tar.gz: 79d8ab66e22e0eacce069057d0802c3157937b8fb311aa5ecb064dfae5932f9d
 SHA512:
-  metadata.gz: c1141f8182f210b2752da9b4ec45609448a9bb8cd5de2eb96034c90e95b89a16d416fbabc82e368d72d5b95735ea13bf90f6f2d6b4f8a492ad438a8d2218e1dc
-  data.tar.gz: 29d24cebaace5128a40bad69153cad70112bd2a8bceb461a1487a364b7bfe9db361113c621ba6092f7e7e6166d9a01b8b6e39b86edfa7ac370d4f04916477561
+  metadata.gz: 973322b9feae4038cea97011992d227074f9f7a0286a649447c02fd5c98459c59df903cd17081fe3d994bb63cd447d9e4ee7b5b7dfc623c908cc3bb138b656fa
+  data.tar.gz: 6dd001b29aab096e7f54c5c29196601768fd9aceb96c235e2f40d7b91b51c5dc6a3581f3cb06e8cc0d6d55c930cddb4b2c1098a43ea025fcdfb2cd1dfc8a1dfe

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)
@@ -69,18 +69,34 @@ module RS4
         RS4.configuration.request_handler.execute(path, :get)
       end
 
+      def embed_document(template_guid, options = {})
+        path = "reusable_templates/#{template_guid}/embed_document"
+
+        body = options
+
+        response = RS4.configuration.request_handler.execute(path, :post, body)
+
+        Rails.logger.info("RS4::ReusableTemplate::embed_document:: #{response.inspect}")
+
+        unless response.is_a?(RS4::Error) || response.nil?
+          # parsed_response = JSON.parse(response.read_body, symbolize_names: true)
+
+          document_hash = response.dig(:document)
+
+          return RS4::Document.new(document_hash)
+        end
+      end
+
       def send_document(template_guid, options = {})
         path = "reusable_templates/#{template_guid}/send_document"
 
         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.2'.freeze
+  VERSION = '0.2.9'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rs4
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.9
 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,7 +29,9 @@ 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