event-counter 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c824074d24fd8d6d102c55c7cd81c4026e3cdd0
-  data.tar.gz: 906bf98133f1f082d6a3f1c1d4831c64f7974ea3
+  metadata.gz: 9ed77b0f7b2996138e3c7125f506022dbfb1b4f6
+  data.tar.gz: 703501bc075661a7ef2584740ec9163450a591ed
 SHA512:
-  metadata.gz: 8db9c66d38029ccf99b8fa828f5936a1dc8ea84412822d7fc1037b4a2d4979988f429e4b2a96379d23e821b4ad08e792409f617b7ac1eb28f71f429341a608fc
-  data.tar.gz: a4085a8f4901cd3854b50ff56791c17bcd345d4269845e4ab5523a3bc35c65ced9bd88e6702ac2c0e2c77f8882edc73afdc5a244fa5f8a2bb927866b0f4c1678
+  metadata.gz: d71bb461d356f61d8c0afd1718886e0e2be6b507ea1e0994e95b25c2370495921a14167d75a4e702730a8dac9ce5a5daeb2fc759c553e0f9a6265a68fdf2b4a0
+  data.tar.gz: aa7d2d7006bee6837fc7fd8440fa11f5e38148e7e478024f1a25f10285cbe3808c5558d0c5e1ab0c7ad8731371545021460293155339851b2e51cb976b759559

data/.gitignore

@@ -7,6 +7,7 @@
 /doc/
 /log
 /pkg/
+/spec/fixtures/*.sql
 /spec/reports/
 /tmp/
 *.bundle

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+gemfile:
+  - gemfiles/pg_ar_30.gemfile
+  - gemfiles/pg_ar_31.gemfile
+  - gemfiles/pg_ar_32.gemfile
+  - gemfiles/pg_ar_40.gemfile
+
+script: RUN_ALL=true rspec spec
+
+services:
+  - postgresql
+
+before_script:
+  - psql -c 'create database event_counter_test;' -U postgres

data/Appraisals

@@ -0,0 +1,11 @@
+%w(3.0 3.1 3.2 4.0 4.1).each do |ar_version|
+  %w(pg).each do |db_type|
+    appraise "#{db_type}-ar-#{ar_version.split('.').first(2).join}" do
+      gem 'activerecord', "~> #{ar_version}"
+      gem 'activesupport', "~> #{ar_version}"
+      gem 'database_cleaner'
+      gem 'pg'
+      gem 'rspec'
+    end
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# EventCounter Changelog
+
+0.1.0 (2014-10-12)
+
+* Added time zones support
+* Improved specs

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'appraisal'
+gem 'rspec'
+gem 'database_cleaner'

data/README.md

@@ -1,10 +1,8 @@
-EventCounter
-===============
+# EventCounter
 
 EventCounter is a database based event counter with throttling per time intervals.
 
-Usage
------
+## Usage
 
 Let's define counters in model
 
@@ -23,66 +21,105 @@ Let's count...
 article = Article.create!
 
 article.up!(:views)
-# creates counter (if it doesn't exist) with value 1 and on Time.now() rounded to 5 minutes, e.x.:
-#=> #<EventCounter id: 1, name: "views", value: 1, countable_id: 1, countable_type: "Article", created_at: "2014-10-16 23:20:00">
+# => #<EventCounter id: 1, name: "views", value: 1, countable_id: 1,
+# countable_type: "Article", created_at: "2014-10-16 23:20:00">
+# creates counter (if it doesn't exist) with value 1 and on Time.now() rounded
+# to 5 minutes, e.x.:
 
 # at once
 article.up!(:views, 3)
-#=> #<EventCounter id: 1, name: "views", value: 4, countable_id: 1, countable_type: "Article", created_at: "2014-10-16 23:20:00">
-# it will update counter (if the other exists in that interval) with value 3 and on Time.now() rounded to 5 minutes
+# => #<EventCounter id: 1, name: "views", value: 4, countable_id: 1,
+# countable_type: "Article", created_at: "2014-10-16 23:20:00">
+# Updates counter (if the other exists in that interval) with value 3 and
+# on Time.now() rounded to 5 minutes
 
 # later
 article.up!(:views, 5)
-#=> #<EventCounter id: 2, name: "views", value: 5, countable_id: 1, countable_type: "Article", created_at: "2014-10-16 23:25:00">
+# => #<EventCounter id: 2, name: "views", value: 5, countable_id: 1,
+# countable_type: "Article", created_at: "2014-10-16 23:25:00">
 article.down!(:views, 2)
-#=> #<EventCounter id: 2, name: "views", value: 3, countable_id: 1, countable_type: "Article", created_at: "2014-10-16 23:25:00">
+# => #<EventCounter id: 2, name: "views", value: 3, countable_id: 1,
+# countable_type: "Article", created_at: "2014-10-16 23:25:00">
 
 # anytime or in a background job
-article.up!(:views, 7, on_time: 10.minutes.ago)
-#=> #<EventCounter id: 3, name: "views", value: 7, countable_id: 1, countable_type: "Article", created_at: "2014-10-16 23:15:00">
+article.up!(:views, 7, on_time: 10.minutes.ago.in_time_zone)
+# => #<EventCounter id: 3, name: "views", value: 7, countable_id: 1,
+# countable_type: "Article", created_at: "2014-10-16 23:15:00">
 
 # we have not got? let's fix it
-article.up!(:views, 9, on_time: 10.minutes.ago, force: true)
-#=> #<EventCounter id: 3, name: "views", value: 9, countable_id: 1, countable_type: "Article", created_at: "2014-10-16 23:15:00">
+article.up!(:views, 9, on_time: 10.minutes.ago.in_time_zone, force: true)
+# => #<EventCounter id: 3, name: "views", value: 9, countable_id: 1,
+# countable_type: "Article", created_at: "2014-10-16 23:15:00">
 ```
 
 Let's get some statistics for our charts...
 
 ```ruby
 article.data_for(:views)
-#=> [[2014-10-16 23:15:00 +0400, 9], [2014-10-16 23:20:00 +0400, 4], [2014-10-16 23:25:00 +0400, 3]]
+# => [
+# [Thu, 16 Oct 2014 23:15:00 MSK +04:00, 9],
+# [Thu, 16 Oct 2014 23:20:00 MSK +04:00, 4],
+# [Thu, 16 Oct 2014 23:25:00 MSK +04:00, 3]
+# ]
 
 article.data_for(:views, interval: 10.minutes)
-#=> [[2014-10-16 23:10:00 +0400, 9], [2014-10-16 23:20:00 +0400, 7]]
-
-range = Time.mktime(2014, 10, 16, 23, 0)..Time.mktime(2014, 10, 16, 23, 10)
+# => [
+# [Thu, 16 Oct 2014 23:10:00 MSK +04:00, 9],
+# [Thu, 16 Oct 2014 23:20:00 MSK +04:00, 7]
+# ]
+
+# with range
+range_start = Time.mktime(2014, 10, 16, 23, 0).in_time_zone
+range_end   = Time.mktime(2014, 10, 16, 23, 10).in_time_zone
+range = range_start..range_end
 article.data_for(:views, interval: 10.minutes, range: range)
-#=> [[2014-10-16 23:00:00 +0400, 0], [2014-10-16 23:10:00 +0400, 9]]
+#=> [
+# [Thu, 16 Oct 2014 23:00:00 MSK +04:00, 0]
+# [Thu, 16 Oct 2014 23:10:00 MSK +04:00, 9]
+# ]
+
+# for different time zone (although we have no data for that time)
+range_start = Time.mktime(2014, 10, 16, 23, 0).in_time_zone('UTC')
+range_end   = Time.mktime(2014, 10, 16, 23, 10).in_time_zone('UTC')
+range = range_start..range_end
+article.data_for(:views, interval: 10.minutes, range: range, tz: 'UTC')
+#=> [
+# [Thu, 16 Oct 2014 23:00:00 UTC +00:00, 0] 
+# [Thu, 16 Oct 2014 23:10:00 UTC +00:00, 0]
+# ]
 
 article.data_for(:views, interval: :day)
-#=> [[2014-10-16 00:00:00 +0400, 16]]
+# => [Thu, 16 Oct 2014 00:00:00 MSK +04:00, 16]
 
 article.data_for(:views, interval: :day, raw: true)
-#=> [{"created_at" => "2014-10-16 00:00:00+04", "value" => "16"}]
-# raw result will make difference in performance on a big data
+#=> [{"created_at" => "2014-10-16 00:00:00", "value" => "16"}]
+# The raw result will make difference in performance on a big data.
+# The returned time is in the requested time zone. By default, a normalization
+# looks as `Time.zone.parse(i['created_at']), i['value'].to_i ]`
 
 # class wide
-range = Time.mktime(2014, 10, 15)..Time.mktime(2014, 10, 16)
+range_start = Time.mktime(2014, 10, 15).in_time_zone
+range_end   = Time.mktime(2014, 10, 16).in_time_zone
+range = range_start..range_end
 Article.data_for(:views, interval: :day, range: range)
-#=> [[2014-10-15 00:00:00 +0400, 0], [2014-10-16 00:00:00 +0400, 16]]
+# => [
+# [Thu, 15 Oct 2014 00:00:00 MSK +04:00, 0]
+# [Thu, 16 Oct 2014 00:00:00 MSK +04:00, 16]
+# ]
 ```
 
-Limitations
------------
+## Limitations
 
   - It works *ONLY* with *PostgreSQL* at the moment.
   - ActiveRecord 3+
+  - ActiveSupport 3+
   - It's polymorphic association.
+  - It uses ActiveSupport::TimeWithZone to return user friendly statistics.
+    So, you have to operate with dates with time zones.
   - Use it in production with caution because it's early release.
 
 
-Installation
---------------
+## Installation
 
 Add gem to Gemfile
 

data/event-counter.gemspec

@@ -18,12 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '~> 3'
+  spec.add_dependency 'activerecord', '>= 3'
+  spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'pg', '~> 0'
-
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'database_cleaner', '~> 0'
-  spec.add_development_dependency 'rspec', '~> 3'
-  spec.add_development_dependency 'fabrication', '~> 0'
-  spec.add_development_dependency 'rake', '~> 10.0'
 end

data/gemfiles/pg_ar_30.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rspec"
+gem "database_cleaner"
+gem "activerecord", "~> 3.0"
+gem "activesupport", "~> 3.0"
+gem "pg"
+
+gemspec :path => "../"

data/gemfiles/pg_ar_30.gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: ../
+  specs:
+    event-counter (0.1.0)
+      activerecord (>= 3)
+      activesupport (>= 3)
+      pg (~> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.19)
+      activesupport (= 3.2.19)
+      builder (~> 3.0.0)
+    activerecord (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.19)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    database_cleaner (1.3.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.11)
+    multi_json (1.10.1)
+    pg (0.17.1)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    thor (0.19.1)
+    tzinfo (0.3.41)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0)
+  activesupport (~> 3.0)
+  appraisal
+  database_cleaner
+  event-counter!
+  pg
+  rspec

data/gemfiles/pg_ar_31.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rspec"
+gem "database_cleaner"
+gem "activerecord", "~> 3.1"
+gem "activesupport", "~> 3.1"
+gem "pg"
+
+gemspec :path => "../"

data/gemfiles/pg_ar_31.gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: ../
+  specs:
+    event-counter (0.1.0)
+      activerecord (>= 3)
+      activesupport (>= 3)
+      pg (~> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.19)
+      activesupport (= 3.2.19)
+      builder (~> 3.0.0)
+    activerecord (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.19)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    database_cleaner (1.3.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.11)
+    multi_json (1.10.1)
+    pg (0.17.1)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    thor (0.19.1)
+    tzinfo (0.3.41)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.1)
+  activesupport (~> 3.1)
+  appraisal
+  database_cleaner
+  event-counter!
+  pg
+  rspec

data/gemfiles/pg_ar_32.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rspec"
+gem "database_cleaner"
+gem "activerecord", "~> 3.2"
+gem "activesupport", "~> 3.2"
+gem "pg"
+
+gemspec :path => "../"

data/gemfiles/pg_ar_32.gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: ../
+  specs:
+    event-counter (0.1.0)
+      activerecord (>= 3)
+      activesupport (>= 3)
+      pg (~> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.19)
+      activesupport (= 3.2.19)
+      builder (~> 3.0.0)
+    activerecord (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.19)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    database_cleaner (1.3.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.11)
+    multi_json (1.10.1)
+    pg (0.17.1)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    thor (0.19.1)
+    tzinfo (0.3.41)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2)
+  activesupport (~> 3.2)
+  appraisal
+  database_cleaner
+  event-counter!
+  pg
+  rspec