sapience 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b51a1bdbf72bc1ea60b09d75b32a6f78f0ed143
+  data.tar.gz: 87a7710812da15bc3cdb80eb2cdedd1681658cd8
+SHA512:
+  metadata.gz: 25c9ac8836d07d4ec09623176e2b12b603be340073b7061f42d28e9378dfc853a8ea4fa667f31d2a544b3d7afe02508459f47759867f6a1dc32277862d18fb6b
+  data.tar.gz: a52fbcd6f66d607db46b44b074ff943b066a5fd88c5f03916745f395f9032334acd4839a9d612948fdd21e416e987beb424981ac6076f7e0d45935b7e02554d0

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: 2pF5ERW8NKVYqrkGeGTvzGP7oYLidlQ41

data/.gitignore

@@ -0,0 +1,13 @@
+Gemfile.lock
+spec/examples.txt
+coverage/
+.DS_Store
+.idea
+log/
+
+/.bundle/
+
+**/*.sqlite3
+
+**/examples.txt
+**/*.gem

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.simplecov

@@ -0,0 +1,15 @@
+require "simplecov-json"
+require "coveralls"
+Coveralls.wear!
+
+SimpleCov.refuse_coverage_drop
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::JSONFormatter,
+]
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/bin/"
+  add_filter "/gemfiles/"
+end

data/.travis.yml

@@ -0,0 +1,27 @@
+sudo: false
+language: ruby
+cache: bundler
+before_install:
+  - rvm get head
+  - gem update --system
+  - gem install bundler
+install:
+  - bundle install -j8 -r3
+script:
+  - if [[ "${STYLE}" = "true" ]]; then bundle exec rake reevoocop; fi;
+  - bundle exec rspec spec
+rvm:
+  - jruby-9.0.5.0
+  - rbx-3.9
+  - 2.2.4
+env: STYLE=false
+
+matrix:
+  fast_finish: true
+  include:
+    - rvm: 2.3.1
+      env: STYLE=true
+
+addons:
+  code_climate:
+    repo_token:

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mikael@zoolutions.se. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sapience.gemspec
+gemspec
+
+gem "pry-nav"
+gem "sentry-raven"
+gem "statsd-ruby"
+gem "minitest_to_rspec"
+gem "transpec"
+gem "codeclimate", require: false
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mikael Henriksson
+
+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,43 @@
+# Sapience
+
+[![Code Climate](https://codeclimate.com/github/reevoo/sapience-rb/badges/gpa.svg)](https://codeclimate.com/github/reevoo/sapience-rb)[![Test Coverage](https://codeclimate.com/github/reevoo/sapience-rb/badges/coverage.svg)](https://codeclimate.com/github/reevoo/sapience-rb/coverage)[![Issue Count](https://codeclimate.com/github/reevoo/sapience-rb/badges/issue_count.svg)](https://codeclimate.com/github/reevoo/sapience-rb)
+
+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/sapience`. 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 'sapience'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sapience
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/reevoo/sapience. 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,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+begin
+  require "reevoocop/rake_task"
+  ReevooCop::RakeTask.new(:reevoocop) do |task|
+    task.options = ["-D"]
+  end
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+end
+task default: [:reevocop, :spec]

data/bin/console

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

@@ -0,0 +1,27 @@
+module Sapience
+  # Formatting & colors used by optional color formatter
+  module AnsiColors
+    CLEAR     = "\e[0m"
+    BOLD      = "\e[1m"
+    BLACK     = "\e[30m"
+    RED       = "\e[31m"
+    GREEN     = "\e[32m"
+    YELLOW    = "\e[33m"
+    BLUE      = "\e[34m"
+    MAGENTA   = "\e[35m"
+    CYAN      = "\e[36m"
+    WHITE     = "\e[37m"
+
+    # Maps the log level to a color for colorized formatters
+    # Since this map is not frozen, it can be modified as needed
+    LEVEL_MAP = {
+      trace: MAGENTA,
+      debug: GREEN,
+      info:  CYAN,
+      warn:  BOLD,
+      error: RED,
+      fatal: RED,
+    }
+  end
+
+end

data/lib/sapience/appender/file.rb

@@ -0,0 +1,138 @@
+# File appender
+#
+#   Writes log messages to a file or open iostream
+#
+module Sapience
+  module Appender
+    class File < Sapience::Subscriber
+
+      # Create a File Logger appender instance.
+      #
+      # Parameters
+      #  :file_name [String|IO]
+      #    Name of file to write to.
+      #    Or, an IO stream to which to write the log message to.
+      #
+      #  :level [:trace | :debug | :info | :warn | :error | :fatal]
+      #    Override the log level for this appender.
+      #    Default: Sapience.config.default_level
+      #
+      #  :formatter: [Object|Proc]
+      #    An instance of a class that implements #call, or a Proc to be used to format
+      #    the output from this appender
+      #    Default: Use the built-in formatter (See: #call)
+      #
+      #  :filter [Regexp|Proc]
+      #    RegExp: Only include log messages where the class name matches the supplied
+      #    regular expression. All other messages will be ignored.
+      #    Proc: Only include log messages where the supplied Proc returns true
+      #          The Proc must return true or false.
+      #
+      # Example
+      #    require 'sapience'
+      #
+      #    # Enable trace level logging
+      #    Sapience.config.default_level = :info
+      #
+      #    # Log to screen
+      #    Sapience.add_appender(:file, io: STDOUT, formatter: :color)
+      #
+      #    # And log to a file at the same time
+      #    Sapience::Logger.add_appender(:file, file_name: 'application.log', formatter: :color)
+      #
+      #    logger = Sapience['test']
+      #    logger.info 'Hello World'
+      #
+      # Example 2. To log all levels to file and only :info and above to screen:
+      #
+      #    require 'sapience'
+      #
+      #    # Enable trace level logging
+      #    Sapience.config.default_level = :trace
+      #
+      #    # Log to screen but only display :info and above
+      #    Sapience.add_appender(:file, io: STDOUT, level: :info)
+      #
+      #    # And log to a file at the same time, including all :trace level data
+      #    Sapience.add_appender(:file, file_name: 'application.log')
+      #
+      #    logger =  Sapience['test']
+      #    logger.info 'Hello World'
+      def initialize(options = {}, deprecated_level = nil, deprecated_filter = nil, &block)
+        # Old style arguments: (file_name, level=nil, filter=nil, &block)
+        options =
+          if options.is_a?(Hash)
+            options.dup
+          else
+            file_name = options
+            opts      = {}
+            if file_name.respond_to?(:write) && file_name.respond_to?(:close)
+              opts[:io] = file_name
+            else
+              opts[:file_name] = file_name
+            end
+            opts[:level]  = deprecated_level if deprecated_level
+            opts[:filter] = deprecated_filter if deprecated_filter
+            opts
+          end
+
+        if io = options.delete(:io)
+          @log = io
+        else
+          @file_name = options.delete(:file_name)
+          fail "Sapience::Appender::File missing mandatory parameter :file_name or :io" unless @file_name
+          reopen
+        end
+
+        # Set the log level and formatter if supplied
+        super(options, &block)
+      end
+
+      # After forking an active process call #reopen to re-open
+      # open the file handles etc to resources
+      #
+      # Note: This method will only work if :file_name was supplied
+      #       on the initializer.
+      #       If :io was supplied, it will need to be re-opened manually.
+      def reopen
+        return unless @file_name
+        ensure_folder_exist
+
+        @log      = open(@file_name, (::File::WRONLY | ::File::APPEND | ::File::CREAT))
+        # Force all log entries to write immediately without buffering
+        # Allows multiple processes to write to the same log file simultaneously
+        @log.sync = true
+        @log.set_encoding(Encoding::BINARY) if @log.respond_to?(:set_encoding)
+        @log
+      end
+
+      def ensure_folder_exist
+        return if ::File.exist?(@file_name)
+
+        dir_name = ::File.dirname(@file_name)
+
+        FileUtils.mkdir_p(dir_name)
+      end
+
+      # Pass log calls to the underlying Rails, log4j or Ruby logger
+      #  trace entries are mapped to debug since :trace is not supported by the
+      #  Ruby or Rails Loggers
+      def log(log)
+        return false unless should_log?(log)
+
+        # Since only one appender thread will be writing to the file at a time
+        # it is not necessary to protect access to the file with a semaphore
+        # Allow this logger to filter out log levels lower than it's own
+        @log.write(formatter.call(log, self) << "\n")
+        true
+      end
+
+      # Flush all pending logs to disk.
+      #  Waits for all sent documents to be writted to disk
+      def flush
+        @log.flush if @log.respond_to?(:flush)
+      end
+
+    end
+  end
+end

data/lib/sapience/appender/sentry.rb

@@ -0,0 +1,72 @@
+begin
+  require "sentry-raven"
+rescue LoadError
+  raise 'Gem sentry-raven is required for logging purposes. Please add the gem "sentry-raven" to your Gemfile.'
+end
+
+# Send log messages to sentry
+#
+# Example:
+#   Sapience.add_appender(:sentry, {})
+#
+class Sapience::Appender::Sentry < Sapience::Subscriber
+  # Create Appender
+  #
+  # Parameters
+  #   level: [:trace | :debug | :info | :warn | :error | :fatal]
+  #     Override the log level for this appender.
+  #     Default: :error
+  #
+  #   formatter: [Object|Proc|Symbol|Hash]
+  #     An instance of a class that implements #call, or a Proc to be used to format
+  #     the output from this appender
+  #     Default: Use the built-in formatter (See: #call)
+  #
+  #   filter: [Regexp|Proc]
+  #     RegExp: Only include log messages where the class name matches the supplied.
+  #     regular expression. All other messages will be ignored.
+  #     Proc: Only include log messages where the supplied Proc returns true
+  #           The Proc must return true or false.
+  #
+  #   host: [String]
+  #     Name of this host to appear in log messages.
+  #     Default: Sapience.config.host
+  #
+  #   application: [String]
+  #     Name of this application to appear in log messages.
+  #     Default: Sapience.config.application
+  def initialize(options = {}, &block)
+    options         = options.is_a?(Hash) ? options.dup : { level: options }
+    options[:level] ||= :error
+
+    super(options, &block)
+  end
+
+  # Send an error notification to sentry
+  def log(log)
+    return false unless should_log?(log)
+
+    context = formatter.call(log, self)
+    if log.exception
+      context.delete(:exception)
+      Raven.capture_exception(log.exception, context)
+    else
+      message = {
+        error_class:   context.delete(:name),
+        error_message: context.delete(:message),
+        context: context,
+      }
+      message[:backtrace] = log.backtrace if log.backtrace
+      Raven.capture_message(message[:error_message], message)
+    end
+    true
+  end
+
+  private
+
+  # Use Raw Formatter by default
+  def default_formatter
+    Sapience::Formatters::Raw.new
+  end
+
+end

data/lib/sapience/appender/statsd.rb

@@ -0,0 +1,68 @@
+require "uri"
+begin
+  require "statsd-ruby"
+rescue LoadError
+  raise 'Gem statsd-ruby is required for logging metrics. Please add the gem "statsd-ruby" to your Gemfile.'
+end
+
+# Example:
+#   Sapience.add_appender(:statsd, {url: "udp://localhost:2222"})
+#
+class Sapience::Appender::Statsd < Sapience::Subscriber
+  # Create Appender
+  #
+  # Parameters:
+  #   url: [String]
+  #     Valid URL to post to.
+  #     Example:
+  #       udp://localhost:8125
+  #     Example, send all metrics to a particular namespace:
+  #       udp://localhost:8125/namespace
+  #     Default: udp://localhost:8125
+  def initialize(options = {}, &block)
+    options = options.is_a?(Hash) ? options.dup : { level: options }
+    url     = options.delete(:url) || "udp://localhost:8125"
+    uri     = URI.parse(url)
+    fail('Statsd only supports udp. Example: "udp://localhost:8125"') if uri.scheme != "udp"
+
+    @statsd           = ::Statsd.new(uri.host, uri.port)
+    path              = uri.path.chomp("/")
+    @statsd.namespace = path.sub("/", "") if path != ""
+
+    super(options, &block)
+  end
+
+  # Send an error notification to sentry
+  def log(log)
+    metric = log.metric
+    return false unless metric
+
+    if log.duration
+      timing(metric, log.duration)
+    else
+      amount = (log.metric_amount || 1).round
+      if amount < 0
+        decrement(metric, amount)
+      else
+        increment(metric, amount)
+      end
+    end
+    true
+  end
+
+  def timing(metric, duration)
+    @statsd.timing(metric, duration)
+  end
+
+  def increment(metric, amount)
+    @statsd.batch do
+      amount.times { @statsd.increment(metric) }
+    end
+  end
+
+  def decrement(metric, amount)
+    @statsd.batch do
+      amount.abs.times { @statsd.decrement(metric) }
+    end
+  end
+end

data/lib/sapience/appender/wrapper.rb

@@ -0,0 +1,74 @@
+# Send log messages to any standard Ruby logging class.
+#
+#  Forwards logging call to loggers such as Logger, log4r, etc.
+#
+module Sapience
+  module Appender
+    class Wrapper < Sapience::Subscriber
+      attr_reader :logger
+
+      # Forward all logging calls to the supplied logging instance.
+      #
+      # Parameters
+      #   logger: [Object]
+      #     Instance of an existing logger conforming to the Ruby Logger methods.
+      #
+      #   level: [:trace | :debug | :info | :warn | :error | :fatal]
+      #     Override the log level for this appender.
+      #     Default: Sapience.config.default_level
+      #
+      #   formatter: [Object|Proc]
+      #     An instance of a class that implements #call, or a Proc to be used to format
+      #     the output from this appender
+      #     Default: Use the built-in formatter (See: #call)
+      #
+      #   filter: [Regexp|Proc]
+      #     RegExp: Only include log messages where the class name matches the supplied.
+      #     regular expression. All other messages will be ignored.
+      #     Proc: Only include log messages where the supplied Proc returns true
+      #           The Proc must return true or false.
+      #
+      # Ruby Logger
+      #    require 'logger'
+      #    require 'sapience'
+      #
+      #    ruby_logger = Logger.new(STDOUT)
+      #    Sapience.add_appender(:wrapper, logger: ruby_logger)
+      #
+      #    logger =  Sapience['test']
+      #    logger.info('Hello World', some: :payload)
+      #
+      def initialize(options, &block)
+        # Backward compatibility
+        options = { logger: options } unless options.is_a?(Hash)
+        options = options.dup
+        @logger = options.delete(:logger)
+
+        # Check if the custom appender responds to all the log levels. For example Ruby ::Logger
+        if does_not_implement = LEVELS[1..-1].find { |i| !@logger.respond_to?(i) }
+          fail(ArgumentError, "Supplied logger does not implement:#{does_not_implement}. It must implement all of #{LEVELS[1..-1].inspect}")
+        end
+
+        fail "Sapience::Appender::Wrapper missing mandatory parameter :logger" unless @logger
+        super(options, &block)
+      end
+
+      # Pass log calls to the underlying Rails, log4j or Ruby logger
+      #  trace entries are mapped to debug since :trace is not supported by the
+      #  Ruby or Rails Loggers
+      def log(log)
+        return false unless should_log?(log)
+
+        @logger.send(log.level == :trace ? :debug : log.level, formatter.call(log, self))
+        true
+      end
+
+      # Flush all pending logs to disk.
+      #  Waits for all sent documents to be writted to disk
+      def flush
+        @logger.flush if @logger.respond_to?(:flush)
+      end
+
+    end
+  end
+end