app_monit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e1109ea294bf183a829e22b2dcb4629637deb5a
-  data.tar.gz: 7fe39bad8e6db970a2355518bd8cfa049c28a4df
+  metadata.gz: 6dc9e44529d531ea68014aa8ae4a9e3db8b58606
+  data.tar.gz: 604fec1a5f824061397732fdde64f78b6e699eed
 SHA512:
-  metadata.gz: 611e7fb651484d36800ffcda8d43554ecd0b0a656d5c51e26eb9011ef1e5d26c8a11e8136f615a88b49015a166c4d8f40e578084107ee770e603d345b7bfce6b
-  data.tar.gz: cad200e2abd1d74c6d21be8f8358f88759d9b766b3bca67ae1730b6b7b7304e949d611fb4d46cc5754e9f70127c41c3bd00cdcaa6849ac41171c02c355f013c6
+  metadata.gz: 9171a668759d6fb693299ab8cc6c04f415e7ce8934bd0b35b36665005dd8e198a21f8790fa976fa6cd7f060a895f4b3bbf322089b4d2d2535943863ad24edf3e
+  data.tar.gz: f8eb9f13c51202064f09b0166fde7da9c97c6c107ed581b4a77b903f16d15d9db56e90660ea023d9aef6a90a9b2f291e00cbaf7a4e98f59a6c68018fb667ab96

data/.ruby-gemset

@@ -0,0 +1 @@
+app_monit_gem

data/README.md

@@ -20,7 +20,108 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configure the client
+
+    AppMonit::Config.api_key   = '<YOUR_API_KEY>'
+    AppMonit::Config.end_point = 'https://api.appmon.it'
+    AppMonit::Config.env       = Rails.env.to_s
+
+### Create an event
+
+    event_name   = 'authentication'
+    payload_hash = {user: {id: 1, name: 'John'} }
+    AppMonit::Event.create(event_name, payload_hash)
+
+### Query
+
+You can use the following metrics to query your data
+
+* count
+* count_unique
+* minimum
+* maximum
+* average
+* sum
+* funnel
+
+    AppMonit::Event.create(:registered, user: {id: '1'})
+    AppMonit::Event.create(:registered, user: {id: '2'})
+    AppMonit::Event.create(:purchase, user: {id: '1'}, product: { price_in_cents: 100, name: 'water', alcoholic: false })
+    AppMonit::Event.create(:purchase, user: {id: '1'}, product: { price_in_cents: 150, name: 'soda', alcoholic: false })
+    AppMonit::Event.create(:purchase, user: {id: '1'}, product: { price_in_cents: 200, name: 'beer', alcoholic: true })
+
+#### count
+    AppMonit::Query.count(:purchase) # { 'result' => 3 }
+
+#### count
+    AppMonit::Query.count_unique(:purchase) # { 'result' => 2, target_property: 'product.name' }
+
+#### minimum
+    AppMonit::Query.minimum(:purchase, target_property: 'product.price_in_cents') # { 'result' => 100 }
+
+#### minimum
+    AppMonit::Query.maximum(:purchase, target_property: 'product.price_in_cents') # { 'result' => 200 }
+
+#### average
+    AppMonit::Query.average(:purchase, target_property: 'product.price_in_cents') # { 'result' => 150 }
+
+#### sum
+    AppMonit::Query.sum(:purchase, target_property: 'product.price_in_cents') # { 'result' => 450 }
+
+#### funnel
+    AppMonit::Query.funnel(steps: [
+        { event_collection: 'registered', actor_property: 'user.id'},
+        { event_collection: 'purchase', actor_property: 'user.id'}
+    ] # { 'result' => { 'result' => [ 2, 1], 'steps' => [{ event_collection: 'registered', actor_property: 'user.id'},
+                                                         { event_collection: 'purchase', actor_property: 'user.id'}]
+
+#### Timeframe
+    AppMonit::Query.count('registered', timeframe: 'this_week')
+
+Options
+
+* this_minute
+* this_hour
+* this_day
+* this_week
+* this_month
+* this_year
+
+Or with n: this_n_minutes (n = 2 => this_2_minutes)
+
+This can also be replaced with previous: previous_minute and previous_n_minutes
+
+#### Interval
+This can be used with timeframe
+    AppMonit::Query.count('registered', timeframe: 'this_week', interval: 'daily')
+
+* minutely
+* hourly
+* daily
+* monthly
+* yearly
+* weekly
+
+Also with n: every_n_minutes (n = 2 => every_2_minutes)
+
+#### Group by
+    AppMonit::Query.count('registered', group_by: 'alcoholic') # { 'result' => [ {'alcoholic' => true,  result => 1 }
+                                                                                 {'alcoholic' => false, result => 2 }]
+
+#### Filter
+    AppMonit::Query.count('registered', filters: [{property_name: 'product.name', operator: 'eq', property_value: 'soda'}])
+
+Allowed operators
+
+* eq
+* neq
+* lt
+* lte
+* gt
+* gte
+* exists
+* in
+* nin
 
 ## Contributing
 

data/lib/app_monit/config.rb

@@ -1,7 +1,7 @@
 module AppMonit
   class Config
     class << self
-      attr_writer :api_key, :env, :end_point
+      attr_writer :api_key, :env, :end_point, :fail_silent
 
       def api_key
         @api_key || raise(ApiKeyNotSetError.new("Please set your API key"))
@@ -14,6 +14,10 @@ module AppMonit
       def end_point
         @end_point || "http://api.appmon.it"
       end
+
+      def fail_silent
+        @fail_silent || false
+      end
     end
   end
 end

data/lib/app_monit/event.rb

@@ -6,12 +6,16 @@ module AppMonit
       create!(*args)
     rescue Http::Error
       false
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse,
+        Net::HTTPHeaderSyntaxError, Net::ProtocolError => error
+      raise error unless AppMonit::Config.fail_silent
+      false
     end
 
     def self.create!(name, data_hash = {})
       created_at = data_hash.delete(:created_at) || Time.now.utc
 
-      message  = { created_at: created_at, name: name, payload: data_hash }
+      message = { created_at: created_at, name: name, payload: data_hash }
       client.post('/v1/events', message)
     end
 

data/lib/app_monit/version.rb

@@ -1,3 +1,3 @@
 module AppMonit
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/app_monit/event_spec.rb

@@ -31,6 +31,26 @@ describe AppMonit::Event do
         assert_equal false, subject.create
       end
     end
+
+    describe 'when the AppMonit::Config.fail_silent is set' do
+      it 'returns false if any Http related error is raised' do
+        AppMonit::Config.fail_silent = true
+
+        subject.stub(:create!, -> { raise Timeout::Error }) do
+          assert_equal false, subject.create
+        end
+      end
+    end
+
+    describe 'when the AppMonit::Config.fail_silent is NOT set' do
+      it 'raises the rescued Http related error again' do
+        AppMonit::Config.fail_silent = false
+
+        subject.stub(:create!, -> { raise Timeout::Error }) do
+          assert_raises(Timeout::Error) { subject.create }
+        end
+      end
+    end
   end
 
   describe '#create!' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_monit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Redmar Kerkhoff
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-29 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile