reportier 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 370f511dd07462a7eee6dbabe9ed0b69a1ad3871
-  data.tar.gz: 7663e4fb47322832da7aa8cd42234200a5fe093c
+  metadata.gz: b2a6af84f7ba493c64deb711f1a16090b1536921
+  data.tar.gz: 70ab0f75ab322a914775a5410f309176ddc92c4d
 SHA512:
-  metadata.gz: 0281eecb8827893f544d8e32bb0c833c7224b360932fa9fe1585abb3ea728eff8824b8d22e183a2885e2c2e77d48bfe1e8fe223076a692671c5034290728cc19
-  data.tar.gz: 0e90955b777f0d2bb6c8a923126150f1506b04c74b6cc4c8c8290661cc6b2fedd695341f1a76b9b975c7e73682e5574ee331bb94f20929e4c33b9e769f2f4199
+  metadata.gz: 60c57b1a029518c684494c8142d9aacf49dad9c59fc4b8b3681e6b9987b1e5725017320f698a68f721210a71105c1b5aa34d25749a4c33f00867443c5bb54f3e
+  data.tar.gz: ef60218d7121948d4611fd7c2bcfd5c9bb2b92c7f7b29ae20debf13b5b4a03afd039be32e4eb2c9b2376e4305c0897a4ebd1f509763b4a5d27c653ffc6af5179

data/README.md

@@ -1,42 +1,44 @@
 # Reportier the stat tracker
 
-This is a tracker that tracks the count of events. Most notable is that 
-as long as you keep addng items reportier will report automatically
-without using 3rd party software like cron.
+A tracker that tracks the count of events. Most notably (as long as you keep adding items) 
+it can track and report automatically on time (roughly) without the use of 3rd party software like cron.
+And it has an extremely thin public interface, basically you just add items.
 
 ## Usage
 
 `gem 'reportier'`
 
-Use Reportier to track how manny times something happened in a certain ammount of time.
-Reportier has a minimal public interface however is quite powerfull inside.
+Use Reportier to track how many times something happened in a certain amount of time.
+Reportier has a minimal public interface however is quite powerful inside.
 
 To use first configure it with intervals by setting a name and when to report
 
+```
 Reportier.configure do |c|
   # Time is in seconds
   c.trackers = {
-    hourly:   60 * 60,
-    bidaily:  60 * 60 * 24 * 2
+    daily: 60 * 60 * 24,
+    daily_page_visits:  60 * 60 * 24
   }
 end
+```
 
 Then you can add items to trackers and it will keep track of them.
 
 ```
-  Reportier[:hourly].add "Home page visit"
+  Reportier[:daily_page_visits].add "Home page visit"
   # or
-  Reportier[:bidaily].add @newly_registered_user # object of type User
+  Reportier[:daily].add @newly_registered_user # object of type User
 ```
 
 Note that you can add objects and Reporiter will track their class.
-You can also add the item to all trackers by doing 
+You can also add the item to all *registered* <sup>[1](#myfootnote1)</sup> trackers by doing 
 
 ```
 Reportier.add_to_all @item
 ```
 
-You can make the tracker report or convert it to json.
+You can manually report or convert it to json.
 
 ```
 Reportier[:daily].add('new user registration')
@@ -49,13 +51,13 @@ Reportier[:daily].to_json
 # -> "{\"new_user_registrations\": 1}"
 ```
 
-Tracker check if they have expired everytime an item is added.
-And they will reset and report when they realise that they 
+Each time an item is added the tracker will check if they have expired.
+If they have they will report and reset.
 
-## Persistance
+## Persistence
 
 Reportier saves items to memory by default however we also support long time 
-persistance with redis, and maybe postgres in the future.
+persistence with redis, and maybe postgres in the future.
 
 To use redis look on setting defaults below.
 
@@ -74,7 +76,7 @@ end
 ### Reporters
 
 By default Reportier will only report to logger and console
-but we also support reporting to slack through slack-reporter and to logger, 
+but we also support reporting to slack through slack-reporter,
 and you can easily create your custom reporting methods.
 
 ```
@@ -82,7 +84,7 @@ Reportier.configure do |c|
   c.reporters = { logger: 'logger', slack: 'slack-reporter' }
 end
 
-## Note you need to ass 'slack-reporter' to your gemfile
+## Note you need to add 'slack-reporter' to your gemfile
 ```
 
 If you want to add custom reporters just add their name and library and then define a `to_#{name)` method to the `Reporter`
@@ -92,15 +94,15 @@ e.x.
 Reportier.configure { |c| c.reporters = { twilio: 'twilio-ruby' } }
 
 class Reportier::Reporter
-  def to_twilio
-    ## you code here
+  def to_twilio(message)
+    ## Do something with #{message}
   end
 end
 ```
 
 ### Default reporting vars
 
-Sometimes its usefull no have stats from other services or modules.
+Sometimes its useful to have stats from other services or modules.
 To do that you can configure reportier to have some default reporting variables
 
 ``` 
@@ -112,17 +114,29 @@ Reportier.configure do |c|
     todays_messages: Message.where('created_at > ?', Datetime.yesterday)
   }
 end
+```
 
 ### Full configuration
 
-Ofcourse you can you all this in a single configuration in the startup of your
+Of course you can have it all in a single configuration in the startup of your
 application. A full configuration would look something like this.
 
 ```
 Reportier.configure do |c|
   c.persister = :redis
-  c.trackers  = { daily: 60 * 60 * 24
+  c.trackers  = { daily: 60 * 60 * 24 }
   c.reporters = { logger: 'logger', slack: 'slack-reporter' }
   c.reporting_vars = { active_users: UserRepo.active.count }
 end
 ```
+
+## Custom Trackers
+Documentation soon
+
+
+## ToDo
+Documentation for custom trackers
+Event driven reports
+Reportier.add_to(trackers // [])
+
+<a name="myfootnote1">1</a>:  Trackers that are configured by `Reportier.configure { |c| c.trackers = ... }`

data/lib/reportier.rb

@@ -1,6 +1,5 @@
 require          'date'
 require_relative 'reportier/naming'
-require_relative 'reportier/time'
 require_relative 'reportier/defaults'
 require_relative 'reportier/reporter'
 require_relative 'reportier/persister'

data/lib/reportier/defaults.rb

@@ -12,7 +12,7 @@ module Reportier
       @reporting_vars.merge! Hash(opts[:reporting_vars])
     end
 
-    def configure 
+    def configure
       yield self
     end
 
@@ -30,6 +30,7 @@ module Reportier
       _require_reporter_libraries
     end
 
+
     private
 
     def initialize_defaults

data/lib/reportier/persister.rb

@@ -10,7 +10,6 @@ module Reportier
     def initialize(tracker)
       @tracker  = tracker
       @reporting_vars = {}
-      _initialize_reporting_vars
     end
 
     def save(item)
@@ -24,12 +23,12 @@ module Reportier
     end
 
     def to_json
-      "{#{to_hash.map { |k,v| "\"#{k}\": #{v}" }.flatten.join(",\n")}}"
+      hash = to_hash.map { |k,v| "\"#{k}\": #{v}" }.join(",\n")
+      "{#{hash}}"
     end
 
     def clear
       @reporting_vars = {}
-      _initialize_reporting_vars
     end
 
     def get_date
@@ -40,8 +39,8 @@ module Reportier
       @tracker.started_at = date
     end
 
-    def to_hash
-      @reporting_vars
+    def to_hash(reporting_vars = @reporting_vars)
+      reporting_vars.merge(@tracker.defaults.reporting_vars)
     end
 
     private
@@ -63,26 +62,21 @@ module Reportier
         "#{key}: #{val}\n"
       end
     end
-    
+
     def initialize_reporting_var(name)
       set(name, 0)
     end
-
-    def _initialize_reporting_vars
-      @reporting_vars.merge!(@tracker.defaults.reporting_vars)
-    end
   end
   class MemoryPersister < Persister; end
   class RedisPersister  < Persister
 
     def clear
       Redis.current.del(Redis.current.keys(name + '*'))
-      _initialize_reporting_vars
     rescue Redis::CommandError
     end
 
     def to_hash
-      Hash[reporting_vars.map { |k| [k, get(k).to_i] }]
+      super(Hash[reporting_vars.map { |k| [k, get(k).to_i] }])
     end
 
     def get_date
@@ -115,7 +109,7 @@ module Reportier
     def get(item)
       Redis.current.get name(item)
     end
-    
+
     def name(item=nil)
       "#{@tracker.name}:#{item}"
     end

data/lib/reportier/reporter.rb

@@ -31,6 +31,8 @@ module Reportier
 
     def to_logger(message)
       create_dir('log') unless Dir.exists? 'log'
+      ::Logger.new('log/reportier.log').info("\n" + message)
+    rescue NameError
       Logger.new('log/reportier.log').info("\n" + message)
     end
 

data/lib/reportier/tracker.rb

@@ -2,7 +2,7 @@ module Reportier
   class Tracker
     attr_accessor :started_at
     attr_reader :reporter, :persister, :type, :name, :defaults
-      
+
 
     def self.[](type)
       @current       ||= Hash.new

data/lib/reportier/version.rb

@@ -1,3 +1,3 @@
 module Reportier
-  VERSION = '0.6.0'
+  VERSION = '0.6.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reportier
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Vasilis Spilka