belphanior-calendar-watcher-servant 0.0.1

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/bin/calendar-watcher-servant

@@ -0,0 +1,121 @@
+#!/usr/bin/ruby1.8
+require 'rubygems'
+require 'belphanior/servant_caller'
+require 'belphanior/servant/servant'
+require 'belphanior/servant/calendar_watcher/calendar_watcher'
+require 'json'
+require 'logger'
+require 'net/http'
+require 'uri'
+require 'sinatra'
+
+# Watches an iCal-compatible calendar and---when a "tick" message is sent---
+# checks for events having occurred between the previous tick and the new tick.
+# Any events that have occurred are fired to a specified server.
+
+servant_init
+
+REQUIRED_VARIABLES = %q{
+calendar url: The URL of the calendar that should be read.
+servant url: The URL of the protocol for the target servant.
+}
+
+if servant_config.get("calendar url") == nil or
+    servant_config.get("servant url") == nil then
+  puts "Some required variables were missing."
+  puts REQUIRED_VARIABLES
+  exit true
+end
+
+if servant_config.get("update seconds") == nil then
+  servant_config.set("update seconds", 60)
+end
+
+add_role_description(
+  {
+    "name" => "timed",
+    "description" => "A servant that can be remotely-triggered to perform some periodic action.",
+    "commands" => [
+                   {
+                     "name" => "step",
+                     "description" => "Execute the behavior of this servant.",
+                     "arguments" => []
+                   }
+                 ]
+  })
+
+def build_role_hash(roles)
+  role_hash = {}
+  roles.each do |role|
+    role_url = role["role_url"]
+    if role_url.start_with? "/" then
+      role_uri = URI(servant_config.get("servant url")) + role_url
+    else
+      role_uri = URI(role_url)
+    end
+    puts "Connect to #{role_uri}"
+    role_code = JSON.parse(Net::HTTP.get_response(role_uri).body)
+    role_hash[role_uri.to_s] = role_code
+  end
+
+  role_hash
+end
+
+def connect_to_servant
+  # TODO(mtomczak): This should be refactored into common library code.
+  protocol_uri = URI(servant_config.get("servant url") + "/protocol")
+  puts "Connect to #{protocol_uri}"
+  protocol = JSON.parse(Net::HTTP.get_response(protocol_uri).body)
+  roles = build_role_hash(protocol["roles"])
+
+  Belphanior::ServantCaller.new(
+    Logger.new(STDOUT),
+    servant_config.get("servant url"),
+    protocol,
+    roles)
+
+end
+
+def do_events(event_names)
+  caller = connect_to_servant
+  event_names.each do |event_name|
+    caller.tell_by_name("commandable") do |servant|
+      servant.do event_name
+    end
+  end
+end
+
+add_handler("step", "", "POST", "/step", "") {
+  new_datetime = DateTime.now
+  watcher = Belphanior::Servant::CalendarWatcher::CalendarWatcher.new(
+    servant_config.get("calendar url"))
+  puts "Retrieving events between #{settings.last_time} and #{new_datetime}"
+  event_names = watcher.get_events_between_times(settings.last_time, new_datetime)
+  set(:last_time, new_datetime)
+  do_events event_names
+}
+
+# Test command: Tries to execute all operations between 1/1/2012 and 12/12/2012
+get "/calendar" do
+  new_datetime = DateTime.new
+  watcher = Belphanior::Servant::CalendarWatcher::CalendarWatcher.new(
+    servant_config.get("calendar url"))
+  do_events (watcher.get_events_between_times(DateTime.parse("1/1/2012"), DateTime.parse("12/12/2012")))
+end
+
+set(:last_time, DateTime.now)
+
+# Self-requesting thread that updates the calendar periodically.
+tick_thread = Thread.new do
+  while true
+    http = Net::HTTP.new(servant_config.get("ip"), servant_config.get("port").to_i)
+    begin
+      request = Net::HTTP::Post.new("/step")
+      request.body = ""
+      http.request(request)
+    rescue
+    end
+    sleep(servant_config.get("update seconds").to_i)
+  end
+end
+

data/lib/belphanior/servant/calendar_watcher/calendar_watcher.rb

@@ -0,0 +1,51 @@
+# Calendar watcher
+require 'rubygems'
+require 'ri_cal'
+require 'net/https'
+
+module Belphanior
+  module Servant
+    module CalendarWatcher
+      class CalendarWatcher
+        attr_accessor :calendar_url
+        def initialize(calendar_url)
+          @calendar_url = calendar_url
+        end
+        # Retrieve all events that happened between start_time and end_time,
+        #  which are DateTime objects.
+        # Returns: Array of strings which are event names for events between
+        #  start_time and end_time
+        def get_events_between_times(start_time, end_time)
+          filtered_events = []
+          calendar = get_calendar
+          events = calendar.events
+          events.each do |event|
+            event.occurrences(:overlapping =>
+              [start_time, end_time]).each do |occurrence|
+                if occurrence.dtstart >= start_time then
+                  puts "Event occurred:"
+                  puts occurrence.summary
+                  puts "Time:"
+                  puts occurrence.dtstart
+                  filtered_events << (occurrence.summary)
+                end
+            end
+          end
+          filtered_events
+        end
+
+        # Retrieves the calendar from the server.
+        def get_calendar
+          uri = URI(@calendar_url)
+          http_session = Net::HTTP.new(uri.host, uri.port)
+          http_session.use_ssl=true
+          http_session.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+          request = Net::HTTP::Get.new(uri.request_uri)
+          response = http_session.request(request)
+          (RiCal.parse_string(response.body))[0]
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: belphanior-calendar-watcher-servant
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mark T. Tomczak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ri_cal
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: belphanior-servant
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id002
+description: |
+  Watches a specified iCal-format calendar for events. When the time
+  for an event comes, sends the name of the event to a servant that
+  supports the "commandable" role
+  (http://belphanior.net/roles/commandable/v1).
+  
+  For example, say you have an iCal at www.foo.com/calendar that has an entry
+  named "wake me up" at 10AM today. If you have a servant at 127.0.0.1:3000
+  that supports "commandable" and understands the "wake me up" command,
+  you could run the calendar_watcher_servant with a servant_config file
+  that looks as follows:
+  {
+    "ip":"127.0.0.1",
+    "port":"4000",
+    "calendar url":"http://www.foo.com/calendar"
+    "servant url":"http://127.0.0.1:3000"
+    "update seconds":"60"
+  }
+  
+  With this configuration, the calendar watcher servant will check the
+  calendar every 60 seconds for new events. When it checks after 10AM,
+  it will discover the "wake me up" event and send it to the servant at
+  127.0.0.1:3000.
+
+email: belphanior+calendar-watcher@fixermark.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- lib/belphanior/servant/calendar_watcher/calendar_watcher.rb
+- bin/calendar-watcher-servant
+homepage: http://belphanior.net
+licenses: 
+- http://www.apache.org/licenses/LICENSE-2.0.txt
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Watches for events and notifies a servant when events occur.
+test_files: []
+