smartermeter 0.2.1 → 0.3.0

data/installer/launch4j.xml

@@ -0,0 +1,27 @@
+<launch4jConfig>
+  <dontWrapJar>true</dontWrapJar>
+  <headerType>console</headerType>
+  <jar>jruby-complete.jar</jar>
+  <outfile>../pkg/base/smartermeter.exe</outfile>
+  <errTitle></errTitle>
+  <cmdLine>main.rb</cmdLine>
+  <chdir>.</chdir>
+  <priority>normal</priority>
+  <downloadUrl>http://java.com/download</downloadUrl>
+  <supportUrl></supportUrl>
+  <customProcName>true</customProcName>
+  <stayAlive>false</stayAlive>
+  <manifest></manifest>
+  <icon>../icons/smartermeter.ico</icon>
+  <var>GEM_HOME=gems</var>
+  <singleInstance>
+    <mutexName>smartermeter</mutexName>
+    <windowTitle>Smartermeter</windowTitle>
+  </singleInstance>
+  <jre>
+    <path></path>
+    <minVersion>1.6.0</minVersion>
+    <maxVersion></maxVersion>
+    <jdkPreference>preferJre</jdkPreference>
+  </jre>
+</launch4jConfig>

data/{lib/smartermeter → installer}/main.rb

@@ -1,11 +1,25 @@
 # Used only to launch from a jar using rawr
 
+require 'rubygems'
 require 'jruby'
 # This is needed for nokogiri to function properly under jruby
 JRuby.objectspace=true
 
 require 'smartermeter'
+require 'smartermeter/daemon'
 require 'smartermeter/interfaces/swing'
 
+# Force character sets of all retrieved documents so that we don't have to have
+# charsets.jar in the JRE
+module WWW
+  class Mechanize
+    class Util
+      def self.detect_charset(src)
+        "ISO-8859-1"
+      end
+    end
+  end
+end
+
 interface = SmarterMeter::Interfaces::Swing.new
 SmarterMeter::Daemon.new(interface).start

data/installer/nsis.nsi

