qoobaa-s3 0.0.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jakub Kuźma, Mirosław Boruta
+
+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/README.rdoc

@@ -0,0 +1,7 @@
+= s3
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Jakub Kuźma. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "s3"
+    gem.summary = %Q{Library for accessing S3 objects and buckets, with command line tool}
+    gem.email = "qoobaa@gmail.com"
+    gem.homepage = "http://github.com/qoobaa/s3"
+    gem.authors = ["Jakub Kuźma", "Mirosław Boruta"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "s3 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/bin/s3cmd.rb

@@ -0,0 +1,188 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require "trollop"
+require "s3"
+
+# HELPER METHODS
+
+include S3
+
+def list_buckets(service)
+  service.buckets.each do |bucket|
+    puts bucket.name
+  end
+end
+
+def create_bucket(service, name, location)
+  service.buckets.build(name).save(location)
+end
+
+def destroy_bucket(service, name)
+  service.buckets.find(name).destroy
+end
+
+def show_bucket(service, name, options = {})
+  service.buckets.find(name).objects.find_all.each do |object|
+    puts "#{name}/#{object.key}"
+  end
+end
+
+def list_objects(service)
+  service.buckets.each do |bucket|
+    bucket.objects.each do |object|
+      puts "#{bucket.name}/#{object.key}"
+    end
+  end
+end
+
+def create_object(service, name, file_name, options = {})
+  bucket_name, object_name = name.split("/", 2)
+  object = service.buckets.find(bucket_name).objects.build(object_name)
+  object.content_type = options[:type]
+  object.content_encoding = options[:encoding]
+  object.content_disposition = options[:disposition]
+  object.acl = options[:acl]
+  object.content = File.new(file_name)
+  object.save
+end
+
+def destroy_object(service, name)
+  bucket_name, object_name = name.split("/", 2)
+  object = service.buckets.find(bucket_name).objects.find(object_name)
+  object.destroy
+end
+
+def show_object(service, name, file_name = nil)
+  bucket_name, object_name = name.split("/", 2)
+  object = service.buckets.find(bucket_name).objects.find_first(object_name)
+  puts "         object:   #{object.name}/#{object.key}"
+  puts "   content type:   #{object.content_type}"
+  puts "           size:   #{object.size}"
+  puts "           etag:   #{object.etag}"
+  puts "  last modified:   #{object.last_modified}"
+  # puts "content disposition: #{object.content_disposition}"
+  if file_name
+    if file_name == "-"
+      puts object.content
+    else
+      File.open(file_name, "wb") do |file|
+        file.write(object.content)
+      end
+    end
+  end
+end
+
+# COMMAND LINE PARSER
+
+ACCESS_KEY_ID = ENV["ACCESS_KEY_ID"]
+SECRET_ACCESS_KEY = ENV["SECRET_ACCESS_KEY"]
+COMMANDS = %w(bucket object)
+BUCKET_SUBCOMMANDS = %w(add remove show)
+OBJECT_SUBCOMMANDS = %w(add remove show)
+
+global_options = Trollop::options do
+  banner "s3.rb"
+  opt :access_key_id, "Your access key id to AWS", :type => :string, :default => ACCESS_KEY_ID
+  opt :secret_access_key, "Your secret access key to AWS", :type => :string, :default => SECRET_ACCESS_KEY
+  opt :debug, "Debug mode", :type => :flag, :default => false
+  stop_on COMMANDS
+end
+
+Trollop::die "No access key id given" unless global_options[:access_key_id]
+Trollop::die "No secret access key given" unless global_options[:secret_access_key]
+
+service = Service.new(:access_key_id => global_options[:access_key_id],
+                      :secret_access_key => global_options[:secret_access_key],
+                      :debug => global_options[:debug])
+
+command = ARGV.shift
+
+begin
+  case command
+  when "bucket"
+    command_options = Trollop::options do
+      banner "manage buckets"
+      stop_on BUCKET_SUBCOMMANDS
+    end
+    subcommand = ARGV.shift
+    case subcommand
+    when "add"
+      subcommand_options = Trollop::options do
+        banner "add bucket"
+        opt :location, "Location of the bucket - EU or US", :default => "US", :type => :string
+      end
+      name = ARGV.shift
+      Trollop::die "Bucket has not been added because of unknown error" unless create_bucket(service, name, subcommand_options[:location])
+    when "remove"
+      subcommand_options = Trollop::options do
+        banner "remove bucket"
+      end
+      name = ARGV.shift
+      Trollop::die "Bucket name must be given" if name.nil? or name.empty?
+      Trollop::die "Bucket has not been removed because of unknown error" unless destroy_bucket(service, name)
+    when "show"
+      subcommand_options = Trollop::options do
+        banner "show bucket"
+        opt :prefix, "Limits the response to keys which begin with the indicated prefix", :type => :string
+        opt :marker, "Indicates where in the bucket to begin listing", :type => :string
+        opt :max_keys, "The maximum number of keys you'd like to see", :type => :integer
+        opt :delimiter, "Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element", :type => :string
+      end
+      name = ARGV.shift
+      Trollop::die "Bucket name must be given" if name.nil? or name.empty?
+      show_bucket(service, name, subcommand_options)
+    when nil
+      list_buckets(service)
+    else
+      Trollop::die "Unknown subcommand: #{subcommand.inspect}"
+    end
+  when "object"
+    command_options = Trollop::options do
+      banner "manage objects"
+      stop_on OBJECT_SUBCOMMANDS
+    end
+    subcommand = ARGV.shift
+    case subcommand
+    when "add"
+      subcommand_options = Trollop::options do
+        banner "object add s3_object_name local_file_name"
+        opt :type, "A standard MIME type describing the format of the contents", :default => "binary/octet-stream"
+        opt :disposition, "Specifies presentational information for the object", :type => :string
+        opt :encoding, "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type header field", :type => :string
+        opt :acl, "The canned ACL to apply to the object. Options include private, public-read, public-read-write, and authenticated-read", :type => :string
+      end
+      name = ARGV.shift
+      Trollop::die "No object name given" if name.nil? or name.empty?
+      file_name = ARGV.shift
+      Trollop::die "No file name given" if file_name.nil? or file_name.empty?
+      Trollop::die "Object has not been added because of unknown error" unless create_object(service, name, file_name, subcommand_options)
+    when "remove"
+      subcommand_options = Trollop::options do
+        banner "object remove s3_object_name"
+      end
+      name = ARGV.shift
+      Trollop::die "No object name given" if name.nil? or name.empty?
+      Trollop::die "Object has not been removed because of unknown error" unless destroy_object(service, name)
+    when "show"
+      subcommand_options = Trollop::options do
+        banner "object show s3_object_name optional_file_name"
+      end
+      name = ARGV.shift
+      Trollop::die "No object name given" if name.nil? or name.empty?
+      file_name = ARGV.shift
+      show_object(service, name, file_name)
+    when nil
+      list_objects(service)
+    else
+      Trollop::die "Unknown subcommand: #{subcommand.inspect}"
+    end
+  when nil
+    Trollop::die "No command given"
+  else
+    Trollop::die "Unknown command #{command.inspect}"
+  end
+rescue Error::ResponseError => e
+  Trollop::die e.message.sub(/\.+\Z/, "")
+end

data/lib/s3.rb

@@ -0,0 +1,23 @@
+require "time"
+require "openssl"
+require "net/http"
+require "net/https"
+require "base64"
+require "forwardable"
+require "digest/md5"
+
+require "xmlsimple"
+
+require "s3/roxy/proxy"
+require "s3/roxy/moxie"
+
+require "s3/bucket"
+require "s3/connection"
+require "s3/exceptions"
+require "s3/object"
+require "s3/service"
+require "s3/signature"
+
+module S3
+  HOST = "s3.amazonaws.com"
+end

data/lib/s3/bucket.rb

@@ -0,0 +1,154 @@
+module S3
+  class Bucket
+    extend Roxy::Moxie
+    extend Forwardable
+
+    attr_reader :name, :service
+
+    def_instance_delegators :service, :service_request
+
+    def retrieve
+      bucket_request(:get, :params => { :max_keys => 0 })
+      self
+    end
+
+    def location(reload = false)
+      if reload or @location.nil?
+        response = bucket_request(:get, :params => { :location => nil })
+        @location = parse_location(response.body)
+      else
+        @location
+      end
+    end
+
+    def ==(other)
+      self.name == other.name and self.service == other.service
+    end
+
+    def exists?
+      retrieve
+      true
+    rescue Error::NoSuchBucket
+      false
+    end
+
+    def destroy
+      bucket_request(:delete)
+      true
+    end
+
+    def save(location = nil)
+      location = location.to_s.upcase if location
+      options = { :headers => {} }
+      if location and location != "US"
+        options[:body] = "<CreateBucketConfiguration><LocationConstraint>#{location}</LocationConstraint></CreateBucketConfiguration>"
+        options[:headers][:content_type] = "application/xml"
+      end
+      bucket_request(:put, options)
+      true
+    end
+
+    def vhost?
+      "#@name.#{HOST}" =~ /\A#{URI::REGEXP::PATTERN::HOSTNAME}\Z/
+    end
+
+    def host
+      vhost? ? "#@name.#{HOST}" : "#{HOST}"
+    end
+
+    def path_prefix
+      vhost? ? "" : "#@name/"
+    end
+
+    def objects(reload = false, options = {})
+      if options.empty?
+        if reload or @objects.nil?
+          @objects = fetch_objects
+        else
+          @objects
+        end
+      else
+        fetch_objects(options)
+      end
+    end
+
+    proxy :objects do
+      def build(key)
+        Object.new(proxy_owner, key)
+      end
+
+      def find_first(name)
+        object = build(name)
+        object.retrieve
+      end
+      alias :find :find_first
+
+      def find_all(options = {})
+        proxy_owner.objects(true, options)
+      end
+
+      def reload
+        proxy_owner.objects(true)
+      end
+
+      def destroy_all
+        proxy_target.each do |object|
+          object.destroy
+        end
+      end
+    end
+
+    def inspect
+      "#<#{self.class}:#{name}>"
+    end
+
+    def initialize(service, name)
+      self.service = service
+      self.name = name
+    end
+
+    private
+
+    attr_writer :service
+
+    def name=(name)
+      raise ArgumentError.new("Invalid bucket name: #{name}") unless name_valid?(name)
+      @name = name
+    end
+
+    def bucket_request(method, options = {})
+      path = "#{path_prefix}#{options[:path]}"
+      service_request(method, options.merge(:host => host, :path => path))
+    end
+
+    def fetch_objects(options = {})
+      response = bucket_request(:get, options)
+      parse_objects(response.body)
+    end
+
+    def parse_objects(xml_body)
+      xml = XmlSimple.xml_in(xml_body)
+      objects_attributes = xml["Contents"]
+      if objects_attributes
+        objects_attributes.map do |object_attributes|
+          Object.new(self,
+                     object_attributes["Key"].first,
+                     :etag => object_attributes["ETag"].first,
+                     :last_modified => object_attributes["LastModified"].first,
+                     :size => object_attributes["Size"].first)
+        end
+      else
+        []
+      end
+    end
+
+    def parse_location(xml_body)
+      xml = XmlSimple.xml_in(xml_body)
+      xml["content"]
+    end
+
+    def name_valid?(name)
+      name =~ /\A[a-z0-9][a-z0-9\._-]{2,254}\Z/ and @name !~ /\A#{URI::REGEXP::PATTERN::IPV4ADDR}\Z/
+    end
+  end
+end