ispusage 0.4.1 → 0.4.2

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/aussiegeek/ispusage"
     gem.authors = ["Alan Harper"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "time_travel"
     gem.add_dependency 'json'
     gem.add_dependency 'nokogiri'
     gem.add_dependency 'mechanize'

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/lib/ispusage/fetchers/au_exetel.rb

@@ -18,14 +18,14 @@ class IspUsage
 
         page = agent.submit(form, form.buttons.first)
 
+        month_start = Time.parse(page.search('/html/body/div/div[3]/div[2]/div[2]/div/p').text.match(/Usage From: (\S+)/)[0])
+        self.month_end = Time.local(month_start.year, month_start.month + 1, month_start.day)
         page.search('.new_usage_content').each do |usage_div|
-          usage_period = UsagePeriod.new
           matches = usage_div.text.match(/^(\d+\.\d+)\D+(\d+)/)
           next if matches.nil?
+          usage_period = self.new_usage_period
           usage_period.used = matches[1].to_f * 1000
           usage_period.quota = matches[2].to_f * 1000
-
-          usage_periods << usage_period
         end
 
         usage_periods.first.label = 'Peak'

data/lib/ispusage/fetchers/au_optus.rb

@@ -27,9 +27,9 @@ class IspUsage
           plan_text = page.search("html>body>div>div>div:nth-of-type(3)>div>div:nth-of-type(2)>div:nth-of-type(4)>div>table tr:nth-of-type(5)>td>table tr:nth-of-type(2)>td>div>table tr:nth-of-type(2)>td:nth-of-type(2)").text
 
           
-          downloads = UsagePeriod.new
-          self.usage_periods << downloads
-          
+          downloads = self.new_usage_period
+          start_date = Time.parse(page.form('UnbilledUsageTableForm')['fromDate'])
+          self.month_end = Time.local(start_date.year, start_date.day + 1, start_date.month - 1)
           downloads.label = phone_no
           downloads.quota = plan_text.match(/(\d+)MB/)[1].to_i
           

data/lib/ispusage/fetchers/au_three.rb

@@ -23,9 +23,8 @@ class IspUsage
         pin_form.pin = options[:pin]
         page = agent.submit(pin_form, pin_form.buttons.first)
         
-        downloads = UsagePeriod.new
-        self.usage_periods << downloads
-
+        downloads = self.new_usage_period
+        self.month_end = Time.parse(page.search("/html/body/div/div/div[3]/div/div[3]/table/tbody/tr/td[4]/p[3]").text)
         downloads.quota = page.search("td[width='190px;']").text.strip.to_i
         downloads.used = downloads.quota - page.search('br+strong.largeclass').text.strip.to_i
       end

data/lib/ispusage/fetchers/au_tpg.rb

@@ -25,12 +25,10 @@ class IspUsage
         page = agent.get('https://cyberstore.tpg.com.au/your_account/index.php?function=checkaccountusage')
 
         usage_text = page.search('table.light_box table tr').text
-        peak = UsagePeriod.new(:label => 'Peak', :type => :balance)
-        usage_periods << peak
+        peak = self.new_usage_period(:label => 'Peak', :type => :balance)
         peak.used = usage_text.match(/\dPeak Downloads used: (\d+)/)[1].to_i
 
-        offpeak = UsagePeriod.new(:label => 'Off Peak', :type => :balance)
-        usage_periods << offpeak
+        offpeak = self.new_usage_period(:label => 'Off Peak', :type => :balance)
         offpeak.used = usage_text.match(/Off-Peak Downloads used: (\d+)/)[1].to_i
 
       end

data/lib/ispusage/fetchers/au_translink.rb

@@ -16,7 +16,7 @@ class IspUsage
         login_form.pass = self.password
         page = agent.submit(login_form, login_form.buttons.first)
 
-        usage = UsagePeriod.new(:type => :balance)
+        usage = self.new_usage_period(:type => :balance)
         self.usage_periods << usage
 
         usage.used = page.search('.results_table/tr[2]/td[2]').text.match(/\d+\.\d+/)[0].to_f

data/lib/ispusage/fetchers/fetcher.rb

@@ -4,12 +4,13 @@ require 'json'
 class IspUsage
   class Fetchers
     class Fetcher
-      attr_accessor :usage_periods, :username, :password, :options, :error
+      attr_accessor :usage_periods, :username, :password, :options, :error, :month_end
       
       def initialize(options)
         @username = options[:username]
         @password = options[:password]
         self.options = options
+        self.month_end = options[:month_end]
         self.usage_periods = []
       end
       
@@ -20,6 +21,11 @@ class IspUsage
           :usage_periods => self.usage_periods.map(&:to_hash)
         }
 
+        unless month_end.nil?
+          hash[:month_end] = month_end
+          hash[:month_used] = month_used
+        end
+
         unless error.nil?
           hash[:error] = error
         end
@@ -30,6 +36,21 @@ class IspUsage
       def to_json
         to_hash.to_json
       end
+
+      def month_used
+        return nil if month_end.nil?
+        month_start = Time.local(month_end.year, month_end.month - 1, month_end.day)
+
+        month_length = month_end.to_f - month_start.to_f
+
+        (1 - (month_end.to_f - Time.now.to_f) / month_length.to_f) * 100
+      end
+
+      def new_usage_period(options = {})
+        usage_period = IspUsage::UsagePeriod.new(self, options)
+        self.usage_periods << usage_period
+        usage_period
+      end
     end
   end
 end

data/lib/ispusage/fetchers/iinet.rb

@@ -15,7 +15,8 @@ class IspUsage
         doc = Nokogiri::XML(xml)
         used = doc.search("/ii_feed[1]/volume_usage[1]/expected_traffic_types[1]/type[1]/@used").text.to_i / 998315 #best I can figure iinet uses base 2 and base 10 bytes
         quota = doc.search("/ii_feed[1]/volume_usage[1]/expected_traffic_types[1]/type[1]/quota_allocation[1]").text.to_i
-        self.usage_periods << UsagePeriod.new(:used => used, :quota => quota)
+        self.month_end = Time.local(Time.now.year,Time.now.month, doc.search("//anniversary").text.to_i)
+        self.new_usage_period(:used => used, :quota => quota)
       end
     end
   end

data/lib/ispusage/fetchers/internode.rb

@@ -40,10 +40,10 @@ class IspUsage
         }
 
         usage_doc = Nokogiri::XML(usage_xml)
-        
+        self.month_end = Time.parse(usage_doc.search("//traffic/@rollover").text)
         used = usage_doc.search("/internode[1]/api[1]/traffic[1]").text.to_i / 1000000
         quota = usage_doc.search("/internode[1]/api[1]/traffic[1]/@quota").text.to_i / 1000000
-        self.usage_periods << UsagePeriod.new(:used => used, :quota => quota)
+        self.new_usage_period(:used => used, :quota => quota)
       end
     end
   end

data/lib/ispusage/usage_period.rb

@@ -1,8 +1,9 @@
 class IspUsage
   class UsagePeriod
-    attr_accessor :quota, :used, :label
+    attr_accessor :quota, :used, :label, :fetcher
     attr_reader :type
-    def initialize(options = {})
+    def initialize(fetcher, options = {})
+      self.fetcher = fetcher
       self.type = :meter
       self.label = ''
       auto_setters = [:quota, :used, :label, :type]
@@ -29,11 +30,14 @@ class IspUsage
         :type => type
       }
 
-      hash.merge!({
-              :quota => quota,
-              :total => total,
-      }) if type == :meter
-
+      if type == :meter
+        hash.merge!({
+                :quota => quota,
+                :total => total
+        })
+        hash[:month_megabytes_used] = month_megabytes_used if month_megabytes_used
+      end
+      
       hash
     end
 
@@ -44,5 +48,10 @@ class IspUsage
         raise IspUsage::InvalidUsagePeriodType
       end
     end
+
+    def month_megabytes_used
+      return nil if fetcher.month_used.nil?
+      fetcher.month_used / 100 * quota
+    end
   end
 end

data/spec/fetchers/au_exetel_spec.rb

@@ -17,6 +17,10 @@ describe IspUsage::Fetchers::AUExetel do
       @usage.fetch_usage
     end
 
+    it "should return last day of usage period" do
+      @usage.month_end.should == Time.parse('2010-04-01')
+    end
+
     describe "peak usage" do
       it "should return usage correctly" do
         @usage.usage_periods.first.used.should == 13150

data/spec/fetchers/au_optus_spec.rb

@@ -15,6 +15,10 @@ describe IspUsage::Fetchers::AUOptus do
       @usage.fetch_usage
     end
 
