rnotifier 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2114e0d1bbcc910c636ec5bb458b464a83032f7
-  data.tar.gz: ece609826496d1734fca46620eaafdaa3d4744b2
+  metadata.gz: cdc39bc4bb388b4f04a7da32a3a1c78f94f02776
+  data.tar.gz: 416474803f5349c511b8fd5f95b38cccc2208ffc
 SHA512:
-  metadata.gz: 35cc8f988db0717644c723ecf7de928285ae4341f52544cb490f86849b3802c8974d47d4b509de0ec91d043a79ad43973507c23dfb8ce59f2694dcc1b3a92997
-  data.tar.gz: ac4c232292e0407259f64d0c0dba2c86b052fdd20be652a44404611f490885d080deefc8bb16822888d4a7f227c7aed8901e8cb4f2f2d6a707abdf97b422cba8
+  metadata.gz: 8d8f7981351c4a9ced9be049a1f7732b77b5eaf55d8fb29cb1d837cea7165d795ad81d1261f6981371a118f34f80c256adede6935b622ae7eeaef281c5dc7b97
+  data.tar.gz: 8af20c69d211af538a61f6da359f95cded4cbd778c790fc5f30c7d398039f1e5b29083803773d3152a6926c36752ecb37918d8150f6e56ec74c21d63658f83a1

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.DS_Store
 .bundle
 .config
 .yardoc

data/README.md

@@ -1,6 +1,6 @@
 # Rnotifier
 
