sentinel-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b064ea2eec5598bba6f8db62610e32ae945bf7c0
+  data.tar.gz: e6b01bfe600a91930174388bf5140cdf21805211
+SHA512:
+  metadata.gz: 66971e1bc851b3398ba577b8a6acc78b390a81d10c9e490bd664bbe957dabcef6e5ebdf8e2b882b94601af331c11d8db97cbbffc80d9890a2b8a4fe383388d22
+  data.tar.gz: 720e8b9f337175886b4c81eead1485485eb3d5c47b4e9082de6af36735a059e4a00b84186c1aeea2d8594dc5b3ab33ff0d6ac20b5234bbbc8dd60dbc17d9f12c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea/
+.rspec

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sentinel.gemspec
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+# Sentinel
+
+This is a gem for ErrorReportApi server integration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sentinel-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sentinel-api
+
+## Usage
+
+There are 3 methods, which produce 3 log level messages:
+info, warn, error.
+
+You can use this gem in 3 ways: 
+ * provide hash with 3 keys: message, info, tags
+ * provide message, exception and tags - info would be made from exception's class message and backtrace
+ * provide message and exception - no tags would be sent
+```ruby
+Sentinel.info({ message: 'your custom error message', info: 'system info or other information', tags: ['tag1', 'tag2']})
+Sentinel.warn('your message', exception, ['tag1', 'tag2'])
+Sentinel.error('your message', exception)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sentinel"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sentinel.rb

@@ -0,0 +1,28 @@
+require "sentinel/version"
+require 'sentinel/configuration'
+require 'sentinel/notifier'
+require 'sentinel/api_client'
+require 'forwardable'
+
+module Sentinel
+  PUBLIC_NOTIFIER_METHODS = %w(warn info error).freeze
+  class << self
+    extend Forwardable
+
+    def_delegators :notifier, *PUBLIC_NOTIFIER_METHODS
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def notifier
+      Notifier
+    end
+
+    def default_logger
+      configuration.default_logger
+    end
+
+  end
+
+end

data/lib/sentinel/api_client.rb

@@ -0,0 +1,29 @@
+require 'httparty'
+
+module Sentinel
+  class ApiClient
+    class << self
+      def send_to_server(record)
+        response = ::HTTParty.public_send(configuration.method, configuration.uri, prepare_request(record))
+        unless response.code == 200
+          Sentinel.default_logger.warn("We sent logs(#{record}) to API Server and got #{response.code} instead of status")
+        end
+      rescue => e
+        Sentinel.default_logger.warn("Troubles with ErrorReporter API call\n #{e.message}\n #{e.backtrace}")
+      end
+
+      private
+
+      def prepare_request(record)
+        {
+            headers: { 'Content-Type' => 'application/json' },
+            body: { request_params: record }.to_json
+        }
+      end
+
+      def configuration
+        Sentinel.configuration
+      end
+    end
+  end
+end

data/lib/sentinel/configuration.rb

@@ -0,0 +1,50 @@
+require 'logger'
+module Sentinel
+  class Configuration
+    attr_accessor :uri
+    attr_accessor :level
+    attr_accessor :method
+
+    DEFAULT_URI = (ENV['sentinel_uri'] || 'http://localhost:3000/reports').freeze
+    DEFAULT_LEVEL = (ENV['sentinel_level'] || 'INFO').freeze
+    DEFAULT_METHOD = (ENV['sentinel_method'] || 'post').freeze
+
+    def initialize(uri:, level:, method:)
+      @uri = uri
+      @level = level
+      @method = method
+    end
+
+    def initialize
+      @uri = DEFAULT_URI
+      @level = DEFAULT_LEVEL
+      @method = DEFAULT_METHOD
+    end
+
+    def merge(options)
+      new_configuration = clone
+      new_configuration.merge!(options)
+
+      new_configuration
+    end
+
+    def merge!(options)
+      options.each do |name, value|
+        variable_name = "@#{name}"
+        next unless instance_variable_defined?(variable_name)
+
+        instance_variable_set(variable_name, value)
+      end
+
+      self
+    end
+
+    def default_logger
+      @default_logger ||= defined?(::Rails) ? ::Rails.logger : ::Logger.new(STDERR)
+    end
+
+    def use_ssl?
+      uri.match(/^https:/) ? true : false
+    end
+  end
+end

data/lib/sentinel/notifier.rb

@@ -0,0 +1,66 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+module Sentinel
+  class Notifier
+    class << self
+
+      def warn(*args)
+        log('WARN', args)
+      end
+
+      def info(*args)
+        log('INFO', args)
+      end
+
+      def error(*args)
+        log('ERROR', args)
+      end
+
+      private_class_method
+
+      def log(level = nil, args)
+        level ||= configuration.level
+        message, info, tags = extract_arguments(args)
+
+        Sentinel::ApiClient.send_to_server({ level: level, message: message, info: info, tags: tags })
+      end
+
+      def extract_arguments(args)
+        message = nil
+        exception = nil
+        tags = nil
+        if args.count == 1 && args[0].is_a?(Hash)
+          result = args[0].with_indifferent_access
+          return [result[:message], result[:info], result[:tags]]
+        else
+          args.each do |arg|
+            if arg.is_a?(String)
+              message = arg
+            elsif arg.is_a?(Exception)
+              exception = arg
+            elsif RUBY_PLATFORM == 'java' && arg.is_a?(java.lang.Exception)
+              exception = arg
+            elsif arg.is_a?(Array)
+              tags = arg
+
+              tags = nil if tags.empty?
+            end
+          end
+        end
+
+        [message, prepare_info(exception), tags]
+      end
+
+      def prepare_info(exception)
+        "#{exception.class}: #{exception.message}, \n#{exception.backtrace.join("\n")}"
+      rescue
+        "#{exception.class}: #{exception.message}"
+      end
+
+
+      def configuration
+        Sentinel.configuration
+      end
+    end
+  end
+end

data/lib/sentinel/version.rb

@@ -0,0 +1,3 @@
+module Sentinel
+  VERSION = "0.0.1"
+end

data/sentinel.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sentinel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sentinel-api"
+  spec.version       = Sentinel::VERSION
+  spec.authors       = ["Edvard Loktev"]
+  spec.email         = ["edvardloktev@gmail.com"]
+
+  spec.summary       = %q{Gem to connect to ErrorReporterAPI}
+  spec.description   = %q{Gem to connect to ErrorReporterAPI}
+  spec.homepage      = "https://gitlab.com/intelllex/sentinel"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+  spec.add_dependency 'activesupport'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: sentinel-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Edvard Loktev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Gem to connect to ErrorReporterAPI
+email:
+- edvardloktev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sentinel.rb
+- lib/sentinel/api_client.rb
+- lib/sentinel/configuration.rb
+- lib/sentinel/notifier.rb
+- lib/sentinel/version.rb
+- sentinel.gemspec
+homepage: https://gitlab.com/intelllex/sentinel
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Gem to connect to ErrorReporterAPI
+test_files: []