econfig-keychain 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 495ae65ae8b8e05d67d3eff3b472e20e0a022de9
-  data.tar.gz: a5492f0f83c3113c135e5731d4e17db7e1954485
+  metadata.gz: 8510be80ac12c816ca31d78e99966ed7e7239f48
+  data.tar.gz: 17623f293d5e9d461cf910c7d30f63dd955c3d52
 SHA512:
-  metadata.gz: fdd4492e96ef852ac396406f208662410156c6076083f9efaa28055e533ba8cfcf1bb74dfeeb2f5eae1527f20e013759a0b8e1b90ecd9d7a91e53fe8a4d0e331
-  data.tar.gz: 40e34cf65c50c24136801905f4458d2cda9f192aa446f5b11b1b2c27c01e43a52baa01131e453518ee85b92b826d157c31e00df8474b8cce7844be0fc7c09c86
+  metadata.gz: c99c777e3f184bb88509dc28d366e9fbaea0af8271625f7a281325d2da474d32c017f28e9204c3524f2d26545a7372adc8dfc39d03ad5d261f18492bf8639e7a
+  data.tar.gz: f2a97f4e6e69865ba0320c62c7794d88d87ce95d5d5d8e4885b900664df553366edb04b1e5a9c921e67f9b8bf93c03508b164e056c3c5bccf83f66bfb7595bb7

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 [HEAD][]
 --------
 
+[v1.0.2][]
+----------
+
+- Allow specifying project name in Econfig.use_keychain [974df0db]
+- Enforce Econfig.init, works better with Rails as well [1680b780]
+
 [v1.0.1][]
 ----------
 
@@ -17,6 +23,7 @@
 
 Initial release!
 
-[HEAD]: https://github.com/elabs/econfig-keychain/compare/v1.0.1...HEAD
+[HEAD]: https://github.com/elabs/econfig-keychain/compare/v1.0.2...HEAD
+[v1.0.2]: https://github.com/elabs/econfig-keychain/compare/v1.0.1...v1.0.2
 [v1.0.1]: https://github.com/elabs/econfig-keychain/compare/v1.0.0...v1.0.1
 [v1.0.0]: https://github.com/elabs/econfig-keychain/compare/f877fd49...v1.0.0

data/README.md

@@ -14,29 +14,42 @@ gem "econfig-keychain"
 ```
 
 Second, create a keychain you wish to store configuration in, name it something
-clever like `thanks-a-latte`. Within `config/initializers/econfig.rb` write the
-following:
+clever like `thanks-a-latte`. Within `config/application.rb` write the following:
 
 ``` ruby
-MyApp.extend Econfig::Shortcut
+# … some rails setup previously
+module MyApp
+  extend Econfig::Shortcut
+  Econfig.use_keychain "thanks-a-latte" if Rails.env.development?
+  
+  class Application < Rails::Application
+  # … rest of the configuration
+```
+
+That's it!
+
+Econfig::Keychain will automatically create an empty secure note using the name of the directory your project is located at, in the `thanks-a-latte` keychain. If you wish to specify the name yourself, you can do so:
 
-if Rails.env.development?
-  Econfig.use_keychain "thanks-a-latte"
-end
+``` ruby
+Econfig.use_keychain "thanks-a-latte", name: "project name"
 ```
 
-That's it!  You can change your configuration from the Rails console:
+## Changing configuration
+
+Econfig::Keychain supports changing configuration by setting values, e.g. from the Rails console:
 
 ``` ruby
 MyApp.aws_access_key_id = "xyz"
 ```
 
-You can also edit your configuration manually using the Mellon CLI:
+You can also edit your configuration with your `$EDITOR` manually using the Mellon CLI:
 
 ```
 bundle exec mellon edit myapp
 ```
 
+Finally, you can also edit the keychain entry manually using Keychain Access.
+
 # License
 
 MIT. See LICENSE.

data/Rakefile

@@ -3,4 +3,8 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
 
+task :console do
+  exec "irb", "-r", "bundler/setup", "-r", "econfig-keychain"
+end
+
 task default: :spec

data/econfig-keychain.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = "~> 2.0"
+
   spec.add_dependency "econfig"
   spec.add_dependency "mellon", "~> 1.0"
 

data/lib/econfig/keychain/version.rb

@@ -1,5 +1,5 @@
 module Econfig
   class Keychain
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

data/lib/econfig/keychain.rb

@@ -4,28 +4,27 @@ require "econfig"
 module Econfig
   class Keychain
     def initialize(keychain, name: nil)
-      name ||= File.basename(Econfig.root)
-      @store = ::Mellon::Store.new(name, keychain: keychain)
-    end
-
-    def project_name
-      @store.project_name
-    end
-
-    def keychain
-      @store.keychain
+      @init = { keychain: keychain, name: name }
     end
 
     def init
-      keychain[project_name] ||= ""
+      project_name = @init[:name] || File.basename(Econfig.root)
+      @store = ::Mellon::Store.new(project_name, keychain: @init[:keychain])
+      @store.keychain[@store.project_name] ||= ""
     end
 
     def get(key)
-      @store[key]
+      store[key]
     end
 
     def set(key, value)
-      @store[key] = value
+      store[key] = value
+    end
+
+    private
+
+    def store
+      @store or raise Econfig::UninitializedError
     end
   end
 end

data/lib/econfig-keychain.rb

@@ -2,8 +2,8 @@ require "econfig/keychain"
 
 module Econfig
   class << self
-    def use_keychain(keychain)
-      Econfig.instance.backends << Econfig::Keychain.new(keychain)
+    def use_keychain(keychain, **kwargs)
+      Econfig.instance.backends << Econfig::Keychain.new(keychain, **kwargs)
     end
   end
 end

data/spec/econfig/keychain_spec.rb

@@ -8,6 +8,7 @@ Econfig.env = "test"
 describe Econfig::Keychain do
   let(:keychain_path) { File.expand_path("./osx.temporary.keychain", __dir__) }
   let(:keychain) { Mellon::Keychain.new(keychain_path) }
+  let(:project_name) { File.basename(Econfig.root) }
   let(:backend) { Econfig::Keychain.new(keychain) }
 
   around do |example|
@@ -20,7 +21,7 @@ describe Econfig::Keychain do
   describe "#init" do
     it "creates the note in the keychain if it does not exist" do
       Econfig.stub(root: "different")
-      expect { backend.init }.to change { keychain[backend.project_name] }
+      expect { backend.init }.to change { keychain[project_name] }
         .from(nil).to("")
     end
 
@@ -30,20 +31,34 @@ describe Econfig::Keychain do
     end
   end
 
-  describe "#get" do
-    it "fetches an option from the keychain" do
-      backend.get("i exist").should eq "this exist"
+  context "before init" do
+    specify "#get raises an error" do
+      expect { backend.get("key") }.to raise_error(Econfig::UninitializedError)
     end
 
-    it "returns nil if option does not exist" do
-      backend.get("does not exist").should be_nil
+    specify "#set raises an error" do
+      expect { backend.set("key", "value") }.to raise_error(Econfig::UninitializedError)
     end
   end
 
-  describe "#set" do
-    it "sets an option in the keychain" do
-      backend.set("new key", "pub")
-      backend.get("new key").should eq "pub"
+  context "after init" do
+    before { backend.init }
+
+    describe "#get" do
+      it "fetches an option from the keychain" do
+        backend.get("i exist").should eq "this exist"
+      end
+
+      it "returns nil if option does not exist" do
+        backend.get("does not exist").should be_nil
+      end
+    end
+
+    describe "#set" do
+      it "sets an option in the keychain" do
+        backend.set("new key", "pub")
+        backend.get("new key").should eq "pub"
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: econfig-keychain
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Kim Burgestrand
@@ -9,76 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: econfig
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mellon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -89,7 +89,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -111,12 +111,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []