cliaws 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+*.log

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0 2008-04-12
+
+* Implemented s3 command-line client.

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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.

data/Manifest.txt

@@ -0,0 +1,28 @@
+.gitignore
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/clis3
+config/hoe.rb
+config/requirements.rb
+lib/cliaws.rb
+lib/cliaws/s3.rb
+lib/cliaws/version.rb
+log/.gitignore
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_cliaws.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,75 @@
+= cliaws
+
+* http://rubyforge.org/projects/cliaws
+
+== DESCRIPTION:
+
+A command-line client for Amazon Web Services.
+
+== FEATURES/PROBLEMS:
+
+* Amazon keys are read from the environment only.  They environment keys must
+  be named:  AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
+* Minimal amount of error checking is done.  Check the command's status after
+  each call.
+* No logging.
+
+== SYNOPSIS:
+
+Usage from the command line:
+
+  $ clis3 list my_awesome_bucket/a_glob
+  $ clis3 put my_awesome_bucket/a_key_name a_local_file
+  $ cat a_local_file | clis3 put my_awesome_bucket/a_key_name
+  $ clis3 put --data "this is the data" my_awesome_bucket/a_key_name
+  $ clis3 get my_awesome_bucket/a_key_name a_local_file
+  $ clis3 get my_awesome_bucket/a_key_name # Outputs to STDOUT
+  $ clis3 cat my_awesome_bucket/a_key_name # Outputs to STDOUT, but adds an extra newline
+  $ clis3 head my_awesome_bucket/a_key_name
+    # Returns a YAML representation of response and metadata headers
+  $ clis3 rm my_awesome_bucket/a_key_name
+
+Cliaws may also be used from Ruby:
+
+  Cliaws.s3.list("my_awesome_bucket/a_glob") # Returns an array of names
+  Cliaws.s3.put(File.open("a_local_file", "rb"), "my_awesome_bucket/a_key_name")
+  Cliaws.s3.put(STDIN, "my_awesome_bucket/a_key_name")
+  Cliaws.s3.put("this is the data", "my_awesome_bucket/a_key_name")
+  Cliaws.s3.get("my_awesome_bucket/a_key_name")
+  Cliaws.s3.head("my_awesome_bucket/a_key_name")
+  Cliaws.s3.rm("my_awesome_bucket/a_key_name")
+
+== REQUIREMENTS:
+
+* main
+* activesupport
+* right_aws
+
+== INSTALL:
+
+* sudo gem install cliaws
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 François Beausoleil (francois@teksol.info)
+
+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.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/clis3

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-4-12.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require "main"
+require "cliaws"
+
+Main {
+  argument("s3_object") do
+    required
+    argument_required
+  end
+
+  mode("list") do
+    def run
+      puts Cliaws.s3.list(params["s3_object"].value)
+    end
+  end
+
+  mode("touch") do
+    def run
+      Cliaws.s3.put("", params["s3_object"].value)
+    end
+  end
+
+  mode("put") do
+    argument("local_file") do
+      optional
+      argument_required
+    end
+
+    option("data") do
+      optional
+      argument_required
+    end
+
+    def run
+      if params["local_file"].given? && params["data"].given? then
+        abort "Cannot give both the --data and local_file parameters at the same time"
+      elsif !params["local_file"].given? && !params["data"].given? then
+        source = STDIN
+      elsif params["local_file"].given? then
+        source = File.open(params["local_file"].value, "rb")
+      else
+        source = params["data"].value
+      end
+
+      Cliaws.s3.put(source, params["s3_object"].value)
+    end
+  end
+
+  mode("rm") do
+    def run
+      Cliaws.s3.rm(params["s3_object"].value)
+    end
+  end
+
+  mode("cat") do
+    def run
+      Cliaws.s3.get(params["s3_object"].value, STDOUT)
+      puts
+    end
+  end
+
+  mode("get") do
+    argument("local_file") do
+      argument_required
+      optional
+    end
+
+    def run
+      if params["local_file"].given? then
+        dest = File.open(params["local_file"].value, "wb")
+      else
+        dest = STDOUT
+      end
+
+      Cliaws.s3.get(params["s3_object"].value, dest)
+    end
+  end
+
+  mode("head") do
+    def run
+      Cliaws.s3.head(params["s3_object"].value)
+    end
+  end
+
+  def run
+    abort "Required action argument missing.  Run '#{$0} help' for details."
+  end
+}

data/config/hoe.rb

@@ -0,0 +1,74 @@
+require 'cliaws/version'
+
+AUTHOR = 'François Beausoleil'  # can also be an array of Authors
+EMAIL = "francois@teksol.info"
+DESCRIPTION = "A command-line suite of tools to access Amazon Web Services, using the RightAws gems."
+GEM_NAME = 'cliaws' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'cliaws' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Cliaws::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'cliaws documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [
+    ["main", "~> 2.8.0"],
+    ["right_aws", "~> 1.7.1"],
+    ["activesupport", "~> 2.0.2"]
+  ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/cliaws/s3.rb

@@ -0,0 +1,50 @@
+require "right_aws"
+require "activesupport"
+
+module Cliaws
+  class S3
+    def initialize(access_key_id, secret_access_key)
+      @s3 = RightAws::S3.new(access_key_id, secret_access_key, :logger => Logger.new("/dev/null"))
+    end
+
+    def list(glob)
+      bucket, path = bucket_and_key_name(glob)
+      options = Hash.new
+      options["prefix"] = path unless path.blank?
+      bucket.keys(options).map(&:full_name)
+    end
+
+    def get(s3_object, dest=nil)
+      bucket, keyname = bucket_and_key_name(s3_object)
+      if dest.nil? then
+        bucket.get(keyname)
+      else
+        dest.write(bucket.get(keyname))
+      end
+    end
+
+    def head(s3_object)
+      bucket, keyname = bucket_and_key_name(s3_object)
+      key = bucket.key(keyname, true)
+      headers = key.headers
+      puts headers.merge(key.meta_headers).to_yaml
+    end
+
+    def put(source, s3_object)
+      bucket, keyname = bucket_and_key_name(s3_object)
+      bucket.put(keyname, source)
+    end
+
+    def rm(s3_object)
+      bucket, keyname = bucket_and_key_name(s3_object)
+      bucket.key(keyname).delete
+    end
+
+    protected
+    def bucket_and_key_name(full_name)
+      bucket_name, path = full_name.split("/", 2)
+      bucket = @s3.bucket(bucket_name, false)
+      [bucket, path]
+    end
+  end
+end

data/lib/cliaws/version.rb

@@ -0,0 +1,9 @@
+module Cliaws #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/cliaws.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "cliaws/s3"
+
+module Cliaws
+  def self.access_key_id
+    ENV["AWS_ACCESS_KEY_ID"]
+  end
+
+  def self.secret_access_key
+    ENV["AWS_SECRET_ACCESS_KEY"]
+  end
+
+  def self.s3
+    @@s3 ||= Cliaws::S3.new(access_key_id, secret_access_key)
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/cliaws.rb'}"
+puts "Loading cliaws gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/cliaws/version.rb'
+
+version  = Cliaws::VERSION::STRING
+download = 'http://rubyforge.org/projects/cliaws'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)