rs4 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c68d7c9729dc665292fad36e4941883c8463cc1023646ae749cb90aae8d1c086
-  data.tar.gz: 1ca39c4a0bb4332e0fb0f3b31cd613bf5fea3145a4547f3ae2c6a2bf3a70a3f2
+  metadata.gz: 8edb979aea62c9329b7a46903ecbcd1821a6c06095529ae43706b87f4035a944
+  data.tar.gz: 8bf89c83e2c4c62a4c3cbbe5b1706e3e330e62fbfbda634da22d10cc2deb7355
 SHA512:
-  metadata.gz: 8c7f1236840b7da3593c717416b5313dab2a6a1c1e5982e4accd7d161b246981d64efc2ddced70cd4cd1a834bc32e3a036252c1cf575c70739e2c696a3d449de
-  data.tar.gz: 743fc9ff74312577fd610019519487a0312a81de74de7e4f951020d9befd048357e230d851ce1facc24a1e5f38ec6f71c010c9e087987e5b0f96f555e8bec603
+  metadata.gz: c1141f8182f210b2752da9b4ec45609448a9bb8cd5de2eb96034c90e95b89a16d416fbabc82e368d72d5b95735ea13bf90f6f2d6b4f8a492ad438a8d2218e1dc
+  data.tar.gz: 29d24cebaace5128a40bad69153cad70112bd2a8bceb461a1487a364b7bfe9db361113c621ba6092f7e7e6166d9a01b8b6e39b86edfa7ac370d4f04916477561

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 *.gem
+*.swp

data/lib/rs4.rb

@@ -2,44 +2,13 @@ require 'uri'
 require 'net/http'
 require 'openssl'
 
-module RS4
-  # Prepares the HTTP request with the headers
-  # required by the RS4 endpoints
-  class Request
-    # Reattempt the request before giving up
-    MAX_RETRIES = 5
-
-    class << self
-      def execute(path, method = :get, body = {})
-        url = URI(RS4.configuration.api_host + '/public/v1/' + path)
-
-        http = Net::HTTP.new(url.host, url.port)
-        http.use_ssl = true
+require 'rs4/request.rb'
+require 'rs4/document.rb'
+require 'rs4/configuration.rb'
+require 'rs4/request_error.rb'
+require 'rs4/reusable_template.rb'
 
-        request = case method
-                  when :get
-                    Net::HTTP::Get.new(url)
-                  when :post
-                    Net::HTTP::Post.new(url)
-                  when :put
-                    Net::HTTP::Put.new(url)
-                  when :delete
-                    Net::HTTP::Delete.new(url)
-                  end
+require 'test/mock_request.rb'
 
-        request.body = body.to_json unless method == :get
-        request['Content-Type'] = 'application/json' unless method == :get
-        request['Authorization'] = "Basic #{Base64.strict_encode64(RS4.configuration.private_api_key)}"
-
-        # https://stackoverflow.com/questions/5370697/what-s-the-best-way-to-handle-exceptions-from-nethttp#answer-11802674
-        begin
-          retries ||= 0
-          http.request(request)
-        rescue StandardError => e
-          Rails.logger.error(e)
-          retry if (retries += 1) < MAX_RETRIES
-        end
-      end
-    end
-  end
+module RS4
 end

data/lib/{configuration.rb → rs4/configuration.rb}

@@ -11,6 +11,7 @@ module RS4
   end
 
   class Configuration
+    attr_accessor :request_handler
     attr_accessor :private_api_key
     attr_accessor :api_host
   end

data/lib/{document.rb → rs4/document.rb}

@@ -87,42 +87,30 @@ module RS4
 
         path = "documents/#{document_guid}"
 
-        response = RS4Api::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.class == RS4::RequestError || 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}")
-          RS4Api::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 = RS4Api::Request.execute(path, :get)
+        response = RS4.configuration.request_handler.execute(path, :get)
 
-        if response.class == Net::HTTPOK
+        unless response.class == RS4::RequestError || 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')
-          RS4Api::RequestError.new(
-            response.code,
-            response.class,
-            JSON.parse(response.read_body)
-          )
         end
+
+        documents
       end
     end
   end

data/lib/rs4/request.rb

@@ -0,0 +1,53 @@
+module RS4
+  # Prepares the HTTP request with the headers
+  # required by the RS4 endpoints
+  class Request
+    # Reattempt the request before giving up
+    MAX_RETRIES = 5
+
+    class << self
+      def execute(path, method = :get, body = {})
+        url = URI(RS4.configuration.api_host + '/public/v1/' + path)
+
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = true
+
+        request = case method
+                  when :get
+                    Net::HTTP::Get.new(url)
+                  when :post
+                    Net::HTTP::Post.new(url)
+                  when :put
+                    Net::HTTP::Put.new(url)
+                  when :delete
+                    Net::HTTP::Delete.new(url)
+                  end
+
+        request.body = body.to_json unless method == :get
+        request['Content-Type'] = 'application/json' unless method == :get
+        request['Authorization'] = "Basic #{Base64.strict_encode64(RS4.configuration.private_api_key)}"
+
+        # https://stackoverflow.com/questions/5370697/what-s-the-best-way-to-handle-exceptions-from-nethttp#answer-11802674
+        begin
+          retries ||= 0
+          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
+        end
+      end
+    end
+  end
+end

data/lib/rs4/reusable_template.rb

@@ -0,0 +1,93 @@
+module RS4
+  class ReusableTemplate
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :creator
+    attr_accessor :expires_in
+    attr_accessor :signer_sequencing
+    attr_accessor :shared_with
+    attr_accessor :distribution_method
+    attr_accessor :identity_method
+    attr_accessor :kba
+    attr_accessor :passcode
+    attr_accessor :filename
+    attr_accessor :tags
+    attr_accessor :user_id
+    attr_accessor :roles
+    attr_accessor :merge_field_components
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :thumbnail_url
+    attr_accessor :page_image_urls
+
+    def initialize(options = {})
+      @id = options[:id]
+      @name = name
+      @creator = options[:creator]
+      @expires_in = options[:expires_in]
+      @signer_sequencing = options[:signer_sequencing]
+      @shared_with = options[:shared_with]
+      @distribution_method = options[:distribution_method]
+      @identity_method = options[:identity_method]
+      @kba = options[:kba]
+      @passcode = options[:passcode]
+      @filename = options[:filename]
+      @tags = options[:tags]
+      @user_id = options[:user_id]
+      @roles = options[:roles]
+      @merge_field_components = options[:merge_field_components]
+      @created_at = options[:created_at]
+      @updated_at = options[:updated_at]
+      @thumbnail_url = options[:thumbnail_url]
+      @page_image_urls = options[:page_image_urls]
+    end
+
+    class << self
+      def get_reusable_template(template_guid)
+        return unless template_guid
+
+        path = "reusable_templates/#{template_guid}"
+
+        response = RS4.configuration.request_handler.execute(path, :get)
+
+        unless response.class == RS4::RequestError || response.nil?
+          # parsed_response = JSON.parse(response.read_body, symbolize_names: true)
+
+          template_hash = response.dig(:reusable_template)
+
+          RS4::ReusableTemplate.new(template_hash)
+        end
+      end
+
+      def get_reusable_templates(options = {})
+        base_path = 'reusable_templates'
+
+        query = CGI.unescape(options.to_query)
+
+        path = query.empty? ? base_path : "#{base_path}?#{query}"
+
+        RS4.configuration.request_handler.execute(path, :get)
+      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?
+          # parsed_response = JSON.parse(response.read_body, symbolize_names: true)
+
+          document_hash = response.dig(:document)
+
+          return RS4::Document.new(document_hash)
+        end
+      end
+    end
+  end
+end

data/lib/rs4/version.rb

@@ -1,3 +1,3 @@
 module RS4
-  VERSION = "0.1.3"
+  VERSION = '0.2.2'.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.3
+  version: 0.2.2
 platform: ruby
 authors:
 - donny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-20 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies: []
 description: Provides ruby access to CRUD operations for RightSignature documents
   and reusable templates
@@ -27,12 +27,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/configuration.rb
-- lib/document.rb
-- lib/request_error.rb
-- lib/reusable_template.rb
 - lib/rs4.rb
+- lib/rs4/configuration.rb
+- lib/rs4/document.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

data/lib/reusable_template.rb

@@ -1,104 +0,0 @@
-module RS4
-  class ReusableTemplate
-    attr_accessor :id
-    attr_accessor :name
-    attr_accessor :creator
-    attr_accessor :expires_in
-    attr_accessor :signer_sequencing
-    attr_accessor :shared_with
-    attr_accessor :distribution_method
-    attr_accessor :identity_method
-    attr_accessor :kba
-    attr_accessor :passcode
-    attr_accessor :filename
-    attr_accessor :tags
-    attr_accessor :user_id
-    attr_accessor :roles
-    attr_accessor :merge_field_components
-    attr_accessor :created_at
-    attr_accessor :updated_at
-    attr_accessor :thumbnail_url
-    attr_accessor :page_image_urls
-
-    def initialize(options = {})
-      @id = options[:id]
-      @name = name
-      @creator = options[:creator]
-      @expires_in = options[:expires_in]
-      @signer_sequencing = options[:signer_sequencing]
-      @shared_with = options[:shared_with]
-      @distribution_method = options[:distribution_method]
-      @identity_method = options[:identity_method]
-      @kba = options[:kba]
-      @passcode = options[:passcode]
-      @filename = options[:filename]
-      @tags = options[:tags]
-      @user_id = options[:user_id]
-      @roles = options[:roles]
-      @merge_field_components = options[:merge_field_components]
-      @created_at = options[:created_at]
-      @updated_at = options[:updated_at]
-      @thumbnail_url = options[:thumbnail_url]
-      @page_image_urls = options[:page_image_urls]
-    end
-
-    def get_reusable_template(template_guid)
-      return unless template_guid
-
-      path = "reusable_templates/#{template_guid}"
-
-      response = RS4::Request.execute(path, :get)
-
-      if response.class == Net::HTTPOK
-        parsed_response = JSON.parse(response.read_body, symbolize_names: true)
-
-        template_hash = parsed_response[:reusable_template]
-
-        RS4Api::ReusableTemplate.new(template_hash)
-      else
-        RS4Api::RequestError.new(
-          response.code,
-          response.class,
-          JSON.parse(response.read_body)
-        )
-      end
-    end
-
-    def get_reusable_templates(options = {})
-      base_path = 'reusable_templates'
-
-      query = CGI.unescape(options.to_query)
-
-      path = query.empty? ? base_path : "#{base_path}?#{query}"
-
-      RS4::Request.execute(path, :get)
-    end
-
-    def send_document(template_guid, options = {})
-      path = "reusable_templates/#{template_guid}/send_document"
-
-      body = options
-
-      body[:in_person] = true
-
-      response = RS4::Request.execute(path, :post, body)
-
-      Rails.logger.info("RS4::ReusableTemplate::send_document:: #{response.inspect}")
-
-      if response.class == Net::HTTPOK
-        parsed_response = JSON.parse(response.read_body, symbolize_names: true)
-
-        document_hash = parsed_response[:document]
-
-        return RS4Api::Document.new(document_hash)
-
-      else
-        return RS4Api::RequestError.new(
-          response.code,
-          response.class,
-          JSON.parse(response.read_body)
-        )
-      end
-    end
-  end
-end