logsnag-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 290549e28821123d90a3a090d8fbfbddfb4121966467d67e166009956586ad9c
+  data.tar.gz: 163c0b7bc7ff995f1aa932cfc46348918e53eb618e1f6be4bbf913442eb38837
+SHA512:
+  metadata.gz: 755f3063453f5555b7f5d6c02265d6e28d029055979a9a1f31104abc26cd447ec27415049f90cb6313c52934b29ba6904805847540d5cd443547722e770521e5
+  data.tar.gz: 716e831b19d6d79d4810647a2c5e3591b860aba9b7d1e47e2b43817d3055455f65e87adc52de4aea8129663f720b200c226a3b1aca08c34448e8355938637845

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,36 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+GemSpec/RequireMFA:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Lint/NonDeterministicRequireOrder:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.4

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.0 (2023-11-11)
+
+### Features
+
+* initial release ([77a98a4](https://github.com/damonbauer/logsnag-ruby/commit/77a98a4ade4725e5d4562be962aa80da00cdd853))
+
+## [Unreleased]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Damon Bauer
+
+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,178 @@
+# logsnag-ruby
+
+Interact with the [LogSnag](https://logsnag.com) API to send logs, identify users, and send insights.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logsnag-ruby'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install logsnag-ruby
+```
+
+## Configuration
+
+Before you can send logs to LogSnag, you need to configure the gem with your API token and project name.
+This is typically done in an initializer in your application.
+For example:
+
+```ruby
+# config/initializers/logsnag.rb
+
+LogSnag.configure do |config|
+  config.api_token = "your_api_token"
+  config.project = "your_project_name"
+end
+```
+
+## Usage
+
+The `logsnag-ruby` gem provides several methods to interact with the LogSnag API.
+
+Each method will automatically add the `project` and `api_token` parameters to the request.
+
+### Logging Events
+
+To send an event log:
+
+```ruby
+LogSnag.log({
+  channel: "server",
+  event: "server_start",
+  # ... other optional parameters ...
+})
+```
+
+**Arguments:**
+
+- `data`: A hash containing the event data.
+    - **Required keys:**
+        - `channel` [String]: The channel within the project to which the log belongs.
+        - `event` [String]: The name of the event.
+    - Optional keys:
+        - `user_id` [String]: The user ID of the user related to the event.
+        - `description` [String]: The description of the event.
+        - `icon` [String]: The icon to be displayed with the event.
+        - `notify` [Boolean]: Whether to send a push notification for the event.
+        - `tags` [Hash]: The tags associated with the event. See [the LogSnag docs](https://docs.logsnag.com/api-reference/log#tags) for more information regarding the format of the `tags` hash.
+        - `parser` [String]: The parser to be used for the event. One of "text" or "markdown".
+        - `timestamp` [Numeric]: The timestamp of the event (in Unix seconds).
+
+**Returns:**
+
+- `LogSnag::Result`: A result object with the following methods:
+    - `success?`: Returns `true` if the request was successful.
+    - `error?`: Returns `true` if the request failed.
+    - `data`: The parsed response data from the server.
+    - `error_message`: The error message if the request failed.
+    - `status_code`: The HTTP status code of the response.
+
+### Identifying Users
+
+To add or update properties to a user profile:
+
+```ruby
+LogSnag.identify({
+  user_id: "user_123",
+  properties: {
+    email: "user@example.com",
+    plan: "premium"
+  }
+})
+```
+
+**Arguments:**
+
+- `data`: A hash containing the identification data.
+    - **Required keys:**
+        - `user_id` [String]: The user ID of the user to be identified.
+        - `properties` [Hash]: The properties of the user to be identified. See [the LogSnag docs](https://docs.logsnag.com/api-reference/identify#properties-schema) for more information regarding the format of the `properties` hash.
+
+**Returns:**
+
+- `LogSnag::Result`: A result object with the following methods:
+    - `success?`: Returns `true` if the request was successful.
+    - `error?`: Returns `true` if the request failed.
+    - `data`: The parsed response data from the server.
+    - `error_message`: The error message if the request failed.
+    - `status_code`: The HTTP status code of the response.
+
+### Sending Insights
+
+To send an insight log:
+
+```ruby
+LogSnag.insight({
+  title: "New Signups",
+  value: 42,
+  # ... other optional parameters ...
+})
+```
+
+**Arguments:**
+
+- `data`: A hash containing the insight data.
+    - **Required keys:**
+        - `title` [String]: The title of the insight.
+        - `value` [String, Numeric]: The numerical value of the insight.
+    - Optional keys:
+        - `icon` [String]: The icon to be displayed with the insight.
+
+**Returns:**
+
+- `LogSnag::Result`: A result object with the following methods:
+    - `success?`: Returns `true` if the request was successful.
+    - `error?`: Returns `true` if the request failed.
+    - `data`: The parsed response data from the server.
+    - `error_message`: The error message if the request failed.
+    - `status_code`: The HTTP status code of the response.
+
+### Mutating Insights
+
+To mutate (increment) an existing numerical insight:
+
+```ruby
+LogSnag.mutate_insight({ 
+  title: "Total Users", 
+  value: 5
+})
+```
+
+**Arguments:**
+
+- `data`: A hash containing the insight mutation data.
+    - **Required keys:**
+        - `title` [String]: The title of the insight.
+        - `value` [Numeric]: The amount to increment the insight by.
+    - Optional keys:
+        - `icon` [String]: The icon to be displayed with the insight.
+
+**Returns:**
+
+- `LogSnag::Result`: A result object with the following methods:
+    - `success?`: Returns `true` if the request was successful.
+    - `error?`: Returns `true` if the request failed.
+    - `data`: The parsed response data from the server.
+    - `error_message`: The error message if the request failed.
+    - `status_code`: The HTTP status code of the response.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub
+at [https://github.com/damonbauer/logsnag-ruby](https://github.com/damonbauer/logsnag-ruby).
+
+## 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/logsnag/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module LogSnag
+  # Configuration class for storing API token, project, and logger
+  class Configuration
+    attr_accessor :logger
+    attr_reader :api_token, :project
+
+    def api_token=(token)
+      raise ArgumentError, "API token cannot be nil" if token.nil? || token.empty?
+
+      @api_token = token
+    end
+
+    def project=(project_name)
+      raise ArgumentError, "Project cannot be nil" if project_name.nil? || project_name.empty?
+
+      @project = project_name
+    end
+  end
+end

data/lib/logsnag/event_base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module LogSnag
+  # Provides a base class for LogSnag events.
+  # Ensures that the data hash is valid and that the configuration object is present.
+  # @abstract Subclass and override {#data} and {#config} to implement.
+  # @attr_reader data [Hash] The data to be sent to LogSnag.
+  # @attr_reader config [LogSnag::Configuration] The configuration object.
+  # @raise [ArgumentError] If the hash is missing required keys or contains invalid keys.
+  # @return [LogSnag::EventBase] The new EventBase object.
+  class EventBase
+    attr_reader :data, :config
+
+    def initialize(data, config)
+      @data = data
+      @config = config
+
+      raise ArgumentError, "`data` must be a Hash" unless data.is_a?(Hash)
+
+      return if config.is_a?(LogSnag::Configuration)
+
+      raise ArgumentError,
+            "LogSnag::Configuration not found. Did you call LogSnag.configure?"
+    end
+
+    def to_json(*_args)
+      data.to_json
+    end
+  end
+end

data/lib/logsnag/identify.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "event_base"
+require_relative "validator"
+
+module LogSnag
+  # Constructs and validates an "identify" object
+  class Identify < EventBase
+    REQUIRED_KEYS = %i[project user_id properties].freeze
+
+    attr_reader :data, :config
+
+    # Creates a new Identify object.
+    # @param data [Hash] The data to be sent to LogSnag.
+    # The data hash must include the following keys:
+    #   - :user_id [String] The user ID of the user to be identified.
+    #   - :properties [Hash] The properties of the user to be identified.
+    # @param config [LogSnag::Configuration] The configuration object.
+    # @see https://docs.logsnag.com/api-reference/identify
+    # @raise [ArgumentError] If the hash is missing required keys, has invalid keys, or has values of incorrect types.
+    # @return [LogSnag::Insight] The new Identify object.
+    def initialize(data, config)
+      super(data, config)
+
+      append_required_fields!
+      compact_properties!
+      validate_data
+    end
+
+    private
+
+    def append_required_fields!
+      data[:project] = config.project
+      data
+    end
+
+    def compact_properties!
+      Validator.compact_hash!(data, :properties)
+    end
+
+    def validate_data
+      Validator.validate_required_keys(REQUIRED_KEYS, data)
+      Validator.validate_hash(data[:properties])
+    end
+  end
+end

data/lib/logsnag/insight.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "event_base"
+require_relative "validator"
+
+module LogSnag
+  # Constructs and validates an "insight" object
+  class Insight < EventBase
+    REQUIRED_KEYS = %i[project title value].freeze
+
+    attr_reader :data, :config
+
+    # Creates a new Insight object.
+    # @param data [Hash] The data to be sent to LogSnag.
+    # The data hash MUST include the following keys:
+    #   - :title [String] The title of the insight.
+    #   - :value [String,Numeric] The numerical value of the insight.
+    # The data hash MAY include the following keys:
+    #   - :icon [String] The icon to be displayed with the insight.
+    # @param config [LogSnag::Configuration] The configuration object.
+    # @param mutate [Boolean] Whether or not to mutate the data hash.
+    # @see https://docs.logsnag.com/api-reference/insight
+    # @raise [ArgumentError] If the hash is missing required keys, has invalid keys, or has values of incorrect types.
+    # @return [LogSnag::Insight] The new Insight object.
+    def initialize(data, config, mutate: false)
+      super(data, config)
+
+      append_required_fields!
+
+      if mutate
+        validate_mutation_data
+      else
+        validate_data
+      end
+    end
+
+    private
+
+    def append_required_fields!
+      data[:project] = config.project
+      data
+    end
+
+    def validate_mutation_data
+      Validator.validate_required_keys(REQUIRED_KEYS, data)
+      validate_mutation_values
+    end
+
+    def validate_data
+      Validator.validate_required_keys(REQUIRED_KEYS, data)
+      validate_values
+    end
+
+    def validate_mutation_values
+      return if [Numeric].any? { |type| data[:value].is_a?(type) }
+
+      raise ArgumentError, "Invalid value for Insight mutation: '#{data[:value]}'. Value must be a number."
+    end
+
+    def validate_values
+      return if [String, Numeric].any? { |type| data[:value].is_a?(type) }
+
+      raise ArgumentError, "Invalid value for Insight: '#{data[:value]}'. Values must be a string or number."
+    end
+  end
+end

data/lib/logsnag/log.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "event_base"
+require_relative "validator"
+
+module LogSnag
+  # Constructs and validates an event log
+  class Log < EventBase
+    REQUIRED_KEYS = %i[project channel event].freeze
+    ALLOWED_KEYS = REQUIRED_KEYS + %i[
+      user_id description icon notify tags parser timestamp
+    ].freeze
+
+    # attr_reader :data, :config
+
+    # Creates a new Log object.
+    # @param data [Hash] The data to be sent to LogSnag.
+    # The data hash must include the following keys:
+    #   - :channel [String] The channel within the project to which the log belongs.
+    #   - :event [String] The name of the event.
+    # The data hash may include the following keys:
+    #   - :user_id [String] The user ID of the user to be identified.
+    #   - :description [String] The description of the event.
+    #   - :icon [String] The icon to be displayed with the event.
+    #   - :notify [Boolean] Whether or not to send a push notification for the event.
+    #   - :tags [Hash] The tags to be associated with the event.
+    #   - :parser [String] The parser to be used for the event. One of "text" or "markdown".
+    #   - :timestamp [Numeric] The timestamp of the event (in Unix seconds).
+    # @param config [LogSnag::Configuration] The configuration object.
+    # @see https://docs.logsnag.com/api-reference/log
+    # @raise [ArgumentError] If the hash is missing required keys, has invalid keys, or has values of incorrect types.
+    # @return [LogSnag::Insight] The new Identify object.
+    def initialize(data, config)
+      super(data, config)
+
+      append_required_fields!
+      compact_tags!
+      validate_data
+    end
+
+    private
+
+    def append_required_fields!
+      data[:project] = config.project
+      data
+    end
+
+    def compact_tags!
+      Validator.compact_hash!(data, :tags)
+    end
+
+    def validate_data
+      Validator.validate_required_keys(REQUIRED_KEYS, data)
+      Validator.validate_allowed_keys(ALLOWED_KEYS, data)
+      Validator.validate_hash(data[:tags])
+    end
+  end
+end

data/lib/logsnag/result.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module LogSnag
+  Result = Struct.new(:success, :data, :error_message, :status_code, keyword_init: true) do
+    def success?
+      success
+    end
+
+    def error?
+      !success
+    end
+  end
+end

data/lib/logsnag/validator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module LogSnag
+  # Provides helpers for validating data.
+  class Validator
+    # Ensure that the `required_keys` are present in the `data` hash.
+    # @param required_keys [Array<Symbol>] The keys that must be present in the hash.
+    # @param data [Hash] The hash to be validated.
+    # @raise [ArgumentError] If the hash is missing required keys.
+    # @return [void]
+    def self.validate_required_keys(required_keys, data)
+      missing_keys = required_keys - data.keys
+      raise ArgumentError, "Missing required keys: #{missing_keys}" unless missing_keys.empty?
+    end
+
+    # Ensure that the `data` hash only contains keys in the `allowed_keys` array.
+    # @param allowed_keys [Array<Symbol>] The keys that are allowed in the hash.
+    # @param data [Hash] The hash to be validated.
+    # @raise [ArgumentError] If the hash contains invalid keys.
+    # @return [void]
+    def self.validate_allowed_keys(allowed_keys, data)
+      invalid_keys = data.keys - allowed_keys
+      raise ArgumentError, "Found invalid keys: #{invalid_keys}" unless invalid_keys.empty?
+    end
+
+    # Removes any nil values from the hash at the specified path.
+    # @param hash [Hash] The hash from which to remove nil values.
+    # @param path [Symbol] The path to the hash to be compacted.
+    # @return [Hash] The hash with nil values removed.
+    def self.compact_hash!(hash, path)
+      hash[path] = hash[path].compact if hash[path]
+      hash
+    end
+
+    # Ensures that the keys and values in the hash conform to the specified rules.
+    # @param hash [Hash] The hash to be validated.
+    # @raise [ArgumentError] If the hash contains invalid keys or values.
+    # @return [void]
+    def self.validate_hash(hash)
+      return unless hash
+
+      hash.each do |key, value|
+        raise ArgumentError, "Invalid key: '#{key}'. Keys must be lowercase and may include dashes." unless key.to_s.match?(/\A[a-z]+(-[a-z]+)*\z/)
+
+        raise ArgumentError, "Invalid value for '#{key}': '#{value}'. Values must be a string, boolean, or number." unless [String, TrueClass, FalseClass, Numeric].any? { |type| value.is_a?(type) }
+      end
+    end
+  end
+end

data/lib/logsnag/version.rb

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

data/lib/logsnag-ruby.rb

@@ -0,0 +1,5 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require "logsnag"
+# rubocop:enable Naming/FileName

data/lib/logsnag.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "json"
+
+require_relative "logsnag/version"
+require_relative "logsnag/configuration"
+require_relative "logsnag/log"
+require_relative "logsnag/identify"
+require_relative "logsnag/insight"
+require_relative "logsnag/result"
+
+# The main module for the LogSnag gem, containing methods for sending logs to LogSnag.
+module LogSnag
+  include HTTParty
+
+  base_uri "https://api.logsnag.com/v1"
+  PATHS = {
+    LOG: "/log",
+    IDENTIFY: "/identify",
+    INSIGHT: "/insight"
+  }.freeze
+
+  class << self
+    attr_accessor :config
+
+    # Configures LogSnag with the provided configuration options.
+    # @yield [LogSnag::Configuration] The configuration object.
+    def configure
+      self.config ||= LogSnag::Configuration.new
+      yield(config)
+    end
+
+    # Sends an event log to LogSnag.
+    #
+    # Logs are the core of LogSnag. They are used to track events in your application. These events could be
+    # anything from user actions to server events, such as a database running out of space or a server crash.
+    #
+    # @param data [Hash] The data to be sent to LogSnag.
+    # The data hash MUST include the following keys:
+    #   - :channel [String] The channel within the project to which the log belongs.
+    #   - :event [String] The name of the event.
+    # The data hash MAY include the following keys:
+    #   - :user_id [String] The user ID of the user to be identified.
+    #   - :description [String] The description of the event.
+    #   - :icon [String] The icon to be displayed with the event.
+    #   - :notify [Boolean] Whether or not to send a push notification for the event.
+    #   - :tags [Hash] The tags to be associated with the event.
+    #   - :parser [String] The parser to be used for the event. One of "text" or "markdown".
+    #   - :timestamp [Numeric] The timestamp of the event (in Unix seconds).
+    # @see https://docs.logsnag.com/api-reference/log
+    # @raise [ArgumentError] If the hash is missing required keys or contains invalid keys.
+    # @return [LogSnag::Result] The formatted result from the request.
+    def log(data = {})
+      event = LogSnag::Log.new(data, config)
+      execute_post(PATHS[:LOG], event)
+    end
+
+    # Sends an identify log to LogSnag.
+    #
+    # The identify endpoint lets you add key-value properties to a user profile.
+    # This endpoint is optional and useful for getting a complete picture of a user just by looking at their profile,
+    # and additionally, these properties can be used for filtering and searching.
+    #
+    # For example, you may add a user's email address, their plan, last payment date, etc., to their profile and
+    # then use these properties to filter and search for users, such as searching for all users on a specific plan.
+    #
+    # @param data [Hash] The data to be sent to LogSnag.
+    # The data hash MUST include the following keys:
+    #   - :user_id [String] The user ID of the user to be identified.
+    #   - :properties [Hash] The properties of the user to be identified.
+    # @see https://docs.logsnag.com/api-reference/identify
+    # @raise [ArgumentError] If the hash is missing required keys or contains invalid keys.
+    # @return [LogSnag::Result] The formatted result from the request.
+    def identify(data = {})
+      event = LogSnag::Identify.new(data, config)
+      execute_post(PATHS[:IDENTIFY], event)
+    end
+
+    # Sends an insight log to LogSnag.
+    #
+    # Insights are real-time widgets that you can add to each of your projects.
+    # They are use-case agnostic and can be used to display any information that you want in real-time.
+    #
+    # @param data [Hash] The data to be sent to LogSnag.
+    # The data hash MUST include the following keys:
+    #   - :title [String] The title of the insight.
+    #   - :value [String,Numeric] The numerical value of the insight.
+    # @see https://docs.logsnag.com/api-reference/insight
+    # @raise [ArgumentError] If the hash is missing required keys, has invalid keys, or has values of incorrect types.
+    # @return [LogSnag::Result] The formatted result from the request.
+    def insight(data = {})
+      event = LogSnag::Insight.new(data, config)
+      execute_post(PATHS[:INSIGHT], event)
+    end
+
+    # Mutate an insight to LogSnag.
+    # This endpoint allows you to change (mutate) existing numerical insights.
+    # @param data [Hash] The data to be sent to LogSnag.
+    # The data hash MUST include the following keys:
+    #   - :title [String] The title of the insight.
+    #   - :value [Numeric] The numerical value of the insight.
+    # The data hash MAY include the following keys:
+    #   - :icon [String] The icon to be displayed with the event.
+    # @see https://docs.logsnag.com/api-reference/insight-mutate
+    # @raise [ArgumentError] If the hash is missing required keys, has invalid keys, or has values of incorrect types.
+    # @return [LogSnag::Result] The formatted result from the request.
+    def mutate_insight(data = {})
+      event = LogSnag::Insight.new(data, config, mutate: true)
+      execute_patch(PATHS[:INSIGHT], event)
+    end
+
+    private
+
+    # Executes a POST request to the specified path with the provided body.
+    # @param path [String] The path to which the request should be made.
+    # @param body [LogSnag::Log,LogSnag::Identify,LogSnag::Insight] The body of the request.
+    # @return [LogSnag::Result] The formatted result from the request.
+    def execute_post(path, body)
+      response = post(
+        path,
+        body: body.to_json,
+        headers: headers
+      )
+
+      handle_response(response)
+    rescue HTTParty::Error => e
+      Result.new(success: false, error_message: e.message, status_code: nil)
+    end
+
+    # Executes a PATCH request to the specified path with the provided body.
+    # @param path [String] The path to which the request should be made.
+    # @param body [LogSnag::Insight] The body of the request.
+    # @return [LogSnag::Result] The formatted result from the request.
+    def execute_patch(path, body)
+      response = patch(
+        path,
+        body: {
+          **body.data,
+          value: {
+            "$inc": body.data[:value]
+          }
+        }.to_json,
+        headers: headers
+      )
+
+      handle_response(response)
+    rescue HTTParty::Error => e
+      Result.new(success: false, error_message: e.message, status_code: nil)
+    end
+
+    # Handles the response from the HTTP request.
+    # @param response [HTTParty::Response] The response from the HTTP request.
+    # @return [LogSnag::Result] The formatted result from the request.
+    def handle_response(response)
+      if response.success?
+        Result.new(success: true, data: response.parsed_response, status_code: response.code)
+      else
+        error_message = response.parsed_response["message"] || response.body
+        Result.new(success: false, error_message: error_message, status_code: response.code)
+      end
+    end
+
+    # Returns the headers to be used in the HTTP request.
+    # @return [Hash] The headers to be used in the HTTP request.
+    def headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{config.api_token}"
+      }
+    end
+  end
+end

data/logsnag.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/logsnag/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "logsnag-ruby"
+  spec.version = LogSnag::VERSION
+  spec.authors = ["Damon Bauer"]
+  spec.email = ["damonbauer@protonmail.com"]
+
+  spec.summary = "Unofficial LogSnag API client, written in Ruby."
+  spec.homepage = "https://github.com/damonbauer/logsnag-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["rubygems_mfa_required"] = "false"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.add_dependency "httparty", "~> 0.21.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: logsnag-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damon Bauer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+description: 
+email:
+- damonbauer@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logsnag-ruby.rb
+- lib/logsnag.rb
+- lib/logsnag/configuration.rb
+- lib/logsnag/event_base.rb
+- lib/logsnag/identify.rb
+- lib/logsnag/insight.rb
+- lib/logsnag/log.rb
+- lib/logsnag/result.rb
+- lib/logsnag/validator.rb
+- lib/logsnag/version.rb
+- logsnag.gemspec
+homepage: https://github.com/damonbauer/logsnag-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'false'
+  homepage_uri: https://github.com/damonbauer/logsnag-ruby
+  source_code_uri: https://github.com/damonbauer/logsnag-ruby
+  changelog_uri: https://github.com/damonbauer/logsnag-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+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.3.26
+signing_key: 
+specification_version: 4
+summary: Unofficial LogSnag API client, written in Ruby.
+test_files: []