timemaster 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,2 @@
+.rake_test_cache
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 brianthecoder
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= Timemaster
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 brianthecoder. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "timemaster"
+    gem.summary = %Q{A way to easily store time based data scalably in riak}
+    gem.description = %Q{Creates buckets for a given resolution and will create all the appropriate links}
+    gem.email = "wbsmith83@gmail.com"
+    gem.homepage = "http://github.com/BrianTheCoder/chronos"
+    gem.authors = ["brianthecoder"]
+    gem.files.include %w(lib/timemaster.rb lib/timemaster/document.rb lib/timemaster/extensions.rb lib/timemaster/helpers.rb lib/timemaster/resolution.rb lib/timemaster/version.rb)
+    gem.add_development_dependency "yard"
+    gem.add_dependency "riak-client"
+    gem.add_dependency "activesupport"
+    gem.add_dependency "hashie"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'reek/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/TODO

@@ -0,0 +1,26 @@
+class Request
+  include Chronos::Document
+  
+  # default, assumes all levels above it
+  resolution :minute 
+  
+  # generates automatically if not defined
+  def key
+    # blarg
+  end
+end
+
+* saving documents
+  * check that lined docs exist
+  * resolution content_type?
+* queurying
+  * single doc
+  * epoch
+  * range
+* stats (map/reduce)
+  * counts
+  * sum
+  * avg
+  
+* easy custom links
+* query by custom links

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/request.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__),'../lib/chronos')
+
+require 'timecop'
+require 'randexp'
+
+Chronos.riak.port = 8091
+
+class Request
+  include Chronos::Document
+  
+  resolution :minute
+  
+  tag :controller_name
+  tag :action_name
+end
+
+module Riak
+  class Bucket
+    def wipe!
+      keys do |key_array|
+        key_array.each{|key| delete(key)}
+      end
+    end
+  end
+end
+
+def wipe_all!
+  %w(years months days hours minutes requests).each{|name| Chronos.riak.bucket(name).wipe! }
+end
+
+def seed
+  controllers = %w(users posts settings photos)
+  actions = %w(index new create edit update destroy)
+  
+  Timecop.freeze(Time.now)
+  200.of do
+    Timecop.travel(rand(10))
+    req = Request.new(:controller_name => controllers.pick,
+                      :action_name => actions.pick,
+                      :response_time => 5.of{ 60 + rand(40)}.sum)
+  end
+end

data/lib/timemaster.rb

@@ -0,0 +1,22 @@
+require 'active_support/core_ext'
+require 'riak/client'
+require 'hashie'
+
+$:.unshift File.dirname(__FILE__)
+
+require 'timemaster/helpers'
+require 'timemaster/extensions'
+require 'timemaster/document'
+require 'timemaster/resolution'
+
+module Timemaster
+  extend self
+  
+  def riak
+    @riak ||= Riak::Client.new
+  end
+  
+  def riak=(client)
+    @riak ||= Riak::Client.new
+  end
+end

data/lib/timemaster/document.rb

