laws 0.0.11

data/bin/laws

@@ -0,0 +1,388 @@
+#!/usr/bin/env ruby
+require 'cri'
+require 'awes/aws_utils'
+
+include AWSAccess
+
+#TODO swap back out
+#DefaultPaths = %w(aws.yml ~/.aws.yml)
+DefaultPaths = ["#{ENV['HOME']}/.aws.yml"] 
+def configure_user(opts)
+  aws_id = opts[:id]
+  aws_key = opts[:key]
+  config_path = opts[:config]
+
+  if config_path && (aws_id || aws_key)
+    puts 'Received both a path to a config file and command-line credentials.'
+    puts 'Please use either --config or the credential arguments.'
+    exit 1
+  end
+
+  if aws_id || aws_key
+    unless aws_id
+      puts 'Please provide an id with your key.'
+      puts 'Try awes -h for more information.'
+      exit 1
+    end
+    unless aws_key
+      puts 'Please provide a key with your id.'
+      puts 'Try awes -h for more information.'
+      exit 1
+    end
+    configure_aws(aws_id, aws_key)
+    return
+  end
+    
+  if config_path
+    exit 1 unless load_config_file(config_path)
+    return true
+  end
+  DefaultPaths.each do |p|
+    if File.exists?(p)
+      exit 1 unless load_config_file(p)
+      return true
+    end
+  end
+  puts "Unable to locate an AWS config file. Exiting."
+  exit 1
+end
+
+s3_cmd = Cri::Command.define do
+  #fig
+  name  's3'
+  usage 's3 <subcommand> [options] <arguments>'
+  summary 'provides command line tools for manipulating Amazon\'s S3 service'
+  description 'Provides several commands for interacting with s3; allows ' +
+    'creation, deletion, and listing of buckets, as well as uploading and' +
+    'downloading of objects.'
+
+end
+
+s3_create_cmd = Cri::Command.define do
+  name 'create'
+  usage 'create <bucket_name>'
+  summary 'creates the named bucket in s3'
+  description 'creates a bucket with the provided name in s3, given the' +
+    'bucket doesn\'t already exist.'
+
+  run do |opts, args, cmd|
+    bucket_name = args.shift
+    unless bucket_name
+      puts "create requires a bucket name."
+      puts "try awes s3 create -h for more information"
+      exit 1
+    end
+    unless args.empty?
+      puts "too many arguments to create."
+      puts "try awes s3 create -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    s3_create_bucket(bucket_name)
+  end
+end
+s3_cmd.add_command s3_create_cmd
+
+s3_list_cmd = Cri::Command.define do
+  name 'list'
+  usage 'list <bucket_name>'
+  summary 'lists the contents of the given bucket'
+  description 'outsputs the key of each object in the given bucket'
+
+  run do |opts, args, cmd|
+    bucket_name = args.shift
+    unless bucket_name
+      puts 'list requires a bucket name.'
+      puts 'Try awes s3 list -h for more information'
+      exit 1
+    end
+    unless args.empty?
+      puts "too many arguments to list."
+      puts "try awes s3 list -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    s3_list_contents(bucket_name)
+  end
+end
+s3_cmd.add_command s3_list_cmd
+
+s3_buckets_cmd = Cri::Command.define do
+  name 'buckets'
+  usage 'buckets'
+  summary 'lists all available buckets in s3'
+  description 'lists all readable buckets for the loaded account in S3'
+
+  run do |opts, args, cmd|
+    unless args.empty?
+      puts "too many arguments to buckets."
+      puts "try awes s3 buckets -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    s3_list_buckets
+  end
+end
+s3_cmd.add_command s3_buckets_cmd
+
+s3_exists_cmd = Cri::Command.define do
+  name 'exists'
+  usage 'exists <bucket_name> [object_key]'
+  summary 'Checks if a bucket or object exists in s3'
+  description 'Checks the existence of the given bucket, and, if provided' +
+    ' the given object'
+
+  run do |opts, args, cmd|
+    bucket_name, object_key = args.shift, args.shift
+    unless bucket_name
+      puts 'Exists requires a bucket name.'
+      exit 1
+    end
+    unless args.empty?
+      puts "too many arguments to exists."
+      puts "try awes s3 exists -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    puts s3_exists?(bucket_name, object_key)
+  end
+end
+s3_cmd.add_command s3_exists_cmd
+
+s3_upload_cmd = Cri::Command.define do
+  name 'upload'
+  usage 'upload [options] <bucket_name> <file_path>'
+  summary 'uploads a file to an s3 bucket'
+  description 'Uploads the given file to the named s3 bucket. If object-key' + 
+    ' is provided, uploads it under that name, otherwise the name is the same' +
+    ' as the base filepath.'
+
+  option :k, ':key', 'object key to upload the file under', :argument => :required
+  flag :c, :create, 'create bucket if it doesn\'t exist.'
+
+  run do |opts, args, cmd|
+    bucket_name, file_path = args.shift, args.shift
+    unless bucket_name
+      puts 'upload requires a bucket name.'
+      exit 1
+    end
+    unless file_path
+      puts 'upload requires a filepath.'
+      exit 1
+    end
+    unless args.empty?
+      puts "too many arguments to upload."
+      puts "try awes s3 upload -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    s3_upload_object(bucket_name, file_path, opts[:key], opts[:create])
+  end
+end
+s3_cmd.add_command s3_upload_cmd
+
+s3_download_cmd = Cri::Command.define do
+  name 'download'
+  usage 'download [options] <bucket_name> <object_key>'
+  summary 'downloads an object from s3'
+  description 'Downloads the object with the provided key from the named' + 
+    ' bucket. If a filepath is provided, saves it with that name. Otherwise ' +
+    'saves with the object-key as the filename'
+
+  option :f, :filename, 'filename to save the object under', :argument => :required
+
+  run do |opts, args, cmd|
+    bucket_name, obj_key = args.shift, args.shift
+    unless bucket_name
+      puts 'download requires a bucket name'
+      exit 1
+    end
+    unless obj_key
+      puts 'download requires an object key'
+      exit 1
+    end
+    unless args.empty?
+      puts "too many arguments to download."
+      puts "try awes s3 download -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    s3_download_object(bucket_name, obj_key, opts[:filename])
+  end
+end
+s3_cmd.add_command s3_download_cmd
+
+s3_delete_cmd = Cri::Command.define do
+  name 'delete'
+  usage 'delete <bucket_name> <object_key>'
+  summary 'deletes a bucket or object from s3'
+  description 'If an object key is provided, deletes that object from the ' +
+    'named bucket. Otherwise deletes the entire bucket.'
+  
+  run do |opts, args, cmd|
+    bucket_name, obj_key = args.shift, args.shift
+    unless bucket_name
+      puts 'delete requires a bucket name'
+      exit 1
+    end
+    unless args.empty?
+      puts "too many arguments to delete."
+      puts "try awes s3 delete -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    s3_delete(bucket_name, obj_key)
+  end
+end
+s3_cmd.add_command s3_delete_cmd
+
+sdb_cmd = Cri::Command.define do
+  name 'sdb'
+  usage 'sdb <subcommand> [options] <arguments>'
+  summary 'provides command line tools for manipulating Amazon\'s SimpleDB service'
+  description 'Provides several commands for interacting with SimpleDB; allows ' +
+    'creation, deletion, and listing of domains, as well as inserting and querying ' +
+    'records.'
+end
+
+sdb_domains_cmd = Cri::Command.define do
+  name 'domains'
+  usage 'domains'
+  summary 'lists all readable domains for the loaded user'
+  description 'prints one domain name per line'
+
+  run do |opts, args, cmd|
+    unless args.empty?
+      puts "too many arguments to domains."
+      puts "try awes sdb domains -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    sdb_list_domains
+  end
+end
+
+sdb_cmd.add_command sdb_domains_cmd
+
+sdb_select_cmd = Cri::Command.define do
+  name 'select'
+  usage 'select <domain> [options]'
+  summary 'selects records from a domain'
+  description 'Selects an optional subset of attributes from the given domain' +
+    ' matching an optional query.'
+  
+  option :a, :attributes, 'list of attributes to select: attr1[attr2,...]',
+    :argument => :required
+  option :w, :where, 'where clause for select. escape in quotations to avoid ' +
+    'conflicting with BASH syntax.', :argument => :required
+
+  run do |opts, args, cmd|
+    domain = args.shift
+    unless domain
+      puts 'select requires a domain'
+      exit 1
+    end
+    unless args.empty?
+      puts "too many arguments to select."
+      puts "try awes sdb select -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    attributes = opts[:attributes] || []
+    sdb_print_items(domain, attributes, opts[:where])
+  end
+end
+sdb_cmd.add_command sdb_select_cmd
+
+sdb_insert_cmd = Cri::Command.define do
+  name 'insert'
+  usage 'insert <key> <domain> <attributes>'
+  summary 'inserts data into SimpleDB'
+  description 'Inserts a list of attributes into a SimpleDB domain with the ' +
+    'given key. Note that at least one attribute=value pair must be present' +
+    ' in the list, or SimpleDB won\'t persist the item.'
+
+  run do |opts, args, cmd|
+    attr_list = args.shift
+    unless attr_list
+      puts 'insert requires at least one attribute pair.'
+      exit 1
+    end
+    attr_vals = {}
+    attr_list.split(',').each do |assignment|
+      s = assignment.split('=')
+      attr_vals[s[0]] = s[1]
+    end
+    if attr_vals.empty?
+      puts "Unable to collect attributes from \"#{attr_list}\"."
+      exit 1
+    end
+
+    key, domain = args.shift, args.shift
+    unless key
+      puts 'insert requires a key'
+      exit 1
+    end
+    unless domain
+      puts 'insert requires a domain'
+      exit 1
+    end
+    unless args.empty?
+      puts "too many arguments to insert."
+      puts "try awes sdb insert -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    sdb_insert(domain, key, attr_vals)
+  end
+end
+sdb_cmd.add_command sdb_insert_cmd
+
+sdb_delete_cmd = Cri::Command.define do
+  name 'delete'
+  usage 'delete [key] <domain>'
+  summary 'delete a domain or record from SimpleDB'
+  description 'Deletes the row with the given key from the given SimpleDB' +
+    ' domain. If no key is provided, deletes the domain'
+
+  run do |opts, args, cmd|
+    domain, key = args.pop, args.pop
+    unless domain
+      puts 'delete requires a domain'
+      exit 1
+    end
+    unless args.empty?
+      puts "too many arguments to delete."
+      puts "try awes sdb delete -h for more information"
+      exit 1
+    end
+    configure_user(opts)
+    sdb_delete(domain, key)
+  end
+end
+sdb_cmd.add_command sdb_delete_cmd
+
+run_cmd = Cri::Command.define do
+  name 'awes'
+  usage 'awes <command>'
+  summary 'A CLI tool for interacting with Amazon Web Services'
+  description 'Support command-line interaction with both S3 and SimpleDB.'
+
+  flag :h, :help, 'show help for this command' do |value, cmd|
+    puts cmd.help
+    exit 0
+  end
+
+  option :c, :config, 'location of YAML config file for AWS keys', :argument => :required
+  option :i, :id, 'specify aws id on command line', :argument => :required
+  option :s, :secret, 'specifify aws secret key on command line', :argument => :required
+end
+
+#handling exceptions between here and s3
+#handle extra/missing args (just print help and exit)
+#usage examples?
+
+run_cmd.add_command sdb_cmd
+run_cmd.add_command s3_cmd
+
+run_cmd.run(ARGV)

data/lib/laws/aws_utils.rb

@@ -0,0 +1,194 @@
+#!/user/bin/env ruby
+
+require 'yaml'
+require 'aws-sdk'
+
+module AWSAccess
+
+  def configure_aws(key, id)
+    AWS.config(:access_key_id => key,
+      :secret_access_key => id)
+  end
+
+  def load_config_file(file_name)
+    unless File.exist?(file_name)
+      puts "Unable to locate config file #{file_name}."
+      return false
+    end
+    config = YAML.load_file(file_name)
+    configure_aws(config["aws_id"], config["aws_key"])
+    true
+  end
+
+###################SimpleDB logic ###############################
+  #TODO rescue query exceptions and print a better error
+  def sdb_print_items(domain_name, attributes = [], where_clause = nil)
+    db = AWS::SimpleDB.new
+    dom = db.domains[domain_name]
+    unless dom.exists?
+      puts "Unable to locate domain #{domain_name}."
+      return false
+    end
+
+    items = dom.items.select(attributes)
+    items = items.where(where_clause) unless where_clause.nil?
+
+    items.each do |i|
+      print i.name
+      print_attributes = attributes.empty? ? i.attributes.keys : attributes
+      print_attributes.each do |a|
+        print ",#{a}=#{i.attributes[a]}"
+      end
+      print "\n"
+    end
+    true
+  end
+
+  def sdb_list_domains
+    AWS::SimpleDB.new.domains.each {|d| puts d.name}
+  end
+
+  def sdb_create_domain(name)
+    db = AWS::SimpleDB.new
+    if db.domains[name].exists?
+      puts "Domain #{name} already exists in SimpleDB."
+      return false
+    end
+
+    db.domains.create(name)
+    true
+  end
+
+  def sdb_insert(domain_name, key, attributes)
+    db = AWS::SimpleDB.new
+    dom = db.domains[domain_name]
+    unless dom.exists?
+      puts "Unable to locate domain #{domain_name}."
+      return false
+    end
+
+    new_item = dom.items[key]
+    attributes.each do |k, v|
+      new_item.attributes[k] = v
+    end
+    true
+  end
+
+  def sdb_delete(domain_name, item_key = nil)
+    db = AWS::SimpleDB.new
+    dom = db.domains[domain_name]
+    unless dom.exists?
+      puts "Unable to locate domain #{domain_name}."
+      return false
+    end
+
+    if item_key.nil?
+      dom.delete! #TODO consider adding force support
+    else
+      item = dom.items[item_key]
+      item.delete
+    end
+  end
+
+###################S3 Logic#################################
+
+  def s3_list_buckets
+    AWS::S3.new.buckets.each {|b| puts b.name}
+  end
+
+  #TODO show more than just the item name
+  def s3_list_contents(bucket_name)
+    bucket = AWS::S3.new.buckets[bucket_name]
+    unless bucket.exists?
+      puts "Unable to locate bucket #{bucket_name}."
+      return false
+    end
+
+    bucket.objects.each do |o|
+      puts o.key
+    end
+    true
+  end
+
+  def s3_create_bucket(name)
+    s3 = AWS::S3.new
+    if s3.buckets[name].exists?
+      puts "Bucket #{name} already exists in S3."
+      return false
+    end
+    s3.buckets.create(name)
+    true
+  end
+
+  def s3_exists?(bucket_name, s3_key = nil)
+    bucket = AWS::S3.new.buckets[bucket_name]
+    unless bucket.exists?
+      puts "Unable to locate bucket #{bucket_name}."
+      return false
+    end
+
+    if s3_key.nil?
+      true
+    else
+      bucket[s3_key].exists?
+    end
+  end
+
+  def s3_upload_object(bucket_name, filepath, s3_key = nil, create_bucket = false)
+    s3_key ||= File.basename(filepath)
+    unless File.exists?(filepath)
+      puts "Unable to locate file at #{filepath}."
+      return false
+    end
+
+    s3 = AWS::S3.new
+    bucket = s3.buckets[bucket_name]
+    unless bucket.exists?
+      if create_bucket
+        s3.buckets.create(bucket_name)
+      else
+        puts "Unable to locate bucket #{bucket_name}."
+        return false
+      end
+    end
+
+    bucket.objects[s3_key].write(File.open(filepath){|f| f.read})
+  end
+
+  def s3_download_object(bucket_name, s3_key, filepath = nil)
+    filepath ||= "./#{s3_key}"
+    bucket = AWS::S3.new.buckets[bucket_name]
+    unless bucket.exists?
+      puts "Unable to locate bucket #{bucket_name}."
+      return false
+    end
+
+    obj = bucket.objects[s3_key]
+    unless obj.exists?
+      puts "Unable to locate item #{s3_key} in bucket #{bucket_name}."
+      return false
+    end
+
+    File.open(filepath, 'w') {|f| f.write(obj.read)}
+  end
+
+  def s3_delete(bucket_name, obj_key = nil)
+    bucket = AWS::S3.new.buckets[bucket_name]
+    unless bucket.exists?
+      puts "Unable to locate bucket #{bucket_name}."
+      return false
+    end
+
+    if obj_key.nil?
+      bucket.delete! #TODO consider adding force support
+    else
+      obj = bucket.objects[obj_key]
+      unless obj.exists?
+        puts "Unable to locate item #{obj_key} in bucket #{bucket_name}"
+        return false
+      end
+      obj.delete
+    end
+  end
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: laws
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 11
+  version: 0.0.11
+platform: ruby
+authors: 
+- Brian Fults
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aws-sdk
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 4
+        version: 1.5.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id002
+description: A CLI for interfacing with S3 and SimpleDB using the sdk.
+email: xclite@gmail.com
+executables: 
+- laws
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/laws/aws_utils.rb
+- bin/laws
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: CLI for managing Amazon Web Services
+test_files: []
+