familia 0.10.2 → 1.0.0.pre.rc2

data/try/20_redis_type_try.rb

@@ -0,0 +1,67 @@
+
+require_relative '../lib/familia'
+require_relative '../lib/familia/features/quantizer'
+require_relative './test_helpers'
+
+#Familia.apiversion = 'v1'
+
+@limiter1 = Limiter.new :requests
+
+
+## Redis Types are unique per instance of a Familia class
+@a = Bone.new 'atoken1', :name1
+@b = Bone.new 'atoken2', :name2
+p [@a.object_id, @b.object_id]
+p [@a.owners.parent.class, @b.owners.parent.class]
+p [@a.owners.parent.object_id, @b.owners.parent.object_id]
+p [@a.owners.rediskey, @b.owners.rediskey]
+p [@a.token, @b.token]
+p [@a.name, @b.name]
+@a.owners.rediskey.eql?(@b.owners.rediskey)
+#=> false
+
+## Redis Types are frozen
+@a.owners.frozen?
+#=> true
+
+
+## Limiter#qstamp
+@limiter1.counter.qstamp(10.minutes, '%H:%M', 1302468980)
+##=> '20:50'
+
+## Redis Types can be stored to quantized stamp suffix
+@limiter1.counter.rediskey
+##=> "v1:limiter:requests:counter:20:50"
+
+## Limiter#qstamp as a number
+@limiter2 = Limiter.new :requests
+@limiter2.counter.qstamp(10.minutes, pattern=nil, now=1302468980)
+##=> 1302468600
+
+## Redis Types can be stored to quantized numeric suffix. This
+## tryouts is disabled b/c `RedisType#rediskey` takes no args
+## and relies on the `class Limiter` definition in test_helpers.rb
+## for the `:quantize` option. The quantized suffix for the Limiter
+## class is `'%H:%M'` so its redis keys will always look like that.
+@limiter2.counter.rediskey
+##=> "v1:limiter:requests:counter:1302468600"
+
+## Increment counter
+@limiter1.counter.clear
+@limiter1.counter.increment
+#=> 1
+
+## Check ttl
+@limiter1.counter.ttl
+#=> 3600.0
+
+## Check ttl for a different instance
+## (this exists to make sure options are cloned for each instance)
+@limiter3 = Limiter.new :requests
+@limiter3.counter.ttl
+#=> 3600.0
+
+## Check realttl
+sleep 1 # Redis ttls are in seconds so we can't wait any less time than this (without mocking)
+@limiter1.counter.realttl
+#=> 3600-1

data/try/{21_redis_object_zset_try.rb → 21_redis_type_zset_try.rb}

@@ -1,5 +1,5 @@
-require 'familia'
-require 'familia/test_helpers'
+require_relative '../lib/familia'
+require_relative './test_helpers'
 
 # Familia.debug = true
 

data/try/{22_redis_object_set_try.rb → 22_redis_type_set_try.rb}

@@ -1,6 +1,6 @@
 
-require 'familia'
-require 'familia/test_helpers'
+require_relative '../lib/familia'
+require_relative './test_helpers'
 
 @a = Bone.new 'atoken', 'akey'
 

data/try/{23_redis_object_list_try.rb → 23_redis_type_list_try.rb}

@@ -1,6 +1,6 @@
 
-require 'familia'
-require 'familia/test_helpers'
+require_relative '../lib/familia'
+require_relative './test_helpers'
 
 @a = Bone.new 'atoken', 'akey'
 

data/try/{24_redis_object_string_try.rb → 24_redis_type_string_try.rb}

@@ -1,13 +1,13 @@
-require 'familia'
-require 'familia/test_helpers'
+require_relative '../lib/familia'
+require_relative './test_helpers'
 
-Familia.apiversion = 'v1'
+#Familia.apiversion = 'v1'
 
 @a = Bone.new 'atoken2', 'akey'
 
 ## Bone#rediskey
 @a.rediskey
-#=> 'v1:bone:atoken2:akey:object'
+#=> 'bone:atoken2:akey:object'
 
 ## Familia::String#value should give default value
 @a.value.value
@@ -39,7 +39,7 @@ Familia.apiversion = 'v1'
 #=> '1000'
 
 ## Familia::String#increment
-@ret.increment 
+@ret.increment
 #=> 1001
 
 ## Familia::String#incrementby
@@ -47,7 +47,7 @@ Familia.apiversion = 'v1'
 #=> 1100
 
 ## Familia::String#decrement
-@ret.decrement 
+@ret.decrement
 #=> 1099
 
 ## Familia::String#decrementby

data/try/{25_redis_object_hash_try.rb → 25_redis_type_hash_try.rb}

@@ -1,5 +1,5 @@
-require 'familia'
-require 'familia/test_helpers'
+require_relative '../lib/familia'
+require_relative './test_helpers'
 
 @a = Bone.new 'atoken', 'akey'
 
@@ -21,7 +21,7 @@ require 'familia/test_helpers'
 @a.props.has_key? 'fieldA'
 #=> true
 
-## Familia::HashKey#all 
+## Familia::HashKey#all
 @a.props.all.class
 #=> Hash
 

data/try/26_redis_bool_try.rb

@@ -1,5 +1,5 @@
-require 'familia'
-require 'familia/test_helpers'
+require_relative '../lib/familia'
+require_relative './test_helpers'
 
 Familia.debug = true
 
@@ -17,10 +17,10 @@ Familia.debug = true
 ## Trying to store a boolean value to a hash key raises an exception
 begin
   @hashkey["test"] = true
-rescue TypeError => e
+rescue Familia::HighRiskFactor => e
   e.message
 end
-#=> "Cannot store test => true (TrueClass) in key"
+#=> "High risk factor for serialization bugs: true<TrueClass>"
 
 ## Boolean values are returned as strings
 @hashkey["test"]
@@ -29,11 +29,15 @@ end
 ## Trying to store a nil value to a hash key raises an exception
 begin
   @hashkey["test"] = nil
-rescue TypeError => e
+rescue Familia::HighRiskFactor => e
   e.message
 end
-#=> "Cannot store test => nil (NilClass) in key"
+#=> "High risk factor for serialization bugs: <NilClass>"
 
 ## The exceptions prevented the hash from being updated
 @hashkey["test"]
 #=> "true"
+
+## Clear the hash key
+@hashkey.clear
+#=> 1

data/try/27_redis_horreum_try.rb

@@ -0,0 +1,93 @@
+require_relative '../lib/familia'
+require_relative './test_helpers'
+
+Familia.debug = true
+
+@identifier = 'tryouts-27@onetimesecret.com'
+@customer = Customer.new @identifier
+@hashkey = Familia::HashKey.new 'tryouts-27'
+
+## Customer passed as value is returned as string identifier, on assignment as string
+@hashkey["test1"] = @customer.identifier
+#=> @identifier
+
+## Customer passed as value is returned as string identifier
+@hashkey["test1"]
+#=> @identifier
+
+## Trying to store a customer to a hash key implicitly converts it to string identifier
+## we can't tell from the return value this way either. Here the store method return value
+## is either 1 (if the key is new) or 0 (if the key already exists).
+@hashkey.store "test2", @customer
+#=> 1
+
+## Trying to store a customer to a hash key implicitly converts it to string identifier
+## but we can't tell that from the return value. Here the hash syntax return value
+## is the value that is being assigned.
+@hashkey["test2"] = @customer
+#=> @customer
+
+## Trying store again with the same key returns 0
+@hashkey.store "test2", @customer
+#=> 0
+
+## Customer passed as value is returned as string identifier
+@hashkey["test2"]
+#=> @identifier
+
+## Remove the key
+@hashkey.clear
+#=> 1
+
+## Horreum objects can update and save their fields (1 of 2)
+@customer.name = 'John Doe'
+#=> "John Doe"
+
+## Horreum objects can update and save their fields (2 of 2)
+@customer.save
+#=> true
+
+## Horreum object fields have a fast writer method (1 of 2)
+Familia.trace :LOAD, @customer.redis, @customer.redisuri, caller if Familia.debug?
+@customer.name! 'Jane Doe'
+#=> 0
+
+## Horreum object fields have a fast writer method (2 of 2)
+@customer.refresh!
+@customer.name
+#=> "Jane Doe"
+
+## Unsaved changes are lost when an object reloads
+@customer.name = 'John Doe'
+@customer.refresh!
+@customer.name
+#=> "Jane Doe"
+
+## Horreum objects can be destroyed
+@customer.destroy!
+#=> true
+
+## All horrerum objects have a key field
+@customer.key
+#=> @identifier
+
+## Even ones that didn't define it
+@cd = CustomDomain.new "www.example.com", "@identifier"
+@cd.key
+#=> nil
+
+## We can call #identifier directly if we want to "lasy load" the unique identifier
+@cd.identifier
+#=> "7565befd"
+
+## The #key field will still be nil
+@cd.key
+#=> nil
+
+## But once we save
+@cd.save
+#=> true
+
+## The key will be set
+@cd.key
+#=> "7565befd"

