rs4 0.2.3 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4064ed9919a67b9d7b02c1b00452f2ba0ff1323ba8953a4a9826cfd000714dcc
-  data.tar.gz: 6907a7d5bad42fac43c1d9b372936cfe44c6d1ec8f2257573d3ed159e04908ae
+  metadata.gz: 67df5afff0e76629545e1cc0d5fd9721395812a6b5c72c7adb6d3f9bc03e149b
+  data.tar.gz: '08dcb4aa33cfc70fbdd359cbe1fcd42e16ba0adf78a944b2ce36d37eb476d839'
 SHA512:
-  metadata.gz: 43d0f4b4ee7df70868c5c413967eeeca8047cf992fbebcc8fd286ad2c93f0590dec64df01b561927f4a7e2d7a682ecf515659a89c42cd207ed3f40f3e1c03950
-  data.tar.gz: a195784b8fb5f06e368fc8f89339d6b89fc282e95deaee5a126f2e42bca5157661f9e80398a291a301979a3ace429da7ce19d17ccb2e18020518da12b81acb53
+  metadata.gz: '062720059d3fcd5e026e0b4e130121eacec1de5b1fe07d3432218902bf4303cadf67ef4c2037cef6a3454c0ee60691dac129b7e6e9a48bb5a92595095c51d72e'
+  data.tar.gz: 13a9dbcf8616d98dc76af53048b71ae60b136976084a194d16b4fcd03f759705945d3c1cca2ae429fb0b1811a255b3775b6c6ec962f032179f698e2b158dde70

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

@@ -90,7 +90,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?
           archived_document = response.dig(:archived_document)
 
           Document.new(archived_document) if archived_document
@@ -104,7 +104,37 @@ module RS4
 
         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])
+          Document.new(raw_document) if raw_document
+        end
+      end
+
+      def get_force_complete(document_guid)
+        return unless document_guid.present?
+
+        path = "documents/#{document_guid}/force_complete"
+
+        response = RS4.configuration.request_handler.execute(path, :post)
+
+        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])
+          Document.new(raw_document) if raw_document
+        end
+      end
+
+      def get_force_complete(document_guid)
+        return unless document_guid.present?
+
+        path = "documents/#{document_guid}/force_complete"
+
+        response = RS4.configuration.request_handler.execute(path, :get)
+
+        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])
@@ -116,7 +146,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,52 @@ module RS4
         RS4.configuration.request_handler.execute(path, :get)
       end
 
+      def prepare_document(template_guid, options = {})
+        path = "reusable_templates/#{template_guid}/prepare_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 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.3'.freeze
+  VERSION = '0.2.10'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rs4
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.10
 platform: ruby
 authors:
 - donny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-07-10 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