sign_well 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b255e6788c68a7d121fcdc284d22ee6c93bfa429426f81898df302ae5a293fee
-  data.tar.gz: ecff23a9c2b0472d2566ab51fccc9eafcecd0e1f1aaa475ecd5c7823cdc07874
+  metadata.gz: 13b9c78b424fc39a7fb6989680a83ecfa2d8aee8751c4c984c1fca3cf6064072
+  data.tar.gz: cf2da8c99dee7f33301ce3952cbf7d75d56ca9d35d14be2b4a620667a651994d
 SHA512:
-  metadata.gz: 105f447a749cf01d9de3cca7e0605de81392fc8f786017ddeaa0567204259bbb247ff76aa190268fe1681b4f25476fde709865e883da71a66523742c389120bb
-  data.tar.gz: 9d1f186d486407b585b92c09ce85a46ede39febc255ac3873c0321d3c4632507c4f581241529589ee64a5ce727953570a2af3d89ad26402528b6ee69e36e08e4
+  metadata.gz: 1ea0092ec82092cac41e4383b44dbc87e50608cb9ee15b759b8bac211998ae618de553a74955252dfbc2a518f005d010ad855624f05e8a30599a2e88bd1d5e92
+  data.tar.gz: c8ab89dc07bd9dbe8298582291c2bacc9a56aa5937052d70e7be3c5a3d626a665f6964025aff1534bf030718a1f4b30d30e254d8bc654f8ca1a454f1425eb856

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.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    sign_well (1.0.1)
+    sign_well (1.0.3)
       faraday (~> 1.7)
       faraday_middleware (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    faraday (1.10.0)
+    faraday (1.10.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -24,8 +24,8 @@ GEM
     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-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
@@ -34,11 +34,12 @@ GEM
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
     minitest (5.15.0)
-    multipart-post (2.1.1)
+    multipart-post (2.4.1)
     rake (13.0.6)
     ruby2_keywords (0.0.5)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-darwin-20
   x86_64-linux
 

data/README.md

@@ -1,11 +1,17 @@
 # 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:
 
-```ruby
-gem 'sign_well'
+```bash
+bundle add sign_well
 ```
 
 And then execute:
@@ -32,7 +38,7 @@ client = SignWell::Client.new(x_api_key: ENV['X_API_KEY'])
 
 ```
 
-## [Get Document](https://developers.signwell.com/reference/get_api-v1-documents-id--1)
+## [Get Document](https://developers.signwell.com/reference/get_api-v1-document)
 
 ```
 response = client.document('docment_id')
@@ -40,7 +46,7 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
-## [Create Document](https://developers.signwell.com/reference/post_api-v1-documents-1)
+## [Create Document](https://developers.signwell.com/reference/post_api-v1-documents)
 
 ```
 response = client.create_document(test_mode: true, files: [{name: 'test', file_url: 'exmpaledoc.com'}], recipients: [{id: 1, email: 'william@test.com'}])
@@ -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}
@@ -57,7 +63,7 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
-## [Update and Send Document](https://developers.signwell.com/reference/post_api-v1-documents-id-send-1)
+## [Update and Send Document](https://developers.signwell.com/reference/post_api-v1-documents-id-send)
 
 ```
 response = client.update_and_send_document(document_id, test_mode: true, embedded_signing: true)
@@ -65,6 +71,14 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
+## [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)
 
 ```
@@ -80,7 +94,7 @@ response.to_object =>  OpenStruct
 ```
 
 
-## [Get Template](https://developers.signwell.com/reference/get_api-v1-document-templates-id--1)
+## [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-1)
+## [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"}],
@@ -146,7 +160,7 @@ response.body => Hash of the JSON.body
 response.to_object =>  OpenStruct 
 ```
 
-## [Delete Webhook](https://developers.signwell.com/reference/delete_api-v1-hooks-id--1)
+## [Delete Webhook](https://developers.signwell.com/reference/delete_api-v1-hooks-id)
 
 ```
 client.delete_web_hook(id)
@@ -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/resource.rb

@@ -15,14 +15,14 @@ module SignWell
 
     def post_request(path, params)
       client.connection.post(path) do |req|
-        req.params = params
+        req.body = params.to_json
         req.headers['Content-Type'] = 'application/json'
       end
     end
 
     def patch_request(path, params)
       client.connection.patch(path) do |req|
-        req.params = params
+        req.body = params.to_json
         req.headers['Content-Type'] = 'application/json'
         req.headers['Accept'] = 'application/json'
       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.1"
+  VERSION = "1.0.3"
 end

data/sign_well.gemspec

@@ -0,0 +1,37 @@
+# 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 = ">= 2.7.0"
+
+  # 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.3.4"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.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,14 @@
 --- !ruby/object:Gem::Specification
 name: sign_well
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - William Kennedy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,11 +89,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,7 +109,7 @@ files:
 - lib/sign_well/response.rb
 - lib/sign_well/version.rb
 - sig/sign_well.rbs
-- sign_well-1.0.0.gem
+- sign_well.gemspec
 homepage: https://github.com/williamkennedy/sign_well
 licenses:
 - MIT
@@ -127,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: An API wrapper around the SignWell API