mifiel 1.3.1 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1569646681fcf22ebc9758654ea1cd69335c0de8fea3be1d91a2141c0c06f83d
-  data.tar.gz: fab079bd4ba6f4edb93a458c934b8e2f783b90296c00bc4e0d0ae0b9d8992d3b
+  metadata.gz: b2ae81be4469bad8b4e6c50570d30d6db02799192d21a3851ab2d188fbc80399
+  data.tar.gz: f22502f1a80a508cb2af45b9e8f2872a151409b891390059642bed642f61ac4c
 SHA512:
-  metadata.gz: 34ea17ff1b1e888dec3ee6f9f5c2b3460bfa29dfc3629330880d0dfe831760e60e3271c2f80511d8edf2b9e0de3f5708944f221581cbf424b9ac13f7c3be303f
-  data.tar.gz: 6f04cbd056834f0709067c43223c2f695c63e9ea9d2d51a2d6419cef800047065be3d46fe739406c9ed9d260cb7c01a6a123b89ae7e21bb6800b6f57726248ac
+  metadata.gz: b5eed38acc15d60d738770aace88ec3506ffad3ba8882396ed3bcc643ababb03b61cbcebbaa6a90f89992571adeb22587e1778feb3b439aef1225290b3e6c3a6
+  data.tar.gz: accb7089bb9401eedc4e587d02915b28af583a786df590432ac153ba112a865e3ccbb108925513263f470c4fa1eedc5f245e5e691048cade50b74668a322f0ae

data/.rubocop.yml

@@ -1,5 +1,10 @@
+require:
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
   Exclude:
     - 'gemfiles/**/*'
 
@@ -16,3 +21,15 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - '*.gemspec'
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+RSpec/NestedGroups:
+  Enabled: false

data/.travis.yml

@@ -5,11 +5,9 @@ sudo: false
 gemfile:
   - gemfiles/rails_5.gemfile
   - gemfiles/rails_6.gemfile
+  - gemfiles/rails_7.gemfile
 
 rvm:
-  - 2.3
-  - 2.4
-  - 2.5
   - 2.6
   - 2.7
   - 3.0
@@ -27,8 +25,14 @@ script:
 
 matrix:
   exclude:
-    - rvm: 2.3
-      gemfile: gemfiles/rails_6.gemfile
-    - rvm: 2.4
-      gemfile: gemfiles/rails_6.gemfile
+    # 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/Appraisals

@@ -9,3 +9,8 @@ appraise 'rails-6' do
   gem 'rails', '6'
   gem 'sinatra'
 end
+
+appraise 'rails-7' do
+  gem 'rails', '7'
+  gem 'sinatra'
+end

data/Gemfile

@@ -7,4 +7,7 @@ gemspec
 
 group :development, :test do
   gem 'coveralls', require: false
+  gem 'pry'
+  gem 'rubocop'
+  gem 'rubocop-rspec'
 end

data/README.md

@@ -3,10 +3,9 @@
 [![Gem Version][gem-version-image]][gem-version-url]
 [![Build Status][travis-image]][travis-url]
 [![Coverage Status][coveralls-image]][coveralls-url]
-[![security][security-image]][security-url]
 
 Ruby SDK for [Mifiel](https://www.mifiel.com) API.
-Please read our [documentation](http://docs.mifiel.com/) for instructions on how to start using the API.
+Please read our [documentation](https://docs.mifiel.com/) for instructions on how to start using the API.
 
 ## Installation
 
@@ -26,154 +25,17 @@ Or install it yourself as:
 
 ## Usage
 
-For your convenience Mifiel offers a Sandbox environment where you can confidently test your code.
-
-To start using the API in the Sandbox environment you need to first create an account at [sandbox.mifiel.com](https://sandbox.mifiel.com).
-
-Once you have an account you will need an APP_ID and an APP_SECRET which you can generate in [sandbox.mifiel.com/access_tokens](https://sandbox.mifiel.com/access_tokens).
-
-Then you can configure the gem with:
+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:
 
 ```ruby
   Mifiel.config do |config|
     config.app_id = '<APP_ID>'
     config.app_secret = '<APP_SECRET>'
-    config.base_url = 'https://app-sandbox.mifiel.com/api/v1' #remove this line when you wish to use the prod environment
+    # remove the next line when you wish to use the prod environment
+    config.base_url = 'https://app-sandbox.mifiel.com/api/v1'
   end
 ```
 
-Document methods:
-
-- Find:
-
-```ruby
-  document = Mifiel::Document.find('id')
-  document.original_hash
-  document.file
-  document.file_signed
-  # ...
-```
-
-- Find all:
-
-```ruby
-  documents = Mifiel::Document.all
-```
-
-- Create:
-
-> Use only **hash** if you dont want us to have the file.<br>
-> Either **file** or **hash** must be provided.
-
-```ruby
-  document = Mifiel::Document.create(
-    file: 'path/to/my-file.pdf',
-    signatories: [
-      { name: 'Signer 1', email: 'signer1@email.com', tax_id: 'AAA010101AAA' },
-      { name: 'Signer 2', email: 'signer2@email.com', tax_id: 'AAA010102AAA' }
-    ]
-  )
-  # if you dont want us to have the PDF, you can just send us 
-  # the original_hash and the name of the document. Both are required
-  document = Mifiel::Document.create(
-    hash: Digest::SHA256.hexdigest(File.read('path/to/my-file.pdf')), 
-    name: 'my-file.pdf',
-    signatories: [...]
-  )
-```
-
-- Save Document related files
-
-```ruby
-  # save the original file
-  document.save_file('path/to/save/file.pdf')
-  # save the signed file (original file + signatures page)
-  document.save_file_signed('path/to/save/file-signed.pdf')
-  # save the signed xml file
-  document.save_xml('path/to/save/xml.xml')
-```
-
-- Sign:
-  + With a pre-created Certificate
-
-    ```ruby
-      certificate = Mifiel::Certificate.find('cert-id')
-      document.sign(certificate_id: certificate.id)
-    ```
-
-  + With a new one
-
-    ```ruby
-      document.sign(certificate: File.read('FIEL_AAA010101AAA.cer'))
-    ```
-
-- Delete
-
-  ```ruby
-    document.delete
-  ```
-
-Certificate methods:
-
-- Sat Certificates
-
-  ```ruby
-    sat_certificates = Mifiel::Certificate.sat
-  ```
-
-- Find:
-
-```ruby
-  certificate = Mifiel::Certificate.find('id')
-  certificate.cer_hex
-  certificate.type_of
-  # ...
-```
-
-- Find all:
-
-```ruby
-  certificates = Mifiel::Certificate.all
-```
-
-- Create
-  
-  ```ruby
-  certificate = Mifiel::Certificate.create(
-    file: 'path/to/my-certificate.cer'
-  )
-  ```
-
-- Delete
-
-  ```ruby
-    certificate.delete
-  ```
-
-User methods
-
-- Setup Widget
-
-  ```ruby
-    args = {
-      email: 'some@email.com',
-      tax_id: 'AAA010101AAA',
-      callback_url: 'http://some-callback.url'
-    }
-
-    user = Mifiel::User.setup_widget(args)
-    user.widget_id
-  ```
-
-Filtering Results
-
-Our API returns a JSON list of items, this result can be filtered using a `where` method matching a specified criteria (or matching using regular expressions):
-
-```ruby
-  document = Mifiel::Document.find('id')
-  document.signers.where(field: /receiver|issuer/, email: 'some@email.com')
-```
-
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/mifiel/fork )
@@ -182,15 +44,9 @@ Our API returns a JSON list of items, this result can be filtered using a `where
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-
 [gem-version-image]: https://badge.fury.io/rb/mifiel.svg
 [gem-version-url]: https://badge.fury.io/rb/mifiel
-
-[security-url]: https://hakiri.io/github/Mifiel/ruby-api-client/master
-[security-image]: https://hakiri.io/github/Mifiel/ruby-api-client/master.svg
-
 [travis-image]: https://travis-ci.org/Mifiel/ruby-api-client.svg?branch=master
 [travis-url]: https://travis-ci.org/Mifiel/ruby-api-client
-
 [coveralls-image]: https://coveralls.io/repos/github/Mifiel/ruby-api-client/badge.svg?branch=master
 [coveralls-url]: https://coveralls.io/github/Mifiel/ruby-api-client?branch=master

data/gemfiles/rails_5.gemfile

@@ -7,6 +7,9 @@ gem "sinatra"
 
 group :development, :test do
   gem "coveralls", require: false
+  gem "pry"
+  gem "rubocop"
+  gem "rubocop-rspec"
 end
 
 gemspec path: "../"

data/gemfiles/rails_6.gemfile

@@ -7,6 +7,9 @@ gem "sinatra"
 
 group :development, :test do
   gem "coveralls", require: false
+  gem "pry"
+  gem "rubocop"
+  gem "rubocop-rspec"
 end
 
 gemspec path: "../"

data/gemfiles/rails_7.gemfile

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

data/lib/mifiel/base.rb

@@ -1,19 +1,30 @@
 # frozen_string_literal: true
 
-require 'rest-client'
-
 module Mifiel
   class Base < Flexirest::Base
     after_request :rescue_errors
 
     def rescue_errors(_name, response)
-      if (400..499).cover?(response.status)
+      case response.status
+      when (400..499)
         result = JSON.parse(response.body)
         message = result['errors'] || [result['error']]
         raise BadRequestError, message.to_a.join(', ')
-      elsif (500..599).cover?(response.status)
+      when (500..599)
         raise ServerError, "Could not process your request: status #{response.status}"
       end
     end
+
+    def self.process_request(path, mthd, payload: nil, type: false)
+      url = "#{Mifiel.config.base_url}/#{path.gsub(%r{^/}, '')}"
+      options = { request_body_type: type }
+      options[:plain] = true if type == :plain
+      _request(
+        url,
+        mthd,
+        payload,
+        options,
+      )
+    end
   end
 end

data/lib/mifiel/certificate.rb

@@ -8,16 +8,8 @@ module Mifiel
     get :sat, '/keys/sat'
 
     def self.create(cer_file)
-      rest_request = RestClient::Request.new(
-        url: "#{Mifiel.config.base_url}/keys",
-        method: :post,
-        payload: {
-          cer_file: File.new(cer_file)
-        },
-        ssl_version: 'SSLv23'
-      )
-      req = ApiAuth.sign!(rest_request, Mifiel.config.app_id, Mifiel.config.app_secret)
-      Mifiel::Certificate.new(JSON.parse(req.execute))
+      payload = { cer_file: File.new(cer_file) }
+      process_request('/keys', :post, payload: payload, type: :form_multipart)
     end
   end
 end

data/lib/mifiel/config.rb

@@ -30,8 +30,25 @@ module Mifiel
 
       def set_api_auth_credentials
         Flexirest::Base.base_url = base_url
-        Flexirest::Base.api_auth_credentials(app_id, app_secret)
+        Flexirest::Base.api_auth_credentials(
+          app_id,
+          app_secret,
+          with_http_method: true,
+        )
         Flexirest::Base.request_body_type = :json
+        Flexirest::Base.faraday_config do |faraday|
+          faraday.headers['User-Agent'] = user_agent
+        end
+      end
+
+      def user_agent
+        [
+          "#{Gem::Platform::RUBY.upcase}/#{RUBY_VERSION}",
+          "mifiel/#{Mifiel::VERSION}",
+          "faraday/#{Faraday::VERSION}",
+          # there is no easy way to get OS version in ruby
+          "(#{RUBY_PLATFORM}/-)",
+        ].join(' ')
       end
     end
 

data/lib/mifiel/document.rb

@@ -7,12 +7,23 @@ module Mifiel
   class Document < Mifiel::Base
     get :all, '/documents'
     get :find, '/documents/:id'
+
+    get :raw_file, '/documents/:id/file', plain: true
+    # @deprecated in favor of raw_file
+    get :raw_data, '/documents/:id/file', plain: true
+
+    get :raw_file_signed, '/documents/:id/file_signed', plain: true
+    # @deprecated in favor of raw_file_signed
+    get :raw_signed_data, '/documents/:id/file_signed', plain: true
+
+    get :raw_xml, '/documents/:id/xml', plain: true
+
     put :save, '/documents/:id'
     delete :delete, '/documents/:id'
     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, Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def self.create(args)
       signatories = args[:signatories]
       file = args[:file]
@@ -27,55 +38,30 @@ module Mifiel
         callback_url: callback_url,
         file: (File.new(file) if file),
         original_hash: hash,
-        name: name
+        name: name,
       }
-      payload = args.merge(payload)
-      payload.reject! { |_k, v| v.nil? }
-      response = process_request('/documents', :post, payload)
-      Mifiel::Document.new(JSON.parse(response))
+      payload = args.merge(payload).compact
+      process_request('/documents', :post, payload: payload, type: :form_multipart)
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
-    def request_signature(email, cc: nil) # rubocop:disable Naming/MethodParameterName
+    # @deprecated
+    def request_signature(email, cc: nil)
       params = { email: email }
       params[:cc] = cc if cc.is_a?(Array)
-      Mifiel::Document._request("#{Mifiel.config.base_url}/documents/#{id}/request_signature", :post, params)
-    end
-
-    def raw_data
-      response = Mifiel::Document.process_request("/documents/#{id}/file", :get)
-
-      response.body
+      Mifiel::Base.process_request("/documents/#{id}/request_signature", :post, payload: params)
     end
 
     def save_file(path)
-      File.open(path, 'wb') { |file| file.write(raw_data) }
-    end
-
-    def raw_signed_data
-      response = Mifiel::Document.process_request("/documents/#{id}/file_signed", :get)
-
-      response.body
+      File.binwrite(path, raw_file)
     end
 
     def save_file_signed(path)
-      File.open(path, 'wb') { |file| file.write(raw_signed_data) }
+      File.binwrite(path, raw_file_signed)
     end
 
     def save_xml(path)
-      response = Mifiel::Document.process_request("/documents/#{id}/xml", :get)
-      File.open(path, 'w') { |file| file.write(response) }
-    end
-
-    def self.process_request(path, method, payload = nil)
-      rest_request = RestClient::Request.new(
-        url: "#{Mifiel.config.base_url}/#{path.gsub(%r{^\/}, '')}",
-        method: method,
-        payload: payload,
-        ssl_version: 'SSLv23'
-      )
-      req = ApiAuth.sign!(rest_request, Mifiel.config.app_id, Mifiel.config.app_secret)
-      req.execute
+      File.write(path, raw_xml)
     end
 
     def self.build_signatories(signatories)

data/lib/mifiel/template.rb

@@ -18,7 +18,7 @@ module Mifiel
         template_id: id,
         identifier: identifier,
         documents: documents,
-        callback_url: callback_url
+        callback_url: callback_url,
       )
     end
   end

data/lib/mifiel/user.rb

@@ -3,27 +3,5 @@
 module Mifiel
   class User < Mifiel::Base
     post :setup_widget, '/users/setup-widget'
-
-    def self.setup_widget(args) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      email = args[:email]
-      tax_id = args[:tax_id]
-      callback_url = args[:callback_url]
-
-      raise ArgumentError, 'Email must be provided' unless email
-      raise ArgumentError, 'Tax id must be provided' unless tax_id
-
-      rest_request = RestClient::Request.new(
-        url: "#{Mifiel.config.base_url}/users/setup-widget",
-        method: :post,
-        payload: {
-          email: email,
-          tax_id: tax_id,
-          callback_url: callback_url
-        },
-        ssl_version: 'SSLv23'
-      )
-      req = ApiAuth.sign!(rest_request, Mifiel.config.app_id, Mifiel.config.app_secret)
-      Mifiel::User.new(JSON.parse(req.execute))
-    end
   end
 end

data/lib/mifiel/version.rb

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

data/lib/mifiel.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'flexirest'
+require 'mifiel/version'
 
 module Mifiel
   require 'mifiel/errors'
@@ -11,7 +12,7 @@ module Mifiel
   autoload :Config, 'mifiel/config'
   autoload :User, 'mifiel/user'
 
-  BASE_URL = 'https://www.mifiel.com/api/v1'
+  BASE_URL = 'https://app.mifiel.com/api/v1'
 
   def self.config
     if block_given?

data/mifiel.gemspec

@@ -16,23 +16,20 @@ 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.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.add_runtime_dependency 'activesupport'
-  spec.add_runtime_dependency 'api-auth', '~> 1.4'
+  # 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_runtime_dependency 'json', '>= 1.8'
-  spec.add_runtime_dependency 'rest-client', '>= 1.8'
 
   spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'bump', '~> 0.5', '>= 0.5.3'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake',       '~> 13.0'
-  spec.add_development_dependency 'rspec',      '~> 3.10'
-  spec.add_development_dependency 'rubocop',    '~> 1.24'
-  spec.add_development_dependency 'simplecov',  '~> 0.21'
+  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/spec/mifiel/base_spec.rb

@@ -3,8 +3,8 @@
 describe Mifiel::Base do
   describe 'rescue_errors' do
     describe 'when bad request' do
-      it 'should raise error' do
-        base = Mifiel::Base.new
+      it 'raises error' do
+        base = described_class.new
         expect do
           base.rescue_errors('blah', FakeResponse.new(400))
         end.to raise_error(Mifiel::BadRequestError)
@@ -12,8 +12,8 @@ describe Mifiel::Base do
     end
 
     describe 'when server error' do
-      it 'should raise error' do
-        base = Mifiel::Base.new
+      it 'raises error' do
+        base = described_class.new
         expect do
           base.rescue_errors('blah', FakeResponse.new(500))
         end.to raise_error(Mifiel::ServerError)

data/spec/mifiel/certificate_spec.rb

@@ -3,11 +3,11 @@
 describe Mifiel::Certificate do
   describe '#create' do
     let(:certificate) do
-      Mifiel::Certificate.create(
-        'spec/fixtures/FIEL_AAA010101AAA.cer'
+      described_class.create(
+        'spec/fixtures/FIEL_AAA010101AAA.cer',
       )
     end
 
-    it { expect(certificate).to be_a(Mifiel::Certificate) }
+    it { expect(certificate).to be_a(described_class) }
   end
 end

data/spec/mifiel/document_spec.rb

@@ -1,65 +1,65 @@
 # frozen_string_literal: true
 
 describe Mifiel::Document do
-  let!(:certificate) { File.read('spec/fixtures/FIEL_AAA010101AAA.cer') }
-  let!(:private_key) { File.read('spec/fixtures/FIEL_AAA010101AAA.key') }
-  let!(:private_key_pass) { '12345678a' }
+  let(:certificate) { File.read('spec/fixtures/FIEL_AAA010101AAA.cer') }
+  let(:private_key) { File.read('spec/fixtures/FIEL_AAA010101AAA.key') }
+  let(:private_key_pass) { '12345678a' }
 
   describe '#create' do
     context 'with a document' do
       let(:document) do
-        Mifiel::Document.create(
+        described_class.create(
           file: 'spec/fixtures/example.pdf',
           signatories: [
             { name: 'Signer 1', email: 'signer1@email.com', tax_id: 'AAA010101AAA' },
-            { name: 'Signer 2', email: 'signer2@email.com', tax_id: 'AAA010102AAA' }
-          ]
+            { name: 'Signer 2', email: 'signer2@email.com', tax_id: 'AAA010102AAA' },
+          ],
         )
       end
 
-      it { expect(document).to be_a(Mifiel::Document) }
+      it { expect(document).to be_a(described_class) }
     end
 
-    context 'from template' do
+    describe 'from template' do
       let!(:template_id) { 'c6c29866-7fd6-4f77-9ecd-eae8bc3a772a' }
       let!(:document) do
-        Mifiel::Document.create_from_template(
+        described_class.create_from_template(
           template_id: template_id,
           fields: {
-            name: 'some'
+            name: 'some',
           },
           signatories: [{
             name: 'Signer',
-            email: 'signer@email.com'
+            email: 'signer@email.com',
           }, {
             name: 'Signer',
-            email: 'signer@email.com'
-          }]
+            email: 'signer@email.com',
+          },],
         )
       end
 
-      it { expect(document).to be_a Mifiel::Document }
+      it { expect(document).to be_a described_class }
     end
 
-    context 'many from template' do
+    describe 'many from template' do
       let!(:template_id) { 'c6c29866-7fd6-4f77-9ecd-eae8bc3a772a' }
       let!(:documents) do
-        Mifiel::Document.create_many_from_template(
+        described_class.create_many_from_template(
           template_id: template_id,
           callback_url: 'http://some-callback.url/mifiel',
           identifier: 'name',
           documents: [{
             fields: {
-              name: 'Some Name'
+              name: 'Some Name',
             },
             signatories: [{
               name: 'Signer',
-              email: 'signer@email.com'
+              email: 'signer@email.com',
             }, {
               name: 'Signer',
-              email: 'signer@email.com'
-            }]
-          }]
+              email: 'signer@email.com',
+            },],
+          }],
         )
       end
 
@@ -68,29 +68,30 @@ describe Mifiel::Document do
   end
 
   describe 'working with a document' do
-    let!(:document) { Mifiel::Document.all.first }
+    let!(:document) { described_class.all.first }
 
-    describe '#raw_data' do
+    describe '#raw_file' do
       let(:document_content) { 'some-pdf-formatted-string' }
 
-      it 'should get the file raw data' do
-        expect(document.raw_data).to eq document_content
+      it 'gets the file raw data' do
+        expect(document.raw_file).to eq document_content
       end
     end
 
-    describe '#raw_signed_data' do
+    describe '#raw_file_signed' do
       let(:document_content) { 'some-pdf-formatted-string' }
 
-      it 'should get the file raw signed data' do
-        expect(document.raw_signed_data).to eq document_content
+      it 'gets the file raw signed data' do
+        expect(document.raw_file_signed).to eq document_content
       end
     end
 
     describe '#save_file' do
       let!(:path) { 'tmp/the-file.pdf' }
-      before { File.unlink(path) if File.exist?(path) }
 
-      it 'should get the file' do
+      before { FileUtils.rm_f(path) }
+
+      it 'gets the file' do
         document.save_file(path)
         expect(File.exist?(path)).to be true
       end
@@ -98,9 +99,10 @@ describe Mifiel::Document do
 
     describe '#save_file_signed' do
       let!(:path) { 'tmp/the-file-signed.pdf' }
-      before { File.unlink(path) if File.exist?(path) }
 
-      it 'should get the file' do
+      before { FileUtils.rm_f(path) }
+
+      it 'gets the file' do
         document.save_file_signed(path)
         expect(File.exist?(path)).to be true
       end
@@ -108,9 +110,10 @@ describe Mifiel::Document do
 
     describe '#save_xml' do
       let!(:path) { 'tmp/the-xml.xml' }
-      before { File.unlink(path) if File.exist?(path) }
 
-      it 'should get the file' do
+      before { FileUtils.rm_f(path) }
+
+      it 'gets the file' do
         document.save_xml(path)
         expect(File.exist?(path)).to be true
       end
@@ -119,7 +122,7 @@ describe Mifiel::Document do
     describe '#request_signature' do
       let!(:error_body) { { errors: ['some error'] }.to_json }
 
-      it '' do
+      it do
         expect do
           document.request_signature('some@email.com')
         end.not_to raise_error
@@ -127,11 +130,11 @@ describe Mifiel::Document do
 
       context 'when bad request' do
         before do
-          url = %r{mifiel.com\/api\/v1\/documents\/#{document.id}\/request_signature}
+          url = %r{mifiel.com/api/v1/documents/#{document.id}/request_signature}
           stub_request(:post, url).to_return(body: error_body, status: 404)
         end
 
-        it '' do
+        it do
           expect do
             document.request_signature('some@email.com')
           end.to raise_error(Mifiel::BadRequestError)
@@ -140,11 +143,11 @@ describe Mifiel::Document do
 
       context 'when server error' do
         before do
-          url = %r{mifiel.com\/api\/v1\/documents\/#{document.id}\/request_signature}
+          url = %r{mifiel.com/api/v1/documents/#{document.id}/request_signature}
           stub_request(:post, url).to_return(body: error_body, status: 500)
         end
 
-        it '' do
+        it do
           expect do
             document.request_signature('some@email.com')
           end.to raise_error(Mifiel::ServerError)

data/spec/mifiel/template_spec.rb

@@ -4,35 +4,40 @@ describe Mifiel::Template do
   let!(:template_id) { 'bb7d65b4-47f1-470e-85e4-22ddae86f9ea' }
 
   shared_examples 'a valid template' do
-    it { expect(template).to be_a(Mifiel::Template) }
+    it { expect(template).to be_a(described_class) }
     it { expect(template).to respond_to(:id) }
     it { expect(template).to respond_to(:name) }
   end
 
   describe '#create' do
-    let!(:template) do
-      Mifiel::Template.create(
+    let(:template) do
+      described_class.create(
         name: 'Some Template',
         content: '<div>Some <field name="name" type="string">NAME</field></div>',
         header: 'Genaros Header',
-        footer: 'Genaros Footer'
+        footer: 'Genaros Footer',
       )
     end
+
     it_behaves_like 'a valid template'
   end
 
   describe '#find' do
-    let!(:template) { Mifiel::Template.find(template_id) }
+    let!(:template) { described_class.find(template_id) }
 
     it_behaves_like 'a valid template'
     it { expect(template.id).to eq(template_id) }
   end
 
   describe '#all' do
-    it 'should respond with many templates' do
-      templates = Mifiel::Template.all
+    let(:templates) { described_class.all }
+
+    it 'responds with many templates' do
       expect(templates.count).to be > 0
-      expect(templates.first).to be_a(Mifiel::Template)
+    end
+
+    it 'responds with a Template' do
+      expect(templates.first).to be_a(described_class)
     end
   end
 end

data/spec/mifiel/user_spec.rb

@@ -3,14 +3,14 @@
 describe Mifiel::User do
   describe '#setup_widget' do
     let(:user) do
-      Mifiel::User.setup_widget(
+      described_class.setup_widget(
         email: 'user@email.com',
         tax_id: 'AAA010101AAA',
-        callback_url: 'http://some-callback.url/mifiel'
+        callback_url: 'http://some-callback.url/mifiel',
       )
     end
 
     it { expect(user.success).to be_truthy }
-    it { expect(user.widget_id).to_not be_nil }
+    it { expect(user.widget_id).not_to be_nil }
   end
 end

data/spec/spec_helper.rb

@@ -26,7 +26,7 @@ RSpec.configure do |config|
     Dir.mkdir 'tmp' unless File.directory? 'tmp'
   end
 
-  config.before(:each) do
+  config.before do
     stub_request(:any, /mifiel.com/).to_rack(FakeMifiel)
   end
 end

data/spec/support/fake_mifiel.rb

@@ -8,7 +8,7 @@ class FakeMifiel < Sinatra::Base # rubocop:disable Metrics/ClassLength
     status 200
     [
       key,
-      key
+      key,
     ].to_json
   end
 
@@ -17,7 +17,7 @@ class FakeMifiel < Sinatra::Base # rubocop:disable Metrics/ClassLength
     status 200
     [
       template,
-      template
+      template,
     ].to_json
   end
 
@@ -56,7 +56,7 @@ class FakeMifiel < Sinatra::Base # rubocop:disable Metrics/ClassLength
     status 200
     [
       document,
-      document
+      document,
     ].to_json
   end
 
@@ -68,7 +68,7 @@ class FakeMifiel < Sinatra::Base # rubocop:disable Metrics/ClassLength
       original_hash: Digest::SHA256.hexdigest(params[:file][:tempfile].read),
       file_file_name: params[:file][:filename],
       signed: false,
-      signed_at: nil
+      signed_at: nil,
     ).to_json
   end
 
@@ -76,7 +76,7 @@ class FakeMifiel < Sinatra::Base # rubocop:disable Metrics/ClassLength
     content_type :json
     status 200
     document(
-      id: params[:id]
+      id: params[:id],
     ).to_json
   end
 
@@ -113,7 +113,7 @@ class FakeMifiel < Sinatra::Base # rubocop:disable Metrics/ClassLength
     {
       id: args[:id] || SecureRandom.uuid,
       name: 'some-template',
-      content: '<div><field name="name">NAME</field></div>'
+      content: '<div><field name="name">NAME</field></div>',
     }
   end
 
@@ -126,7 +126,7 @@ class FakeMifiel < Sinatra::Base # rubocop:disable Metrics/ClassLength
       owner: 'JORGE MORALES MENDEZ',
       tax_id: 'MOMJ811012643',
       expires_at: '2017-04-28T19:43:23.000Z',
-      expired: false
+      expired: false,
     }
   end
 
@@ -142,7 +142,7 @@ class FakeMifiel < Sinatra::Base # rubocop:disable Metrics/ClassLength
       status: [1, 'Firmado'],
       owner: {
         email: 'signer1@email.com',
-        name: 'Jorge Morales'
+        name: 'Jorge Morales',
       },
       file: "/api/v1/documents/#{id}/file",
       file_download: "/api/v1/documents/#{id}/file?download=true",
@@ -158,9 +158,9 @@ class FakeMifiel < Sinatra::Base # rubocop:disable Metrics/ClassLength
         signature: '77cd5156779c..4e276ef1056c1de11b7f70bed28',
         user: {
           email: 'signer1@email.com',
-          name: 'Jorge Morales'
-        }
-      }]
+          name: 'Jorge Morales',
+        },
+      }],
     }
   end
 end

metadata

@@ -1,43 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: mifiel
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.1
 platform: ruby
 authors:
 - Genaro Madrid
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: api-auth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: api-auth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: flexirest
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -94,26 +58,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -132,58 +76,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -229,9 +159,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bump
 - gemfiles/rails_5.gemfile
 - gemfiles/rails_6.gemfile
+- gemfiles/rails_7.gemfile
 - lib/mifiel.rb
 - lib/mifiel/base.rb
 - lib/mifiel/certificate.rb
@@ -256,7 +186,8 @@ files:
 homepage: https://www.mifiel.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -265,7 +196,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -276,14 +207,4 @@ rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby SDK for mifiel.com.
-test_files:
-- spec/fixtures/FIEL_AAA010101AAA.cer
-- spec/fixtures/FIEL_AAA010101AAA.key
-- spec/fixtures/example.pdf
-- spec/mifiel/base_spec.rb
-- spec/mifiel/certificate_spec.rb
-- spec/mifiel/document_spec.rb
-- spec/mifiel/template_spec.rb
-- spec/mifiel/user_spec.rb
-- spec/spec_helper.rb
-- spec/support/fake_mifiel.rb
+test_files: []

data/bump

@@ -1,70 +0,0 @@
-#!/usr/bin/env python
-import re, glob, sys, os
-
-__USAGE__ = \
-"""BUMP is a semantic versioning bump script which accepts the following
-mutually exclusive arguments:
-   -m - a "major" version bump equal to +1.0.0
-   -n - a "minor" version bump equal to +0.1.0
-   -p - a "patch" version bump equal to +0.0.1
-   -h - a "hot fix" version bump equal to +0.0.1
-
-   All of these options allow for the -r flag, which indicates that the state
-   is a RELEASE not a SNAPSHOT. If -r is not specified, then -SNAPSHOT is
-   appended to the updated version string."""
-
-__INITIAL__ = ['0', '0', '1']
-
-
-if __name__ == "__main__":
-    v = []
-    try:
-        version_file = glob.glob("lib/*/version.rb")[0]
-        raw_v = re.search(r'VERSION = \'(.*)\'', open(version_file).read(), re.M|re.I|re.S).group(1)
-        v = re.split(re.compile("\.|-"), raw_v)
-        v = v[0:3]
-        map(int, v)
-
-    except ValueError:
-        print("failed to parse the existing VERSION file, assuming v 0.0.1")
-        v = ['0', '0', '1']
-
-    except FileNotFoundError:
-        print("failed to find a VERSION file, assuming v 0.0.0")
-        v = ['0', '0', '0']
-
-    op = ''
-    try:
-        op = sys.argv[1]
-    except:
-        print(__USAGE__)
-        sys.exit(-1)
-
-    if(op == '-m'):
-        v = [str(int(v[0])+1), '0', '0']
-
-    elif(op == '-n'):
-        v = [v[0], str(int(v[1])+1), '0']
-
-    elif(op == '-p' or op == '-h'):
-        v = [v[0], v[1], str(int(v[2])+1)]
-
-    else:
-        print(__USAGE__)
-        sys.exit(-1)
-
-    v = '.'.join(v)
-
-    if(op == '-h'):
-      os.system("git checkout -b hotfix/v%s master" % v)
-
-    else:
-      os.system("git checkout -b release/v%s develop" % v)
-
-    os.system("bump set %s" % v)
-
-    v += "\n"
-
-    print(v)
-
-    sys.exit(0)