smartermeter 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0 (January 8th, 2011)
+* First public release

data/Gemfile

@@ -1,2 +1,5 @@
 source :rubygems
 gemspec
+
+# Used only in the Java client, which isn't distributed as a gem
+gem "profligacy"

data/Rakefile

@@ -86,7 +86,7 @@ namespace :rawr do
     dir = File.join(File.dirname(__FILE__), "vendor", "gems")
     FileUtils.rm_rf(dir)
     FileUtils.mkdir_p(dir)
-    ["nokogiri", "mechanize", "crypt"].each do |gem|
+    ["nokogiri", "mechanize", "crypt", "profligacy"].each do |gem|
       `gem unpack -t "#{dir}" #{gem}`
     end
 
@@ -100,6 +100,9 @@ namespace :rawr do
     Dir.glob(File.join(dir, "nokogiri.old", "lib", "*")).each do |file|
       FileUtils.mv(file, File.join(dir))
     end
+    Dir.glob(File.join(dir, "profligacy.old", "lib", "*")).each do |file|
+      FileUtils.mv(file, File.join(dir))
+    end
     FileUtils.mv(File.join(dir, "crypt.old", "crypt"), File.join(dir, "crypt"))
     Dir.glob(File.join(dir, "mechanize.old", "lib", "*")).each do |file|
       FileUtils.mv(file, File.join(dir))
@@ -127,7 +130,7 @@ task :release => :build do
   sh "git tag v#{version}"
   sh "git push origin master"
   sh "git push origin v#{version}"
-  #sh "gem push pkg/#{name}-#{version}.gem"
+  sh "gem push pkg/#{name}-#{version}.gem"
 end
 
 desc "Build #{gem_file} into the pkg directory"

data/bin/smartermeter

@@ -7,4 +7,5 @@ rescue Exception
 end
 require 'smartermeter'
 
-SmarterMeter::Daemon.new.start
+interface = SmarterMeter::Interfaces::CLI.new
+SmarterMeter::Daemon.new(interface).start

data/lib/smartermeter/daemon.rb

@@ -1,11 +1,15 @@
+require 'fileutils'
 require 'crypt/blowfish'
 require 'yaml'
-require 'logger'
 require 'date'
 
 module SmarterMeter
   class Daemon
 
+    def initialize(interface)
+      @ui = interface
+    end
+
     # Loads the configuration, and starts
     #
     # Never returns.
@@ -28,13 +32,6 @@ module SmarterMeter
       File.expand_path(File.join(@config[:data_dir], date.strftime("%Y-%m-%d.csv")))
     end
 
-    def log
-      return @logger if @logger
-      @logger = Logger.new STDOUT
-      @logger.level = Logger::INFO
-      @logger
-    end
-
     # Loads the configuration and prompts for required settings if they are
     # missing.
     #
@@ -49,7 +46,7 @@ module SmarterMeter
     # Returns the configuration hash.
     def load_configuration
       @config = {
-        :start_date => Date.today,
+        :start_date => Date.today - 1,
         :data_dir => default_data_dir
       }
 
@@ -79,32 +76,22 @@ module SmarterMeter
       end
     end
 
+    # Returns true if the all of the required configuration has been set.
+    def has_configuration?
+      @config[:username] and @config[:password]
+    end
+
     # Prompts the user for required settings that are blank.
     #
     # Returns nothing.
     def verify_configuration
-      return if @config[:username] and @config[:password]
-
-      puts
-      puts "Smartermeter: Initial Configuration"
-      puts "--------------------------------------------------------------------------------"
-      puts "This program stores your PG&E account username and password on disk. The"
-      puts "password is encrypted but could be retrieved fairly easily. If this makes you"
-      puts "uncomfortable quit now (use ctrl-c)."
-      puts "--------------------------------------------------------------------------------"
-
-      unless @config[:username]
-        print "PG&E account username: "
-        @config[:username] = gets.strip
-      end
+      return if has_configuration?
 
-      unless @config[:password]
-        print "PG&E account password: "
-        self.password = gets.strip
+      @ui.setup do |config|
+        @config.merge!(config)
+        self.password = config[:password] if config.has_key? :password
+        save_configuration
       end
-
-      save_configuration
-      puts "Setup complete"
     end
 
     # Saves the current configuration to disk.
@@ -124,13 +111,19 @@ module SmarterMeter
       one_hour = 60 * 60
 
       while true
+        unless has_configuration?
+          @ui.log.info("Waiting for configuration")
+          sleep(5)
+          next
+        end
+
         dates = dates_requiring_data
         unless dates.empty?
-          log.info("Attempting to fetch data for: #{dates.join(",")}")
+          @ui.log.info("Attempting to fetch data for: #{dates.join(",")}")
           results = fetch_dates(dates)
-          log.info("Successfully fetched: #{results.join(",")}")
+          @ui.log.info("Successfully fetched: #{results.join(",")}")
         else
-          log.info("Sleeping")
+          @ui.log.info("Sleeping")
         end
         sleep(one_hour)
       end
@@ -141,32 +134,34 @@ module SmarterMeter
     # Note: An authorization failure will cause an exits, as it is a dire
     # condition.
     #
-    # Returns a new Service instance which has been properly authorized.
+    # Returns a new Service instance which has been properly authorized and nil
+    #   otherwise.
     def service
       service = Service.new
-      log.info("Logging in as #{@config[:username]}")
-      unless service.login(@config[:username], password)
-        log.error("Incorrect username or password given.")
-        log.error("Please remove ~/.smartermeter and configure smartermeter again.")
-        exit(-1)
+      @ui.log.info("Logging in as #{@config[:username]}")
+      if service.login(@config[:username], password)
+        @ui.log.info("Logged in as #{@config[:username]}")
+        service
+      else
+        @ui.log.error("Login failed.")
+        @ui.log.error(service.last_page) if service.last_page
+        @ui.log.error(service.last_exception) if service.last_exception
+        @ui.log.error("If this happens repeatedly your login information may be incorrect")
+        @ui.log.error("Remove ~/.smartermeter and restart to re-configure smartermeter.")
+        nil
       end
-      log.info("Logged in as #{@config[:username]}")
-      service
     end
 
     # Connect and authenticate to the PG&E Website.
     #
     # It provides an instance of Service to the provided block
-    # for direct manipulation.
+    # for direct manipulation. If there was a failure logging into the service
+    # the block will not be executed.
     #
     # Returns nothing.
     def connect
       s = service
-      begin
-        yield s
-      rescue SocketError => e
-        log.error("Could not access the PG&E site, are you connected to the Internet?")
-      end
+      yield s if s
     end
 
     # Attempts to retrieve power data for each of the dates in the list.
@@ -179,25 +174,28 @@ module SmarterMeter
 
       connect do |service|
         dates.each do |date|
-          log.info("Fetching #{date}")
+          @ui.log.info("Fetching #{date}")
+
           data = service.fetch_csv(date)
+          next if data.empty?
 
-          log.info("Verifying #{date}")
+          @ui.log.info("Verifying #{date}")
           samples = Sample.parse_csv(data).values.first
           first_sample = samples.first
 
           if first_sample.kwh
-            log.info("Saving #{date}")
+            @ui.log.info("Saving #{date}")
+            FileUtils.mkdir_p(File.dirname(data_file(date)))
             File.open(data_file(date), "w") do |f|
               f.write(data)
             end
 
             upload(date, samples)
 
-            log.info("Completed #{date}")
+            @ui.log.info("Completed #{date}")
             completed << date
           else
-            log.info("Incomplete #{date}")
+            @ui.log.info("Incomplete #{date}")
           end
         end
       end
@@ -208,12 +206,12 @@ module SmarterMeter
     def upload(date, samples)
       case @config[:transport]
       when :google_powermeter
-        log.info("Uploading #{date} to Google PowerMeter")
+        @ui.log.info("Uploading #{date} to Google PowerMeter")
         transport = SmarterMeter::Transports::GooglePowerMeter.new(@config[:google_powermeter])
         if transport.upload(samples)
-          log.info("Upload for #{date} complete")
+          @ui.log.info("Upload for #{date} complete")
         else
-          log.info("Upload for #{date} failed")
+          @ui.log.info("Upload for #{date} failed")
         end
       end
     end

data/lib/smartermeter/interfaces/cli.rb

@@ -0,0 +1,41 @@
+require 'logger'
+
+module SmarterMeter
+  module Interfaces
+    class CLI
+      # Returns a logger like interface to log errors and warnings to.
+      def log
+        return @logger if @logger
+        @logger = Logger.new STDOUT
+        @logger.level = Logger::INFO
+        @logger
+      end
+
+      # Public: Called when ~/.smartermeter needs to be configured.
+      # Yields a hash containing the configuration by the user.
+      #
+      # Returns nothing
+      def setup
+        puts
+        puts "Smartermeter: Initial Configuration"
+        puts "--------------------------------------------------------------------------------"
+        puts "This program stores your PG&E account username and password on disk. The"
+        puts "password is encrypted but could be retrieved fairly easily. If this makes you"
+        puts "uncomfortable quit now (use ctrl-c)."
+        puts "--------------------------------------------------------------------------------"
+
+        config = {}
+
+        print "PG&E account username: "
+        config[:username] = gets.strip
+
+        print "PG&E account password: "
+        config[:password] = gets.strip
+
+        puts "Configuration finished"
+
+        yield config
+      end
+    end
+  end
+end

data/lib/smartermeter/interfaces/swing.rb

@@ -0,0 +1,85 @@
+require 'logger'
+require 'profligacy/swing'
+require 'profligacy/lel'
+
+module SmarterMeter
+  module Interfaces
+    class Swing
+      include_package "java.awt"
+
+      def initialize
+        # TODO: Implement a way to update the settings
+        #settings_item = MenuItem.new("Settings")
+        #settings_item.add_action_listener { SettingsWindow.new do |config|
+        #    puts config.inspect
+        #  end
+        #}
+
+        exit_item = MenuItem.new("Exit")
+        exit_item.add_action_listener {java.lang.System::exit(0)}
+
+        popup = PopupMenu.new
+        #popup.add(settings_item)
+        popup.add(exit_item)
+
+        image = Toolkit::default_toolkit.get_image("icon.png")
+        tray_icon = TrayIcon.new(image, "Smartermeter", popup)
+        tray_icon.image_auto_size = true
+
+        tray = SystemTray::system_tray
+        tray.add(tray_icon)
+      end
+
+      # Returns a logger like interface to log errors and warnings to.
+      def log
+        return @logger if @logger
+        @logger = Logger.new(File.expand_path("~/.smartermeter.log"))
+        @logger.level = Logger::INFO
+        @logger
+      end
+
+      # Public: Called when ~/.smartermeter needs to be configured.
+      # Yields a hash containing the configuration specified by the user.
+      #
+      # Returns nothing.
+      def setup
+        SettingsWindow.new do |config|
+          yield config
+        end
+      end
+    end
+
+    class SettingsWindow
+      include_package "javax.swing"
+
+      def initialize(&block)
+        layout = "
+            [ username_label | (150)username_field ]
+            [ password_label | (150)password_field ]
+            [ _ | >save_button ]
+        "
+
+        @ui = Profligacy::Swing::LEL.new(JFrame, layout) do |c,i|
+          c.username_label = JLabel.new "PG&E Username:"
+          c.username_field = JTextField.new
+          c.password_label = JLabel.new "PG&E Password:"
+          c.password_field = JPasswordField.new
+          c.save_button = JButton.new("Save")
+
+          i.save_button = { :action => proc do |t, e|
+              config = {
+                :username => @ui.username_field.text,
+                :password => @ui.password_field.text
+              }
+              @frame.dispose
+              yield config
+            end
+          }
+        end
+
+        @frame = @ui.build(:args => "Smartermeter Settings")
+        @frame.defaultCloseOperation = JFrame::DISPOSE_ON_CLOSE
+      end
+    end
+  end
+end

data/lib/smartermeter/main.rb

@@ -5,5 +5,7 @@ require 'jruby'
 JRuby.objectspace=true
 
 require 'smartermeter'
+require 'smartermeter/interfaces/swing'
 
-SmarterMeter::Daemon.new.start
+interface = SmarterMeter::Interfaces::Swing.new
+SmarterMeter::Daemon.new(interface).start

data/lib/smartermeter/service.rb

@@ -7,6 +7,9 @@ module SmarterMeter
     OVERVIEW_URL = "https://www.pge.com/csol/actions/login.do?aw"
     ENERGYGUIDE_AUTH_URL = "https://www.energyguide.com/LoadAnalysis/LoadAnalysis.aspx?Referrerid=154"
 
+    attr_reader :last_page
+    attr_reader :last_exception
+
     def initialize
       @agent = WWW::Mechanize.new { |agent|
         agent.user_agent_alias = 'Mac Safari'
@@ -15,64 +18,79 @@ module SmarterMeter
 
     # Returns true upon succesful login and false otherwise
     def login(username, password)
-      @agent.get(LOGIN_URL) do |page|
-        logged_in_page = page.form_with(:action => 'https://www.pge.com/eum/login') do |login|
-          login.USER = username
-          login.PASSWORD = password
-        end.submit
+      begin
+        @agent.get(LOGIN_URL) do |page|
+          logged_in_page = page.form_with(:action => 'https://www.pge.com/eum/login') do |login|
+            login.USER = username
+            login.PASSWORD = password
+          end.submit
+        end
+
+        # There is a crazy meta-reload thing here that mechanize doesn't handle
+        # correctly by itself so let's help it along...
+        @agent.get(OVERVIEW_URL) do |page|
+
+          return false if page.title =~ /PG&E Login/
+
+          # Load the PG&E Terms of Use page
+          tou_link = page.link_with(:href => '/csol/actions/billingDisclaimer.do?actionType=hourly')
+          unless tou_link
+            @last_page = page
+            return false
+          end
+          tou_page = @agent.click(tou_link)
+          form = tou_page.forms().first
+          agree_button = form.button_with(:value => 'I Understand - Proceed')
+
+          # Agree to the terms of use
+          form['agreement'] = 'yes'
+
+          # Load up the PG&E frame page for historical data
+          hourly_usage_container = form.submit(agree_button)
+
+          # Now load up the frame with the content
+          hourly_usage = @agent.click(hourly_usage_container.frames.select{|f| f.href == "/csol/nexus/content.jsp"}.first)
+
+          # Now post the authentication information from PG&E to energyguide.com
+          @data_page = hourly_usage.form_with(:action => ENERGYGUIDE_AUTH_URL).submit
+        end
+        @authenticated = true
+      rescue Exception => e
+        @last_exception = e
+        return false
       end
-
-      # There is a crazy meta-reload thing here that mechanize doesn't handle
-      # correctly by itself so let's help it along...
-      @agent.get(OVERVIEW_URL) do |page|
-
-        return false if page.title =~ /PG&E Login/
-
-        # Load the PG&E Terms of Use page
-        tou_page = @agent.click(page.link_with(:href => '/csol/actions/billingDisclaimer.do?actionType=hourly'))
-        form = tou_page.forms().first
-        agree_button = form.button_with(:value => 'I Understand - Proceed')
-
-        # Agree to the terms of use
-        form['agreement'] = 'yes'
-
-        # Load up the PG&E frame page for historical data
-        hourly_usage_container = form.submit(agree_button)
-
-        # Now load up the frame with the content
-        hourly_usage = @agent.click(hourly_usage_container.frames.select{|f| f.href == "/csol/nexus/content.jsp"}.first)
-
-        # Now post the authentication information from PG&E to energyguide.com
-        @data_page = hourly_usage.form_with(:action => ENERGYGUIDE_AUTH_URL).submit
-      end
-      true
     end
 
     def fetch_csv(date)
-      # TODO: Check if the authentication has been called
+      raise RuntimeException, "login must be called before fetch_csv" unless @authenticated
 
       # Now we almost actually have data. However we need to setup the desired
       # parameters first before we can get the exportable data. This really shouldn't
       # be necessary.
-      hourly_data = @data_page.form_with(:action => "/LoadAnalysis/LoadAnalysis.aspx") do |form|
-        form['__EVENTTARGET'] = "objChartSelect$butSubmit"
-        form['objTimePeriods$objExport$hidChart'] = "Hourly Usage"
-        form['objTimePeriods$objExport$hidChartID'] = 8
-        form['objChartSelect$ddChart'] = 8 # Hourly usage
-
-        form['objTimePeriods$objExport$hidTimePeriod'] = "Week"
-        form['objTimePeriods$objExport$hidTimePeriodID'] = 3
-        form['objTimePeriods$rlPeriod'] = 3
-
-        form['objChartSelect$ccSelectedDate1'] = date.strftime("%m/%d/%Y")
-      end.submit
+      begin
+        hourly_data = @data_page.form_with(:action => "/LoadAnalysis/LoadAnalysis.aspx") do |form|
+          form['__EVENTTARGET'] = "objChartSelect$butSubmit"
+          form['objTimePeriods$objExport$hidChart'] = "Hourly Usage"
+          form['objTimePeriods$objExport$hidChartID'] = 8
+          form['objChartSelect$ddChart'] = 8 # Hourly usage
+
+          form['objTimePeriods$objExport$hidTimePeriod'] = "Week"
+          form['objTimePeriods$objExport$hidTimePeriodID'] = 3
+          form['objTimePeriods$rlPeriod'] = 3
+
+          form['objChartSelect$ccSelectedDate1'] = date.strftime("%m/%d/%Y")
+        end.submit
 
-      # Now the beautiful data...
-      hourly_csv = hourly_data.form_with(:action => "/LoadAnalysis/LoadAnalysis.aspx") do |form|
-        form['__EVENTTARGET'] = "objTimePeriods$objExport$butExport"
-      end.submit
+        # Now the beautiful data...
+        hourly_csv = hourly_data.form_with(:action => "/LoadAnalysis/LoadAnalysis.aspx") do |form|
+          form['__EVENTTARGET'] = "objTimePeriods$objExport$butExport"
+        end.submit
 
-      hourly_csv.body
+        hourly_csv.body
+      rescue Timeout::Error => e
+        @last_exception = e
+        return ""
+      end
     end
   end
 end

data/lib/smartermeter.rb

@@ -2,7 +2,8 @@ require 'smartermeter/sample'
 require 'smartermeter/service'
 require 'smartermeter/daemon'
 require 'smartermeter/transports/google_powermeter'
+require 'smartermeter/interfaces/cli'
 
 module SmarterMeter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/smartermeter.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'smartermeter'
-  s.version           = '0.1.0'
-  s.date              = '2011-01-08'
+  s.version           = '0.2.0'
+  s.date              = '2011-01-25'
   s.rubyforge_project = 'smartermeter'
 
   ## Make sure your summary is short. The description may be as long
@@ -61,6 +61,7 @@ Gem::Specification.new do |s|
   ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
   # = MANIFEST =
   s.files = %w[
+    CHANGELOG.md
     Gemfile
     README.md
     Rakefile
@@ -68,6 +69,8 @@ Gem::Specification.new do |s|
     build_configuration.rb
     lib/smartermeter.rb
     lib/smartermeter/daemon.rb
+    lib/smartermeter/interfaces/cli.rb
+    lib/smartermeter/interfaces/swing.rb
     lib/smartermeter/main.rb
     lib/smartermeter/sample.rb
     lib/smartermeter/service.rb

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
     - 0
-    - 1
+    - 2
     - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
   - Matt Colyer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-08 00:00:00 -08:00
+date: 2011-01-25 00:00:00 -08:00
 default_executable: smartermeter
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -82,6 +82,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+  - CHANGELOG.md
   - Gemfile
   - README.md
   - Rakefile
@@ -89,6 +90,8 @@ files:
   - build_configuration.rb
   - lib/smartermeter.rb
   - lib/smartermeter/daemon.rb
+  - lib/smartermeter/interfaces/cli.rb
+  - lib/smartermeter/interfaces/swing.rb
   - lib/smartermeter/main.rb
   - lib/smartermeter/sample.rb
   - lib/smartermeter/service.rb