simplydb 0.0.1 → 0.0.2

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/examples/record.rb

@@ -1,4 +1,5 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
 require 'simplydb'
 require 'simplydb/record/base'
 
@@ -9,30 +10,36 @@ SimplyDB::Record::Base.establish_connection({
 
 class MyDomain < SimplyDB::Record::Base; end
 
-MyDomain.create_domain
 
+puts "=== Domain info ==="
+puts "create domain: #{MyDomain.create_domain}"
 puts "domain name: #{MyDomain.domain_name}"
-puts "domain exists?: #{MyDomain.domain_exists?}"
+puts "domain_exists?: #{MyDomain.domain_exists?}"
+
 
-model = MyDomain.new(
-  :name => 'JT Archie',
+puts "\n"
+puts "=== Record info ==="
+
+person = MyDomain.new(
+  :name => 'Joe Smith',
   :age => 27
 )
-puts "attribues: #{model.attributes.inspect}"
-model[:age] = 29
-puts "attribues: #{model.attributes.inspect}"
 
-puts "model.new_record?: #{model.new_record?}"
+person[:age] = 29
+
+puts "person attributes: #{person.attribute_names.inspect}"
+puts "person attributes hash: #{person.attributes.inspect}"
 
-model.item_name = "Testing"
-puts "save: #{model.save}"
+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)
 
-got_model = MyDomain.find('Testing')
-puts "got_model: #{got_model.attributes.inspect}"
+found_person = MyDomain.find("person1")
+puts "found person attributes: #{found_person.attributes.inspect}"
 
-models = MyDomain.find_by_select('SELECT * FROM my_domain')
-puts "models: #{models.inspect}"
+people = MyDomain.find_by_select('SELECT * FROM my_domain')
+puts "people: #{people.inspect}"
 
-#MyDomain.delete_domain
+MyDomain.delete_domain

data/lib/simplydb/record.rb

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

data/lib/simplydb/record/base.rb

@@ -1,4 +1,3 @@
-require 'simplydb'
 require 'simplydb/extensions'
 require 'uuidtools'
 
@@ -6,6 +5,7 @@ module SimplyDB
   module Record
     class MissingItemName < RuntimeError; end
     class ItemNotFound < RuntimeError; end
+    class MissingCredentials < RuntimeError; end
     
     class Base
       include SimplyDB::Extensions
@@ -15,21 +15,31 @@ module SimplyDB
         
         # 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 = {})
-          @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
-          }
+          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))
@@ -104,6 +114,15 @@ module SimplyDB
           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)}
@@ -120,6 +139,10 @@ module SimplyDB
           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)
@@ -213,7 +236,7 @@ module SimplyDB
         @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).
+      # 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)
@@ -226,6 +249,7 @@ module SimplyDB
       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
@@ -238,6 +262,7 @@ module SimplyDB
         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

data/simplydb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simplydb}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["JT Archie"]
-  s.date = %q{2010-06-30}
+  s.date = %q{2010-07-06}
   s.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.}
   s.email = %q{jtarchie@gmail.com}
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "lib/simplydb/error.rb",
      "lib/simplydb/extensions.rb",
      "lib/simplydb/interface.rb",
+     "lib/simplydb/record.rb",
      "lib/simplydb/record/base.rb",
      "simplydb.gemspec",
      "spec/client_spec.rb",

data/spec/record/base_spec.rb

@@ -4,8 +4,9 @@ require 'simplydb/record/base'
 
 describe SimplyDB::Record::Base do
   before do
+    #need to reset the class each time
+    Object.send(:remove_const, :People)  if Object.const_defined?(:People)
     class People < SimplyDB::Record::Base; end
-    People.set_domain_name(nil) #have to reset the domain name each time
     
     @attributes = {
       'name' => 'Joe Smith',
@@ -13,17 +14,32 @@ describe SimplyDB::Record::Base do
     }
   end
 
-  it "should be able to set connection credentials" do
-    People.establish_connection({
-      :access_key => access_key,
-      :secret_key => secret_key,
-      :force => false
-    })
-    People.connection.should == {
-      :access_key => access_key,
-      :secret_key => secret_key,
-      :force => false
-    }
+  describe "setting connection credentials" do
+    it "should be able to set connection credentials" do
+      People.establish_connection({
+        :access_key => access_key,
+        :secret_key => secret_key,
+        :force => false
+      })
+      People.connection.should == {
+        :access_key => access_key,
+        :secret_key => secret_key,
+        :force => false
+      }
+    end
+    it "should inherit from its parent" do
+      SimplyDB::Record::Base.establish_connection({
+        :access_key => access_key,
+        :secret_key => secret_key,
+        :force => true
+      })
+      People.establish_connection
+      People.connection.should == {
+        :access_key => access_key,
+        :secret_key => secret_key,
+        :force => true
+      }
+    end
   end
   
   describe "domain specific functions" do

data/spec/spec_helper.rb

@@ -21,4 +21,4 @@ Spec::Runner.configure do |config|
       yield
     end
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simplydb
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - JT Archie
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-30 00:00:00 -07:00
+date: 2010-07-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,6 +106,7 @@ files:
 - lib/simplydb/error.rb
 - lib/simplydb/extensions.rb
 - lib/simplydb/interface.rb
+- lib/simplydb/record.rb
 - lib/simplydb/record/base.rb
 - simplydb.gemspec
 - spec/client_spec.rb