sign_well 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2b4c38aa54fec1cbfc11f2bb9e24d005ba18a06f406bcf038c8a8a4451048fe
-  data.tar.gz: e7379a5b36b229056d636be8ab1411bdcd9e7ce11352f1f52516c53eaf708221
+  metadata.gz: e57b8457cf10b0706e082e44b7b475e7ba4762e5ff4e26c2042e0da88d1d9704
+  data.tar.gz: 219b14547a2aa1e14b2ca26a64ef26f60100c18327d7293dae28aa317d6eb125
 SHA512:
-  metadata.gz: 3f87a2f13accaf1d988994e5cf7787a50b957baa5d3a12d38ab3b373bf4be6dadac5fa342d8d43b1a8dd694a02af3f366bbb76c0a71b40192513b71cdc35579b
-  data.tar.gz: 7386cec5d8d2f71c2b3f80bd711ef5faa709be52ba34a68531df37a0a4f98e9ac8a728c3faebbd3620d0cef11997e79f342e789463331d84489ea937d7396ec5
+  metadata.gz: 9df44bf77d425d656a4fab494fffd224cf9ee5d76e98af99b0325eedadd2f56cdda4e6afae961b53641a923da00e05652e9e605030ca00bacc9fa21a793c2752
+  data.tar.gz: 9d316ce287b4c891594bbebd7c65db5862c0e9e30b752add25ca54eae2aa6b5b5b07c02be211dd456e9c0dfd2f162383a6d50908cb8212522a0c8e5bbb704934

data/CONTRIBUTING.md

@@ -0,0 +1,2 @@
+Bug reports and pull requests are welcome on GitHub at https://github.com/williamkennedy/sign_well. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
+

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+
+gem "irb", "~> 1.15"

data/Gemfile.lock

@@ -1,52 +1,57 @@
 PATH
   remote: .
   specs:
-    sign_well (1.0.2)
-      faraday (~> 1.7)
-      faraday_middleware (~> 1.1)
+    sign_well (2.0.0)
+      faraday (~> 2.12.2)
+      ostruct (~> 0.6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
-    minitest (5.15.0)
-    multipart-post (2.1.1)
-    rake (13.0.6)
-    ruby2_keywords (0.0.5)
+    date (3.4.1)
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.10.2)
+    logger (1.7.0)
+    minitest (5.25.5)
+    net-http (0.6.0)
+      uri
+    ostruct (0.6.1)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.3)
+      date
+      stringio
+    rake (13.2.1)
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    stringio (3.1.6)
+    uri (1.0.3)
 
 PLATFORMS
-  x86_64-darwin-20
+  arm64-darwin-23
+  ruby
+  x86_64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 2.3.4)
+  bundler (~> 2.6.7)
+  irb (~> 1.15)
   minitest (~> 5.0)
   rake (~> 13.0)
   sign_well!
 
 BUNDLED WITH
-   2.3.4
+   2.6.7

data/README.md

@@ -1,5 +1,11 @@
 # SignWell
 
+## Support
+
+If you would like to support this project and haven't signed up to Signwell yet, please consider using this [referral link](https://www.signwell.com/?via=william-gh).  
+
+This gem has been battle tested at [Low](https://low.ie), the best place in Ireland to go for life insurance. We use Signwell to process large 25 page templates. This gem helps creates 1000's of documents a month. 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -48,7 +54,7 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
-## [Create Document from Template](https://developers.signwell.com/reference/post_api-v1-document-templates-documents-1)
+## [Create Document from Template](https://developers.signwell.com/reference/post_api-v1-document-templates-documents)
 
 ```
 response = client.create_document_from_template(test_mode: true, template_id: 'template_id',  recipients: [{id: 1, email: 'test@test.com', placeholder_name: 'Customer', name: 'Customer'}, {id: 2, email: 'sender@sent.com',name: 'William',  placeholder_name: 'Document Sender'}], template_fields: [{api_id: 'TextField_1', value: 'hello'}, {api_id: 'CheckBox_1', value: true}
@@ -65,13 +71,21 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
-## [Delete Document](https://developers.signwell.com/reference/delete_api-v1-documents-id)
+## [Send Reminder]( https://developers.signwell.com/reference/post_api-v1-documents-id-remind)
+
+```
+response = client.remind_document(document_id, test_mode: true, embedded_signing: true)
+response.body => Hash of the JSON.body
+response.to_object =>  OpenStruct 
+```
+
+## [Delete Document](https://developers.signwell.com/reference/delete_api-v1-documents-id--1)
 
 ```
 response = client.delete_document(document_id)
 ```
 
-## [Completed PDF](https://developers.signwell.com/reference/get_api-v1-documents-id-completed-pdf)
+## [Completed PDF](https://developers.signwell.com/reference/get_api-v1-documents-id-completed-pdf-1)
 
 ```
 response = client.completed_pdf(document_id, test_mode: true, url_only: true)
@@ -80,7 +94,7 @@ response.to_object =>  OpenStruct
 ```
 
 
-## [Get Template](https://developers.signwell.com/reference/get_api-v1-document-templates-id-)
+## [Get Template](https://developers.signwell.com/reference/get_api-v1-template)
 
 ```
 response = client.template(tempate_id)
@@ -88,7 +102,7 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
-## [Create Template](https://developers.signwell.com/reference/post_api-v1-document-templates)
+## [Create Template](https://developers.signwell.com/reference/post_api-v1-template)
 
 ```
 body = {test_mode: true, "files"=>[{"name"=>"string.pdf", "file_url"=>"https://file-examples-com.github.io/uploads/2017/10/file-sample_150kB.pdf"}],
@@ -110,13 +124,13 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
-## [Delete Template](https://developers.signwell.com/reference/delete_api-v1-document-templates-id)
+## [Delete Template](https://developers.signwell.com/reference/delete_api-v1-document-templates-id--1)
 
 ```
 client.delete_template(id)
 ```
 
-## [Get API Application](https://developers.signwell.com/reference/get_api-v1-api-applications-id)
+## [Get API Application](https://developers.signwell.com/reference/get_api-v1-api-applications-id--1)
 
 ```
 response = client.api_application(id)
@@ -124,13 +138,13 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
-## [Delete API Application](https://developers.signwell.com/reference/delete_api-v1-api-applications-id)
+## [Delete API Application](https://developers.signwell.com/reference/delete_api-v1-api-applications-id--1)
 
 ```
 client.delete_api_application(id)
 ```
 
-## [List Webhooks](https://developers.signwell.com/reference/get_api-v1-hooks)
+## [List Webhooks](https://developers.signwell.com/reference/get_api-v1-hooks-1)
 
 ```
 response = client.list_web_hooks
@@ -138,7 +152,7 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
-## [Create Webhooks](https://developers.signwell.com/reference/post_api-v1-hooks)
+## [Create Webhooks](https://developers.signwell.com/reference/post_api-v1-hooks-1)
 
 ```
 response = client.create_web_hook(test_mode: true, callback_url: 'https://test.com')
@@ -152,7 +166,7 @@ response.to_object =>  OpenStruct
 client.delete_web_hook(id)
 ```
 
-## [Get Credentials](https://developers.signwell.com/reference/get_api-v1-me)
+## [Get Credentials](https://developers.signwell.com/reference/get_api-v1-me-1)
 
 ```
 client.me
@@ -176,7 +190,9 @@ client.connection.get(path)
 
 ## Contributing
 
-  Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sign_well. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sign_well/blob/main/CODE_OF_CONDUCT.md).
+  Bug reports and pull requests are welcome on GitHub at https://github.com/williamkennedy/sign_well. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/williamkennedy/sign_well/blob/main/CODE_OF_CONDUCT.md).
+
+
 
 ## License
 
@@ -184,4 +200,4 @@ client.connection.get(path)
 
 ## Code of Conduct
 
-  Everyone interacting in the SignWell project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sign_well/blob/main/CODE_OF_CONDUCT.md).
+  Everyone interacting in the SignWell project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/williamkennedy/sign_well/blob/main/CODE_OF_CONDUCT.md).

data/SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Supported Versions
+
+Please create an issue or pull request if you discover any issue

data/lib/sign_well/client.rb

@@ -11,7 +11,7 @@ module SignWell
     def document(id, params = {})
       DocumentResource.new(self).get(id, params)
     end
-    
+
     def create_document(params)
       DocumentResource.new(self).create(params)
     end
@@ -32,6 +32,10 @@ module SignWell
       DocumentResource.new(self).completed_pdf(id, params)
     end
 
+    def remind_document(id, params = {})
+      DocumentResource.new(self).remind(id, params)
+    end
+
     def template(id, params = {})
       TemplateResource.new(self).get(id, params)
     end

data/lib/sign_well/resources/document_resource.rb

@@ -23,5 +23,9 @@ module SignWell
     def completed_pdf(id, params)
       Response.new(get_request("documents/#{id}/completed_pdf", params).body)
     end
+
+    def remind(id, params)
+      Response.new(post_request("documents/#{id}/remind", params).body)
+    end
   end
 end

data/lib/sign_well/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SignWell
-  VERSION = "1.0.2"
+  VERSION = '2.0.0'
 end

data/lib/sign_well.rb

@@ -1,22 +1,20 @@
 # frozen_string_literal: true
 
-require "sign_well/version"
-require "faraday"
-require "faraday_middleware"
+require 'sign_well/version'
+require 'faraday'
 
 module SignWell
-  autoload :Client, "sign_well/client"
-  autoload :Resource, "sign_well/resource"
+  autoload :Client, 'sign_well/client'
+  autoload :Resource, 'sign_well/resource'
 
-  #Endpoints
-  
-  autoload :DocumentResource, "sign_well/resources/document_resource"
-  autoload :TemplateResource, "sign_well/resources/template_resource"
-  autoload :ApiApplicationResource, "sign_well/resources/api_application_resource"
-  autoload :WebHookResource, "sign_well/resources/web_hook_resource"
-  autoload :MeResource, "sign_well/resources/me_resource"
+  # Endpoints
 
-  # Responder
-  autoload :Response, "sign_well/response"
+  autoload :DocumentResource, 'sign_well/resources/document_resource'
+  autoload :TemplateResource, 'sign_well/resources/template_resource'
+  autoload :ApiApplicationResource, 'sign_well/resources/api_application_resource'
+  autoload :WebHookResource, 'sign_well/resources/web_hook_resource'
+  autoload :MeResource, 'sign_well/resources/me_resource'
 
+  # Responder
+  autoload :Response, 'sign_well/response'
 end

data/sign_well.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/sign_well/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sign_well'
+  spec.version = SignWell::VERSION
+  spec.authors = ['William Kennedy']
+  spec.email = ['william.kennedy@hey.com']
+
+  spec.summary = 'An API wrapper around the SignWell API'
+  spec.description = ''
+  spec.homepage = 'https://github.com/williamkennedy/sign_well'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_development_dependency 'bundler', '~> 2.6.7'
+  spec.add_development_dependency 'irb', '~> 1.15'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+
+  spec.add_dependency 'faraday', '~> 2.12.2'
+  spec.add_dependency 'ostruct', '~> 0.6.1'
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sign_well
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - William Kennedy
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: 2.6.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: 2.6.7
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +51,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.12.2
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.6.1
 description: ''
 email:
 - william.kennedy@hey.com
@@ -89,11 +102,13 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - bin/console
 - bin/setup
 - lib/sign_well.rb
@@ -107,11 +122,11 @@ files:
 - lib/sign_well/response.rb
 - lib/sign_well/version.rb
 - sig/sign_well.rbs
+- sign_well.gemspec
 homepage: https://github.com/williamkennedy/sign_well
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,15 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: An API wrapper around the SignWell API
 test_files: []