simplydb 0.0.2 → 0.0.3

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2010 JT Archie
-
-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.rdoc

@@ -1,37 +0,0 @@
-= simplydb
-
-A minimal interface to Amazon SimpleDB that has separation of interfaces. From the low level HTTP request access to high level Ruby abstraction ORM.
-
-  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/VERSION

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

data/examples/interface.rb

@@ -1,19 +0,0 @@
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-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

data/examples/record.rb

@@ -1,45 +0,0 @@
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'simplydb'
-require 'simplydb/record/base'
-
-SimplyDB::Record::Base.establish_connection({
-  'access_key' => ENV['AWS_ACCESS_KEY'],
-  'secret_key' => ENV['AWS_SECRET_KEY']
-})
-
-class MyDomain < SimplyDB::Record::Base; end
-
-
-puts "=== Domain info ==="
-puts "create domain: #{MyDomain.create_domain}"
-puts "domain name: #{MyDomain.domain_name}"
-puts "domain_exists?: #{MyDomain.domain_exists?}"
-
-
-puts "\n"
-puts "=== Record info ==="
-
-person = MyDomain.new(
-  :name => 'Joe Smith',
-  :age => 27
-)
-
-person[:age] = 29
-
-puts "person attributes: #{person.attribute_names.inspect}"
-puts "person attributes hash: #{person.attributes.inspect}"
-
-person.item_name = "person1"
-puts "save: #{person.save}"
-puts "id (item_name): #{person.item_name}"
-
-sleep 2 #let SimpleDB propogate data (not supporting consistant read, yet)
-
-found_person = MyDomain.find("person1")
-puts "found person attributes: #{found_person.attributes.inspect}"
-
-people = MyDomain.find_by_select('SELECT * FROM my_domain')
-puts "people: #{people.inspect}"
-
-MyDomain.delete_domain

data/lib/simplydb/clients/typhoeus.rb

@@ -1,35 +0,0 @@
-require 'typhoeus'
-
-module SimplyDB
-  module Clients
-    class Typhoeus
-      
-      attr_accessor :hydra, :options
-      
-      def initialize(options = {})
-        @options = options
-        @hydra = ::Typhoeus::Hydra.new
-      end
-      
-      def request(options={}, force = true, &block)
-        request = ::Typhoeus::Request.new(options[:url],
-          :method => options[:method],
-          :params => options[:params]
-        )
-        
-        @hydra.queue(request)
-        
-        unless force
-          request.on_complete {|response| block.call(response)}
-        else
-          @hydra.run
-          block.call(request.response)
-        end
-      end
-      
-      def run!
-        @hydra.run
-      end
-    end
-  end
-end

data/lib/simplydb/extensions.rb

@@ -1,21 +0,0 @@
-module SimplyDB
-  module Extensions
-    def underscore(camel_cased_word)
-      camel_cased_word.to_s.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
-    end
-    
-    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

data/lib/simplydb/record.rb

@@ -1,2 +0,0 @@
-require 'simplydb/record/base'
-#require 'simplydb/record/model'

data/lib/simplydb/record/base.rb

@@ -1,282 +0,0 @@
-require 'simplydb/extensions'
-require 'uuidtools'
-
-module SimplyDB
-  module Record
-    class MissingItemName < RuntimeError; end
-    class ItemNotFound < RuntimeError; end
-    class MissingCredentials < RuntimeError; end
-    
-    class Base
-      include SimplyDB::Extensions
-      
-      class << self
-        include SimplyDB::Extensions
-        
-        # This setups up the parameters for the connection for SimpleDB.
-        #
-        # NOTE: connection settings default to parent's settings if not provided
-        # ==== Parameters
-        # +access_key+: AWS access key.
-        # +secret_key+: AWS secret key.
-        # +force+: Force the creation of the domain. (Not yet implemented)
-        def establish_connection(options = {})
-          unless options.empty?
-            @connection = {
-              :access_key => options[:aws_access_key] || options[:access_key] || ENV['AWS_ACCESS_KEY'] || ENV['ACCESS_KEY'],
-              :secret_key => options[:aws_secret_key] || options[:secret_key] || ENV['AWS_SECRET_KEY'] || ENV['SECRET_KEY'],
-              :force => options[:force] == true ? true : false
-            }
-          else
-            @connection ||= superclass.connection
-          end
-          
-          raise MissingCredentials, "Require AWS access key and secret key" if @connection[:access_key].nil? || @connection[:secret_key].nil?
-        end
-        
-        # Returns the connection's paramters.
-        attr_accessor :connection
-        
-        # access to the logger
-        attr_accessor :logger
-        
-        # Returns the interface(+SimplyDB::Interface+) the model uses to communicate with SimpleDB.
-        def interface
-          @interface ||= (establish_connection; SimplyDB::Interface.new(@connection))
-        end
-        
-        # Set the name of the domain to associate the record with. This should be set
-        # to the name as it appears on SimpleDB.
-        # ====Paremeters
-        # +name+: The domain name the model will use when saving data to SimpleDB.
-        def set_domain_name(name)
-          @domain_name = name
-          @domain_name ||= domain_name 
-        end
-        alias_method :domain_name=, :set_domain_name
-        
-        # Return the domain name the model has been assigned. Default is the model
-        # name underscored.
-        #
-        #    Person.domain_name == "person"
-        #    MyDomain.domain_name == "my_domain"
-        def domain_name; @domain_name ||= underscore(name); end
-        
-        # Creates the domain associated with the model based on the +domain_name+.
-        def create_domain
-          return interface.create_domain(domain_name)
-        end
-        
-        # Deletes the domain associated with the model based on the +domain_name+.
-        def delete_domain
-          return interface.delete_domain(domain_name)
-        end
-        
-        # Checks to see if the domain associated with the model exists.
-        def domain_exists?
-          interface.domain_metadata(domain_name)
-          return true
-        rescue SimplyDB::Error::NoSuchDomain => e
-          return false
-        end
-        
-        # Creates an object (or multiple objects) and saves it to the database, if validations pass.
-        # The resulting object is returned whether the object was saved successfully to the database or not.
-        #
-        # The +attributes+ parameter can be either be a Hash or an Array of Hashes.  These Hashes describe the
-        # attributes on the objects that are to be created.
-        #
-        # ==== Examples
-        #   # Create a single new object
-        #   User.create(:first_name => 'Jamie')
-        #
-        #   # Create an Array of new objects
-        #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
-        #
-        #   # Create a single object and pass it into a block to set other attributes.
-        #   User.create(:first_name => 'Jamie') do |u|
-        #     u.is_admin = false
-        #   end
-        #
-        #   # Creating an Array of new objects using a block, where the block is executed for each object:
-        #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
-        #     u.is_admin = false
-        #   end        
-        def create(attributes = {}, &block)
-          if attributes.is_a?(Array)
-            attributes.collect { |attr| create(attr, &block) }
-          else
-            object = new(attributes)
-            yield(object) if block_given?
-            object.item_name ||= attributes.delete(:item_name) || UUIDTools::UUID.random_create #TODO: not depend on UUID
-            object.save
-            return object
-          end
-        end
-        
-        # Find operates with four different retrieval approaches:
-        # * Find by id - This can either be a specific id ("1"), a list of ids ("1", "5", "6"), or an array of ids ([5, 6, 10]). If no record can be found for all of the listed ids, then +ItemNotFound+ will be raised.
-        #
-        # ==== Examples
-        #   # find by id
-        #   Person.find(1)       # returns the object for ID = 1
-        #   Person.find(1, 2, 6) # returns an array for objects with IDs in (1, 2, 6)
-        #   Person.find([7, 17]) # returns an array for objects with IDs in (7, 17)
-        #   Person.find([1])     # returns an array for the object with ID = 1
-        def find(item_names)
-          if item_names.is_a?(Array)
-            return item_names.collect {|item_name| find(item_name)}
-          else
-            attributes = interface.get_attributes(domain_name, item_names)
-            unless attributes.empty?
-              object = new(attributes)
-              object.item_name = item_names
-              object.instance_variable_set('@new_record', false)
-              return object
-            else
-              raise SimplyDB::Record::ItemNotFound
-            end
-          end
-        end
-        
-        # Executes a custom SELECT query against your domain and returns all the results.  The results will
-        # be returned as an array with columns requested encapsulated as attributes of the model you call
-        # this method from.  If you call <tt>Product.find_by_sql</tt> then the results will be returned in
-        # a Product object with the attributes you specified in the SQL query.
-        def find_by_select(statement = nil, consistant_read = false)
-          return [] unless statement
-          items = interface.select(statement, consistant_read)
-          objects = items.collect {|item_name, attributes|
-            object = new(attributes)
-            object.item_name = item_name
-            object.instance_variable_set('@new_record', false)
-            object
-          }
-          return objects
-        end
-      end
-      
-      # New objects can be instantiated with attributes pass as a hash with teh key being the
-      # column name and the value being column value.
-      #
-      # ==== Parameters
-      # +attributes+: A hash of the attributes columns and their values.
-      def initialize(attributes = nil)
-        @attributes = {}
-        @new_record = true
-        @destroyed = false
-        self.attributes = attributes unless attributes.nil?
-      end
-      
-      # Returns true if the record has not been created yet.
-      def new_record?
-        return @new_record
-      end
-      
-      # Returns the value of the attribute identified by <tt>attr_name</tt>.
-      # (Alias for the protected read_attribute method).
-      def [](attribute_name)
-        return read_attribute(attribute_name)
-      end
-      
-      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
-      # (Alias for the protected write_attribute method).
-      def []=(attribute_name, value)
-        write_attribute(attribute_name, value)
-      end
-      
-      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
-      def attributes
-        attrs = {}
-        attribute_names.each { |name| attrs[name] = read_attribute(name) }
-        return attrs
-      end
-      
-      # Allows you to set all the attributes at once by passing in a hash with keys
-      # matching the attribute names (which again matches the column names).
-      def attributes=(new_attributes)
-        return if new_attributes.nil?
-        new_attributes.each do |name, value|
-          if respond_to?(:"#{name}=")
-            send(:"#{name}=", value)
-          else
-            write_attribute(name, value)
-          end
-        end  
-      end
-      
-      # Checks that an attribute has been assigned a value.
-      def has_attribute?(attribute_name)
-        return @attributes.has_key?(attribute_name)
-      end
-      
-      # Returns an array of names for the attributes available on this object sorted alphabetically.
-      def attribute_names
-        return @attributes.keys.sort
-      end
-      
-      # Save the record to SimpleDB. Requires that an <tt>item_name</tt> has been set for the record.
-      def save(replace = false)
-        raise SimplyDB::Record::MissingItemName if item_name.nil? || item_name.empty?
-        if interface.put_attributes(domain_name, item_name, attributes, {}, replace)
-          @new_record = false
-          return true
-        end
-        return false
-      end
-      
-      # Freeze the attributes hash such they are still accessible, even on destroyed records.
-      def freeze
-        @attributes.freeze
-        return self
-      end
-      
-      # Returns +true+ if the attributes hash has been frozen.
-      def frozen?
-        @attributes.frozen?
-      end
-
-      # Deletes the record in the SimpleDB and freezes this instance to reflect that no changes should be made (since they can’t be persisted).
-      def destroy
-        unless new_record?
-          interface.delete_attributes(domain_name, item_name)
-        end
-        
-        @destroyed = true
-        return freeze
-      end
-      
-      def connection; return self.class.connection; end
-      def interface; return self.class.interface; end
-      def domain_name; return self.class.domain_name; end
-      def logger; self.class.logger; end
-      
-      def method_missing(method, *args) #:nodoc:
-        method = method.to_s
-        case method
-          when /=$/
-            return write_attribute(method.sub(/\=$/,''), args[0])
-          else
-            return read_attribute(method) if has_attribute?(method)
-        end
-        raise NoMethodError.new("Could not find method #{method}", method, *args)
-      end
-      
-      # The item name associated with the record. This is the SimpleDB item name.
-      def item_name=(value)
-        @item_name = value.to_s
-      end
-      
-      attr_reader :item_name
-      
-      private
-        def read_attribute(name) #:nodoc:
-          return @attributes[name.to_s]
-        end
-        
-        def write_attribute(name, value) #:nodoc:
-          @attributes[name.to_s] = value.to_s
-        end
-    end
-  end
-end