familia 0.7.0 → 0.9.0

data/lib/familia/test_helpers.rb

@@ -32,3 +32,9 @@ class Customer < Storable
   class_string :message
 end
 
+class Limiter < Storable
+  include Familia
+  index :name
+  field :name
+  string :counter, :quantize => true, :ttl => 1.hour, :quantize => [10.minutes, '%H:%M', 1302468980]
+end

data/lib/familia.rb

@@ -3,6 +3,7 @@ FAMILIA_LIB_HOME = File.expand_path File.dirname(__FILE__) unless defined?(FAMIL
 require 'uri/redis'
 require 'gibbler'
 require 'familia/core_ext'
+require 'multi_json'
 
 module Familia
   module VERSION
@@ -85,7 +86,9 @@ module Familia
       uri &&= URI.parse uri if String === uri
       uri ||= Familia.uri
       conf = uri.conf
-      conf[:thread_safe] = true unless conf.has_key?(:thread_safe)
+      conf[:thread_safe] = "true" unless conf.has_key?(:thread_safe)
+      conf[:thread_safe] = conf[:thread_safe].to_s == "true"
+      conf[:logging] = conf[:logging].to_s == "true"
       if conf.has_key?(:logging) && conf[:logging].to_s == "true"
         require 'logger'
         require 'log4r'
@@ -128,6 +131,16 @@ module Familia
       end
       @apiversion 
     end
+    def now n=Time.now
+      n.utc.to_i
+    end
+    # A quantized timestamp
+    # e.g. 12:32 -> 12:30
+    # 
+    def qnow quantum=10.minutes, now=Familia.now
+      rounded = now - (now % quantum)
+      Time.at(rounded).utc.to_i
+    end
   end
   
   class Problem < RuntimeError; end
@@ -148,11 +161,6 @@ module Familia
     obj.send :include, Gibbler::Complex
     obj.extend Familia::ClassMethods
     obj.class_zset :instances, :class => obj, :reference => true
-    # :object is a special redis object because its reserved
-    # for storing the marshaled instance data (e.g. to_json).
-    # When it isn't defined explicitly we define it here b/c
-    # it's assumed to exist in other places (see #save).
-    obj.string :object, :class => obj unless obj.redis_object? :object
     Familia.classes << obj
   end
   

data/try/10_familia_try.rb

@@ -34,3 +34,20 @@ Bone.list? :owners
 definition = Bone.list :owners
 definition.klass
 #=> Familia::List
+
+## Familia.now
+Familia.now Time.parse('2011-04-10 20:56:20 UTC').utc
+#=> 1302468980
+
+## Familia.qnow
+Familia.qnow 10.minutes, 1302468980
+#=> 1302468600
+
+## Familia::Object.qstamp
+Limiter.qstamp 10.minutes, '%H:%M', 1302468980
+#=> '20:50'
+
+## Familia::Object#qstamp
+limiter = Limiter.new :request
+limiter.qstamp 10.minutes, '%H:%M', 1302468980
+##=> '20:50'

data/try/20_redis_object_try.rb

@@ -5,8 +5,8 @@ Familia.apiversion = 'v1'
 
 
 ## Redis Objects are unique per instance of a Familia class
-@a = Bone.new 'atoken'
-@b = Bone.new 'btoken'
+@a = Bone.new 'atoken', :name1
+@b = Bone.new 'atoken', :name2
 @a.owners.rediskey == @b.owners.rediskey
 #=> false
 
@@ -15,4 +15,31 @@ Familia.apiversion = 'v1'
 #=> true
 
 
+## Limiter#qstamp
+@limiter = Limiter.new :requests
+@limiter.counter.qstamp 10.minutes, '%H:%M', 1302468980
+#=> '20:50'
 
+## Redis Objects can be stored to quantized keys
+@limiter.counter.rediskey
+#=> "v1:limiter:requests:counter:20:50"
+
+## Increment counter
+@limiter.counter.clear
+@limiter.counter.increment
+#=> 1
+
+## Check ttl
+@limiter.counter.ttl
+#=> 3600
+
+## Check ttl for a different instance
+## (this exists to make sure options are cloned for each instance)
+@limiter2 = Limiter.new :requests
+@limiter2.counter.ttl
+#=> 3600
+
+## Check realttl
+sleep 1
+@limiter.counter.realttl
+#=> 3600-1

data/try/21_redis_object_zset_try.rb

@@ -9,11 +9,11 @@ require 'familia/test_helpers'
 @a.metrics.add 0, :metric0
 @a.metrics.add 1, :metric1
 @a.metrics.add 3, :metric3
-#=> true
+##=> true
 
 ## Familia::SortedSet#members
 @a.metrics.members
-#=> ['metric0', 'metric1', 'metric2', 'metric3', 'metric4']
+##=> ['metric0', 'metric1', 'metric2', 'metric3', 'metric4']
 
 ## Familia::SortedSet#members
 @a.metrics.revmembers
@@ -63,4 +63,4 @@ require 'familia/test_helpers'
 @a.metrics.members
 #=> ['metric2']
 
-@a.metrics.clear
+@a.metrics.clear

metadata

@@ -1,76 +1,109 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: familia
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.7.0
+version: !ruby/object:Gem::Version
+  version: 0.9.0
 platform: ruby
-authors: 
+authors:
 - Delano Mandelbaum
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-
-date: 2011-03-04 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2024-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: redis
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.1.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: uri-redis
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+- !ruby/object:Gem::Dependency
+  name: uri-redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.4.2
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: gibbler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.8.6
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: gibbler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  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
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  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: '0.0'
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.8.6
+      - !ruby/object:Gem::Version
+        version: 0.0.5
   type: :runtime
-  version_requirements: *id004
-description: Organize and store ruby objects in Redis
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+description: 'Familia: Organize and store ruby objects in Redis'
 email: delano@solutious.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
+- ".gitignore"
 - CHANGES.txt
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
-- Rakefile
+- README.md
 - VERSION.yml
 - familia.gemspec
 - lib/familia.rb
@@ -89,33 +122,27 @@ files:
 - try/24_redis_object_string_try.rb
 - try/25_redis_object_hash_try.rb
 - try/30_familia_object_try.rb
-has_rdoc: true
-homepage: http://github.com/delano/familia
-licenses: []
-
+homepage: https://github.com/delano/familia
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.6.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: familia
-rubygems_version: 1.5.2
+rubygems_version: 3.2.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Organize and store ruby objects in Redis
 test_files: []
-

data/README.rdoc

@@ -1,14 +0,0 @@
-# Familia - 0.6 BETA
-
-**Organize and store ruby objects in Redis**
-
-
-## More Information
-
-* [Codes](http://github.com/delano/familia)
-* [RDocs](http://delano.github.com/familia)
-
-
-## Credits
-
-* [Delano Mandelbaum](http://goldensword.ca)

data/Rakefile

@@ -1,70 +0,0 @@
-require "rubygems"
-require "rake"
-require "rake/clean"
-require 'yaml'
-
-begin
-  require 'hanna/rdoctask'
-rescue LoadError
-  require 'rake/rdoctask'
-end
- 
-config = YAML.load_file("VERSION.yml")
-task :default => ["build"]
-CLEAN.include [ 'pkg', 'doc' ]
-name = "familia"
-
-begin
-  require "jeweler"
-  Jeweler::Tasks.new do |gem|
-    gem.version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
-    gem.name = name
-    gem.rubyforge_project = gem.name
-    gem.summary = "Organize and store ruby objects in Redis"
-    gem.description = gem.summary
-    gem.email = "delano@solutious.com"
-    gem.homepage = "http://github.com/delano/familia"
-    gem.authors = ["Delano Mandelbaum"]
-    gem.add_dependency("redis",      ">= 2.1.0")
-    gem.add_dependency("uri-redis",  ">= 0.4.2")
-    gem.add_dependency("gibbler",    ">= 0.8.6")
-    gem.add_dependency("storable",   ">= 0.8.6")
-    
-    #gem.add_development_dependency("rspec", ">= 1.2.9")
-    #gem.add_development_dependency("mocha", ">= 0.9.8")
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-
-Rake::RDocTask.new do |rdoc|
-  version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
-  rdoc.rdoc_dir = "doc"
-  rdoc.title = "#{name} #{version}"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("LICENSE.txt")
-  rdoc.rdoc_files.include("bin/*.rb")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
-
-
-# Rubyforge Release / Publish Tasks ==================================
-
-#about 'Publish website to rubyforge'
-task 'publish:rdoc' => 'doc/index.html' do
-  #sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
-end
-
-#about 'Public release to rubyforge'
-task 'publish:gem' => [:package] do |t|
-  sh <<-end
-    rubyforge add_release -o Any -a CHANGES.txt -f -n README.md #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
-    rubyforge add_file -o Any -a CHANGES.txt -f -n README.md #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
-  end
-end
-
-
-
-