simple_record 1.1.72 → 1.2.0

data/README.markdown

@@ -2,17 +2,11 @@
 
 An ActiveRecord interface for SimpleDB.  Can be used as a drop in replacement for ActiveRecord in rails.
 
-## Full Documentation
-
-[http://sites.appoxy.com/simple_record/]
+Brought to you by: [![Appoxy](http://www.simpledeployr.com/images/global/appoxy-small.png)](http://www.appoxy.com)
 
 ## Discussion Group
 
-[http://groups.google.com/group/simple-record]
-
-## Issue Tracking
-
-[http://appoxy.lighthouseapp.com/projects/38366-simplerecord/overview]
+<http://groups.google.com/group/simple-record>
 
 ## Getting Started
 
@@ -130,6 +124,14 @@ but this should get you started.
 You can get more ideas from here: http://api.rubyonrails.org/classes/ActiveRecord/Base.html. Not everything is supported
 but a lot is.
 
+### Pagination
+
+SimpleRecord has paging built in and acts much like will_paginate:
+
+    MyModel.paginate(:page=>2, :per_page=>30 [, the other normal query options like in find()])
+
+That will return results 30 to 59.
+
 ## Configuration
 
 ### Domain Prefix
@@ -235,6 +237,30 @@ You can use any cache that supports the ActiveSupport::Cache::Store interface.
 If you want a simple in memory cache store, try: http://gemcutter.org/gems/local_cache . It supports max cache size and
 timeouts. You can also use memcached or http://www.quetzall.com/cloudcache.
 
+## Encryption
+
+SimpleRecord has built in support for encrypting attributes with AES-256 encryption and one way hashing using SHA-512 (good for passwords).  And it's easy to use.
+
+Here is an example of a model with an encrypted attribute and a hashed attribute.
+
+    class ModelWithEnc < SimpleRecord::Base
+        has_strings :name,
+                    {:name=>:ssn, :encrypted=>"simple_record_test_key"},
+                    {:name=>:password, :hashed=>true}
+    end
+
+The :encrypted option takes a key that you specify. The attribute can only be decrypted with the exact same key.
+
+The :hashed option is simply true/false.
+
+Encryption is generally transparent to you, SimpleRecord will store the encrypted value in the database and unencrypt it when you use it.
+
+Hashing is not quite as transparent as it cannot be converted back to it's original value, but you can do easy comparisons with it, for instance:
+
+ob2.password == "mypassword"
+
+This will actually be compared by hashing "mypassword" first.
+
 ## Kudos
 
 Special thanks to Garrett Cox for creating Activerecord2sdb which SimpleRecord is based on:

data/lib/simple_record/exceptions.rb

@@ -0,0 +1,6 @@
+module SimpleRecord
+
+    class RecordNotSaved < StandardError
+
+    end
+end

data/lib/simple_record/translations.rb

@@ -18,9 +18,9 @@ module SimpleRecord
             att_meta = defined_attributes_local[name.to_sym]
 
             if att_meta.type == :int
-                ret = Translations.pad_and_offset(value)
+                ret = Translations.pad_and_offset(value, att_meta)
             elsif att_meta.type == :date
-                ret = Translations.pad_and_offset(value)
+                ret = Translations.pad_and_offset(value, att_meta)
             else
                 ret = value.to_s
             end
@@ -104,7 +104,7 @@ module SimpleRecord
         end
 
 
-        def self.pad_and_offset(x) # Change name to something more appropriate like ruby_to_sdb
+        def self.pad_and_offset(x, att_meta=nil) # Change name to something more appropriate like ruby_to_sdb
             # todo: add Float, etc
             #    puts 'padding=' + x.class.name + " -- " + x.inspect
             if x.kind_of? Integer

data/lib/simple_record.rb

@@ -27,9 +27,10 @@
 require 'aws'
 require 'sdb/active_sdb'
 require 'base64'
-require File.expand_path(File.dirname(__FILE__) + "/simple_record/encryptor")
-require File.expand_path(File.dirname(__FILE__) + "/simple_record/callbacks")
 require File.expand_path(File.dirname(__FILE__) + "/simple_record/attributes")
+require File.expand_path(File.dirname(__FILE__) + "/simple_record/callbacks")
+require File.expand_path(File.dirname(__FILE__) + "/simple_record/encryptor")
+require File.expand_path(File.dirname(__FILE__) + "/simple_record/exceptions")
 require File.expand_path(File.dirname(__FILE__) + "/simple_record/errors")
 require File.expand_path(File.dirname(__FILE__) + "/simple_record/password")
 require File.expand_path(File.dirname(__FILE__) + "/simple_record/results_array")
@@ -41,6 +42,15 @@ module SimpleRecord
 
     @@options = {}
     @@stats = SimpleRecord::Stats.new
+    @@logging = false
+
+    def self.enable_logging
+        @@logging = true
+    end
+
+    def self.disable_logging
+        @@logging = false
+    end
 
     def self.stats
         @@stats
@@ -83,6 +93,13 @@ module SimpleRecord
         extend SimpleRecord::Attributes
         include SimpleRecord::Callbacks
 
+        # Too many ActiveRecord dependencies.
+#        if Gem.available?('will_paginate')
+#            require 'will_paginate/finder'
+#            include WillPaginate::Finder
+#        end
+        
+
 
         def initialize(attrs={})
             # todo: Need to deal with objects passed in. iterate through belongs_to perhaps and if in attrs, set the objects id rather than the object itself
@@ -374,6 +391,10 @@ module SimpleRecord
             end
         end
 
+        def save!(options={})
+            save(options) || raise(RecordNotSaved)
+        end
+
         def save_with_validation!(options={})
             if valid?
                 save
@@ -429,24 +450,6 @@ module SimpleRecord
             ok
         end
 
-        def save_attributes(atts)
-#            puts 'atts=' + atts.inspect
-            ret = super(atts)
-#            puts '@atts=' + @attributes.inspect
-            atts.each_pair do |k, v|
-                @attributes[k.to_s] = v
-                if k.is_a?(Symbol)
-                    @attributes.delete(k)
-                end
-            end
-#            puts '@atts2=' + @attributes.inspect
-            @attributes_rb = {} unless @attributes_rb # was getting errors after upgrade.
-            @attributes_rb.clear # clear out the ruby versions so they can reload on next get.
-            if ret
-                self.class.cache_results(self)
-            end
-            ret
-        end
 
         def get_atts_to_delete
             # todo: this should use the @dirty hash now
@@ -570,8 +573,8 @@ module SimpleRecord
                     attvalue = value.nil? ? nil : value.id
                 else
                     attname = name.to_s
-#                    attvalue = att_meta.init_value(value)
-                  attvalue = value
+                    attvalue = att_meta.init_value(value)
+#                  attvalue = value
                     #puts 'converted ' + value.inspect + ' to ' + attvalue.inspect
                 end
             end
@@ -603,10 +606,18 @@ module SimpleRecord
             super()
         end
 
+
         def update_attributes(atts)
-            return save_attributes(atts)
+            set_attributes(atts)
+            save
+        end
+
+        def update_attributes!(atts)
+            set_attributes(atts)
+            save!
         end
 
+
         def self.quote_regexp(a, re)
             a =~ re
             #was there a match?
@@ -690,6 +701,50 @@ module SimpleRecord
             return find(*params)
         end
 
+        def self.all(*args)
+            find(:all, *args)
+        end
+
+        def self.first(*args)
+            find(:first, *args)
+        end
+
+        def self.count(*args)
+            find(:count, *args)
+        end
+
+        # This gets less and less efficient the higher the page since SimpleDB has no way
+        # to start at a specific row. So it will iterate from the first record and pull out the specific pages.
+        def self.paginate(options={})
+#            options = args.pop
+            puts 'paginate options=' + options.inspect if @@logging
+            page     = options[:page] || 1
+            per_page = options[:per_page] || self.per_page || 50
+            total    = options[:total_entries]
+            options[:limit] = page * per_page
+            fr = find(:all, options)
+            puts 'fr.size=' + fr.size.to_s
+            ret = []
+            i = 0
+            p = 1
+            fr.each do |x|
+#                puts 'x=' + x.inspect
+                if p == page
+#                    puts 'adding'
+                    ret << x
+                end
+                i += 1
+                if i > 0 && i % per_page == 0
+                    p += 1
+                    if p > page
+                        break
+                    end
+                end
+            end
+            ret
+        end
+
+
         def self.convert_condition_params(options)
             return if options.nil?
             conditions = options[:conditions]
@@ -759,6 +814,13 @@ module SimpleRecord
             id.hash
         end
 
+        private
+        def set_attributes(atts)
+            atts.each_pair do |k, v|
+                set(k, v)
+            end
+        end
+
     end
 
 

data/test/my_base_model.rb

@@ -1,8 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + "/../lib/simple_record")
-
-class MyBaseModel < SimpleRecord::Base
-
-    has_strings :base_string
-
-    
+require File.expand_path(File.dirname(__FILE__) + "/../lib/simple_record")
+
+class MyBaseModel < SimpleRecord::Base
+
+    has_strings :base_string
+
+    
 end

data/test/my_child_model.rb

@@ -1,35 +1,35 @@
-require File.expand_path(File.dirname(__FILE__) + "/../lib/simple_record")
-require 'my_model'
-
-class MyChildModel < SimpleRecord::Base
-    belongs_to :my_model
-    belongs_to :x, :class_name=>"MyModel"
-    has_attributes :name, :child_attr
-
-end
-
-
-=begin
-
-
-puts 'word'
-
-mm = MyModel.new
-puts 'word2'
-
-mcm = MyChildModel.new
-
-puts 'mcm instance methods=' + MyChildModel.instance_methods(true).inspect
-#puts 'mcm=' + mcm.instance_methods(false)
-puts 'mcm class vars = ' + mcm.class.class_variables.inspect
-puts mcm.class == MyChildModel
-puts 'saved? ' + mm.save.to_s
-puts mm.errors.inspect
-
-puts "mm attributes=" + MyModel.defined_attributes.inspect
-puts "mcm attributes=" + MyChildModel.defined_attributes.inspect
-
-mcm2 = MyChildModel.new
-puts "mcm2 attributes=" + MyChildModel.defined_attributes.inspect
-
-=end
+require File.expand_path(File.dirname(__FILE__) + "/../lib/simple_record")
+require 'my_model'
+
+class MyChildModel < SimpleRecord::Base
+    belongs_to :my_model
+    belongs_to :x, :class_name=>"MyModel"
+    has_attributes :name, :child_attr
+
+end
+
+
+=begin
+
+
+puts 'word'
+
+mm = MyModel.new
+puts 'word2'
+
+mcm = MyChildModel.new
+
+puts 'mcm instance methods=' + MyChildModel.instance_methods(true).inspect
+#puts 'mcm=' + mcm.instance_methods(false)
+puts 'mcm class vars = ' + mcm.class.class_variables.inspect
+puts mcm.class == MyChildModel
+puts 'saved? ' + mm.save.to_s
+puts mm.errors.inspect
+
+puts "mm attributes=" + MyModel.defined_attributes.inspect
+puts "mcm attributes=" + MyChildModel.defined_attributes.inspect
+
+mcm2 = MyChildModel.new
+puts "mcm2 attributes=" + MyChildModel.defined_attributes.inspect
+
+=end

data/test/my_model.rb

@@ -19,13 +19,13 @@ class MyModel < MyBaseModel
     end
 
     def bump_save_count
-        puts 'save_count=' + save_count.to_s
+#        puts 'save_count=' + save_count.to_s
         if save_count.nil?
             self.save_count = 1
         else
             self.save_count += 1
         end
-         puts 'save_count=' + self.save_count.to_s
+#         puts 'save_count=' + self.save_count.to_s
     end
 
     def validate
@@ -37,7 +37,7 @@ class MyModel < MyBaseModel
     end
 
     def validate_on_update
-        puts 'save_count = ' + save_count.to_s
+#        puts 'save_count = ' + save_count.to_s
         errors.add("save_count", "should not be zero.") if save_count.blank? || save_count == 0
     end
 

data/test/paging_array_test.rb

@@ -1,15 +1,15 @@
-
-require File.expand_path(File.dirname(__FILE__) + "/../lib/results_array")
-
-array = SimpleRecord::ResultsArray.new()
-#array.extend(ResultsArray)
-
-500.times do |i|
-    array << "_ob_" + i.to_s
-end
-
-array.each do |v|
-    puts v.to_s
-end
-
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/results_array")
+
+array = SimpleRecord::ResultsArray.new()
+#array.extend(ResultsArray)
+
+500.times do |i|
+    array << "_ob_" + i.to_s
+end
+
+array.each do |v|
+    puts v.to_s
+end
+
 puts array[10]

data/test/test_base.rb

@@ -32,4 +32,19 @@ class TestBase < Test::Unit::TestCase
 
     end
 
+
+    # Use to populate db
+    def create_my_models(count)
+        batch = []
+        count.times do |i|
+            mm = MyModel.new(:name=>"model_" + i.to_s)
+            batch << mm
+        end
+        MyModel.batch_save batch
+
+        sleep 2
+
+    end
+
+
 end

data/test/test_marshalled.rb

@@ -0,0 +1,43 @@
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/simple_record")
+require "yaml"
+require 'aws'
+require 'my_model'
+require 'my_child_model'
+require 'active_support'
+require 'test_base'
+
+
+class Person < SimpleRecord::Base
+    has_strings :name, :i_as_s
+    has_ints :age, :i2
+end
+class DirtyTest < TestBase
+
+    def setup
+        super
+
+        Person.create_domain
+        @person = Person.new(:name => 'old', :age => 70)
+        @person.save
+
+        assert !@person.changed?
+        assert !@person.name_changed?
+    end
+
+    def teardown
+        Person.delete_domain
+        SimpleRecord.close_connection
+    end
+
+    def test_string_on_initialize
+        p = Person.new(:name=>"Travis", :age=>5, :i2=>"6")
+        assert p.name == "Travis"
+        assert p.age == 5
+        assert p.i2 == 6, "i2 == #{p.i2}"
+
+        
+    end
+
+end
+

data/test/test_pagination.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), "/../lib/simple_record")
+require File.join(File.dirname(__FILE__), "./test_helpers")
+require File.join(File.dirname(__FILE__), "./test_base")
+require "yaml"
+require 'aws'
+require 'my_model'
+require 'my_child_model'
+require 'model_with_enc'
+require 'active_support'
+
+
+# Pagination is intended to be just like will_paginate.
+class TestPagination < TestBase
+
+    def test_paginate
+        create_my_models(20)
+
+        (1..3).each do |page|
+            models = MyModel.paginate :page=>page, :per_page=>5, :order=>"name"
+            assert models.size == 5
+            models.each do |m|
+                puts m.name
+            end
+        end
+    end
+
+end

data/test/test_simple_record.rb

@@ -354,18 +354,6 @@ class TestSimpleRecord < TestBase
         assert !o.nil?
     end
 
-    # Use to populate db
-    def create_my_models(count)
-        batch = []
-        count.times do |i|
-            mm = MyModel.new(:name=>"model_" + i.to_s)
-            batch << mm
-        end
-        MyModel.batch_save batch
-
-
-    end
-
     def test_objects_in_constructor
         mm = MyModel.new(:name=>"model1")
         mm.save
@@ -586,7 +574,7 @@ class TestSimpleRecord < TestBase
         mm.update_attributes(:name=>"name2", :age=>21, "date2"=>now)
         assert mm.name == "name2", "Name is #{mm.name}"
         assert mm.age == 21
-        assert mm.date2 == now
+        assert mm.date2.to_time.eql?(now), "#{mm.date2.class.name} #{mm.date2.to_time.inspect} != #{now.inspect}"
         sleep 1
 
         mm = MyModel.find(mm.id)
@@ -635,5 +623,48 @@ class TestSimpleRecord < TestBase
         mme = ModelWithEnc.new(:ssn=>nil, :password=>nil)
     end
 
+    def test_string_ints
+        mm = MyModel.new
+        mm.name = "whatever"
+        mm.age = "1"
+        puts mm.inspect
+
+        mm2 = MyModel.new
+        mm2.name = "whatever2"
+        mm2.age = 1
+        params = {:name=>"scooby", :age=>"123"}
+        mm3 = MyModel.new(params)
+
+
+        assert mm.age == 1, "mm.age=#{mm.age}"
+        assert mm2.age == 1
+        assert mm3.age == 123
+
+        mm.save!
+        mm2.save!
+        mm3.save!
+        sleep 1
+
+        assert mm.age == 1
+        assert mm2.age == 1
+        assert mm3.age == 123
+
+        mmf1 = MyModel.find(mm.id)
+        mmf2 = MyModel.find(mm2.id)
+        mmf3 = MyModel.find(mm3.id)
+
+        assert mmf1.age == 1
+        assert mmf2.age == 1
+        assert mmf3.age == 123
+
+        mmf1.update_attributes({:age=>"456"})
+
+        mmf1.age == 456
+
+
+
+
+
+    end
 
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: simple_record
 version: !ruby/object:Gem::Version 
-  version: 1.1.72
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Travis Reeder
@@ -11,19 +16,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-23 00:00:00 -07:00
+date: 2010-05-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aws
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: Drop in replacement for ActiveRecord to Amazon SimpleDB instead.
 email: travis@appoxy.com
 executables: []
@@ -38,6 +45,7 @@ files:
 - lib/simple_record/callbacks.rb
 - lib/simple_record/encryptor.rb
 - lib/simple_record/errors.rb
+- lib/simple_record/exceptions.rb
 - lib/simple_record/password.rb
 - lib/simple_record/results_array.rb
 - lib/simple_record/stats.rb
@@ -56,33 +64,37 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Drop in replacement for ActiveRecord to Amazon SimpleDB instead.
 test_files: 
-- test/test_global_options.rb
-- test/temp_test.rb
-- test/test_dirty.rb
+- test/conversions.rb
 - test/model_with_enc.rb
-- test/test_base.rb
-- test/my_model.rb
 - test/my_base_model.rb
+- test/my_child_model.rb
+- test/my_model.rb
 - test/paging_array_test.rb
-- test/test_simple_record.rb
+- test/temp_test.rb
+- test/test_base.rb
+- test/test_dirty.rb
 - test/test_encodings.rb
+- test/test_global_options.rb
 - test/test_helpers.rb
-- test/my_child_model.rb
+- test/test_marshalled.rb
+- test/test_pagination.rb
 - test/test_results_array.rb
-- test/conversions.rb
+- test/test_simple_record.rb