@@ -0,0 +1,158 @@
+module Timemaster
+  module Document
+    def self.included(klass)
+      klass.extend ClassMethods
+      klass.extend Helpers
+      klass.send(:include, Helpers)
+      klass.send(:attr_accessor, *[:key, :attributes])
+      klass.send(:attr_reader, :time)
+      klass.cattr_accessor :resolution_period
+      klass.cattr_accessor :tags
+    end
+    
+    module ClassMethods
+      def get(id)
+        begin
+          new bucket.get(id)
+        rescue Riak::FailedRequest
+          nil
+        end
+      end
+      
+      def bucket_name
+        @bucket_name ||= self.to_s.tableize
+      end
+      
+      def resolution(period)
+        self.resolution_period = period
+      end
+      
+      def epoch(period = :hour, time = Time.now.utc, tag = nil)
+        # res_instance = Resolution.new(options[:resolution], options[:time])
+        index = Resolution.index(resolution_period)
+        res_index = Resolution.index(period)
+        resolutions = []
+        RESOLUTIONS[0..index].each_with_index do |res_period, i| 
+          resolutions[i] = Resolution.new(res_period, (i <= res_index) ? time : nil)
+        end
+        root = resolutions.shift.riak_object
+        root.walk(resolutions.map(&:walk_spec).insert(-1, Riak::WalkSpec.new('requests', tag, true))).flatten
+      end
+      
+      def period(resolution = :hour, start = 1.day.ago, stop = Time.now)
+        res_instance = Resolution.new(:hour)
+        keys = (start..stop).send(:"to_#{res_instance.bucket_name}")
+        keys.map! do |time|
+          res_instance.time = time
+          res_instance.key
+        end
+        keys
+      end
+      
+      def tag(new_tag, options = {})
+        self.tags ||= []
+        self.tags << new_tag
+      end
+    end
+    
+    def initialize(params = {})
+      case params
+      when Hash
+        @time = params.delete(:time) || Time.now.utc
+        @attributes = Hashie::Mash.new(params)
+      when Riak::RObject
+        self.riak_object = params
+      end
+    end
+    
+    def make_links
+      return link_for if self.class.tags.blank?
+      self.class.tags.map{|key| link_for("#{key}_#{@attributes[key.to_sym]}")}.flatten.compact
+    end
+    
+    def time_from_link(link)
+      Time.utc(*link.url.split('/').last.split('_'))
+    end
+    
+    def resolutions
+      @resolutions ||= RESOLUTIONS[0..resolution_index].inject({}) do |hash, period| 
+        hash[period] = Resolution.new(period, time)
+        hash
+      end
+    end
+    
+    def resolution_index
+      @resolution_index ||= RESOLUTIONS.index(self.class.resolution_period)
+    end
+    
+    def time=(timestamp)
+      case timestamp
+      when Date
+        self.time = timestamp.to_time
+      when Time
+        @time = timestamp.utc
+      when Riak::Link
+        self.time = time_from_link(timestamp)
+      end
+    end
+    
+    def [](key)
+      @attributes[key]
+    end
+    
+    def []=(key, value)
+      @attributes[key] = value
+    end
+    
+    def method_missing(method_symbol, *args)
+      method_name = method_symbol.to_s
+      if %w(? =).include?(method_name[-1,1])
+        method = method_name[0..-2]
+        operator = method_name[-1,1]
+        if operator == '='
+          set_value(method, args.first)
+        elsif operator == '?'
+          !@attributes[method].blank?
+        end
+      else 
+        @attributes[method_name]
+      end
+    end
+    
+    def set_value(method, val)
+      if val.blank?
+        @attributes.delete(method)
+      else
+        @attributes[method] = val
+      end
+    end
+    
+    def bucket_name
+      @bucket_name ||= self.class.bucket_name
+    end
+    
+    def resolution_docs
+      RESOLUTIONS[0..resolution_index].each do |period|
+        res_period = resolutions[period]
+        unless res_period.exists?
+          if (child = resolutions[res_period.next])
+            res_period.links << child.link
+          end
+          res_period.store
+          if (parent = resolutions[res_period.prev])
+            parent.update_links!(res_period.link)
+          end
+        end
+      end
+    end
+    
+    def save
+      resolution_docs
+      data = @attributes
+      store
+      self.key = riak_object.key
+      linked_res = resolutions[self.class.resolution_period]
+      linked_res.update_links!(make_links)
+    end
+  end
+end

data/lib/timemaster/extensions.rb

@@ -0,0 +1,84 @@
+module Timemaster
+  module Extensions
+      extend self
+      
+    def time_formats
+      { :year   => '%Y',
+        :month  => '%m',
+        :day    => '%d',
+        :hour   => '%H',
+        :minute => '%M',
+        :second => '%S'}
+    end
+  end
+end
+
+Timemaster::Extensions.time_formats.each do |k, v|
+  Date::DATE_FORMATS.update(k => v)
+  Time::DATE_FORMATS.update(k => v)
+end
+
+class Range
+  ##
+  # Takes a range and converts it to an array of months
+  #
+  # (Time.now..1.day.from_now).to_hours
+  #
+  def to_months
+    return if first > last
+    arr = []
+    time = first
+    while time <= last
+      arr << time
+      time += 1.month
+    end
+    return arr
+  end
+  ##
+  # Takes a range and converts it to an array of days
+  #
+  # (Time.now..7.days.from_now).to_days
+  #
+  def to_days
+    return if first > last
+    arr = []
+    time = first
+    while time <= last
+      arr << time
+      time += 1.day
+    end
+    return arr
+  end
+  
+  ##
+  # Takes a range and converts it to an array of hours
+  #
+  # (Time.now..1.day.from_now).to_hours
+  #
+  def to_hours
+    return if first > last
+    arr = []
+    time = first
+    while time <= last
+      arr << time
+      time += 1.hour
+    end
+    return arr
+  end
+  
+  ##
+  # Takes a range and converts it to an array of minutes
+  #
+  # (Time.now..1.day.from_now).to_hours
+  #
+  def to_minutes
+    return if first > last
+    arr = []
+    time = first
+    while time <= last
+      arr << time
+      time += 1.minute
+    end
+    return arr
+  end
+end

