deviant 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 221dace94e2713ad166d84f30ba336a514068f25
+  data.tar.gz: b9b135325edacb4b1682d053b4a9c69df43223c2
+SHA512:
+  metadata.gz: d13b19a14a96d24e9300907a46c116c818267fb145d8e7daf481dedade5a2bf2a587b8bb2f83681e5151fe6c62db2c00fc4c3949e8a7a3b415c202f4594b5eda
+  data.tar.gz: 97152e43912f6dd0cd2cdc830b354ea5cf7b1a91da1346d59fbf42be8dfec5528590555eba5ef805d706896ab2b364045264e074cfd9bc2197d10778fa4051c6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan LeFevre
+
+MIT License
+
+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,73 @@
+# Deviant
+
+An application exception logger written in Ruby and backed by elasticsearch. It can be integrated directly into your application or as Rack middleware (coming soon). Search index updates can be performed asynchronously via Sidekiq.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deviant'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deviant
+
+If you don't have elasticsearch yet, you will need to install it. Luckily it's super easy. If you're running OSX and using homebrew, simply run:
+
+```
+brew install elasticsearch
+elasticsearch -f -D es.config=/usr/local/opt/elasticsearch/config/elasticsearch.yml
+```
+
+## Configuration
+
+``` ruby
+Deviant.configure do
+  application 'my_application'
+  redis Redis.current
+  elasticsearch 'http://localhost:9292'
+  sidekiq true
+end
+```
+
+## Logging
+
+``` ruby
+begin
+  my_broken_code
+rescue => e
+  # Generic Usage
+  Deviant.exception(e)
+
+  # All methods can end with ! to re-raise the exception after logging
+  Deviant.exception!(e)
+
+  # Log extra metadata, such as HTTP statuses or User info
+  Deviant.exception(e, status: 401, user: user.email)
+end
+```
+
+## Searching
+
+``` ruby
+# Helper method
+Deviant.client.fetch("Broken").results.map(&:message)
+Deviant.client.fetch(email: 'example@example.com').results
+
+# Directly access Tire search
+Deviant.client.search do
+  query { string "email:example@example.com" }
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/deviant.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deviant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deviant"
+  spec.version       = Deviant::VERSION
+  spec.authors       = ["Ryan LeFevre"]
+  spec.email         = ["meltingice8917@gmail.com"]
+  spec.description   = %q{Elasticsearch backed exception logging}
+  spec.summary       = %q{Elasticsearch backed exception logging}
+  spec.homepage      = "https://github.com/meltingice/deviant"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq"
+  spec.add_dependency "tire"
+  spec.add_dependency "yajl-ruby"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/examples/client.rb

@@ -0,0 +1,13 @@
+require 'deviant'
+
+Deviant.configure do
+  application 'testing'
+  elasticsearch 'http://localhost:9200'
+  redis 'redis://localhost:6379'
+  # sidekiq true
+end
+
+Deviant.client.index { delete }
+Deviant.exception(StandardError.new("Fail"), user: 1)
+Deviant.exception(StandardError.new("Extra fail"), user: 2)
+Deviant.client.index { refresh }

data/examples/worker.rb

@@ -0,0 +1,8 @@
+require 'deviant'
+
+Deviant.configure do
+  application 'testing'
+  elasticsearch 'http://localhost:9200'
+  redis 'redis://localhost:6379'
+  sidekiq true
+end

data/lib/deviant/client.rb

@@ -0,0 +1,49 @@
+module Deviant
+  class Client
+    def initialize(options)
+      @options = options
+    end
+
+    def store(name, message, data = {})
+      entry = {name: name, message: message, date: Time.now}.merge(data)
+      return store_async(entry) if @options[:sidekiq][:enabled]
+
+      index { store(entry) }
+    end
+
+    def fetch(query, tags = [])
+      query = build_query(query)
+      search do
+        query { string query }
+        filter :terms, tags: tags if tags.size > 0
+        sort { by :date, 'desc' }
+      end
+    end
+
+    def index(&block)
+      Tire.index @options[:name], &block
+    end
+
+    def search(&block)
+      Tire.search @options[:name], &block
+    end
+
+    private
+
+    def store_async(entry)
+      DeviantWorker.perform_async(entry)
+    end
+
+    def build_query(query)
+      if query.is_a?(Hash)
+        return query.to_a.map { |item|
+          "#{item[0]}:#{item[1]}"
+        }.join(' AND ')
+      elsif query.is_a?(Array)
+        query.join(' AND ')
+      else
+        query
+      end
+    end
+  end
+end

data/lib/deviant/configuration.rb

@@ -0,0 +1,82 @@
+module Deviant
+  DEFAULTS = {
+    name: nil,
+    redis_url: "redis://localhost:9292",
+    elasticsearch_url: nil,
+    sidekiq: {
+      enabled: false,
+      configure_server: false,
+      configure_client: false
+    }
+  }
+
+  def self.options
+    @options ||= DEFAULTS.dup
+  end
+
+  def self.options=(opts)
+    @options = opts
+  end
+
+  def self.configure(&block)
+    class_eval &block
+    setup!
+  end
+
+  def self.application(name)
+    options[:name] = name
+  end
+
+  def self.redis(config)
+    if config.is_a?(Redis)
+      client = config.client
+      options[:redis_url] = "#{client.scheme}://#{client.host}:#{client.port}"
+    else
+      options[:redis_url] = config
+    end
+  end
+
+  def self.elasticsearch(url)
+    options[:elasticsearch_url] = url
+  end
+
+  def self.sidekiq(enabled, opts={})
+    options[:sidekiq][:enabled] = enabled
+    options[:sidekiq][:configure_server] = opts[:configure_server] || false
+    options[:sidekiq][:configure_client] = opts[:configure_client] || false
+  end
+
+  private
+
+  # A lot of 3rd party libraries are singletons, so we want to make
+  # sure we don't blow away the main application's config.
+  def self.setup!
+    @client = nil
+
+    if options[:sidekiq][:enabled]
+      if options[:sidekiq][:configure_client]
+        Sidekiq.configure_client do |config|
+          config.redis = {
+            namespace: options[:name],
+            url: options[:redis_url]
+          }
+        end
+      end
+
+      if options[:sidekiq][:configure_server]
+        Sidekiq.configure_server do |config|
+          config.redis = {
+            namespace: options[:name],
+            url: options[:redis_url]
+          }
+        end
+      end
+    end
+
+    if options[:elasticsearch_url]
+      Tire.configure do
+        url Deviant.options[:elasticsearch_url]
+      end
+    end
+  end
+end

data/lib/deviant/log.rb

@@ -0,0 +1,14 @@
+module Deviant
+  def self.exception(e, data = {})
+    client.store e.class.name, e.message, data
+  end
+
+  def self.method_missing(method, *args, &block)
+    if args.length > 0 && method.to_s[-1] == '!' && respond_to?(method.to_s[0...-1])
+      send method.to_s[0...-1], *args, &block
+      raise args.first
+    end
+
+    super
+  end
+end

data/lib/deviant/version.rb

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

data/lib/deviant/worker.rb

@@ -0,0 +1,9 @@
+class DeviantWorker
+  include Sidekiq::Worker
+
+  def perform(data)
+    Tire.index Deviant.options[:name] do
+      store(data)
+    end
+  end
+end

data/lib/deviant.rb

@@ -0,0 +1,15 @@
+require "tire"
+require "sidekiq"
+require "yajl/json_gem"
+
+require "deviant/configuration"
+require "deviant/client"
+require "deviant/log"
+require "deviant/worker"
+require "deviant/version"
+
+module Deviant
+  def self.client
+    @client ||= Client.new(options)
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: deviant
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan LeFevre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: tire
+  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: yajl-ruby
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Elasticsearch backed exception logging
+email:
+- meltingice8917@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- deviant.gemspec
+- examples/client.rb
+- examples/worker.rb
+- lib/deviant.rb
+- lib/deviant/client.rb
+- lib/deviant/configuration.rb
+- lib/deviant/log.rb
+- lib/deviant/version.rb
+- lib/deviant/worker.rb
+homepage: https://github.com/meltingice/deviant
+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.0.8
+signing_key: 
+specification_version: 4
+summary: Elasticsearch backed exception logging
+test_files: []