yakg 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/tmaher/corefoundation.git
-  revision: 73a97c6e7d268d21d17f671c94e98185153c5e3f
+  revision: e4cb21a7985577c44cd0aa8f9f17e9b6b6e09141
   specs:
     corefoundation (0.1.4)
       ffi
@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    yakg (0.0.1)
+    yakg (0.0.2)
       corefoundation
       ffi
 
@@ -24,7 +24,7 @@ GEM
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
       rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.0)
+    rspec-core (2.12.1)
     rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.0)

data/README.md

@@ -0,0 +1,99 @@
+Yet Another Keyring Gem
+=======================
+
+Storing passwords in plaintext makes me a sad panda. Let's use Apple's
+Keychain utility!
+
+```
+tmaher@bananaweizen:~$ irb
+irb(main):001:0> require 'yakg'
+=> true
+irb(main):002:0> Yakg.set "someuser", "s3|<r1+"
+=> true
+irb(main):003:0> Yakg.get "someuser"
+=> "s3|<r1+"
+irb(main):004:0> Yakg.unset "someuser"
+=> true
+irb(main):005:0> Yakg.get "someuser"
+=> nil
+irb(main):006:0> Yakg.set "user1", "password1"
+=> true
+irb(main):007:0> Yakg.set "user2", "2password"
+=> true
+irb(main):008:0> Yakg.list
+=> ["user1", "user2"]
+```
+
+In addition to usernames, Keychain also has the notion of "service
+name". It's a free-form string, useful for namespacing different
+accounts.  Let's take a look...
+
+```
+rb(main):009:0> Yakg.DEFAULT_SERVICE_NAME
+=> "ruby-yakg-gem"
+irb(main):010:0> Yakg.DEFAULT_SERVICE_NAME = "awesome other service"
+=> "awesome other service"
+irb(main):011:0> Yakg.list
+=> []
+irb(main):012:0> Yakg.set "user1", "kitties!"
+=> true
+irb(main):013:0> Yakg.set "harry.bovik", "dogs"
+=> true
+irb(main):014:0> Yakg.list
+=> ["user1", "harry.bovik"]
+irb(main):015:0> Yakg.list "ruby-yakg-gem"
+=> ["user1", "user2"]
+irb(main):016:0> Yakg.get "user1", "ruby-yakg-gem"
+=> "password1"
+irb(main):017:0> Yakg.get "user1"
+=> "kitties!"
+irb(main):018:0> ^D
+tmaher@bananaweizen:~$ irb
+irb(main):001:0> require 'yakg'
+=> true
+irb(main):002:0> Yakg.list
+=> ["user1", "user2"]
+irb(main):003:0> Yakg.list "awesome other service"
+=> ["user1", "harry.bovik"]
+irb(main):004:0> Yakg.list
+=> ["user1", "user2"]
+irb(main):005:0> Yakg.unset "user1"
+=> true
+irb(main):006:0> Yakg.list
+=> ["user2"]
+irb(main):007:0> Yakg.list "awesome other service"
+=> ["user1", "harry.bovik"]
+```
+
+Technical Details
+=================
+
+This gem wrapps Apple's Security Framework (a C library) using the
+excellent `ffi` gem. References for the full Keychain Services API can
+be found at
+https://developer.apple.com/library/mac/#documentation/security/Reference/keychainservices/Reference/reference.html
+
+My views on the virtues of wrapping Security Framework and calling it
+from the Ruby process, as opposed to use of helper programs such as
+`git-password`, can be found at https://gist.github.com/4116645
+
+
+Related Work
+============
+
+* https://github.com/xli/mac-keychain also wraps Security Framework
+  but with RubyCocoa. That makes it more difficult to use with local
+  Ruby builds
+
+* https://github.com/seattlerb/osx_keychain uses RubyInline to call
+  into the underlying C library. That necessitates a C compiler.
+
+* https://github.com/jprichardson/keychain_manager shells out to call
+  the `security` CLI tool.  It's also less oriented around password
+  management, and more geared towards PKI.
+
+* https://github.com/fcheung/keychain also wraps Security Framework
+  with ffi.  It's far more feature-complete than Yakg, but I wanted a
+  more minimalist API. Both approaches absolutely have their place.
+  Yakg shares some code, specifically fcheung/corefoundation for error
+  message string handling, and I am indebted to Mr. Cheung for it.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

metadata

@@ -1,104 +1,106 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: yakg
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Tom Maher
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-25 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  type: :runtime
+date: 2012-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ffi
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: corefoundation
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: woof_util
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rake
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: *id005
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Use Ruby's DL mechanism to access the MacOS Keychain
 email: tmaher@tursom.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - VERSION
 - lib/yakg.rb
@@ -110,36 +112,32 @@ files:
 - yakg.gemspec
 homepage: https://github.com/tmaher/yakg
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -4137837794244479460
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -4137837794244479460
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Yet Another Keyring Gem
 test_files: []
-