secret_store 0.0.1 → 0.0.2

data/README.md

@@ -1,11 +1,14 @@
 SecretStore
 ===========
 
-Store secrets for your app in a encrypted in a yaml file.
+Store secrets for your app AES encrypted in a yaml file.
 
 Often when working on a web application, you have the need for storing a
 variety of API keys or secrets to 3rd party services.  However, it's not
 desireable to check those secrets in as plain text to the code respository.
+This means that any 3rd party access to your repository provides that info.
+With SecretStore, parties without knowledge of the master password (this can
+include your own team members!) will not have direct access to such secrets.
 
 One common way around this is to set such keys in the environment.  This is,
 for example, what [Heroku recommends](https://devcenter.heroku.com/articles/config-vars)
@@ -41,11 +44,12 @@ require "secret_store"
 secret_store = SecretStore.new("master_password", "/path/to/data.yml")
 secret_store.store("some_api_key", "c7dd199")
 secret_store.get("some_api_key") # => "c7dd199"
-secret_store.get("unknown_key") # => raises IndexError
+secret_store.get("unknown_key") # => nil
+secret_store.get!("unknown_key") # => raises IndexError
 
-secret_store.store("known_key", "b123fa") => stores
-secret_store.store("known_key", "new_val") => raises error
-secret_store.store("known_key", "new_val", :force) => overwrites stored
+secret_store.store("secret", "b123fa") # => stores
+secret_store.store("secret", "new_val")  # => raises error
+secret_store.store!("secret", "new_val") # => overwrites stored
 ```
 
 For a typical application, it could be desirable to define a

data/lib/secret_store/version.rb

@@ -1,3 +1,3 @@
 class SecretStore
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/secret_store.rb

@@ -10,10 +10,10 @@ class SecretStore
     self.file_path = file_path
   end
 
-  def store(key, secret, force = false)
-    load_data
+  def store(key, secret, reload_data = true)
+    load_data if reload_data
 
-    if ! force && @data[key.to_s]
+    if @data[key.to_s]
       raise "Key #{key} already stored"
     end
 
@@ -22,9 +22,20 @@ class SecretStore
     load_data[key]
   end
 
+  def store!(key, secret)
+    load_data
+    @data.delete(key.to_s)
+    store(key, secret, false)
+  end
+
   def get(key)
-    ciphertext = @data.fetch(key.to_s)
-    cipher.decrypt(ciphertext)
+    if ciphertext = @data[key.to_s]
+      cipher.decrypt(ciphertext)
+    end
+  end
+
+  def get!(key)
+    get(key) or raise IndexError.new(%Q[key not found: "#{key}"])
   end
 
   def encrypt(secret)
@@ -32,18 +43,9 @@ class SecretStore
   end
 
   def change_password(new_password)
-    new_data = {}
-
-    @data.each_key do |key|
-      new_data[key] = get(key)
-    end
-
+    decrypted = decrypted_data
     self.password = new_password
-
-    new_data.each do |key, plaintext|
-      @data[key] = encrypt(plaintext)
-    end
-
+    replace_with_decrypted(decrypted)
     store_data
   end
 
@@ -77,4 +79,17 @@ class SecretStore
       f.puts YAML.dump @data
     end
   end
+
+  def decrypted_data
+    @data.each_key.inject({}) do |decrypted_data, key|
+      decrypted_data[key] = get(key)
+      decrypted_data
+    end
+  end
+
+  def replace_with_decrypted(decrypted)
+    decrypted.each do |key, plaintext|
+      @data[key] = encrypt(plaintext)
+    end
+  end
 end

data/spec/secret_store_spec.rb

@@ -36,18 +36,17 @@ describe SecretStore, "storing a secret" do
   end
 
   context "when the key is already stored" do
-    it "raises if not forced" do
+    it "raises" do
       subject.store("foobar", "fizzbuzz")
       lambda {
         subject.store("foobar", "fizzbuzz")
       }.should raise_error
     end
 
-    it "stores if forced" do
+    it "can be overwritten with #store!" do
       subject.store("foobar", "fizzbuzz")
-      lambda {
-        subject.store("foobar", "fizzbuzz", :force)
-      }.should_not raise_error
+      subject.store!("foobar", "buzzfizz")
+      subject.get("foobar").should == "buzzfizz"
     end
   end
 end
@@ -61,12 +60,6 @@ describe SecretStore, "getting a secret" do
     subject.get("foobar").should == "fizzbuzz"
   end
 
-  it "raises IndexError if the key is not found" do
-    lambda{
-      subject.get("not_found")
-    }.should raise_error(IndexError)
-  end
-
   it "raises OpenSSL::Cipher::CipherError if the password for the store is wrong" do
     subject.store("foobar", "fizzbuzz")
     with_wrong_pass = SecretStore.new("wrong_pass", tmpfile.path)
@@ -74,6 +67,14 @@ describe SecretStore, "getting a secret" do
       with_wrong_pass.get("foobar")
     }.should raise_error(OpenSSL::Cipher::CipherError)
   end
+
+  context "when called via #get!" do
+    it "raises IndexError if the key is not found" do
+      lambda{
+        subject.get!("not_found")
+      }.should raise_error(IndexError)
+    end
+  end
 end
 
 describe SecretStore, "changing the password" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: secret_store
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gibberish
-  requirement: &2160632160 !ruby/object:Gem::Requirement
+  requirement: &2152744720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160632160
+  version_requirements: *2152744720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160631720 !ruby/object:Gem::Requirement
+  requirement: &2152744200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160631720
+  version_requirements: *2152744200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160631280 !ruby/object:Gem::Requirement
+  requirement: &2152743740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160631280
+  version_requirements: *2152743740
 description: Store secrets for your app in a encrypted in a yaml file.
 email:
 - xternal1+github@gmail.com
@@ -74,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1229492496997866402
+      hash: 2805007848849734124
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1229492496997866402
+      hash: 2805007848849734124
 requirements: []
 rubyforge_project: secret_store
 rubygems_version: 1.8.15