+    it "should set month end correctly" do
+      @usage.month_end.should == Time.parse('2010-03-03')
+    end
+    
     it "should return usage correctly" do
       @usage.usage_periods.first.used.should == 151
     end

data/spec/fetchers/au_three_spec.rb

@@ -25,5 +25,9 @@ describe IspUsage::Fetchers::AUThree do
     it "should return total correctly" do
       @usage.usage_periods.first.total.should == 500
     end
+
+    it "should set month_end" do
+      @usage.month_end.should == Time.parse('2010-03-06')
+    end
   end
 end

data/spec/fetchers/fetcher_spec.rb

@@ -1,16 +1,33 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'time_travel'
 
 describe IspUsage::Fetchers::Fetcher do
-  it "should return hash for usage information" do
-    @usage = IspUsage::Fetchers::Fetcher.new(:username => 'bob', :password => 'xkcd')
-    @usage.usage_periods << IspUsage::UsagePeriod.new(:used => 500, :quota => 1000, :label => 'All Day')
-    @usage.to_hash.should == {
-      :usage_periods => [{:used => 500, :quota => 1000, :total => 1000, :label => 'All Day', :type => :meter}],
-      :isp => 'Fetcher',
-      :username => 'bob'
-    }
-  end
+  describe "usage hash" do
+    it "without month end" do
+      @usage = IspUsage::Fetchers::Fetcher.new(:username => 'bob', :password => 'xkcd')
+      @usage.new_usage_period(:used => 500, :quota => 1000, :label => 'All Day')
+      @usage.to_hash.should == {
+        :usage_periods => [{:used => 500, :quota => 1000, :total => 1000, :label => 'All Day', :type => :meter}],
+        :isp => 'Fetcher',
+        :username => 'bob'
+      }
+    end
 
+    it "with month end" do
+      at_time '2010-02-04 12:00' do
+        @usage = IspUsage::Fetchers::Fetcher.new(:username => 'bob', :password => 'xkcd', :month_end => Time.parse('2010-02-20'))
+        @usage.new_usage_period(:used => 500, :quota => 1000, :label => 'All Day')
+        @usage.to_hash.should == {
+          :usage_periods => [{:used => 500, :quota => 1000, :total => 1000, :label => 'All Day', :type => :meter, :month_megabytes_used => 500}],
+          :isp => 'Fetcher',
+          :username => 'bob',
+          :month_end => Time.parse('2010-02-20'),
+          :month_used => 50
+        }
+      end
+    end
+  end
+  
   it "should return an error" do
     @usage = IspUsage::Fetchers::Fetcher.new(:username => 'bob', :password => 'xkcd')
     @usage.error = "Invalid username/password"
@@ -22,4 +39,57 @@ describe IspUsage::Fetchers::Fetcher do
             :usage_periods => []
     }
   end
+
+  describe "month used" do
+    before do
+      @usage = IspUsage::Fetchers::Fetcher.new({})
+      @usage.month_end = Time.parse('2010-02-22')
+    end
+    
+    it "should be 100% at the end of the month" do
+      at_time '2010-02-22' do
+        @usage.month_used.should == 100
+      end
+    end
+
+    it "should be 0% at the start of the month" do
+      at_time '2010-01-22' do
+        @usage.month_used.should == 0
+      end
+    end
+
+    it "should be 50% in the middle of the month" do
+      at_time '2010-02-6 12:00' do
+        @usage.month_used.should == 50
+      end
+    end
+  end
+
+  describe "month megabytes used" do
+    before do
+      @usage = IspUsage::Fetchers::Fetcher.new({})
+      @usage_period = IspUsage::UsagePeriod.new(@usage)
+      @usage_period.quota = 50000
+      @usage.usage_periods << @usage_period
+      @usage.month_end = Time.parse('2010-02-22')
+    end
+
+    it "should be 50000MB at the end of the month" do
+      at_time '2010-02-22' do
+        @usage_period.month_megabytes_used.should == 50000
+      end
+    end
+
+    it "should be 0MB at the start of the month" do
+      at_time '2010-01-22' do
+        @usage_period.month_megabytes_used.should == 0
+      end
+    end
+
+    it "should be 25000MB in the middle of the month" do
+      at_time '2010-02-6 12:00' do
+        @usage_period.month_megabytes_used.should == 25000
+      end
+    end
+  end
 end

data/spec/fetchers/iinet_spec.rb

