active_call 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e129c0113e02eef8e739a830213f343eddb585c6798f4237f127256b1a5ac419
-  data.tar.gz: 550cdfc7e5285f9dc353003eb570fc89ae1d36d54025af035ab2a4751b61658a
+  metadata.gz: d67030b5b5cf7b405b842c1295c33912ebaa2b6ad1aeaefa0807e1a0f4fef105
+  data.tar.gz: 6b19ccf7e464102efe1e70ab0501ea6bb3aa8a781880f1492cca1bfeee9de576
 SHA512:
-  metadata.gz: 91d837ea7bead55372e4eaf777f84f35ac4ad3a9183633e9bc9042d14cdf26ae02c425a30391ff4dc85116d66d38edb62202fa114c5657c9c5bee60fa02bde83
-  data.tar.gz: 4025432ebc6ef1dbf2cbe5129b4e235808ab91ded26d192c04b7253bca008423e6d054808e3f774421e86bc42465e005ee0e4bfd26241ab19e685fc6ffc219d2
+  metadata.gz: 5b0aea3b486558cd5d81ead4cbc1e75c1ae97f1edef31b3d9ed796b04cdb78e24e6aeda57227ade6c927f7a90599dfe16c06dc8065b98dcbb340db8a27f279e4
+  data.tar.gz: 46f8fa215650ff0373ada16c79a7bd3f2f5a73ff8aaea30081a6e59ade1a869ac3aff735c132d87bc3774708ef13c2dc7829d802774b238f6acd74a061589063

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 ## [Unreleased]
 
+## [0.2.1] - 2025-03-25
+
+- Gemspec `changelog_uri` fixed.
+
 ## [0.2.0] - 2025-03-20
 
-- Added method `.call!` with a bang, which will raise an `ActiveCall::ValidationError` exception when validation fails and an `ActiveCall::RequestError` exception when errors were added to the service object in the `after_call` callback.
+- Added method `.call!` with a bang, which will raise an `ActiveCall::ValidationError` exception when validation fails and an `ActiveCall::RequestError` exception when errors were added to the service object in the `validate on: :response` block.
 - Use new method `success?` instead of `valid?`.
 - Method `valid?` will return `true` if the service object passed validation and was able to make the `call` method.
 - Use `validate, on: :response` to validate the response object.

data/README.md

@@ -1,5 +1,7 @@
 # Active Call
 
+[![Gem Version](https://badge.fury.io/rb/active_call.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/active_call)
+
 Active Call provides a standardized way to create service objects.
 
 ## Installation
@@ -49,7 +51,7 @@ Define a service object with optional validations and callbacks.
 ```ruby
 require 'active_call'
 
-class YourGemName::SomeResource::CreateService < ActiveCall::Base
+class YourGem::SomeResource::CreateService < ActiveCall::Base
   attr_reader :message
 
   validates :message, presence: true
@@ -82,12 +84,12 @@ class YourGemName::SomeResource::CreateService < ActiveCall::Base
 end
 ```
 
-### Using `.call`
+### Using `call`
 
 You will get an **errors** object when validation fails.
 
 ```ruby
-service = YourGemName::SomeResource::CreateService.call(message: '')
+service = YourGem::SomeResource::CreateService.call(message: '')
 service.success? # => false
 service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=blank, options={}>]>
 service.errors.full_messages # => ["Message can't be blank"]
@@ -97,7 +99,7 @@ service.response # => nil
 A **response** object on a successful `call` invocation.
 
 ```ruby
-service = YourGemName::SomeResource::CreateService.call(message: ' bar ')
+service = YourGem::SomeResource::CreateService.call(message: ' bar ')
 service.success? # => true
 service.response # => {:foo=>"bar"}
 ```
@@ -105,20 +107,20 @@ service.response # => {:foo=>"bar"}
 And an **errors** object if you added errors during the `validate, on: :response` validation.
 
 ```ruby
-service = YourGemName::SomeResource::CreateService.call(message: 'baz')
+service = YourGem::SomeResource::CreateService.call(message: 'baz')
 service.success? # => false
 service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=invalid, options={:message=>"cannot be baz"}>]>
 service.errors.full_messages # => ["Message cannot be baz"]
 service.response # => {:foo=>"baz"}
 ```
 
-### Using `.call!`
+### Using `call!`
 
 An `ActiveCall::ValidationError` **exception** gets raised when validation fails.
 
 ```ruby
 begin
-  service = YourGemName::SomeResource::CreateService.call!(message: '')
+  service = YourGem::SomeResource::CreateService.call!(message: '')
 rescue ActiveCall::ValidationError => exception
   exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=blank, options={}>]>
   exception.errors.full_messages # => ["Message can't be blank"]
@@ -128,7 +130,7 @@ end
 A **response** object on a successful `call` invocation.
 
 ```ruby
-service = YourGemName::SomeResource::CreateService.call!(message: ' bar ')
+service = YourGem::SomeResource::CreateService.call!(message: ' bar ')
 service.success? # => true
 service.response # => {:foo=>"bar"}
 ```
@@ -137,7 +139,7 @@ And an `ActiveCall::RequestError` **exception** gets raised if you added errors
 
 ```ruby
 begin
-  service = YourGemName::SomeResource::CreateService.call!(message: 'baz')
+  service = YourGem::SomeResource::CreateService.call!(message: 'baz')
 rescue ActiveCall::RequestError => exception
   exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=invalid, options={:message=>"cannot be baz"}>]>
   exception.errors.full_messages # => ["Message cannot be baz"]
@@ -150,17 +152,17 @@ end
 If you have secrets, use a **configuration** block.
 
 ```ruby
-class YourGemName::BaseService < ActiveCall::Base
+class YourGem::BaseService < ActiveCall::Base
   self.abstract_class = true
 
   config_accessor :api_key, default: ENV['API_KEY'], instance_writer: false
 end
 ```
 
-Then in your application code you can overwite the configuration defaults.
+Then in your application code you can override the configuration defaults.
 
 ```ruby
-YourGemName::BaseService.configure do |config|
+YourGem::BaseService.configure do |config|
   config.api_key = Rails.application.credentials.api_key || ENV['API_KEY']
 end
 ```
@@ -170,7 +172,7 @@ And implement a service object like so.
 ```ruby
 require 'net/http'
 
-class YourGemName::SomeResource::CreateService < YourGemName::BaseService
+class YourGem::SomeResource::CreateService < YourGem::BaseService
   def call
     Net::HTTP.get_response(URI("http://example.com/api?#{URI.encode_www_form(api_key: api_key)}"))
   end
@@ -201,6 +203,7 @@ Now start adding your service objects in the `lib` directory and make sure they
 
 ## Gems Using Active Call
 
+- [nCino KYC DocFox](https://github.com/kobusjoubert/doc_fox)
 - [Zoho Sign](https://github.com/kobusjoubert/zoho_sign)
 
 ## Development

data/lib/active_call/base.rb

@@ -14,13 +14,13 @@ class ActiveCall::Base
     # Abstract classes are not meant to be instantiated directly, but rather inherited from.
     # The `call` method doesn't need to be implemented in abstract classes.
     #
-    # Example:
+    # ==== Examples
     #
-    #   class YourGemName::BaseService < ActiveCall::Base
+    #   class YourGem::BaseService < ActiveCall::Base
     #     self.abstract_class = true
     #   end
     #
-    #   class YourGemName::SomeResource::CreateService < YourGemName::BaseService
+    #   class YourGem::SomeResource::CreateService < YourGem::BaseService
     #     def call
     #       # Implementation specific to this service.
     #     end
@@ -33,6 +33,33 @@ class ActiveCall::Base
     end
 
     # TODO: Refactor `call` and `call!`. The only differences are the two lines raising exceptions.
+
+    # Using `call`
+    #
+    # ==== Examples
+    #
+    # You will get an `errors` object when validation fails.
+    #
+    #   service = YourGem::SomeResource::CreateService.call(message: '')
+    #   service.success? # => false
+    #   service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=blank, options={}>]>
+    #   service.errors.full_messages # => ["Message can't be blank"]
+    #   service.response # => nil
+    #
+    # A `response` object on a successful `call` invocation.
+    #
+    #   service = YourGem::SomeResource::CreateService.call(message: ' bar ')
+    #   service.success? # => true
+    #   service.response # => {:foo=>"bar"}
+    #
+    # And an `errors` object if you added errors during the `validate, on: :response` validation.
+    #
+    #   service = YourGem::SomeResource::CreateService.call(message: 'baz')
+    #   service.success? # => false
+    #   service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=invalid, options={:message=>"cannot be baz"}>]>
+    #   service.errors.full_messages # => ["Message cannot be baz"]
+    #   service.response # => {:foo=>"baz"}
+    #
     def call(...)
       service_object = new(...)
       service_object.instance_variable_set(:@bang, false)
@@ -50,6 +77,36 @@ class ActiveCall::Base
       service_object
     end
 
+    # Using `call!`
+    #
+    # ==== Examples
+    #
+    # An `ActiveCall::ValidationError` exception gets raised when validation fails.
+    #
+    #   begin
+    #     service = YourGem::SomeResource::CreateService.call!(message: '')
+    #   rescue ActiveCall::ValidationError => exception
+    #     exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=blank, options={}>]>
+    #     exception.errors.full_messages # => ["Message can't be blank"]
+    #   end
+    #
+    # A `response` object on a successful `call` invocation.
+    #
+    #   service = YourGem::SomeResource::CreateService.call!(message: ' bar ')
+    #   service.success? # => true
+    #   service.response # => {:foo=>"bar"}
+    #
+    # And an `ActiveCall::RequestError` exception gets raised if you added errors during the `validate, on: :response`
+    # validation.
+    #
+    #   begin
+    #     service = YourGem::SomeResource::CreateService.call!(message: 'baz')
+    #   rescue ActiveCall::RequestError => exception
+    #     exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=invalid, options={:message=>"cannot be baz"}>]>
+    #     exception.errors.full_messages # => ["Message cannot be baz"]
+    #     exception.response # => {:foo=>"baz"}
+    #   end
+    #
     def call!(...)
       service_object = new(...)
       service_object.instance_variable_set(:@bang, true)

data/lib/active_call/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveCall
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_call
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,7 +66,7 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/kobusjoubert/active_call
   source_code_uri: https://github.com/kobusjoubert/active_call
-  changelog_uri: https://github.com/kobusjoubert/active_call/CHANGELOG.md
+  changelog_uri: https://github.com/kobusjoubert/active_call/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: