bone 0.2.6 → 0.3.0

data/Gemfile

@@ -0,0 +1,9 @@
+# http://gembundler.com/man/gemfile.5.html
+source "https://rubygems.org/"
+
+gem 'familia', '0.6.0', :git => "git://github.com/delano/familia.git", :branch => '0.6'
+
+
+
+
+

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GIT
+  remote: git://github.com/delano/familia.git
+  revision: df5752a573b7a68d26aa940fad2edf4c25f7018f
+  branch: 0.6
+  specs:
+    familia (0.6.0)
+      gibbler (>= 0.8.4)
+      redis (>= 2.1.0)
+      storable (>= 0.8.3)
+      uri-redis (>= 0.4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    attic (0.5.2)
+    gibbler (0.8.4)
+      attic (>= 0.4.0)
+    redis (2.1.1)
+    storable (0.8.3)
+    uri-redis (0.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  familia (= 0.6.0)!

data/LICENSE.txt

@@ -1,19 +1,60 @@
-Copyright (c) 2009 Solutious Inc, Delano Mandelbaum
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Copyright (c) 2009-2011 Delano Mandelbaum, Solutious Inc.
+Distributes under the same terms as Ruby (copied below).
+---------------------------------------------------------------------------
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.md

@@ -1,70 +1,93 @@
-## Bone - 0.2 ##
+## Bone - 0.3 ##
 
-**Environment variables in the "visible mass of condensed water vapour floating in the atmosphere, typically high above the ground."**
+**Remote environment variables**
 
 ## Features
 
 * Store variables and files remotely
-* Simple interface
+* A command-line and ruby interface
+* Secure REST API (based on AWS sig)
+* Also supports direct [Redis](http://code.google.com/p/redis/) access.
 
 ## CLI Example
-    
+        
     # Specify arbitrary keys and values. 
     $ bone set cust_id c397d204aa4e94f566d7f78c
     $ bone cust_id
     c397d204aa4e94f566d7f78c
     
-    # File contents are read automatically...
-    $ bone set redis_conf config/redis-server.conf
+    # Set values from STDIN
+    $ >config/redis-server.conf bone set redis_conf 
     $ bone redis_conf 
-    # Redis configuration file example
-    ...
+    [content of redis-server.conf]
     
-    # unless you specify -s
-    $ bone set -s redis_conf config/redis-server.conf
-    $ bone redis_conf
-    config/redis-server.conf
+    # The data doesn't have to be text
+    $ >path/2/dog.jpg bone set dog_picture
+    $ bone dog_picture > dog.jpg 
+    $ open dog.jpg
     
     # Show all available keys
     $ bone keys
     cust_id
     redis_conf
+    dog_picture
     
 ## Ruby Example
 
     require 'bone'
     
-    ENV['BONE_TOKEN'] ||= Bone.generate_token
-    
     Bone[:cust_id] = 'c397d204aa4e94f566d7f78c'
     Bone[:redis_conf] = File.read('config/redis-server.conf')
     
     Bone[:cust_id]                    # => "c397d204aa4e94f566d7f78c"
-    Bone[:redis_conf]                 # => "# Redis configuration file example..."
+    Bone[:redis_conf]                 # => "[content of redis-server.conf]"
     
+    # OR
     
+    bone = Bone.new
+    bone[:latest_backup] = 'redis.rdb-2011-01-01'
+    bone.keys                         # => ['cust_id', 'latest_backup', 'redis_conf']
+    
+## Setting BONE_SOURCE ##
+
+Bone can store data via a REST API or directly to Redis. The default source is redis://127.0.0.1:6379. 
+
+### Redis ###
+
+If you are running [Redis](http://code.google.com/p/redis/) at a different address or port, you can change it by setting the BONE_SOURCE environment variable or by explicitly setting in Ruby with `Bone.source='redis://anotherhost:6379'`.
+
+### HTTP ###
+
+If you want to use the REST API, you need to run an instance of [boned](http://github.com/solutious/boned) (the bone daemon).You'd then set your bone source to something like `https://somehost:3073`. **Note: unless your bone client and server are on a private network, it is highly recommended to use HTTPS.**
+
+
 ## Installation
 
     $ sudo gem install bone
-    $ bone token
-    $ export BONE_TOKEN=YOURTOKEN
     
-You also need to running instance of [boned](http://github.com/solutious/boned) (the bone daemon).
-
+    $ bone generate
+    # Your token for http://localhost:3073
+    BONE_TOKEN=LBL6PEGVWLFR3PJIOFQG01GN
+    BONE_SECRET=tXvhnban0HD.Aqj$goK9a2oW$T/L8le9460cfXR1t^RfMXq.5vQ2^lHd-c.WND6V
+    
+    [Add BONE_TOKEN and BONE_SECRET to your .bashrc or equivalent]
     
-## More Information
+    $ bone
 
 
 ## Credits
 
 * Delano Mandelbaum (http://solutious.com)
+* Query signatures for the HTTP API are based on / stolen from: https://github.com/grempe/amazon-ec2/blob/master/lib/AWS.rb
 
 
 ## Thanks 
 
-* Kalin Harvey for the early feedback. 
+* Kalin Harvey and Marc-André Cournoyer for the early feedback.
 
 
 ## License
 
-See LICENSE.txt
+Copyright (c) 2009-2011 Delano Mandelbaum, Solutious Inc.
+
+Distributes under the same terms as Ruby

data/Rakefile

@@ -1,60 +1,65 @@
-
-require 'rake/clean'
-require 'rake/gempackagetask'
-require 'rake/testtask'
-require 'rake/runtest'
-require 'fileutils'
-include FileUtils
+require "rubygems"
+require "rake"
+require "rake/clean"
+require 'yaml'
 
 begin
   require 'hanna/rdoctask'
 rescue LoadError
   require 'rake/rdoctask'
 end
-
-
-task :default => :test
-
-
-# PACKAGE =============================================================
-
+ 
+config = YAML.load_file("VERSION.yml")
+task :default => ["build"]
+CLEAN.include [ 'pkg', 'doc' ]
 name = "bone"
-load "#{name}.gemspec"
 
-version = @spec.version
-
-Rake::GemPackageTask.new(@spec) do |p|
-  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
+    gem.name = name
+    gem.rubyforge_project = gem.name
+    gem.summary = "A simple store for remote environment variables"
+    gem.description = gem.summary
+    gem.email = "delano@solutious.com"
+    gem.homepage = "https://github.com/solutious/bone"
+    gem.authors = ["Delano Mandelbaum"]
+    gem.add_dependency("familia",            ">= 0.6.0")
+    gem.add_dependency("em-http-request")
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-task :test do
-  puts "Success!"
-end
 
-task :install => [ :rdoc, :package ] do
-	sh %{sudo gem install pkg/#{name}-#{version}.gem}
+Rake::RDocTask.new do |rdoc|
+  version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}.#{config[:BUILD]}"
+  rdoc.rdoc_dir = "doc"
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("LICENSE.txt")
+  rdoc.rdoc_files.include("bin/*.rb")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-task :uninstall => [ :clean ] do
-	sh %{sudo gem uninstall #{name}}
-end
 
+# Rubyforge Release / Publish Tasks ==================================
 
+#about 'Publish website to rubyforge'
+task 'publish:rdoc' => 'doc/index.html' do
+  #sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
+end
 
-Rake::RDocTask.new do |t|
-	t.rdoc_dir = 'doc'
-	t.title    = @spec.summary
-	t.options << '--line-numbers' <<  '-A cattr_accessor=object'
-	t.options << '--charset' << 'utf-8'
-	t.rdoc_files.include('LICENSE.txt')
-	t.rdoc_files.include('README.md')
-	t.rdoc_files.include('CHANGES.txt')
-	#t.rdoc_files.include('Rudyfile')  # why is the formatting f'd?
-	t.rdoc_files.include('bin/*')
-	t.rdoc_files.include('lib/**/*.rb')
+#about 'Public release to rubyforge'
+task 'publish:gem' => [:package] do |t|
+  sh <<-end
+    rubyforge add_release -o Any -a CHANGES.txt -f -n README.md #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
+    rubyforge add_file -o Any -a CHANGES.txt -f -n README.md #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
+  end
 end
 
-CLEAN.include [ 'pkg', '*.gem', '.config', 'doc', 'coverage*' ]
 
 
 

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:MAJOR: 0
+:MINOR: 3
+:PATCH: 0

data/bin/bone

@@ -28,7 +28,7 @@ class Bone::CLI::Definition
   
   global :D, :debug, "Enable debug mode" do
     Drydock.debug true
-    Bone.enable_debug
+    Bone.debug = true
   end
   
   about "Get a value for the given key"
@@ -40,37 +40,45 @@ class Bone::CLI::Definition
   usage "bone set keyname keyvalue"
   usage "bone set keyname=keyvalue"
   usage "bone set keyname path/2/file"
-  option :s, :string, "Assume value is a string even if file name exists"
   command :set => Bone::CLI
   
-  about "Delete a key/value pair"
-  usage "bone del keyname"
-  command :del => Bone::CLI
-  command_alias :del, :rem
-  command_alias :del, :delete
+  #about "Delete a key/value pair"
+  #usage "bone del keyname"
+  #command :del => Bone::CLI
+  #command_alias :del, :rem
+  #command_alias :del, :delete
   
   about "Display all available keys"
   usage "bone keys"
   usage "bone keys keyname"
   command :keys => Bone::CLI
   
-  about "Display the token or generate a new one"
+  about "Display the current token"
   usage "bone token"
-  option :f, :force, "Force generating a new token"
   command :token => Bone::CLI
+
+  about "Display the current secret"
+  usage "bone token"
+  command :secret => Bone::CLI
+
+  about "Generate a new token"
+  usage "bone generate"
+  command :generate => Bone::CLI
   
 end
 
 begin
   Drydock.run!(ARGV, STDIN) if Drydock.run? && !Drydock.has_run?
-rescue Bone::BadBone => ex
+rescue Bone::NoToken => ex
   puts "Invalid token: #{ex.message}"
-  puts "Run the following command to generate a new one:", "$ #{$0} token"
-  STDERR.puts ex.backtrace if Bone.debug?
+  puts "Create a token with one of the following commands:", 
+       "bone generate", 
+       "bone register TOKEN SECRET"
+  STDERR.puts ex.backtrace if Bone.debug
   exit 1
 rescue Bone::Problem => ex
   puts ex.message
-  STDERR.puts ex.backtrace if Bone.debug?
+  STDERR.puts ex.backtrace if Bone.debug
   exit 1
 rescue Drydock::ArgError, Drydock::OptError => ex
   STDERR.puts ex.message
@@ -84,6 +92,6 @@ rescue Interrupt
   exit 1
 rescue => ex
   STDERR.puts "ERROR (#{ex.class.to_s}): #{ex.message}"
-  STDERR.puts ex.backtrace if Drydock.debug?
+  STDERR.puts ex.backtrace if Drydock.debug
 end
 

data/bone.gemspec

@@ -1,46 +1,80 @@
-@spec = Gem::Specification.new do |s|
-  s.name = "bone"
-  s.rubyforge_project = 'bone'
-  s.version = "0.2.6"
-  s.summary = "Get Bones"
-  s.description = s.summary
-  s.author = "Delano Mandelbaum"
-  s.email = "delano@solutious.com"
-  s.homepage = "http://github.com/solutious/bone"
-  
-  s.extra_rdoc_files = %w[README.md LICENSE.txt CHANGES.txt]
-  s.has_rdoc = true
-  s.rdoc_options = ["--line-numbers", "--title", s.summary, "--main", "README.md"]
-  s.require_paths = %w[lib]
-  
-  s.executables = %w[bone]
-  
-  # = MANIFEST =
-  # git ls-files
-  s.files = %w(
-  CHANGES.txt
-  LICENSE.txt
-  README.md
-  Rakefile
-  Rudyfile
-  bin/bone
-  bone.gemspec
-  lib/bone.rb
-  lib/bone/cli.rb
-  try/bone.rb
-  vendor/drydock-0.6.8/CHANGES.txt
-  vendor/drydock-0.6.8/LICENSE.txt
-  vendor/drydock-0.6.8/README.rdoc
-  vendor/drydock-0.6.8/Rakefile
-  vendor/drydock-0.6.8/bin/example
-  vendor/drydock-0.6.8/drydock.gemspec
-  vendor/drydock-0.6.8/lib/drydock.rb
-  vendor/drydock-0.6.8/lib/drydock/console.rb
-  vendor/drydock-0.6.8/lib/drydock/mixins.rb
-  vendor/drydock-0.6.8/lib/drydock/mixins/object.rb
-  vendor/drydock-0.6.8/lib/drydock/mixins/string.rb
-  vendor/drydock-0.6.8/lib/drydock/screen.rb
-  )
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
 
-  
+Gem::Specification.new do |s|
+  s.name = %q{bone}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Delano Mandelbaum"]
+  s.date = %q{2010-12-17}
+  s.default_executable = %q{bone}
+  s.description = %q{A simple store for remote environment variables}
+  s.email = %q{delano@solutious.com}
+  s.executables = ["bone"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.md"
+  ]
+  s.files = [
+    "CHANGES.txt",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE.txt",
+     "README.md",
+     "Rakefile",
+     "Rudyfile",
+     "VERSION.yml",
+     "bin/bone",
+     "bone.gemspec",
+     "config/redis-server.conf",
+     "lib/bone.rb",
+     "lib/bone/api.rb",
+     "lib/bone/cli.rb",
+     "try/10_generate_try.rb",
+     "try/16_http_try.rb",
+     "try/20_instance_try.rb",
+     "try/25_key_token_object_try.rb",
+     "try/30_api_memory_try.rb",
+     "try/31_api_redis_try.rb",
+     "try/32_api_http_try.rb",
+     "try/manual_cli.rb",
+     "vendor/drydock-0.6.8/CHANGES.txt",
+     "vendor/drydock-0.6.8/LICENSE.txt",
+     "vendor/drydock-0.6.8/README.rdoc",
+     "vendor/drydock-0.6.8/Rakefile",
+     "vendor/drydock-0.6.8/bin/example",
+     "vendor/drydock-0.6.8/drydock.gemspec",
+     "vendor/drydock-0.6.8/lib/drydock.rb",
+     "vendor/drydock-0.6.8/lib/drydock/console.rb",
+     "vendor/drydock-0.6.8/lib/drydock/mixins.rb",
+     "vendor/drydock-0.6.8/lib/drydock/mixins/object.rb",
+     "vendor/drydock-0.6.8/lib/drydock/mixins/string.rb",
+     "vendor/drydock-0.6.8/lib/drydock/screen.rb"
+  ]
+  s.homepage = %q{https://github.com/solutious/bone}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{bone}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple store for remote environment variables}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<familia>, [">= 0.6.0"])
+      s.add_runtime_dependency(%q<em-http-request>, [">= 0"])
+    else
+      s.add_dependency(%q<familia>, [">= 0.6.0"])
+      s.add_dependency(%q<em-http-request>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<familia>, [">= 0.6.0"])
+    s.add_dependency(%q<em-http-request>, [">= 0"])
+  end
 end
+