zoho_sign 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85bd1a932999943e553720f8e0d866a0b5365bdd2a29406c5016d59b2ae39f7b
-  data.tar.gz: 55cd33a724b2d63ecc0c95aa62cf1d2e5a6b114aa1d522244fc8314ccdf30ef6
+  metadata.gz: 3c46cf1b2d02de19a4ee38cfef80b99434821cd5b8fb2e522fa9d5451262f69f
+  data.tar.gz: 120c0544bc95cac4d0b4c4097f1883c845cad7807d1872b26740528be756a3c2
 SHA512:
-  metadata.gz: 57f9062cd8b92ecdfae801fbce3a70bd6a4b0a44d3c06d331dee9d0709006e79ddb4b11ab90804d0c9719c9898768019f8227f78cf15ca9ab613d6271785b163
-  data.tar.gz: 9bd95ce532b3f593f764dfb48f4bb8af5a0661f2e67ca935aa493b556828e07aeb38db07e70235ac334faacb5605b26679f75a939fcaea9be28762cd670f8c54
+  metadata.gz: b986846dda6e3844e6acd6bb00f8ca7a71a24bd9164ab23ae8f9144e36445c8ef6f07948b6ba29b09a5e7ee6f712f4f95c99c79963d211784478f58b5e1c2701
+  data.tar.gz: '0297893e33d5effb14c80ed199402798642c56bcf2a56300f31ab3f6e3fa8688086c973bcb0c11261f65067904c2c424ef9a0476f09a19e8921a3d9c11665c1c'

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.2.1] - 2023-10-03
+
+- Adding support for Zoho regional domains (#53)
+
+## [0.2.0] - 2023-10-02
+
+- Upgrade Faraday gem from v1 to v2 (#52)
+- Add ruby 3.1 to the testing matrix. (#27)
+
+## [0.1.1] - 2021-12-17
+
+- Created `RELEASE_PROCESS.md`.
+
 ## [0.1.0] - 2021-09-17
 
 - Initial release:

data/Gemfile

@@ -10,7 +10,7 @@ gem "dotenv"
 gem "rake", "~> 13.0"
 
 # Lints
-gem "rubocop", "~> 1.7"
+gem "standard", "~> 1.5"
 
 # Console
 gem "pry"
@@ -19,3 +19,6 @@ gem "pry"
 gem "faker"
 gem "rspec", "~> 3.0"
 gem "webmock"
+
+# Publish Gem
+gem "gem-release", "~> 2.2"

data/README.md

@@ -48,7 +48,15 @@ ZohoSign.config.update(
 params = ZohoSign::Auth.refresh_token(ENV["ZOHO_SIGN_REFRESH_TOKEN"])
 ZohoSign.config.connection = params
 ```
-
+### Configure regional domain (if applicable)
+```ruby
+ZohoSign.config.update(
+  api: {
+    auth_domain: "https://accounts.zoho.eu",
+    domain: "https://sign.zoho.eu"
+  }
+)
+```
 ### How to use `ZohoSign::Template`
 
 Find all templetes:

data/RELEASE_PROCESS.md

@@ -0,0 +1,51 @@
+# How to create a new release
+
+## Step 1: Update `CHANGELOG.md`
+
+The step 1 is to make sure the `CHANGELOG.md` is up-to-date. If is not up-to-date
+please update the missing changes.
+
+## Step 2: Prepare the release
+
+Note: This steps needs to be performed in the `main` branch. Remember to have a up-to-date repo.
+
+First open the `lib/zoho_sign/version.rb` file and update the `VERSION` constant.
+
+We are following "[Semantic Versioning v2](https://semver.org/spec/v2.0.0.html)" conventions.
+
+## Step 3: Setup your environment
+
+First of all make sure you have the file `~/.gem/credentials` with this content:
+
+```yml
+---
+:rubygems_api_key: $RUBYGEM_API_KEY
+:github: $GITHUB_TOKEN_API_KEY
+```
+
+You can get your `$RUBYGEM_API_KEY` from your RubyGems.org account.
+You can get your `$GITHUB_TOKEN_API_KEY` from your GitHub.com account. Instructions [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
+
+## Step 4: Publish new gem version in GitHub Package Registry
+
+Now last step run this terminal commands:
+
+```bash
+gem build *.gemspec
+gem push --KEY github --host https://$GITHUB_USER:$GITHUB_TOKEN_API_KEY@rubygems.pkg.github.com/wecasa *.gem
+```
+
+- `$GITHUB_USER` -> example `wakematta`
+- `$GITHUB_TOKEN_API_KEY` -> Instructions [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
+
+## Step 5: Publish new gem version in RubyGems.org
+
+Now you can run this terminal command:
+
+```bash
+gem bump --release --push --tag --version '$NEW_RELEASE_VERSION' --message ':arrow_up: Prepare release v%{version} %{skip_ci}'
+```
+
+Remember that `$NEW_RELEASE_VERSION` needs to be the same as the one in `lib/zoho_sign/version.rb`.
+
+You can add `--pretend` to the command, to make sure there is no erros. Before doing it for real.

data/Rakefile

@@ -5,8 +5,6 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require "standard/rake"
 
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+task default: %i[spec standard]

data/lib/zoho_sign/auth.rb

@@ -2,7 +2,7 @@
 
 require "json"
 require "faraday"
-require "faraday_middleware"
+require "faraday/retry"
 require "addressable"
 
 module ZohoSign
@@ -11,8 +11,6 @@ module ZohoSign
   class Auth
     extend Forwardable
 
-    AUTH_DOMAIN_PATH = "https://accounts.zoho.com"
-
     TOKEN_PATH = "/oauth/v2/token"
 
     DEFAULT_SCOPES = %w[
@@ -27,6 +25,7 @@ module ZohoSign
       @configuration = ZohoSign.config
       @access_type = access_type
       @scopes = scopes
+      @auth_domain_path = ZohoSign.config.api.auth_domain
     end
 
     def self.refresh_token(refresh_token)
@@ -57,7 +56,7 @@ module ZohoSign
     end
 
     def token_full_uri
-      Addressable::URI.join(AUTH_DOMAIN_PATH, TOKEN_PATH)
+      Addressable::URI.join(@auth_domain_path, TOKEN_PATH)
     end
 
     def self.get_token(grant_token)

data/lib/zoho_sign/base_record.rb

@@ -21,8 +21,7 @@ module ZohoSign
       # @param [String] :sort_order (nil)
       #
       # @return [Array] Array of instances of current class
-      def all(start_index: DEFAULT_START_INDEX, per_request: DEFAULT_RECORDS_PER_REQUEST,
-              sort_column: nil, sort_order: nil)
+      def all(start_index: DEFAULT_START_INDEX, per_request: DEFAULT_RECORDS_PER_REQUEST, sort_column: nil, sort_order: nil)
         params = build_params_for_index_action(start_index, per_request, sort_column, sort_order)
         body = connection.get(request_path, params)
         response = build_response(body)

data/lib/zoho_sign/connection.rb

@@ -2,7 +2,7 @@
 
 require "rainbow"
 require "faraday"
-require "faraday_middleware"
+require "faraday/retry"
 
 require_relative "response_handler"
 
@@ -101,7 +101,7 @@ module ZohoSign
         conn.headers["Content-Type"] = "application/x-www-form-urlencoded"
         conn.request :json
         conn.request :retry
-        conn.response :json, parser_options: { symbolize_names: true }, content_type: /\bjson$/
+        conn.response :json, parser_options: {symbolize_names: true}, content_type: /\bjson$/
         conn.response :logger if ZohoSign.config.debug
         conn.adapter Faraday.default_adapter
       end
@@ -112,7 +112,7 @@ module ZohoSign
         conn.headers["Authorization"] = authorization_token if access_token?
         conn.headers["Content-Type"] = "application/x-www-form-urlencoded"
         conn.request :retry
-        conn.response :json, parser_options: { symbolize_names: true }, content_type: /\bjson$/
+        conn.response :json, parser_options: {symbolize_names: true}, content_type: /\bjson$/
         conn.response :logger if ZohoSign.config.debug
         conn.adapter Faraday.default_adapter
       end

data/lib/zoho_sign/template.rb

@@ -35,8 +35,7 @@ module ZohoSign
       #
       # @return [Class] ZohoSign::Document instance
       #
-      def create_document(template_id:, field_data: {}, recipient_data: [], shared_notes: "", quicksend: true,
-                          document_name: nil)
+      def create_document(template_id:, field_data: {}, recipient_data: [], shared_notes: "", quicksend: true, document_name: nil)
         actions = recipient_data.map do |action_data|
           recipient = action_data.fetch(:recipient)
           {

data/lib/zoho_sign/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZohoSign
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/zoho_sign.rb

@@ -27,6 +27,7 @@ module ZohoSign
   end
 
   setting :api do
+    setting :auth_domain, default: "https://accounts.zoho.com"
     setting :domain, default: "https://sign.zoho.com"
     setting :base_path, default: "/api/v1"
   end

data/renovate.json

@@ -1,5 +1,6 @@
 {
   "extends": [
     "config:base"
-  ]
+  ],
+  "commitMessagePrefix": ":arrow_up:"
 }

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: zoho_sign
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Wecasa Developers Team
 - Mohamed Ziata
+- Louise
+- Romain Verbeke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -68,7 +70,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,9 +110,9 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
+- RELEASE_PROCESS.md
 - Rakefile
 - bin/console
 - bin/setup
@@ -132,6 +134,7 @@ metadata:
   source_code_uri: https://github.com/wecasa/zoho_sign
   changelog_uri: https://github.com/wecasa/zoho_sign/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/wecasa/zoho_sign/issues
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -147,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Zoho Sign API Wrapper

data/Gemfile.lock

@@ -1,124 +0,0 @@
-PATH
-  remote: .
-  specs:
-    zoho_sign (0.1.0)
-      activesupport
-      addressable
-      dry-configurable (~> 0.13)
-      faraday
-      faraday_middleware
-      rainbow
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.1.4.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.9)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.4.4)
-    dotenv (2.7.6)
-    dry-configurable (0.13.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.6)
-    dry-core (0.7.1)
-      concurrent-ruby (~> 1.0)
-    faker (2.19.0)
-      i18n (>= 1.6, < 2)
-    faraday (1.8.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      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-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday_middleware (1.1.0)
-      faraday (~> 1.0)
-    hashdiff (1.0.1)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.14.4)
-    multipart-post (2.1.1)
-    parallel (1.21.0)
-    parser (3.0.2.0)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.21.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    webmock (3.14.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  dotenv
-  faker
-  pry
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.7)
-  webmock
-  zoho_sign!
-
-BUNDLED WITH
-   2.2.27