@@ -0,0 +1,102 @@
+;--------------------------------
+;Include Modern UI
+
+  !include "MUI2.nsh"
+
+;--------------------------------
+;General
+
+  ;Name and file
+  Name "Smartermeter (${VERSION})"
+  OutFile "../pkg/smartermeter-${VERSION}.exe"
+
+  ;Default installation folder
+  InstallDir "$PROGRAMFILES\Smartermeter"
+
+  ;Get installation folder from registry if available
+  InstallDirRegKey HKCU "Software\Smartermeter" ""
+
+  ;Request application privileges for Windows Vista
+  RequestExecutionLevel user
+
+;--------------------------------
+;Interface Settings
+
+  !define MUI_ABORTWARNING
+  !define MUI_ICON "../icons/smartermeter.ico"
+
+;--------------------------------
+;Pages
+
+  !insertmacro MUI_PAGE_WELCOME
+  !insertmacro MUI_PAGE_LICENSE "..\LICENSE"
+  !insertmacro MUI_PAGE_COMPONENTS
+  !insertmacro MUI_PAGE_DIRECTORY
+  !insertmacro MUI_PAGE_INSTFILES
+  !insertmacro MUI_PAGE_FINISH
+
+  !insertmacro MUI_UNPAGE_WELCOME
+  !insertmacro MUI_UNPAGE_CONFIRM
+  !insertmacro MUI_UNPAGE_INSTFILES
+  !insertmacro MUI_UNPAGE_FINISH
+
+;--------------------------------
+;Languages
+
+  !insertmacro MUI_LANGUAGE "English"
+
+;--------------------------------
+;Installer Sections
+
+Section "Smartermeter Base" SecBase
+
+  SetOutPath "$INSTDIR"
+
+  ;ADD YOUR OWN FILES HERE...
+  File /r "../pkg/base/*"
+
+  CreateDirectory "$SMPROGRAMS\Smartermeter"
+  CreateShortCut "$SMPROGRAMS\Smartermeter\Smartermeter.lnk" "$INSTDIR\smartermeter.exe"
+  CreateShortCut "$SMPROGRAMS\Smartermeter\Uninstall.lnk" "$INSTDIR\uninstall.exe"
+
+  ;Store installation folder
+  WriteRegStr HKCU "Software\Smartermeter" "" $INSTDIR
+
+  ;Create uninstaller
+  WriteUninstaller "$INSTDIR\uninstall.exe"
+SectionEnd
+
+;--------------------------------
+;Descriptions
+
+  ;Language strings
+  LangString DESC_SecBase ${LANG_ENGLISH} "The smartermeter application."
+
+  ;Assign language strings to sections
+  !insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
+    !insertmacro MUI_DESCRIPTION_TEXT ${SecBase} $(DESC_SecBase)
+  !insertmacro MUI_FUNCTION_DESCRIPTION_END
+
+;--------------------------------
+;Uninstaller Section
+
+Section "Uninstall"
+
+  ;ADD YOUR OWN FILES HERE...
+
+  Delete "$INSTDIR\*.rb"
+  Delete "$INSTDIR\*.jar"
+  Delete "$INSTDIR\*.exe"
+  RMDIR  /r "$INSTDIR\gems"
+  RMDIR  /r "$INSTDIR\icons"
+  RMDIR  /r "$INSTDIR\smartermeter"
+
+  Delete "$SMPROGRAMS\Smartermeter\Smartermeter.lnk"
+  Delete "$SMPROGRAMS\Smartermeter\Uninstall.lnk"
+  RMDIR "$SMPROGRAMS\Smartermeter"
+
+  RMDir "$INSTDIR"
+
+  DeleteRegKey /ifempty HKCU "Software\Smartermeter"
+
+SectionEnd

data/lib/smartermeter/interfaces/swing.rb

@@ -7,6 +7,8 @@ module SmarterMeter
     class Swing
       include_package "java.awt"
 
+      LogFile = File.expand_path("~/.smartermeter.log")
+
       def initialize
         # TODO: Implement a way to update the settings
         #settings_item = MenuItem.new("Settings")
@@ -15,14 +17,29 @@ module SmarterMeter
         #  end
         #}
 
+        update_item = MenuItem.new("Check for Updates")
+        update_item.add_action_listener do
+          desktop = Desktop.getDesktop();
+          uri = Java::JavaNet::URI.new("http://matt.colyer.name/projects/smartermeter/?v=#{SmarterMeter::VERSION}")
+          desktop.browse(uri)
+        end
+
+        log_item = MenuItem.new("View Log")
+        log_item.add_action_listener do
+          LogWindow.new {}
+        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(update_item)
+        popup.add(log_item)
+        popup.add(MenuItem.new("-"))
         popup.add(exit_item)
 
-        image = Toolkit::default_toolkit.get_image("icon.png")
+        image = Toolkit::default_toolkit.get_image("icons/smartermeter-16x16.png")
         tray_icon = TrayIcon.new(image, "Smartermeter", popup)
         tray_icon.image_auto_size = true
 
@@ -33,7 +50,7 @@ module SmarterMeter
       # 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 = Logger.new(LogFile)
         @logger.level = Logger::INFO
         @logger
       end
@@ -43,7 +60,7 @@ module SmarterMeter
       #
       # Returns nothing.
       def setup
-        SettingsWindow.new do |config|
+        Wizard.new do |config|
           yield config
         end
       end
@@ -53,6 +70,8 @@ module SmarterMeter
       include_package "javax.swing"
 
       def initialize(&block)
+        UIManager.set_look_and_feel(UIManager.get_system_look_and_feel_class_name)
+
         layout = "
             [ username_label | (150)username_field ]
             [ password_label | (150)password_field ]
@@ -78,7 +97,389 @@ module SmarterMeter
         end
 
         @frame = @ui.build(:args => "Smartermeter Settings")
-        @frame.defaultCloseOperation = JFrame::DISPOSE_ON_CLOSE
+        @frame.set_location_relative_to(nil)
+        @frame.default_close_operation = JFrame::DISPOSE_ON_CLOSE
+      end
+    end
+
+    class LogWindow
+      include_package "javax.swing"
+
+      LogFile = File.expand_path("~/.smartermeter.log")
+
+      def initialize(&block)
+        UIManager.set_look_and_feel(UIManager.get_system_look_and_feel_class_name)
+
+        layout = "
+            [ log_label  ]
+            [ (600,200)*log_area ]
+            [ >buttons ]
+        "
+
+        log = File.read(LogFile)
+
+        @ui = Profligacy::Swing::LEL.new(JFrame, layout) do |c,i|
+          c.log_label = JLabel.new "Log:"
+
+          textarea = JTextArea.new(log)
+          textarea.set_caret_position(textarea.get_text().length())
+          c.log_area = JScrollPane.new(textarea)
+
+          c.buttons = Profligacy::Swing::LEL.new(JPanel, "[clear|close]") do |cc,ii|
+            cc.clear = JButton.new "Clear"
+            ii.clear = { :action => proc do |t, e|
+                File.open(LogFile, "w") { |f| f.write("") }
+                textarea.text = ""
+              end
+            }
+            cc.close = JButton.new "Close"
+            ii.close = { :action => proc do |t, e|
+                @frame.dispose
+                yield
+              end
+            }
+          end.build :auto_create_container_gaps => false
+        end
+
+        @frame = @ui.build(:args => "Smartermeter Log")
+        @frame.set_location_relative_to(nil)
+        @frame.default_close_operation = JFrame::DISPOSE_ON_CLOSE
+      end
+    end
+
+    class Wizard
+      include_package "javax.swing"
+      include_package "java.awt"
+
+      def initialize
+        UIManager.set_look_and_feel(UIManager.get_system_look_and_feel_class_name)
+
+        layout = "
+            [ panel ]
+            [ rule ]
+            [ >buttons ]
+        "
+
+        @page_index = 0
+
+        @wizard = Profligacy::Swing::LEL.new(JFrame, layout) do |c,i|
+          c.rule = JSeparator.new
+
+          @buttons = Profligacy::Swing::LEL.new(JPanel, "[back|next|>gap|cancel]") do |cc,ii|
+            cc.back = JButton.new "Back"
+            cc.back.minimum_size = Dimension.new(50,14)
+            cc.back.visible = false
+            ii.back = { :action => method(:show_previous_page) }
+
+            cc.next = JButton.new "Next"
+            cc.next.minimum_size = Dimension.new(50,14)
+            cc.next.enabled = false
+            ii.next = { :action => method(:show_next_page) }
+
+            cc.gap = Box.create_horizontal_strut(10)
+
+            cc.cancel = JButton.new "Cancel"
+            cc.cancel.minimum_size = Dimension.new(50,14)
+            ii.cancel =  { :action => proc do |t, e|
+                if cc.cancel.text == "Complete"
+                  config = {
+                    :username => @pages[0].username,
+                    :password => @pages[0].password,
+                    :transport => :google_powermeter,
+                    :google_powermeter => {
+                      :token => @pages[1].token,
+                      :variable => @pages[1].variable,
+                      :auth => @pages[1].auth
+                    }
+                  }
+                else
+                  config = {}
+                end
+
+                @frame.dispose
+                yield config
+              end
+            }
+          end
+          c.buttons = @buttons.build
+
+          @panel = JPanel.new(CardLayout.new)
+          @pages = [PGEPage, GooglePowerMeterPage, CompletePage].map do |klass|
+            page = klass.new(@buttons)
+            @panel.add(page.build, klass.to_s)
+            page
+          end
+          c.panel = @panel
+        end
+
+        @frame = @wizard.build(:args => "SmarterMeter Setup", :auto_create_container_gaps => false) do |frame|
+          frame.default_close_operation = JFrame::DISPOSE_ON_CLOSE
+          frame.set_size(560, 400)
+          frame.set_location_relative_to(nil) # Centers on screen
+        end
+      end
+
+      # Public: Presents the next page of the wizard.
+      #
+      # type  - The symbol representing the name of the event called
+      # event - The Java::Awt::Event that was triggered.
+      #
+      # Returns nothing.
+      def show_next_page(type, event)
+        @page_index += 1
+        configure_buttons
+
+        @panel.get_layout.next(@panel)
+      end
+
+      # Public: Presents the previous page of the wizard.
+      #
+      # type  - The symbol representing the name of the event called
+      # event - The Java::Awt::Event that was triggered.
+      #
+      # Returns nothing.
+      def show_previous_page(type, event)
+        @page_index -= 1
+        configure_buttons
+
+        @panel.get_layout.previous(@panel)
+      end
+
+    protected
+
+      def configure_buttons
+        @pages[@page_index].validate
+
+        if @page_index > 0
+          @buttons.back.visible = true
+        else
+          @buttons.back.visible = false
+        end
+
+        if @page_index == @pages.size - 1
+          @buttons.next.visible = false
+          @buttons.cancel.text = "Complete"
+        else
+          @buttons.next.visible = true
+          @buttons.cancel.text = "Cancel"
+        end
+      end
+
+      module WizardPage
+        include_package "javax.swing"
+        include_package "java.awt"
+
+        # Protected: Creates a panel that includes the header at the top, in
+        # a standard wizard visual format.
+        #
+        # It expects a block, which yields a Profligacy::Swing::LEL object
+        # to attach components and events to.
+        #
+        #     header("Title", "Message") do |c|
+        #       c.controls = JButton.new("Hello World!")
+        #     end
+        #
+        # title    - The text to show in the header as the title.
+        # message  - The text to show under the title in the header.
+        # controls - True adds a controls area to the page, false ignores it.
+        #            Defaults to true.
+        #
+        # Returns nothing.
+        def header(title, message, controls=true)
+          layout = "
+            [ (560,100)*header ]
+          "
+          layout += "[ controls ]" if controls
+
+          @panel = Profligacy::Swing::LEL.new(JPanel, layout) do |c,i|
+            header_layout = "
+                [ <title ]
+                [ <message ]
+            "
+            @header = Profligacy::Swing::LEL.new(JPanel, header_layout) do |cc,ii|
+              cc.title = JLabel.new title
+              cc.message = JEditorPane.new "text/html", message
+              cc.message.background = Color::WHITE
+              cc.message.editable = false
+              cc.message.border = BorderFactory.createEmptyBorder(0, 30, 0, 0)
+              ii.message = { :hyperlink => proc do |t, e|
+                  if e.event_type.to_s == "ACTIVATED"
+                    desktop = Desktop.getDesktop()
+                    uri = Java::JavaNet::URI.new(e.url.to_s)
+                    desktop.browse(uri)
+                  end
+                end
+              }
+            end
+
+            c.header = @header.build
+            c.header.background = Color::WHITE
+
+            yield c if block_given?
+          end
+        end
+
+        def build
+          @panel.build(:auto_create_container_gaps => false)
+        end
+      end
+
+      # Contains the controls and messaging for the PGE page of the wizard.
+      class PGEPage
+        include_package "javax.swing"
+        include_package "java.awt"
+        include WizardPage
+
+        def initialize(buttons)
+          @global_buttons = buttons
+
+          title = "<html><b>Connect to PG&E</b></html>"
+          message  = "Enter your PG&E username and password. If you don't have one,"
+          message += "create one first and then enter it below."
+
+          header(title, message) do |c|
+            layout = "
+                [ username_label | <username_field ]
+                [ password_label | <password_field ]
+                [ _ | create ]
+            "
+
+            @controls = Profligacy::Swing::LEL.new(JPanel, layout) do |cc,ii|
+              cc.username_label = JLabel.new "PG&E Username:"
+              cc.username_field = JTextField.new
+              cc.username_field.maximum_size = Dimension.new(160,14)
+              ii.username_field = { :key => method(:validate) }
+
+              cc.password_label = JLabel.new "PG&E Password:"
+              cc.password_field = JPasswordField.new
+              cc.password_field.maximum_size = Dimension.new(160,14)
+              ii.password_field = { :key => method(:validate) }
+
+              cc.create = JButton.new "Create a PG&E Account"
+              ii.create = { :action => method(:open_pge_sign_up_flow) }
+            end
+            c.controls = @controls.build
+          end
+        end
+
+        # Public: Get the currently set username
+        def username
+          @controls.username_field.text
+        end
+
+        # Public: Get the currently set username
+        def password
+          @controls.password_field.text
+        end
+
+        # Determines whether a user has entered both a username and
+        # password. If they have then the next button is enabled.
+        #
+        # Returns nothing.
+        def validate(*ignored_args)
+          valid = @controls.password_field.text.size > 0 and @controls.username_field.text.size > 0
+          @global_buttons.next.enabled = valid
+        end
+
+        # Opens the PG&E sign up flow for a user to create an account online
+        # if they haven't already.
+        #
+        # type  - The symbol representing the name of the event called
+        # event - The Java::Awt::Event that was triggered.
+        #
+        # Returns nothing.
+        def open_pge_sign_up_flow(type, event)
+          desktop = Desktop.getDesktop()
+          uri = Java::JavaNet::URI.new("https://www.pge.com/eum/registration?TARGET=https://www.pge.com/csol")
+          desktop.browse(uri)
+        end
+      end
+
+      class GooglePowerMeterPage
+        include_package "javax.swing"
+        include_package "java.awt"
+        include WizardPage
+
+        def initialize(buttons)
+          @buttons = buttons
+
+          title = "<html><b>Connect to Google PowerMeter</b></html>"
+          message  = "In order to view your power data on Google PowerMeter you'll need to create an account."
+
+          header(title, message) do |c|
+            layout = "
+                [ create ]
+                [ auth_label ]
+                [ auth_field ]
+            "
+            @controls = Profligacy::Swing::LEL.new(JPanel, layout) do |cc,ii|
+              cc.create = JButton.new "Create a PowerMeter Account"
+              ii.create = { :action => method(:open_google_powermeter_registration) }
+              cc.auth_label = JLabel.new "Then, copy your Authorization Information below:"
+              cc.auth_field = JTextArea.new
+              cc.auth_field.line_wrap = true
+              cc.auth_field.minimum_size = Dimension.new(400, 80)
+              cc.auth_field.maximum_size = Dimension.new(400, 80)
+              ii.auth_field = { :key => method(:validate) }
+            end
+            c.controls = @controls.build
+          end
+        end
+
+        def token
+          CGI.parse(@controls.auth_field.text.strip)["token"][0]
+        end
+
+        def variable
+          CGI.parse(@controls.auth_field.text.strip)["path"][0]+".d1"
+        end
+
+        def auth
+          @controls.auth_field.text.strip
+        end
+
+        # Opens the Google Powermeter registration flow so that users can upload
+        # their data.
+        #
+        # Returns nothing.
+        def open_google_powermeter_registration(*ignored_args)
+            desktop = Desktop.getDesktop()
+            uri = Java::JavaNet::URI.new("https://www.google.com/powermeter/device/activate?mfg=SmarterMeter&model=SmarterMeter&did=PGE&dvars=1")
+            desktop.browse(uri)
+        end
+
+        # Determines whether a user has entered authorization information from
+        # Google.
+        #
+        # Returns nothing.
+        def validate(*ignored_args)
+          @buttons.next.enabled = @controls.auth_field.text.size > 0
+        end
+      end
+
+      class CompletePage
+        include_package "javax.swing"
+        include_package "java.awt"
+        include WizardPage
+
+        def initialize(buttons)
+          @buttons = buttons
+
+          title = "<html><b>SmarterMeter Setup Complete</b></html>"
+          message =  "SmarterMeter will now run in your taskbar and periodically check for new power data "
+          message += "and relay it to Google PowerMeter.<br><br>"
+          message += "If you encounter an issue or would like to help improve SmarterMeter visit <a href='http://github.com/mcolyer/smartermeter/'>http://github.com/mcolyer/smatermeter</a>"
+          message += "<br><br>Enjoy!"
+
+          header(title, message, false)
+        end
+
+        # Enable the next button
+        #
+        # Returns nothing.
+        def validate(*ignored_args)
+          @buttons.next.enabled = true
+        end
       end
     end
   end

