ruby-rescuetime 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,16 @@
+= RubyRescuetime
+
+== Ruby port of: https://launchpad.net/rescuetime-linux-uploader
+So, it's basically a inofficial uploader for:
+https://www.rescuetime.com/
+
+_It's probably running only on Ubuntu machines. (Feel free to test)_
+
+== Installation:
+gem install ruby-rescuetime
+
+== Usage:
+ruby-rescuetime --help
+
+This project rocks and uses MIT-LICENSE.
+

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RubyRescuetime'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/bin/ruby-rescuetime

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+# TODO: description
+
+require 'rescuetime/commands'
+

data/lib/rescuetime.rb

@@ -0,0 +1,16 @@
+module Rescuetime
+  require 'rescuetime/debug'
+  require 'rescuetime/extension'
+
+  require 'rescuetime/application'
+  require 'rescuetime/config'
+  require 'rescuetime/loop'
+  require 'rescuetime/uploader'
+
+  # Load Extensions
+  Dir["#{File.dirname(__FILE__)}/rescuetime/extensions/**/*.rb"].each { |f| require f }
+
+  # Load Extensions defined in users home directory
+  Dir["#{Dir.home}/.ruby-rescuetime/extensions/**/*.rb"].each { |f| require f }
+end
+

data/lib/rescuetime/application.rb

@@ -0,0 +1,152 @@
+module Rescuetime
+  class Application
+    include Rescuetime::Debug
+
+    def self.current_application_name
+      cmd = <<-CMD
+        xprop -id `xprop -root |
+          awk '/_NET_ACTIVE_WINDOW/ {print $5; exit;}'` |
+          awk -F = '/WM_CLASS/ {print $2; exit;}'|
+          awk '{print $2}' |
+          sed 's/^"//g' |
+          sed 's/"$//g'
+      CMD
+      `#{cmd}`.strip
+    end
+
+    def self.current_window_title
+      cmd = <<-CMD
+        xprop -id `xprop -root |
+          awk '/_NET_ACTIVE_WINDOW/ {print $5; exit;}'` |
+          awk -F = '/^WM_NAME/ {print $2; exit;}' |
+          sed -e's/^ *"//g' |
+          sed -e's/\\"$//g'
+      CMD
+      `#{cmd}`.strip
+    end
+
+    attr_reader :name, :title, :created_at, :finished_at
+    #protected_class_method :new
+
+    # TODO
+    def self.create(options = {})
+      name  = options[:name] || self.current_application_name
+      klass = Rescuetime::Extension.get(name) || self
+      klass.new(options)
+    end
+
+
+
+    # Constructor: Call with {:debug => true} to get debug messages
+    def initialize(options = {})
+      @debug      = options[:debug]
+      @name       = options[:name]  || current_application_name
+      @title      = options[:title] || current_window_title
+
+      @created_at   = Time.now
+      @finished_at  = nil
+      @active       = true
+    end
+
+    def name
+      @name.gsub("\000", "").gsub("'", "`")
+    end
+
+    def title
+      @title.gsub("\000", "").gsub("'", "`")
+    end
+
+    # Returns: Time of where app where detected to not be active anymore, or
+    # Time now if not finished yet
+    def finished_at
+      (@finished_at || Time.now).to_s[0..-7] # HACK: to remove offset (e.g. + 01:00)
+    end
+
+    def created_at
+      (@created_at || Time.now).to_s[0..-7] # HACK: to remove offset (e.g. + 01:00)
+    end
+
+    # Returns: boolean, if application is still active window
+    def active?
+      return @active unless @active
+
+      @active = @name  == current_application_name &&
+                @title == current_window_title
+      finish! unless @active
+
+      return @active
+    end
+
+    def finished?
+      !active?
+    end
+
+    # Returns difference between StartTime and now if still active, or
+    # StartTime and FinishedTime if not ative anymore
+    def active_time
+      (active?) ? (Time.now - @created_at) : (@finished_at - @created_at)
+    end
+
+    def to_s
+      "#{name}:#{title}:#{extended_info}"
+    end
+
+    def extended_info
+      (@extended_info || "").gsub("\000", "").gsub("'", "`")
+    end
+
+    def os_username
+      @os_username ||= `uname -n`.strip + "\\" + `id -un`.strip
+    end
+
+    # TODO
+    def to_upload_data
+      return "" if name.empty?
+
+      out =  "- os_username: '#{os_username}'\n"
+      out += "  app_name: '#{name}'\n"
+      out += "  window_title: '#{title}'\n"
+      out += "  extended_info: '#{extended_info}'\n"
+      out += "  start_time: #{created_at}\n"
+      out += "  end_time: #{finished_at}\n"
+
+      return out
+    end
+
+
+
+    private
+      def finish!
+        @active = false
+        @finished_at = Time.now
+      end
+
+      def current_application_name
+        application_name(self.class.current_application_name)
+      end
+
+      def current_window_title
+        window_title(self.class.current_window_title)
+      end
+
+      # To be overwritten
+      def application_name(name)
+        name
+      end
+
+      # To be overwritten
+      def window_title(title)
+        title
+      end
+  end
+end
+
+
+
+#- os_username: 'werbeboten-HP-Pavilion-g6-Notebook-PC\werbeboten'
+#  app_name: 'werbeboten@werbeboten-HP-Pavilion-g6-Notebook-PC: ~/Dev/Rails3/BuecherdeParser'
+#  window_title: 'werbeboten@werbeboten-HP-Pavilion-g6-Notebook-PC: ~/Dev/Rails3/BuecherdeParser'
+#  extended_info: ''
+#  start_time: 2012-02-10 11:56:52
+#  end_time: 2012-02-10 11:56:57
+

data/lib/rescuetime/commands.rb

@@ -0,0 +1,50 @@
+require 'rescuetime'
+require 'optparse'
+
+# This hash will hold all of the options
+# parsed from the command-line by OptionParser.
+options = {}
+
+optparse = OptionParser.new do|opts|
+  # Set a banner, displayed at the top of the help screen.
+  opts.banner = "Usage: ruby-rescuetime [options]"
+
+  # Define the options, and what they do
+  opts.on( '-d', '--debug', 'View debug messages' ) do
+    options[:debug] = true
+  end
+
+  opts.on( '-u', '--email EMAIL', 'Your email login used.' ) do |email|
+    options[:email] = email
+  end
+
+  opts.on( '-p', '--password PASSWORD', 'Your password used.' ) do |password|
+    options[:password] = password
+  end
+
+  options[:config] = File.join(Dir.home, ".ruby-rescuetime", "config.yml")
+  opts.on( '-c', '--config FILE', 'Path to your config-file. (Default: ~/.ruby-rescuetime/config.yml)' ) do |config|
+    options[:config] = config
+  end
+
+  options[:path] = File.join(Dir.home, ".ruby-rescuetime")
+  opts.on('--path PATH', 'Path to your config directory. (Default: ~/.ruby-rescuetime/)' ) do |path|
+    options[:path] = path
+  end
+
+  # This displays the help screen, all programs are assumed to have this option.
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+end
+
+# Parse the command-line. Remember there are two forms
+# of the parse method. The 'parse' method simply parses
+# ARGV, while the 'parse!' method parses ARGV and removes
+# any options found there, as well as any parameters for
+# the options. What's left is the list of files to resize.
+optparse.parse!
+
+Rescuetime::Loop.new(options)
+

data/lib/rescuetime/config.rb

@@ -0,0 +1,83 @@
+module Rescuetime
+  class Config
+    include Rescuetime::Debug
+    require 'fileutils'
+    require 'yaml'
+
+    DEFAULT_PATH = File.join(Dir.home, ".ruby-rescuetime")
+    DEFAULT_FILE = "config.yml"
+
+    DEFAULT_CONFIG = {
+      :email    => "foo@example.com",
+      :password => ""
+    }
+
+    # Constructor
+    def initialize(options = {})
+      options = {
+        :debug    => false,
+        :email    => nil,
+        :password => nil,
+        :config   => File.join(DEFAULT_PATH, DEFAULT_FILE),
+        :path     => nil
+      }.merge(options)
+
+      @debug        = options[:debug]
+      @config_path  = options[:config] || File.join(options[:path] || DEFAULT_PATH, DEFAULT_FILE)
+      config        = read_config(@config_path)
+
+      @config = {
+        :email    => options[:email]    || config[:email],
+        :password => options[:password] || config[:password],
+        :path     => DEFAULT_PATH       || config[:path]
+      }
+      update if @config != config
+    end
+
+    def email
+      @config[:email]
+    end
+
+    def password
+      @config[:password]
+    end
+
+    # Path where to store data
+    def path
+      @config[:path]
+    end
+
+    def location
+      @config_path
+    end
+
+    # Write current config to disc
+    def update
+      update_config(@config, @config_path)
+    end
+
+
+
+    private
+      def read_config(path)
+        create_config_file(path) unless File.exist?(path)
+        YAML::load(File.open(path))
+      end
+
+      def create_config_file(path)
+        write_config_file(DEFAULT_CONFIG, path)
+      end
+
+      def update_config(config, path)
+        write_config_file(config, path)
+      end
+
+      def write_config_file(config, path)
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, 'w') do |f|
+          f.write(YAML::dump(config))
+        end
+      end
+  end
+end
+

data/lib/rescuetime/debug.rb

@@ -0,0 +1,18 @@
+module Rescuetime
+  module Debug
+    # Debug-mode turned on?
+    def debug?
+      @debug == true
+    end
+
+    private
+      # Debug-Wrapper
+      def debug(msg = nil, &block)
+        return unless debug?
+
+        puts msg if msg
+        yield if block_given?
+      end
+  end
+end
+

data/lib/rescuetime/extension.rb

@@ -0,0 +1,29 @@
+module Rescuetime
+  module Extension
+    @extensions = {}
+
+    def self.included(klass)
+      # TODO: raise "No APPLICATION constant defined."
+
+      app = klass::APPLICATION.to_s
+      if @extensions[app]
+        warn <<-WARN
+          Extension for given APPLICATION (#{app}) allready exists.
+          Class: #{klass}
+          Trace: #{caller.first.inspect}
+        WARN
+      end
+
+      @extensions[app] = klass
+    end
+
+    def self.extensions
+      @extensions
+    end
+
+    def self.get(key)
+      @extensions[key.to_s]
+    end
+  end
+end
+

data/lib/rescuetime/extensions/chromium.rb

@@ -0,0 +1,32 @@
+class Rescuetime::Chromium < Rescuetime::Application
+  APPLICATION = "Chromium-browser"
+  include Rescuetime::Extension
+  include Rescuetime::Debug
+
+  def window_title(given_title)
+    title = given_title.gsub(/- Chromium$/, '').strip
+    t = title.downcase
+    if t["google mail"]
+      return "http://www.mail.google.com"
+    elsif t["twitter"]
+      return "http://www.twitter.com"
+    elsif t["facebook"]
+      return "http://www.facebook.com"
+    else
+      return t
+    end
+  end
+
+  alias :old_name :name
+  def name
+    ["google mail", "twitter", "facebook"].each do |e|
+      return "#{e} - chromium" if title[e]
+    end
+    "#{title} - chromium"
+  end
+
+#  def extended_info
+#    title
+#  end
+end
+