synchrolog-ruby 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d33af17dfd0c04955ae0b00157d1408fe8ce1cf
+  data.tar.gz: c840f448e5524fd3d0757ca6d9cf1b004e8f204d
+SHA512:
+  metadata.gz: 2aae13d77c66de0ea8b3009d33ca826e890ee09a32b9a6162558a1108d3a50a313b6ca247e53fa2a24801fb10ee6788f6e04ed71a7fac0272d570df2b91e6414
+  data.tar.gz: 4f0550dd7b0e5efdd06017369dde0b727f101268f4ddb9a7556a20a62cfac2fbef8e237c4837a9914b846e76209ee637317750a20c258c04c54d405f0fd1457d

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in synchrolog-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Synchrolog roberto@synchrolog.com
+
+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,54 @@
+# Synchrolog
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/synchrolog`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'synchrolog-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install synchrolog-ruby
+
+## Usage
+
+Run:
+
+    $ rails g synchrolog:install
+    
+or create file `config/initializers/synchrolog.rb` with the following content:
+```ruby
+SYNCHROLOG = Synchrolog.new('YOUR_API_KEY') 
+Rails.logger.extend(ActiveSupport::Logger.broadcast(SYNCHROLOG.logger))
+```
+
+and add this line to `config/application.rb`:
+```ruby
+config.middleware.insert_after 0, 'Synchrolog::Middleware'
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/synchrolog/synchrolog-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "synchrolog"
+
+# 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/generators/synchrolog/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/base'
+
+module Synchrolog
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a Synchrolog initializer."
+
+      def copy_initializer
+        template "synchrolog.rb", "config/initializers/synchrolog.rb"
+        application "config.middleware.insert 0, 'Synchrolog::Middleware'"
+      end      
+    end
+  end
+end

data/lib/generators/synchrolog/templates/synchrolog.rb

@@ -0,0 +1,2 @@
+SYNCHROLOG = Synchrolog.new('YOUR_API_KEY') 
+Rails.logger.extend(ActiveSupport::Logger.broadcast(SYNCHROLOG.logger))

data/lib/synchrolog/exception_logger/http.rb

@@ -0,0 +1,40 @@
+require 'net/http'
+require 'uri'
+
+module Synchrolog
+  module ExceptionLogger
+    class HTTP
+      def initialize(api_key, **args)
+        @api_key = api_key
+        @host = args[:host]
+      end
+      
+      def capture(response, exception, env, anonymous_id, user_id)
+        return unless anonymous_id
+        json_headers = {'Authorization' => "Basic #{@api_key}", 'Content-Type' =>'application/json'}
+        uri = URI.parse("#{@host}/v1/track-backend-error")
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.post(uri.path, body(response, exception, env, anonymous_id, user_id).to_json, json_headers)
+      end
+
+      def body(response, exception, env, anonymous_id, user_id)
+        status, headers, body = *response
+        return {
+          event_type: 'error', 
+          timestamp: Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.%3NZ"),
+          anonymous_id: anonymous_id,
+          user_id: user_id,
+          source: 'backend',
+          api_key: @api_key,
+          error: {
+            status: status.to_s,
+            description: exception.to_s,
+            backtrace: exception.backtrace,
+            ip_address: env['REMOTE_ADDR'],
+            user_agent: env['HTTP_USER_AGENT']
+          }
+        }
+      end
+    end
+  end
+end

data/lib/synchrolog/exception_logger/https.rb

@@ -0,0 +1,42 @@
+require 'net/https'
+require 'uri'
+
+module Synchrolog
+  module ExceptionLogger
+    class HTTPS
+      def initialize(api_key, **args)
+        @api_key = api_key
+        @host = args[:host]
+      end
+
+      def capture(response, exception, env, anonymous_id, user_id)
+        return unless anonymous_id
+        json_headers = {'Authorization' => "Basic #{@api_key}", 'Content-Type' =>'application/json'}
+        uri = URI.parse("#{@host}/v1/track-backend-error")
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+      	http.verify_mode = OpenSSL::SSL::VERIFY_NONE      
+        http.post(uri.path, body(response, exception, env, anonymous_id, user_id).to_json, json_headers)
+      end
+
+      def body(response, exception, env, anonymous_id, user_id)
+        status, headers, body = *response
+        return {
+          event_type: 'error', 
+          timestamp: Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.%3NZ"),
+          anonymous_id: anonymous_id,
+          user_id: user_id,
+          source: 'backend',
+          api_key: @api_key,
+          error: {
+            status: status.to_s,
+            description: exception.to_s,
+            backtrace: exception.backtrace,
+            ip_address: env['REMOTE_ADDR'],
+            user_agent: env['HTTP_USER_AGENT']
+          }
+        }
+      end
+    end
+  end
+end

