siri_cal 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 BOUNMY Stephane
+
+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.md

@@ -0,0 +1,155 @@
+SiriCal
+=======
+
+SiriCal is a simple limited solution to handle [iOS 5 Siri feature][s] in your Ruby app :
+
+* provides Siri helpers to your ruby app by synchronizing google calendar events.
+* an alternative limited solution before Apple release an API for Siri.
+* relies on google_calendar gem : [google_calendar][gc].
+
+This gem is much inspired by Tyson Tale's hack: [siri_says][ss].
+
+Installation
+------------
+
+#### Rails app
+
+You can use the latest Rails 3 gem with the latest SiriCal gem:
+
+In your gemfile
+      
+    gem 'siri_cal'
+
+or using rubygems
+
+    gem install siri_cal
+
+After you install SiriCal, you need to run the generator:
+
+    rails generate siri_cal:install
+
+The generator will install:
+
+* an initializer which describes most SiriCal’s configuration options.
+* a step file which describe siri sayings
+
+#### iPhone
+
+Add the calendar:
+
+1. Settings
+2. "Mail, Contacts, Calendars"
+3. "Add Account..."
+4. "Other"
+5. "Add CalDAV Account"
+    * Server: google.com
+    * Username: username@gmail.com
+    * Password: ___________
+    * Description: "sirical"
+6. "Next"
+
+Choose the calendar as default so Siri will add events to it:
+
+1.  Settings
+1.  "Mail, Contacts, Calendars"
+2.  "Default Calendar" --> sirical
+
+Usage
+-----
+
+A model
+
+    class User < ActiveRecord::Base
+      siriable
+      has_many  :movies
+    end
+    
+
+Be sure to have 2 fields containing your google calendar
+
+* login (siriable_login here)
+* password (siriable_password here)
+
+db/schema.rb should look like:
+
+    create_table "users", :force => true do |t|
+      t.string   "name"
+      t.string   "siriable_login"
+      t.string   "siriable_password"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+In lib/siri_says/default.rb
+
+    says /a movie (.+)/i do |movie_name|
+      puts "[Siri] Movie '#{movie_name}' scheduled by #{@object.name} at #{@event.start_time}"
+    end
+
+* @object is the User instance "bob"
+* @event is the Google::Event instance
+
+Tell Siri:
+    
+    "Schedule a movie transformers right now."
+
+In your ruby code:
+
+    user = User.create :name => "bob", :siriable_login => "bob@gmail.com", :siriable_password => "bobibob"
+    user.execute_siri!
+
+(seconds later)
+
+    [Siri] Movie 'transformers' scheduled by bob at 2010-11-08 12:20
+
+Example of events
+------------------
+
+From [Siri Says][ss] :
+
+#### Immediate events
+
+To create an immediate event, you can either create an event "now" or "all-day tomorrow":
+
+* "Schedule a movie right now"
+* "Schedule an event right now: movie"
+* "Schedule an appointment tomorrow, all-day: movie"
+* "New appointment now: movie"
+* Etc.
+
+#### Scheduled events
+
+Create events that fire later just like you would any other scheduled event:
+
+* "New appointment for tomorrow at 4am: deploy"
+* "Schedule a deploy tomorrow at 4am"
+* "Schedule an event tomorrow at 4am: deploy"
+* "Schedule an appointment tomorrow, at 4am: deploy"
+* Etc.
+
+Compatibility
+-------------
+
+Tested under Rails 3.X.
+
+Contribute
+----------
+
+Pull requests for features and bug fix with tests are welcome.
+
+This is my first gem so please consider this as beta version.
+
+TODO
+----
+
+* Find an asynchronous way to get calendar events.
+* Possibility to use different caldav servers, not only gmail.
+
+License
+-------
+
+This project rocks and uses MIT-LICENSE.
+
+[s]: http://www.apple.com/iphone/features/siri.html
+[ss]: https://github.com/tysontate/siri_says
+[gc]: https://github.com/northworld/google_calendar

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    = 'SiriCal'
+  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/lib/generators/install.rb

@@ -0,0 +1,16 @@
+module SiriCal
+  module Generators
+    class InstallGenerator < Rails::Generators::Base #:nodoc:
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Copies siri says file"
+
+      def copy_siri_says_default
+        copy_file "siri_says/default.rb", "lib/siri_says/default.rb"
+      end
+
+      def copy_config
+        copy_file "siri_cal.rb", "config/initializers/siri_cal.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/siri_cal.rb

@@ -0,0 +1,13 @@
+SiriCal.setup do |config|
+  # Configure the path containing the siri says files.
+  config.siri_says_path = "lib/siri_says"
+
+  # Set the delete event policy
+  # :success  delete event only when event matches one of the siri says block
+  # :always   delete event once it is fetched from calendar
+  # :none     never delete event
+  config.delete_event = :success
+
+  # Set the calendar name to connect to. Default: "sirical"
+  # config.calendar_name = "sirical"
+end