-Exception catcher for rack base applications.
+Events and Exception catcher libraray.
 
 [![Build Status](https://travis-ci.org/jiren/rnotifier.png?branch=master)](https://travis-ci.org/jiren/rnotifier) 
  [![Coverage Status](https://coveralls.io/repos/jiren/rnotifier/badge.png?branch=master)](https://coveralls.io/r/jiren/rnotifier?branch=master)
@@ -21,7 +21,7 @@ Or install it yourself as:
 
 ## Usage
 
-rnotifier install 'API-KEY'  # This will create 'config/rnotifier.yaml' file.
+    rnotifier install 'API-KEY'  # This will create 'config/rnotifier.yaml' file.
 
 ### Config file options
 
@@ -33,6 +33,25 @@ rnotifier install 'API-KEY'  # This will create 'config/rnotifier.yaml' file.
 
     rnotifier test                 #this will send test exception to rnotifier.
 
+
+### Send events and alerts
+
+    Rnotifier.event(:sign_up, {:username => 'Jiren', :email => 'jiren@example.com', :using => 'facebook' })
+
+    Rnotifier.alert(:order_fail, {:user => 'Jiren', :product => 'PS3', :order_id => '321' })
+
+
+You can also sends tags with 'event' and 'alert'
+i.e
+
+    Rnotifier.event(
+      :sign_up, 
+      {:username => 'Jiren', :email => 'jiren@example.com', :using => 'facebook' },
+      {:tags => ['newsletter']}
+    )
+
+
+
 ## Contributing
 
 1. Fork it

data/bin/rnotifier

@@ -15,6 +15,7 @@ install api-key [environments] #Create config/rnotifier.yaml with api_key and en
     require 'rack'
     require 'rnotifier'    
     require 'rnotifier/config_test.rb'
+    ENV['RACK_ENV'] = 'rnotifier_test'
     Rnotifier.load_config('config/rnotifier.yaml')
     if Rnotifier::Config.valid?
       Rnotifier::ConfigTest.test

data/lib/rnotifier/config.rb

@@ -3,7 +3,7 @@ module Rnotifier
     DEFAULT = {
       :api_host     => 'http://api.rnotifier.com',
       :api_version  => 'v1', 
-      :notify_path  => 'exception',
+      :exception_path  => 'exception',
       :event_path   => 'event',
       :ignore_env   => ['development', 'test'],
       :http_open_timeout => 2,
@@ -13,7 +13,7 @@ module Rnotifier
     CLIENT = "RRG:#{Rnotifier::VERSION}"
 
     class << self
-      attr_accessor :api_key, :notification_path, :event_path, :environments, :current_env, 
+      attr_accessor :api_key, :exception_path, :event_path, :environments, :current_env, 
         :valid, :app_env, :api_host, :ignore_exceptions, :capture_code
 
       def [](val)
@@ -46,12 +46,11 @@ module Rnotifier
         return if self.api_key.to_s.length == 0
 
         self.api_host ||= DEFAULT[:api_host]
-        self.notification_path = '/' + [DEFAULT[:api_version], DEFAULT[:notify_path], self.api_key].join('/')
+        self.exception_path = '/' + [DEFAULT[:api_version], DEFAULT[:exception_path]].join('/')
         self.app_env = get_app_env
         self.ignore_exceptions = self.ignore_exceptions.split(',') if self.ignore_exceptions.is_a?(String)
 
-        self.event_path = '/' + [DEFAULT[:api_version], DEFAULT[:event_path], self.api_key].join('/')
-
+        self.event_path = '/' + [DEFAULT[:api_version], DEFAULT[:event_path]].join('/')
         self.valid = true 
       end
 
@@ -83,16 +82,6 @@ module Rnotifier
         (defined?(Rails) && Rails.respond_to?(:root)) ? Rails.root.to_s : Dir.pwd
       end
 
-      def event_app_env
-        {
-          :env => self.current_env,
-          :pid => $$,
-          :host => (Socket.gethostname rescue ''),
-          :language => 'ruby',
-          :platform => (RUBY_PLATFORM rescue '')
-        }
-      end
-
     end
   end
 end

data/lib/rnotifier/event_data.rb

@@ -5,16 +5,17 @@ module Rnotifier
     EVENT = 0
     ALERT = 1
 
-    def initialize(name, type, data = {})
+    def initialize(name, type, data = {}, tags = nil)
       @data = {
         :name => name, 
         :data => data,
         :app_env => EventData.app_env,
-        :occurred_at => Time.now.utc.to_s,
+        :occurred_at => Time.now.to_i,
         :rnotifier_client => Config::CLIENT,
         :type => type,
       }
       @data[:context_data] = Thread.current[:rnotifier_context] if Thread.current[:rnotifier_context]
+      @data[:tags] = tags if tags
     end
 
     def notify
@@ -27,7 +28,12 @@ module Rnotifier
     end
 
     def self.app_env
-      @env ||= Rnotifier::Config.event_app_env 
+      @app_env ||= {
+        :env => Config.current_env,
+        :pid => $$,
+        :host => (Socket.gethostname rescue ''),
+        :language => 'ruby'
+      }
     end
 
   end

data/lib/rnotifier/exception_code.rb

@@ -1,13 +1,23 @@
 module Rnotifier
   class ExceptionCode
+
+    SYNTAX_ERROR_REGX = /\A(.*:\d*):/
+
     class << self
 
-      def get(backtrace)
-        return unless backtrace
-        bline = backtrace.find do |l| 
-          l.index(Config.app_env[:app_root]) == 0 && !Gem.path.any?{|path| l.index(path) == 0}
+      def get(exception)
+        return unless exception.backtrace
+
+        if exception.class == SyntaxError && exception.message.match(SYNTAX_ERROR_REGX)
+          bline = $1 
+        else
+          bline = exception.backtrace.find do |l| 
+            l.index(Config.app_env[:app_root]) == 0 && !Gem.path.any?{|path| l.index(path) == 0}
+          end
         end
+
         filename, line, method = (bline|| backtrace[0]).split(':')
+
         self.find(filename, line.to_i, 3)
       end
 

data/lib/rnotifier/exception_data.rb

@@ -13,19 +13,19 @@ module Rnotifier
     end
 
     def notify
-      return unless Config.valid?
+      return if !Config.valid?
       return if Config.ignore_exceptions && Config.ignore_exceptions.include?(exception.class.to_s)
 
       begin
         data = options[:type] == :rack ? self.rack_exception_data : {:extra => self.env }
         data[:app_env] = Rnotifier::Config.app_env
-        data[:occurred_at] = Time.now.utc.to_s
+        data[:occurred_at] = Time.now.to_i
         data[:exception] = self.exception_data
         data[:context_data] = Thread.current[:rnotifier_context] if Thread.current[:rnotifier_context]
         data[:data_from] = options[:type]
         data[:rnotifier_client] = Config::CLIENT 
 
-        return Notifier.send(data)
+        return Notifier.send(data, Config.exception_path)
       rescue Exception => e
         Rlogger.error("[NOTIFY] #{e.message}")
         Rlogger.error("[NOTIFY] #{e.backtrace}")
@@ -36,15 +36,14 @@ module Rnotifier
     def rack_exception_data
       data = {}
       data[:request] = {
-        :url               => request.url,
-        :referer_url       => request.referer,
-        :ip                => request.ip,
-        :http_method       => "#{request.request_method}#{' # XHR' if request.xhr?}",
-        :params            => filtered_params,
-        :headers           => self.headers,
-        :session           => request.session
+        :url          => request.url,
+        :referer_url  => request.referer,
+        :ip           => request.ip,
+        :http_method  => "#{request.request_method}#{' # XHR' if request.xhr?}",
+        :params       => filtered_params,
+        :headers      => self.headers,
+        :session      => request.session
       }
-
       data
     end
 
@@ -55,7 +54,7 @@ module Rnotifier
         :backtrace  => exception.backtrace,
         :fingerprint => (self.fingerprint rescue nil)
       }
-      e_data[:code] = ExceptionCode.get(e_data[:backtrace]) if Config.capture_code
+      e_data[:code] = ExceptionCode.get(exception) if Config.capture_code
       e_data
     end
 

data/lib/rnotifier/notifier.rb

@@ -8,9 +8,9 @@ module Rnotifier
         end
       end
 
-      def send(data, url = nil)
+      def send(data, path)
         response = self.connection.post do |req|
-          req.url(url || Config.notification_path)
+          req.url(path)
           req.headers['Content-Type'] = 'application/json'
           req.headers['Api-Key'] = Config.api_key
           req.options[:timeout] =  Config[:http_open_timeout]

data/lib/rnotifier/rlogger.rb

@@ -1,6 +1,7 @@
 module Rnotifier
 	class Rlogger
 		TAG = '[RNOTIFIER]'
+
 		class << self
 
       ['info', 'error', 'warn'].each do |level|

data/lib/rnotifier/version.rb

@@ -1,3 +1,3 @@
 module Rnotifier
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/rnotifier.rb

@@ -50,12 +50,16 @@ module Rnotifier
       Rnotifier::ExceptionData.new(exception, params, {:type => :rescue}).notify
     end
 
-    def event(name, params = {})
-      Rnotifier::EventData.new(name, Rnotifier::EventData::EVENT, params).notify if Rnotifier::Config.valid?
+    def event(name, params, tags = {})
+      if Rnotifier::Config.valid? && params.is_a?(Hash)
+        Rnotifier::EventData.new(name, Rnotifier::EventData::EVENT, params, tags[:tags]).notify 
+      end
     end
 
-    def alert(name, params = {})
-      Rnotifier::EventData.new(name, Rnotifier::EventData::ALERT, params).notify if Rnotifier::Config.valid?
+    def alert(name, params, tags = {})
+      if Rnotifier::Config.valid? && params.is_a?(Hash)
+        Rnotifier::EventData.new(name, Rnotifier::EventData::ALERT, params, tags[:tags]).notify 
+      end
     end
 
   end

data/spec/config_spec.rb

@@ -4,9 +4,11 @@ require 'spec_helper'
 describe Rnotifier::Config do
   before(:all) do
     @api_key = 'API-KEY'
-    @notification_path = '/' + [ Rnotifier::Config::DEFAULT[:api_version], 
-                                 Rnotifier::Config::DEFAULT[:notify_path], 
-                                 @api_key].join('/')
+    @exception_path = '/' + [ Rnotifier::Config::DEFAULT[:api_version], 
+                              Rnotifier::Config::DEFAULT[:exception_path]].join('/')
+
+    @event_path = '/' + [ Rnotifier::Config::DEFAULT[:api_version], 
+                              Rnotifier::Config::DEFAULT[:event_path]].join('/')
   end
 
   before(:each) do
@@ -25,7 +27,8 @@ describe Rnotifier::Config do
   it 'has default config values' do
     Rnotifier::Config.tap do |c|
       expect(c.current_env).to eq @environments
-      expect(c.notification_path).to eq @notification_path
+      expect(c.exception_path).to eq @exception_path
+      expect(c.event_path).to eq @event_path
       expect(c.api_key).to eq @api_key
     end
   end
@@ -53,7 +56,7 @@ describe Rnotifier::Config do
     Rnotifier.load_config("#{Dir.pwd}/spec/fixtures/rnotifier.yaml")
 
     expect(Rnotifier::Config.api_key).to eq @api_key
-    expect(Rnotifier::Config.environments).to eq ['production', 'staging']
+    expect(Rnotifier::Config.environments).to eq ['production', 'staging', 'test']
     expect(Rnotifier::Config.valid?).to be_true
   end
 

data/spec/event_data_spec.rb

@@ -19,13 +19,29 @@ describe Rnotifier::EventData do
     end
   end
 
-  it 'sends event data to server' do
-    path = '/' + [ Rnotifier::Config::DEFAULT[:api_version], Rnotifier::Config::DEFAULT[:event_path], 'API-KEY'].join('/')
-    stubs = stub_faraday_request({:path => path})
+  it 'is initialize event_data object with tags' do
+    [:event, :alert].each do |e|
+      e_data = Rnotifier::EventData.new(@name, e, @data, [:create, :update])
 
+      expect(e_data.data[:name]).to eq @name
+      expect(e_data.data[:data]).to eq @data
+      expect(e_data.data[:type]).to eq e
+      expect(e_data.data[:tags]).to eq [:create, :update]
+    end
+  end
+
+  it 'sends event data to server' do
+    stubs = stub_faraday_request({:path => Rnotifier::Config.event_path})
     Rnotifier::EventData.new(@name, @data).notify
 
     expect { stubs.verify_stubbed_calls }.to_not raise_error
   end
 
+  it 'sends event data with tags to server' do
+    stubs = stub_faraday_request({:path => Rnotifier::Config.event_path})
+    Rnotifier.event(@name, @data, {:tags => [:new]})
+
+    expect { stubs.verify_stubbed_calls }.to_not raise_error
+  end
+
 end

data/spec/fixtures/fake_app.rb

@@ -17,6 +17,12 @@ module RnotifierTest
       [200, {}, 'OK']
     end
 
+    get '/event' do
+      Rnotifier.event(:product, {:id => 1, :name => 'PS3' }, [:create])
+
+      [200, {}, 'OK']
+    end
+
   end
 
 end

data/spec/fixtures/rnotifier.yaml

@@ -1,2 +1,2 @@
 apikey: API-KEY
-environments: production,staging
+environments: production,staging,test

data/spec/spec_helper.rb

@@ -34,7 +34,7 @@ end
 def stub_faraday_request(opts = {})
   opts[:status] ||= 200
   opts[:message] ||= 'ok'
-  opts[:path] ||= '/' + [ Rnotifier::Config::DEFAULT[:api_version], Rnotifier::Config::DEFAULT[:notify_path], 'API-KEY'].join('/')
+  opts[:path] ||= '/' + [ Rnotifier::Config::DEFAULT[:api_version], Rnotifier::Config::DEFAULT[:exception_path]].join('/')
 
   stubs = Faraday::Adapter::Test::Stubs.new
   conn  = Faraday.new do |builder|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rnotifier
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jiren Patel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday