aws-ie 0.0.2

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.org

@@ -0,0 +1,60 @@
+# -*- mode: org; -*-
+#+TITLE: AWS import/Export API support
+
+* AWS::Import
+AWS::Import provides Ruby interface to AWS Import/Export API
+
+* Getting started
+
+require 'aws/import/job'
+
+*** Configure the Import using your access/secret keys
+    AWS::Import::Config.aws_access_key_id = "YOUR-ACCESS-KEY"
+
+    AWS::Import::Config.aws_secret_key_id = "YOUR-SECRET-KEY"
+
+*** Build Manifest according to AWS API docs
+manifest = <<EOF
+
+manifestVersion: 2.0
+
+bucket: myBucket-Sonian
+
+accessKeyId: YOUR-ACCESS-KEY
+
+returnAddress:
+
+  name: Amazon.com ATTN Joe Random
+
+  street1: 120 Nosuch Ave S.
+
+  city: Seattle
+
+  stateOrProvince: WA
+
+  postalCode: 91111
+
+  phoneNumber: 206-266-0000
+
+  country: USA
+
+eraseDevice: no
+
+deviceId: 49382
+
+EOF
+
+*** Create new Import Job
+job = AWS::Import::Job.new(:manifest => manifest)
+
+job.save
+
+job.id # => JobId node value from response (Example: ABC-123)
+
+or
+
+job = AWS::Import::Job.create(:manifest => manifest)
+
+job.id # => JobId node value from response (Example: ABC-123)
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+require 'spec/rake/spectask'
+
+Bundler::GemHelper.install_tasks
+Spec::Rake::SpecTask.new
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/aws-ie.gemspec

@@ -0,0 +1,35 @@
+version = File.read(File.expand_path("../VERSION",__FILE__)).strip
+require 'bundler'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'aws-ie'
+  s.version     = version
+  s.summary     = 'AWS Import/Export API supoprt.'
+  s.homepage    = "http://rubygems.org/gems/aws-ie"
+
+  s.required_ruby_version     = '>= 1.8.7'
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", "1.3.0"
+  s.add_dependency "nokogiri", "1.4.3.1"
+
+  s.author            = 'Maksim Horbul'
+  s.email             = 'max@gorbul.net'
+
+  s.files = [
+    "README.org",
+    "COPYING",
+    "Gemfile",
+    "Rakefile",
+    "VERSION",
+    "aws-ie.gemspec",
+    "lib/aws/ie.rb",
+    "lib/aws/import/job.rb",
+    "lib/aws/ie/client.rb",
+    "spec/aws/import/job_spec.rb",
+    "spec/aws/ie/client_spec.rb"
+   ]
+   s.require_path = 'lib'
+end

data/lib/aws/ie/client.rb

@@ -0,0 +1,72 @@
+require 'net/http'
+require 'net/https'
+require 'time'
+
+module AWS
+  class IE
+    class Client
+
+      API_URL = "https://importexport.amazonaws.com"
+
+      class << self
+        attr_accessor :aws_access_key_id
+        attr_accessor :aws_secret_key_id
+        attr_accessor :test_mode
+        attr_accessor :debug_output
+      end
+
+      def initialize
+        @url = URI.parse(API_URL)
+        @url.path = "/" if @url.path.empty?
+      end
+
+      def post(params)
+        request = prepare_request_with_params(params)
+        http = Net::HTTP.new(@url.host, @url.port)
+        unless self.class.debug_output.nil?
+          http.set_debug_output(self.class.debug_output)
+        end
+        http.use_ssl = true
+        http.start { |http| http.request(request) }.body
+      end
+
+      private
+      def prepare_request_with_params(params)
+        request = Net::HTTP::Post.new(@url.path)
+        request.body = signed_query_string(params)
+        request.content_type = "application/x-www-form-urlencoded"
+        request
+      end
+
+      def signed_query_string(params)
+        canonical_query = canonical_query_string(params)
+        canonical_string = ["POST", @url.host, "/", canonical_query].join("\n")
+        digest = OpenSSL::Digest::Digest.new('sha1')
+        hmac = OpenSSL::HMAC.
+          digest(digest, self.class.aws_secret_key_id, canonical_string)
+        signature = [hmac].pack("m").strip
+        canonical_query + "&Signature=" + urlencode(signature)
+      end
+
+      def canonical_query_string(params)
+        default_params = {
+          "Timestamp" => Time.now.iso8601,
+          "AWSAccessKeyId" => self.class.aws_access_key_id,
+          "SignatureVersion" => 2,
+          "SignatureMethod" => "HmacSHA1"
+        }
+        default_params["ValidateOnly"] = true if self.class.test_mode == true
+        params.merge!(default_params)
+        sep = "&"
+        params.sort { |a,b| a[0] <=> b[0] }.
+          reduce([]) { |r, p| r << "#{urlencode(p[0].to_s)}=#{urlencode(p[1].to_s)}" }.
+          join(sep)
+      end
+
+      def urlencode(str)
+        r = /[^-_.!~*'()a-zA-Z\d;?@&$,\[\]]/n
+        URI.escape(str, r)
+      end
+    end
+  end
+end

data/lib/aws/ie.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require File.dirname(__FILE__) + '/ie/client'
+require File.dirname(__FILE__) + '/import/job'

data/lib/aws/import/job.rb

@@ -0,0 +1,110 @@
+require 'rubygems'
+require 'nokogiri'
+
+module AWS
+  module Import
+
+    class ResponseError < Exception
+      attr_accessor :code
+      def initialize(options)
+        @code = options[:code]
+        super(options[:message])
+      end
+    end
+
+    class Job
+      attr_reader :id, :signature, :status
+      attr_accessor :manifest
+
+      class << self
+
+        attr_accessor :client
+
+        def create(attributes = { })
+          self.new(attributes) do |job|
+            job.save
+          end
+        end
+
+        def cancel(job_id)
+          params = {
+            "Operation" => "CancelJob",
+            "JobId" => job_id
+          }
+          xml = self.new.send(:request, params)
+          success = xml.root.xpath("//Success").text
+          return success == "true"
+        end
+
+        def find(job_id)
+          self.new.find(job_id)
+        end
+
+      end
+
+      def initialize(attributes = { }, &block)
+        @manifest = attributes[:manifest]
+        block.call(self) if block_given?
+      end
+
+      def save
+        self.new_job? ? create : update
+      end
+
+      def find(job_id)
+        params = {
+          "Operation" => "GetStatus",
+          "JobId" => job_id
+        }
+        xml = request(params)
+        @id = xml.root.xpath("//JobId").text
+        @manifest = xml.root.xpath("//CurrentManifest").text
+        @status = {
+          :code => xml.root.xpath("//ProgressCode").text,
+          :message => xml.root.xpath("//ProgressMessage").text
+        }
+        @signature = xml.root.xpath("//Signature").text
+        self
+      end
+
+      def new_job?
+        self.id.nil?
+      end
+
+      private
+      def create
+        params = {
+          "Operation" => "CreateJob",
+          "Manifest" => self.manifest
+        }
+        xml = request(params)
+        @id = xml.root.xpath("//JobId").text
+        @signature = xml.root.xpath("//Signature").text
+      end
+
+      def update
+        params = {
+          "Operation" => "UpdateJob",
+          "Manifest" => self.manifest,
+          "JobId" => self.id
+        }
+        xml = request(params)
+        success = xml.root.xpath("//Success").text
+        return success == "true"
+      end
+
+      def request(params)
+        self.class.client ||= AWS::IE::Client.new
+        params.merge!("JobType" => "Import")
+        xml = Nokogiri::XML(self.class.client.post(params))
+        xml.remove_namespaces!
+        if xml.root.name == "ErrorResponse"
+          code = xml.root.xpath("//Error/Code").text
+          message = xml.root.xpath("//Error/Message").text
+          raise ResponseError.new(:code => code, :message => message)
+        end
+        xml
+      end
+    end
+  end
+end

data/spec/aws/ie/client_spec.rb

@@ -0,0 +1,128 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'aws/ie/client'
+
+describe AWS::IE::Client do
+
+  let(:manifest) do
+    { }
+  end
+
+  let(:params) do
+    {
+      "Operation" => "CreateJob",
+      "JobType" => "Import",
+      "Manifest" => manifest.to_yaml
+    }
+  end
+
+  let(:signed_query_string) do
+    "AWSAccessKeyId=ABC-123" +
+      "&JobType=Import" +
+      "&Manifest=---%20%7B%7D%0A%0A" +
+      "&Operation=CreateJob" +
+      "&SignatureMethod=HmacSHA1" +
+      "&SignatureVersion=2" +
+      "&Timestamp=2010-09-20T05%3A10%3A35%2B00%3A00" +
+      "&Signature=hmgL0julWxoVXeYHHqFQAbvmaL4%3D"
+  end
+
+  let(:timestamp) { Time.parse("2010-09-20 05:10:35") }
+
+  let(:post_request) { Net::HTTP::Post.new("/") }
+
+  let(:http) do
+    stubs = {
+      :start => response,
+      :use_ssl= => nil,
+      :request => response,
+      :set_debug_output => nil
+    }
+    mock("Net::HTTP", stubs)
+  end
+
+  let(:response) do
+    mock("Response", :body => "<xml />")
+  end
+
+  let(:host) { "importexport.amazonaws.com" }
+  let(:port) { 443 }
+
+  let(:access_key) { "ABC-123" }
+  let(:secret_key) { "123-ABC" }
+
+  before do
+    post_request
+    timestamp
+    Time.should_receive(:now).and_return(timestamp)
+    described_class.aws_access_key_id = access_key
+    described_class.aws_secret_key_id = secret_key
+  end
+
+  it "should prepare HTTP Post signed request" do
+    Net::HTTP.stub!(:new).and_return(http)
+    Net::HTTP::Post.should_receive(:new).with("/").and_return(post_request)
+    post_request.should_receive(:body=).with(signed_query_string)
+    post_request.should_receive(:content_type=).
+      with("application/x-www-form-urlencoded")
+    client = described_class.new
+    client.post(params)
+  end
+
+  it "should send the signed request" do
+    Net::HTTP::Post.stub!(:new).and_return(post_request)
+    Net::HTTP.should_receive(:new).with(host, port).and_return(http)
+    http.should_receive(:start).and_yield(http)
+    http.should_receive(:use_ssl=).with(true)
+    http.should_receive(:request).with(post_request).and_return(response)
+    client = described_class.new
+    client.post(params).should == "<xml />"
+  end
+
+  context "in debug mode" do
+
+    before do
+      AWS::IE::Client.debug_output = STDOUT
+    end
+
+    it "should set debug output" do
+      Net::HTTP.stub!(:new).and_return(http)
+      Net::HTTP::Post.should_receive(:new).with("/").and_return(post_request)
+      http.should_receive(:set_debug_output).with(STDOUT)
+      client = described_class.new
+      client.post(params)
+    end
+
+  end
+
+  context "in test mode" do
+
+    let(:signed_query_string) do
+      "AWSAccessKeyId=ABC-123" +
+        "&JobType=Import" +
+        "&Manifest=---%20%7B%7D%0A%0A" +
+        "&Operation=CreateJob" +
+        "&SignatureMethod=HmacSHA1" +
+        "&SignatureVersion=2" +
+        "&Timestamp=2010-09-20T05%3A10%3A35%2B00%3A00" +
+        "&ValidateOnly=true" +
+        "&Signature=%2BOIG%2F6ouAbS%2FI2vTQZYFsgUKk3Y%3D"
+    end
+
+    before do
+      AWS::IE::Client.test_mode = true
+    end
+
+    it "should send validate only request" do
+      Net::HTTP.stub!(:new).and_return(http)
+      Net::HTTP::Post.should_receive(:new).with("/").and_return(post_request)
+      post_request.should_receive(:body=).with(signed_query_string)
+      post_request.should_receive(:content_type=).
+        with("application/x-www-form-urlencoded")
+      client = described_class.new
+      client.post(params)
+    end
+
+  end
+
+end
+

data/spec/aws/import/job_spec.rb

@@ -0,0 +1,261 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'aws/ie'
+require 'yaml'
+
+describe AWS::Import::Job do
+
+  let(:manifest) do
+    File.read(File.join(File.dirname(__FILE__), "../../fixtures/manifest.yml"))
+  end
+
+  let(:client) do
+    AWS::IE::Client.new
+  end
+
+  let(:response) do
+    File.read(File.join(
+                        File.dirname(__FILE__),
+                        "../../fixtures/#{response_file_name}"))
+  end
+
+  before do
+    client.stub!(:post).and_return("<xml />")
+    described_class.client = client
+  end
+
+  describe "in general" do
+
+    it "should have manifest" do
+      job = described_class.new
+      job.manifest.should be_nil
+      job.manifest = "manifest content"
+      job.manifest.should == "manifest content"
+    end
+
+    it "should get the parameters from constructor" do
+      job = described_class.new(:manifest => "manifest content")
+      job.manifest.should == "manifest content"
+    end
+
+    it "should be a new job when it's not saved yet" do
+      job = described_class.new
+      job.should be_new_job
+    end
+
+    it "should create only one instance of the IE::Client" do
+      described_class.client = nil
+      AWS::IE::Client.should_receive(:new).once.and_return(client)
+      job = described_class.new
+      job.save
+      described_class.find("ABC-123")
+    end
+
+    it "should not be a new job when it's saved already" do
+      response_file = File.
+        join(File.dirname(__FILE__),
+            "../../fixtures/get_status_response_successfull.xml")
+      response = File.read(response_file)
+      client.should_receive(:post).and_return(response)
+      job = AWS::Import::Job.find("ABC-123")
+      job.should_not be_new_job
+    end
+
+  end
+
+  describe "when find a job by id" do
+
+    let(:response_file_name) do
+      "get_status_response_successfull.xml"
+    end
+
+    let(:params) do
+      {
+        "JobType" => "Import",
+        "Operation" => "GetStatus",
+        "JobId" => "ABC-123"
+      }
+    end
+
+    let(:job) { AWS::Import::Job.new }
+
+    before do
+      client.stub!(:post).with(params).and_return(response)
+    end
+
+    context "but job does not exist" do
+
+      let(:response_file_name) do
+        "get_status_response_failed.xml"
+      end
+
+      it "should raise exception when job is not found" do
+        job
+        lambda { AWS::Import::Job.find("ABC-123") }.
+          should raise_error(AWS::Import::ResponseError)
+      end
+
+    end
+
+    it "should send JobStatus API request" do
+      client.should_receive(:post).with(params).and_return(response)
+      AWS::Import::Job.find("ABC-123")
+    end
+
+    it "should create Job instance and have all attributes set" do
+      job
+      AWS::Import::Job.should_receive(:new).and_return(job)
+      AWS::Import::Job.find("ABC-123")
+      job.manifest.should == manifest
+      job.id.should == "ABC-123"
+      job.status[:code].should == "Pending"
+      job.status[:message].should == "The specified job has not started."
+      job.signature.should == "D6j+YqwmWiVXQzuy5Bu0lxehI3E="
+    end
+
+  end
+
+  describe "when is being canceled" do
+
+    let(:params) do
+      {
+        "JobType" => "Import",
+        "Operation" => "CancelJob",
+        "JobId" => "ABC-123"
+      }
+    end
+
+    context "successfully" do
+
+      let(:response_file_name) { "cancel_job_response_successfull.xml" }
+
+      it "should send cancel request and get successfull response" do
+        client.should_receive(:post).with(params).and_return(response)
+        described_class.cancel("ABC-123").should be_true
+      end
+
+    end
+
+    context "failed" do
+
+      let(:response_file_name) { "cancel_job_response_failed.xml" }
+
+      it "should send cancel request and get failed response" do
+        client.should_receive(:post).with(params).and_return(response)
+        begin
+          described_class.cancel("ABC-123")
+        rescue AWS::Import::ResponseError => e
+          e.code.should == "InvalidJobIdException"
+          e.message.should == "No such job 4Y8ND-VALIDATE-ONLY for your account"
+        end
+      end
+
+    end
+
+  end
+
+  describe "when is being updated" do
+
+    let(:response_file_name) { "update_job_response_successful.xml" }
+
+    let(:manifest) { { } }
+
+    let(:params) do
+      {
+        "JobType" => "Import",
+        "Operation" => "UpdateJob",
+        "Manifest" => manifest.to_yaml,
+        "JobId" => "ABC-123"
+      }
+    end
+
+    let(:job) do
+      job = described_class.new do |j|
+        j.manifest = manifest.to_yaml
+      end
+    end
+
+    before do
+      job.stub!(:id).and_return("ABC-123")
+    end
+
+    it "should update the existing job" do
+      client.should_receive(:post).with(params).and_return(response)
+      job.save.should be_true
+    end
+
+    describe "when update API call is failed" do
+
+    let(:response_file_name) { "update_job_response_failed.xml" }
+
+      it "should raise exception" do
+        begin
+          job.save
+        rescue AWS::Import::ResponseError => e
+          e.code.should == "InvalidJobIdException"
+          e.message.should == "No such job 123456 for your account"
+        end
+      end
+
+    end
+
+  end
+
+  describe "when is being created" do
+
+    let(:response_file_name) { "create_job_response.xml" }
+
+    let(:manifest) do
+      { }
+    end
+
+    let(:params) do
+      {
+        "JobType" => "Import",
+        "Operation" => "CreateJob",
+        "Manifest" => manifest.to_yaml
+      }
+    end
+
+    before do
+      client.stub!(:post).with(params).and_return(response)
+    end
+
+    it "should create AWS::IE::Client instance" do
+      described_class.create(:manifest => manifest.to_yaml).
+        should be_instance_of(described_class)
+    end
+
+    it "should send API request" do
+      client.should_receive(:post).with(params).and_return(response)
+      described_class.create(:manifest => manifest.to_yaml).
+        should be_instance_of(described_class)
+    end
+
+    it "should get the Job ID from response" do
+      job = described_class.create(:manifest => manifest.to_yaml)
+      job.id.should == "45HFS-VALIDATE-ONLY"
+    end
+
+    it "should have the signature" do
+      job = described_class.create(:manifest => manifest.to_yaml)
+      job.signature.should == "/dxgK27c8++SFiZLLaIvHt4Oy4k="
+    end
+
+    describe "and error occures" do
+
+      let(:response_file_name) { "create_job_response_failed.xml" }
+
+      it "should return not saved job with errors inside" do
+        begin
+          job = described_class.create
+        rescue AWS::Import::ResponseError => e
+          e.code.should == "MissingParameterException"
+          e.message.should == "Manifest must be specified"
+        end
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: aws-ie
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Maksim Horbul
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id001
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  requirement: *id002
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 113
+        segments: 
+        - 1
+        - 4
+        - 3
+        - 1
+        version: 1.4.3.1
+  requirement: *id003
+  name: nokogiri
+  prerelease: false
+  type: :runtime
+description: 
+email: max@gorbul.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.org
+- COPYING
+- Gemfile
+- Rakefile
+- VERSION
+- aws-ie.gemspec
+- lib/aws/ie.rb
+- lib/aws/import/job.rb
+- lib/aws/ie/client.rb
+- spec/aws/import/job_spec.rb
+- spec/aws/ie/client_spec.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/aws-ie
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: AWS Import/Export API supoprt.
+test_files: []
+