keyp 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bff8c5655d1b350b28208c20add4b0b3cf884fd2
-  data.tar.gz: 53a122d43fda4ec7267bd77aea3626dc2e16dba6
+  metadata.gz: 2951607e2465cc3204c7f01d993802e75be59acb
+  data.tar.gz: efaa651f76f6d65eefde6316111bd62640790c43
 SHA512:
-  metadata.gz: cf0bbf2bc59d7a578afd69641032677ab6ff61f7d78331603a63e30fab9bd3dfd68e88756e9c74d0566f189d438bf92ebe91c9ad43ee7bef74b9379d5dac793b
-  data.tar.gz: baddf04bce4de7c751da7acf783a9527d00c31690cfa7d1a7697c402509c5cd912a9f2d1b4266d95d9f0eec08e79438b4628c2b1e3fd155559d04ef1797b2cc1
+  metadata.gz: d69defc81b8351eeeb6171738687dd2577c910e145ec67808ff56c72a6052c399d8be9bb399a38b857912d41d7de4d9574b50ea876206157ee383e8c122a8174
+  data.tar.gz: c4d11396115a4ebe2b0a1ed49f24cc2e1e72dbbada753aa0796d1fdaa301d5bfccd822f5d43168578b8dfca0f52249bf4d94e8d44b7e33442d7153f33c35e3f4

data/README.md

@@ -12,12 +12,14 @@ Web applications generally need sensitive information, like salts and keys. Mana
 
 ## Important
 
-Keyp is still in early development and is experimental. As such it is very much a work in progress. Not all features
+Keyp is still in early development. As such it is very much a work in progress. Not all features
 expressed in the documentation may be working. The documentation may be plain wrong. I don't recommend you use Keyp
 for any kind of production code at this point in this gem's lifecycle.
 
 ## Quick Tour
 
+To install, see "Installation" below
+
 Keyp manages key value pairs in collections. As of version 0.0.4, Keyp refers to collections as *bags*. There is a
 default bag called *default*. Unless you specify a bag name, *default* will be used.
 
@@ -51,7 +53,8 @@ Keyp is not limited to just access keys. Any kind of string based name/value pai
 
 TODO: Improve description
 
-_CAVEAT:_ This gem is at a very early stage in development. Any and all functionality is subject to change.
+_CAVEAT:_ This gem is at an early stage in development. Functionality is 
+subject to change depending on need and clarity.
 
 ## Installation
 
@@ -93,15 +96,14 @@ TODO: Write more detailed documentation, For now, see the quick start above and
     $ keyp --help
 
 ## Release Notes
+* v 0.0.7 - Added loading a bag from the ENV. Added renaming bags Fixed error with keys of less than three characters.
+* v 0.0.6 - Added copying key:values to the Ruby ENV in the library (still have to implement in the CLI)
 * v 0.0.5 - Fixed iso8601 error
 * v 0.0.4 - Fixed missing file error
 
 ## Development plan/Features to implement
 
-* Get basic functionality working soundly backed with effective tests
-* Implement .keyp directory setup
-* Add ENV vars to bag
-* Add bag vars to ENV
+* Fill out rspec tests 
 * Incorporate with shell configuration
 * Write very clear documentation
 * Implement import/Export to YAML and/or JSON

data/bin/keyp

@@ -6,16 +6,18 @@
 # implementations. A good number and a few well known use Thor, so seems like a good idea to
 # figure out how to use Thor as well.
 #
-# I'm trying out some of the different impementations for Keyp, learning how they work, pros and cons
-# Then I'll pick a single approach after exploring them
+
 
 # TO run in the project dir:
 # ruby -Ilib ./bin/keyp
+# or
+# bundle exec bin/keyp
 
 # resolve bin path, ignoring symlinks
 require 'pathname'
 bin_file = Pathname.new(__FILE__).realpath
 
+# The Keyp CLI uses GLI
 # http://davetron5000.github.io/gli/
 require 'gli'
 
@@ -24,13 +26,6 @@ require 'pp'
 require 'keyp'
 include GLI::App
 
-# keyp set key=value
-# keyp get key
-# keyp
-
-
-# keyp create bag
-
 program_desc 'A command line interface for the Keyp key:value manager'
 
 desc 'The Keyp bag to use'
@@ -42,6 +37,11 @@ switch [:d, :debug]
 desc 'Suppress hints: If invalid parameters are set, no suggestive feedback will be provided'
 switch [:s, :suppress]
 
+
+
+version Keyp::VERSION
+
+
 # TODO: fix this because this implies that we either already have a bag or it will create a new one
 pre do |global_options, command, options, args|
   # initialize our store
@@ -57,8 +57,7 @@ pre do |global_options, command, options, args|
     puts "---- end prehook ---"
   end
 
-  unless command.name ==  :setup
-
+  unless [:setup, :show, :delete].include? command.name
     # check if we are configured
     unless Keyp.configured?
       puts "Please run setup to use Keyp. Run with --help to view help menu"
@@ -125,7 +124,7 @@ command :set do |c|
     nvp = Keyp.parse_arg_string buff
 
     if nvp
-      $bag[nvp[:key]] = nvp[:value]
+      $bag[nvp[:key]] = nvp[:value].strip
     elsif global_options[:suppress] == false
       # puts "Usage keyp set KEY1=VALUE1 [KEY2=VALUE2 ...]"
       puts "Usage: keyp set KEY=VALUE"
@@ -190,8 +189,11 @@ command :setup do |c|
   end
 end
 
-command :create do |c|
+create_desc = 'Creates a new bag'
 
+desc create_desc
+command :create do |c|
+  c.desc create_desc
   c.action do |global_options, options, args|
     puts "keyp create"
     # TODO: add checking in case store already exists
@@ -206,14 +208,56 @@ command :create do |c|
   end
 end
 
+delete_desc = 'Deletes an existing bag or set of bags matching the delete parameter'
+desc delete_desc
 command :delete do |c|
+  c.desc 'forces delete (no prompting)'
+  c.switch [:f, :force]
+  c.desc "outputs the name of each file as it's deleted"
+  c.switch [:v, :verbose]
+  c.desc "Confirm deletion of each file. Currently not enabled"
+  c.switch [:c, :confirm]
+  c.desc delete_desc
   c.action do |global_options, options, args|
-    puts "delete bag is not supported at this time"
-    # TODO: prompt for verification
+    # TODO: add * for all bags
+    # TODO: enable prompting per file. Confirm skips the global confirm
+
+    help_now!('filename pattern is required') if args.empty?
+
+    if options[:force]
+      do_delete = true
+    else
+      puts "This will delete all the bags matching \"#{args[0]}\"."
+      print "Are you sure? (yes to confirm. Anything else to cancel) "
+      do_delete = STDIN.gets.chomp.upcase == 'YES'
+    end
+
+    if do_delete
+      # experimenting with different techniques
+      delete_type = 1
+      case delete_type
+        when 1
+          files = Dir["#{File.join(Keyp.home,args[0]+Keyp.ext)}"]
+          puts "going to delete files #{files}" if $debug
+          files.each do |f|
+            File.delete(f)
+            puts "deleted #{File.basename(f, Keyp.ext)}" if options[:verbose]
+          end
+        when 2
+          result = File.delete(args[0])
+          puts "delete results: #{result}"
+          #TODO: provide feedback
+      end
+    else
+      puts "delete bag(s) canceled."
+    end
   end
 end
 
+show_desc = 'Lists all the bags in Keyp'
+desc show_desc
 command :show do |c|
+  c.desc show_desc
   c.action do |global_options, options, args|
     # TODO: implement filtering, stats (like number of items in a bag, last updated, etc)
     # and just filename
@@ -224,13 +268,40 @@ command :show do |c|
   end
 end
 
-post do |global_options, command, options, args|
-  # if bag.data is dirty, then save
-  if $debug
-    puts "post-hook, state of bag.dirty = #{$bag.dirty}"
+rename_desc = 'Rename the given bag'
+desc rename_desc
+command :rename do |c|
+  #c.desc 'from bag name)'
+  #c.flag [:f, :from]
+  #c.desc 'to bag name'
+  #c.flag [:t, :to]
+  c.desc rename_desc
+  c.action do |global_options, options, args|
+    # get from_name and to_name
+    if args.count < 2
+      puts "TODO: rename help"
+    else
+      begin
+        res = Keyp::rename_bag(from: args[0], to: args[1])
+        puts "Renamed bag #{args[0]} to #{args[1]}"
+      rescue
+        puts "Unable to rename bag #{args[0]} to #{args[1]}"
+        # TODO: add reason
+      end
+
+    end
   end
+end
+
 
