caring-aws-sdb 0.3.2.caring.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007, 2008 Tim Dysinger
+
+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

@@ -0,0 +1 @@
+Amazon SDB API

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "aws-sdb"
+    gem.summary = "Amazon SDB API"
+    gem.description = gem.summary
+    gem.email = "ddollar@gmail.com"
+    gem.homepage = "http://github.com/ddollar/aws-sdb"
+    gem.authors = ["Tim Dysinger", "David Dollar"]
+    gem.add_runtime_dependency "uuidtools"
+    gem.add_development_dependency 'rspec'
+  end
+  Jeweler::GemcutterTasks.new
+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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gem-github-stats #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/aws-sdb.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{caring-aws-sdb}
+  s.version = "0.3.2.caring.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Dysinger", "David Dollar"]
+  s.date = %q{2009-10-02}
+  s.description = %q{Amazon SDB API}
+  s.email = %q{ddollar@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "aws-sdb.gemspec",
+     "lib/aws_sdb.rb",
+     "lib/aws_sdb/error.rb",
+     "lib/aws_sdb/service.rb",
+     "spec/aws_sdb/service_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ddollar/aws-sdb}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Amazon SDB API}
+  s.test_files = [
+    "spec/aws_sdb/service_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  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
+      s.add_runtime_dependency(%q<uuidtools>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<uuidtools>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<uuidtools>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/lib/aws_sdb.rb

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

data/lib/aws_sdb/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_sdb/service.rb

@@ -0,0 +1,183 @@
+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_sdb.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
+
+    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 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_element|
+        item = { :name => item_element.get_text('Name').to_s }
+        attributes = {}
+        item_element.each_element('Attribute') do |attribute|
+          attributes[attribute.get_text('Name').to_s] = attribute.get_text('Value').to_s
+        end
+        item[:attributes] = attributes
+        results << item
+      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_sdb/service_spec.rb

@@ -0,0 +1,185 @@
+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" do
+    # TODO Implement this example
+  end
+
+  it "should not have to call amazon to determine domain name correctness" do
+    # TODO Implement this example
+  end
+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 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_sdb'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: caring-aws-sdb
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 3
+  - 2
+  - caring
+  - 1
+  version: 0.3.2.caring.1
+platform: ruby
+authors: 
+- Tim Dysinger
+- David Dollar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Amazon SDB API
+email: ddollar@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- aws-sdb.gemspec
+- lib/aws_sdb.rb
+- lib/aws_sdb/error.rb
+- lib/aws_sdb/service.rb
+- spec/aws_sdb/service_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ddollar/aws-sdb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Amazon SDB API
+test_files: 
+- spec/aws_sdb/service_spec.rb
+- spec/spec_helper.rb