everylog_ruby_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a41febdaeb7e75805abe0fb888b1967757bbeb652ebc6178329f74035a578cfc
+  data.tar.gz: '08e6751b3e68e5151769e28b6422ef439be51ca215bf9f2761431539ff5f6b53'
+SHA512:
+  metadata.gz: 0ff1922e485792cae0c20d20c889eed0365f6af4cc297685fb7e0a1ca03fb6ce99983ec7321c947a3b4a190533561f712dd28280113248ddd5fd7b19f88fd70d
+  data.tar.gz: 072bc8c0756b36d07b110d4bc958f07dc2083c7a19418c2388ac94521474bf4be2f78f10da97bc47443c9e526e513da09744797cc7ae327ae2ca9bc75ad363b9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2022-04-22
+
+- Initial release

data/README.md

@@ -0,0 +1,50 @@
+# EveryLog Ruby Client
+
+A fantastic (and simple) gem to interact with the EveryLog API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'everylog_ruby_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install everylog_ruby_client
+
+## Usage
+```ruby
+require 'everylog_ruby_client'
+
+# @param [Hash] options
+# @option options [String] :api_key for authenticate against EveryLog server
+# @option options [String] :everylog_url (https://api.everylog.io/api/v1/log-entries) to reach Everlog server
+$EveryLogClient = EveryLog::Client.instance.setup(api_key: <YOUR_API_KEY>)
+
+# @param [Hash] options
+# @option options [String]  :projectId name of the project
+# @option options [String]  :title to display in the application and if enabled in the notification
+# @option options [String]  :summary is a not so long text to display on the application and if enabled in the notification
+# @option options [String]  :body it can contain a long text simple formatted, no html to display in the application
+# @option options [Array]   :tags it can be used to categorize the notification, must be strings
+# @option options [String]  :link it can be used to display on the application and if enabled in the notification
+# @option options [Boolean] :push if True, a push notification is sent to application
+$EveryLogClient.notify(...)
+```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/everylogsaas/everylog_ruby_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/everylogsaas/everylog_ruby_client/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EveryLog ruby client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/everylogsaas/everylog_ruby_client/blob/master/CODE_OF_CONDUCT.md).

data/lib/everylog_ruby_client/version.rb

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

data/lib/everylog_ruby_client.rb

@@ -0,0 +1,76 @@
+require_relative "everylog_ruby_client/version"
+require "singleton"
+require "uri"
+require "net/http"
+require "json"
+
+module EveryLog
+  class Client
+    include ::Singleton
+
+    SETUP_DEFAULTS = {
+      api_key: nil,
+      everylog_url: "https://api.everylog.io/api/v1/log-entries"
+    }.freeze
+
+    NOTIFY_DEFAULTS = {
+      projectId: nil,
+      title: nil,
+      summary: nil,
+      body: nil,
+      tags: [],
+      link: "",
+      push: false
+    }.freeze
+
+    attr_reader :options
+
+    # @param [Hash] options
+    # @option options [String] :api_key for authenticate against Everylog server
+    # @option options [String] :everylog_url (https://api.everylog.io/api/v1/log-entries) to reach Everlog server
+    def setup(options = {})
+      @options = _parse_options(options, SETUP_DEFAULTS)
+      self
+    end
+
+    # @param [Hash] options
+    # @option options [String]  :projectId name of the project
+    # @option options [String]  :title to display in the application and if enabled in the notification
+    # @option options [String]  :summary is a not so long text to display on the application and if enabled in the notification
+    # @option options [String]  :body it can contain a long text simple formatted, no html to display in the application
+    # @option options [Array]   :tags it can be used to categorize the notification, must be strings
+    # @option options [String]  :link it can be used to display on the application and if enabled in the notification
+    # @option options [Boolean] :push if True, a push notification is sent to application
+    def notify(notify_options = {})
+      @notify_options = _parse_options(notify_options, NOTIFY_DEFAULTS)
+      uri = URI(options[:everylog_url])
+      req = Net::HTTP::Post.new(uri, {
+                                  "Content-Type": "application/json",
+                                  "Authorization": "Bearer #{options[:api_key]}"
+                                })
+      req.body = @notify_options.to_json
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+      res.body
+    end
+
+    private
+
+    def _parse_options(options, defaults_to_dup)
+      defaults = defaults_to_dup.dup
+      result_parsed_options = options.dup
+
+      defaults.each_key do |key|
+        defaults[key] = defaults[key].call if defaults[key].respond_to?(:call)
+        result_parsed_options[key] = result_parsed_options[key.to_s] if result_parsed_options.key?(key.to_s)
+      end
+
+      defaults.each_key do |key|
+        result_parsed_options[key] = defaults[key] if result_parsed_options[key].nil?
+      end
+
+      result_parsed_options
+    end
+  end  
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: everylog_ruby_client
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Gilberto Maccacaro
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-22 00:00:00.000000000 Z
+dependencies: []
+description: "    A simple Ruby with no external dependencies, to easily integrate
+  with Everylog API\n"
+email:
+- gilberto.maccacaro@devinterface.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/everylog_ruby_client.rb
+- lib/everylog_ruby_client/version.rb
+homepage: https://github.com/everylogsaas/everylog_ruby_client
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/everylogsaas/everylog_ruby_client/issues
+  changelog_uri: https://github.com/everylogsaas/everylog_ruby_client/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/everylog_ruby_client/1.0.1
+  homepage_uri: https://github.com/everylogsaas/everylog_ruby_client
+  source_code_uri: https://github.com/everylogsaas/everylog_ruby_client/tree/v1.0.1
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A Ruby client library for Everylog API
+test_files: []