-  unless command.name == :setup
+post do |global_options, command, options, args|
+
+  unless [:setup, :show, :delete].include? command.name
+    if $debug
+      puts "post-hook, state of bag.dirty = #{$bag.dirty}"
+    end
+    # if bag.data is dirty, then save
+    # TODO: check bag.save. if it checks dirty, then we don't need to check here
     $bag.save
   else
     true

data/lib/keyp.rb

@@ -43,6 +43,8 @@ module Keyp
   # Default home directory that keyp uses to store bags
   DEFAULT_KEYP_DIR = '.keyp'
 
+  # number of digits for the fractional seconds in decimal
+  TIMESTAMP_FS_DIGITS = 6
   #TODO: set this
   #ENV_VAR_NAME_REGEX =
 
@@ -64,7 +66,16 @@ module Keyp
   # it is recommended you restrict permissions
   #
   def self.home
-    ENV['KEPY_HOME'] || File.join(ENV['HOME'], DEFAULT_KEYP_DIR)
+    #puts "Keyp::home, KEYP_HOME=#{ENV['KEYP_HOME']}"
+    ENV['KEYP_HOME'] || File.join(ENV['HOME'], DEFAULT_KEYP_DIR)
+=begin
+    puts "home_dir=#{home_dir}"
+    if ENV['KEYP_HOME']
+      ENV['KEYP_HOME']
+    else
+      File.join(ENV['HOME'], DEFAULT_KEYP_DIR)
+    end
+=end
   end
 
   ##
@@ -94,15 +105,13 @@ module Keyp
     # check if keyp directory exists
 
     unless Dir.exist?(home)
-      puts "making directory #{home}"
       Dir.mkdir(home, 0700)
       if Dir.exist?(home)
         home
       else
-        nil
+        raise "unable to create Keyp directory #{home}"
       end
     else
-      Puts "#{home} already exists"
       nil
     end
   end
@@ -159,25 +168,14 @@ module Keyp
   ##
   # Creates a new bag if one does not already exist with the given name
   #
+  # raises exception if bag already exists
+  # NOTE: We might want to change this
   def self.create_bag(name, options = {} )
-    time_now = Time.now.utc.iso8601
-    file_data = {}
-    file_data['meta'] = {
-      'name' => name,
-      'description' => '',
-      'created_at' => time_now,
-      'updated_at' => time_now
-    }
-    file_data['data'] = nil
     unless exist? name
-      File.open(bag_path(name), 'w') do |f|
-        f.write file_data.to_yaml
-        f.chmod(0600)
-      end
+      Bag.new(name)
     else
-      raise "Unable to create a new store at #{filepath}. One already exists."
+      raise "Unable to create a new bag \"#{name}\". It already exists."
     end
-    bag name
   end
 
   ##
@@ -193,6 +191,33 @@ module Keyp
     end
   end
 
+  ##
+  #
+  # == options
+  # +:from+ current name of the bag (rename from)
+  # +:to+ new name of the bag (rename to)
+  #
+  def self.rename_bag(options = {})
+
+    #TODO: Implement this
+    # validate_options(:from,:to)
+
+    from_name = options[:from]
+    to_name = options[:to]
+
+    unless from_name || to_name
+      raise "required parameters are missing. Requires both :from and :to"
+    end
+
+    # if current bag does not exist, we raise and exception
+    unless exist?(from_name)
+      raise ("cannot rename #{from_name} because it does not exist")
+    end
+    bag = bag(from_name)
+    bag.rename(to_name)
+    #bag(from_name).rename(to_name)
+  end
+
   def self.parse_arg_string(arg_string, options={})
 
     mode = options[:token_mode] || :default

data/lib/keyp/bag.rb

@@ -4,21 +4,27 @@ module Keyp
   # Some inspiration:
   # http://stackoverflow.com/questions/2680523/dry-ruby-initialization-with-hash-argument
   #
-  # TODO: add handling so that keys (hierarchical keys too) are accessed as members instead of
-  # hash access
+  # TODO: add handling so that keys (hierarchical keys too) are accessed as members instead of hash access
   #
-  # TODO: move to own file, rename to "Bag"
   # TODO: i18n error messages
+  # TODO: handle symbol to string and back for keys. Need instance setting to handle validating keys as symbols
   #
   class Bag
 
-    attr_reader :keypdir, :dirty
-    attr_accessor :name, :data, :file_hash
+    # TODO: Make name attr_reader
+    # TODO: See if we need data as an attr_accessor If not then it makes
+    # it easier to encapsulate handling of string/symbol keys
+    attr_reader :keypdir, :dirty, :meta
+    attr_accessor :data, :file_hash
+
+    def name
+      @meta['name']
+    end
 
     ##
     # Returns the full path of this Bag's file
     def keypfile
-      File.join(@keypdir, @name+@ext)
+      File.join(@keypdir, name+@ext)
     end
 
     ##
@@ -28,39 +34,44 @@ module Keyp
     # +keypdir+
     # +read_only+
     # +ext+
-    def initialize(name, options = {})
+    def initialize(bag_name, options = {})
       # I'm not happy with how creating instance variables works. There must be a cleaner way
-      @name = name
+      @meta = { 'name' => bag_name}
       options.each do |k,v|
-        puts "processing options #{k} = #{v}"
+        #JB set debug log: puts "processing options #{k} = #{v}"
         instance_variable_set("@#{k}", v) unless v.nil?
       end
-      # set attributes not set by params
 
+      # set attributes not set by params
       @keypdir ||= Keyp::home
       @read_only ||= false
       @ext ||= Keyp::DEFAULT_EXT
-      #@keypfile = config_path
-      # load our resource
-
-      # load config file into hashes
-      # not the most efficient thing, but simpler and safe enough for now
 
       unless File.exist? keypfile
-        puts "Bag.initialize, create_bag #{keypfile}"
-        Keyp::create_bag(name)
+        #JB set debug log: puts "Bag.initialize, create_bag #{keypfile}"
+        #TODO: move this to its own method
+        time_now = Time.now.utc.iso8601(TIMESTAMP_FS_DIGITS)
+        file_data = {}
+        file_data['meta'] = {
+            'name' => bag_name,
+            'description' => '',
+            'created_at' => time_now,
+            'updated_at' => time_now
+        }
+        file_data['data'] = nil
+        File.open(Keyp::bag_path(bag_name), 'w') do |f|
+          f.write file_data.to_yaml
+          f.chmod(0600)
+        end
       end
-      file_data = load(keypfile)
-
-      @meta = file_data[:meta]
-      @data = file_data[:data]|| {}
-      @file_hash = file_data[:file_hash]
+      load_file
       @dirty = false
     end
 
     ##
     #
     def [](key)
+      # TODO: convert from any symbols to string
       @data[key]
     end
 
@@ -74,6 +85,7 @@ module Keyp
     # Sets a key:value pair
     # NOTE: This may be made protected
     def set_prop(key, value)
+      # TODO
       unless @read_only
         # TODO: check if data has been modified
         # maybe there is a way hash tells us its been modified. If not then
@@ -83,22 +95,19 @@ module Keyp
           @dirty = true
         end
       else
-        raise "Bag #{@name} is read only"
+        raise "Bag #{name} is read only"
       end
     end
 
     ##
     # Deletes the key:value pair from this bag for the given key
     def delete(key)
-      unless @read_only
-        if @data.key? key
-          @dirty = true
-        end
-        val = @data.delete(key)
-      else
-        raise "Bag #{@name} is read only"
+      if @read_only
+        raise "Cannot delete key \"#{key}\". Bag \"#{name}\" is read only."
       end
-      val
+
+      @dirty = true if @data.key? key
+      @data.delete(key)
     end
 
     ##
@@ -108,6 +117,14 @@ module Keyp
     end
 
 
+    def read_only?
+      @read_only
+    end
+
+    def key?(key)
+      @data.key?(key)
+    end
+
     ##
     # Adds key/value pairs from this bag to the Ruby ENV
     # NOTE: Currently in development.
@@ -136,7 +153,7 @@ module Keyp
       overwrite = options[:overwrite] || false
       pattern = options[:sysvar] if options.key?(:sysvar)
 
-      pattern ||= /(...)/
+      pattern ||= /(..*)/
       @data.each do |key,value|
         if pattern.match(key)
           # TODO: add overwrite checking
@@ -147,9 +164,71 @@ module Keyp
       assigned
     end
 
+    ##
+    # load environment variables into this bag
+    # === Options
+    # +:pattern+ Applies keys matching this pattern
+    # +:overwrite+ true to overwrite existing keys, false (default) to not overwrite existing keys
+    #
+    #
+    def load_from_env(options = {})
+      assigned = {}
+      overwrite = options[:overwrite] || false
+      pattern = options[:pattern] || /(..*)/
+      ENV.each do | key, value|
+        if pattern.match(key)
+          unless overwrite && @data.key?(key)
+            @data[key] = value
+            assigned[key] = value
+          end
+        else
+          puts "load_from_env. No match for #{key}"
+        end
+      end
+      assigned
+    end
 
     # TODO add from hash
 
+    ##
+    # renames the bag to +new_name+
+    # returns new bag name if succesful, raises exception if not
+    #
+    def rename(new_name, options = {})
+
+      # Since we are not changing any key pairs, the only meta to be changed is +name+
+      #
+      # TODO: Check for valid key name
+      #TODO: change to try to create a new file and lock it. If we can, then we fill it
+      if Keyp::exist?(new_name)
+        raise "Bag rename error. Target \"#{new_name}\" already exists."
+      end
+
+      if @dirty
+        # We don't want to allow renaming a bag with modified values because it will complicate rollback
+        #TODO: improve error message
+        raise "Can't rename a modified bag. Save first"
+      end
+
+      # TODO: treat the following as a transaction so if the bag file can't be renamed then
+      # the old file is restored unmodified
+      #curr_name = @meta['name']
+      curr_name = name
+      old_file = Keyp::bag_path(curr_name)
+      to_file = Keyp::bag_path(new_name)
+      #TODO: Add file locking for concurrency protection
+      @meta['name'] = new_name
+      @meta['last_name'] =curr_name
+      @renaming = true
+      # saves with the new name
+      save
+      @renaming = nil
+      # now remove the old file
+      File.delete(old_file)
+
+      load_file
+      @meta['name']
+    end
 
     def import(filename)
       raise "import not yet supported"
@@ -165,39 +244,12 @@ module Keyp
     # TODO: def to_s
 
     ##
-    # Give full path, attempt to load
-    # sticking with YAML format for now
-    # May add new file format later in which case we'll
-    # TODO: consider changing to class method
-    def load (config_path)
-      #config_data = {}
-      # Get extension
-      file_ext = File.extname(config_path)
-
-      # check
-      # only YAML supported for initial version. Will consider adapters to
-      # abstract the persistence layer
-
-
-      # TODO: make this hardcoded case a hash of helpers
-      # TODO: Add two sections: Meta and data, then return as hash
-
-      if file_ext.downcase == Keyp::DEFAULT_EXT
-
-        # Either we are arbitrarily creating directories when
-        # given a path for a file that doesn't exist
-        # or we have special behavior for the default dir
-        # or we just fault and let the caller deal with it
-        unless File.exist? config_path
-          raise "Keyp config file not found: #{config_path}"
-        end
-
-        file_data = YAML.load_file(config_path)
-
-      else
-        raise "Keyp version x only supports YAML for config files. You tried a #{file_ext}"
-      end
-      { meta: file_data['meta'], data: file_data['data']||{}, file_hash: file_data.hash }
+    #
+    def load_file
+      file_data = Bag::load_file(keypfile)
+      @meta = file_data[:meta]
+      @data = file_data[:data]|| {}
+      @file_hash = file_data[:file_hash]
     end
 
     ##
@@ -209,22 +261,25 @@ module Keyp
       if @read_only
         raise "This bag instance is read only"
       end
-      if @dirty
+      if @dirty || @renaming
         # lock file
         # read checksum
         # if checksum matches our saved checksum then update file and release lock
         # otherwise, raise
         # TODO: implement merge from updated file and raise only if conflict
         begin
-          file_data = { 'meta' => @meta, 'data' => @data }
-
           if File.exist? keypfile
-            read_file_data = load(keypfile)
+            read_file_data = Bag::load_file(keypfile)
             unless @file_hash == read_file_data[:file_hash]
               raise "Will not write to #{keypfile}\nHashes differ. Expected hash =#{@file_hash}\n" +
                         "found hash #{read_file_data[:file_hash]}"
             end
           end
+          if @dirty && !@renaming
+            @meta['updated_at'] = Time.now.utc.iso8601(Keyp::TIMESTAMP_FS_DIGITS)
+          end
+
+          file_data = { 'meta' => @meta, 'data' => @data }
           File.open(keypfile, 'w') do |f|
             f.write file_data.to_yaml
           end
@@ -233,7 +288,49 @@ module Keyp
           # TODO: log error
 
         end
+      else
+        puts "save called but not saving (not dirty or renaming flag set"
+      end
+    end
+
+
+    # Class methods
+    ##
+    # Give full path, attempt to load
+    # sticking with YAML format for now
+    # May add new file format later in which case we'll
+    # TODO: Make this a class method and an instance method
+    # that calls the class method and does the instance assignment
+    def self.load_file (config_path)
+      # Get extension
+      file_ext = File.extname(config_path)
+
+      # check
+      # only YAML supported for initial version. Will consider adapters to
+      # abstract the persistence layer
+
+
+      # TODO: make this hardcoded case a hash of helpers
+      # TODO: Add two sections: Meta and data, then return as hash
+
+      if file_ext.downcase == Keyp::DEFAULT_EXT
+
+        # Either we are arbitrarily creating directories when
+        # given a path for a file that doesn't exist
+        # or we have special behavior for the default dir
+        # or we just fault and let the caller deal with it
+        unless File.exist? config_path
+          raise "Keyp config file not found: #{config_path}"
+        end
+
+        file_data = YAML.load_file(config_path)
+
+      else
+        raise "Keyp version x only supports YAML for config files. You tried a #{file_ext}"
       end
+      { meta: file_data['meta'], data: file_data['data']||{}, file_hash: file_data.hash }
     end
-  end
-end
+
+
+  end # class Bag
+end # module Keyp

data/lib/keyp/version.rb

@@ -1,3 +1,3 @@
 module Keyp
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/bag_spec.rb

@@ -2,44 +2,53 @@ require 'spec_helper'
 
 describe Keyp::Bag do
 
+  def bag_name_for_testing
+    # TODO: pseudo random bag name generation to a helper
+    "grue_eats_you_when_it_is_dark_#{Time.now.strftime("%Y%m%d%H%M%S%L")}"
+  end
+
   context "is empty" do
     before (:each) do
-      puts "before : is empty"
-      @bag = Keyp::Bag.new 'testing123'
+      @bag_name = bag_name_for_testing
+      @bag = Keyp::Bag.new @bag_name
     end
 
     it "should return an empty hash" do
-
       @bag.data.size.should == 0
     end
-    #it "should have metadata" do
-    #  @bag.meta['created_on'].should_not == nil
-    #end
+    after (:each) do
+      Keyp.delete_bag @bag_name if Keyp.exist? @bag_name
+    end
   end
 
   context "is not empty" do
     before (:each) do
-      puts "before : is not empty"
-      @bag = Keyp::Bag.new 'grue_eats_you'
+      @bag_name = bag_name_for_testing
+      @bag = Keyp::Bag.new @bag_name
       @bag['LIGHTS'] = 'out'
     end
 
     it "should return a non-empty hash" do
       @bag.data.size.should > 0
     end
+    after (:each) do
+      Keyp.delete_bag @bag_name if Keyp.exist? @bag_name
+    end
   end
 
   context "environment variables" do
     before (:each) do
-      # TODO: pseudo random bag name generation to a helper
-      bag_name = "grue_eats_you_when_it_is_dark_#{Time.now.strftime("%Y%m%d%H%M%S%L")}"
-      @bag = Keyp::Bag.new bag_name
+      @bag_name = bag_name_for_testing
+      @bag = Keyp::Bag.new @bag_name
     end
     it "should copy all vars"  do
       testvars = {
           'ALPHA' => 'First in the phonetic alphabet',
           'BRAVO' => 'Second in the phonetic alphabet',
-          'CHARLIE' => 'Third in the phonetic alphabet'
+          'CHARLIE' => 'Third in the phonetic alphabet',
+          '_' => 'a single underscore',
+          'a' => 'first letter in the alphabet',
+          'bb' => 'two of the second letter in the alphabet'
       }
 
       testvars.each { |key, value| @bag[key] = value }
@@ -50,14 +59,39 @@ describe Keyp::Bag do
         ENV[key].should == value
       end
     end
+
+    it 'should receive all vars' do
+      test_keyvals = {
+        'foo' => 'bar',
+        'biz' => 'baz',
+        'GRUE' => 'Eats you in the dark',
+        'a' => 'first letter in the alphabet',
+        'bb' => 'two of the second letter in the alphabet'
+      }
+
+      test_keyvals.each do |key,value|
+        ENV[key] = value
+      end
+      @bag.load_from_env
+      ENV.each do |key,value|
+        #puts "testing key=#{key}"
+        @bag.key?(key).should == true
+        @bag[key].should == value
+      end
+    end
+
+    it 'should not overwrite existing keys'
+    it 'should match filtering pattern'
+    after (:each) do
+      Keyp.delete_bag @bag_name if Keyp.exist? @bag_name
+    end
   end
 
-  context "bag state" do
+  context 'Bag state' do
 
     before (:each) do
-      # TODO: pseudo random bag name generation to a helper
-      bag_name = "grue_eats_you_when_it_is_dark_#{Time.now.strftime("%Y%m%d%H%M%S%L")}"
-      @bag = Keyp::Bag.new bag_name
+      @bag_name = bag_name_for_testing
+      @bag = Keyp::Bag.new @bag_name
     end
 
     it 'should not set the dirty flag when no items are in the bag' do
@@ -92,10 +126,102 @@ describe Keyp::Bag do
       @bag['KEY1'] = 'value1'
       @bag.dirty.should == false
     end
+
+    it 'should allow assigning a key if not read only'
+    it 'should not allow assigning a key if read only'
+    after (:each) do
+      Keyp.delete_bag @bag_name if Keyp.exist? @bag_name
+    end
+  end
+
+  context 'Metadata' do
+
+    before (:each) do
+      @bag_name = bag_name_for_testing
+      @bag = Keyp::Bag.new @bag_name
+    end
+
+    it "should have metadata" do
+    #  @bag.meta['created_on'].should_not == nil
+    end
+
+    it 'should not update created_at after bag is initially created' do
+      created_at = @bag.meta['created_at']
+      @bag['foo'] = 'bar'
+      @bag.save
+      @bag.meta['created_at'].should == created_at
+    end
+
+    it 'should update updated_at when bag is saved' do
+      updated_at = @bag.meta['updated_at']
+      @bag['foo'] = 'bar'
+      @bag.save
+      @bag.meta['updated_at'].should > updated_at
+    end
+
+    it 'should not update updated_at if bag has not been saved' do
+      updated_at = @bag.meta['updated_at']
+      @bag['foo'] = 'bar'
+      @bag.meta['updated_at'].should == updated_at
+    end
+
+    it 'should use metadata for the bag name' do
+      def @bag.set_name(name)
+        @meta['name'] = name
+      end
+      test_name = 'norwegian_blue'
+      @bag.set_name(test_name)
+      @bag.name.should == test_name
+    end
+    after (:each) do
+      Keyp.delete_bag @bag_name if Keyp.exist? @bag_name
+    end
   end
 
+  context 'Bag management' do
+    before (:each) do
+      @from_name = bag_name_for_testing
+      @from_bag = Keyp::Bag.new @from_name
+      sleep(1)
+      @to_name = bag_name_for_testing
+    end
+
+    it 'should rename if new name does not exist' do
+      bag = @from_bag
+      kp = {
+          'key1' => 'value1',
+          'key2' => 'value2'
+      }
+
+      # seed a couple of kv pairs just to keep it a bit real
+      # but we should also test with an empty bag
+      kp.each {|k,v| bag[k] = v }
+      bag.save
+      before_meta = {}
+      bag.meta.each { |k,v| before_meta[k] = v }
+      bag.name.should == @from_name
+      @to_name.should_not == @from_name
+      # we know the to_name does not exist
+      result = bag.rename(@to_name)
+      bag.name.should == @to_name
+      bag.meta['name'].should == @to_name
+      bag.meta['created_at'].should == before_meta['created_at']
+      # Since we are not changing any key pairs, updated_at doesn't change
+      bag.meta['updated_at'].should == before_meta['updated_at']
+      bag.meta['name'].should_not == before_meta['name']
+    end
+
+    it 'should not rename if new name exists' do
+
+    end
+    after (:each) do
+      Keyp.delete_bag @from_name if Keyp.exist? @from_name
+      Keyp.delete_bag @to_name if Keyp.exist? @to_name
+    end
+  end
+
+
   it 'should return a key with data member'
   it 'should return a key acting as a hash'
-  it 'should allow assigning a key if not read only'
-  it 'should not allow assigning a key if read only'
+
 end

data/spec/keyp_spec.rb

@@ -1,18 +1,25 @@
 require 'spec_helper'
+require 'tmpdir'
+require 'fileutils'
 
 describe Keyp do
 
-  context "CONSTANTS" do
+  def bag_name_for_testing
+    # TODO: pseudo random bag name generation to a helper
+    "bring_a_towel_#{Time.now.strftime("%Y%m%d%H%M%S%L")}"
+  end
+
+  context 'CONSTANTS' do
     it 'should return correct version string' do
       #Keyp.version_string.should == "Keyp version #{Keyp::VERSION}"
-      Keyp::VERSION.should == '0.0.6'
+      Keyp::VERSION.should == '0.0.7'
     end
 
     it 'should specify default store' do
       Keyp::DEFAULT_BAG.should == 'default'
     end
 
-    it "should specifify default store extension" do
+    it 'should specifify default store extension' do
       Keyp::DEFAULT_EXT.should == '.yml'
     end
 
@@ -21,16 +28,41 @@ describe Keyp do
     end
   end
 
-  context "Keyp directory" do
+  context 'Default Keyp directory' do
     it 'should return correct default keyp dir' do
       # DEFAULT_KEYP_DIRNAME = ENV['KEYP_DIRNAME'] || '.keyp'
       Keyp::home.should == File.join(ENV['HOME'], '.keyp')
     end
+  end
+
+  context 'Alternate Keyp directory' do
+
+
+    before (:each) do
+      @root_tempdir = Dir.mktmpdir
+      @temp_keyp_dir = File.join(@root_tempdir,Keyp::DEFAULT_KEYP_DIR)
+      ENV['KEYP_HOME'] = @temp_keyp_dir
+    end
+
+    it 'should be able to override default keyp dir' do
+      puts "ENV['KEYP_HOME']=#{ENV['KEYP_HOME']}"
+      keyp_dir = Keyp::setup
+      keyp_dir.should == Keyp::home
+      keyp_dir.should == @temp_keyp_dir
+      Keyp::home.should == ENV['KEYP_HOME']
+
+    end
 
-    it 'should be able to override default keyp dir'
+    #TODO: Keyp::setup should return nil when trying to setup to an existing dir
+    # Check if we can describe a method
+    after (:each) do
+      puts "AFTER called, going to try to delete #{@tempdir}"
+      FileUtils.rm_rf @root_tempdir
+      ENV['KEYP_HOME'] = nil
+    end
   end
 
-  context "Bag management" do
+  context 'Bag management' do
     it 'should return default bag' do
       keyper = Keyp::bag
       keyper.name.should == 'default'
@@ -42,15 +74,65 @@ describe Keyp do
       Keyp.exist?(keyper.name).should == true
     end
 
-    it "should say a bag does not exist" do
+    it 'should say a bag does not exist' do
       # TODO: add bag name generation to a helper
       bag_name = "grue_eats_you_when_it_is_dark_#{Time.now.strftime("%Y%m%d%H%M%S%L")}"
       Keyp.exist?(bag_name).should_not == true
     end
-
   end
 
+  context 'Renaming bags' do
+    # NOTE: Yeah, this code and the bag_spec code are redundant
+    before (:each) do
+      @from_name = bag_name_for_testing
+      if Keyp::exist?(@from_name)
+        puts "Rename bag, bag #{@from_name} already exists"
+      else
+        puts "Rename bag, bag #{@from_name} does NOT exist"
+      end
+      @from_bag = Keyp.create_bag(@from_name)
+      sleep(1)
+      @to_name = bag_name_for_testing
+    end
 
+    it 'should rename bag if it exists and new name does not' do
+      bag = @from_bag
+      kp = {
+          'key1' => 'value1',
+          'key2' => 'value2'
+      }
+
+      # seed a couple of kv pairs just to keep it a bit real
+      # but we should also test with an empty bag
+      kp.each {|k,v| bag[k] = v }
+      bag.save
+      before_meta = {}
+      bag.meta.each { |k,v| before_meta[k] = v }
+      bag.name.should == @from_name
+      @to_name.should_not == @from_name
+      result = Keyp.rename_bag(from: @from_name, to: @to_name)
+      Keyp.exist?(@from_name).should == false
+      Keyp.exist?(@to_name).should == true
+      bag = Keyp.bag @to_name
+      bag.name.should == @to_name
+      bag.meta['name'].should == @to_name
+      bag.meta['created_at'].should == before_meta['created_at']
+      # Since we are not changing any key pairs, updated_at doesn't change
+      bag.meta['updated_at'].should == before_meta['updated_at']
+      kp.each do |k,v|
+        bag.key?(k).should == true
+        bag[k].should == v
+      end
+    end
+
+    it 'should not rename bag if current name does not exist'
+    it 'should not rename bag if new name exists'
+
+    after (:each) do
+      Keyp.delete_bag @from_name if Keyp.exist? @from_name
+      Keyp.delete_bag @to_name if Keyp.exist? @to_name
+    end
+  end
 
 
   # Braindump of tests

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keyp
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - John Baldwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli