familia 0.10.2 → 1.0.0.pre.rc1

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!

data/try/test_helpers.rb

@@ -0,0 +1,186 @@
+# rubocop:disable all
+
+require 'digest'
+require_relative '../lib/familia'
+
+# ENV['FAMILIA_TRACE'] = '1'
+#Familia.debug = true
+Familia.enable_redis_logging = true
+Familia.enable_redis_counter = true
+
+class Bone < Familia::Horreum
+  identifier     [:token, :name]
+  field     :token
+  field     :name
+  list      :owners
+  set       :tags
+  zset      :metrics
+  hashkey   :props
+  string    :value, :default => "GREAT!"
+end
+
+class Blone < Familia::Horreum
+  feature :safe_dump
+  list      :owners
+  set       :tags
+  zset      :metrics
+  hashkey   :props
+  string    :value, :default => "GREAT!"
+end
+
+class Customer < Familia::Horreum
+  db 15 # don't use Onetime's default DB
+  ttl 5.years
+
+  feature :safe_dump
+  #feature :api_version
+
+  # NOTE: The SafeDump mixin caches the safe_dump_field_map so updating this list
+  # with hot reloading in dev mode will not work. You will need to restart the
+  # server to see the changes.
+  @safe_dump_fields = [
+    :custid,
+    :role,
+    :verified,
+    :updated,
+    :created,
+
+    # NOTE: The secrets_created incrementer is null until the first secret
+    # is created. See CreateSecret for where the incrementer is called.
+    #
+    {secrets_created: ->(cust) { cust.secrets_created.value || 0 } },
+
+    # We use the hash syntax here since `:active?` is not a valid symbol.
+    {active: ->(cust) { cust.active? } }
+  ]
+
+  class_sorted_set :values, key: 'onetime:customer'
+  class_hashkey :domains
+
+  hashkey :stripe_customer
+  sorted_set :timeline
+  sorted_set :custom_domains
+
+  counter :secrets_created
+
+  identifier :custid
+
+  field :custid
+  field :sessid
+  field :email
+  field :role
+  field :key
+  field :passphrase_encryption
+  field :passphrase
+  field :verified
+  field :apitoken
+  field :planid
+  field :created
+  field :updated
+  field :reset_requested #=> Boolean
+
+  hashkey :password_reset #=> Familia::HashKey
+  list :sessions #=> Familia::List
+
+  class_list :customers, suffix: []
+  class_string :message
+
+  class_zset :instances, class: self, reference: true
+
+  def active?
+    verified && !reset_requested
+  end
+end
+@c = Customer.new
+@c.custid = "d@example.com"
+
+class Session < Familia::Horreum
+  db 14 # don't use Onetime's default DB
+  ttl 180.minutes
+
+  identifier :generate_id
+
+  field :sessid
+  field :shrimp
+  field :custid
+  field :useragent
+  field :key
+  field :authenticated
+  field :ipaddress
+  field :created
+  field :updated
+
+  def generate_id
+    @sessid ||= Familia.generate_id
+    @sessid
+  end
+
+  # The external identifier is used by the rate limiter to estimate a unique
+  # client. We can't use the session ID b/c the request agent can choose to
+  # not send cookies, or the user can clear their cookies (in both cases the
+  # session ID would change which would circumvent the rate limiter). The
+  # external identifier is a hash of the IP address and the customer ID
+  # which means that anonymous users from the same IP address are treated
+  # as the same client (as far as the limiter is concerned). Not ideal.
+  #
+  # To put it another way, the risk of colliding external identifiers is
+  # acceptable for the rate limiter, but not for the session data. Acceptable
+  # b/c the rate limiter is a temporary measure to prevent abuse, and the
+  # worse case scenario is that a user is rate limited when they shouldn't be.
+  # The session data is permanent and must be kept separate to avoid leaking
+  # data between users.
+  def external_identifier
+    elements = []
+    elements << ipaddress || 'UNKNOWNIP'
+    elements << custid || 'anon'
+    @external_identifier ||= Familia.generate_sha_hash(elements)
+    Familia.ld "[Session.external_identifier] sess identifier input: #{elements.inspect} (result: #{@external_identifier})"
+    @external_identifier
+  end
+
+end
+@s = Session.new
+
+class CustomDomain < Familia::Horreum
+
+  class_sorted_set :values, key: 'onetime:customdomain:values'
+
+  identifier :derive_id
+
+  field :display_domain
+  field :custid
+  field :base_domain
+  field :subdomain
+  field :trd
+  field :tld
+  field :sld
+  field :txt_validation_host
+  field :txt_validation_value
+  field :status
+  field :vhost
+  field :verified
+  field :created
+  field :updated
+  field :_original_value
+
+  # Derive a unique identifier for the object based on the display domain and
+  # the customer ID. This is used to ensure that the same domain can't be
+  # added twice by the same customer while avoiding collisions between customers.
+  def derive_id
+    Familia.generate_sha_hash(:display_domain, :custid).slice(0, 8)
+  end
+end
+@d = CustomDomain.new
+@d.display_domain = "example.com"
+@d.custid = @c.custid
+
+class Limiter < Familia::Horreum
+
+  identifier :name
+  field :name
+  string :counter, :ttl => 1.hour, :quantize => [10.minutes, '%H:%M', 1302468980]
+
+  def identifier
+    @name
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: familia
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 1.0.0.pre.rc1
 platform: ruby
 authors:
 - Delano Mandelbaum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -45,47 +45,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: gibbler
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: storable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :runtime
+        version: '11.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '11.0'
 description: 'Familia: An ORM for Redis in Ruby.. Organize and store ruby objects
   in Redis'
 email: gems@solutious.com
@@ -96,6 +68,8 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".pre-commit-config.yaml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -103,26 +77,55 @@ files:
 - VERSION.yml
 - familia.gemspec
 - lib/familia.rb
+- lib/familia/base.rb
+- lib/familia/connection.rb
 - lib/familia/core_ext.rb
-- lib/familia/helpers.rb
-- lib/familia/object.rb
-- lib/familia/redisobject.rb
-- lib/familia/test_helpers.rb
-- lib/familia/tools.rb
+- lib/familia/errors.rb
+- lib/familia/features.rb
+- lib/familia/features/api_version.rb
+- lib/familia/features/atomic_saves.rb
+- lib/familia/features/quantizer.rb
+- lib/familia/features/safe_dump.rb
+- lib/familia/horreum.rb
+- lib/familia/horreum/class_methods.rb
+- lib/familia/horreum/commands.rb
+- lib/familia/horreum/relations_management.rb
+- lib/familia/horreum/serialization.rb
+- lib/familia/horreum/settings.rb
+- lib/familia/horreum/utils.rb
+- lib/familia/logging.rb
+- lib/familia/redistype.rb
+- lib/familia/redistype/commands.rb
+- lib/familia/redistype/serialization.rb
+- lib/familia/settings.rb
+- lib/familia/types/hashkey.rb
+- lib/familia/types/list.rb
+- lib/familia/types/sorted_set.rb
+- lib/familia/types/string.rb
+- lib/familia/types/unsorted_set.rb
+- lib/familia/utils.rb
+- lib/familia/version.rb
+- lib/redis_middleware.rb
 - try/00_familia_try.rb
 - try/10_familia_try.rb
-- try/20_redis_object_try.rb
-- try/21_redis_object_zset_try.rb
-- try/22_redis_object_set_try.rb
-- try/23_redis_object_list_try.rb
-- try/24_redis_object_string_try.rb
-- try/25_redis_object_hash_try.rb
+- try/20_redis_type_try.rb
+- try/21_redis_type_zset_try.rb
+- try/22_redis_type_set_try.rb
+- try/23_redis_type_list_try.rb
+- try/24_redis_type_string_try.rb
+- try/25_redis_type_hash_try.rb
 - try/26_redis_bool_try.rb
+- try/27_redis_horreum_try.rb
 - try/30_familia_object_try.rb
+- try/35_feature_safedump_try.rb
+- try/40_customer_try.rb
+- try/41_customer_safedump_try.rb
+- try/test_helpers.rb
 homepage: https://github.com/delano/familia
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -138,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: An ORM for Redis in Ruby.

data/lib/familia/helpers.rb

@@ -1,70 +0,0 @@
-
-module Familia
-  #
-  #     class Example
-  #       include Familia
-  #       field :name
-  #       include Familia::Stamps
-  #     end 
-  #
-  module Stamps
-    def self.included(obj)
-      obj.module_eval do
-        field :created => Integer
-        field :updated => Integer
-        def init_stamps
-          now = Time.now.utc.to_i
-          @created ||= now
-          @updated ||= now 
-        end
-        def created
-          @created ||= Time.now.utc.to_i
-        end
-        def updated
-          @updated ||= Time.now.utc.to_i
-        end
-        def created_age
-          Time.now.utc.to_i-created
-        end
-        def updated_age
-          Time.now.utc.to_i-updated
-        end
-        def update_time
-          @updated = Time.now.utc.to_i
-        end
-        def update_time!
-          update_time
-          save if respond_to? :save
-          @updated
-        end
-      end
-    end
-  end
-  module Status
-    def self.included(obj)
-      obj.module_eval do
-        field :status
-        field :message
-        def  failure?()        status? 'failure'       end
-        def  success?()        status? 'success'       end
-        def  pending?()        status? 'pending'       end
-        def  expired?()        status? 'expired'       end
-        def disabled?()        status? 'disabled'      end
-        def  failure!(msg=nil) status! 'failure',  msg end
-        def  success!(msg=nil) status! 'success',  msg end
-        def  pending!(msg=nil) status! 'pending',  msg end
-        def  expired!(msg=nil) status! 'expired',  msg end
-        def disabled!(msg=nil) status! 'disabled', msg end
-        private
-        def status?(s)
-          status.to_s == s.to_s
-        end
-        def status!(s, msg=nil)
-          @updated = Time.now.utc.to_f
-          @status, @message = s, msg
-          save if respond_to? :save
-        end
-      end
-    end
-  end
-end