data/lib/smartermeter/service.rb

@@ -11,7 +11,7 @@ module SmarterMeter
     attr_reader :last_exception
 
     def initialize
-      @agent = WWW::Mechanize.new { |agent|
+      @agent = Mechanize.new { |agent|
         agent.user_agent_alias = 'Mac Safari'
       }
     end
@@ -68,7 +68,7 @@ module SmarterMeter
       # parameters first before we can get the exportable data. This really shouldn't
       # be necessary.
       begin
-        hourly_data = @data_page.form_with(:action => "/LoadAnalysis/LoadAnalysis.aspx") do |form|
+        hourly_data = @data_page.form_with(:action => "LoadAnalysis.aspx") do |form|
           form['__EVENTTARGET'] = "objChartSelect$butSubmit"
           form['objTimePeriods$objExport$hidChart'] = "Hourly Usage"
           form['objTimePeriods$objExport$hidChartID'] = 8
@@ -82,7 +82,7 @@ module SmarterMeter
         end.submit
 
         # Now the beautiful data...
-        hourly_csv = hourly_data.form_with(:action => "/LoadAnalysis/LoadAnalysis.aspx") do |form|
+        hourly_csv = hourly_data.form_with(:action => "LoadAnalysis.aspx") do |form|
           form['__EVENTTARGET'] = "objTimePeriods$objExport$butExport"
         end.submit
 

data/lib/smartermeter.rb

@@ -5,5 +5,5 @@ require 'smartermeter/transports/google_powermeter'
 require 'smartermeter/interfaces/cli'
 
 module SmarterMeter
-  VERSION = "0.2.1"
+  VERSION = "0.3.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.2.1'
-  s.date              = '2011-01-25'
+  s.version           = '0.3.0'
+  s.date              = '2011-03-14'
   s.rubyforge_project = 'smartermeter'
 
   ## Make sure your summary is short. The description may be as long
@@ -48,13 +48,13 @@ Gem::Specification.new do |s|
 
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
-  s.add_dependency('mechanize', ["= 0.9.3"])
+  s.add_dependency('mechanize', ["= 1.0.0"])
   s.add_dependency('crypt', ["= 1.1.4"])
 
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
-  s.add_development_dependency('rawr', ["~> 1.4.5"])
   s.add_development_dependency('rspec', ["~> 2.4.0"])
+  s.add_development_dependency('minitar', ["~> 0.5.2"])
 
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE
@@ -63,15 +63,21 @@ Gem::Specification.new do |s|
   s.files = %w[
     CHANGELOG.md
     Gemfile
+    LICENSE
     README.md
     Rakefile
     bin/smartermeter
-    build_configuration.rb
+    icons/smartermeter-16x16.png
+    icons/smartermeter-32x32.png
+    icons/smartermeter.ico
+    icons/smartermeter.svg
+    installer/launch4j.xml
+    installer/main.rb
+    installer/nsis.nsi
     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
     lib/smartermeter/transports/cacert.pem