active_operator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b9cf2ed21ea684d81d26477429ede619d17b88eac2d5f84684419221a026a2b
+  data.tar.gz: 644dc660407b17b845086e62004ed5f0d7d0ba29ba31bb81abe801480124ef2e
+SHA512:
+  metadata.gz: f7efb4a3cb1688678025b2a55124dc0b3c75da573d8c9b4b6bc093e01871cdd2470b3f7357fcf6d360c4bb559ba40cdbe6f4d2ffe2e8fffcba1cdb92b6ad2b5e
+  data.tar.gz: 4bca940a6bd59dd0c8d3bd27d33b10986ed1f932e20248a9674e9c8e1ac8520dbedce44c03910d4d920e907a11dd28fec2b840bc1f71fe2946cbcb3ee68d8807

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [0.1.0] - 2025-07-05
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jeremy Smith
+
+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,105 @@
+# Active Operator
+
+A Rails pattern for calling external APIs, then storing and processing their responses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "active_operator"
+```
+
+And then execute:
+
+```bash
+bundle install
+rails generate active_operator:install
+rails db:migrate
+```
+
+## Usage
+
+### 1. Define an Operation
+
+Create operation classes that inherit from `ApplicationOperation`:
+
+```ruby
+class Geocoding::V1 < ApplicationOperation
+  def request
+    # Make API call and return response, which will be stored in the operation record
+    faraday.get(
+      "https://api.geocod.io/v1.8/geocode",
+      {
+        q: record.address,
+        api_key: Rails.application.credentials.dig(:geocodio, :api_key),
+        fields: "timezone"
+      }
+    )
+  end
+
+  def process
+    # Load the response stored in the operation record, and update perform updates and other actions
+    result = response.dig("body", "results", 0)
+
+    record.update!(
+      latitude: result.dig("location", "lat"),
+      longitude: result.dig("location", "lng"),
+      timezone: result.dig("fields", "timezone", "name")
+    )
+  end
+end
+```
+
+### 2. Associate with Models
+
+Use the `has_operation` method in your models:
+
+```ruby
+class Location < ApplicationRecord
+  has_operation :geocoding, class_name: "Geocoding::V1"
+end
+```
+
+### 3. Save Operations
+
+You are responsible for saving the associated operation record.
+
+```ruby
+# Save an associated operation for a new record, within a transaction
+location = Location.new(location_params)
+location.build_geocoding
+location.save
+
+# Save an associated operation for an existing record
+location = Location.find(params[:id])
+location.geocoding.save
+```
+
+### 4. Perform Operations
+
+```ruby
+# Synchronous execution
+location = Location.find(params[:id])
+location.geocoding.perform
+
+# Asynchronous execution
+location = Location.find(params[:id])
+location.geocoding.perform_later
+```
+
+### 5. Check Operation Status
+
+```ruby
+location.geocoding.received?   # Operation completed request and stored response
+location.geocoding.processed?  # Operation completed processing of response
+location.geocoding.errored?    # Operation failed either request or process
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jeremysmithco/active_operator.

data/lib/active_operator/model.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ActiveOperator
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_operation(name, class_name: name.to_s.classify)
+        has_one name, class_name:, as: :record, inverse_of: :record, dependent: :destroy
+        define_method(name) { super() || public_send("build_#{name}") }
+      end
+    end
+  end
+end

data/lib/active_operator/operation.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ActiveOperator
+  class Operation < ActiveRecord::Base
+    self.table_name = "active_operator_operations"
+
+    belongs_to :record, polymorphic: true
+
+    def received?  = received_at?
+    def processed? = processed_at?
+    def errored?   = errored_at?
+
+    def perform
+      request!
+      process!
+    rescue
+      errored!
+      raise
+    end
+
+    def perform_later
+      ActiveOperator::PerformOperationJob.perform_later(self)
+    end
+
+    def request!
+      return false if received?
+
+      update!(response: request, received_at: Time.current)
+    end
+
+    def process!
+      return false if !received?
+      return false if processed?
+
+      ActiveRecord::Base.transaction do
+        process
+        update!(processed_at: Time.current)
+      end
+    end
+
+    def errored!
+      update!(errored_at: Time.current)
+    end
+
+    def request
+      raise NotImplementedError, "Operations must implement the `request` method"
+    end
+
+    def process
+      raise NotImplementedError, "Operations must implement the `process` method"
+    end
+  end
+end

data/lib/active_operator/perform_operation_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveOperator
+  class PerformOperationJob < ActiveJob::Base
+    discard_on ActiveRecord::RecordNotFound
+
+    def perform(operation)
+      operation.perform
+    end
+  end
+end

data/lib/active_operator/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveOperator
+  class Railtie < Rails::Railtie
+    initializer "active_operator.include_model" do
+      ActiveSupport.on_load(:active_record) do
+        include ActiveOperator::Model
+      end
+    end
+  end
+end

data/lib/active_operator/version.rb

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

data/lib/active_operator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_operator/version"
+require "active_operator/model"
+require "active_operator/operation"
+require "active_operator/perform_operation_job"
+
+module ActiveOperator
+  def self.table_name_prefix
+    "active_operator_"
+  end
+end
+
+require "active_operator/railtie" if defined?(Rails::Railtie)

data/lib/generators/active_operator/install_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module ActiveOperator
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_migration_file
+        migration_template(
+          "create_active_operator_operations.rb.erb",
+          "db/migrate/create_active_operator_operations.rb"
+        )
+      end
+
+      def create_application_operation
+        template(
+          "application_operation.rb.erb",
+          "app/operations/application_operation.rb"
+        )
+      end
+    end
+  end
+end

data/lib/generators/active_operator/templates/application_operation.rb.erb

@@ -0,0 +1,3 @@
+class ApplicationOperation < ActiveOperator::Operation
+  self.abstract_class = true
+end

data/lib/generators/active_operator/templates/create_active_operator_operations.rb.erb

@@ -0,0 +1,14 @@
+class CreateActiveOperatorOperations < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :active_operator_operations do |t|
+      t.string :type, null: false
+      t.references :record, polymorphic: true, null: false, index: true
+      t.json :response, null: false, default: "{}"
+      t.datetime :received_at
+      t.datetime :processed_at
+      t.datetime :errored_at
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: active_operator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Smith
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+email:
+- jeremy@jeremysmith.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/active_operator.rb
+- lib/active_operator/model.rb
+- lib/active_operator/operation.rb
+- lib/active_operator/perform_operation_job.rb
+- lib/active_operator/railtie.rb
+- lib/active_operator/version.rb
+- lib/generators/active_operator/install_generator.rb
+- lib/generators/active_operator/templates/application_operation.rb.erb
+- lib/generators/active_operator/templates/create_active_operator_operations.rb.erb
+homepage: https://github.com/jeremysmithco/active_operator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jeremysmithco/active_operator
+  source_code_uri: https://github.com/jeremysmithco/active_operator
+  changelog_uri: https://github.com/jeremysmithco/active_operator/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Rails pattern for calling external APIs, then storing and processing their
+  responses
+test_files: []