gn-tracker 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6d17c1fe62491b91eba0a5e0e7369b7acd20b10ee37675ea333e2e0b13baef0
+  data.tar.gz: 99523c2972eaf4bcd9161c18312fa2e1a425fafacbffeb4577d7c6f2d636d8dd
+SHA512:
+  metadata.gz: f72a03588f668e0fc2a6df6c8d3bb4bf8351eb993ff4a09d492d098eeef6fb5a3f5c3fe09fa2072b308288eb6f01762b15217805a5b7949fcab893443c5dc4f7
+  data.tar.gz: c31a0ecfacc2a2972fe333bc31bb4f863babf8f77cee2316d6f7b14c87ef4695ffa45bc65a2dfa9339957f32dbae4fd5a7ff5dcaf80f5b84e959ab2bdf340ad6

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+/.bundle
+/tmp
+/vendor/bundle

data/.rubocop-https---raw-githubusercontent-com-getninjas-dotfiles-master--rubocop-yml

@@ -0,0 +1,83 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - bin/*
+    - config.ru
+    - config/application.rb
+    - config/boot.rb
+    - config/environment.rb
+    - config/environments/development.rb
+    - config/environments/production.rb
+    - config/environments/test.rb
+    - config/initializers/airbrake.rb
+    - config/initializers/application_controller_renderer.rb
+    - config/initializers/backtrace_silencers.rb
+    - config/initializers/cookies_serializer.rb
+    - config/initializers/filter_parameter_logging.rb
+    - config/initializers/inflections.rb
+    - config/initializers/mime_types.rb
+    - config/initializers/wrap_parameters.rb
+    - config/puma.rb
+    - config/spring.rb
+    - db/schema.rb
+    - db/seeds/**/*
+    - Gemfile.lock
+    - Rakefile
+    - script/rails
+
+Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/LineLength:
+  Max: 120
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+RSpec/EmptyExampleGroup:
+  Exclude:
+    - spec/factories/*
+
+RSpec/EmptyLineAfterExampleGroup:
+  Exclude:
+    - spec/factories/*
+
+RSpec/MissingExampleGroupArgument:
+  Exclude:
+    - spec/factories/*
+
+SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%I': '[]'
+    '%r': ()
+    '%w': '[]'
+    '%W': '[]'
+
+Style/PercentQLiterals:
+  EnforcedStyle: upper_case_q
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - https://raw.githubusercontent.com/getninjas/dotfiles/master/.rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+
+rvm:
+  - 2.1.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,7 @@
+# Contributor Code of Conduct
+
+The GetNinjas team is committed to fostering a welcoming community.
+
+**Our Code of Conduct can be found here**:
+
+https://www.contributor-covenant.org/version/1/4/code-of-conduct

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    gn-tracker (0.4.0)
+      logstash-logger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.3)
+    logstash-event (1.2.02)
+    logstash-logger (0.26.1)
+      logstash-event (~> 1.2)
+    method_source (0.9.2)
+    parallel (1.17.0)
+    parser (2.6.4.1)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (13.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.3)
+    rubocop (0.75.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.36.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  gn-tracker!
+  pry-byebug
+  rake
+  rspec
+  rubocop-performance
+  rubocop-rspec
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 GetNinjas
+
+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,82 @@
+### Installation
+
+```ruby
+gem 'gn-tracker'
+```
+
+### Configuration
+
+```ruby
+require "gn/tracker"
+
+Gn::Tracker.configure do |config|
+  config.application = "YourApp"
+  config.path = "/var/www/example/shared/logstash"
+end
+```
+
+### Unstruct Event
+
+Just call `track_unstruct_event` method:
+
+```ruby
+require "gn/tracker"
+
+tracker = Gn::Tracker.new
+tracker.track_unstruct_event(message: { a: 1 }, schema: "iglu:br.com.example.com/schema/1.0.0")
+```
+
+The attributes `message` and `schema` are mandatory. If you want to send an event for a different application, you can specify an `application`:
+
+```ruby
+require "gn/tracker"
+
+tracker = Gn::Tracker.new
+
+tracker.track_unstruct_event(
+  message: { a: 1 },
+  schema: "iglu:br.com.example.com/schema/1.0.0",
+  application: "Kituno"
+)
+```
+
+You can pass the argument `true_timestamp` (in milliseconds):
+
+```ruby
+require "gn/tracker"
+
+tracker = Gn::Tracker.new
+tracker.track_unstruct_event(
+  message: { a: 1 },
+  schema: "iglu:br.com.example.com/schema/1.0.0",
+  application: "Kituno",
+  true_timestamp: "1509471096577"
+)
+```
+
+and pass the argument `contexts` (array with aditional contexts):
+
+```ruby
+require "gn/tracker"
+
+contexts = [
+  {
+    schema: "iglu:br.com.example.com/another_schema/1.0.0",
+    message: { b: 2 }
+  },
+
+  {
+    schema: "iglu:br.com.example.com/third_schema/1.0.0",
+    message: { c: 3 }
+  }
+]
+
+tracker = Gn::Tracker.new
+
+tracker.track_unstruct_event(
+  message: { a: 1 },
+  schema: "iglu:br.com.example.com/schema/1.0.0",
+  application: "Kituno",
+  contexts: contexts
+)
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gn/tracker"
+
+# 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

data/bin/setup

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

data/gn-tracker.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gn/tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.authors       = ["GetNinjas"]
+  spec.bindir        = "exe"
+  spec.email         = ["tech@getninjas.com.br"]
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.homepage      = "http://www.getninjas.com.br"
+  spec.license       = "MIT"
+  spec.name          = "gn-tracker"
+  spec.require_paths = ["lib"]
+  spec.summary       = "Gem which encapsulates logstash-logger"
+  spec.version       = Gn::Tracker::VERSION
+
+  spec.add_runtime_dependency "logstash-logger"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rspec"
+end

data/lib/gn/tracker.rb

@@ -0,0 +1,52 @@
+require "gn/tracker/version"
+require "logstash-logger"
+
+module Gn
+  class Tracker
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def initialize
+      @logger = LogStashLogger.new(
+        type: :file,
+        sync: true,
+        path: self.class.configuration.path
+      )
+    end
+
+    def track_unstruct_event(
+      message:,
+      schema:,
+      application: self.class.configuration.application,
+      true_timestamp: DateTime.now.strftime('%Q'),
+      contexts: []
+    )
+      event = LogStash::Event.new(
+        message: message.to_json,
+        application: application,
+        schema: schema,
+        true_timestamp: true_timestamp,
+        contexts: contexts.to_json
+      )
+      @logger.info event
+    end
+
+    class Configuration
+      attr_accessor :application, :path
+
+      def initialize
+        @application = ENV.fetch('GN_TRACKER_APPLICATION') { 'GN_TRACKER' }
+        @path = '/tmp/logstash'
+      end
+    end
+  end
+end

data/lib/gn/tracker/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gn
+  class Tracker
+    VERSION = "0.4.0"
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: gn-tracker
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- GetNinjas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-logger
+  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: '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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop-performance
+  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: rubocop-rspec
+  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'
+description: 
+email:
+- tech@getninjas.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop-https---raw-githubusercontent-com-getninjas-dotfiles-master--rubocop-yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gn-tracker.gemspec
+- lib/gn/tracker.rb
+- lib/gn/tracker/version.rb
+homepage: http://www.getninjas.com.br
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Gem which encapsulates logstash-logger
+test_files: []