data/lib/timemaster/helpers.rb

@@ -0,0 +1,29 @@
+module Timemaster
+  module Helpers
+    def bucket
+      @bucket ||= Chronos.riak.bucket(bucket_name)
+    end
+    
+    def riak_object
+      @riak_object ||= bucket.new(key)
+    end
+    
+    delegate :walk, :links, :store, :data, :to => :riak_object
+    
+    def path
+      @path ||= ['', 'riak', bucket_name, key].join('/')
+    end
+    
+    def exists? 
+      @exists ||= (key.blank? ? false : bucket.exists?(key))
+    end
+    
+    def link_for(tag = nil)
+      Riak::Link.new(path, tag)
+    end
+    
+    def walk_spec(tag = nil, keep = false)
+      Riak::WalkSpec.new(bucket_name, (tag||default_tag), keep)
+    end
+  end
+end

data/lib/timemaster/resolution.rb

@@ -0,0 +1,62 @@
+module Timemaster
+  RESOLUTIONS = [:year, :month, :day, :hour, :minute, :second]
+  class Resolution
+    include Helpers
+    
+    def self.index(resolution)
+      RESOLUTIONS.index(resolution)
+    end
+    
+    attr_accessor :name, :time
+    def initialize(name, time)
+      @name = name
+      @time = case time
+      when Time then
+        time
+      when String
+        Time.utc(*time.split('_'))
+      when Nil
+        Time.now.utc
+      end
+    end
+    
+    def index
+      @index ||= self.class.index(name)
+    end
+    
+    def default_tag
+      return @tag if @tag
+      return nil unless @time
+      @tag = @time.to_s(name)
+    end
+    
+    def prev
+      (index >= 1) ? RESOLUTIONS[index - 1] : nil
+    end
+    
+    def next
+      RESOLUTIONS[index + 1]
+    end
+    
+    def bucket_name
+      @bucket_name ||= name.to_s.tableize
+    end
+    
+    def update_links!(*args)
+      obj = bucket.get(key)
+      obj.links.merge args.flatten
+      obj.store
+    end
+    
+    def key
+      return @key if @key
+      # join string up to resolution and user to format time
+      return @key = nil if index.blank?
+      @key = RESOLUTIONS[0..index].inject(''){|str, res| "#{str}_#{time.to_s(res)}"}[1..-1]
+    end
+    
+    def link
+      @link ||= link_for(default_tag)
+    end
+  end
+end

data/lib/timemaster/version.rb

@@ -0,0 +1,5 @@
+module Timemaster
+  module Version
+    
+  end
+end

data/test/chronos_test.rb

@@ -0,0 +1,12 @@
+require 'teststrap'
+
+context "chronos" do
+  setup do
+    @time = Time.local(2010, 4, 20, 16, 20, 0)
+    Timecop.freeze(@time)
+  end
+
+  asserts "creates all the appropriate time based keys" do
+    
+  end
+end

data/test/teststrap.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'riot'
+require 'chronos'
+require 'timecop'
+
+Chronos.riak.port = 8091
+
+CONTROLLERS = %w(users posts settings photos)
+ACTIONS = %w(index new create edit update destroy)
+
+class Request
+  include Chronos::Document
+  
+  resolution :minute
+  
+  tag :controller_name
+  tag :action_name
+  
+  def self.make
+    new(:controller_name => CONTROLLERS.pick, 
+        :action_name => ACTIONS.pick, 
+        :request_time => 5.of{ 60 + rand(40)}.sum)
+  end
+  
+  def self.gen
+    make.save
+  end
+end
+
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: timemaster
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- brianthecoder
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-30 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: riak-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Creates buckets for a given resolution and will create all the appropriate links
+email: wbsmith83@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- examples/request.rb
+- lib/timemaster.rb
+- lib/timemaster/document.rb
+- lib/timemaster/extensions.rb
+- lib/timemaster/helpers.rb
+- lib/timemaster/resolution.rb
+- lib/timemaster/version.rb
+- test/chronos_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://github.com/BrianTheCoder/chronos
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A way to easily store time based data scalably in riak
+test_files: 
+- test/chronos_test.rb
+- test/teststrap.rb
+- examples/request.rb