mr_keychain 0.1.0 → 0.1.1

data/Gemfile

@@ -6,5 +6,5 @@ group :development do
   gem "bluecloth", "~> 2.0.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
+#  gem "rcov", ">= 0"
 end

data/Gemfile.lock

@@ -9,7 +9,6 @@ GEM
       git (>= 1.2.5)
       rake
     rake (0.8.7)
-    rcov (0.9.9)
     rspec (2.4.0)
       rspec-core (~> 2.4.0)
       rspec-expectations (~> 2.4.0)
@@ -27,6 +26,5 @@ DEPENDENCIES
   bluecloth (~> 2.0.0)
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
-  rcov
   rspec (~> 2.4.0)
   yard (~> 0.6.0)

data/README.markdown

@@ -22,10 +22,10 @@ Example Usage
         # add some search criteria, you need at least one, options are listed
         # in the keychain services reference 'Attribute Item Keys and Values'
         # section (link above)
-        item.attributes.merge!({
+        item.attributes.merge!(
                 KSecAttrProtocol => KSecAttrProtocolHTTPS,
                 KSecAttrServer   => 'github.com'
-        })
+        )
 
         # work with the entry if it exists
         if item.exists?
@@ -41,13 +41,19 @@ Example Usage
 
            # change the user name and save to the keychain
            # note how you do not need authorization to change the user name
-           item.update!({ KSecAttrAccount => 'test' })
+           item.update!( KSecAttrAccount => 'test' )
            puts item.metadata[KSecAttrAccount]
 
         else
            puts 'No such item exists, maybe you need different criteria?'
         end
 
+TODO
+====
+
+- Make the simple cases simpler
+- Allow more succinct names for constants and guess the actual values
+
 Contributing to keychain
 ========================
 

data/Rakefile

@@ -15,7 +15,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/ferrous26/keychain"
   gem.license = "MIT"
   gem.summary = %Q{Example code of how to use the Mac OS X keychain in MacRuby}
-  gem.description = %Q{Uses APIs new in Snow Leopard to create, read, and update keychain entries}
+  gem.description = %Q{Takes advantage of MacRuby and uses APIs new in Snow Leopard to create, read, and update keychain entries}
   gem.email = "marada@uwaterloo.ca"
   gem.authors = ["Mark Rada"]
 end
@@ -27,10 +27,10 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
+# RSpec::Core::RakeTask.new(:rcov) do |spec|
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
 
 task :default => :spec
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/mr_keychain.rb

@@ -19,7 +19,6 @@ module Keychain
 #
 # In order to be secure, this class will NEVER cache a password; any time
 # that you change a password, it will be written to the keychain immeadiately.
-
 class Item
 
   # @return [Hash]
@@ -39,9 +38,9 @@ class Item
   # to the item you wish to work with, but you can add or remove attributes
   # via accessors as well.
   # @param [Hash] attributes
-  def initialize attributes = nil
+  def initialize attributes = {}
     @attributes = { KSecClass => KSecClassInternetPassword }
-    @attributes.merge! attributes if attributes
+    @attributes.merge! attributes
   end
 
   # @note This method asks only for the metadata and doesn't need authorization
@@ -50,10 +49,10 @@ class Item
   # @return [true,false]
   def exists?
     result = Pointer.new :id
-    search = @attributes.merge({
+    search = @attributes.merge(
       KSecMatchLimit       => KSecMatchLimitOne,
       KSecReturnAttributes => true
-    })
+    )
 
     case (error_code = SecItemCopyMatching(search, result))
     when ErrSecSuccess then
@@ -76,14 +75,14 @@ class Item
   # @return [String] UTF8 encoded password string
   def password
     result = Pointer.new :id
-    search = @attributes.merge({
+    search = @attributes.merge(
       KSecMatchLimit => KSecMatchLimitOne,
       KSecReturnData => true
-    })
+    )
 
     case (error_code = SecItemCopyMatching(search, result))
     when ErrSecSuccess then
-      NSString.alloc.initWithData result[0], encoding:NSUTF8StringEncoding
+      result[0].to_str
     else
       message = SecCopyErrorMessageString(error_code, nil)
       raise KeychainException, "Error getting password: #{message}"
@@ -97,13 +96,11 @@ class Item
   # @param [String] new_password a UTF-8 encoded string
   # @return [String] the saved password
   def password= new_password
-    password_data = {
-      KSecValueData => new_password.dataUsingEncoding(NSUTF8StringEncoding)
-    }
+    password_data = { KSecValueData => new_password.to_data }
     if exists?
       error_code = SecItemUpdate( @attributes, password_data )
     else
-      error_code = SecItemAdd( @attributes.merge password_data, nil )
+      error_code = SecItemAdd( @attributes.merge(password_data), nil )
     end
 
     case error_code
@@ -126,7 +123,7 @@ class Item
   # @return [Hash] attributes
   def update! new_attributes
     result = Pointer.new :id
-    query  = @attributes.merge({ KSecMatchLimit => KSecMatchLimitOne })
+    query  = @attributes.merge( KSecMatchLimit => KSecMatchLimitOne )
 
     case (error_code = SecItemUpdate(query, new_attributes))
     when ErrSecSuccess then
@@ -143,10 +140,10 @@ class Item
   # @return [Hash]
   def metadata
     result = Pointer.new :id
-    search = @attributes.merge({
+    search = @attributes.merge(
       KSecMatchLimit       => KSecMatchLimitOne,
       KSecReturnAttributes => true
-    })
+    )
 
     case (error_code = SecItemCopyMatching(search, result))
     when ErrSecSuccess then

data/spec/keychain_spec.rb

@@ -28,7 +28,7 @@ describe 'Keychain' do
       end
 
       it 'should allow the class to be overriden' do
-        @item = Keychain::Item.new({ KSecClass => 'different' })
+        @item = Keychain::Item.new( KSecClass => 'different' )
         @item.attributes[KSecClass].should == 'different'
       end
     end
@@ -36,18 +36,18 @@ describe 'Keychain' do
 
     describe '#exists?' do
       it 'returns false if the item does not exist' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolIRCS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         @item.exists?.should == false
       end
 
       it 'returns true if the item exists' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolHTTPS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         @item.exists?.should == true
       end
 
@@ -60,18 +60,18 @@ describe 'Keychain' do
 
     describe '#password' do
       it 'should return a string with the password' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolHTTPS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         @item.password.class.should == String
       end
 
       it 'should raise an exception if no password is found' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolIRCS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         expect { @item.password }.to raise_exception(Keychain::KeychainException)
       end
     end
@@ -79,27 +79,27 @@ describe 'Keychain' do
 
     describe '#metadata' do
       it 'should return a hash' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolHTTPS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         @item.metadata.class.should == Hash
       end
 
       it 'should raise an exception if nothing is found' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolIRCS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         expect { @item.metadata }.to raise_exception(Keychain::KeychainException)
       end
 
       # this assumes the keychain item has more metadata
       it 'should not overwrite @attributes' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolHTTPS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         metadata = @item.metadata
         @item.attributes.should_not == metadata
       end
@@ -108,27 +108,27 @@ describe 'Keychain' do
 
     describe '#metadata!' do
       it 'should return a hash' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolHTTPS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         @item.metadata.class.should == Hash
       end
 
       it 'should raise an exception if nothing is found' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolIRCS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         expect { @item.metadata }.to raise_exception(Keychain::KeychainException)
       end
 
       # this assumes the keychain item has more metadata
       it 'should overwrite @attributes' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolHTTPS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         metadata = @item.metadata!
         @item.attributes.should == metadata
       end
@@ -154,10 +154,10 @@ describe 'Keychain' do
 
     # describe '#password=' do
     #   before do
-    #     @item.attributes.merge!({
+    #     @item.attributes.merge!(
     #       KSecAttrProtocol => KSecAttrProtocolHTTPS,
     #       KSecAttrServer   => 'github.com'
-    #     })
+    #     )
     #   end
 
     #   it 'should return the updated password' do
@@ -169,9 +169,9 @@ describe 'Keychain' do
     #   end
 
     #   it 'should create entries if they do not exsit' do
-    #     @item.attributes.merge!({
+    #     @item.attributes.merge!(
     #       KSecAttrAccount  => 'test'
-    #     })
+    #     )
     #     @item.password = 'another test'
     #     @item.exists?.should == true
     #   end
@@ -184,41 +184,41 @@ describe 'Keychain' do
 
     describe '#update!' do
       it 'should update fields given in the persistent keychain' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolHTTPS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         @item.update!({ KSecAttrComment => 'test' })
         @item.metadata[KSecAttrComment].should == 'test'
       end
 
       it 'should raise an exception for non-existant items' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolIRCS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         expect {
-          @item.update!({ KSecAttrComment => 'different test' })
+          @item.update!( KSecAttrComment => 'different test' )
         }.to raise_exception(Keychain::KeychainException)
       end
 
       it 'should update @attributes' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolHTTPS,
           KSecAttrServer   => 'github.com'
-        })
+        )
         @item.update!({ KSecAttrComment => 'toast' })
         @item.attributes[KSecAttrComment].should == 'toast'
       end
 
       it 'should return the metadata of the keychain item' do
-        @item.attributes.merge!({
+        @item.attributes.merge!(
           KSecAttrProtocol => KSecAttrProtocolHTTPS,
           KSecAttrServer   => 'github.com'
-        })
-        @item.update!({
+        )
+        @item.update!(
                         KSecAttrComment => 'bread'
-                      })[KSecAttrComment].should == 'bread'
+                      )[KSecAttrComment].should == 'bread'
       end
     end
 

metadata

@@ -1,120 +1,106 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mr_keychain
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-05 00:00:00 -05:00
+date: 2011-03-01 00:00:00 -05:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 4
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
   name: yard
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 2
+      - !ruby/object:Gem::Version
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id006
-description: Uses APIs new in Snow Leopard to create, read, and update keychain entries
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+description: Takes advantage of MacRuby and uses APIs new in Snow Leopard to create,
+  read, and update keychain entries
 email: marada@uwaterloo.ca
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.markdown
-files: 
+files:
 - .document
 - .rspec
 - .rvmrc
@@ -130,37 +116,30 @@ files:
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/ferrous26/keychain
-licenses: 
+licenses:
 - MIT
 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: -1899776903697949187
-      segments: 
-      - 0
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
       version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
       version: "0"
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Example code of how to use the Mac OS X keychain in MacRuby
-test_files: 
+test_files:
 - spec/keychain_spec.rb
 - spec/spec_helper.rb