reportier 0.5.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35c22449bf729329f9138fd15ec42ed74203bd9f
-  data.tar.gz: 73c282dd8a894e9d9a7d92084c8e2ebea0662a8d
+  metadata.gz: 370f511dd07462a7eee6dbabe9ed0b69a1ad3871
+  data.tar.gz: 7663e4fb47322832da7aa8cd42234200a5fe093c
 SHA512:
-  metadata.gz: 94527640a1856e2085ff45fe9dc9cdec99cc7cf0ac48cc18daa582496ecfe6113d2d2034baf4ba364fc955ccf533edcbd0d5d8ec979d227260dacb0257d03362
-  data.tar.gz: b0fdf328874cd417415e6fd1781776ea9df3630532eb92974ccf5c834fa67cb7d1b0f276be136d1e46ca71402f2c83d827ebf96f677ec4ef989d200ac469e817
+  metadata.gz: 0281eecb8827893f544d8e32bb0c833c7224b360932fa9fe1585abb3ea728eff8824b8d22e183a2885e2c2e77d48bfe1e8fe223076a692671c5034290728cc19
+  data.tar.gz: 0e90955b777f0d2bb6c8a923126150f1506b04c74b6cc4c8c8290661cc6b2fedd695341f1a76b9b975c7e73682e5574ee331bb94f20929e4c33b9e769f2f4199

data/README.md

@@ -1,75 +1,95 @@
 # Reportier the stat tracker
 
-This is a tracker that tracks the count of events.
+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.
+
+## Usage
 
-## Use
 `gem 'reportier'`
 
-Using the Tracker is fairly simple, by default there are 4 types of trackers.
-An `Hourly`, a `Daily` a `Weekly` and a `Monthly`.
-To add something to a tracker simply `.get` it and `#add` something.
+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.
 
-You can also `#report` the current state of the tracker, however trackers report and reset by themselves
-as long as you keep adding items to them.
+To use first configure it with intervals by setting a name and when to report
 
-Examples:
+Reportier.configure do |c|
+  # Time is in seconds
+  c.trackers = {
+    hourly:   60 * 60,
+    bidaily:  60 * 60 * 24 * 2
+  }
+end
 
-```
-Reportier::Tracker[:daily].add('new user registration')
+Then you can add items to trackers and it will keep track of them.
 
-Reportier::Tracker[:daily].report
-# -> Daily report started at 2016-06-17T15:34:40+03:00
-# @new_user_registrations: 1
+```
+  Reportier[:hourly].add "Home page visit"
+  # or
+  Reportier[:bidaily].add @newly_registered_user # object of type User
 ```
 
-You can also use `Reportier.add_to_all('we need to track this')` and it will add the item to all trackers.
-If you keep adding this way, each tracker will report when his time is due, and you have to worry about
-nothing else.
+Note that you can add objects and Reporiter will track their class.
+You can also add the item to all trackers by doing 
 
-Trackers also have a `#to_json` method for converting tracked items to json.
+```
+Reportier.add_to_all @item
+```
 
+You can make the tracker report or convert it to json.
 
-## Setting defaults
+```
+Reportier[:daily].add('new user registration')
 
-Reportier has 3 methods for setting defaults.
+Reportier[:daily].report
+# -> Daily report started at 2016-06-17T15:34:40+03:00
+# new_user_registrations: 1
 
-`.set_default_reporting_vars`
+Reportier[:daily].to_json 
+# -> "{\"new_user_registrations\": 1}"
+```
 
-This is for setting default things you want to track. Example use would be.
+Tracker check if they have expired everytime an item is added.
+And they will reset and report when they realise that they 
 
-```
-Reportier.set_default_reporting_vars active_users: User.active, open_conversations: Conversation.all.count
-```
+## Persistance
 
-`.set_default_types`
+Reportier saves items to memory by default however we also support long time 
+persistance with redis, and maybe postgres in the future.
 
-This is for setting default tracker types, by type we mean how much time it needs for reset.
-So the usage would be
+To use redis look on setting defaults below.
 
+## Setting defaults
+
+### Persister
+Right now we only support memory and redis.
+Select peristance like so.
 
 ```
-Reportier.set_default_types yearly: 1.year, bidaily: 2.days
+Reportier.configure do |c|
+  c.persister = :redis
+end
 ```
 