data/lib/generators/templates/siri_says/default.rb

@@ -0,0 +1,3 @@
+says /^(?:|a )movie (.+)$/i do |movie_name|
+  puts "[Siri] Movie #{movie_name} scheduled by #{@object.name} at #{@event.start_time}"
+end

data/lib/siri_cal.rb

@@ -0,0 +1,41 @@
+Bundler.require
+require 'active_support/concern'
+require 'active_support/dependencies'
+require 'rails/generators'
+
+require 'generators/install'
+require 'siri_cal/say_proxy'
+require 'siri_cal/methods'
+
+module SiriCal
+  extend ActiveSupport::Concern
+  class RedundantError < StandardError; end;
+
+  # Public: String path of the siri's says files. Default: "lib/siri_says"
+  mattr_accessor :siri_says_path
+  @@siri_says_path = "lib/siri_says"
+
+  # Public: String path of the siri's says files. Default: :success
+  mattr_accessor :delete_event
+  @@delete_event = :success
+
+  # Public: String name of the caldav calendar to connect to. Default: "sirical"
+  mattr_accessor :calendar_name
+  @@calendar_name = "sirical"
+
+  def self.setup
+    yield self
+  end
+
+  module StepMethods
+    def says(regexp=nil, &block)
+      @proxy = SayProxy
+      @proxy << Say.new(regexp, &block) if regexp && block
+      @proxy
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, SiriCal
+Object.send :include, SiriCal::StepMethods

data/lib/siri_cal/methods.rb

@@ -0,0 +1,49 @@
+require 'google_calendar'
+
+module SiriCal
+  module ClassMethods
+    # Public: Initialize a Siriable object.
+    #
+    # options - The Hash options used to redefine the config (default: {}):
+    #           :login  - The Symbol login field to sign in with (default: :login).
+    #           :password - The Symbol login field to sign in with (default: :password).
+    #
+    # Examples
+    #
+    #   siriable :login => :caldav_login, :password => :caldav_password
+    #
+    #
+    # Returns nothing.
+
+    def siriable options={}
+      config = {}
+      config[:login] = options.delete(:login) || :siriable_login
+      config[:password] = options.delete(:password) || :siriable_password
+      config.each do |key, value|
+        define_method "siri_cal_#{key}" do
+          self.send(value)
+        end
+      end
+    end
+  end
+
+  module InstanceMethods
+    # Public: Initialize calendar
+    #
+    # Returns an instance of Google::Calendar.
+    def calendar
+      Google::Calendar.new :username => siri_cal_login, :password => siri_cal_password, :calendar => calendar_name
+    end
+
+    # Public: GET calendar's event and run then according to block defined in lib/siri_says.rb
+    #
+    # Returns nothing.
+    def execute_siri!
+      SayProxy.load_files
+      calendar.events.to_a.each do |event|
+        res = SayProxy.invoke_say(event, self)
+        event.delete if (res && delete_event == :success) || delete_event == :always
+      end
+    end
+  end
+end

data/lib/siri_cal/say_proxy.rb

@@ -0,0 +1,63 @@
+module SiriCal
+
+  class Say
+    def initialize(regexp, &block)
+      self.regexp, self.block = regexp, block
+    end
+
+    attr_accessor :regexp, :block, :captures
+  end
+
+  class SayProxy
+    class << self
+      def proxy
+        @proxy ||= []
+      end
+
+      def <<(say)
+        proxy << say
+      end
+
+      def count
+        proxy.count
+      end
+
+      def matches_says(name)
+        proxy.select { |say| !!(say.regexp =~ name and say.captures = $~.captures) }
+      end
+
+      def invoke_say(event, object=nil)
+        matches = matches_says(event.title)
+        raise RedundantError, "You should have only one say step that matches \"#{name}\"" if matches.size > 1
+        if !matches.empty?
+          m = matches.first
+          @object, @event = object, event
+          self.instance_exec(*m.captures, &m.block)
+          return true
+        end
+        false
+      end
+
+      def clear
+        proxy.clear
+      end
+
+      # Internal : Load only once Siri says files
+      #
+      # Returns true on success
+      # Returns false if already loaded
+      def load_files
+        return false unless proxy.empty?
+        Dir.glob(File.join(SiriCal.siri_says_path, "*")).each do |filename|
+          load File.expand_path(filename)
+        end
+        true
+      end
+
+      def all
+        proxy
+      end
+    end
+
+  end
+end

data/lib/siri_cal/version.rb

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

data/lib/tasks/siri_cal_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :siri_cal do
+#   # Task goes here
+# end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/