quirkey-purse 0.1.1

data/History.txt

@@ -0,0 +1,10 @@
+ == 0.1.1 2008-10-29
+
+* minor enhancements:
+  * Error handling for git integration
+  * Prompt before creating pockets
+
+ == 0.1.0 2008-10-28
+
+* 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/purse
+lib/purse.rb
+lib/purse/cli.rb
+lib/purse/error.rb
+lib/purse/note.rb
+lib/purse/pocket.rb
+lib/purse/settings.rb
+lib/purse/version.rb
+lib/purse/help.txt

data/PostInstall.txt

@@ -0,0 +1,2 @@
+
+For more information on purse, see http://quirkey.com/blog

data/README.txt

@@ -0,0 +1,82 @@
+= purse
+
+http://quirkey.rubyforge.org/purse
+
+== DESCRIPTION:
+
+A simple way of storing private/sensitive info and then sharing it with others using git
+
+== SYNOPSIS:
+
+Purse stores information in a two level folder system. The basic piece of stored information is a 'note'. 
+A 'pocket' is a folder containing one to many notes. A *pocket* can be synced between mutlple users/computers 
+using a remote git repository.
+
+To configure for the first time:
+
+	purse
+
+and follow the handy on screen instructions.
+
+To create a new pocket/note.
+
+	purse pocketname notename
+
+It will prompt you asking if you want to create the note.
+Once you've edited in your favorite editor and saved, purse 
+will use Blowfish to encrypt the note with the password you provide. 
+
+Then you can display the note with:
+
+	purse pocketname notename
+
+or edit with:
+
+	purse pocketname notename --edit
+
+Each time it will ask you for the password you initially provided to encrypt it.
+
+For more commands/info run:
+
+	purse --help
+
+== REQUIREMENTS:
+
+purse requires a couple of gems, namely 
+	highline -- for command line tools
+	termios		
+	crypt	 -- for encryption
+	git		 -- for uh, git
+
+== INSTALL:
+
+	sudo gem install purse
+
+then run
+	
+	purse
+
+== 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/purse

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+#
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'purse')
+
+Purse::Cli.run(ARGV)

data/lib/purse.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'git'
+require 'crypt/blowfish'
+require 'highline'
+require 'yaml'
+
+require 'purse/error'
+require 'purse/settings'
+require 'purse/pocket'
+require 'purse/note'
+require 'purse/cli'

data/lib/purse/cli.rb

