devise_user_metering 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 235ac1530efa4f108ed266bc062097c61c1eb5ba
-  data.tar.gz: 9f2705da414110def3942b74846971a48c1ff1ea
+  metadata.gz: b675bc0b1c171194964694c2778391ef28c721ce
+  data.tar.gz: ae2576392b6882d541d9ac4145a3548a45aad6f8
 SHA512:
-  metadata.gz: 3154a5e58bafcd8ecabf4717d0dacdf174f92ae60c3a8e386cbe45001890b42d6060586b1fd60cc37487527d7549f49c524c64e3f2f2d0897d91ce9737939f9c
-  data.tar.gz: 52ca71e1d748802a99da12e7cf17a4517cfcb55b3558d4d735e8635143ed81afe727a6908c795a3c6ef3aa81a2a1d155d0ef0508721d4e08f8aa5ece8e85541b
+  metadata.gz: 5bfa5e33ddaf0f79dac99c6199fa0f04a8bf2319009bed519f744b677d9e1645b0a0caac2d08075b567affe2fe864f04119d670737d8ba0ca07b05629b6266a2
+  data.tar.gz: 99877f71bfa566b774af1b4db49298dc2a82ae612258135f255516e4c9024237544fe43b4000ce118aca86fc664da016c8e0c3a6a7df24bc7bd64af99e6eb9bc

data/Gemfile

@@ -16,4 +16,5 @@ group :development do
   gem "simplecov", ">= 0"
   gem "timecop"
   gem 'test-unit'
+  gem 'pry-byebug'
 end

data/Gemfile.lock

@@ -40,6 +40,10 @@ GEM
     arel (6.0.2)
     bcrypt (3.1.10)
     builder (3.2.2)
+    byebug (5.0.0)
+      columnize (= 0.9.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     devise (3.5.1)
@@ -82,6 +86,7 @@ GEM
       nokogiri (>= 1.5.9)
     mail (2.6.3)
       mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
     mime-types (2.6.1)
     mini_portile (0.6.2)
     minitest (5.7.0)
@@ -98,6 +103,13 @@ GEM
       rack (~> 1.2)
     orm_adapter (0.5.0)
     power_assert (0.2.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.2.0)
+      byebug (~> 5.0)
+      pry (~> 0.10)
     rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -141,6 +153,7 @@ GEM
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    slop (3.6.0)
     sprockets (3.2.0)
       rack (~> 1.0)
     sprockets-rails (2.3.2)
@@ -164,6 +177,7 @@ DEPENDENCIES
   bundler (~> 1.0)
   devise
   jeweler (~> 2.0.1)
+  pry-byebug
   rails (>= 3.0.4)
   rdoc (~> 3.12)
   shoulda

data/devise_user_metering.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: devise_user_metering 0.0.1 ruby lib
+# stub: devise_user_metering 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "devise_user_metering"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Mike Ihbe"]
-  s.date = "2015-07-29"
+  s.date = "2015-09-04"
   s.description = "Add methods to devise User models that account for active time during a month. Useful for SAAS billings"
   s.email = "we@mustwin.com"
   s.extra_rdoc_files = [
@@ -53,6 +53,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<timecop>, [">= 0"])
       s.add_development_dependency(%q<test-unit>, [">= 0"])
+      s.add_development_dependency(%q<pry-byebug>, [">= 0"])
     else
       s.add_dependency(%q<rails>, [">= 3.0.4"])
       s.add_dependency(%q<devise>, [">= 0"])
@@ -63,6 +64,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<timecop>, [">= 0"])
       s.add_dependency(%q<test-unit>, [">= 0"])
+      s.add_dependency(%q<pry-byebug>, [">= 0"])
     end
   else
     s.add_dependency(%q<rails>, [">= 3.0.4"])
@@ -74,6 +76,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<timecop>, [">= 0"])
     s.add_dependency(%q<test-unit>, [">= 0"])
+    s.add_dependency(%q<pry-byebug>, [">= 0"])
   end
 end
 

data/lib/devise_user_metering/model.rb

@@ -3,38 +3,44 @@
 module Devise
   module Models
     module UserMetering
-      # This function returns a decimal between 0 and 1 that reflects the amount of the month this user has been 'active'
+
+      # takes a time, returns the active interval in that time's month
       def active_proportion_of_month(time)
-        month = time.beginning_of_month
-        end_month = time.end_of_month
+        active_proportion_of_interval(time.beginning_of_month, time.end_of_month)
+      end
 
