logkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73647846f52c59d3282cfebaa228bdf05a0be8d883c5de812dcd04f09537ee85
+  data.tar.gz: c16e11f14bf5a3050bef2c75e6d9f998d1c24555790bfe2ba6580b767ae9818a
+SHA512:
+  metadata.gz: cd1ec8121cc63245c2a174cedd43d843bbba5957826826d8f3ffaab22b83fb20a1c4a479ae9872686217da32de5a76432dd17c62bf649acee9cc7c95c786e4f7
+  data.tar.gz: 11bdbd0ac43cd9065c7f752bd1f652483b58bac745af3ad939e5fbfb7303c7078f084e160163ca43d95981357c03019d458616a3d5ca3b33e4e14cb72fcc0365

data/README.md

@@ -0,0 +1,68 @@
+# Logkit
+
+Logkit is a Ruby client for logging events to Logkit. It provides a simple interface to send data from your Ruby or Ruby on Rails application to your Logkit endpoint.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'logkit'
+```
+
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install logkit
+```
+
+## Configuration
+
+### Ruby on Rails
+
+To configure the gem in a Rails application, you'll want to set up an initializer file where you can configure the logkit_url and other settings.
+
+Create a file config/initializers/logkit.rb:
+
+```rb
+# config/initializers/logkit.rb
+require 'logkit'
+
+Logkit::Client.logkit_url = "https://your-logkit-endpoint.com"
+Logkit::Client.mode = Rails.env.production? ? "prod" : "dev"
+```
+
+
+This configuration sets the Logkit URL and adjusts the logging mode based on the environment. In production, it logs to the Logkit service, and in development or test environments, it logs to the console.
+
+## Usage
+
+To log events, simply call the log method anywhere in your Rails application:
+
+```rb
+Logkit::Client.log("event_name", { key: "value" })
+```
+
+This will send an event named event_name with the provided payload to the configured Logkit endpoint.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run rake test 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/philipp-spiess/logkit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.
+

data/lib/logkit/version.rb

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

data/lib/logkit.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "logkit/version"
+
+module Logkit
+  class Error < StandardError; end
+
+  class Client
+    @logkit_url = nil
+    @mode = "prod"
+
+    class << self
+      attr_accessor :logkit_url, :mode
+
+      def log(event, payload)
+        return if @logkit_url.nil?
+
+        if @mode == "dev"
+          puts "[logkit] #{event}: #{payload}"
+        else
+          uri = URI(@logkit_url)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true if uri.scheme == "https"
+          request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+          request.body = { event: event, payload: payload, mode: @mode }.to_json
+          response = http.request(request)
+          puts response.body
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: logkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philipp Spiess
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-19 00:00:00.000000000 Z
+dependencies: []
+description: Next generation logging infrastructure
+email:
+- hello@philippspiess.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/logkit.rb
+- lib/logkit/version.rb
+homepage: https://logkit.co
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://logkit.co
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Ruby client for Logkit
+test_files: []