data/try/30_familia_object_try.rb

@@ -1,6 +1,6 @@
-require 'familia'
-require 'familia/test_helpers'
-Familia.apiversion = 'v1'
+require_relative '../lib/familia'
+require_relative './test_helpers'
+#Familia.apiversion = 'v1'
 
 @a = Bone.new 'atoken', 'akey'
 
@@ -8,8 +8,8 @@ Familia.apiversion = 'v1'
 Bone.prefix
 #=> :bone
 
-## Familia#index
-@a.index
+## Familia#identifier
+@a.identifier
 #=> 'atoken:akey'
 
 ## Familia.suffix
@@ -18,32 +18,34 @@ Bone.suffix
 
 ## Familia#rediskey
 @a.rediskey
-#=> 'v1:bone:atoken:akey:object'
+#=> 'bone:atoken:akey:object'
 
 ## Familia#rediskey
 @a.rediskey
-#=> 'v1:bone:atoken:akey:object'
+#=> 'bone:atoken:akey:object'
 
 ## Familia#save
 @cust = Customer.new :delano, "Delano Mandelbaum"
 @cust.save
 #=> true
 
-## Customer.instances
-Customer.instances.all.collect(&:custid)
-#=> [:delano]
+## Customer.values (Updateing this sorted set of instance IDs is a Onetime
+# Secret feature. Disabled here b/c there's no code in Familia or the test
+# helpers that replicates this behaviour.) Leaving this here for reference.
+Customer.values.all.collect(&:custid)
+##=> ['delano']
 
 ## Familia.from_redis
 obj = Customer.from_redis :delano
-obj.custid
-#=> :delano
+[obj.class, obj.custid]
+#=> [Customer, 'delano']
 
 ## Customer.destroy
 @cust.destroy!
-#=> 1
+#=> true
 
 ## Customer.instances
-Customer.instances.size
+Customer.values.size
 #=> 0
 
 ## Familia#save with an object that expires
@@ -57,7 +59,7 @@ Customer.customers.class
 
 ## Familia class rediskey
 Customer.customers.rediskey
-#=> 'v1:customer:customers'
+#=> 'customer:customers'
 
 ## Familia.class_list
 Customer.customers << :delano << :tucker << :morton
@@ -69,19 +71,18 @@ Customer.customers.clear
 #=> 1
 
 
-## Familia class replace 1
+## Familia class replace 1 of 4
 Customer.message.value = "msg1"
 #=> "msg1"
 
-## Familia class replace 2
+## Familia class replace 2 of 4
 Customer.message.value
 #=> "msg1"
 
-## Familia class replace 3
+## Familia class replace 3 of 4
 Customer.message = "msg2"
 #=> "msg2"
 
-## Familia class replace 4
+## Familia class replace 4 of 4
 Customer.message.value
 #=> "msg2"
-

