duly_noted 1.0.1 → 1.0.2

data/README.md

@@ -45,9 +45,26 @@ or add
 
 to your `gemfile` and run `bundle install`
 
+##Configuration
+_New in 1.0.2_
+
+You can now configure the \**ahem*\* setting with the `configure` method in an initializer, like so:
+
+	DulyNoted.configure do |config|
+		config.editable_for = 3600 # default is one hour
+	end
+
+The `editable_for` configuration option will set the expiration on the id keys so your Redis database's key count and size doesn't shoot up crazy high.  The default is for them to expire after one hour.
+
+
 ##What's New
 
+### 1.0.2
+* The motivation behind this release was to restore precious precious redis space back to our user(s)
+* This update adds a `#configure` method which takes a block with one variable and allows you to set configuration setting(s).  Currently there's only one configuration option, and that's `editable_for`, which will let you set the expire time on the `id` keys.  So if you're not going to edit the meta hashes after a day, you could set it to `1.day`.  Alternatively, if you're never going to edit the meta hashes, you could set it to `0`, which will delete them immediately.
+
 ### 1.0.1
+* The main motivation behind this release was to stop using the timestamp as the unique identifier for the tracked metrics.  We can only capture the time so precicely with ruby, and redis can take in so many metrics a second, that it would be possible to get duplicate timestamps, even when we measure the time to the millisecond.  Using unique ids will make sure that you are not limited by duly_noted, but by the much more capable Redis.
 * Obliterated `ref_id`s, and everything they stood for.  Not really everything they stood for.  Now each metric gets its own unique id.
 * `#track` now returns the id of the metric you just tracked
 * id's are unique across all of duly_noted, so when you update them with `#update` you don't need to specify which metric_name

data/lib/duly_noted.rb

@@ -46,6 +46,7 @@ require "uri"
 require "duly_noted/helpers"
 require "duly_noted/version"
 require "duly_noted/updater"
+require 'duly_noted/configuration'
 
 # The **DulyNoted** module contains five main methods:
 
@@ -58,6 +59,7 @@ require "duly_noted/updater"
 module DulyNoted
   include Helpers
   include Updater
+  include Configuration
   extend self # the following are class methods
 
 # ##Parameter Descriptions
@@ -113,6 +115,7 @@ module DulyNoted
       DulyNoted.redis.sadd build_key("metrics", false), key_without_for
       DulyNoted.redis.zadd key, options[:generated_at].to_f, "#{key}:#{id}:meta"
       DulyNoted.redis.set "dnid:#{id}", "#{key}:#{id}:meta" # set alias key
+      DulyNoted.redis.expire "dnid:#{id}", DulyNoted::Configuration.editable_for
       if options[:meta] # set meta data
         DulyNoted.redis.mapped_hmset "#{key}:#{id}:meta", options[:meta]
         options[:meta].keys.each do |field|
@@ -369,6 +372,11 @@ module DulyNoted
       }))
     )
   end
+
+  def configure
+    yield DulyNoted::Configuration
+  end
+
   class NotValidMetric < StandardError; end
   class InvalidOptions < StandardError; end
   class InvalidStep < StandardError; end

data/lib/duly_noted/configuration.rb

@@ -0,0 +1,33 @@
+module DulyNoted
+  module Configuration
+    extend self
+    
+    @data = {:editable_for => 3600}
+
+    def update!(data)
+      data.each do |key, value|
+        self[key] = value
+      end
+    end
+
+    def [](key)
+      @data[key.to_sym]
+    end
+
+    def []=(key, value)
+      if value.class == Hash
+        @data[key.to_sym] = Config.new(value)
+      else
+        @data[key.to_sym] = value
+      end
+    end
+
+    def method_missing(sym, *args)
+      if sym.to_s =~ /(.+)=$/
+        self[$1] = args.first
+      else
+        self[sym]
+      end
+    end
+  end
+end

data/lib/duly_noted/updater.rb

@@ -1,11 +1,12 @@
 require "duly_noted/version"
 require "duly_noted/helpers"
+require "duly_noted/configuration"
 
 module DulyNoted
   module Updater
     def update_schema(schema_version, redis)
       time = Time.now
-      if schema_version = [1,0,0]
+      if schema_version === ["1","0","0"]
         #update to 1.0.1
         puts "Updating schema to comply with duly_noted 1.0.1"
         metrics = redis.smembers "dn:metrics"
@@ -28,7 +29,15 @@ module DulyNoted
         redis.keys("*:ref:*").each do |ref_keys|
           redis.del(ref_keys)
         end
-        schema_version = [1,0,1]
+        schema_version = ["1","0","1"]
+      end
+      if schema_version === ["1","0","1"]
+        #update to 1.0.2
+        puts "Updating schema to comply with duly_noted 1.0.2"
+        redis.keys("dnid:*").each do |id_key|
+          redis.expire id_key, Configuration.editable_for
+        end
+        schema_version = ["1","0","2"]
       end
       redis.set "dn:version", VERSION
       puts "All up to date.  Completed updates in #{Time.now-time} seconds."

data/lib/duly_noted/version.rb

@@ -1,3 +1,3 @@
 module DulyNoted
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duly_noted
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70148931411020 !ruby/object:Gem::Requirement
+  requirement: &70133075998940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70148931411020
+  version_requirements: *70133075998940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70148931410600 !ruby/object:Gem::Requirement
+  requirement: &70133075998520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148931410600
+  version_requirements: *70133075998520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70148931410180 !ruby/object:Gem::Requirement
+  requirement: &70133075998100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148931410180
+  version_requirements: *70133075998100
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70148931409760 !ruby/object:Gem::Requirement
+  requirement: &70133075997680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148931409760
+  version_requirements: *70133075997680
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70148931409340 !ruby/object:Gem::Requirement
+  requirement: &70133075997260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148931409340
+  version_requirements: *70133075997260
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70148931408920 !ruby/object:Gem::Requirement
+  requirement: &70133075996840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148931408920
+  version_requirements: *70133075996840
 - !ruby/object:Gem::Dependency
   name: chronic
-  requirement: &70148931408500 !ruby/object:Gem::Requirement
+  requirement: &70133075996420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148931408500
+  version_requirements: *70133075996420
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70148931424440 !ruby/object:Gem::Requirement
+  requirement: &70133075996000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148931424440
+  version_requirements: *70133075996000
 - !ruby/object:Gem::Dependency
   name: ruby_gntp
-  requirement: &70148931424020 !ruby/object:Gem::Requirement
+  requirement: &70133075995580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148931424020
+  version_requirements: *70133075995580
 description: a simple redis based stat-tracker
 email:
 - will@willcosgrove.com
@@ -127,6 +127,7 @@ files:
 - Rakefile
 - duly_noted.gemspec
 - lib/duly_noted.rb
+- lib/duly_noted/configuration.rb
 - lib/duly_noted/helpers.rb
 - lib/duly_noted/updater.rb
 - lib/duly_noted/version.rb
@@ -146,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -502772928455294375
+      hash: -210504055019801151
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -502772928455294375
+      hash: -210504055019801151
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.16