nimbussecure 0.5.0 → 0.5.1

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+.idea
 .bundle
 Gemfile.lock
 binstubs

data/README.md

@@ -70,34 +70,34 @@ setup service, you can dynamically grab all your sensitive credentials
 and data needed to run your application. This typically happens during
 your application boot up process.
 
-# Setting up your .nibmussecure.yml file:
-The easiest way to setup Nimbus Secure is to setup a configuration file in your home directory.
-This file will contain sensitive information, so it should be marked as readable to you only
-(permission mode 400). The following is a sample configuration file:
+# Setup
+For a complete set of instructions on how to setup and use Nimbus Secure,
+please go to https://www.nimbussecure.com, login, and click on "Instructions"
+in the top menu bar.
 
-account: <my_account_id>
-apikey: <my_accounts_apikey>
-crypt_keys:
-  key1: <my_secret_value_for_key1>
-  key2: <my_secret_value_for_key2>
+# Command Line
+You must complete the set of instructions under 'Setup' above for this to work
+properly.
 
-The value "<my_account_id>" is the same value that appears in the base part of your URL you use to
-access Nmbus Secure. So, for example, if the URL you use to access Nimbus Secure is this:
+Once ready, you can do things like this:
 
-  https://www.nimbussecure.com/myaccount
+  nimbussecure account
 
-Then your account id is "myaccount". Your "apikey" can be retrieved from the "Api Keys" tab in
-Nimbus Secure.
+will return a list of information about your account.
 
-For each encryption key you have in your account and you wish to use, you must have a line in the
-"crypt_keys:"" section of the config file. In the above example, "key1" is the name assigned to the
-first encryption key, and "<my_secret_value_for_key1>" is the secret value you assigned when
-you created this encryption key.
+Assuming you have a stored key with a name "testmessage" setup, with an approprate encryption key.
+Then the following can be used to retrieve and decrypt a stored key:
+
+  nimbussecure lookup testmessage
+
+The decrypted value in the stored key will be sent to stdout.
 
 # Using in Ruby
+You must complete the set of instructions under 'Setup' above for this to work
+properly.
+
 Assuming you have a stored key with a name "testmessage" setup, with an approprate encryption key.
-Also assuming your ~/.nimbussecure.yml file is setup with your account identifier, API Key,
-and the encryption key value. Then the following can be used to retrieve and decrypt a stored key:
+Then the following can be used to retrieve and decrypt a stored key:
 
 require 'nimbussecure'
 stored_value=nimbussecure.lookup_value "testmessage"

data/Rakefile

@@ -1,6 +1,21 @@
 require "bundler/gem_tasks"
 
-desc "Run all tests"
-task :test do
-  require "#{File.dirname(Pathname.new(File.expand_path(__FILE__)).realpath.to_s).to_s}/test/run_tests.rb"
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
 end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+

data/bin/nimbussecure

@@ -42,6 +42,8 @@ NOTE:
     This is a set of key/value pairs. The key is the name as defined in your
     Nimbus Secure \"Encryption Keys\" section, and the value is the secret value
     you used when you created your encryption key.
+
+Version: #{NimbusSecure::VERSION}
 "
   exit 1
 end

data/bin/nimbussecure_setup

@@ -0,0 +1,138 @@
+#!/usr/bin/env ruby
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+require 'nimbussecure'
+#
+#
+# This program will create a new ~/.nimbussecure.yml file (or equivalent in a different filename).
+#
+#
+def usage
+  puts "
+Usage:
+    nimbussecure_setup <account_id> <apikey> [filename]
+
+This program will generate a default ~/.nimbussecure.yml file for use by the Nimbus Secure
+Gem. It will fill in all the basic information needed, and will access Nimbus Secure to get
+a complete list of your encryption keys, adding a line for each.
+
+ See https://www.nimbussecure.com for more information.
+
+NOTE:
+  account_id:
+    The account ident can be found based on the URL you use to access Nimbus Secure. If your URL is:
+
+      https://www.nimbussecure.com/my_acct/
+
+    Then the <account_id> value to use should be \"my_acct\"
+  apikey:
+    You can find your API Key by clicking on \"API Keys\" when you are logged into
+    the Nimbus Secure website.
+  filename:
+    Optional filename to store the configuration file to. The default is ~/.nimbussecure.yml.
+"
+  exit 1
+end
+
+
+def main
+  usage unless (ARGV.size==2) or (ARGV.size==3)
+  filename="~/.nimbussecure.yml"
+  filename=ARGV[2] if ARGV.size==3
+
+  expand_file=File.expand_path filename
+  setup_file expand_file,ARGV[0],ARGV[1]
+end
+
+#
+# Create New File
+#
+def setup_file filename,account_id,apikey
+  crypt_key_hash_list={}
+  existing_content=read_old_config_file filename
+  if existing_content
+    if existing_content["account"]!=account_id or existing_content["apikey"]!=apikey
+      puts "ERROR: There is an existing file that refers to a different account or API Key."
+      exit 1
+    end
+    crypt_key_hash_list=existing_content["crypt_keys"]
+  end
+
+
+  ns=NimbusSecure.new account: account_id,apikey: apikey
+  crypt_keys=ns.crypt_keys
+  unless ns.success? and crypt_keys
+    puts "Error: #{ns.last_error_message}"
+    exit 1
+  end
+
+  ns.crypt_keys.each do |ck|
+    crypt_key_hash_list[ck.ident.to_s]||=nil
+  end
+
+
+
+  content=config_file_contents account_id,apikey,crypt_key_hash_list
+  if File.exists?(filename)
+    newfilename=filename+"_old#{Time.now.to_i}"
+    puts "Moved existing file to #{newfilename}"
+    File.rename filename,newfilename
+  end
+  File.open filename, File::CREAT|File::TRUNC|File::RDWR, 0644 do |f|
+    f.write content+"\n"
+  end
+  puts "Created #{filename}"
+end
+
+
+#
+# Get old content if it exists
+#
+def read_old_config_file filename
+  return nil unless File.exist?(filename)
+  content=File.read(filename)
+  unless content
+    puts "The Configuration file is invalid: #{filename}"
+    exit 1
+  end
+  YAML.load(content)
+end
+
+#
+# Create a configuration file from specified parameters
+#
+def config_file_contents account_id,apikey,crypt_key_hash_list
+  content=[]
+  content<<"#"
+  content<<"# Nimbus Secure Configuration File"
+  content<<"# https://www.nimbussecure.com"
+  content<<"# This file was auto-generated on: #{Time.now.strftime '%b %e, %Y %H:%M:%S %Z'}"
+  content<<"# Nimbus Secure Client Version Number: #{NimbusSecure::VERSION}"
+  content<<"#"
+  content<<"account: #{account_id}"
+  content<<"apikey: #{apikey}"
+  #
+  # See if we have any secret values setup...
+  #
+  any_values=false
+  crypt_key_hash_list.each do |key,value|
+    any_values=true unless value.nil?
+  end
+  if any_values
+    content<<"#"
+    content<<"# Note: Please fill in any remaining crypt key secret values yourself."
+    content<<"#"
+  else
+    content<<"#"
+    content<<"# Note: The crypt key names are filled in here, but you must add the"
+    content<<"#       crypt key secret values yourself."
+    content<<"#"
+  end
+  content<<"crypt_keys:"
+  crypt_key_hash_list.each do |key,value|
+    content<<"  #{key}: #{value||"<put secret value here>"}"
+  end
+  content.join("\n")
+end
+
+main

data/lib/nimbussecure/config.rb

@@ -7,7 +7,7 @@ class NimbusSecure
       @endpoint="https://www.nimbussecure.com"
     end
     def invalid?
-      endpoint.nil? || account.nil? || apikey.nil? || crypt_keys.size==0
+      endpoint.nil? || account.nil? || apikey.nil?
     end
     def valid?
       !invalid?

data/lib/nimbussecure/crypt_key.rb

@@ -57,6 +57,7 @@ class NimbusSecure
   #
   def crypt_keys
     res=request_get "/crypt_keys"
+    return nil unless res
     @cached_crypt_keys=res["crypt_keys"].map{|key|NimbusSecure::CryptKey.new self,key}
   end
   def crypt_keys_from_cache

data/lib/nimbussecure/version.rb

@@ -1,3 +1,3 @@
 class NimbusSecure
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/nimbussecure.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "minitest"
+  #s.add_development_dependency "minitest"
+  #s.add_development_dependency "minitest-reporters"
+  s.add_development_dependency "rspec"
   s.add_development_dependency "vcr"
   s.add_development_dependency "fakeweb"
   s.add_runtime_dependency "faraday"

data/{test → spec/requests}/accounts_spec.rb

@@ -1,6 +1,6 @@
-require 'minitest_helper'
+require 'spec_helper'
 
-describe NimbusSecure::Account do
+describe "NimbusSecure::Account" do
   before do
     @ns=NimbusSecure.new({endpoint: "http://localhost:3000",
                                   account: "vcrtest",
@@ -10,9 +10,9 @@ describe NimbusSecure::Account do
   it "should get a list of all accounts (when there is just one)" do
     VCR.use_cassette "accounts/test" do
       acct=@ns.account
-      acct.name.must_equal "VCR Account"
-      acct.num_crypt_keys.must_equal 23
-      acct.num_stored_keys.must_equal 34
+      acct.name.should eq "VCR Account"
+      acct.num_crypt_keys.should eq 23
+      acct.num_stored_keys.should eq 34
     end
   end
 end

data/{test → spec/requests}/basic_key_lookup_spec.rb

@@ -1,4 +1,4 @@
-require 'minitest_helper'
+require 'spec_helper'
 describe "Key Lookup" do
   before do
     @ns=NimbusSecure.new({endpoint: "http://localhost:3000",
@@ -8,22 +8,22 @@ describe "Key Lookup" do
   end
   it "should be able to lookup a key and decrypt it" do
     VCR.use_cassette "lookup/key1" do
-      @ns.lookup_value(:test1).must_equal "This is a test stored key"
+      @ns.lookup_value(:test1).should eq  "This is a test stored key"
     end
   end
   it "should be able to lookup a second key and decrypt it" do
     VCR.use_cassette "lookup/key2" do
-      code=@ns.lookup_value(:test1).must_equal "This is a test stored key"
-      code=@ns.lookup_value(:test2).must_equal "This is another test stored key"
+      code=@ns.lookup_value(:test1).should eq  "This is a test stored key"
+      code=@ns.lookup_value(:test2).should eq  "This is another test stored key"
     end
   end
   it "should be able to fail gracefully if key is not found" do
     VCR.use_cassette "lookup/key3" do
       code=@ns.lookup_value :invalidkey
-      code.must_be_nil
-      @ns.success?.must_equal false
-      @ns.last_error_message.must_equal "Could not locate Stored Key invalidkey"
-      @ns.last_error_details.must_be_nil
+      code.should be_nil
+      @ns.success?.should eq  false
+      @ns.last_error_message.should eq  "Could not locate Stored Key invalidkey"
+      @ns.last_error_details.should be_nil
     end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'vcr'
+require 'nimbussecure'
+
+root_dir=File.expand_path("../..", __FILE__)
+Dir["#{root_dir}spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :fakeweb
+  # c.stub_with :fakeweb
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nimbussecure
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-02 00:00:00.000000000 Z
+date: 2012-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: &70236373001520 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70345215642340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70236373001520
+  version_requirements: *70345215642340
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70236373001100 !ruby/object:Gem::Requirement
+  requirement: &70345215641920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70236373001100
+  version_requirements: *70345215641920
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70236373000680 !ruby/object:Gem::Requirement
+  requirement: &70345215641480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70236373000680
+  version_requirements: *70345215641480
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70236373000240 !ruby/object:Gem::Requirement
+  requirement: &70345215641000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70236373000240
+  version_requirements: *70345215641000
 - !ruby/object:Gem::Dependency
   name: gibberish
-  requirement: &70236372999780 !ruby/object:Gem::Requirement
+  requirement: &70345215640540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,12 +65,13 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70236372999780
+  version_requirements: *70345215640540
 description: Client library for NimbusSecure
 email:
 - lee@nimbussecure.com
 executables:
 - nimbussecure
+- nimbussecure_setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -79,6 +80,7 @@ files:
 - README.md
 - Rakefile
 - bin/nimbussecure
+- bin/nimbussecure_setup
 - lib/nimbussecure.rb
 - lib/nimbussecure/accounts.rb
 - lib/nimbussecure/attr_accessor.rb
@@ -92,14 +94,13 @@ files:
 - lib/nimbussecure/version.rb
 - nimbussecure.gemspec
 - pry_load.rb
-- test/accounts_spec.rb
-- test/basic_key_lookup_spec.rb
-- test/fixtures/vcr_cassettes/accounts/test.yml
-- test/fixtures/vcr_cassettes/lookup/key1.yml
-- test/fixtures/vcr_cassettes/lookup/key2.yml
-- test/fixtures/vcr_cassettes/lookup/key3.yml
-- test/minitest_helper.rb
-- test/run_tests.rb
+- spec/fixtures/vcr_cassettes/accounts/test.yml
+- spec/fixtures/vcr_cassettes/lookup/key1.yml
+- spec/fixtures/vcr_cassettes/lookup/key2.yml
+- spec/fixtures/vcr_cassettes/lookup/key3.yml
+- spec/requests/accounts_spec.rb
+- spec/requests/basic_key_lookup_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -125,11 +126,10 @@ signing_key:
 specification_version: 3
 summary: Client library for NimbusSecure
 test_files:
-- test/accounts_spec.rb
-- test/basic_key_lookup_spec.rb
-- test/fixtures/vcr_cassettes/accounts/test.yml
-- test/fixtures/vcr_cassettes/lookup/key1.yml
-- test/fixtures/vcr_cassettes/lookup/key2.yml
-- test/fixtures/vcr_cassettes/lookup/key3.yml
-- test/minitest_helper.rb
-- test/run_tests.rb
+- spec/fixtures/vcr_cassettes/accounts/test.yml
+- spec/fixtures/vcr_cassettes/lookup/key1.yml
+- spec/fixtures/vcr_cassettes/lookup/key2.yml
+- spec/fixtures/vcr_cassettes/lookup/key3.yml
+- spec/requests/accounts_spec.rb
+- spec/requests/basic_key_lookup_spec.rb
+- spec/spec_helper.rb

data/test/minitest_helper.rb

@@ -1,10 +0,0 @@
-$LOAD_PATH << File.dirname(File.expand_path(__FILE__).to_s).to_s+"/../lib/"
-require 'minitest/autorun'
-require 'vcr'
-require 'nimbussecure'
-
-VCR.configure do |c|
-  c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
-  c.hook_into :fakeweb
-  # c.stub_with :fakeweb
-end

data/test/run_tests.rb

@@ -1,6 +0,0 @@
-require 'minitest/autorun'
-test_dir_root=File.dirname(Pathname.new(File.expand_path(__FILE__)).realpath.to_s).to_s
-$LOAD_PATH << test_dir_root
-FileList["#{test_dir_root}/*_spec.rb"].each do |file|
-  require file
-end