-        if end_month > Time.now
-          raise StandardError.new("You can't get meter data for incomplete months")
+      # takes an interval start and interval end
+      # returns a decimal between 0 and 1 that reflects the proportion of time in the given interval
+      # that the user has been 'active'
+      def active_proportion_of_interval(interval_start, interval_end)
+        if interval_end > Time.now
+          raise StandardError.new("You can't get meter data for partial intervals")
         end
-        if month < self.activated_at.beginning_of_month
-          raise StandardError.new("No usage data retained for that month")
+        if usage_in_interval?(interval_start, interval_end)
+          raise StandardError.new('No usage data retained for this period of time')
         end
 
-        in_month = ->(time) { (month..end_month).cover?(time) }
-        if in_month.call(self.activated_at) || in_month.call(self.deactivated_at)
-          if !active && self.deactivated_at < month
+        in_interval = ->(time) { (interval_start..interval_end).cover?(time) }
+        if in_interval.call(self.activated_at) || in_interval.call(self.deactivated_at)
+          if !active && self.deactivated_at < interval_start
             return 0
           end
-          month_duration = end_month - month
-          remainder = self.active ? [end_month - self.activated_at, 0].max : 0
-          (remainder + self.rollover_active_duration) / month_duration
+          interval_duration = interval_end - interval_start
+          remainder = self.active ? [interval_end - self.activated_at, 0].max : 0
+          (remainder + self.rollover_active_duration) / interval_duration
         else
           self.active ? 1 : 0
-        end
-
+        end 
       end
 
+      #activates the user to indicate the start of metering
       def activate!
         self.activated_at = Time.new
         self.active = true
         self.save!
       end
 
+      #deactivates the user to indicate the end of metering
       def deactivate!
         now = Time.new
         self.deactivated_at = now
@@ -43,10 +49,18 @@ module Devise
         self.save!
       end
 
+      #indicates the user has been accounted for said month/interval and resets the rollover_active_duration to zero
       def billed!
         self.rollover_active_duration = 0
         self.save!
       end
+
+      private
+
+      def usage_in_interval?(interval_start, interval_end)
+        (self.deactivated_at && self.deactivated_at < interval_start) ||
+          (self.activated_at && self.activated_at > interval_end)
+      end   
     end
   end
 end

data/lib/devise_user_metering/version.rb

@@ -1,6 +1,6 @@
 module DeviseUserMetering
   module Version
-    VERSION = "0.0.1".freeze
+    VERSION = "0.0.2".freeze
   end
 end
 

data/lib/generators/devise_user_metering/templates/migration.rb

@@ -1,6 +1,7 @@
 class DeviseAddLastseenable<%= table_name.camelize.singularize %> < ActiveRecord::Migration
   def self.up
     add_column :<%= table_name %>, :active, :boolean, default: true
+    add_column :<%= table_name %>, :billed_at, :datetime
     add_column :<%= table_name %>, :activated_at, :datetime
     add_column :<%= table_name %>, :deactivated_at, :datetime
     add_column :<%= table_name %>, :rollover_active_duration, :int
@@ -11,7 +12,9 @@ class DeviseAddLastseenable<%= table_name.camelize.singularize %> < ActiveRecord
   
   def self.down
     remove_column :<%= table_name %>, :active, :boolean
+    remove_column :<%= table_name %>, :billed_at, :datetime
     remove_column :<%= table_name %>, :activated_at, :datetime
+    remove_column :<%= table_name %>, :deactivated_at, :datetime
     remove_column :<%= table_name %>, :rollover_active_duration, :int
   end
 end

data/test/test_devise_user_metering.rb

@@ -17,6 +17,13 @@ class UserTest < Test::Unit::TestCase
       assert_in_delta 17.0/31, u.active_proportion_of_month(Time.parse("2015-01-01")), ACCEPTABLE_DELTA # 15 days of 31 in jan 2015
     end
   end
+  
+  should "Track users with an optional custom time span passed in" do
+    u =  new_user(activated_at: Time.parse("2015-01-01"), active: true, rollover_active_duration: 0)
+    Timecop.freeze(Date.parse("2015-03-20")) do
+       assert_equal 1, u.active_proportion_of_interval(Time.parse("2015-01-15"), Time.parse("2015-02-15"))
+    end
+  end
 
   should "Track users activated this month and deactivated this month as a partial month" do
     u = new_user(activated_at: Time.parse("2015-01-10"), active: true, rollover_active_duration: 0)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_user_metering
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mike Ihbe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Add methods to devise User models that account for active time during
   a month. Useful for SAAS billings
 email: we@mustwin.com