s4 0.0.1

data/Rakefile

@@ -0,0 +1,5 @@
+task :default => :test
+
+task :test do
+  system "cutest test/*.rb"
+end

data/lib/s4.rb

@@ -0,0 +1,144 @@
+require "net/http/persistent"
+require "rexml/document"
+require "base64"
+require "time"
+
+# Simpler AWS S3 library
+class S4
+  VERSION = "0.0.1"
+
+  # sub-resource names which may appear in the query string and also must be
+  # signed against.
+  SubResources = %w( acl location logging notification partNumber policy requestPayment torrent uploadId uploads versionId versioning versions website )
+
+  # Header over-rides which may appear in the query string and also must be
+  # signed against.
+  HeaderValues = %w( response-content-type response-content-language response-expires reponse-cache-control response-content-disposition response-content-encoding )
+
+  attr_reader :connection, :access_key_id, :secret_access_key, :bucket, :host
+
+  def initialize(s3_url = ENV["S3_URL"])
+    raise ArgumentError, "No S3 URL provided. You can set ENV['S3_URL'], too." if s3_url.nil? || s3_url.empty?
+
+    begin
+      url = URI(s3_url)
+    rescue URI::InvalidURIError => e
+      e.message << " The format is s3://access_key_id:secret_access_key@s3.amazonaws.com/bucket"
+      raise e
+    end
+
+    @access_key_id     = url.user
+    @secret_access_key = URI.unescape(url.password || "")
+    @host              = url.host
+    @bucket            = url.path[1..-1]
+  end
+
+  def connection
+    @connection ||= Net::HTTP::Persistent.new("aws-s3/#{bucket}")
+  end
+
+  # Lower level object get which just yields the successful S3 response to the
+  # block. See #download if you want to simply copy a file from S3 to local.
+  def get(name, &block)
+    request(uri(name), &block)
+  end
+
+  # Download the file with the given filename to the given destination.
+  def download(name, destination=nil)
+    get(name) do |response|
+      File.open(destination || File.join(Dir.pwd, File.basename(name)), "wb") do |io|
+        response.read_body do |chunk|
+          io.write(chunk)
+        end
+      end
+    end
+  end
+
+  # Delete the object with the given name.
+  def delete(name)
+    request(uri = uri(name), Net::HTTP::Delete.new(uri.request_uri))
+  end
+
+  # Upload the file with the given filename to the given destination in your
+  # S3 bucket. If no destination is given then uploads it with the same
+  # filename to the root of your bucket.
+  def upload(name, destination=nil)
+    put File.open(name, "rb"), destination || File.basename(name)
+  end
+
+  def put(io, name)
+    uri = uri(name)
+    req = Net::HTTP::Put.new(uri.request_uri)
+
+    req.body_stream = io
+    req.add_field "Content-Length", io.size
+    req.add_field "Content-Type", "application/x-www-form-urlencoded"
+
+    request(URI::HTTP.build(host: host, path: "/#{bucket}/#{name}"), req)
+  end
+
+  # List bucket contents
+  def list(prefix = "")
+    REXML::Document.new(request(uri("", query: "prefix=#{prefix}"))).elements.collect("//Key", &:text)
+  end
+
+  private
+
+  def uri(path, options={})
+    URI::HTTP.build(options.merge(host: host, path: "/#{bucket}/#{CGI.escape(path.sub(/^\//, ""))}"))
+  end
+
+  # Makes a request to the S3 API.
+  def request(uri, request = nil)
+    # TODO: Possibly use SAX parsing for large request bodies (?)
+
+    request ||= Net::HTTP::Get.new(uri.request_uri)
+
+    connection.request(uri, sign(uri, request)) do |response|
+      case response
+        when Net::HTTPNotFound
+          return nil
+
+        when Net::HTTPSuccess
+          if block_given?
+            yield(response)
+          else
+            return response.body
+          end
+
+        else
+          raise Error.from_xml(response.body)
+
+      end
+    end
+  end
+
+  def sign(uri, request)
+    date = Time.now.utc.rfc822
+
+    request.add_field "Date", date
+    request.add_field "Authorization", "AWS #{access_key_id}:#{signature(uri, request)}"
+
+    request
+  end
+
+  def signature(uri, request)
+    Base64.encode64(
+      OpenSSL::HMAC.digest(
+        OpenSSL::Digest::Digest.new("sha1"),
+        secret_access_key,
+        "#{request.class::METHOD}\n\n#{request["Content-Type"]}\n#{request.fetch("Date")}\n#{uri.path}"
+      )
+    ).chomp
+  end
+
+  # Base class of all S3 Errors
+  class Error < ::RuntimeError
+    def self.from_xml(xml)
+      doc = REXML::Document.new(xml).elements["//Error"]
+      code = doc.elements["Code"].text
+      message = doc.elements["Message"].text
+      new("#{code}: #{message}")
+    end
+  end
+end

data/s4.gemspec

@@ -0,0 +1,25 @@
+require "./lib/s4"
+
+Gem::Specification.new do |s|
+  s.name              = "s4"
+  s.version           = S4::VERSION
+  s.summary           = "Simple API for AWS S3"
+  s.description       = "Simple API for AWS S3"
+  s.authors           = ["Ben Alavi"]
+  s.email             = ["ben.alavi@citrusbyte.com"]
+  s.homepage          = "http://github.com/benalavi/s4"
+
+  s.files = Dir[
+    "LICENSE",
+    "README.markdown",
+    "Rakefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/**/*.rb"
+  ]
+
+  s.add_dependency "net-http-persistent", "~> 1.7"
+
+  s.add_development_dependency "cutest"
+  s.add_development_dependency "timecop", "~> 0.3"
+end

data/test/s3_test.rb

@@ -0,0 +1,108 @@
+require "cutest"
+require "timecop"
+require "fileutils"
+
+begin
+  require "ruby-debug"
+rescue LoadError
+end
+
+require File.expand_path("../lib/s3", File.dirname(__FILE__))
+
+def fixture(filename="")
+  File.join(File.dirname(__FILE__), "fixtures", filename)
+end
+
+def output(filename="")
+  File.join(File.dirname(__FILE__), "output", filename)
+end
+
+Bucket = URI(ENV["S3_URL"]).path[1..-1]
+
+scope do
+  setup do
+    FileUtils.rm_rf(output)
+    FileUtils.mkdir_p(output)
+    @s3 = S3.new
+  end
+
+  test "should download foo.txt" do
+    `s3cmd put #{fixture("foo.txt")} s3://#{Bucket}/foo.txt`
+    @s3.download("foo.txt", output("foo.txt"))
+
+    assert_equal "abc123", File.read(output("foo.txt"))
+  end
+
+  test "should not download non-existent files" do
+    `s3cmd del 's3://#{Bucket}/foo.txt'`
+    @s3.download("foo.txt", output("foo.txt"))
+
+    assert !File.exists?(output("foo.txt"))
+  end
+
+  test "should yield raw response from get of foo.txt" do
+    `s3cmd put #{fixture("foo.txt")} s3://#{Bucket}/foo.txt`
+
+    @s3.get("foo.txt") do |response|
+      assert_equal "abc123", response.body
+    end
+  end
+
+  test "should delete object" do
+    `s3cmd put #{fixture("foo.txt")} s3://#{Bucket}/foo.txt`
+    @s3.get("foo.txt") { |response| assert_equal "abc123", response.body }
+    @s3.delete("foo.txt")
+
+    assert_equal nil, @s3.get("foo.txt")
+  end
+
+  test "should return list of items in bucket" do
+    `s3cmd del 's3://#{Bucket}/abc/*'`
+    `s3cmd del 's3://#{Bucket}/boom.txt'`
+    `s3cmd del 's3://#{Bucket}/foo\ bar+baz.txt'`
+    `s3cmd put #{fixture("foo.txt")} s3://#{Bucket}/foo.txt`
+    `s3cmd put #{fixture("foo.txt")} s3://#{Bucket}/bar.txt`
+    `s3cmd put #{fixture("foo.txt")} s3://#{Bucket}/baz.txt`
+
+    assert_equal %w( bar.txt baz.txt foo.txt ), @s3.list
+  end
+
+  test "should return list of keys starting with prefix" do
+    `s3cmd put #{fixture("foo.txt")} s3://#{Bucket}/abc/bing.txt`
+    `s3cmd put #{fixture("foo.txt")} s3://#{Bucket}/abc/bang.txt`
+    `s3cmd put #{fixture("foo.txt")} s3://#{Bucket}/boom.txt`
+
+    assert_equal %w( abc/bang.txt abc/bing.txt ), @s3.list("abc/")
+  end
+
+  test "should get content with special chars in it" do
+    `s3cmd put #{fixture("foo.txt")} 's3://#{Bucket}/foo bar+baz.txt'`
+
+    @s3.get("foo bar+baz.txt") { |response| assert_equal "abc123", response.body }
+  end
+
+  test "should upload foo.txt" do
+    `s3cmd del 's3://#{Bucket}/foo.txt'`
+
+    s3 = S3.new
+
+    s3.upload(fixture("foo.txt"))
+
+    s3.get("foo.txt") { |response| assert_equal "abc123", response.body }
+  end
+
+  test "barks when no URL is provided" do
+    assert_raise(ArgumentError) { S3.new("") }
+    assert_raise(ArgumentError) { S3.new(nil) }
+
+    assert_raise(URI::InvalidURIError) { S3.new("s3://foo:bar/baz") }
+  end
+
+  test "raises on S3 errors" do
+    s3 = S3.new(ENV["S3_URL"].sub(/.@/, "@")) # Break the password
+
+    assert_raise(S3::Error) do
+      s3.upload(fixture("foo.txt"))
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: s4
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Alavi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-20 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-http-persistent
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.7"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cutest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.3"
+  type: :development
+  version_requirements: *id003
+description: Simple API for AWS S3
+email: 
+- ben.alavi@citrusbyte.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/s4.rb
+- s4.gemspec
+- test/s3_test.rb
+has_rdoc: true
+homepage: http://github.com/benalavi/s4
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Simple API for AWS S3
+test_files: []
+