ispusage 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Alan Harper
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= ispusage
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Alan Harper. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ispusage"
+    gem.summary = %Q{Fetch ISP quota Usage}
+    gem.description = %Q{Fetch ISP qutoa usage}
+    gem.email = "alan@aussiegeek.net"
+    gem.homepage = "http://github.com/aussiegeek/ispusage"
+    gem.authors = ["Alan Harper"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ispusage #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/ispusage

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'ispusage'
+ 
+exit IspUsage::Cli.run!(*ARGV)
+

data/lib/ispusage/fetchers/fetcher.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'json'
+
+class IspUsage
+  class Fetchers
+    class Fetcher
+      attr_accessor :usage_periods, :username, :password
+      
+      def initialize(options)
+        @username = options[:username]
+        @password = options[:password]
+        
+        self.usage_periods = []
+      end
+      
+      def to_hash
+        {
+          :isp => self.class.to_s.split('::').last,
+          :username => @username,
+          :usage_periods => self.usage_periods.map(&:to_hash)
+        }
+      end
+      
+      def to_json
+        to_hash.to_json
+      end
+    end
+  end
+end

data/lib/ispusage/fetchers/iinet.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'open-uri'
+require 'nokogiri'
+
+class IspUsage
+  class Fetchers
+    class AUIinet < Fetcher
+      attr_reader :used, :quota
+      def initialize(options)
+        super(options)
+      end
+
+      def fetch_usage
+        xml = open("https://toolbox.iinet.net.au/cgi-bin/new/volume_usage_xml.cgi?action=login&username=#{@username}&password=#{@password}")
+        doc = Nokogiri::XML(xml)
+        used = doc.search("/ii_feed[1]/volume_usage[1]/expected_traffic_types[1]/type[1]/@used").text.to_i / 1048576
+        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)
+      end
+    end
+  end
+end

data/lib/ispusage/fetchers/internode.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'nokogiri'
+require 'net/http'
+require 'net/https'
+
+class IspUsage
+  class Fetchers
+    class AUInternode < Fetcher
+      def initialize(options)
+        super(options)
+      end
+
+      def fetch_usage
+        url = URI.parse("https://@customer-webtools-api.internode.on.net/api/v1.5/")
+        req = Net::HTTP::Get.new(url.path)
+        req.basic_auth @username, @password
+
+        services_xml = ""
+        req = Net::HTTP.new('customer-webtools-api.internode.on.net', 443)
+        req.use_ssl = true
+        req.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        req.start() {|http|
+          req = Net::HTTP::Get.new('/api/v1.5/')
+          req.basic_auth @username, @password
+          response = http.request(req)
+          services_xml = response.body
+        }
+        services_doc = Nokogiri::XML(services_xml)
+        service_id = services_doc.search('/internode[1]/api[1]/services[1]/service[1]').text
+
+        usage_xml = ""
+        req = Net::HTTP.new('customer-webtools-api.internode.on.net', 443)
+        req.use_ssl = true
+        req.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        req.start() {|http|
+          req = Net::HTTP::Get.new("/api/v1.5/#{service_id}/usage")
+          req.basic_auth @username, @password
+          response = http.request(req)
+          usage_xml = response.body
+        }
+
+        usage_doc = Nokogiri::XML(usage_xml)
+        
+        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)
+      end
+    end
+  end
+end

data/lib/ispusage/fetchers.rb

@@ -0,0 +1,3 @@
+require 'ispusage/fetchers/fetcher'
+require 'ispusage/fetchers/iinet'
+require 'ispusage/fetchers/internode'

data/lib/ispusage/usage_period.rb

@@ -0,0 +1,31 @@
+class IspUsage
+  class UsagePeriod
+    attr_accessor :quota, :used, :label
+    def initialize(options = {})
+      self.label = 'No Label Set'
+      auto_setters = [:quota, :used, :label]
+      options.each do |key, value|
+        if auto_setters.include?(key)
+          self.send(key.to_s + '=', value)
+        end
+      end
+    end
+    
+    def total
+      if quota > used
+        return quota
+      else
+        return used
+      end
+    end
+    
+    def to_hash
+      {
+        :quota => quota,
+        :used => used,
+        :total => total,
+        :label => label
+      }
+    end
+  end
+end

data/lib/ispusage.rb

@@ -0,0 +1,46 @@
+require 'ispusage/fetchers'
+require 'ispusage/usage_period'
+require 'optparse'
+require 'pp'
+require 'json'
+
+class IspUsage
+
+  ISPS = [
+    'AUBigpond',
+    'AUIinet',
+    'AUInternode'
+  ]
+
+  class Cli
+    class << self
+      def run!(*args)
+        options = {:output => :text}
+        optparse = OptionParser.new do|opts|
+          opts.on('-i', '--isp isp', 'ISP') {|i| options[:isp] = i}
+          opts.on('-u', '--username username', 'Username') {|u| options[:username] = u}
+          opts.on('-p', '--password password', 'Password') {|p| options[:password] = p}
+          opts.on('-j', '--json', 'JSON Output') {|j| options[:output] = :json}
+        end
+        optparse.parse!
+
+        unless ISPS.include?(options[:isp])
+          puts 'Unknown ISP: ' + options[:isp]
+          return 1
+        end
+
+        ispclass = eval("IspUsage::Fetchers::#{options[:isp]}")
+        fetcher = ispclass.new(options)
+
+        fetcher.fetch_usage
+        case options[:output]
+        when :text
+          puts fetcher.used.to_s + '/' + fetcher.quota.to_s
+        when :json
+          puts fetcher.to_json
+        end
+        return 0
+      end
+    end
+  end
+end

data/spec/fetchers/fetcher_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+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'}],
+      :isp => 'Fetcher',
+      :username => 'bob'
+    }
+  end
+end

data/spec/fetchers/iinet_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe IspUsage::Fetchers::AUIinet do
+  describe "single usage period" do
+    before do
+      fixture = File.read(File.dirname(__FILE__) + '/../fixtures/auiinet_single_account.xml')
+      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
+    end
+
+    it "should return usage correctly" do
+      @usage.usage_periods.first.used.should == 28613
+    end
+
+    it "should return quota correctly" do
+      @usage.usage_periods.first.quota.should == 100000
+    end
+  end
+end

data/spec/fetchers/internode_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe IspUsage::Fetchers::AUInternode do
+  describe "single usage period" do
+    before do
+      services = File.read(File.dirname(__FILE__) + '/../fixtures/auinternode_home.xml')
+      FakeWeb.register_uri(:get, 'https://user:password@customer-webtools-api.internode.on.net/api/v1.5/', :body => services)
+      service = File.read(File.dirname(__FILE__) + '/../fixtures/auinternode_home_usage.xml')
+      FakeWeb.register_uri(:get, 'https://user:password@customer-webtools-api.internode.on.net/api/v1.5/1234567/usage', :body => service)
+
+
+      options = {:username => 'user', :password => 'password'}
+      @usage = IspUsage::Fetchers::AUInternode.new(options)
+      @usage.fetch_usage
+    end
+
+    it "should return usage correctly" do
+      @usage.usage_periods.first.used.should == 38565
+    end
+
+    it "should return quota correctly" do
+      @usage.usage_periods.first.quota.should == 50000
+    end
+  end
+end

data/spec/fixtures/auiinet_single_account.xml

@@ -0,0 +1,152 @@
+<ii_feed>
+    <account_info>
+        <plan>Business 3</plan>
+        <product>adsl_business V2</product>
+    </account_info>
+    <volume_usage>
+        <quota_reset>
+            <anniversary>28</anniversary>
+            <days_so_far>10</days_so_far>
+            <days_remaining>22</days_remaining>
+        </quota_reset>        
+        <expected_traffic_types>
+            <type classification="anytime" used="30003394620">
+                <name>non-free</name>
+                <quota_allocation>100000</quota_allocation>
+                <is_shaped speed="0">false</is_shaped>
+            </type>
+            <type classification="freezone" used="1467105012">
+                <name>freezone</name>
+            </type>
+        </expected_traffic_types>
+        <volume_usage>
+            <day_hour period="2010-01-28">
+                <usage type="anytime">8476364804</usage>
+                <usage type="freezone">19950428</usage>
+            </day_hour>
+            <day_hour period="2010-01-29">
+                <usage type="anytime">5680001329</usage>
+                <usage type="freezone">2678761</usage>
+            </day_hour>
+            <day_hour period="2010-01-30">
+                <usage type="anytime">235408370</usage>
+                <usage type="freezone">55411712</usage>
+            </day_hour>
+            <day_hour period="2010-01-31">
+                <usage type="anytime">158825278</usage>
+                <usage type="freezone">2005748</usage>
+            </day_hour>
+            <day_hour period="2010-02-01">
+                <usage type="anytime">838021923</usage>
+                <usage type="freezone">6545194</usage>
+            </day_hour>
+            <day_hour period="2010-02-02">
+                <usage type="anytime">665067485</usage>
+                <usage type="freezone">5278122</usage>
+            </day_hour>
+            <day_hour period="2010-02-03">
+                <usage type="anytime">518595034</usage>
+                <usage type="freezone">119592204</usage>
+            </day_hour>
+            <day_hour period="2010-02-04">
+                <usage type="anytime">7044499877</usage>
+                <usage type="freezone">1067657233</usage>
+            </day_hour>
+            <day_hour period="2010-02-05">
+                <usage type="anytime">5841971792</usage>
+                <usage type="freezone">118317383</usage>
+            </day_hour>
+            <day_hour period="2010-02-06">
+                <usage type="anytime">544638728</usage>
+                <usage type="freezone">69668227</usage>
+            </day_hour>
+            <day_hour period="2010-02-07">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-08">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-09">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-10">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-11">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-12">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-13">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-14">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-15">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-16">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-17">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-18">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-19">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-20">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-21">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-22">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-23">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-24">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-25">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-26">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+            <day_hour period="2010-02-27">
+                <usage type="anytime">0</usage>
+                <usage type="freezone">0</usage>
+            </day_hour>
+        </volume_usage>
+    </volume_usage>
+    <connections>
+        <ip on_since="2010-02-04 20:38:12">1.2.3.4</ip>
+    </connections>
+</ii_feed>

data/spec/fixtures/auinternode_home.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<internode><api><services count="1"><service type="Personal_ADSL" href="/api/v1.5/1234567">1234567</service></services></api></internode>

data/spec/fixtures/auinternode_home_usage.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<internode>
+    <api>
+        <service type='Personal_ADSL' request='usage'>2659798</service>
+        <traffic name='total' rollover='2010-02-21' plan-interval='Monthly' quota='50000000000' unit='bytes'>38565393900</traffic>
+    </api>
+</internode>

data/spec/ispusage_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Ispusage" do
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib', 'ispusage'))
+require 'ispusage'
+
+require 'rubygems'
+require 'spec'
+require 'spec/autorun'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+Spec::Runner.configure do |config|
+  
+end

data/spec/usage_period_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe IspUsage::UsagePeriod do
+  it "should return hash for usage period" do
+    @usage_period = IspUsage::UsagePeriod.new(:quota => 1000, :used => 500, :label => 'All Day')
+    @usage_period.to_hash.should == {:quota => 1000, :used => 500, :total => 1000, :label => 'All Day'}
+  end
+  
+  describe "calculate totals" do
+    it "when under quota" do
+      @usage_period = IspUsage::UsagePeriod.new(: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_period.total.should == 1500
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: ispusage
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alan Harper
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-13 00:00:00 +10:00
+default_executable: ispusage
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Fetch ISP qutoa usage
+email: alan@aussiegeek.net
+executables: 
+- ispusage
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/ispusage
+- lib/ispusage.rb
+- lib/ispusage/fetchers.rb
+- lib/ispusage/fetchers/fetcher.rb
+- lib/ispusage/fetchers/iinet.rb
+- lib/ispusage/fetchers/internode.rb
+- lib/ispusage/usage_period.rb
+- spec/fetchers/fetcher_spec.rb
+- spec/fetchers/iinet_spec.rb
+- spec/fetchers/internode_spec.rb
+- spec/fixtures/auiinet_single_account.xml
+- spec/fixtures/auinternode_home.xml
+- spec/fixtures/auinternode_home_usage.xml
+- spec/ispusage_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/usage_period_spec.rb
+has_rdoc: true
+homepage: http://github.com/aussiegeek/ispusage
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Fetch ISP quota Usage
+test_files: 
+- spec/fetchers/fetcher_spec.rb
+- spec/fetchers/iinet_spec.rb
+- spec/fetchers/internode_spec.rb
+- spec/ispusage_spec.rb
+- spec/spec_helper.rb
+- spec/usage_period_spec.rb