boom 0.1.2 → 0.2.0

data/CHANGELOG.markdown

@@ -2,6 +2,16 @@
 
 ## head
 
+## 0.2.0
+- Add Keychain storage to store Boom data securely in OS X's Keychain.app.
+  Thanks, [@davidtrogers](https://github.com/davidtrogers)!
+- Switch from yajl-ruby because [OS X isn't for
+  developers](http://zachholman.com/2011/03/osx-isnt-for-developers/). Thanks
+  for finishing it up, [@antonlindstrom](https://github.com/antonlindstrom).
+- Move dependencies to Bundler, because it's the One True Way™ at this point.
+- Some README updates.
+- `boom -v`.
+
 ## 0.1.2
 - Copy to clipboard doesn't hang anymore. Sweet. Thanks,
   [mcollina](https://github.com/mcollina).

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    boom (0.1.2)
+      json_pure (~> 1.5.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    json_pure (1.5.1)
+    mocha (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  boom!
+  mocha (~> 0.9.9)

data/README.markdown

@@ -13,12 +13,30 @@ For more details about what boom is and how it works, check out
 
     gem install boom
 
+## Quick and Dirty
+
+    $ boom gifs
+    Boom! Created a new list called "gifs".
+
+    $ boom gifs melissa http://cl.ly/3pAn/animated.gif
+    Boom! "melissa" in "gifs" is "http://cl.ly/3pAn/animated.gif". Got it.
+
+    $ boom melissa
+    Boom! Just copied http://cl.ly/3pAn/animated.gif to your clipboard.
+
+And that's just a taste! I know, you're salivating, I can hear you from here.
+(Why your saliva is noisy is beyond me.) Check out the [full list of
+commands](https://github.com/holman/boom/wiki/Commands).
+
 ## Contribute
 
-I'd love to include your contributions, friend. Make sure your methods are
-[TomDoc](http://tomdoc.org)'d properly, that existing tests pass (`rake`), and
-that any new functionality includes appropriate tests. Bonus points if you're
-not updating the gemspec or bumping boom's version.
+I'd love to include your contributions, friend.
+
+Clone this repository, then run `bundle install`. That'll install all the gem
+dependencies. Make sure your methods are [TomDoc](http://tomdoc.org)'d
+properly, that existing tests pass (`rake`), and that any new functionality
+includes appropriate tests. Bonus points if you're not updating the gemspec or
+bumping boom's version.
 
 All good? Cool! Then [send me a pull request](https://github.com/holman/boom/pull/new/master)!
 

data/boom.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'boom'
-  s.version           = '0.1.2'
-  s.date              = '2011-03-11'
+  s.version           = '0.2.0'
+  s.date              = '2011-04-11'
   s.rubyforge_project = 'boom'
 
   ## Make sure your summary is short. The description may be as long
@@ -54,7 +54,7 @@ Gem::Specification.new do |s|
 
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
-  s.add_dependency('yajl-ruby', "~> 0.7.8")
+  s.add_dependency('json_pure', "~> 1.5.1")
 
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
@@ -66,6 +66,8 @@ Gem::Specification.new do |s|
   # = MANIFEST =
   s.files = %w[
     CHANGELOG.markdown
+    Gemfile
+    Gemfile.lock
     LICENSE.markdown
     README.markdown
     Rakefile
@@ -84,6 +86,7 @@ Gem::Specification.new do |s|
     lib/boom/storage.rb
     lib/boom/storage/base.rb
     lib/boom/storage/json.rb
+    lib/boom/storage/keychain.rb
     lib/boom/storage/mongodb.rb
     lib/boom/storage/redis.rb
     test/examples/config_json.json

data/lib/boom.rb

@@ -6,7 +6,7 @@ rescue LoadError
 end
 
 require 'fileutils'
-require 'yajl'
+require 'json/pure'
 
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
@@ -21,11 +21,12 @@ require 'boom/storage/base'
 require 'boom/storage/json'
 require 'boom/storage/redis'
 require 'boom/storage/mongodb'
+require 'boom/storage/keychain'
 
 require 'boom/core_ext/symbol'
 
 module Boom
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 
   extend self
 

data/lib/boom/command.rb

@@ -76,12 +76,14 @@ module Boom
       #
       # Returns output based on method calls.
       def delegate(command, major, minor)
-        return all  if command == 'all'
-        return edit if command == 'edit'
-        return switch(major) if command == 'switch'
-        return show_storage  if command == 'storage'
-        return help if command == 'help'
-        return help if command[0] == 45 || command[0] == '-' # any - dash options are pleas for help
+        return all               if command == 'all'
+        return edit              if command == 'edit'
+        return switch(major)     if command == 'switch'
+        return show_storage      if command == 'storage'
+        return version           if command == "-v"
+        return version           if command == "--version"
+        return help              if command == 'help'
+        return help              if command[0] == 45 || command[0] == '-' # any - dash options are pleas for help
         return echo(major,minor) if command == 'echo' || command == 'e'
         return open(major,minor) if command == 'open' || command == 'o'
 
@@ -278,6 +280,13 @@ module Boom
         storage.save
       end
 
+      # Public: the version of boom that you're currently running.
+      #
+      # Returns a String identifying the version number.
+      def version
+        output "You're running boom #{Boom::VERSION}. Congratulations!"
+      end
+
       # Public: launches JSON file in an editor for you to edit manually. Uses
       # the $EDITOR environment variable for editing.
       #

data/lib/boom/config.rb

@@ -74,14 +74,14 @@ module Boom
     #
     # Returns nothing.
     def load_attributes
-      @attributes = Yajl::Parser.new.parse(File.new(file, 'r'))
+      @attributes = JSON.parse(File.new(file, 'r').read)
     end
 
     # Public: writes the in-memory JSON Hash to disk.
     #
     # Returns nothing.
     def save
-      json = Yajl::Encoder.encode(attributes, :pretty => true)
+      json = JSON.generate(attributes)
       File.open(file, 'w') {|f| f.write(json) }
     end
 

data/lib/boom/storage/json.rb

@@ -32,7 +32,7 @@ module Boom
       #
       # Returns nothing.
       def populate
-        storage = Yajl::Parser.new.parse(File.new(json_file, 'r'))
+        storage = JSON.parse(File.new(json_file, 'r').read)
       
         storage['lists'].each do |lists|
           lists.each do |list_name, items|
@@ -61,7 +61,7 @@ module Boom
       #
       # Returns a String Json representation of its Lists and their Items.
       def to_json
-        Yajl::Encoder.encode(to_hash, :pretty => true)
+        JSON.generate(to_hash)
       end
 
     end

data/lib/boom/storage/keychain.rb

@@ -0,0 +1,129 @@
+# coding: utf-8
+
+# Keychain provides methods for using Mac OS X's Keychain as a storage option.
+# It saves lists as Keychain files in ~/Library/Keychains with the filename
+# format being: "Boom.list.mylist.keychain"
+#
+module Boom
+  module Storage
+    class Keychain < Base
+
+      KEYCHAIN_FORMAT = %r{Boom\.list\.(.+)\.keychain}
+
+      # Opens Keychain app when json_file is called during `boom edit`
+      #
+      # Returns nothing
+      def open_keychain_app
+        `open /Applications/Utilities/'Keychain Access.app' &`
+      end
+
+      alias_method :json_file, :open_keychain_app
+
+      # Boostraps Keychain by asking if you're using Mac OS X which is a prereq
+      #
+      # Returns true on a Mac
+      def bootstrap
+        raise RuntimeError unless Boom::Platform.darwin?
+        true
+      rescue
+        puts(e 'No Keychain utility to access, maybe try another storage option?')
+        false
+      end
+
+      # Populate the in-memory store with all the lists and items from Keychain
+      #
+      # Returns Array of keychain names, i.e. ["Boom.list.mylist.keychain"]
+      def populate
+        stored_keychain_lists.each do |keychain|
+          @lists << list = List.new(keychain.scan(KEYCHAIN_FORMAT).flatten.first)
+          extract_keychain_items(keychain).each do |name|
+            list.add_item(Item.new(name, extract_keychain_value(name, keychain)))
+          end
+        end
+      end
+
+      # Saves the data from memory to the correct Keychain
+      #
+      # Returns nothing
+      def save
+        @lists.each do |list|
+          keychain_name = list_to_filename(list.name)
+          create_keychain_list(keychain_name) unless stored_keychain_lists.include?(keychain_name)
+          unless list.items.empty?
+            list.items.each do |item|
+              store_item(item, keychain_name)
+            end
+          end
+          delete_unwanted_items(list)
+        end
+        delete_unwanted_lists
+      rescue RuntimeError
+        puts(e "Couldn't save to your keychain, check Console.app or above for relevant messages")
+      end
+
+
+      private
+
+      # Returns an Array of keychains stored in ~/Library/Keychains:
+      # => ["Boom.list.mylist.keychain"]
+      def stored_keychain_lists
+        @stored_keychain_lists ||= `security -q list-keychains |grep Boom.list` \
+          .split(/[\/\n\"]/).select {|kc| kc =~ KEYCHAIN_FORMAT}
+      end
+
+      # Create the keychain list "Boom.list.mylist.keychain" in ~/Library/Keychains
+      def create_keychain_list(keychain_name)
+        `security -q create-keychain #{keychain_name}`
+      end
+
+      # Saves the individual item's value to the right list/keychain
+      def store_item(item, keychain_name)
+        `security 2>/dev/null -q add-generic-password -a '#{item.name}' -s '#{item.name}' -w '#{item.value}' #{keychain_name}`
+      end
+
+      # Retrieves the value of a particular item in a list
+      def extract_keychain_value(item_name, keychain)
+        `security 2>&1 >/dev/null find-generic-password -ga '#{item_name}' #{keychain}`.chomp.split('"').last
+      end
+
+      # Gets all items in a particular list
+      def extract_keychain_items(keychain_name)
+        @stored_items ||= {}
+        @stored_items[keychain_name] ||= `security dump-keychain -a #{keychain_name} |grep acct` \
+          .split(/\s|\\n|\\"|acct|<blob>=|\"/).reject {|f| f.empty?}
+      end
+
+      # Converts list name to the corresponding keychain filename format based
+      # on the KEYCHAIN_FORMAT
+      def list_to_filename(list_name)
+        KEYCHAIN_FORMAT.source.gsub(/\(\.\+\)/, list_name).gsub('\\','')
+      end
+
+      # Delete's a keychain file
+      def delete_list(keychain_filename)
+        `security delete-keychain #{keychain_filename}`
+      end
+
+      # Delete's all keychain files you don't want anymore
+      def delete_unwanted_lists
+        (stored_keychain_lists - @lists.map {|list| list_to_filename(list.name)}).each do |filename|
+          delete_list(filename)
+        end
+      end
+
+      # Removes unwanted items in a list
+      # security util doesn't have a delete password option so we'll have to
+      # drop it and recreate it with what is in memory
+      def delete_unwanted_items(list)
+        filename = list_to_filename(list.name)
+        if (list.items.size < extract_keychain_items(filename).size)
+          delete_list(filename)
+          create_keychain_list(filename)
+          list.items.each do |item|
+            store_item(item, filename)
+          end unless list.items.empty?
+        end
+      end
+    end
+  end
+end

data/lib/boom/storage/mongodb.rb

@@ -3,7 +3,6 @@
 # Storage adapter that saves data from boom to MongoDB instead of JSON file.
 begin
   require 'mongo'
-  require 'json/pure' # Will be here for now See Issue#21
 rescue LoadError
 end
 

data/test/test_command.rb

@@ -161,4 +161,11 @@ class TestCommand < Test::Unit::TestCase
     assert_match /We've switched you over to redis/, command('switch redis')
   end
 
+  def test_version_switch
+    assert_match /#{Boom::VERSION}/, command('-v')
+  end
+
+  def test_version_long
+    assert_match /#{Boom::VERSION}/, command('--version')
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: boom
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Zach Holman
@@ -15,23 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-11 00:00:00 -08:00
+date: 2011-04-11 00:00:00 -07:00
 default_executable: boom
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: yajl-ruby
+  name: json_pure
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 1
         segments: 
-        - 0
-        - 7
-        - 8
-        version: 0.7.8
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -68,6 +68,8 @@ extra_rdoc_files:
 - LICENSE.markdown
 files: 
 - CHANGELOG.markdown
+- Gemfile
+- Gemfile.lock
 - LICENSE.markdown
 - README.markdown
 - Rakefile
@@ -86,6 +88,7 @@ files:
 - lib/boom/storage.rb
 - lib/boom/storage/base.rb
 - lib/boom/storage/json.rb
+- lib/boom/storage/keychain.rb
 - lib/boom/storage/mongodb.rb
 - lib/boom/storage/redis.rb
 - test/examples/config_json.json
@@ -126,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: boom
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 2
 summary: boom lets you access text snippets over your command line.