data/try/35_feature_safedump_try.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# These tryouts test the safe dumping functionality.
+
+require_relative '../lib/familia'
+require_relative './test_helpers'
+
+## By default Familia::Base has no safe_dump_fields method
+Familia::Base.respond_to?(:safe_dump_fields)
+#=> false
+
+## Implementing models like Customer can define safe dump fields
+Customer.safe_dump_fields
+#=> [:custid, :role, :verified, :updated, :created, :secrets_created, :active]
+
+## Implementing models like Customer can safely dump their fields
+@cust = Customer.new
+@cust.custid = "test@example.com"
+@cust.role = "user"
+@cust.verified = true
+@cust.created = Time.now.to_i
+@cust.updated = Time.now.to_i
+@safe_dump = @cust.safe_dump
+@safe_dump.keys.sort
+#=> [:active, :created, :custid, :role, :secrets_created, :updated, :verified]
+
+## Implementing models like Customer do have other fields
+## that are by default considered not safe to dump.
+@cust1 = Customer.new
+@cust1.email = "test@example.com"
+
+@all_non_safe_fields = @cust1.instance_variables.map { |el|
+  el.to_s[1..-1].to_sym # slice off the leading @
+}.sort
+
+(@all_non_safe_fields - Customer.safe_dump_fields).sort
+#=> [:custom_domains, :email, :password_reset, :sessions, :stripe_customer, :timeline]
+
+## Implementing models like Customer can rest assured knowing
+## any other field not in the safe list will not be dumped.
+@cust2 = Customer.new
+@cust2.email = "test@example.com"
+@cust2.custid = "test@example.com"
+@all_safe_fields = @cust2.safe_dump.keys.sort
+
+@all_non_safe_fields = @cust2.instance_variables.map { |el|
+  el.to_s[1..-1].to_sym # slice off the leading @
+}.sort
+p [1, all_non_safe_fields: @all_non_safe_fields]
+# Check if any of the non-safe fields are in the safe dump
+(@all_non_safe_fields & @all_safe_fields) - [:custid, :role, :verified, :updated, :created, :secrets_created]
+#=> []
+
+## Bone does not have safe_dump feature enabled
+Bone.respond_to?(:safe_dump_fields)
+#=> false
+
+## Bone instances do not have safe_dump method
+@bone = Bone.new(name: "Rex", age: 3)
+@bone.respond_to?(:safe_dump)
+#=> false
+
+## Blone has safe_dump feature enabled
+Blone.respond_to?(:safe_dump_fields)
+#=> true
+
+## Blone has empty safe_dump_fields
+Blone.safe_dump_fields
+#=> []
+
+## Blone instances have safe_dump method
+@blone = Blone.new(name: "Fido", age: 5)
+@blone.respond_to?(:safe_dump)
+#=> true
+
+## Blone safe_dump returns an empty hash
+@blone.safe_dump
+#=> {}
+
+# Teardown
+@cust2.destroy!
+@bone = nil
+@blone = nil

data/try/40_customer_try.rb

@@ -0,0 +1,140 @@
+# Customer Tryouts
+require_relative '../lib/familia'
+require_relative './test_helpers'
+
+# Setup
+@now = Time.now.to_f
+@customer = Customer.new
+@customer.custid = "test@example.com"
+@customer.email = "test@example.com"
+@customer.role = "user"
+@customer.key = "abc123"
+@customer.planid = "basic"
+@customer.created = Time.now.to_i
+@customer.updated = Time.now.to_i
+
+## Customer can be saved
+@customer.save
+#=> true
+
+## Customer can be retrieved by identifier
+retrieved_customer = Customer.from_redis("test@example.com")
+retrieved_customer.custid
+#=> "test@example.com"
+
+## Customer fields can be accessed
+@customer.email
+#=> "test@example.com"
+
+## Customer role can be set and retrieved
+@customer.role = "admin"
+@customer.role
+#=> "admin"
+
+## Customer can update fields
+@customer.planid = "premium"
+@customer.save
+ident = @customer.identifier
+Customer.from_redis(ident).planid
+#=> "premium"
+
+## Customer can increment secrets_created counter
+@customer.secrets_created.clear
+@customer.secrets_created.increment
+@customer.secrets_created.value
+#=> '1'
+
+## Customer can add custom domain via add method
+@customer.custom_domains.add(@now, "example.org")
+@customer.custom_domains.members.include?("example.org")
+#=> true
+
+## Customer can retrieve custom domain score via score method
+@customer.custom_domains.score("example.org")
+#=> @now
+
+## Customer can add custom domain via []= method
+@customer.custom_domains["example2.org"] = @now
+@customer.custom_domains.members.include?("example2.org")
+#=> true
+
+## Customer can retrieve custom domain score via []
+@customer.custom_domains["example.org"]
+#=> @now
+
+
+## Customer can store timeline
+@customer.timeline["last_login"] = @now
+@customer.timeline["last_login"].to_i.positive?
+#=> true
+
+## Customer can be added to class-level sorted set
+Customer.instances << @customer
+Customer.instances.member?(@customer)
+#=> true
+
+## Customer can be removed from class-level sorted set
+Customer.instances.delete(@customer)
+Customer.instances.member?(@customer)
+#=> false
+
+## Customer can add a session
+@customer.sessions << "session123"
+@customer.sessions.members.include?("session123")
+#=> true
+
+## Customer can set and get password reset information
+@customer.password_reset["token"] = "reset123"
+@customer.password_reset["token"]
+#=> "reset123"
+
+## Customer can be destroyed
+ret = @customer.destroy!
+cust = Customer.from_redis("test@example.com")
+exists = Customer.exists?("test@example.com")
+[ret, cust.nil?, exists]
+#=> [true, true, false]
+
+## Customer.destroy! can be called on an already destroyed object
+@customer.destroy!
+#=> false
+
+## Customer.db returns the correct database number
+Customer.db
+#=> 15
+
+## Customer.db returns the correct database number
+@customer.db
+#=> 15
+
+## @customer.redis.connection returns the correct redis URI
+@customer.redis.connection
+#=> {:host=>"127.0.0.1", :port=>6379, :db=>15, :id=>"redis://127.0.0.1:6379/15", :location=>"127.0.0.1:6379"}
+
+## @customer.redis.uri returns the correct redis URI
+@customer.secrets_created.db
+#=> nil
+
+## @customer.redis.uri returns the correct redis URI
+@customer.secrets_created.redis.connection
+#=> {:host=>"127.0.0.1", :port=>6379, :db=>15, :id=>"redis://127.0.0.1:6379/15", :location=>"127.0.0.1:6379"}
+
+## Customer.url is nil by default
+Customer.uri
+#=> nil
+
+## Customer.destroy! makes only one call to Redis
+RedisCommandCounter.count_commands { @customer.destroy! }
+#=> 1
+
+## Customer.db returns the correct database number
+Customer.instances.db
+#=> nil
+
+## Customer.db returns the correct database number
+Customer.instances.uri.to_s
+#=> 'redis://127.0.0.1/15/'
+
+
+# Teardown
+Customer.instances.clear

data/try/41_customer_safedump_try.rb

@@ -0,0 +1,86 @@
+
+require_relative '../lib/familia'
+require_relative './test_helpers'
+
+# Setup
+@now = Time.now.to_i
+@customer = Customer.new
+@customer.custid = "test@example.com"
+@customer.email = "test@example.com"
+@customer.role = "user"
+@customer.key = "abc123"
+@customer.planid = "basic"
+@customer.created = @now
+@customer.updated = @now
+@customer.verified = true
+@customer.reset_requested = false
+@customer.save
+@safe_dump = @customer.safe_dump
+
+## Customer can be safely dumped
+@safe_dump.keys.sort
+#=> [:active, :created, :custid, :role, :secrets_created, :updated, :verified]
+
+## Safe dump includes correct custid
+@safe_dump[:custid]
+#=> "test@example.com"
+
+## Safe dump includes correct role
+@safe_dump[:role]
+#=> "user"
+
+## Safe dump includes correct verified status
+@safe_dump[:verified]
+#=> true
+
+## Safe dump includes correct created timestamp
+@safe_dump[:created]
+#=> @now
+
+## Safe dump includes correct updated timestamp
+@safe_dump[:updated]
+#=> @now
+
+## Safe dump includes correct secrets_created count
+@customer.secrets_created.increment
+@safe_dump = @customer.safe_dump
+@safe_dump[:secrets_created]
+#=> "2"
+
+## Safe dump includes correct active status when verified and not reset requested
+@safe_dump[:active]
+#=> true
+
+## Safe dump includes correct active status when not verified
+@customer.verified = false
+@customer.save
+@safe_dump = @customer.safe_dump
+@safe_dump[:active]
+#=> false
+
+## Safe dump includes correct active status when reset requested
+@customer.verified = true
+@customer.reset_requested = true
+@customer.save
+@safe_dump = @customer.safe_dump
+@safe_dump[:active]
+#=> false
+
+## Safe dump excludes sensitive information (email)
+@safe_dump.has_key?(:email)
+#=> false
+
+## Safe dump excludes sensitive information (key)
+@safe_dump.has_key?(:key)
+#=> false
+
+## Safe dump excludes sensitive information (passphrase)
+@safe_dump.has_key?(:passphrase)
+#=> false
+
+## Safe dump excludes non-specified fields
+@safe_dump.has_key?(:planid)
+#=> false
+
+# Teardown
+@customer.destroy!