data/lib/synchrolog/exception_logger.rb

@@ -0,0 +1,15 @@
+require 'synchrolog/exception_logger/https'
+require 'synchrolog/exception_logger/http'
+
+module Synchrolog
+  module ExceptionLogger
+    def self.new(api_key, **args)
+      args[:host] ||= 'https://input.synchrolog.com'
+      if /^https:\/\//.match(args[:host])
+        Synchrolog::ExceptionLogger::HTTPS.new(api_key, args)
+      else
+        Synchrolog::ExceptionLogger::HTTP.new(api_key, args)
+      end
+    end
+  end
+end

data/lib/synchrolog/logger/http.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+require 'uri'
+
+module Synchrolog
+  module Logger
+    class HTTP
+      def initialize(api_key, **args)
+        @api_key = api_key
+        @host = args[:host]
+      end
+
+      def write(message)
+        return unless message[:anonymous_id]
+        json_headers = {'Authorization' => "Basic #{@api_key}", 'Content-Type' =>'application/json'}
+        uri = URI.parse("#{@host}/v1/track-backend")
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.post(uri.path, body(message).to_json, json_headers)
+      end
+
+      def body(message)
+        {
+          event_type: 'log', 
+          timestamp: message[:timestamp],
+          anonymous_id: message[:anonymous_id],
+          user_id: message[:user_id],
+          source: 'backend',
+          api_key: @api_key,
+          log: message
+        }
+      end
+
+      def close
+        nil
+      end
+    end
+  end
+end

data/lib/synchrolog/logger/https.rb

@@ -0,0 +1,39 @@
+require 'net/https'
+require 'uri'
+
+module Synchrolog
+  module Logger
+    class HTTPS
+      def initialize(api_key, **args)
+        @api_key = api_key
+        @host = args[:host]
+      end
+
+      def write(message)
+        return unless message[:anonymous_id]
+        json_headers = {'Authorization' => "Basic #{@api_key}", 'Content-Type' =>'application/json'}
+        uri = URI.parse("#{@host}/v1/track-backend")
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+      	http.verify_mode = OpenSSL::SSL::VERIFY_NONE      
+        http.post(uri.path, body(message).to_json, json_headers)
+      end
+
+      def body(message)
+        {
+          event_type: 'log', 
+          timestamp: message[:timestamp],
+          anonymous_id: message[:anonymous_id],
+          user_id: message[:user_id],
+          source: 'backend',
+          api_key: @api_key,
+          log: message
+        }
+      end
+
+      def close
+        nil
+      end
+    end
+  end
+end

data/lib/synchrolog/logger.rb

@@ -0,0 +1,15 @@
+require 'synchrolog/logger/https'
+require 'synchrolog/logger/http'
+
+module Synchrolog
+  module Logger
+    def self.new(api_key, **args)
+      args[:host] ||= 'https://input.synchrolog.com'
+      if /^https:\/\//.match(args[:host])
+        Synchrolog::Logger::HTTPS.new(api_key, args)
+      else
+        Synchrolog::Logger::HTTP.new(api_key, args)
+      end
+    end
+  end
+end

data/lib/synchrolog/middleware.rb

