teambox-things-sync 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle
+*~
+*.cache
+*.log
+*.pid
+.DS_Store
+.rvmrc
+pkg/*
+

data/Gemfile

@@ -0,0 +1,8 @@
+# A sample Gemfile
+source "http://rubygems.org"
+gem 'teambox-client', "0.2.0"
+gem 'things-client', "0.2.4"
+
+group :development do
+  gem 'rspec', '>=2.0.0.beta.20'
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.6)
+    diff-lcs (1.1.2)
+    hashie (0.2.2)
+    httparty (0.5.2)
+      crack (= 0.1.6)
+    rb-appscript (0.5.3)
+    rspec (2.0.0.beta.20)
+      rspec-core (= 2.0.0.beta.20)
+      rspec-expectations (= 2.0.0.beta.20)
+      rspec-mocks (= 2.0.0.beta.20)
+    rspec-core (2.0.0.beta.20)
+    rspec-expectations (2.0.0.beta.20)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.20)
+    teambox-client (0.2.0)
+      hashie (~> 0.2.0)
+      httparty (~> 0.5.0)
+      yajl-ruby (~> 0.7.0)
+    things-client (0.2.4)
+      rb-appscript (>= 0.5.3)
+    yajl-ruby (0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (>= 2.0.0.beta.20)
+  teambox-client (= 0.2.0)
+  things-client (= 0.2.4)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Arkadiusz Holko
+
+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,38 @@
+
+**teambox-things-sync** lets you sync your Things todos to and from Teambox Collaboration Software.
+
+It fetches todos from remote teambox app (project, task name, due date, task list name) and updates completed ones in both ways. Project (named like the one in teambox) will be created in Things if necessary. By default only tasks assigned to you are imported.
+
+Installation
+-------------------------------------------------------------------------------
+
+For now you can install only from source:
+    
+    git clone git://github.com/fastred/teambox-things-sync.git
+    cd teambox-things-sync
+    bundle install
+
+Then create a file $HOME/.teambox with these values:
+
+    username: your_teambox_username_or_email
+    password: password
+    site_url: http://your-teambox-app.com (optional, default set to http://teambox.com)
+
+    
+Usage
+-------------------------------------------------------------------------------
+
+Now you can run:
+
+    ruby sync.rb
+
+You should see output with names of imported tasks.
+
+If it worked you can add it to your crontab:
+
+    1,31 * * * * cd /path/to/teambox-things-sync/ && ruby sync.rb
+
+Legal
+-------------------------------------------------------------------------------
+
+Things is a trademark of Cultured Code GmbH & Co. KG.

data/Rakefile

@@ -0,0 +1,16 @@
+begin
+  require 'rubygems'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "teambox-things-sync"
+    gemspec.summary = "Simple ruby app for Teambox and Things.app syncing"
+    gemspec.email = "fastred@fastred.org"
+    gemspec.homepage = "http://github.com/fastred/teambox-things-sync"
+    gemspec.authors = ["Arkadiusz Holko"]
+    gemspec.add_development_dependency "rspec", ">=2.0.0.beta.20"
+    gemspec.add_dependency "teambox-client", "0.2.0"
+    gemspec.add_dependency "things-client", "0.2.4"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/teambox-things-sync

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'teambox-things-sync'
+require 'teambox-things-sync/command'

data/lib/teambox-things-sync.rb

@@ -0,0 +1,15 @@
+require 'teambox-client'
+require 'things'
+require 'time'
+require 'timeout'
+
+module TeamboxThingsSync
+  autoload :Base, File.dirname(__FILE__) + '/teambox-things-sync/base'
+  autoload :ConfigStore, File.dirname(__FILE__) + '/teambox-things-sync/config_store'
+  autoload :TaskListCache, File.dirname(__FILE__) + '/teambox-things-sync/task_list_cache'
+end
+
+module Things
+   additional_properties = %{properties :tag_names, :due_date}
+   Todo.module_eval(additional_properties)
+end

data/lib/teambox-things-sync/base.rb

@@ -0,0 +1,146 @@
+module TeamboxThingsSync
+  class Base
+    
+    attr_reader :config
+
+    def initialize
+      parse_config_file
+      httpauth = Teambox::HTTPAuth.new(@config['username'], @config['password'],
+                                       :api_endpoint => api_url(@config['teambox_url']))
+      @client = Teambox::Base.new(httpauth)
+    end
+
+    def synchronise
+      Timeout::timeout(@config['timeout_limit']) {
+        begin
+          projects = @client.projects
+        rescue
+          abort "Cannot fetch project list, check your internet connection."
+        end
+    
+        projects.each do |project|
+          log "Started working with #{project.name}"
+          begin
+            mark_as_done_at_remote(project)
+
+            person_id = find_person_id(project.permalink)
+            fetch_tasks_from_remote(project, person_id)
+          rescue
+            abort "Something went wrong while updating.\n" + $!
+          end
+        end
+      }
+    end
+
+
+    def self.find_or_create_project_in_things(project_name)
+      Things::Project.find(project_name) or Things::Project.create(:name => project_name)
+    end
+
+    def self.find_or_create_todo_in_things(todo_name)
+      Things::Todo.find(todo_name) or Things::Todo.create(:name => todo_name)
+    end
+
+    def task_url(project_permalink, task_list_id, task_id)
+      "#{@config['teambox_url']}/projects/#{project_permalink}/"+
+        "task_lists/#{task_list_id}/tasks/#{task_id}"
+    end
+
+    def api_url(url)
+      url.gsub("http://", "")
+    end
+
+    def is_task_open?(status)
+      [0,1].include? status
+    end
+
+    private
+
+      # update tasks marked as done in Things
+      def mark_as_done_at_remote(project)
+        @client.tasks.each do |task|
+          things_todo = Things::Todo.find(task.name)
+          if !things_todo.nil? && things_todo.completed? && is_task_open?(task.status)
+            # API isn't great right now, so we update task as resolved 
+            # and add the new comment to it
+            @client.update_project_task(project.permalink, task.id, {:status => 3})
+            @client.create_project_task_comment(project.permalink, task.id,
+                                                {:status => 3,
+                                                 :body => "Sent from my Things.app"})
+            log "#{task.name} at remote set as done"
+          end
+        end
+      end
+
+      # fetches current task data from remote
+      def fetch_tasks_from_remote(project, person_id)
+        task_list_cache = TaskListCache.new(@client, project.permalink)
+        @client.tasks.each do |task|
+          # grab only tasks assigned to current user
+          if task.assigned_id == person_id
+            things_todo = Base.find_or_create_todo_in_things(task.name)
+            # update only those that aren't completed in both local and remote
+            if is_task_open?(task.status) || !things_todo.completed?
+              things_todo.project = Base.find_or_create_project_in_things(project.name)
+              things_todo.notes = "Don't edit this field!\n" +
+                task_url(project.permalink, task.task_list_id, task.id)
+
+              unless task.due_on.nil?
+                things_todo.due_date = Time.parse(task.due_on)
+              end
+
+              # data from remote has higher priority
+              unless is_task_open?(task.status)
+                things_todo.complete
+              else
+                things_todo.open
+              end
+
+              things_todo.tag_names = task_list_cache[task.task_list_id]
+              things_todo.save
+              log "\"#{task.name}\" has been saved in Things.app"
+            end
+          end
+        end
+      end
+
+      def upload_tasks_to_remote(project)
+        # maybe add task from things to teambox app (in future)
+        # things_project_tasks = things_project.todos
+        # things_project_tasks.each do |todo|
+        #   if !all_tasks.any?{|t| t.name == todo.name}
+        #   end
+        # end
+      end
+
+      # finds person_id in given project
+      def find_person_id(project_permalink)
+        project_people = @client.project_people(project_permalink)
+        project_people.find { |person| person.user_id == @client.account.id }.id
+      end
+
+      def log(text)
+        puts text if @config['output_log']
+      end
+
+    
+      def parse_config_file
+        @config = ConfigStore.new("#{ENV['HOME']}/.teambox")
+        @config['teambox_url'] ||= "http://teambox.com"
+        @config['output_log'] ||= true
+        @config['timeout_limit'] ||= 40
+        check_correctness_of_config
+      end
+    
+      def check_correctness_of_config
+        if @config['username'].nil? || @config['password'].nil?
+          abort "'username' and/or 'password' not found in " +
+            "#{ENV['HOME']}/.teambox file. See README."
+        end
+      
+        unless @config['timeout_limit'].integer?
+          abort "timeout_limit should be a number (integer)"
+        end
+      end
+  end
+end

data/lib/teambox-things-sync/command.rb

@@ -0,0 +1 @@
+TeamboxThingsSync::Base.new.synchronise

data/lib/teambox-things-sync/config_store.rb

@@ -0,0 +1,42 @@
+# borrowed from http://github.com/teambox/teambox-ruby-client/blob/master/examples/helpers/config_store.rb
+module TeamboxThingsSync
+  class ConfigStore
+  
+    attr_reader :file
+
+    def initialize(file)
+      @file = file
+    end
+
+    def load
+      @config ||= YAML::load(open(file))
+      self
+    end
+
+    def [](key)
+      load
+      @config[key]
+    end
+
+    def []=(key, value)
+      @config[key] = value
+    end
+
+    def delete(*keys)
+      keys.each { |key| @config.delete(key) }
+      save
+      self
+    end
+
+    def update(c={})
+      @config.merge!(c)
+      save
+      self
+    end
+
+    def save
+      File.open(file, 'w') { |f| f.write(YAML.dump(@config)) }
+      self
+    end
+  end
+end

data/lib/teambox-things-sync/task_list_cache.rb

@@ -0,0 +1,17 @@
+module TeamboxThingsSync
+  class TaskListCache
+  
+    def initialize(client, project_name)
+      @data = {}
+      @client = client
+      @project_name = project_name
+    end
+
+    def [](task_list_id)
+      if @data[task_list_id].nil?
+        @data[task_list_id] = @client.project_task_list(@project_name, task_list_id).name
+      end
+      @data[task_list_id]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require "bundler/setup"
+require 'teambox-client'
+require 'things'
+require 'time'
+require 'timeout'
+require 'rspec'
+Dir["#{File.dirname(__FILE__)}/../lib/*.rb"].each {|f| require f}

data/spec/teambox-things-sync/base_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "TeamboxThingsSync::Base" do
+  describe "#task_url" do
+    it "should return correct url to teambox.com' task" do
+      sync = TeamboxThingsSync::Base.new
+      sync.task_url("proj", "1", "2").should ==
+        "http://teambox.com/projects/proj/task_lists/1/tasks/2"
+    end
+    
+    it "should return correct url to task if teambox url changed" do
+      sync = TeamboxThingsSync::Base.new
+      sync.config["teambox_url"] = "http://testteambox.com"
+      sync.task_url("proj", "1", "2").should ==
+        "http://testteambox.com/projects/proj/task_lists/1/tasks/2"
+    end
+  end
+
+  describe "#.find_or_create_project_in_things" do
+  
+    it "should find project by name in Things" do
+      Things::Project.should_receive(:find).with("testowy").and_return(true)
+      TeamboxThingsSync::Base.find_or_create_project_in_things("testowy")
+    end
+  
+    it "should create new project in Things if it doesn't exist" do
+      Things::Project.should_receive(:find).with("testowy").and_return(false)
+      Things::Project.should_receive(:create).with(:name => "testowy").and_return(true)
+      TeamboxThingsSync::Base.find_or_create_project_in_things("testowy")
+    end
+  end
+
+  describe "#.find_or_create_todo_in_things" do
+  
+    it "should find todo by name in Things" do
+      Things::Todo.should_receive(:find).with("testowe").and_return(true)
+      TeamboxThingsSync::Base.find_or_create_todo_in_things("testowe")
+    end
+  
+    it "should create new todo in Things if it doesn't exist" do
+      Things::Todo.should_receive(:find).with("testowe").and_return(false)
+      Things::Todo.should_receive(:create).with(:name => "testowe").and_return(true)
+      TeamboxThingsSync::Base.find_or_create_todo_in_things("testowe")
+    end
+  end
+end

data/spec/teambox-things-sync/task_list_cache_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "TeamboxThingsSync::TaskListCache" do
+  pending
+end

data/spec/teambox-things-sync_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TeamboxThingsSync do
+  pending
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: teambox-things-sync
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Arkadiusz Holko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-15 00:00:00 +02:00
+default_executable: teambox-things-sync
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: teambox-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: things-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :runtime
+  version_requirements: *id003
+description: 
+email: fastred@fastred.org
+executables: 
+- teambox-things-sync
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/teambox-things-sync
+- lib/teambox-things-sync.rb
+- lib/teambox-things-sync/base.rb
+- lib/teambox-things-sync/command.rb
+- lib/teambox-things-sync/config_store.rb
+- lib/teambox-things-sync/task_list_cache.rb
+- spec/spec_helper.rb
+- spec/teambox-things-sync/base_spec.rb
+- spec/teambox-things-sync/task_list_cache_spec.rb
+- spec/teambox-things-sync_spec.rb
+has_rdoc: true
+homepage: http://github.com/fastred/teambox-things-sync
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple ruby app for Teambox and Things.app syncing
+test_files: 
+- spec/spec_helper.rb
+- spec/teambox-things-sync/base_spec.rb
+- spec/teambox-things-sync/task_list_cache_spec.rb
+- spec/teambox-things-sync_spec.rb