docuseal 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71374b71ef11af519bb47bc0c6f0c67635726528db6ce40bcc93527d579ed96a
-  data.tar.gz: 9310cb9a409b912f8df388d4afae5a60376321d4859d4fb0dc0893b2fed2296d
+  metadata.gz: a42565a2583a622dcfef3e7d2c145b4ea79a5b57972791c00b3c8d80f03c2bf4
+  data.tar.gz: 10bdcee2c2f97e43b746773836ac548646156e3f2825bf4bc563533cf9430d61
 SHA512:
-  metadata.gz: 1a8180b8f8a14b1db76ef934c91a33e528093881c59d147111ef3e49ae38a90ff3e653ec0cdd7a964fcb6b78dc0878c00e39608e40069579de900d5d39552389
-  data.tar.gz: 37b7f9d321ddd45530bb41b13b1d96446da0af20f55fa3aa7a18210e10c2b0dde57c7498207525c80d790452d58def384c0569219ebcf93d195b212c8b9b7c99
+  metadata.gz: 4969ccfcdca73d84d274ff3d31c79ed5beab209179efbe9c8a561477366b4503082497af7cf74e523fce008adc7c88fe553947c042714fb303959ab2473c5ff6
+  data.tar.gz: a3ca3f193ed03196c1eef26dcd2cc768aa73cd5f2ead6294656928d4333f2dea06f7c9b92a549c928a6980cd122fba7e08064f785a6c751f15dd80cf13cb50f3

data/README.md

@@ -1,255 +1,103 @@
-# Docuseal API Connector
+# DocuSeal Ruby Library
 
-<a href="https://codecov.io/github/moraki-finance/docuseal" >
- <img src="https://codecov.io/github/moraki-finance/docuseal/graph/badge.svg?token=SKTT14JJGV"/>
-</a>
+The DocuSeal Ruby library provides seamless integration with the DocuSeal API, allowing developers to interact with DocuSeal's electronic signature and document management features directly within Ruby applications. This library is designed to simplify API interactions and provide tools for efficient implementation.
 