@@ -0,0 +1,247 @@
+module Purse
+  class Cli
+
+    ACTION_PREFIX = /^--/
+
+    # purse pursename #=> initialize or pull
+    # purse pursename notename #=> pocket.find(notename) if it doesnt exist first pull then ask if you want to create it
+    # purse pursename notename --edit #=> open in EDITOR save and push
+    # purse pursename push
+    # purse pursename pull
+    # purse settings/ purse # rerun settings 
+    class << self
+      def run(args)
+        begin
+          banner
+          settings_exist?
+          action = args.detect {|a| a =~ ACTION_PREFIX }
+          args.reject! {|a| a == action}
+          pocket_name, note_name = args[0], args[1]
+          if !action.nil? && action != ''
+            action = action.gsub(ACTION_PREFIX,'')
+            send(action, *([pocket_name, note_name].compact))
+          else
+            case note_name
+            when 'push'
+              push(pocket_name)
+            when 'pull'
+              pull(pocket_name)
+            when '' 
+            when nil
+              list(pocket_name)
+            else
+              find(pocket_name, note_name)
+            end
+          end
+        rescue MissingFile
+          say("Could not find note: #{pocket_name}/#{note_name}")
+        rescue Git::GitExecuteError => e
+          say(e)
+        rescue NoMethodError => e
+          say("Sorry, there is no action #{action}.\nTry purse --help for a list of commands. #{e}")
+        end
+        hr
+      end
+
+      protected
+      def settings
+        h1('Setup utility')
+        hr
+        say("loading settings from : #{Settings.path}")
+        Settings.load
+        settings = {}
+        settings[:root_path] = cli.ask("Root Path for pockets? ") {|q| q.default = Settings.get(:root_path) || File.join(File.expand_path('~'), '.purse', 'pockets') }
+        settings[:editor]    = cli.ask("Editor for notes? ") {|q| q.default = Settings.get(:editor) || 'vim' }
+        hr
+        say("saving settings to : #{Settings.path}")
+        Settings.settings = settings
+      end
+
+      def init(pocket_name)
+        pocket = Pocket.new(pocket_path(pocket_name))
+        if !pocket.exists?
+          say("could not find pocket /#{pocket_name}")
+          if cli.agree("would you like to create it? (y/n)")
+            pocket.init
+          else
+            exit
+          end
+        end
+        pocket
+      end
+
+      def find(pocket_name, note_name)
+        say("loading note #{pocket_name}/#{note_name}")
+        hr
+        pocket = init(pocket_name)
+        note = pocket.find(note_name)
+        display(note)
+      rescue MissingFile
+        say("could not find note: #{pocket_name}/#{note_name}")
+        if cli.agree("would you like to create it? (y/n)")
+          edit(pocket_name, note_name)
+        end
+      end
+
+      def display(note)
+        decrypt(note)
+        h1("Note: #{note.name}",:green)
+        hr
+        say(note.data)
+        hr
+      end
+
+      def save(note, password = nil)
+        password ||= cli.ask("Password: ") { |q| q.echo = false }
+        note.save(password)
+      end
+
+      def decrypt(note)
+        return unless note.encrypted?
+        password = cli.ask("Password: ") { |q| q.echo = false }
+        note.decrypt(password)
+        password
+      end
+
+      def edit(pocket_name, note_name)
+        say("loading note #{pocket_name}/#{note_name}")
+        hr
+        pocket = init(pocket_name)
+        pocket.edit(note_name) do |note|
+          password = decrypt(note)
+          tmp_path = empty_temp_path
+          File.open(tmp_path, 'w') {|f| f << note.data }
+          execute("#{editor} #{tmp_path}")
+          sleep(2)
+          data = ""
+          File.open(tmp_path, 'r') {|f| data << f.read }
+          note.data = data
+          hr
+          say("saving note #{pocket_name}/#{note_name}")
+          save(note, password)
+        end
+      end
+
+      def delete(pocket_name, note_name = nil)
+        pocket = init(pocket_name)
+        if note_name
+          note = pocket.find(note_name)
+          note.delete if cli.agree("are you sure you want to delete #{pocket_name}/#{note_name}? (y/n)")
+        else
+          pocket.delete if cli.agree("are you sure you want to delete /#{pocket_name}? (y/n)")
+        end
+      end
+
+      def push(pocket_name)
+        pocket = init(pocket_name)
+        say("Committing local changes for #{pocket_name}")
+        pocket.commit
+        hr
+        set_remote(pocket_name)
+        say("Pulling changes from remote (#{pocket.remote})")
+        pocket.pull
+        hr
+        say("Pushing changes to remote (#{pocket.remote})")
+        pocket.push
+      end
+
+      def pull(pocket_name)
+        pocket = init(pocket_name)
+        say("Committing local changes for #{pocket_name}")
+        pocket.commit
+        hr
+        set_remote(pocket_name)
+        say("Pulling changes from remote (#{pocket.remote})")
+        pocket.pull
+      end
+
+      def set_remote(pocket_name)
+        pocket = init(pocket_name)
+        unless pocket.remote
+          remote_url = cli.ask("please enter your remote git url (git@github ...)")
+          pocket.set_remote(remote_url)
+          say("set remote to #{remote_url}")
+        end
+      end
+
+      def help(*args)
+        h1("Help", :yellow)
+        hr
+        help_text = File.open(File.join(File.dirname(__FILE__),'help.txt')) {|f| f.read }
+        say(help_text)
+      end
+
+      def list(pocket_name = nil, note_name = nil)
+        unless pocket_name
+          h1("Listing your Pockets", :green)
+          hr
+          pockets = Dir[File.join(Settings.get(:root_path), '*')].find_all {|file| File.directory?(file) }
+          if pockets.empty?
+            say("no pockets yet. create one with 'purse pocketname'")
+          else
+            pockets.each {|p| say("/#{File.basename(p)}/") }
+          end
+        else
+          pocket = init(pocket_name)
+          say("Notes in <%= color '(#{pocket_name})', :red %>")
+          hr
+          pocket.notes.each do |note| 
+            say("- #{note.name}") 
+          end
+        end
+      end
+
+      def settings_exist?
+        return if Settings.get(:root_path) && Settings.get(:editor)
+        h1("you must configure purse before you use it", :red)
+        settings
+        say("rerun this utility any time with purse --settings")
+        exit
+      end
+
+      def pocket_path(pocket_name)
+        File.join(Settings.get(:root_path), pocket_name)
+      end
+
+      def editor
+        Settings.get(:editor)
+      end
+
+      def banner
+        hr
+        h1('/ Purse /', :white)
+        hr
+      end
+
+      def h1(text, color = :red)
+        say("<%= color('#{text}', :#{color}) %>")
+      end 
+
+      def hr(color = :magenta)
+        say("<%= color('-' * 40, :#{color}) %>")
+      end
+
+      def say(message)
+        cli.say(message)
+      end
+
+      def cli
+        @cli ||= HighLine.new
+      end
+
+      def execute(command)
+        `#{command}`
+      end
+
+      def random_temp_name
+        "#{rand Time.now.to_i}-#{rand(1000)}--"
+      end
+
+      def empty_temp_path
+        temp_dir = File.join(Settings.get(:root_path), 'tmp')
+        FileUtils.mkdir_p(temp_dir)
+        File.join(temp_dir, random_temp_name)
+      end
+    end
+  end
+end

data/lib/purse/error.rb

@@ -0,0 +1,10 @@
+module Purse
+  class Error < RuntimeError; end 
+  
+  class MissingParameter < Error; end;
+  class MissingFile      < Error; end
+  
+  def self.check_for_parameter(name, param)
+    raise MissingParameter, "You must set a #{name}" if param.nil? || param.strip == ''
+  end
+end

data/lib/purse/help.txt

@@ -0,0 +1,54 @@
+-- General --
+
+Purse stores information in a two level folder system. 
+The basic piece of stored information is a 'note'. 
+A 'pocket' is a folder containing one to many notes. 
+A *pocket* can be synced between mutlple users/computers using a remote git repository.
+
+-- Commands --
+
+purse
+purse --list
+
+	List Pockets
+	
+purse --help
+
+	Display this message
+	
+purse --settings
+
+	Run the settings utility
+	
+purse pocketname
+
+	List the notes in pocket 'pocketname'
+
+purse pocketname --delete
+
+	Destroy the pocket: pocketname
+	
+purse pocketname --pull
+
+	Pull the pocket 'pocketname' from a remote git repository.
+	Will prompt for URL the first time its run.
+	
+purse pocketname --push
+
+	Push the pocket 'pocketname' to a remote git repository.
+	Will prompt for URL the first time its run.
+	
+purse pocketname notename
+
+	Display or create the note 'notename' in the pocket 'pocketname'.
+	Will prompt for password.
+	
+purse pocketname notename --edit
+
+	Edit or create the note 'notename' in the pocket 'pocketname'.
+	Will prompt for password.
+
+purse pocketname notename --delete
+
+	Delete the note 'notename' in the pocket 'pocketname'.
+