@@ -0,0 +1,36 @@
+require 'securerandom'
+require 'json'
+
+module Synchrolog
+  class Middleware
+    def initialize app
+      @app = app
+    end
+
+    def call env
+      request = ActionDispatch::Request.new(env)
+      if request.original_fullpath == "/synchrolog-time"     
+        [ 200, {'Content-Type' => 'application/json'}, [{ time: Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.%3NZ") }.to_json] ]
+      else
+        if request.cookie_jar['synchrolog_anonymous_id'].nil?
+          request.cookie_jar['synchrolog_anonymous_id'] = SecureRandom.hex
+        end
+        anonymous_id = request.cookie_jar['synchrolog_anonymous_id']
+        user_id = request.cookie_jar['synchrolog_user_id']
+        SYNCHROLOG.logger.tagged("synchrolog_anonymous_id:#{anonymous_id}", "synchrolog_user_id:#{user_id}") do
+          begin
+            response = @app.call(env)      
+          rescue Error
+            raise # Don't capture Synchrolog errors
+          rescue Exception => exception
+            SYNCHROLOG.exception_logger.capture(response, exception, env, anonymous_id, user_id)
+            raise
+          end
+          exception = env['rack.exception'] || env['action_dispatch.exception']
+          SYNCHROLOG.exception_logger.capture(response, exception, env, anonymous_id, user_id) if exception
+          response
+        end
+      end
+    end
+  end
+end

data/lib/synchrolog/version.rb

@@ -0,0 +1,3 @@
+module Synchrolog
+  VERSION = "0.1.4"
+end

data/lib/synchrolog-ruby.rb

@@ -0,0 +1 @@
+require 'synchrolog'

data/lib/synchrolog.rb

@@ -0,0 +1,50 @@
+require 'synchrolog/version'
+require 'synchrolog/logger'
+require 'synchrolog/exception_logger'
+require 'synchrolog/middleware'
+
+require 'active_support/logger'
+require 'active_support/tagged_logging'
+ 
+module Synchrolog
+  class Client
+    def initialize(api_key, opts={})
+      @api_key = api_key
+      @opts = opts
+    end
+    
+    def logger
+      @logger ||= initialize_logger
+    end
+    
+    def exception_logger
+      @exception_logger ||= initialize_exception_logger
+    end
+    
+    private
+    
+    def initialize_logger
+      client = Synchrolog::Logger.new(@api_key, @opts)
+      logger = ActiveSupport::Logger.new(client)
+      logger.formatter = SynchrologFormatter.new
+      ActiveSupport::TaggedLogging.new(logger)
+    end
+    
+    def initialize_exception_logger
+      Synchrolog::ExceptionLogger.new(@api_key, @opts)
+    end
+
+    class SynchrologFormatter < ActiveSupport::Logger::SimpleFormatter
+      def call(severity, timestamp, progname, message)
+        anonymous_id_match = message.match(/\[synchrolog_anonymous_id:(\S*)\]/)
+        anonymous_id = anonymous_id_match.try(:[], 1)
+        message.slice!(anonymous_id_match.begin(0)..anonymous_id_match[0].length) if anonymous_id
+
+        user_id_match = message.match(/\[synchrolog_user_id:(\S*)\]/)
+        user_id = user_id_match.try(:[], 1)
+        message.slice!(user_id_match.begin(0)..user_id_match[0].length) if user_id
+        { type: severity, timestamp: timestamp.utc.iso8601(3), message: message, anonymous_id: anonymous_id, user_id: user_id }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "synchrolog"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/synchrolog_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+RSpec.describe Synchrolog do
+  it "has a version number" do
+    expect(Synchrolog::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/synchrolog-ruby.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'synchrolog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "synchrolog-ruby"
+  spec.version       = Synchrolog::VERSION
+  spec.authors       = ["Synchrolog.com"]
+  spec.email         = ["roberto@synchrolog.com"]
+
+  spec.summary       = "Synchrolog library"
+  spec.description   = "Synchrolog ruby library"
+  spec.homepage      = "https://github.com/synchrolog/synchrolog-ruby"
+  spec.license       = "MIT"
+
+  # 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'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency 'activesupport', '>= 4'
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: synchrolog-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Synchrolog.com
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Synchrolog ruby library
+email:
+- roberto@synchrolog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/synchrolog/install_generator.rb
+- lib/generators/synchrolog/templates/synchrolog.rb
+- lib/synchrolog-ruby.rb
+- lib/synchrolog.rb
+- lib/synchrolog/exception_logger.rb
+- lib/synchrolog/exception_logger/http.rb
+- lib/synchrolog/exception_logger/https.rb
+- lib/synchrolog/logger.rb
+- lib/synchrolog/logger/http.rb
+- lib/synchrolog/logger/https.rb
+- lib/synchrolog/middleware.rb
+- lib/synchrolog/version.rb
+- spec/spec_helper.rb
+- spec/synchrolog_spec.rb
+- synchrolog-ruby.gemspec
+homepage: https://github.com/synchrolog/synchrolog-ruby
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Synchrolog library
+test_files: []