@@ -7,7 +7,10 @@ describe IspUsage::Fetchers::AUIinet do
       FakeWeb.register_uri(:get, 'https://toolbox.iinet.net.au/cgi-bin/new/volume_usage_xml.cgi?action=login&username=user&password=password', :body => fixture)
       options = {:username => 'user', :password => 'password'}
       @usage = IspUsage::Fetchers::AUIinet.new(options)
-      @usage.fetch_usage
+      # xml says end date relative to this month
+      at_time '2010-02-06' do
+        @usage.fetch_usage
+      end
     end
 
     it "should return usage correctly" do
@@ -17,5 +20,9 @@ describe IspUsage::Fetchers::AUIinet do
     it "should return quota correctly" do
       @usage.usage_periods.first.quota.should == 100000
     end
+
+    it "should return last day of usage period" do
+      @usage.month_end.should == Time.parse('2010-02-28')
+    end
   end
 end

data/spec/fetchers/internode_spec.rb

@@ -25,6 +25,10 @@ describe IspUsage::Fetchers::AUInternode do
     it "should return total correctly" do
       @usage.usage_periods.first.total.should == 50000
     end
+
+    it "should return last day of usage period" do
+      @usage.month_end.should == Date.parse('2010-02-21')
+    end
   end
 
   describe "single usage period over limit" do

data/spec/usage_period_spec.rb

@@ -3,41 +3,48 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe IspUsage::UsagePeriod do
   describe "should return hash for usage period" do
     it "should describe a meter" do
-      @usage_period = IspUsage::UsagePeriod.new(:quota => 1000, :used => 500, :label => 'All Day', :type => :meter)
+      @usage = IspUsage::Fetchers::Fetcher.new({})
+      @usage_period = @usage.new_usage_period(:quota => 1000, :used => 500, :label => 'All Day', :type => :meter)
       @usage_period.to_hash.should == {:quota => 1000, :used => 500, :total => 1000, :label => 'All Day', :type => :meter}
     end
 
     it "should describe a balance" do
-      @usage_period = IspUsage::UsagePeriod.new(:used => 500, :label => 'Freezone', :type => :balance)
+      @usage = IspUsage::Fetchers::Fetcher.new({})
+      @usage_period = @usage.new_usage_period(:used => 500, :label => 'Freezone', :type => :balance)
       @usage_period.to_hash.should == {:used => 500, :label => 'Freezone', :type => :balance}
     end
   end
   
   describe "calculate totals" do
     it "when under quota" do
-      @usage_period = IspUsage::UsagePeriod.new(:quota => 1000, :used => 500)
+      @usage = IspUsage::Fetchers::Fetcher.new({})
+      @usage_period = @usage.new_usage_period(:quota => 1000, :used => 500)
       @usage_period.total.should == 1000
     end
     
     it "when over quota" do
-      @usage_period = IspUsage::UsagePeriod.new(:quota => 1000, :used => 1500)
+      @usage = IspUsage::Fetchers::Fetcher.new({})
+      @usage_period = @usage.new_usage_period(:quota => 1000, :used => 1500)
       @usage_period.total.should == 1500
     end
 
     it "when its a balance" do
-      @usage_period = IspUsage::UsagePeriod.new(:used => 1500, :type => :balance)
+      @usage = IspUsage::Fetchers::Fetcher.new({})
+      @usage_period = @usage.new_usage_period(:used => 1500, :type => :balance)
       @usage_period.total.should be_nil
     end
   end
 
   describe "type" do
     before do
-      @usage_period = IspUsage::UsagePeriod.new(:quota => 500, :used => 250)
+      @usage = IspUsage::Fetchers::Fetcher.new({})
+      @usage_period = @usage.new_usage_period(:quota => 500, :used => 250)
     end
 
     it "should set type correctly in initialize" do
-      usage_period = IspUsage::UsagePeriod.new(:type => :balance)
-      usage_period.type.should == :balance
+      @usage = IspUsage::Fetchers::Fetcher.new({})
+      @usage_period = @usage.new_usage_period(:type => :balance)
+      @usage_period.type.should == :balance
     end
 
     it "should default to meter" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ispusage
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Alan Harper
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-10 00:00:00 +10:00
+date: 2010-03-14 00:00:00 +10:00
 default_executable: ispusage
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
+- !ruby/object:Gem::Dependency 
+  name: time_travel
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: json
   type: :runtime