ofocus_sync 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-05-27
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Quirkey NYC, LLC
+
+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/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/ofocus_sync
+config/hoe.rb
+config/requirements.rb
+lib/ofocus_sync.rb
+lib/ofocus_sync/ofocus_cli.rb
+lib/ofocus_sync/ofocus_sync.rb
+lib/ofocus_sync/version.rb
+test/test_helper.rb
+test/test_ofocus_sync.rb

data/PostInstall.txt

@@ -0,0 +1,3 @@
+For more information on ofocus_sync, see http://quirkey.rubyforge.org/ofocus_sync
+
+

data/README.txt

@@ -0,0 +1,66 @@
+= ofocus_sync
+
+http://quirkey.rubyforge.com/ofocus_sync
+
+== DESCRIPTION:
+
+Until OmniFocus provides a good syncing mechanism this will do:
+ofocus_sync will gzip and upload your .ofocus file (that holds all your GTD data) to an FTP server of your choosing. 
+On the other side you can download the gziped file and ofocus_sync will unzip it and put it in the right place. 
+This is great for syncing between two computers (home/work) with an FTP as a bridge.
+
+== FEATURES/PROBLEMS:
+
+	TODO: s3 syncing/backup
+	TODO: timestamp syncing
+
+== SYNOPSIS:
+
+Run 
+$ ofocus_sync setup
+
+And follow the instructions to set up your configuration
+When you're leaving your computer, quit OmniFocus, then run
+$ ofocus_sync up
+
+When you're at the other side (OmniFocus should not be running):
+$ ofocus_sync down
+
+== REQUIREMENTS:
+
+OmniFocus (duh)
+highline gem
+An FTP account
+
+== INSTALL:
+
+$ sudo gem install ofocus_sync
+
+Then run:
+$ ofocus_sync setup
+and follow the guided instructions
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Quirkey NYC, LLC
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/ofocus_sync

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "../lib/ofocus_sync.rb")
+
+OfocusSync::Cli.new(ARGV.shift)

data/config/hoe.rb

@@ -0,0 +1,75 @@
+require 'ofocus_sync/version'
+
+AUTHOR = 'Aaron Quint'  # can also be an array of Authors
+EMAIL = "aaron@quirkey.com"
+DESCRIPTION = "A simple sync tool for OmniFocus"
+GEM_NAME = 'ofocus_sync' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'quirkey' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+ ['highline','>= 1.4.0',
+  'net-ssh', '>= 2.0.1',
+  'net-sftp','>= 2.0.0']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "quirkey"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = OfocusSync::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'ofocus_sync documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/ofocus_sync.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'ofocus_sync/ofocus_sync'
+require 'ofocus_sync/ofocus_cli'

data/lib/ofocus_sync/ofocus_cli.rb

@@ -0,0 +1,76 @@
+require 'highline/import'
+require 'yaml'
+
+module OfocusSync
+  class Cli
+    
+    ACTIONS =%w{up upload down download setup}
+    SETTINGS_YML = '~/.ofocus'
+
+    def initialize(action)
+      if ACTIONS.include?(action)
+        h1("OfocusSync", :blue)
+        hr
+        self.send(action)
+      else
+        usage
+        exit
+      end
+    end
+
+    def setup
+      h1 "SETUP"
+      hr
+      say "Please follow the instructions that follow to set up OfocusSync\n"
+      settings = OfocusSync::Sync::DEFAULT_OPTIONS.dup
+      yml_path = ask("Where would you like to store your settings? ") {|q| q.default = SETTINGS_YML }
+      h1 "FTP Settings"
+      settings[:host] = ask("FTP Host? ") {|q| q.default = settings[:host] }
+      settings[:username] = ask("Username? ")
+      settings[:password] = ask("Password? ") {|q| q.echo = false }
+      settings[:remote_path] = ask("Remote Path? ") {|q| q.default = settings[:remote_path] }
+      hr
+      h1 "Local Settings"
+      settings[:local_path] = ask("Your OmniFocus support directory? ") {|q| q.default = settings[:local_path] }
+      settings[:ofocus_dir] = ask("Your OmniFocus OmniFocus file? ") {|q| q.default = settings[:ofocus_dir] }
+      hr
+      say("Dumping to your YAML file: #{yml_path}.")
+      yml = YAML.dump(settings)
+      File.open(File.expand_path(yml_path), 'w+') {|f| f << yml }
+      say("Done")
+      hr
+    end
+    
+    def download
+      OfocusSync::Sync.new(load_settings).download
+    end
+    alias :down :download
+    
+    def upload
+      OfocusSync::Sync.new(load_settings).upload
+    end
+    alias :up :upload
+
+    def usage
+      say("USAGE: <%= color(' ofocus_sync [setup|upload|download]', :blue) %>")
+    end
+    
+    protected
+   
+    def h1(text, color = :red)
+      say("<%= color('#{text}', :#{color}) %>")
+    end 
+
+    def hr
+      say("<%= color('#' * 40, :magenta) %>")
+    end
+    
+    def load_settings
+      if File.readable?(File.expand_path(SETTINGS_YML))
+        File.open(File.expand_path(SETTINGS_YML)) {|f| YAML.load(f) }
+      else
+        say "You must run setup before using upload."
+      end
+    end
+  end
+end

