awsraw 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in awsraw.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/awsraw.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "awsraw/version"
+
+Gem::Specification.new do |s|
+  s.name        = "awsraw"
+  s.version     = Awsraw::VERSION
+  s.authors     = ["Pete Yandell"]
+  s.email       = ["pete@notahat.com"]
+  s.homepage    = "http://github.com/envato/flickraw"
+  s.summary     = %q{Minimal AWS client}
+  s.description = %q{A client for Amazon Web Services in the style of FlickRaw}
+
+  s.rubyforge_project = "awsraw"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/awsraw/s3/client.rb

@@ -0,0 +1,78 @@
+require 'net/http'
+require 'awsraw/s3/request'
+require 'awsraw/s3/response'
+require 'awsraw/s3/signer'
+
+module AWSRaw
+  module S3
+
+    # A client for the AWS S3 rest API.
+    #
+    # http://docs.amazonwebservices.com/AmazonS3/latest/API/APIRest.html
+    class Client
+
+      def initialize(access_key_id, secret_access_key)
+        @access_key_id     = access_key_id
+        @secret_access_key = secret_access_key
+      end
+
+      def request(params = {})
+        request = Request.new(params, signer)
+
+        http_request = construct_http_request(request)
+
+        http_response = Net::HTTP.start(request.uri.host, request.uri.port) do |http|
+          http.request(http_request)
+        end
+
+        construct_response(http_response)
+      end
+
+      def request!(params = {})
+        response = request(params)
+        raise "Uh oh! Failure from S3." if response.failure?
+      end
+
+    private
+
+      def construct_http_request(request)
+        klass = http_request_class(request)
+        path  = request.uri.request_uri
+
+        klass.new(path).tap do |http_request|
+          request.headers.each do |name, value|
+            http_request[name] = value
+          end
+          http_request.body = request.content
+        end
+      end
+
+      def http_request_class(request)
+        case request.method
+          when "GET"
+            Net::HTTP::Get
+          when "HEAD"
+            Net::HTTP::Head
+          when "PUT"
+            Net::HTTP::Put
+          else
+            raise "Invalid HTTP method!"
+        end
+      end
+
+      def construct_response(http_response)
+        Response.new(
+          :code    => http_response.code,
+          :headers => http_response.to_hash,
+          :content => http_response.body
+        )
+      end
+
+      def signer
+        @signer ||= Signer.new(@access_key_id, @secret_access_key)
+      end
+
+    end
+
+  end
+end

data/lib/awsraw/s3/request.rb

@@ -0,0 +1,58 @@
+require 'digest/md5'
+require 'time'
+require 'uri'
+
+module AWSRaw
+  module S3
+
+    # Note that we use path style (rather than virtual hosted style) requests.
+    # This is because virtual hosted requests only support lower case bucket
+    # names.
+    #
+    # See http://docs.amazonwebservices.com/AmazonS3/latest/dev/VirtualHosting.html
+    class Request
+      def initialize(params, signer)
+        @method  = params[:method]
+        @bucket  = params[:bucket]
+        @key     = params[:key]
+        @query   = params[:query]
+        @headers = params[:headers] || {}
+        @content = params[:content]
+
+        raise "Content without Content-Type" if !@content.nil? && @headers["Content-Type"].nil?
+
+        headers["Content-MD5"]   = content_md5 unless content.nil?
+        headers["Date"]          = Time.now.rfc2822
+        headers["Authorization"] = signer.signature(self)
+      end
+
+      attr_reader :method
+      attr_reader :bucket
+      attr_reader :key
+      attr_reader :query
+      attr_reader :headers
+      attr_reader :content
+
+      def host
+        "s3.amazonaws.com"
+      end
+
+      def path
+        @path ||= URI.escape("/#{bucket}#{key}")
+      end
+
+      def uri
+        @uri ||= URI::HTTP.build(
+          :host  => host,
+          :path  => path,
+          :query => query
+        )
+      end
+
+      def content_md5
+        @content_md5 ||= Base64.encode64(Digest::MD5.digest(content)).strip
+      end
+    end
+
+  end
+end

data/lib/awsraw/s3/response.rb

@@ -0,0 +1,26 @@
+module AWSRaw
+  module S3
+
+    class Response
+      def initialize(params = {})
+        @code    = params[:code]
+        @headers = params[:headers]
+        @content = params[:content]
+      end
+
+      attr_accessor :code
+      attr_accessor :headers
+      attr_accessor :content
+
+      def success?
+        code =~ /^2\d\d$/
+      end
+
+      def failure?
+        !success?
+      end
+    end
+
+  end
+end
+

data/lib/awsraw/s3/signer.rb

@@ -0,0 +1,60 @@
+require 'digest/sha1'
+require 'openssl'
+require 'uri'
+require 'base64'
+
+module AWSRaw
+  module S3
+
+    # Generates the Authorization header for a REST request to S3.
+    #
+    # See http://docs.amazonwebservices.com/AmazonS3/latest/dev/RESTAuthentication.html
+    class Signer
+
+      def initialize(access_key_id, secret_access_key)
+        @access_key_id     = access_key_id
+        @secret_access_key = secret_access_key
+      end
+
+      def signature(request)
+        string_to_sign = string_to_sign(request)
+
+        digest    = OpenSSL::Digest::Digest.new("sha1")
+        sha       = OpenSSL::HMAC.digest(digest, @secret_access_key, string_to_sign)
+        signature = Base64.encode64(sha).strip
+
+        "AWS #{@access_key_id}:#{signature}"
+      end
+
+      def string_to_sign(request)
+        [
+          request.method,
+          request.headers["Content-MD5"]  || "",
+          request.headers["Content-Type"] || "",
+          request.headers["Date"],
+          canonicalized_amz_headers(request.headers),
+          canonicalized_resource(request)
+        ].flatten.join("\n")
+      end
+
+    private
+
+      def canonicalized_amz_headers(headers)
+        header_names = headers.keys.
+          select  {|name| name =~ /^x-amz-/i }.
+          sort_by {|name| name.downcase }
+
+        header_names.map do |name|
+          "#{name.downcase}:#{headers[name]}"
+        end
+      end
+
+      def canonicalized_resource(request)
+        # TODO: Should also append the sub-resource.
+        request.path
+      end
+
+    end
+
+  end
+end

data/lib/awsraw/version.rb

@@ -0,0 +1,3 @@
+module Awsraw
+  VERSION = "0.0.1"
+end

data/lib/awsraw.rb

@@ -0,0 +1,5 @@
+require "awsraw/version"
+
+module Awsraw
+  # Your code goes here...
+end

data/spec/s3/client_spec.rb

@@ -0,0 +1,28 @@
+require 'awsraw/s3/client'
+
+describe AWSRaw::S3::Client do
+
+  subject { AWSRaw::S3::Client.new("dummy_access_key_id", "dummy_secret_access_key") }
+
+  context "#request!" do
+    it "returns if the response indicates success" do
+      response = stub(:failure? => false)
+      subject.stub(:request => response)
+
+      expect {
+        subject.request!(:method => "PUT")
+      }.should_not raise_error
+    end
+
+    it "raises an error if the response indicates failure" do
+      response = stub(:failure? => true)
+      subject.stub(:request => response)
+
+      expect {
+        subject.request!(:method => "PUT")
+      }.should raise_error("Uh oh! Failure from S3.")
+    end
+  end
+
+end
+

data/spec/s3/signer_spec.rb

@@ -0,0 +1,49 @@
+require 'awsraw/s3/signer'
+
+describe AWSRaw::S3::Signer do
+  let(:access_key_id)     { "0PN5J17HBGZHT7JJ3X82" }
+  let(:secret_access_key) { "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o" }
+
+  subject { AWSRaw::S3::Signer.new(access_key_id, secret_access_key) }
+
+  context "examples from Amazon docs" do
+    it "signs a get request correctly" do
+      request = stub(
+        :method  => "GET",
+        :path    => "/johnsmith/photos/puppy.jpg",
+        :headers => { "Date" => "Tue, 27 Mar 2007 19:36:42 +0000" }
+      )
+
+      subject.string_to_sign(request).should ==
+        "GET\n\n\nTue, 27 Mar 2007 19:36:42 +0000\n/johnsmith/photos/puppy.jpg"
+
+      subject.signature(request).should == "AWS #{access_key_id}:xXjDGYUmKxnwqr5KXNPGldn5LbA="
+    end
+
+    it "signs an upload correctly" do
+      request = stub(
+        :method => "PUT",
+        :path   => "/static.johnsmith.net/db-backup.dat.gz",
+        :headers => {
+          "User-Agent"                   => "curl/7.15.5",
+          "Date"                         => "Tue, 27 Mar 2007 21:06:08 +0000",
+          "x-amz-acl"                    => "public-read",
+          "Content-Type"                 => "application/x-download",
+          "Content-MD5"                  => "4gJE4saaMU4BqNR0kLY+lw==",
+          "X-Amz-Meta-ReviewedBy"        => "joe@johnsmith.net,jane@johnsmith.net",
+          "X-Amz-Meta-FileChecksum"      => "0x02661779",
+          "X-Amz-Meta-ChecksumAlgorithm" => "crc32",
+          "Content-Disposition"          => "attachment; filename=database.dat",
+          "Content-Encoding"             => "gzip",
+          "Content-Length"               => "5913339"
+        }
+      )
+
+      subject.string_to_sign(request).should ==
+        "PUT\n4gJE4saaMU4BqNR0kLY+lw==\napplication/x-download\nTue, 27 Mar 2007 21:06:08 +0000\nx-amz-acl:public-read\nx-amz-meta-checksumalgorithm:crc32\nx-amz-meta-filechecksum:0x02661779\nx-amz-meta-reviewedby:joe@johnsmith.net,jane@johnsmith.net\n/static.johnsmith.net/db-backup.dat.gz"
+
+      subject.signature(request).should == "AWS #{access_key_id}:C0FlOtU8Ylb9KDTpZqYkZPX91iI="
+    end
+
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: awsraw
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pete Yandell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-12 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+description: A client for Amazon Web Services in the style of FlickRaw
+email: 
+- pete@notahat.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- awsraw.gemspec
+- lib/awsraw.rb
+- lib/awsraw/s3/client.rb
+- lib/awsraw/s3/request.rb
+- lib/awsraw/s3/response.rb
+- lib/awsraw/s3/signer.rb
+- lib/awsraw/version.rb
+- spec/s3/client_spec.rb
+- spec/s3/signer_spec.rb
+has_rdoc: true
+homepage: http://github.com/envato/flickraw
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: awsraw
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Minimal AWS client
+test_files: 
+- spec/s3/client_spec.rb
+- spec/s3/signer_spec.rb