active_call 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4673cf511194223bf9481aa7ed85507c9162556b20469f28c9421cc59f4230a9
+  data.tar.gz: 20fed6531fd0ac7bc7c6e6f8ffb03d336c82e6b91131354c3c5da6e202ea56b0
+SHA512:
+  metadata.gz: 0064c55032419b699535d0f19cfbf90d730089f57da8a7ac360bdb96fbb7f40dc6d2a19859baec6074e180aef6ef290a45bb818ba872a5418f2ad8c0432786cf
+  data.tar.gz: bea908f7aeb097617edaf7694a5fffd21e8ef6f3a90f8fdcebd8e4efd23cf90fba289df598914c35540b16400b7ae46dd6ce4c4bd5df29e1b42feb1ad6dabfa2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Include:
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'
+  Exclude:
+    - active_call.gemspec
+    - bin/*
+    - 'vendor/**/*'
+    - 'gem/**/*'
+
+Lint/MissingSuper:
+  AllowedParentClasses:
+    - ActiveCall::Base
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*/**.rb
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Exclude:
+    - lib/active_call.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/SymbolArray:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-08
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Kobus Joubert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+# Active Call
+
+Active Call provides a standardized way to create service objects.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+Your child classes should inherit from `ActiveCall::Base`.
+
+Now you can start adding your own service object classes in your gem's `lib` folder.
+
+Each service object must define only one public method named `call`.
+
+A `response` attribute is set with the result of the `call` method.
+
+An `errors` object will be set if you specified any validations that failed before the `call` method could be invoked.
+
+There is also a `before_call` hook to set up anything before invoking the `call` method. This only happens after all validations have passed.
+
+Define a service object with optional validations and callbacks.
+
+```ruby
+require 'active_call'
+
+class YourGemName::SomeResource::GetService < ActiveCall::Base
+  attr_reader :message
+
+  validates :message, presence: true
+
+  before_call :strip_message
+
+  def initialize(message: nil)
+    @message = message
+  end
+
+  def call
+    { foo: message }
+  end
+
+  private
+
+  def strip_message
+    @message.strip!
+  end
+end
+```
+
+You will get a **response** object.
+
+```ruby
+service = YourGemName::SomeResource::GetService.call(message: ' bar ')
+service.valid? # => true
+service.response # => { foo: 'bar' }
+```
+
+And an **errors** object when validation failed.
+
+```ruby
+service = YourGemName::SomeResource::GetService.call(message: '')
+service.valid? # => false
+service.errors.full_messages # => ["Message can't be blank"]
+service.response # => nil
+```
+
+If you have secrets, use a **configuration** block.
+
+```ruby
+require 'net/http'
+
+class YourGemName::BaseService < ActiveCall::Base
+  config_accessor :api_key, default: ENV['API_KEY'], instance_writer: false
+
+  def call
+    Net::HTTP.get_response(URI("http://example.com/api?#{URI.encode_www_form(api_key: api_key)}"))
+  end
+end
+```
+
+Then in your application code you can overrite the configuration defaults.
+
+```ruby
+YourGemName::BaseService.configure do |config|
+  config.api_key = Rails.application.credentials.api_key || ENV['API_KEY']
+end
+```
+
+## Gem Creation
+
+To create your own gem for a service.
+
+```bash
+gem update --system
+```
+
+Build your gem.
+
+```bash
+bundle gem your_service --test=rspec --linter=rubocop --ci=github --github-username=<your_profile_name> --git --changelog --mit
+```
+
+Then add Active Call as a dependency in your gemspec.
+
+```ruby
+spec.add_dependency 'active_call'
+```
+
+Now start adding your service objects in the `lib` directory and make sure they inherit from `ActiveCall::Base`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kobusjoubert/active_call.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/active_call/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class ActiveCall::Base
+  extend ActiveModel::Callbacks
+  include ActiveModel::Validations
+  include ActiveSupport::Configurable
+
+  attr_reader :response
+
+  define_model_callbacks :call
+
+  class << self
+    def call(...)
+      service_object = new(...)
+      return service_object if service_object.invalid?
+
+      service_object.run_callbacks(:call) do
+        service_object.instance_variable_set(:@response, service_object.call)
+      end
+
+      service_object
+    end
+  end
+end

data/lib/active_call/version.rb

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

data/lib/active_call.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'active_model'
+require 'zeitwerk'
+
+require_relative 'active_call/version'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module ActiveCall
+  class Error < StandardError; end
+end

data/sig/active_call.rbs

@@ -0,0 +1,4 @@
+module ActiveCall
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: active_call
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kobus Joubert
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Active Call provides a standardized way to create service objects.
+email:
+- kobus@translate3d.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_call.rb
+- lib/active_call/base.rb
+- lib/active_call/version.rb
+- sig/active_call.rbs
+homepage: https://github.com/kobusjoubert/active_call
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Active Call
+test_files: []