boringmetrics-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f20c8aaaab17cf76207209400332fdb37cf4f4ca03d2f22e70ce9d316b79164
+  data.tar.gz: 67456101066e331580c7e5db7cdc10d8677f08873e1ea87febe6e66bd6a1fb89
+SHA512:
+  metadata.gz: 687ee811ae61ebeedf646f8973095f8ed4423e4ecd08a9e596fb55cb62ac5338382132264942e6e66e9420e572bf28d22704e1287c63b0bbfed49b1dbe44e4ec
+  data.tar.gz: 8b5b8f6d10eaebc7f9b51fd6186ddb217bdfeb7054970b5d9d1a01d38e97c0a0cd10f5c07373318815398122028a858b9f3eed64e865ae9a0f28f9d88490ea74

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2025 Boring Metrics
+
+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,102 @@
+# Boring Metrics Ruby SDK
+
+This is a Ruby SDK for the Boring Metrics API. It provides a simple and efficient way to interact with the API from your Ruby applications.
+
+## Supported Platforms
+
+The SDK is available for the following platforms:
+
+- [`boringmetrics`](https://github.com/boringmetrics/ruby-sdk/tree/main/packages/boringmetrics): SDK for Ruby
+- [`boringmetrics-rails`](https://github.com/boringmetrics/ruby-sdk/tree/main/packages/boringmetrics-rails): SDK for Ruby on Rails
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# For plain Ruby applications
+gem 'boringmetrics'
+
+# For Rails applications
+gem 'boringmetrics-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install boringmetrics
+$ gem install boringmetrics-rails
+```
+
+## Usage
+
+### Ruby
+
+```ruby
+# Initialize the SDK
+BoringMetrics.initialize("YOUR_API_TOKEN")
+
+# Send a log
+BoringMetrics.logs.send(
+  type: "log",
+  level: "info",
+  message: "User signed in",
+  data: { user_id: "123" },
+)
+
+# Send multiple logs
+BoringMetrics.logs.send_batch([
+  { type: "log", level: "warn", message: "Something looks weird" },
+  { type: "log", level: "error", message: "Something broke!", data: { error: "Connection timeout" } }
+])
+
+# Set a live metric value
+BoringMetrics.lives.update(
+  live_id: "metric-123",
+  value: 42,
+  operation: "set",
+)
+
+# Increment a live metric value
+BoringMetrics.lives.update(
+  live_id: "metric-123",
+  value: 5,
+  operation: "increment",
+)
+```
+
+### Rails
+
+In a Rails application, you can initialize the SDK in an initializer:
+
+```ruby
+# config/initializers/boringmetrics.rb
+BoringMetrics::Rails.initialize("YOUR_API_TOKEN", {
+  logs_max_batch_size: 50,
+  logs_send_interval: 10
+})
+```
+
+The Rails integration automatically captures exceptions and logs them to BoringMetrics.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boringmetrics/ruby-sdk.
+
+## Contributors
+
+Thanks to everyone who contributed to the Boring Metrics Ruby SDK!
+
+<a href="https://github.com/boringmetrics/ruby-sdk/graphs/contributors">
+  <img src="https://contributors-img.web.app/image?repo=boringmetrics/ruby-sdk" />
+</a>
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/boringmetrics-rails/middleware.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module BoringMetrics
+  module Rails
+    # Rack middleware for BoringMetrics
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        start_time = Time.now
+        
+        # Process the request
+        begin
+          status, headers, response = @app.call(env)
+          [status, headers, response]
+        rescue StandardError => e
+          # Log the exception if BoringMetrics is initialized
+          if defined?(BoringMetrics.client) && BoringMetrics.client
+            BoringMetrics.logs.send(
+              type: "log",
+              level: "error",
+              message: e.message,
+              data: {
+                exception: e.class.name,
+                backtrace: e.backtrace&.first(10),
+                path: env["PATH_INFO"],
+                method: env["REQUEST_METHOD"]
+              }
+            )
+          end
+          raise e
+        ensure
+          # Log request metrics if BoringMetrics is initialized
+          if defined?(BoringMetrics.client) && BoringMetrics.client
+            duration = ((Time.now - start_time) * 1000).round(2) # in milliseconds
+            
+            # Update live metric for request duration
+            BoringMetrics.lives.update(
+              live_id: "request_duration",
+              value: duration,
+              operation: "set"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/boringmetrics-rails/railtie.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "rails"
+require_relative "middleware"
+
+module BoringMetrics
+  module Rails
+    # Rails integration for BoringMetrics
+    class Railtie < ::Rails::Railtie
+      initializer "boringmetrics.middleware" do |app|
+        app.middleware.use Middleware
+      end
+
+      # Log Rails errors to BoringMetrics
+      config.after_initialize do
+        ActiveSupport::Notifications.subscribe("process_action.action_controller") do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+          exception = event.payload[:exception_object]
+
+          if exception && defined?(BoringMetrics.client) && BoringMetrics.client
+            BoringMetrics.logs.send(
+              type: "log",
+              level: "error",
+              message: exception.message,
+              data: {
+                exception: exception.class.name,
+                backtrace: exception.backtrace&.first(10),
+                controller: event.payload[:controller],
+                action: event.payload[:action]
+              }
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/boringmetrics-rails/version.rb

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

data/lib/boringmetrics-rails.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "boringmetrics"
+require_relative "boringmetrics-rails/version"
+require_relative "boringmetrics-rails/railtie"
+
+module BoringMetrics
+  # Rails integration for BoringMetrics
+  module Rails
+    class << self
+      # Initialize the SDK with Rails integration
+      #
+      # @param token [String] Your BoringMetrics API token
+      # @param config [Hash] Optional configuration options
+      # @return [BoringMetrics::Client] The initialized client
+      def initialize(token, **config)
+        BoringMetrics.initialize(token, **config)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: boringmetrics-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aymeric Chauvin
+bindir: bin
+cert_chain: []
+date: 2025-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: boringmetrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Rails integration for the Boring Metrics Ruby SDK. It provides Rails-specific
+  functionality for the Boring Metrics API.
+email:
+- contact@halftheopposite.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/boringmetrics-rails.rb
+- lib/boringmetrics-rails/middleware.rb
+- lib/boringmetrics-rails/railtie.rb
+- lib/boringmetrics-rails/version.rb
+homepage: https://github.com/boringmetrics/ruby-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boringmetrics/ruby-sdk
+  source_code_uri: https://github.com/boringmetrics/ruby-sdk
+  changelog_uri: https://github.com/boringmetrics/ruby-sdk/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Rails integration for Boring Metrics
+test_files: []