-[![Tests](https://github.com/moraki-finance/docuseal/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/moraki-finance/docuseal/actions/workflows/main.yml)
+## Documentation
 
-A lightweight API connector for docuseal. Docuseal API docs: https://www.docuseal.co/docs/api
-
-:warning: The extracted API objects don't do input parameters validations. It's a simple faraday wrapper that allows you to send as many inputs as you want. The docuseal API might fail when passing a wrong set of parameters.
+Detailed documentation is available at [DocuSeal API Docs](https://www.docuseal.com/docs/api).
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add docuseal
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install docuseal
-
-## Usage
-
-### Setup
+To install the library, run:
 
-You'll need to set the Docuseal API key in the configuration.
-
-```rb
-Docuseal.configure do |config|
-  config.api_key = "{DOCUSEAL_API_KEY}"
-end
+```sh
+gem install docuseal
 ```
 
-You can also set some other configurations like:
-
-```rb
-Docuseal.configure do |config|
-  config.api_key = "{DOCUSEAL_API_KEY}"
-
-  # Set the docuseal API request timeout, the default is 120 seconds
-  config.request_timeout = 20
-
-  # Set extra headers that will get attached to every docuseal api request.
-  # Useful for observability tools like Helicone: https://www.helicone.ai/
-  config.global_headers = {
-    "Helicone-Auth": "Bearer HELICONE_API_KEY"
-    "helicone-stream-force-format" => "true",
-  }
+If you want to build the gem from source:
 
-  # Set the base_uri to use the docuseal EU servers if you're account was registered there.
-  # The default is https://api.docuseal.co/
-  config.base_uri = "https://api.docuseal.eu/"
-end
+```sh
+gem build docuseal.gemspec
 ```
 
-### Submissions
+### Requirements
 
-#### List
+- Ruby 2.5+.
 
-Reference: https://www.docuseal.co/docs/api#list-all-submissions
+### Bundler
 
-```rb
-submissions = Docuseal::Submission.list
-```
-
-#### Find
+Add the library to your Gemfile for projects using Bundler:
 
-Reference: https://www.docuseal.co/docs/api#get-a-submission
+```ruby
+source 'https://rubygems.org'
 
-```rb
-submission = Docuseal::Submission.find(1)
+gem 'docuseal'
 ```
 
-#### Create
-
-Reference: https://www.docuseal.co/docs/api#create-a-submission
-
-```rb
-submission = Docuseal::Submission.create(
-  template_id: 1000001,
-  send_email: true,
-  submitters: [{role: 'First Party', email: 'john.doe@example.com'}]
-)
-```
-
-#### Create From Email
-
-Reference: https://www.docuseal.co/docs/api#create-submissions-from-emails
-
-```rb
-submission = Docuseal::Submission.create(
-  from: :emails,
-  template_id: 1000001,
-  emails: 'hi@docuseal.co, example@docuseal.co'
-)
-```
-
-#### Archive
-
-Reference: https://www.docuseal.co/docs/api#archive-a-submission
-
-```rb
-submission = Docuseal::Submission.archive(1)
-```
-
-### Submitters
-
-#### List
-
-Reference: https://www.docuseal.co/docs/api#list-all-submitters
-
-```rb
-submitters = Docuseal::Submitter.list
-```
-
-#### Find
-
-Reference: https://www.docuseal.co/docs/api#get-a-submitter
-
-```rb
-submitter = Docuseal::Submitter.find(1)
-```
-
-#### Update
-
-Reference: https://www.docuseal.co/docs/api#update-a-submitter
-
-```rb
-submitter = Docuseal::Submitter.update(1,
-  email: 'john.doe@example.com',
-  fields: [{name: 'First Name', default_value: 'Acme'}]
-)
-```
-
-### Templates
-
-#### List
-
-Reference: https://www.docuseal.co/docs/api#list-all-templates
-
-```rb
-templates = Docuseal::Template.list
-```
+## Usage
 
-#### Find
+### Configuration
 
-Reference: https://www.docuseal.co/docs/api#get-a-template
+Set up the library with your DocuSeal API key based on your deployment. Retrieve your API key from the appropriate location:
 
-```rb
-template = Docuseal::Template.find(1)
-```
+#### Global Cloud
 
-#### Create From DOCX
+API keys for the global cloud can be obtained from your [Global DocuSeal Console](https://console.docuseal.com/api).
 
-Reference: https://www.docuseal.co/docs/api#create-a-template-from-word-docx
+```ruby
+require 'docuseal'
 
-```rb
-template = Docuseal::Template.create(
-  from: :docx,
-  name: 'Demo DOCX',
-  documents: [{ name: 'Demo DOCX', file: 'base64' }]
-)
+Docuseal.key = 'your_api_key_here'
 ```
 
-#### Create From HTML
+#### EU Cloud
 
-Reference: https://www.docuseal.co/docs/api#create-a-template-from-html
+API keys for the EU cloud can be obtained from your [EU DocuSeal Console](https://console.docuseal.eu/api).
 
-```rb
-template = Docuseal::Template.create(
-  from: :html,
-  html: '<p>Lorem Ipsum is simply dummy text of the\n<text-field\n  name="Industry"\n  role="First Party"\n  required="false"\n  style="width: 80px; height: 16px; display: inline-block; margin-bottom: -4px">\n</text-field>\nand typesetting industry</p>\n',
-  name: 'Test Template'
-)
-```
+```ruby
+require 'docuseal'
 
-#### Create From PDF
-
-Reference: https://www.docuseal.co/docs/api#create-a-template-from-existing-pdf
-
-```rb
-template = Docuseal::Template.create(
-  from: :pdf,
-  name: 'Test PDF',
-  documents: [
-    {
-      name: 'string',
-      file: 'base64',
-      fields: [{name: 'string', areas: [{x: 0, y: 0, w: 0, h: 0, page: 0}]}]
-    }
-  ]
-)
+Docuseal.key = 'your_api_key_here'
+Docuseal.url = 'https://api.docuseal.eu'
 ```
 
-#### Clone
-
-Reference: https://www.docuseal.co/docs/api#clone-a-template
+#### On-Premise
 
-```rb
-template = Docuseal::Template.clone(1,
-  name: 'Clone of Test',
-)
-```
+For on-premise installations, API keys can be retrieved from the API settings page of your deployed application, e.g., https://yourdocusealapp.com/settings/api.
 
-#### Update
+```ruby
+require 'docuseal'
 
-Reference: https://www.docuseal.co/docs/api#update-a-template
-
-```rb
-template = Docuseal::Template.update(1,
-  name: 'New Document Name',
-  folder_name: 'New Folder'
-)
+Docuseal.key = 'your_api_key_here'
+Docuseal.url = 'https://yourdocusealapp.com/api'
 ```
 
-#### Update Documents
-
-Reference: https://www.docuseal.co/docs/api#update-template-documents
-
-```rb
-template = Docuseal::Template.update_documents(1,
-  documents: [{file: 'base64'}]
-)
-```
+### Basic Examples
 
-#### Archive
+#### List Templates
 
-Reference: https://www.docuseal.co/docs/api#archive-a-template
+```ruby
+# list templates
+Docuseal.list_templates
 
-```rb
-template = Docuseal::Template.archive(1)
+# retrieve single template
+Docuseal.get_template(1)
 ```
 
-## Development
+### Configuring Timeouts
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment:
+Set timeouts to avoid hanging requests:
 
-```bash
-$ DOCUSEAL_API_KEY={YOUR API KEY} DOCUSEAL_BASE_URI={YOUR BASE URI} bin/console
+```ruby
+Docuseal.open_timeout = 70
+Docuseal.read_timeout = 90
 ```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Support
 
-## Contributing
+For feature requests or bug reports, visit our [GitHub Issues page](https://github.com/docusealco/docuseal-ruby/issues).
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/moraki-finance/docuseal. 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/moraki-finance/docuseal/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Docuseal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/docuseal/blob/main/CODE_OF_CONDUCT.md).

data/lib/docuseal/api.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Docuseal
+  class Api
+    Error = Class.new(StandardError)
+
+    attr_reader :http
+
+    def initialize(config)
+      @http = Http.new(config)
+    end
+
+    def list_templates(params = {})
+      http.get('/templates', params)
+    end
+
+    def get_template(id)
+      http.get("/templates/#{id}")
+    end
+
+    def create_template_from_docx(data)
+      http.post('/templates/docx', data)
+    end
+
+    def create_template_from_html(data)
+      http.post('/templates/html', data)
+    end
+
+    def create_template_from_pdf(data)
+      http.post('/templates/pdf', data)
+    end
+
+    def merge_templates(data)
+      http.post('/templates/merge', data)
+    end
+
+    def clone_template(id, data)
+      http.post("/templates/#{id}/clone", data)
+    end
+
+    def update_template(id, data)
+      http.put("/templates/#{id}", data)
+    end
+
+    def update_template_documents(id, data)
+      http.put("/templates/#{id}/documents", data)
+    end
+
+    def archive_template(id)
+      http.delete("/templates/#{id}")
+    end
+
+    def permanently_delete_template(id)
+      http.delete("/templates/#{id}", { permanently: true })
+    end
+
+    def list_submissions(params = {})
+      http.get('/submissions', params)
+    end
+
+    def get_submission(id)
+      http.get("/submissions/#{id}")
+    end
+
+    def create_submission(data)
+      http.post('/submissions/init', data)
+    end
+
+    def create_submission_from_emails(data)
+      http.post('/submissions/emails', data)
+    end
+
+    def archive_submission(id)
+      http.delete("/submissions/#{id}")
+    end
+
+    def permanently_delete_submission(id)
+      http.delete("/submissions/#{id}", { permanently: true })
+    end
+
+    def list_submitters(params = {})
+      http.get('/submitters', params)
+    end
+
+    def get_submitter(id)
+      http.get("/submitters/#{id}")
+    end
+
+    def update_submitter(id, data)
+      http.put("/submitters/#{id}", data)
+    end
+  end
+end

data/lib/docuseal/http.rb

@@ -1,62 +1,84 @@
-module Docuseal
-  module HTTP
-    def get(path, headers: {}, **query)
-      full_uri = uri(path:, query:)
+# frozen_string_literal: true
 
-      conn.get(full_uri) do |req|
-        req.headers = all_headers(headers)
-      end
-    end
+require 'json'
+require 'cgi'
+require 'uri'
+require 'net/http'
 
-    def post(path, data: {}, headers: {}, **query)
-      full_uri = uri(path:, query:)
+module Docuseal
+  class Http
+    BODY_METHODS = %i[post put].freeze
 
-      conn.post(full_uri) do |req|
-        req.body = data.to_json if data.any?
-        req.headers = all_headers(headers)
-      end
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
     end
 
-    def put(path, data: {}, headers: {}, **query)
-      full_uri = uri(path:, query:)
+    def get(path, params = {})
+      send_request(:get, path, params)
+    end
 
-      conn.put(full_uri) do |req|
-        req.body = data.to_json if data.any?
-        req.headers = all_headers(headers)
-      end
+    def post(path, body = {})
+      send_request(:post, path, {}, body)
     end
 
-    def delete(path, headers: {}, **query)
-      full_uri = uri(path:, query:)
+    def put(path, body = {})
+      send_request(:put, path, {}, body)
+    end
 
-      conn.delete(full_uri) do |req|
-        req.headers = all_headers(headers)
-      end
+    def delete(path, params = {})
+      send_request(:delete, path, params)
     end
 
     private
 
-    def conn
-      connection = Faraday.new do |f|
-        f.options[:timeout] = request_timeout
-        f.request :json
-        f.response :json
-        f.response :raise_error
-      end
+    def send_request(method, path, params = {}, body = {})
+      uri = URI.parse(config[:url] + path)
 
-      @faraday_middleware&.call(connection)
+      path = uri.path + to_query(params)
 
-      connection
-    end
+      resp =
+        if BODY_METHODS.include?(method)
+          conn(uri).public_send(method, path, body.to_json, headers)
+        else
+          conn(uri).public_send(method, path, headers)
+        end
 
-    def uri(path:, query: {})
-      File.join(base_uri, path) + "?#{URI.encode_www_form(query)}"
+      handle_response(resp)
     end
 
-    def all_headers(request_headers = {})
+    def headers
       {
-        "X-Auth-Token" => api_key
-      }.merge(global_headers).merge(request_headers)
+        'X-Auth-Token' => config[:key],
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def to_query(params)
+      return '' if params.empty?
+
+      "?#{params.map { |key, value| "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" }.join('&')}"
+    end
+
+    def conn(uri)
+      conn = Net::HTTP.new(uri.host, uri.port)
+
+      conn.read_timeout = config[:read_timeout]
+      conn.open_timeout = config[:open_timeout]
+
+      conn.use_ssl = uri.scheme == 'https'
+
+      conn
+    end
+
+    def handle_response(response)
+      case response.code.to_i
+      when 200..299
+        JSON.parse(response.body)
+      else
+        raise Api::Error, "API Error #{response.code}: #{response.body}"
+      end
     end
   end
 end

data/lib/docuseal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docuseal
-  VERSION = "0.1.1"
+  VERSION = '1.0.0'
 end

data/lib/docuseal.rb

@@ -1,45 +1,68 @@
-require "faraday"
-
-require_relative "docuseal/http"
-require_relative "docuseal/client"
-require_relative "docuseal/model"
-require_relative "docuseal/submission"
-require_relative "docuseal/submitter"
-require_relative "docuseal/template"
+# frozen_string_literal: true
 
 module Docuseal
-  class Error < StandardError; end
+  autoload :VERSION, 'docuseal/version'
+  autoload :Api, 'docuseal/api'
+  autoload :Http, 'docuseal/http'
 
-  class ConfigurationError < Error; end
+  DEFAULT_CONFIG = {
+    url: 'https://api.docuseal.com',
+    open_timeout: 60,
+    read_timeout: 60
+  }.freeze
 
-  class Configuration
-    attr_accessor :request_timeout, :base_uri, :global_headers
-    attr_writer :api_key
+  Configuration = Struct.new(:key,
+                             :url,
+                             :read_timeout,
+                             :open_timeout, keyword_init: true)
 
-    DEFAULT_BASE_URI = "https://api.docuseal.co/".freeze
-    DEFAULT_REQUEST_TIMEOUT = 120
+  class << self
+    require 'forwardable'
 
-    def initialize
-      @api_key = ENV["DOCUSEAL_API_KEY"]
-      @request_timeout = DEFAULT_REQUEST_TIMEOUT
-      @base_uri = ENV.fetch("DOCUSEAL_BASE_URI", DEFAULT_BASE_URI)
-      @global_headers = {}
-    end
+    extend Forwardable
 
-    def api_key
-      @api_key || (raise ConfigurationError, "Docuseal api_key missing!")
+    def_delegators :api,
+                   :list_templates,
+                   :get_template,
+                   :create_template_from_docx,
+                   :create_template_from_html,
+                   :create_template_from_pdf,
+                   :merge_templates,
+                   :clone_template,
+                   :update_template,
+                   :update_template_documents,
+                   :archive_template,
+                   :permanently_delete_template,
+                   :list_submissions,
+                   :get_submission,
+                   :create_submission,
+                   :create_submission_from_emails,
+                   :archive_submission,
+                   :permanently_delete_submission,
+                   :list_submitters,
+                   :get_submitter,
+                   :update_submitter
+
+    def_delegators :config,
+                   :key, :key=,
+                   :url, :url=,
+                   :open_timeout, :open_timeout=,
+                   :read_timeout, :read_timeout=
+
+    def config
+      @config ||= Configuration.new(DEFAULT_CONFIG)
     end
-  end
 
-  class << self
-    attr_writer :configuration
-  end
+    def setup
+      config.tap do |instance|
+        yield(instance) if block_given?
+      end
+    end
 
-  def self.configuration
-    @configuration ||= Docuseal::Configuration.new
-  end
+    def api(config = nil)
+      config = config ? DEFAULT_CONFIG.merge(config) : Docuseal.config
 
-  def self.configure
-    yield(configuration)
+      Docuseal::Api.new(config)
+    end
   end
 end

metadata

@@ -1,79 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: docuseal
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Martin Mochetti
-autorequire:
+- DocuSeal
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-description: A lightway, simple and non-official docuseal API connector.
+date: 2024-12-24 00:00:00.000000000 Z
+dependencies: []
+description: DocuSeal is a document signing platform. This gem provides a Ruby interface
+  to the DocuSeal API.
 email:
-- martin.mochetti@gmail.com
+- support@docuseal.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".ruby-version"
-- ".standard.yml"
-- ".vscode/settings.json"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
 - README.md
-- Rakefile
 - lib/docuseal.rb
-- lib/docuseal/client.rb
+- lib/docuseal/api.rb
 - lib/docuseal/http.rb
-- lib/docuseal/model.rb
-- lib/docuseal/submission.rb
-- lib/docuseal/submitter.rb
-- lib/docuseal/template.rb
 - lib/docuseal/version.rb
-- sig/docuseal.rbs
-homepage: https://github.com/moraki-finance/docuseal
+homepage: https://www.docuseal.com
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/moraki-finance/docuseal
-  source_code_uri: https://github.com/moraki-finance/docuseal
-  changelog_uri: https://github.com/moraki-finance/docuseal/blob/main/CHANGELOG.md
-post_install_message:
+  bug_tracker_uri: https://github.com/docusealco/docuseal-ruby/issues
+  homepage_uri: https://www.docuseal.com
+  source_code_uri: https://github.com/docusealco/docuseal-ruby
+  documentation_uri: https://www.docuseal.com/docs/api
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -81,15 +40,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
-summary: A lightweight docuseal API connector.
+summary: Ruby bindings for DocuSeal API
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.ruby-version

@@ -1 +0,0 @@
-3.3.0

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard
-ruby_version: 3.3.0

data/.vscode/settings.json

@@ -1,11 +0,0 @@
-{
-  "rubyLsp.formatter": "none", // Use standard rbfmt instead
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.organizeImports": "explicit"
-  },
-  "[ruby]": {
-    "editor.defaultFormatter": "testdouble.vscode-standard-ruby"
-  },
-  "standardRuby.autofix": true
-}

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2024-02-22
-
-- Initial release

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at martin.mochetti@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -1,3 +0,0 @@
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/moraki-finance/docuseal. 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/moraki-finance/docuseal/blob/main/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in docuseal.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "standard", "~> 1.3"
-
-group :development, :test do
-  gem "webmock", "~> 3.22.0"
-  gem "byebug", "~> 11.1"
-  gem "pry", "~> 0.14.2"
-  gem "pry-byebug", "~> 3.10"
-  gem "pry-rescue", "~> 1.5"
-  gem "pry-stack_explorer", "~> 0.6.1"
-end
-
-group :test do
-  gem "simplecov"
-  gem "simplecov-cobertura"
-end

data/Gemfile.lock

@@ -1,156 +0,0 @@
-PATH
-  remote: .
-  specs:
-    docuseal (0.1.1)
-      faraday (>= 1)
-      faraday_middleware (>= 1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    bigdecimal (3.1.6)
-    binding_of_caller (1.0.0)
-      debug_inspector (>= 0.0.1)
-    byebug (11.1.3)
-    coderay (1.1.3)
-    crack (1.0.0)
-      bigdecimal
-      rexml
-    debug_inspector (1.2.0)
-    diff-lcs (1.5.1)
-    docile (1.4.0)
-    faraday (1.10.3)
-      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.4)
-      multipart-post (~> 2)
-    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)
-    hashdiff (1.1.0)
-    interception (0.5)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
-    method_source (1.0.0)
-    multipart-post (2.4.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
-      ast (~> 2.4.1)
-      racc
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.10.1)
-      byebug (~> 11.0)
-      pry (>= 0.13, < 0.15)
-    pry-rescue (1.6.0)
-      interception (>= 0.5)
-      pry (>= 0.12.0)
-    pry-stack_explorer (0.6.1)
-      binding_of_caller (~> 1.0)
-      pry (~> 0.13)
-    public_suffix (5.0.4)
-    racc (1.7.3)
-    rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.0)
-    rubocop (1.60.2)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
-      rexml
-      simplecov (~> 0.19)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    standard (1.34.0)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.60)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.3.1)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
-    unicode-display_width (2.5.0)
-    webmock (3.22.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-23
-
-DEPENDENCIES
-  byebug (~> 11.1)
-  docuseal!
-  pry (~> 0.14.2)
-  pry-byebug (~> 3.10)
-  pry-rescue (~> 1.5)
-  pry-stack_explorer (~> 0.6.1)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  simplecov
-  simplecov-cobertura
-  standard (~> 1.3)
-  webmock (~> 3.22.0)
-
-BUNDLED WITH
-   2.5.5

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Martin Mochetti
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/Rakefile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "standard/rake"
-
-task default: %i[spec standard]

data/lib/docuseal/client.rb

@@ -1,25 +0,0 @@
-module Docuseal
-  class Client
-    include Docuseal::HTTP
-
-    CONFIG_KEYS = %i[
-      api_key request_timeout base_uri global_headers
-    ].freeze
-
-    attr_reader(*CONFIG_KEYS)
-
-    def self.instance
-      @instance ||= new
-    end
-
-    private
-
-    def initialize
-      CONFIG_KEYS.each do |key|
-        # Set instance variables like api_type & access_token. Fall back to global config
-        # if not present.
-        instance_variable_set(:"@#{key}", Docuseal.configuration.send(key))
-      end
-    end
-  end
-end

data/lib/docuseal/model.rb

@@ -1,87 +0,0 @@
-module Docuseal
-  class Model
-    class << self
-      def create(path: self.path, **attrs)
-        raise Docuseal::Error, "Method not allowed" if not_allowed_to.include?(:create)
-
-        response = Docuseal::Client.instance.post(path, data: attrs)
-        body = response.body
-
-        return body.map(&self) if body.is_a?(Array)
-
-        new(body)
-      end
-
-      def find(id)
-        raise Docuseal::Error, "Method not allowed" if not_allowed_to.include?(:find)
-
-        response = Docuseal::Client.instance.get("#{path}/#{id}")
-        new(response.body)
-      end
-
-      def update(id, **attrs)
-        raise Docuseal::Error, "Method not allowed" if not_allowed_to.include?(:update)
-
-        response = Docuseal::Client.instance.put("#{path}/#{id}", data: attrs)
-        new(response.body)
-      end
-
-      def list(**)
-        raise Docuseal::Error, "Method not allowed" if not_allowed_to.include?(:list)
-
-        response = Docuseal::Client.instance.get(path, **)
-        response.body["data"].map(&self)
-      end
-
-      def archive(id)
-        raise Docuseal::Error, "Method not allowed" if not_allowed_to.include?(:archive)
-
-        response = Docuseal::Client.instance.delete("#{path}/#{id}")
-        new(response.body)
-      end
-
-      # Auxiliary methods
-
-      def to_proc
-        ->(attrs) { new(attrs) }
-      end
-
-      def skip_coertion_for(attrs = [])
-        @skip_coertion_for ||= attrs
-      end
-
-      def not_allowed_to(attrs = [])
-        @not_allowed_to ||= attrs
-      end
-    end
-
-    def to_json
-      @_raw.to_json
-    end
-
-    protected
-
-    def initialize(attrs = {})
-      @_raw = attrs
-
-      attrs.each do |key, value|
-        if self.class.skip_coertion_for.include?(key.to_sym)
-          instance_variable_set(:"@#{key}", value)
-        else
-          coerced_value = if value.is_a?(Hash)
-            Docuseal::Model.new(value)
-          elsif value.is_a?(Array)
-            value.map do |v|
-              v.is_a?(Hash) ? Docuseal::Model.new(v) : v
-            end
-          else
-            value
-          end
-          instance_variable_set(:"@#{key}", coerced_value)
-        end
-      end
-
-      instance_variables.each { |iv| self.class.send(:attr_reader, iv.to_s[1..].to_sym) }
-    end
-  end
-end

data/lib/docuseal/submission.rb

@@ -1,18 +0,0 @@
-module Docuseal
-  class Submission < Model
-    skip_coertion_for [:values]
-    not_allowed_to [:update]
-
-    def self.path
-      "/submissions"
-    end
-
-    def self.create(from: nil, **attrs)
-      if from
-        super(path: "#{path}/#{from}", **attrs)
-      else
-        super(**attrs)
-      end
-    end
-  end
-end

data/lib/docuseal/submitter.rb

@@ -1,9 +0,0 @@
-module Docuseal
-  class Submitter < Model
-    not_allowed_to %i[create archive]
-
-    def self.path
-      "/submitters"
-    end
-  end
-end

data/lib/docuseal/template.rb

@@ -1,29 +0,0 @@
-module Docuseal
-  class Template < Model
-    def self.path
-      "/templates"
-    end
-
-    # from: :html, :docx or :pdf
-    #
-    # https://www.docuseal.co/docs/api#create-a-template-from-html
-    # https://www.docuseal.co/docs/api#create-a-template-from-word-docx
-    # https://www.docuseal.co/docs/api#create-a-template-from-existing-pdf
-    def self.create(from:, **attrs)
-      super(path: "#{path}/#{from}", **attrs)
-    end
-
-    # https://www.docuseal.co/docs/api#update-template-documents
-    def self.update_documents(id, documents: [])
-      return if documents.empty?
-      response = Docuseal::Client.instance.put("#{path}/#{id}/documents", data: {documents:})
-      new(response.body)
-    end
-
-    # https://www.docuseal.co/docs/api#clone-a-template
-    def self.clone(id, **attrs)
-      response = Docuseal::Client.instance.post("#{path}/#{id}/clone", data: attrs)
-      new(response.body)
-    end
-  end
-end

data/sig/docuseal.rbs

@@ -1,4 +0,0 @@
-module Docuseal
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end