basilico 0.0.1

data/README.md

@@ -0,0 +1,52 @@
+# Basilico
+
+Basilico is an event handling framework for the Mac OS X Pomodoro application. You can hook it into the application using the Script section of Pomodoro Preferences. More on this below. While being a framework for events, it also provides useful events out of the box.
+
+## Requirements
+
+Basilico runs on MacRuby. Actually the framework itself should run on any Ruby implementation (tests coming soon), but most of the built-in handlers use the `Basilico::AppHelpers` module which depends on some OS X frameworks.
+
+## Built-in handlers
+
+### Adium, iChat and Skype status and status message
+
+These handlers update your status and status message when starting or ending a pomodoro. Your status will be set to "Do not disturb" or "Away" when starting a pomodoro with "in a Pomodoro" as the status message. Upon ending or resetting the pomodoro your status will be set back to "Online" or "Available" and your status message will be cleared.
+
+### Pomodoro logger
+
+The logger event handler logs every event with the current time and all the arguments into the file `~/pomodoro.log`.
+
+## Setting up Basilico
+
+You should have MacRuby installed. Then install the basilico gem:
+
+    $ gem install basilico
+
+The only thing left is setting up the Pomodoro app to send events to Basilico. You will find example scripts in the `scripts` directory of the repository. Open the preferences window of Pomodoro and setup the scripts in the Scripts tab.
+
+The example scripts use rvm. You can simplify them if you have MacRuby installed some other way.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2010 László Bácsi
+
+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/bin/basilico

@@ -0,0 +1,13 @@
+#!/usr/bin/env macruby
+
+require 'basilico'
+
+event = ARGV.shift
+unless Basilico::EVENTS.include?(event)
+  $stderr.puts "USAGE: #{File.basename(__FILE__)} event [key=value ...]"
+  $stderr.puts "       where event is one of the following:"
+  $stderr.puts "          #{Basilico::EVENTS.join(", ")}"
+  exit 1
+end
+
+Basilico.run_all(event, ARGV)

data/event_handlers/adium_status.rb

@@ -0,0 +1,46 @@
+require 'basilico/app_helpers'
+
+module Basilico
+  module Handlers
+    class AdiumStatus < Basilico::EventHandler
+
+      include Basilico::AppHelpers
+
+      def initialize
+        @adium = find_running_app_by_name("Adium")
+      end
+
+      def start(options={})
+        return unless running?
+        set_status_with_message "Away", "in a Pomodoro"
+      end
+
+      def end(options={})
+        return unless running?
+        set_status_with_message "Available", nil
+      end
+      alias_method :reset, :end
+
+    private
+
+      def running?
+        !!@adium
+      end
+
+      def set_status_with_message(status, message)
+        first_account = nil
+        @adium.accounts.select(&:enabled).each do |account|
+          #unless first_account
+            account.send("go#{status}WithMessage", message)
+            #first_account = account
+          #else
+            # This should work and works in other contexts
+            # but here it throws an exception
+            #account.setStatus(first_account.status)
+          #end
+        end
+      end
+
+    end
+  end
+end

data/event_handlers/ichat_status.rb

@@ -0,0 +1,52 @@
+require 'basilico/app_helpers'
+
+module Basilico
+  module Handlers
+    class IChatStatus < Basilico::EventHandler
+
+      include Basilico::AppHelpers
+
+      ICHAT_STATUSES = {
+        "available" => 1635148140,
+        "away" => 1635213689,
+        "invisible" => 1768846963,
+        "offline" => 1868981868
+      }
+
+      def initialize
+        @ichat = find_running_app_by_name("iChat")
+      end
+
+      def start(options={})
+        return unless running?
+        set_status "away"
+        set_status_message "in a Pomodoro"
+      end
+
+      def end(options={})
+        return unless running?
+        set_status "available"
+        set_status_message ""
+      end
+      alias_method :reset, :end
+
+    private
+
+      def running?
+        !!@ichat
+      end
+
+      def set_status(status)
+        status_id = ICHAT_STATUSES[status]
+        @ichat.setStatus(status_id)
+        # let's wait until the status has actually changed
+        until @ichat.status == status_id; end
+      end
+
+      def set_status_message(message)
+        @ichat.setStatusMessage(message)
+      end
+
+    end
+  end
+end

data/event_handlers/log_events.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+
+module Basilico
+  module Handlers
+    class LogEvents < Basilico::EventHandler
+
+      Basilico::EVENTS.each do |event|
+        define_method(event) do |options|
+          log(event, options)
+        end
+      end
+
+    private
+
+      def log(event, options)
+        File.open(File.expand_path("~/pomodoro.log"), "a") do |f|
+          f.puts "[#{Time.now}] #{event.tr('_', ' ').capitalize}"
+          f.puts YAML.dump(options).gsub(/\A--- \n/, '').gsub(/^/, '  ') unless options.empty?
+        end
+      end
+
+    end
+  end
+end

data/event_handlers/skype_status.rb

@@ -0,0 +1,42 @@
+require 'basilico/app_helpers'
+
+module Basilico
+  module Handlers
+    class SkypeStatus < Basilico::EventHandler
+
+      include Basilico::AppHelpers
+
+      def initialize
+        @skype = find_running_app_by_name("Skype")
+      end
+
+      def start(options={})
+        return unless running?
+        set_status "dnd"
+        set_status_message "in a Pomodoro"
+      end
+
+      def end(options={})
+        return unless running?
+        set_status "online"
+        set_status_message ""
+      end
+      alias_method :reset, :end
+
+    private
+
+      def running?
+        !!@skype
+      end
+
+      def set_status(status)
+        @skype.sendCommand("set userstatus #{status}", scriptName: "basilico")
+      end
+
+      def set_status_message(message)
+        @skype.sendCommand("set profile mood_text #{message}", scriptName: "basilico")
+      end
+
+    end
+  end
+end

data/lib/basilico.rb

@@ -0,0 +1,41 @@
+require 'basilico/event_handler.rb'
+
+module Basilico
+
+  extend self
+
+  EVENTS = %w{start interrupt interrupt_over reset resume end break_end every}
+
+  def handlers
+    @event_handlers ||= []
+  end
+
+  def add_handler(klass)
+    handlers << klass
+  end
+
+  def run_all(event, *vars)
+    options = parse_variables(vars.flatten)
+    handlers.each do |handler|
+      next unless handler.handles?(event)
+      handler.new.send(event, options)
+    end
+  end
+
+private
+
+  def self.parse_variables(vars)
+    vars.inject({}) do |hash, pair|
+      key, value = pair.split("=")
+      value = value.to_i if value =~ /\A\d+\Z/ and key != "title"
+      hash[key] = value
+      hash
+    end
+  end
+
+end
+
+# Load all handlers
+Dir[File.join(File.dirname(__FILE__), "..", "event_handlers", "*.rb")].each do |handler|
+  require(handler)
+end

data/lib/basilico/app_helpers.rb

@@ -0,0 +1,28 @@
+framework 'Foundation'
+framework 'ScriptingBridge'
+
+module Basilico
+  module AppHelpers
+
+  private
+
+    def app(bundle_id)
+      SBApplication.applicationWithBundleIdentifier(bundle_id)
+    end
+
+    def sys_events
+      @_sys_events ||= app("com.apple.SystemEvents")
+    end
+
+    def find_process(name)
+      sys_events.processes.detect {|p| p.name == name}
+    end
+
+    def find_running_app_by_name(name)
+      if process = find_process(name)
+        app(process.bundleIdentifier)
+      end
+    end
+
+  end
+end

data/lib/basilico/event_handler.rb

@@ -0,0 +1,14 @@
+module Basilico
+  class EventHandler
+
+    def self.inherited(subclass)
+      Basilico.add_handler(subclass)
+    end
+
+    def self.handles?(event)
+      handled_events = instance_methods(false).map(&:to_s) & Basilico::EVENTS
+      handled_events.include?(event)
+    end
+
+  end
+end

data/lib/basilico/version.rb

@@ -0,0 +1,3 @@
+module Basilico
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: basilico
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Laszlo Bacsi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-02 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Basilico is a framework for handling Pomodoro events while also providing useful events out of the box
+email: lackac@lackac.hu
+executables: 
+- basilico
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/basilico
+- lib/basilico/app_helpers.rb
+- lib/basilico/event_handler.rb
+- lib/basilico/version.rb
+- lib/basilico.rb
+- event_handlers/adium_status.rb
+- event_handlers/ichat_status.rb
+- event_handlers/log_events.rb
+- event_handlers/skype_status.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/lackac/basilico
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Basilico is an event handling framework for the Mac OS X Pomodoro application
+test_files: []
+