apirelio-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 315db73ba6a8c542405b654fd06f14eeb266094261d7fc8eb5e99c6a3740b338
+  data.tar.gz: d6abf278b2edf175d4f97e3050e7aee75f7ce1c4a71e72d0d200e4412830f9d5
+SHA512:
+  metadata.gz: 7ca3413f28871ccdac677b8167aed1477704fcb8470e69bad170a90b95aaf7ca6ab6602bfb41d6de0c434ca2548540992ff021970cda574d17e0ba63fe6eac0e
+  data.tar.gz: c623fe0d570cc43db9514c9fc8a17f4d5c81b2e3dac4e393060131d55a50c1e3d5ce1b16edb1d7e545eb27cd2137206cd32cd7de0edb3e8f19aa77fbb1f9dcf8

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.0 - 2026-08-12
+
+- Add automatic Rails middleware registration through a Railtie.
+- Add Rails configuration, customer/application resolvers and request context.
+- Capture matched Action Dispatch route patterns, controller actions and exceptions.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Apirelio
+
+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,23 @@
+# Apirelio Rails
+
+[Documentation](https://apirelio.com/docs/ruby/rails) · [RubyGems](https://rubygems.org/gems/apirelio-rails) · [Apirelio](https://apirelio.com)
+
+Automatic customer-aware API analytics for Rails 7.1 and 8.x.
+
+```bash
+bundle add apirelio-rails
+```
+
+```ruby
+# config/initializers/apirelio.rb
+Apirelio::Rails.configure do |config|
+  config.api_key = ENV.fetch("APIRELIO_API_KEY", "")
+  config.service = "billing-api"
+  config.customer_resolver = ->(env) {
+    account = env["current_account"]
+    account && { id: account.id.to_s, name: account.name, plan: account.plan }
+  }
+end
+```
+
+The Railtie registers middleware automatically. It records matched Rails routes, controller actions, status, duration and stable customer/application identity. Bodies, query strings, credentials, cookies and client IP addresses are never captured.

data/lib/apirelio/rails/configuration.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Apirelio
+  module Rails
+    class Configuration
+      attr_accessor :api_key, :service, :endpoint, :environment, :release, :enabled,
+                    :batch_size, :flush_interval, :max_queue_size, :timeout, :max_retries,
+                    :metadata_keys, :include_routes, :exclude_routes, :customer_resolver,
+                    :application_resolver, :error_code_resolver, :metadata_resolver,
+                    :api_version_header, :capture_headers, :transport
+
+      def initialize
+        @api_key = ENV.fetch("APIRELIO_API_KEY", "")
+        @service = ENV.fetch("APIRELIO_SERVICE", "rails-api")
+        @endpoint = ENV.fetch("APIRELIO_ENDPOINT", "https://apirelio.com")
+        @environment = ENV.fetch("RAILS_ENV", "production")
+        @release = ENV["APIRELIO_RELEASE"]
+        @enabled = true
+        @batch_size = 100
+        @flush_interval = 5.0
+        @max_queue_size = 10_000
+        @timeout = 2.0
+        @max_retries = 2
+        @metadata_keys = []
+        @include_routes = []
+        @exclude_routes = []
+        @customer_resolver = nil
+        @application_resolver = nil
+        @error_code_resolver = nil
+        @metadata_resolver = nil
+        @api_version_header = "HTTP_X_API_VERSION"
+        @capture_headers = %w[HTTP_X_SDK_VERSION HTTP_USER_AGENT]
+        @transport = nil
+      end
+
+      def client_options
+        {
+          api_key: api_key,
+          service: service,
+          endpoint: endpoint,
+          environment: environment,
+          release: release,
+          enabled: enabled,
+          batch_size: batch_size,
+          flush_interval: flush_interval,
+          max_queue_size: max_queue_size,
+          timeout: timeout,
+          max_retries: max_retries,
+          metadata_keys: metadata_keys,
+          transport: transport
+        }
+      end
+    end
+  end
+end

data/lib/apirelio/rails/middleware.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Apirelio
+  module Rails
+    class Middleware
+      def initialize(app, configuration = Apirelio::Rails.configuration)
+        @configuration = configuration
+        @client = Apirelio::Client.new(**configuration.client_options)
+        @middleware = Apirelio::Rack::Middleware.new(
+          app,
+          client: @client,
+          include_routes: configuration.include_routes,
+          exclude_routes: configuration.exclude_routes,
+          customer_resolver: configuration.customer_resolver,
+          application_resolver: configuration.application_resolver,
+          error_code_resolver: configuration.error_code_resolver,
+          metadata_resolver: configuration.metadata_resolver,
+          api_version_header: configuration.api_version_header,
+          capture_headers: configuration.capture_headers,
+          sdk: "rails",
+          sdk_version: VERSION
+        )
+      end
+
+      def call(env)
+        @middleware.call(env)
+      end
+
+      attr_reader :client
+    end
+  end
+end

data/lib/apirelio/rails/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Apirelio
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "apirelio.middleware" do |app|
+        app.middleware.use Apirelio::Rails::Middleware, Apirelio::Rails.configuration
+      end
+    end
+  end
+end

data/lib/apirelio/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Apirelio
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/apirelio/rails.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "apirelio"
+require "active_support"
+require "rails/railtie"
+require_relative "rails/version"
+require_relative "rails/configuration"
+require_relative "rails/middleware"
+
+module Apirelio
+  module Rails
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield configuration
+      end
+
+      def reset_configuration!
+        @configuration = Configuration.new
+      end
+
+      def context(env)
+        Apirelio::Rack.context(env)
+      end
+    end
+  end
+end
+
+require_relative "rails/railtie"

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: apirelio-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Apirelio
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apirelio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+description: Automatic, fail-safe Apirelio request instrumentation for Rails API applications.
+email:
+- info@apirelio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/apirelio/rails.rb
+- lib/apirelio/rails/configuration.rb
+- lib/apirelio/rails/middleware.rb
+- lib/apirelio/rails/railtie.rb
+- lib/apirelio/rails/version.rb
+homepage: https://apirelio.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://apirelio.com
+  source_code_uri: https://github.com/pryznar/apirelio-rails
+  changelog_uri: https://github.com/pryznar/apirelio-rails/blob/main/CHANGELOG.md
+  documentation_uri: https://apirelio.com/docs/ruby/rails
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Customer-aware API analytics for Ruby on Rails.
+test_files: []