simplydb 0.0.2 → 0.0.3

data/.gitignore

@@ -1,21 +1,5 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
+pkg/*
+*.gem
+.bundle
+Gemfile.lock
+.idea/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,37 @@
+# simplydb
+
+A minimal interface to Amazon SimpleDB that has separation of interfaces. Build to support a Sinatra app that can be used as a JSON <-> SimpleDB proxy.
+
+      require 'rubygems'
+      require 'simplydb'
+
+      interface = SimplyDB::Interface.new({
+        :access_key => ENV['AWS_ACCESS_KEY'],
+        :secret_key => ENV['AWS_SECRET_KEY']
+      })
+
+      if interface.create_domain("MyDomain")
+        interface.put_attributes('MyDomain', 'Item123', {'color'=>['red','brick','garnet']})
+
+        attributes = interface.get_attributes('MyDomain', 'Item123')
+        puts "Item123 = #{attributes.inspect}"
+
+        items = interface.select("select color from MyDomain where color = 'brick'")
+        puts "Items = #{items.inspect}"
+
+        interface.delete_domain("MyDomain")
+      end
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 JT Archie. See LICENSE for details.

data/Rakefile

@@ -1,54 +1,14 @@
-require 'rubygems'
-require 'rake'
+require 'bundler'
+require 'rspec/core/rake_task'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "simplydb"
-    gem.summary = %Q{A minimal interface to Amazon SimpleDB.}
-    gem.description = %Q{A minimal interface to Amazon SimpleDB that has separation of interfaces. From the low level HTTP request access to high level Ruby abstraction ORM.}
-    gem.email = "jtarchie@gmail.com"
-    gem.homepage = "http://github.com/jtarchie/simplydb"
-    gem.authors = ["JT Archie"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_dependency "typhoeus", ">= 0.1.27"
-    gem.add_dependency "nokogiri", ">= 1.4.2"
-    gem.add_dependency "uuidtools", ">= 2.1.1"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
+Bundler::GemHelper.install_tasks
 
-task :spec => :check_dependencies
-
-task :default => :spec
-
-desc "irb loaded with SimplyDB (rubygems not required)"
-task :irb do
-  exec("irb -I lib/ -r 'simplydb' -r 'simplydb/record/base'")
+desc "Run specs"
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = %w{--colour --format progress}
+    t.pattern = 'spec/*_spec.rb'
+  end
 end
-task :console => :irb
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "simplydb #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task :default => :spec

data/lib/simplydb.rb

@@ -1,5 +1,4 @@
-require 'rubygems'
-require 'simplydb/extensions'
 require 'simplydb/error'
+require 'simplydb/interface'
 require 'simplydb/client'
-require 'simplydb/interface'
+require 'simplydb/server'

data/lib/simplydb/client.rb

@@ -1,66 +1,79 @@
 require 'openssl'
 require 'digest/sha1'
 require 'base64'
-require 'uri'
-require 'simplydb/clients/typhoeus'
+require 'rest_client'
 
 module SimplyDB
   class Client
-    include SimplyDB::Extensions
-    
-    attr_accessor :options, :http_client
-    
-    def initialize(options = {})
-      @options = {
-        :async => false,
-        :protocol => 'https://',
-        :host => 'sdb.amazonaws.com',
-        :port => 443,
-        :path => "/",
-        :signature_version => '2',
-        :version => '2009-04-15',
-        :signature_method => 'HmacSHA256',
-      }.merge(options)
-      @http_client = (@options[:client] || SimplyDB::Clients::Typhoeus).new(options)
-    end
-    
-    def async?
-      return options[:async] == true
-    end
-    
-    def base_url
-      "#{@options[:protocol]}#{@options[:host]}:#{@options[:port]}#{@options[:path]}"
-    end
-    
-    def string_to_sign(method, params)
-      return "#{method.to_s.upcase}\n#{options[:host]}\n/\n" + escape_hash(params)
-    end
-    
-    def generate_signature(method, params)
-      Base64.encode64(
-        OpenSSL::HMAC.digest(
-          OpenSSL::Digest::Digest.new('sha256'),
-          @options[:secret_key],
-          string_to_sign(method, params)
-        )
-      ).chomp
-    end
-    
-    def params_with_signature(method, params)
-      params.merge!({
-        'AWSAccessKeyId' => @options[:access_key],
-        'SignatureVersion' => @options[:signature_version],
-        'Timestamp' => Time.now.iso8601,
-        'Version' => @options[:version],
-        'SignatureMethod' => @options[:signature_method]
-      })
-      params['Signature'] = generate_signature(method, params)
-      return params
-    end
-    
-    def call(method, params ={}, &on_complete)
-      options = {:method => method, :url => base_url, :params => params_with_signature(method, params)}
-      @http_client.request(options, !async?) {|request| on_complete.call(request.body)}
+      attr_accessor :options, :http_client
+
+      def initialize(options = {})
+        @options = {
+          :protocol => 'https://',
+          :host => 'sdb.amazonaws.com',
+          :port => 443,
+          :path => "/",
+          :signature_version => '2',
+          :version => '2009-04-15',
+          :signature_method => 'HmacSHA256',
+        }.merge(options)
+      end
+
+      def base_url
+        "#{@options[:protocol]}#{@options[:host]}:#{@options[:port]}#{@options[:path]}"
+      end
+
+      def string_to_sign(method, params)
+        return "#{method.to_s.upcase}\n#{options[:host]}\n/\n" + escape_hash(params)
+      end
+
+      def generate_signature(method, params)
+        Base64.encode64(
+          OpenSSL::HMAC.digest(
+            OpenSSL::Digest::Digest.new('sha256'),
+            @options[:secret_key],
+            string_to_sign(method, params)
+          )
+        ).chomp
+      end
+
+      def params_with_signature(method, params)
+        params.merge!({
+          'AWSAccessKeyId' => @options[:access_key],
+          'SignatureVersion' => @options[:signature_version],
+          'Timestamp' => Time.now.iso8601,
+          'Version' => @options[:version],
+          'SignatureMethod' => @options[:signature_method]
+        })
+        params['Signature'] = generate_signature(method, params)
+        params
+      end
+
+      def call(method, params, &block)
+        params = params_with_signature(method, params)
+        response = case method.to_sym
+#          when :get
+#            RestClient.get(base_url << "?#{escape_hash(params)}")
+          when :post
+            RestClient.post(base_url, params)
+          else
+            raise "Not support request method #{method}"
+                   end
+        block.call(response.body)
+      rescue RestClient::BadRequest => e
+        block.call(e.response.body)
+      end
+      
+      private
+      
+      def escape_value(string)
+        string.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+          '%' + $1.unpack('H2' * $1.size).join('%').upcase
+        end.gsub(' ', '%20')
+      end
+
+      def escape_hash(params = {})
+        return params.collect{|k,v| [k.to_s, v.to_s]}.sort.collect { |key, value| [escape_value(key), escape_value(value)].join('=') }.join('&')
+      end
     end
-  end
 end

data/lib/simplydb/error.rb

@@ -1,60 +1,65 @@
 module SimplyDB
-  module Error
-    # ref http://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/APIError.html
-    class AccessFailure < RuntimeError; end
-    class AttributeDoesNotExist < RuntimeError; end
-    class AuthFailure < RuntimeError; end
-    class AuthMissingFailure < RuntimeError; end
-    class ConditionalCheckFailed < RuntimeError; end
-    class ExistsAndExpectedValue < RuntimeError; end
-    class FeatureDeprecated < RuntimeError; end
-    class IncompleteExpectedExpression < RuntimeError; end
-    class InternalError < RuntimeError; end
-    class InvalidAction < RuntimeError; end
-    class InvalidHTTPAuthHeader < RuntimeError; end
-    class InvalidHttpRequest < RuntimeError; end
-    class InvalidLiteral < RuntimeError; end
-    class InvalidNextToken < RuntimeError; end
-    class InvalidNumberPredicates < RuntimeError; end
-    class InvalidNumberValueTests < RuntimeError; end
-    class InvalidParameterCombination < RuntimeError; end
-    class InvalidParameterValue < RuntimeError; end
-    class InvalidQueryExpression < RuntimeError; end
-    class InvalidResponseGroups < RuntimeError; end
-    class InvalidService < RuntimeError; end
-    class InvalidSOAPRequest < RuntimeError; end
-    class InvalidSortExpression < RuntimeError; end
-    class InvalidURI < RuntimeError; end
-    class InvalidWSAddressingProperty < RuntimeError; end
-    class InvalidWSDLVersion < RuntimeError; end
-    class MalformedSOAPSignature < RuntimeError; end
-    class MissingAction < RuntimeError; end
-    class MissingParameter < RuntimeError; end
-    class MissingWSAddressingProperty < RuntimeError; end
-    class MultipleExistsConditions < RuntimeError; end
-    class MultipleExpectedNames < RuntimeError; end
-    class MultipleExpectedValues < RuntimeError; end
-    class MultiValuedAttribute < RuntimeError; end
-    class NoSuchDomain < RuntimeError; end
-    class NoSuchVersion < RuntimeError; end
-    class NotYetImplemented < RuntimeError; end
-    class NumberDomainsExceeded < RuntimeError; end
-    class NumberDomainAttributesExceeded < RuntimeError; end
-    class NumberDomainBytesExceeded < RuntimeError; end
-    class NumberItemAttributesExceeded < RuntimeError; end
-    class NumberSubmittedAttributesExceeded < RuntimeError; end
-    class NumberSubmittedItemsExceeded < RuntimeError; end
-    class RequestExpired < RuntimeError; end
-    class RequestTimeout < RuntimeError; end
-    class ServiceUnavailable < RuntimeError; end
-    class TooManyRequestedAttributes < RuntimeError; end
-    class UnsupportedHttpVerb < RuntimeError; end
-    class UnsupportedNextToken < RuntimeError; end
-    class URITooLong < RuntimeError; end
-  
-    #Standard AWS errors
-    class SignatureDoesNotMatch < RuntimeError; end
-    class InvalidClientTokenId < RuntimeError; end
-    class InvalidRequest < RuntimeError; end
+  class Error < RuntimeError
+    attr_accessor :http_status_code, :name
+    def initialize(name, http_status_code)
+      @name = name
+      @http_status_code = http_status_code
+    end  
   end
+  
+  AccessFailure = Error.new("AccessFailure",403)
+  AttributeDoesNotExist = Error.new("AttributeDoesNotExist",404)
+  AuthFailure = Error.new("AuthFailure",403)
+  AuthMissingFailure = Error.new("AuthMissingFailure",403)
+  ConditionalCheckFailed = Error.new("ConditionalCheckFailed",409)
+  ExistsAndExpectedValue = Error.new("ExistsAndExpectedValue",400)
+  FeatureDeprecated = Error.new("FeatureDeprecated",400)
+  IncompleteExpectedExpression = Error.new("IncompleteExpectedExpression",400)
+  InternalError = Error.new("InternalError",500)
+  InvalidAction = Error.new("InvalidAction",400)
+  InvalidHTTPAuthHeader = Error.new("InvalidHTTPAuthHeader",400)
+  InvalidHttpRequest = Error.new("InvalidHttpRequest",400)
+  InvalidLiteral = Error.new("InvalidLiteral",400)
+  InvalidNextToken = Error.new("InvalidNextToken",400)
+  InvalidNumberPredicates = Error.new("InvalidNumberPredicates",400)
+  InvalidNumberValueTests = Error.new("InvalidNumberValueTests",400)
+  InvalidParameterCombination = Error.new("InvalidParameterCombination",400)
+  InvalidParameterValue = Error.new("InvalidParameterValue",400)
+  InvalidQueryExpression = Error.new("InvalidQueryExpression",400)
+  InvalidResponseGroups = Error.new("InvalidResponseGroups",400)
+  InvalidService = Error.new("InvalidService",400)
+  InvalidSOAPRequest = Error.new("InvalidSOAPRequest",400)
+  InvalidSortExpression = Error.new("InvalidSortExpression",400)
+  InvalidURI = Error.new("InvalidURI",400)
+  InvalidWSAddressingProperty = Error.new("InvalidWSAddressingProperty",400)
+  InvalidWSDLVersion = Error.new("InvalidWSDLVersion",400)
+  MalformedSOAPSignature = Error.new("MalformedSOAPSignature",403)
+  MissingAction = Error.new("MissingAction",400)
+  MissingParameter = Error.new("MissingParameter",400)
+  MissingWSAddressingProperty = Error.new("MissingWSAddressingProperty",400)
+  MultipleExistsConditions = Error.new("MultipleExistsConditions",400)
+  MultipleExpectedNames = Error.new("MultipleExpectedNames",400)
+  MultipleExpectedValues = Error.new("MultipleExpectedValues",400)
+  MultiValuedAttribute = Error.new("MultiValuedAttribute",409)
+  NoSuchDomain = Error.new("NoSuchDomain",400)
+  NoSuchVersion = Error.new("NoSuchVersion",400)
+  NotYetImplemented = Error.new("NotYetImplemented",401)
+  NumberDomainsExceeded = Error.new("NumberDomainsExceeded",409)
+  NumberDomainAttributesExceeded = Error.new("NumberDomainAttributesExceeded",409)
+  NumberDomainBytesExceeded = Error.new("NumberDomainBytesExceeded",409)
+  NumberItemAttributesExceeded = Error.new("NumberItemAttributesExceeded",409)
+  NumberSubmittedAttributesExceeded = Error.new("NumberSubmittedAttributesExceeded",409)
+  NumberSubmittedItemsExceeded = Error.new("NumberSubmittedItemsExceeded",409)
+  RequestExpired = Error.new("RequestExpired",400)
+  RequestTimeout = Error.new("RequestTimeout",408)
+  ServiceUnavailable = Error.new("ServiceUnavailable",503)
+  TooManyRequestedAttributes = Error.new("TooManyRequestedAttributes",400)
+  UnsupportedHttpVerb = Error.new("UnsupportedHttpVerb",400)
+  UnsupportedNextToken = Error.new("UnsupportedNextToken",400)
+  URITooLong = Error.new("URITooLong",400)
+
+  #Standard AWS errors
+  SignatureDoesNotMatch = Error.new("SignatureDoesNotMatch",400)
+  InvalidClientTokenId = Error.new("InvalidClientTokenId",400)
+  InvalidRequest = Error.new("InvalidRequest",400)
 end

data/lib/simplydb/interface.rb

@@ -7,43 +7,35 @@ module SimplyDB
       @options = {}.merge(options)
       @client = SimplyDB::Client.new(options)
     end
-    
-    def create_domain(name, &block)
+
+    def create_domain(name)
       call({'Action' => 'CreateDomain', 'DomainName' => name}) do |doc|
-        ret_val = doc.css("CreateDomainResponse").length > 0
-        block.call(ret_val) if block_given?
-        ret_val
+        doc.css("CreateDomainResponse").length > 0
       end
     end
-    
-    def delete_domain(name, &block)
+
+    def delete_domain(name)
       call({'Action' => 'DeleteDomain', 'DomainName' => name}) do |doc|
-        ret_val = doc.css("DeleteDomainResponse").length > 0
-        block.call(ret_val) if block_given?
-        ret_val
+        doc.css("DeleteDomainResponse").length > 0
       end
     end
-    
-    def list_domains(&block)
+
+    def list_domains
       call({'Action' => 'ListDomains'}) do |doc|
-        domains = doc.css('DomainName').collect{|d| d.text}
-        block.call(domains) if block_given?
-        domains
+        doc.css('DomainName').collect{|d| d.text}
       end
     end
-    
-    def domain_metadata(name, &block)
+
+    def domain_metadata(name)
       call({'Action' => 'DomainMetadata','DomainName' => name}) do |doc|
-        attributes = doc.css("DomainMetadataResult").first.children.inject({}) do |memo, child|
+        doc.css("DomainMetadataResult").first.children.inject({}) do |memo, child|
           memo[child.name] = child.text
           memo
         end
-        block.call(attributes) if block_given?
-        attributes
       end
     end
-    
-    def put_attributes(name, id, attributes = {}, expected = {}, replace = false, &block)
+
+    def put_attributes(name, id, attributes = {}, expected = {}, replace = false)
       params = define_attributes(attributes, expected, replace)
       params.merge!({
         'DomainName' => name,
@@ -51,13 +43,11 @@ module SimplyDB
         'Action' => 'PutAttributes'
       })
       call(params) do |doc|
-        ret_val = doc.css("PutAttributesResponse").length > 0
-        block.call(ret_val) if block_given?
-        ret_val
+        doc.css("PutAttributesResponse").length > 0
       end
     end
-    
-    def batch_put_attributes(name, items = {}, &block)
+
+    def batch_put_attributes(name, items = {})
       params = {'DomainName' => name, 'ActionName' => 'BatchPutAttributes'}
       items.keys.each_with_index do |key, i|
         params["Item.#{i}.ItemName"] = key
@@ -72,13 +62,11 @@ module SimplyDB
         end
       end
       call(params) do |doc|
-        ret_val = doc.css("BatchPutAttributesResponse").length > 0
-        block.call(ret_val) if block_given?
-        ret_val
+        doc.css("BatchPutAttributesResponse").length > 0
       end
     end
-    
-    def delete_attributes(name, id, attributes = {}, expected = {}, &block)
+
+    def delete_attributes(name, id, attributes = {}, expected = {})
       params = define_attributes(attributes, expected)
       params.merge!({
         'DomainName' => name,
@@ -86,23 +74,21 @@ module SimplyDB
         'Action' => 'DeleteAttributes'
       })
       call(params) do |doc|
-        ret_val = doc.css("DeleteAttributesResponse").length > 0
-        block.call(ret_val) if block_given?
-        ret_val
+        doc.css("DeleteAttributesResponse").length > 0
       end
     end
-    
-    def get_attributes(name, id, wanted_attributes = [], consistent_read = false, &block)
+
+    def get_attributes(name, id, wanted_attributes = [], consistent_read = false)
       params = {
         'Action' => 'GetAttributes',
         'DomainName' => name,
         'ItemName' => id,
-        'ConsistentRead' => consistent_read.to_s, 
+        'ConsistentRead' => consistent_read.to_s,
       }
       wanted_attributes.each_with_index {|name, index| params["AttributeName.#{index}"] = name}
 
       call(params) do |doc|
-        attributes = doc.css("Attribute").inject({}) do |memo, attribute|
+        doc.css("Attribute").inject({}) do |memo, attribute|
           name = attribute.css("Name").first.text
           value = attribute.css("Value").first.text
           if memo.has_key?(name)
@@ -113,12 +99,10 @@ module SimplyDB
           end
           memo
         end
-        block.call(attributes) if block_given?
-        attributes
       end
     end
-    
-    def select(expression, consistent_read = false, next_token = nil, &block)
+
+    def select(expression, consistent_read = false, next_token = nil)
       params = {
         'Action' => 'Select',
         'SelectExpression' => expression,
@@ -126,9 +110,9 @@ module SimplyDB
       }
       params['NextToken'] = next_token unless next_token.nil?
       call(params) do |doc|
-        ret_val = doc.css("SelectResponse SelectResult Item").inject({}) do |items, item|
-          item_name = item.css("Name").first.text
-          items[item_name] = item.css("Attribute").inject({}) do |attributes, attribute|
+        doc.css("SelectResponse SelectResult Item").collect do |element|
+          item_name = element.css("Name").first.text
+          item = element.css("Attribute").inject({}) do |attributes, attribute|
             attribute_name = attribute.css("Name").first.text
             attribute_value = attribute.css("Value").first.text
             if attributes.has_key?(attribute_name)
@@ -139,13 +123,11 @@ module SimplyDB
             end
             attributes
           end
-          items
+          {item_name => item}
         end
-        block.call(ret_val) if block_given?
-        ret_val
       end
     end
-    
+
     private
       def define_attributes(attributes = {}, expected = {}, replace = false)
         params = {}
@@ -154,7 +136,7 @@ module SimplyDB
           v.each do |value|
             params["Attribute.#{index}.Name"] = k
             params["Attribute.#{index}.Value"] = value
-            params["Attribute.#{index}.Replace"] = "1" if replace
+            params["Attribute.#{index}.Replace"] = "true" if replace
             index += 1
           end
           index
@@ -178,9 +160,9 @@ module SimplyDB
           end
           index
         }
-        return params
+        params
       end
-      
+
       def call(params = {}, attempts = 3, &block)
         @client.call(:post, params) do |body|
           begin
@@ -194,7 +176,7 @@ module SimplyDB
               @next_token = doc.css("NextToken").first.text unless doc.css("NextToken").empty?
               block.call(doc)
             end
-          rescue SimplyDB::Error::ServiceUnavailable => e
+          rescue SimplyDB::Error::ServiceUnavailable, RestClient::ServiceUnavailable => e
             if attempts > 0
               call(params, attempts - 1, &block)
             else