mifiel 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2c4dce2300a5b45db18cf7f9d1627615416a2a26c523e5ac2f75619601f4505
-  data.tar.gz: 9b77870339343d556247691b6d051e1abe75c06635738eb93b8ebf1dc2ff8dd7
+  metadata.gz: fba43da41b56717d0f34d2d23441a29685b1014eff732a8c7c3c2a886cbcf81f
+  data.tar.gz: a067295115e5ae373cb996708138bef64ed3f5a5f7406e3027df2f321ff13d3b
 SHA512:
-  metadata.gz: 76ad57f5e80dcca88ae90354eba7c9ffd34ce4face32f40518f3af954e509ba2929a1d876ab367cbdebbc594482c8b7ccb6dceca51682ce94e5a2dc50be04830
-  data.tar.gz: 899b2734c72b89781758f99842cbdde7a28424558a5a5e64f9e9d39123c2b361c304c0c2e5004ba79c4746b55a3342427e832f2d6587886d8d27a0c2612c7843
+  metadata.gz: 224c26fd5767508ffaddd0a8f824f6f70129728c7ff1d81834a33117a470d6e697b92d5a8b5f166f4679f57fe8619ef048936c9e45bd3a6717100b23dd427956
+  data.tar.gz: 6babe35d31fcc72e070079b5e718f47e2157254f33a40f01989685bcf2e0d91a4cd73bb2793183f65d090593e6adb852b25ab6d6de2b2056b379d5e8bb08edca

data/Appraisals

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 appraise 'rails-7' do
-  gem 'rails', '7'
+  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-8' do
-  gem 'rails', '8'
+  # 8.0.x still passes quirks_mode; 8.1 removed it and works with json 3.
+  gem 'rails', '~> 8.1.0'
 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/gemfiles/rails_7.gemfile

@@ -2,7 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "rails", "7"
+gem "rails", "~> 7.2.0"
+gem "json", "< 3"
 gem "mutex_m"
 gem "benchmark"
 gem "ostruct"

data/gemfiles/rails_8.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "8"
+gem "rails", "~> 8.1.0"
 
 group :development, :test do
   gem "coveralls", require: false

data/lib/mifiel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mifiel
-  VERSION = '2.0.0'
+  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'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mifiel
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Genaro Madrid
@@ -64,6 +64,7 @@ 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
@@ -96,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ruby SDK for mifiel.com.
 test_files: []