app_monit 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7592815c09ea9a8c41849e706fc4c0f890897dbd
-  data.tar.gz: 182997dbbcf2280f9bb30305ef0038418493f464
+  metadata.gz: b45442d97743d84c104c4ff7d9f353e68f0c7d2f
+  data.tar.gz: 82ea6df8c1bf81b4702570735e65c07e6ecede16
 SHA512:
-  metadata.gz: 793306265482872b9dd2fcf1c76ef1947ba0022a489da546f735462345e9dafce55957a22e80ab955369d84844c009025d226efaaf7428c159ed36c56fa30d21
-  data.tar.gz: 79b57a659c3f19e8a8f145a82bdba3190cc8b56d6dc7c5f1cda3b23ab9695976c2c40af525b97213a9a9add711db6ff33798229996533c0efec36f33b5fe05c8
+  metadata.gz: 853143be5929ea5b6f8fc6bc00cce5a1b60ad42dff0c811d4764a26f12506f0447937ccafc693e764b8d9372830cf94c092ddd01b00dcf3052b1fdc8e7c38f24
+  data.tar.gz: 3c30b46d77e7fb013c629ac31521fe917ba0d1c3f95e5ef9aa051a06d07f89295f95a2535fceebb146cd81af432da3d890aa6e5c3fcaf1fd8ccc45acddf5aeb7

data/README.md

@@ -2,13 +2,13 @@
 
 # AppMonit
 
-TODO: Write a gem description
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'app_monit'
+```ruby
+gem 'app_monit'
+```
 
 And then execute:
 
@@ -22,63 +22,115 @@ Or install it yourself as:
 
 ### 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
+#### Basic configuration
+
+```ruby
+AppMonit::Config.api_key   = '<YOUR_API_KEY>'
+AppMonit::Config.end_point = 'https://api.appmon.it'
+AppMonit::Config.env       = Rails.env.to_s
+```
+
+#### Additional configuration
+
+To ignore connection related errors when creating events, set the `.fail_silent` option in the configuration (default: `false`):
+
+```ruby
+AppMonit::Config.fail_silent = true
+```
+
+To disable creating events, set the `.enabled` option in the configuration (default: `true`):
+
+```ruby
+AppMonit::Config.enabled = false
+```
 
 ### Create an event
 
-    event_name   = 'authentication'
-    payload_hash = {user: {id: 1, name: 'John'} }
-    AppMonit::Event.create(event_name, payload_hash)
+```ruby
+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
+You can use the following methods to query your data:
+
+* `#count`
+* `#count_unique`
+* `#minimum`
+* `#maximum`
+* `#average`
+* `#sum`
+* `#funnel`
+
+The examples are based on the following events:
+
+```ruby
+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`
+
+```ruby
+AppMonit::Query.count(:purchase) #=> { 'result' => 3 }
+```
 
-* count
-* count_unique
-* minimum
-* maximum
-* average
-* sum
-* funnel
+#### `#count_unique`
 
-    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 })
+```ruby
+AppMonit::Query.count_unique(:purchase) #=> { 'result' => 2, target_property: 'product.name' }
+```
 
-#### count
-    AppMonit::Query.count(:purchase) # { 'result' => 3 }
+#### `#minimum`
 
-#### count
-    AppMonit::Query.count_unique(:purchase) # { 'result' => 2, target_property: 'product.name' }
+```ruby
+AppMonit::Query.minimum(:purchase, target_property: 'product.price_in_cents') #=> { 'result' => 100 }
+```
 
-#### minimum
-    AppMonit::Query.minimum(:purchase, target_property: 'product.price_in_cents') # { 'result' => 100 }
+#### `#maximum`
 
-#### minimum
-    AppMonit::Query.maximum(:purchase, target_property: 'product.price_in_cents') # { 'result' => 200 }
+```ruby
+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 }
+#### `#average`
 
-#### sum
-    AppMonit::Query.sum(:purchase, target_property: 'product.price_in_cents') # { 'result' => 450 }
+```ruby
+AppMonit::Query.average(:purchase, target_property: 'product.price_in_cents') #=> { 'result' => 150 }
+```
 
-#### 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'}]
+#### `#sum`
+
+```ruby
+AppMonit::Query.sum(:purchase, target_property: 'product.price_in_cents') #=> { 'result' => 450 }
+```
+
+#### `#funnel`
+
+```ruby
+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
+You can specify a timeframe when querying your data:
+
+```ruby
+AppMonit::Query.count('registered', timeframe: 'this_week')
+```
+
+Use the following options to specify the timeframe:
 
 * this_minute
 * this_hour
@@ -86,14 +138,18 @@ Options
 * this_week
 * this_month
 * this_year
+* this_n_minutes (example: with n = 2 results this_2_minutes)
 
-Or with n: this_n_minutes (n = 2 => this_2_minutes)
+In addition to using the word 'this' to specify the timeframe, you can also use the word 'previous' (example: previous_minute, previous_day and with n = 3 the previous_3_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')
+You can specify an interval when querying your data in combination with a timeframe:
+
+```ruby
+AppMonit::Query.count('registered', timeframe: 'this_week', interval: 'daily')
+```
+Use the following options to specify the interval:
 
 * minutely
 * hourly
@@ -101,27 +157,40 @@ This can be used with timeframe
 * monthly
 * yearly
 * weekly
+* every_n_minutes (example: with n = 3 results every_3_minutes)
 
-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 }]
+
+You can specify a group when querying your data:
+
+```ruby
+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
+
+You can specify a filter when querying your data:
+
+```ruby
+AppMonit::Query.count('registered', filters: [{ property_name: 'product.name', operator: 'eq', property_value: 'soda' }]) #=> { 'result' => 1 }
+```
+
+Use the following operators:
+
+| Operator | Matcher
+| -------- | --------------------------- |
+| eq       | equal                       |
+| neq      | not equal                   |
+| lt       | less than                   |
+| lte      | less than or equal to       |
+| gt       | greater than                |
+| gte      | greater than or equal to    |
+| exists   | exists                      |
+| in       | in                          |
+| nin      | not in                      |
+
 
 ## Contributing
 

data/lib/app_monit/config.rb

@@ -1,7 +1,7 @@
 module AppMonit
   class Config
     class << self
-      attr_writer :api_key, :env, :end_point, :fail_silent, :enabled
+      attr_writer :api_key, :env, :end_point, :fail_silent, :enabled, :timeout
 
       def api_key
         @api_key || raise(ApiKeyNotSetError.new("Please set your API key"))
@@ -22,6 +22,10 @@ module AppMonit
       def enabled?
         @enabled.nil? ? env != "test" : @enabled
       end
+
+      def timeout
+        @timeout || 1
+      end
     end
   end
 end

data/lib/app_monit/http.rb

@@ -14,7 +14,7 @@ module AppMonit
         @client.verify_mode  = OpenSSL::SSL::VERIFY_PEER
       end
 
-      @client.read_timeout = 1
+      @client.read_timeout = AppMonit::Config.timeout if AppMonit::Config.timeout > 0
     end
 
     def self.post(path, data_hash)

data/lib/app_monit/version.rb

@@ -1,3 +1,3 @@
 module AppMonit
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/app_monit/http_spec.rb

@@ -40,8 +40,14 @@ describe AppMonit::Http do
     assert_requested :post, /.*/, :headers => { 'Appmonit-Api-Key' => 'FUBAR123' }
   end
 
-  it 'sets the read timeout to 1 second' do
-    assert_equal 1, subject.client.read_timeout
+  it 'sets the read timeout to AppMonit::Config.timeout' do
+    AppMonit::Config.timeout = 10
+    assert_equal 10, subject.client.read_timeout
+  end
+
+  it 'sets the read timeout to the default' do
+    AppMonit::Config.timeout = 0
+    assert_equal 60, subject.client.read_timeout
   end
 
   describe 'when using ssl' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_monit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Redmar Kerkhoff
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler