charlesju-aws-simpledb 0.1.0 → 0.1.3

data/Manifest

@@ -0,0 +1,10 @@
+LICENSE
+Manifest
+README
+Rakefile
+aws-simpledb.gemspec
+lib/aws-simpledb.rb
+lib/aws-simpledb/error.rb
+lib/aws-simpledb/service.rb
+spec/aws-simpledb/service_spec.rb
+spec/spec_helper.rb

data/README

@@ -1,5 +1,10 @@
+== About
 Amazon SimpleDB
-
 Reworking this API to be up-to-date with the new APIs.
 
+== Commands
+sudo gem build aws-simpledb.gemspec
+sudo gem install aws-simpledb-0.1.0.gem
+
+== Notes
 THIS GEM IS NOT READY FOR USE

data/Rakefile

@@ -1,20 +1,14 @@
 require 'rubygems'
-require 'spec/rake/spectask'
-require 'rake/gempackagetask'
-
-Spec::Rake::SpecTask.new
-
-gem_spec = eval(IO.read(File.join(File.dirname(__FILE__), "aws-simpledb.gemspec")))
-
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -I lib -r aws-simpledb.rb"
+require 'rake'
+require 'echoe'
+
+Echoe.new('aws-simpledb', '0.1.3') do |p|
+  p.description     = "This is an easy way to use Amazon SimpleDB"
+  p.url             = "http://github.com/charlesju/aws-simpledb"
+  p.author          = "Charles Ju"
+  p.email           = "charlesju@gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
 end
 
-Rake::GemPackageTask.new(gem_spec) do |pkg|
-  pkg.gem_spec = gem_spec
-end
-
-task :install => [:package] do
-  sh %{sudo gem install pkg/#{gem_spec.name}-#{gem_spec.version}}
-end
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each {|ext| load ext}

data/aws-simpledb.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{aws-simpledb}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Charles Ju"]
+  s.date = %q{2009-09-16}
+  s.description = %q{This is an easy way to use Amazon SimpleDB}
+  s.email = %q{charlesju@gmail.com}
+  s.extra_rdoc_files = ["LICENSE", "README", "lib/aws-simpledb.rb", "lib/aws-simpledb/error.rb", "lib/aws-simpledb/service.rb"]
+  s.files = ["LICENSE", "Manifest", "README", "Rakefile", "aws-simpledb.gemspec", "lib/aws-simpledb.rb", "lib/aws-simpledb/error.rb", "lib/aws-simpledb/service.rb", "spec/aws-simpledb/service_spec.rb", "spec/spec_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/charlesju/aws-simpledb}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Aws-simpledb", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{aws-simpledb}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{This is an easy way to use Amazon SimpleDB}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/aws-simpledb.rb

@@ -0,0 +1,3 @@
+require 'aws-simpledb/error'
+require 'aws-simpledb/service'
+

data/lib/aws-simpledb/error.rb

@@ -0,0 +1,42 @@
+module AwsSdb
+
+  class Error < RuntimeError ; end
+
+  class RequestError < Error
+    attr_reader :request_id
+
+    def initialize(message, request_id=nil)
+      super(message)
+      @request_id = request_id
+    end
+  end
+
+  class InvalidDomainNameError < RequestError ; end
+  class InvalidParameterValueError < RequestError ; end
+  class InvalidNextTokenError < RequestError ; end
+  class InvalidNumberPredicatesError < RequestError ; end
+  class InvalidNumberValueTestsError < RequestError ; end
+  class InvalidQueryExpressionError < RequestError ; end
+  class MissingParameterError < RequestError ; end
+  class NoSuchDomainError < RequestError ; end
+  class NumberDomainsExceededError < RequestError ; end
+  class NumberDomainAttributesExceededError < RequestError ; end
+  class NumberDomainBytesExceededError < RequestError ; end
+  class NumberItemAttributesExceededError < RequestError ; end
+  class RequestTimeoutError < RequestError ; end
+
+  class FeatureDeprecatedError < RequestError ; end
+
+  class ConnectionError < Error
+    attr_reader :response
+
+    def initialize(response)
+      super(
+        "#{response.code} \
+         #{response.message if response.respond_to?(:message)}"
+      )
+      @response = response
+    end
+  end
+
+end

data/lib/aws-simpledb/service.rb

@@ -0,0 +1,214 @@
+require 'logger'
+require 'time'
+require 'cgi'
+require 'uri'
+require 'net/http'
+require 'base64'
+require 'openssl'
+require 'rexml/document'
+require 'rexml/xpath'
+
+module AwsSdb
+
+  class Service
+    def initialize(options={})
+      @access_key_id = options[:access_key_id] || ENV['AMAZON_ACCESS_KEY_ID']
+      @secret_access_key = options[:secret_access_key] || ENV['AMAZON_SECRET_ACCESS_KEY']
+      @base_url = options[:url] || 'http://sdb.amazonaws.com'
+      @logger = options[:logger] || Logger.new("aws-simpledb.log")
+    end
+
+    def list_domains(max = nil, token = nil)
+      params = { 'Action' => 'ListDomains' }
+      params['NextToken'] =
+        token unless token.nil? || token.empty?
+      params['MaxNumberOfDomains'] =
+        max.to_s unless max.nil? || max.to_i == 0
+      doc = call(:get, params)
+      results = []
+      REXML::XPath.each(doc, '//DomainName/text()') do |domain|
+        results << domain.to_s
+      end
+      return results, REXML::XPath.first(doc, '//NextToken/text()').to_s
+    end
+
+    def create_domain(domain)
+      call(:post, { 'Action' => 'CreateDomain', 'DomainName'=> domain.to_s })
+      nil
+    end
+
+    def delete_domain(domain)
+      call(
+        :delete,
+        { 'Action' => 'DeleteDomain', 'DomainName' => domain.to_s }
+      )
+      nil
+    end
+    # <QueryWithAttributesResult><Item><Name>in-c2ffrw</Name><Attribute><Name>code</Name><Value>in-c2ffrw</Value></Attribute><Attribute><Name>date_created</Name><Value>2008-10-31</Value></Attribute></Item><Item>
+    def query_with_attributes(domain, query, max = nil, token = nil)
+      params = {
+        'Action' => 'QueryWithAttributes',
+        'QueryExpression' => query,
+        'DomainName' => domain.to_s
+      }
+      params['NextToken'] =
+        token unless token.nil? || token.empty?
+      params['MaxNumberOfItems'] =
+        max.to_s unless max.nil? || max.to_i == 0
+
+      doc = call(:get, params)
+      results = []
+      REXML::XPath.each(doc, "//Item") do |item|
+        name = REXML::XPath.first(item, './Name/text()').to_s
+
+
+        attributes = {'Name' => name}
+        REXML::XPath.each(item, "./Attribute") do |attr|
+          key = REXML::XPath.first(attr, './Name/text()').to_s
+          value = REXML::XPath.first(attr, './Value/text()').to_s
+          ( attributes[key] ||= [] ) << value
+        end
+        results << attributes
+      end
+      return results, REXML::XPath.first(doc, '//NextToken/text()').to_s
+    end
+
+    # <QueryResult><ItemName>in-c2ffrw</ItemName><ItemName>in-72yagt</ItemName><ItemName>in-52j8gj</ItemName>
+    def query(domain, query, max = nil, token = nil)
+      params = {
+        'Action' => 'Query',
+        'QueryExpression' => query,
+        'DomainName' => domain.to_s
+      }
+      params['NextToken'] =
+        token unless token.nil? || token.empty?
+      params['MaxNumberOfItems'] =
+        max.to_s unless max.nil? || max.to_i == 0
+
+      doc = call(:get, params)
+      results = []
+      REXML::XPath.each(doc, '//ItemName/text()') do |item|
+        results << item.to_s
+      end
+      return results, REXML::XPath.first(doc, '//NextToken/text()').to_s
+    end
+    
+    def get_select(query, max = nil, token = nil)
+      params = {
+        'Action' => 'Select',
+        'SelectExpression' => query      
+      }
+      params['NextToken'] =
+        token unless token.nil? || token.empty?
+      params['MaxNumberOfItems'] =
+        max.to_s unless max.nil? || max.to_i == 0
+
+      doc = call(:get, params)
+      results = []
+      REXML::XPath.each(doc, "//Item") do |item|
+        name = REXML::XPath.first(item, './Name/text()').to_s
+        attributes = {'Name' => name}
+        REXML::XPath.each(item, "./Attribute") do |attr|
+          key = REXML::XPath.first(attr, './Name/text()').to_s
+          value = REXML::XPath.first(attr, './Value/text()').to_s
+          ( attributes[key] ||= [] ) << value
+        end
+        results << attributes
+      end
+      return results, REXML::XPath.first(doc, '//NextToken/text()').to_s
+    end
+    
+    def put_attributes(domain, item, attributes, replace = true)
+      params = {
+        'Action' => 'PutAttributes',
+        'DomainName' => domain.to_s,
+        'ItemName' => item.to_s
+      }
+      count = 0
+      attributes.each do | key, values |
+        ([]<<values).flatten.each do |value|
+          params["Attribute.#{count}.Name"] = key.to_s
+          params["Attribute.#{count}.Value"] = value.to_s
+          params["Attribute.#{count}.Replace"] = replace
+          count += 1
+        end
+      end
+      call(:put, params)
+      nil
+    end
+
+    def get_attributes(domain, item)
+      doc = call(
+        :get,
+        {
+          'Action' => 'GetAttributes',
+          'DomainName' => domain.to_s,
+          'ItemName' => item.to_s
+        }
+      )
+      attributes = {}
+      REXML::XPath.each(doc, "//Attribute") do |attr|
+        key = REXML::XPath.first(attr, './Name/text()').to_s
+        value = REXML::XPath.first(attr, './Value/text()').to_s
+        ( attributes[key] ||= [] ) << value
+      end
+      attributes
+    end
+
+    def delete_attributes(domain, item)
+      call(
+        :delete,
+        {
+          'Action' => 'DeleteAttributes',
+          'DomainName' => domain.to_s,
+          'ItemName' => item.to_s
+        }
+      )
+      nil
+    end
+
+    protected
+
+    def call(method, params)
+      params.merge!( {
+          'Version' => '2007-11-07',
+          'SignatureVersion' => '1',
+          'AWSAccessKeyId' => @access_key_id,
+          'Timestamp' => Time.now.gmtime.iso8601
+        }
+      )
+      data = ''
+      query = []
+      params.keys.sort_by { |k| k.upcase }.each do |key|
+        data << "#{key}#{params[key].to_s}"
+        query << "#{key}=#{CGI::escape(params[key].to_s)}"
+      end
+      digest = OpenSSL::Digest::Digest.new('sha1')
+      hmac = OpenSSL::HMAC.digest(digest, @secret_access_key, data)
+      signature = Base64.encode64(hmac).strip
+      query << "Signature=#{CGI::escape(signature)}"
+      query = query.join('&')
+      url = "#{@base_url}?#{query}"
+      uri = URI.parse(url)
+      @logger.debug("#{url}") if @logger
+      response =
+        Net::HTTP.new(uri.host, uri.port).send_request(method, uri.request_uri)
+      @logger.debug("#{response.code}\n#{response.body}") if @logger
+      raise(ConnectionError.new(response)) unless (200..400).include?(
+        response.code.to_i
+      )
+      doc = REXML::Document.new(response.body)
+      error = doc.get_elements('*/Errors/Error')[0]
+      raise(
+        Module.class_eval(
+          "AwsSdb::#{error.get_elements('Code')[0].text}Error"
+        ).new(
+          error.get_elements('Message')[0].text,
+          doc.get_elements('*/RequestID')[0].text
+        )
+      ) unless error.nil?
+      doc
+    end
+  end
+
+end

data/spec/aws-simpledb/service_spec.rb

@@ -0,0 +1,183 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'digest/sha1'
+require 'net/http'
+require 'rexml/document'
+
+require 'rubygems'
+require 'uuidtools'
+
+include AwsSdb
+
+describe Service, "when creating a new domain" do
+  before(:all) do
+    @service = AwsSdb::Service.new
+    @domain = "test-#{UUID.random_create.to_s}"
+    domains = @service.list_domains[0]
+    domains.each do |d|
+      @service.delete_domain(d) if d =~ /^test/
+    end
+  end
+
+  after(:all) do
+    @service.delete_domain(@domain)
+  end
+
+  it "should not raise an error if a valid new domain name is given" do
+    lambda {
+      @service.create_domain("test-#{UUID.random_create.to_s}")
+    }.should_not raise_error
+  end
+
+  it "should not raise an error if the domain name already exists" do
+    domain = "test-#{UUID.random_create.to_s}"
+    lambda {
+      @service.create_domain(domain)
+      @service.create_domain(domain)
+    }.should_not raise_error
+  end
+
+  it "should raise an error if an a nil or '' domain name is given" do
+    lambda {
+      @service.create_domain('')
+    }.should raise_error(InvalidParameterValueError)
+    lambda {
+      @service.create_domain(nil)
+    }.should raise_error(InvalidParameterValueError)
+    lambda {
+      @service.create_domain('     ')
+    }.should raise_error(InvalidParameterValueError)
+  end
+
+  it "should raise an error if the domain name length is < 3 or > 255" do
+    lambda {
+      @service.create_domain('xx')
+    }.should raise_error(InvalidParameterValueError)
+    lambda {
+      @service.create_domain('x'*256)
+    }.should raise_error(InvalidParameterValueError)
+  end
+
+  it "should only accept domain names with a-z, A-Z, 0-9, '_', '-', and '.' " do
+    lambda {
+      @service.create_domain('@$^*()')
+    }.should raise_error(InvalidParameterValueError)
+  end
+
+  it "should only accept a maximum of 100 domain names"
+
+  it "should not have to call amazon to determine domain name correctness"
+end
+
+describe Service, "when listing domains" do
+  before(:all) do
+    @service = AwsSdb::Service.new
+    @domain = "test-#{UUID.random_create.to_s}"
+    @service.list_domains[0].each do |d|
+      @service.delete_domain(d) if d =~ /^test/
+    end
+    @service.create_domain(@domain)
+  end
+
+  after(:all) do
+    @service.delete_domain(@domain)
+  end
+
+  it "should return a complete list" do
+    result = nil
+    lambda { result = @service.list_domains[0] }.should_not raise_error
+    result.should_not be_nil
+    result.should_not be_empty
+    result.include?(@domain).should == true
+  end
+end
+
+describe Service, "when deleting domains" do
+  before(:all) do
+    @service = AwsSdb::Service.new
+    @domain = "test-#{UUID.random_create.to_s}"
+    @service.list_domains[0].each do |d|
+      @service.delete_domain(d) if d =~ /^test/
+    end
+    @service.create_domain(@domain)
+  end
+
+  after do
+    @service.delete_domain(@domain)
+  end
+
+  it "should be able to delete an existing domain" do
+    lambda { @service.delete_domain(@domain) }.should_not raise_error
+  end
+
+  it "should not raise an error trying to delete a non-existing domain" do
+    lambda {
+      @service.delete_domain(UUID.random_create.to_s)
+    }.should_not raise_error
+  end
+end
+
+describe Service, "when managing items" do
+  before(:all) do
+    @service = AwsSdb::Service.new
+    @domain = "test-#{UUID.random_create.to_s}"
+    @service.list_domains[0].each do |d|
+      @service.delete_domain(d) if d =~ /^test/
+    end
+    @service.create_domain(@domain)
+    @item = "test-#{UUID.random_create.to_s}"
+    @attributes = {
+      :question => 'What is the answer?',
+      :answer => [ true, 'testing123', 4.2, 42, 420 ]
+    }
+  end
+
+  after(:all) do
+     @service.delete_domain(@domain)
+  end
+
+  it "should be able to put attributes" do
+    lambda {
+      @service.put_attributes(@domain, @item, @attributes)
+    }.should_not raise_error
+  end
+
+  it "should be able to get attributes" do
+    result = nil
+    lambda {
+      result = @service.get_attributes(@domain, @item)
+    }.should_not raise_error
+    result.should_not be_nil
+    result.should_not be_empty
+    result.has_key?('answer').should == true
+    @attributes[:answer].each do |v|
+      result['answer'].include?(v.to_s).should == true
+    end
+  end
+
+  it "should be able to query" do
+    result = nil
+    lambda {
+      result = @service.query(@domain, "[ 'answer' = '42' ]")[0]
+    }.should_not raise_error
+    result.should_not be_nil
+    result.should_not be_empty
+    result.should_not be_nil
+    result.include?(@item).should == true
+  end
+
+  it "should be able to query with attributes"
+
+  it "should be able to delete attributes" do
+    lambda {
+      @service.delete_attributes(@domain, @item)
+    }.should_not raise_error
+  end
+end
+
+# TODO Pull the specs from the amazon docs and write more rspec
+# 100 attributes per each call
+# 256 total attribute name-value pairs per item
+# 250 million attributes per domain
+# 10 GB of total user data storage per domain
+# ...etc...

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'aws-simpledb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: charlesju-aws-simpledb
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors: 
 - Charles Ju
@@ -9,19 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-16 00:00:00 -07:00
+date: 2009-09-16 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: uuidtools
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+dependencies: []
+
 description: This is an easy way to use Amazon SimpleDB
 email: charlesju@gmail.com
 executables: []
@@ -29,18 +20,33 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
 - LICENSE
+- README
+- lib/aws-simpledb.rb
+- lib/aws-simpledb/error.rb
+- lib/aws-simpledb/service.rb
 files: 
 - LICENSE
+- Manifest
 - README
 - Rakefile
+- aws-simpledb.gemspec
+- lib/aws-simpledb.rb
+- lib/aws-simpledb/error.rb
+- lib/aws-simpledb/service.rb
+- spec/aws-simpledb/service_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/charlesju/aws-simpledb
 licenses: 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Aws-simpledb
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -53,14 +59,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 
 rubyforge_project: aws-simpledb
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
-summary: Amazon SimpleDB
+specification_version: 3
+summary: This is an easy way to use Amazon SimpleDB
 test_files: []