-These new tracker classes will be created and can be used normally like any other tracker,
-also `Reportier.add_to_all` will take this new classes in account.
-Note that if you don't use Rails you can `import` or `extend` `Reportier::Time` to you current environment
-and use `hours(1)`, `days(1)`, `weeks(1)`,  `months(1)`, `years(1)`, years and months are not exact.
+### Reporters
 
-`.set_default_reporters`
-
-This is for setting default reporters, by default Reportier will only report to console
-but we also support reporting to slack and logger, and you can easily create your custom reporting methods.
+By default Reportier will only report to logger and console
+but we also support reporting to slack through slack-reporter and to logger, 
+and you can easily create your custom reporting methods.
 
 ```
-Reportier.set_default_reporters slack: 'slack-reporter', logger: 'logger'
+Reportier.configure do |c|
+  c.reporters = { logger: 'logger', slack: 'slack-reporter' }
+end
+
+## Note you need to ass '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`
 e.x.
 
 ```
-Reportier.set_default_reporters twilio: 'twilio-ruby'
+Reportier.configure { |c| c.reporters = { twilio: 'twilio-ruby' } }
 
 class Reportier::Reporter
   def to_twilio
@@ -78,6 +98,31 @@ class Reportier::Reporter
 end
 ```
 
-### TODO
+### Default reporting vars
+
+Sometimes its usefull no have stats from other services or modules.
+To do that you can configure reportier to have some default reporting variables
 
-When persisted through redis trackers need to get their starting time from redis
+``` 
+Reportier.configure do |c|
+  # For adding reporting vars
+  c.reporting_vars = { active_users: UserRepo.active.count }
+  # For updating existing reporting vars
+  c.update_reporting_vars {
+    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
+application. A full configuration would look something like this.
+
+```
+Reportier.configure do |c|
+  c.persister = :redis
+  c.trackers  = { daily: 60 * 60 * 24
+  c.reporters = { logger: 'logger', slack: 'slack-reporter' }
+  c.reporting_vars = { active_users: UserRepo.active.count }
+end
+```

data/lib/reportier.rb

@@ -9,11 +9,15 @@ require_relative 'reportier/version'
 
 module Reportier
   def self.add_to_all(item)
-    Defaults.global.types.each do |type, v|
+    Defaults.global.trackers.each do |type, v|
       Tracker[type].add(item)
     end
   end
 
+  def self.[](type)
+    Tracker[type]
+  end
+
   def self.configure(&blk)
     Defaults.global.configure &blk
   end

data/lib/reportier/defaults.rb

@@ -1,6 +1,6 @@
 module Reportier
   class Defaults
-    attr_accessor :types, :reporting_vars, :reporters,
+    attr_accessor :trackers, :reporting_vars, :reporters,
       :persister
 
     def self.global
@@ -20,9 +20,9 @@ module Reportier
       @reporting_vars.merge!(hash)
     end
 
-    def types=(opts)
-      @types = Hash.new(0)
-      @types.merge! opts
+    def trackers=(opts)
+      @trackers = Hash.new(0)
+      @trackers.merge! opts
     end
 
     def reporters=(opts)
@@ -33,9 +33,9 @@ module Reportier
     private
 
     def initialize_defaults
-      @types          = Hash.new(0)
+      @trackers          = Hash.new(0)
       @reporting_vars = Hash.new
-      @reporters      = Hash.new
+      @reporters      = { console: nil, logger: 'logger' }
       @persister      = :memory
     end
 

data/lib/reportier/tracker.rb

@@ -21,7 +21,7 @@ module Reportier
 
     def add(item)
       (report && clear) unless active?
-      return if Defaults.global.types[@type] == 0
+      return if Defaults.global.trackers[@type] == 0
       @persister.save(Namer.new.name_item(item))
     end
 
@@ -52,7 +52,7 @@ module Reportier
     end
 
     def expires_at
-      get_date + Defaults.global.types[@type]
+      get_date + Defaults.global.trackers[@type]
     end
 
     def get_date
@@ -71,7 +71,7 @@ module Reportier
     end
 
     def _long_due?
-      expires_at < (DateTime.now - Defaults.global.types[@type])
+      expires_at < (DateTime.now - Defaults.global.trackers[@type])
     end
   end
 end

data/lib/reportier/version.rb

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

metadata

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