data/lib/ofocus_sync/ofocus_sync.rb

@@ -0,0 +1,132 @@
+require 'net/ssh'
+require 'net/sftp'
+require 'ftools'
+
+module OfocusSync
+
+  class Sync
+    DEFAULT_OPTIONS = 
+    {
+      :host => 'localhost',
+      :username => '',
+      :password => '',
+      :ofocus_dir => 'OmniFocus.ofocus',
+      :local_path => '~/Library/Application Support/OmniFocus',
+      :tmpfile  => 'ofocus.tar.gz',
+      :remote_path => 'omnifocus/',
+      :keep_backups => 3 
+      }.freeze
+
+      def initialize(options = {})
+        @options = DEFAULT_OPTIONS.dup.merge(options)
+      end
+
+      def download
+        begin
+          rename_ofocus_file
+          download_zip_file
+          extract_zip_file
+        rescue => e
+          announce("Error: #{e}")
+        end
+      end
+
+      def upload
+        begin
+          announce("Starting upload sync")
+          zip_ofocus_file
+          upload_zip_file
+          announce("Finished upload sync")
+        rescue => e
+          announce("Error: #{e}")
+        end
+      end
+
+      def options
+        #spit out options but clean the password
+      end
+
+      protected
+
+      def upload_zip_file
+        get_connection do |ftp|
+          announce("Sending Ofocus Zip to Remote Host")
+          ftp.upload!(zip_file_path, remote_file_path)
+        end
+        # upload_file_with_progress(zip_file_path, remote_file_path)
+      end
+
+      def download_zip_file
+        get_connection do |ftp|
+          announce("Getting Ofocus Zip from Remote Host")
+          ftp.download!(remote_file_path, zip_file_path)
+        end
+      end
+
+      def zip_ofocus_file
+        announce("Packing OmniFocus dir")
+        tar = "tar -z --create -C #{cli_clean_path(@options[:local_path])} --file=#{cli_clean_path(zip_file_path)} #{@options[:ofocus_dir]}"
+        puts tar
+        `#{tar}`
+      end
+
+      def extract_zip_file
+        announce("Unpacking OmniFocus dir")
+        tar = "cd #{cli_clean_path(@options[:local_path])} && tar -xzvf #{cli_clean_path(zip_file_path)}"
+        puts tar
+        `#{tar}`
+      end
+
+      def rename_ofocus_file
+        announce("Renaming current OmniFocus directory")
+        File.mv(local_file_path,backup_file_path)
+      rescue => e 
+        warn e
+      end
+
+      def cli_clean_path(path)
+        path.gsub(/ /,"\\ ")
+      end
+      
+      def zip_file_path
+        File.join(File.expand_path(@options[:local_path]),@options[:tmpfile])
+      end
+
+      def local_file_path
+        File.join(File.expand_path(@options[:local_path]),@options[:ofocus_dir])
+      end
+
+      def remote_file_path
+        File.join(@options[:remote_path],@options[:tmpfile])
+      end
+
+      def backup_file_path
+        File.join(File.expand_path(@options[:local_path]),"Previous OmniFocus (#{Time.now.strftime('%Y-%m-%d')}).ofocus")
+      end
+
+      # gzip a file
+      # def tar(from, to, options = "")
+      #   command = "tar #{options} '#{from}'"
+      #   command << " '#{to}'" if to
+      #   `#{command}`
+      # end
+
+      # get an sftp connection with the options provided
+      def get_connection
+        announce("Connecting to #{@options[:username]}@#{@options[:host]}")
+        Net::SFTP.start(@options[:host], @options[:username], :password => @options[:password]) do |sftp|
+          yield sftp
+        end
+      end
+
+      # use STDOUT to announce current step
+      def announce(what)
+        puts "[#{Time.now}] #{what}"
+      end
+
+      def progress
+        print "#"
+      end
+
+    end
+  end

data/lib/ofocus_sync/version.rb

@@ -0,0 +1,9 @@
+module OfocusSync #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/ofocus_sync'

data/test/test_ofocus_sync.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestOfocusSync < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: ofocus_sync
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Quint
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-27 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A simple sync tool for OmniFocus
+email: 
+- aaron@quirkey.com
+executables: 
+- ofocus_sync
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+- Rakefile
+- bin/ofocus_sync
+- config/hoe.rb
+- config/requirements.rb
+- lib/ofocus_sync.rb
+- lib/ofocus_sync/ofocus_cli.rb
+- lib/ofocus_sync/ofocus_sync.rb
+- lib/ofocus_sync/version.rb
+- test/test_helper.rb
+- test/test_ofocus_sync.rb
+has_rdoc: true
+homepage: http://quirkey.rubyforge.org
+post_install_message: |+
+  For more information on ofocus_sync, see http://quirkey.rubyforge.org/ofocus_sync
+  
+  
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: quirkey
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: A simple sync tool for OmniFocus
+test_files: 
+- test/test_helper.rb
+- test/test_ofocus_sync.rb