mifiel 1.4.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2ae81be4469bad8b4e6c50570d30d6db02799192d21a3851ab2d188fbc80399
-  data.tar.gz: f22502f1a80a508cb2af45b9e8f2872a151409b891390059642bed642f61ac4c
+  metadata.gz: fba43da41b56717d0f34d2d23441a29685b1014eff732a8c7c3c2a886cbcf81f
+  data.tar.gz: a067295115e5ae373cb996708138bef64ed3f5a5f7406e3027df2f321ff13d3b
 SHA512:
-  metadata.gz: b5eed38acc15d60d738770aace88ec3506ffad3ba8882396ed3bcc643ababb03b61cbcebbaa6a90f89992571adeb22587e1778feb3b439aef1225290b3e6c3a6
-  data.tar.gz: accb7089bb9401eedc4e587d02915b28af583a786df590432ac153ba112a865e3ccbb108925513263f470c4fa1eedc5f245e5e691048cade50b74668a322f0ae
+  metadata.gz: 224c26fd5767508ffaddd0a8f824f6f70129728c7ff1d81834a33117a470d6e697b92d5a8b5f166f4679f57fe8619ef048936c9e45bd3a6717100b23dd427956
+  data.tar.gz: 6babe35d31fcc72e070079b5e718f47e2157254f33a40f01989685bcf2e0d91a4cd73bb2793183f65d090593e6adb852b25ab6d6de2b2056b379d5e8bb08edca

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.3', '3.4', '4.0']
+        gemfile:
+          - gemfiles/rails_7.gemfile
+          - gemfiles/rails_8.gemfile
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    steps:
+      - uses: actions/checkout@v7
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Create tmp dir
+        run: mkdir -p tmp
+      - name: RuboCop
+        run: bundle exec rubocop
+      - name: RSpec
+        run: bundle exec rspec

data/.rubocop.yml

@@ -1,12 +1,14 @@
-require:
+plugins:
   - rubocop-rspec
+  - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
   NewCops: enable
   SuggestExtensions: false
   Exclude:
     - 'gemfiles/**/*'
+    - 'vendor/**/*'
 
 Layout/LineLength:
   Max: 190

data/Appraisals

@@ -1,16 +1,15 @@
 # frozen_string_literal: true
 
-appraise 'rails-5' do
-  gem 'rails', '5'
-  gem 'sinatra'
-end
-
-appraise 'rails-6' do
-  gem 'rails', '6'
-  gem 'sinatra'
+appraise 'rails-7' do
+  gem 'rails', '~> 7.2.0'
+  # ActiveSupport 7.2 still calls JSON.generate(quirks_mode: true), which json 3 dropped.
+  gem 'json', '< 3'
+  gem 'mutex_m'
+  gem 'benchmark'
+  gem 'ostruct'
 end
 
-appraise 'rails-7' do
-  gem 'rails', '7'
-  gem 'sinatra'
+appraise 'rails-8' do
+  # 8.0.x still passes quirks_mode; 8.1 removed it and works with json 3.
+  gem 'rails', '~> 8.1.0'
 end

data/Gemfile

@@ -9,5 +9,13 @@ group :development, :test do
   gem 'coveralls', require: false
   gem 'pry'
   gem 'rubocop'
+  gem 'rubocop-rake'
   gem 'rubocop-rspec'
+
+  gem 'appraisal'
+  gem 'rake'
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'sinatra'
+  gem 'webmock'
 end

data/README.md

@@ -4,8 +4,16 @@
 [![Build Status][travis-image]][travis-url]
 [![Coverage Status][coveralls-image]][coveralls-url]
 
-Ruby SDK for [Mifiel](https://www.mifiel.com) API.
-Please read our [documentation](https://docs.mifiel.com/) for instructions on how to start using the API.
+Ruby SDK for the [Mifiel](https://www.mifiel.com) API.
+
+## Documentation
+
+API reference, guides, and examples:
+
+- English: https://docs.mifiel.com/en/
+- Español: https://docs.mifiel.com/es/
+
+This README covers installation and client setup only.
 
 ## Installation
 
@@ -17,28 +25,35 @@ gem 'mifiel'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install mifiel
+```bash
+gem install mifiel
+```
 
-## Usage
+## Setup
 
-Follow the steps in our [documentation](https://docs.mifiel.com/) to create an account and get your access tokens, then you can configure the gem with:
+1. Create an account (production or [sandbox](https://app-sandbox.mifiel.com)).
+2. Generate an `APP_ID` and `APP_SECRET` in [Access Tokens](https://app-sandbox.mifiel.com/settings/access-tokens).
+3. Configure the gem:
 
 ```ruby
-  Mifiel.config do |config|
-    config.app_id = '<APP_ID>'
-    config.app_secret = '<APP_SECRET>'
-    # remove the next line when you wish to use the prod environment
-    config.base_url = 'https://app-sandbox.mifiel.com/api/v1'
-  end
+Mifiel.config do |config|
+  config.app_id = '<APP_ID>'
+  config.app_secret = '<APP_SECRET>'
+  # Production is the default.
+  # For sandbox:
+  config.base_url = 'https://app-sandbox.mifiel.com/api/v1'
+end
 ```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/mifiel/fork )
+1. Fork it (https://github.com/Mifiel/ruby-api-client/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks'
 
+desc 'start a console with mifiel loaded'
 task :console do
   exec 'pry -r mifiel -I ./lib'
 end

data/gemfiles/rails_7.gemfile

@@ -2,14 +2,24 @@
 
 source "https://rubygems.org"
 
-gem "rails", "7"
-gem "sinatra"
+gem "rails", "~> 7.2.0"
+gem "json", "< 3"
+gem "mutex_m"
+gem "benchmark"
+gem "ostruct"
 
 group :development, :test do
   gem "coveralls", require: false
   gem "pry"
   gem "rubocop"
+  gem "rubocop-rake"
   gem "rubocop-rspec"
+  gem "appraisal"
+  gem "rake"
+  gem "rspec"
+  gem "simplecov"
+  gem "sinatra"
+  gem "webmock"
 end
 
 gemspec path: "../"

data/gemfiles/{rails_5.gemfile → rails_8.gemfile}

@@ -2,14 +2,20 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5"
-gem "sinatra"
+gem "rails", "~> 8.1.0"
 
 group :development, :test do
   gem "coveralls", require: false
   gem "pry"
   gem "rubocop"
+  gem "rubocop-rake"
   gem "rubocop-rspec"
+  gem "appraisal"
+  gem "rake"
+  gem "rspec"
+  gem "simplecov"
+  gem "sinatra"
+  gem "webmock"
 end
 
 gemspec path: "../"

data/lib/mifiel/config.rb

@@ -28,16 +28,18 @@ module Mifiel
 
       private
 
-      def set_api_auth_credentials
+      def set_api_auth_credentials # rubocop:disable Metrics/MethodLength
         Flexirest::Base.base_url = base_url
         Flexirest::Base.api_auth_credentials(
           app_id,
           app_secret,
           with_http_method: true,
+          digest: 'sha1',
         )
         Flexirest::Base.request_body_type = :json
         Flexirest::Base.faraday_config do |faraday|
           faraday.headers['User-Agent'] = user_agent
+          faraday.headers['X-ORIGINAL-URI'] = faraday.path_prefix
         end
       end
 

data/lib/mifiel/document.rb

@@ -23,7 +23,7 @@ module Mifiel
     post :create_from_template, '/templates/:template_id/generate_document', timeout: 60
     post :create_many_from_template, '/templates/:template_id/generate_documents', timeout: 60
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable-next Metrics/MethodLength
     def self.create(args)
       signatories = args[:signatories]
       file = args[:file]
@@ -43,7 +43,6 @@ module Mifiel
       payload = args.merge(payload).compact
       process_request('/documents', :post, payload: payload, type: :form_multipart)
     end
-    # rubocop:enable Metrics/MethodLength
 
     # @deprecated
     def request_signature(email, cc: nil)

data/lib/mifiel/errors.rb

@@ -1,10 +1,21 @@
 # frozen_string_literal: true
 
 module Mifiel
-  MifielError = Class.new StandardError
-  BadRequestError = Class.new StandardError
-  ServerError = Class.new StandardError
-  PrivateKeyError = Class.new StandardError
-  NotPrivateKeyError = Class.new ArgumentError
-  NoSignatureError = Class.new StandardError
+  class MifielError < StandardError
+  end
+
+  class BadRequestError < StandardError
+  end
+
+  class ServerError < StandardError
+  end
+
+  class PrivateKeyError < StandardError
+  end
+
+  class NotPrivateKeyError < ArgumentError
+  end
+
+  class NoSignatureError < StandardError
+  end
 end

data/lib/mifiel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mifiel
-  VERSION = '1.4.1'
+  VERSION = '2.1.0'
 end

data/lib/mifiel/webhook.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mifiel
+  # Account-level webhook subscriptions.
+  # @see https://docs.mifiel.com/en/#tag/Webhooks
+  class Webhook < Mifiel::Base
+    get :all, '/webhooks'
+    get :find, '/webhooks/:id'
+    post :create, '/webhooks'
+    delete :delete, '/webhooks/:id'
+
+    # Trigger delivery for this webhook.
+    #
+    # @param resource [String] UUID of the related resource included in the callback payload
+    # @param instant [Boolean] when true, deliver immediately once instead of enqueueing retries
+    def trigger(resource:, instant: false)
+      self.class.process_request(
+        "/webhooks/#{id}/trigger",
+        :post,
+        payload: { resource: resource, instant: instant },
+      )
+    end
+  end
+end

data/lib/mifiel.rb

@@ -9,6 +9,7 @@ module Mifiel
   autoload :Document, 'mifiel/document'
   autoload :Certificate, 'mifiel/certificate'
   autoload :Template, 'mifiel/template'
+  autoload :Webhook, 'mifiel/webhook'
   autoload :Config, 'mifiel/config'
   autoload :User, 'mifiel/user'
 

data/mifiel.gemspec

@@ -17,19 +17,12 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 3.2'
 
   # 1.4 fixes a security MITM issue
   # 2.5 is actually a breaking change: it changes the MD5 header
-  spec.add_runtime_dependency 'api-auth', '>= 1.4', '< 2.5'
-  spec.add_runtime_dependency 'flexirest', '~> 1.6'
+  spec.add_dependency 'api-auth', '~> 2.0'
+  spec.add_dependency 'flexirest', '~> 1.6'
 
-  spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'sinatra'
-  spec.add_development_dependency 'webmock'
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "4"

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'pry'
 require 'mifiel'
 require 'webmock/rspec'
@@ -10,16 +11,14 @@ SimpleCov.start do
   add_filter '/spec/'
 end
 
-Coveralls.wear!
-
-Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+Dir['./spec/support/**/*.rb'].each { |f| require f }
 
 RSpec.configure do |config|
   config.before(:suite) do
     Mifiel.config do |conf|
       conf.app_id = 'APP_ID'
       conf.app_secret = 'APP_SECRET'
-      conf.base_url = 'http://www.mifiel.com/api/v1'
+      conf.base_url = 'https://app.mifiel.com/api/v1'
     end
 
     # Creates ruby-api-client/tmp folder so signed files can be saved correctly

metadata

@@ -1,35 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: mifiel
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Genaro Madrid
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api-auth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: flexirest
   requirement: !ruby/object:Gem::Requirement
@@ -44,105 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description:
 email:
 - genmadrid@gmail.com
 executables: []
@@ -150,18 +44,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/rails_5.gemfile
-- gemfiles/rails_6.gemfile
 - gemfiles/rails_7.gemfile
+- gemfiles/rails_8.gemfile
 - lib/mifiel.rb
 - lib/mifiel/base.rb
 - lib/mifiel/certificate.rb
@@ -171,8 +64,10 @@ files:
 - lib/mifiel/template.rb
 - lib/mifiel/user.rb
 - lib/mifiel/version.rb
+- lib/mifiel/webhook.rb
 - mifiel-ruby-api-client.sublime-project
 - mifiel.gemspec
+- mise.toml
 - spec/fixtures/FIEL_AAA010101AAA.cer
 - spec/fixtures/FIEL_AAA010101AAA.key
 - spec/fixtures/example.pdf
@@ -188,7 +83,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,15 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ruby SDK for mifiel.com.
 test_files: []

data/.travis.yml

@@ -1,38 +0,0 @@
-language: ruby
-cache: bundler
-sudo: false
-
-gemfile:
-  - gemfiles/rails_5.gemfile
-  - gemfiles/rails_6.gemfile
-  - gemfiles/rails_7.gemfile
-
-rvm:
-  - 2.6
-  - 2.7
-  - 3.0
-  - 3.1
-
-notifications:
-  email:
-    on_success: change
-    on_failure: always
-
-script:
-  - mkdir ./tmp/
-  - bundle exec rubocop
-  - bundle exec rspec
-
-matrix:
-  exclude:
-    # rails 7 requires ruby > 2.7
-    - rvm: 2.6
-      gemfile: gemfiles/rails_7.gemfile
-    # rails 5 is too old for these ruby versions
-    - rvm: 2.7
-      gemfile: gemfiles/rails_5.gemfile
-    - rvm: 3.0
-      gemfile: gemfiles/rails_5.gemfile
-    - rvm: 3.1
-      gemfile: gemfiles/rails_5.gemfile
-  fast_finish: true

data/gemfiles/rails_6.gemfile

@@ -1,15 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "6"
-gem "sinatra"
-
-group :development, :test do
-  gem "coveralls", require: false
-  gem "pry"
-  gem "rubocop"
-  gem "rubocop-rspec"
-end
-
-gemspec path: "../"