check_in 0.0.1

data/.document

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Higginbotham
+
+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 @@
+= check_in
+
+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 Daniel Higginbotham. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "check_in"
+    gem.summary = %Q{Allow services to check in}
+    gem.description = %Q{Allow services to check in}
+    gem.email = "daniel@flyingmachinestudios.com"
+    gem.homepage = "http://github.com/flyingmachine/check_in"
+    gem.authors = ["Daniel Higginbotham"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "redis-namespace", ">= 0.10.0"
+    # 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: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "check_in #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/check_in.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{check_in}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Higginbotham"]
+  s.date = %q{2011-07-20}
+  s.description = %q{Allow services to check in}
+  s.email = %q{daniel@flyingmachinestudios.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "check_in.gemspec",
+    "lib/check_in.rb",
+    "lib/check_in/reader.rb",
+    "lib/check_in/writer.rb",
+    "spec/check_in_spec.rb",
+    "spec/redis-test.conf",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/writer_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/flyingmachine/check_in}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Allow services to check in}
+  s.test_files = [
+    "spec/check_in_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/writer_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<redis-namespace>, [">= 0.10.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<redis-namespace>, [">= 0.10.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<redis-namespace>, [">= 0.10.0"])
+  end
+end
+

data/lib/check_in/reader.rb

@@ -0,0 +1,26 @@
+module CheckIn
+  class Reader
+    attr_reader :base
+    def initialize(base)
+      @base = base
+    end
+    
+    def raw_checkins
+      CheckIn.redis.lrange(check_in_configuration.redis_key, 0, check_in_configuration.list_length)
+    end
+    
+    def checkins
+      raw_checkins.collect do |c|
+        value, time = c.split(" | ")
+        {
+          :value => value,
+          :time => Time.parse(time)
+        }
+      end.sort{ |a, b| a.time <=> b.time }
+    end
+    
+    def check_in_configuration
+      base.check_in_configuration
+    end
+  end
+end

data/lib/check_in/writer.rb

@@ -0,0 +1,105 @@
+module CheckIn
+  module Writer
+    
+    def self.included(klass)
+      klass.class_eval do
+        class << self
+          attr_accessor :check_in_configuration
+        end
+      end
+      klass.check_in_configuration = Configuration.new(klass)
+    end
+    
+    
+    class Configuration
+      attr_reader :base
+      
+      def initialize(base)
+        @base = base
+      end
+      
+      def service_name=(service_name)
+        @service_name = service_name
+      end
+      
+      def service_name
+        @service_name ||= base.name
+      end
+      
+      def list_length=(list_length)
+        @list_length = list_length
+      end
+      
+      def list_length
+        @list_length || 500
+      end 
+      
+      def instance_name_method=(instance_name_method) 
+        @instance_name_method = instance_name_method
+      end
+      
+      def instance_name_method
+        @instance_name_method ||= :to_s
+      end
+      
+      # redefine method to call check_in after original method is called
+      def check_in_after(method_name)
+        base.class_eval <<-END
+          alias_method :pre_check_in_#{method_name}, :#{method_name}
+          def #{method_name}(*args)
+            pre_check_in_#{method_name}(*args)
+            check_in(*args)
+          end
+        END
+      end
+      
+      # redefine method to call check_in before original method is called
+      def check_in_before(method_name)
+        base.class_eval <<-END
+          alias_method :pre_check_in_#{method_name}, :#{method_name}
+          def #{method_name}(*args)
+            check_in(*args)
+            pre_check_in_#{method_name}(*args)
+          end
+        END
+      end
+      
+      def redis_key
+        "checkins:#{service_name}"
+      end
+      
+      def setup(&block)
+        yield self
+      end
+    end
+    
+    def check_in(*args)
+      instance_name = send(check_in_configuration.instance_name_method)
+      time = Time.now.strftime(CheckIn.time_format)
+      line = "#{instance_name} | #{time}"
+      CheckIn.redis.rpush(check_in_configuration.redis_key, line)
+      trim_checkins
+    end
+    
+    def trim_checkins
+      size = CheckIn.redis.llen(check_in_configuration.redis_key)
+      if size > check_in_configuration.list_length
+        CheckIn.redis.ltrim(check_in_configuration.redis_key, size - check_in_configuration.list_length, size - 1)
+      end
+    end
+    
+    def check_in_configuration
+      # this is to allow usage on class methods
+      if self.class.respond_to?(:check_in_configuration)
+        self.class.check_in_configuration
+      else 
+        self.class_eval do
+          class << self
+            check_in_configuration
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/check_in.rb

@@ -0,0 +1,38 @@
+require 'redis/namespace'
+require 'check_in/writer'
+require 'check_in/reader'
+
+module CheckIn
+  class << self
+    
+    # Accepts:
+    #   1. A 'hostname:port' string
+    #   2. A 'hostname:port:db' string (to select the Redis db)
+    #   3. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
+    #      or `Redis::Namespace`.
+    def redis=(server)
+      if server.respond_to? :split
+        host, port, db = server.split(':')
+        redis = Redis.new(:host => host, :port => port,
+          :thread_safe => true, :db => db)
+        @redis = Redis::Namespace.new(:check_in, :redis => redis)
+      elsif server.respond_to? :namespace=
+          @redis = server
+      else
+        @redis = Redis::Namespace.new(:check_in, :redis => server)
+      end
+    end
+  
+    def redis
+      @redis || raise("You must set the redis instance.")
+    end
+  
+    def time_format=(format)
+      @time_format = format
+    end
+  
+    def time_format
+      @time_format ||= "%b %d %Y %H:%M:%S"
+    end
+  end
+end

data/spec/check_in_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CheckIn" do
+end

data/spec/redis-test.conf

@@ -0,0 +1,115 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./spec/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./spec/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+# slaveof <masterip> <masterport>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'check_in'
+require 'spec'
+require 'spec/autorun'
+
+dir = File.dirname(File.expand_path(__FILE__))
+
+Spec::Runner.configure do |config|
+  config.before(:all) do
+    puts "Starting redis for testing at localhost:9736..."
+    `redis-server #{dir}/redis-test.conf`
+    CheckIn.redis = 'localhost:9736'
+  end
+end
+
+at_exit do
+  pid = `ps -A -o pid,command | grep [r]edis-test`.split(" ")[0]
+  puts "Killing test redis server..."
+  `rm -f #{dir}/dump.rdb`
+  Process.kill("KILL", pid.to_i)
+end

data/spec/writer_spec.rb

@@ -0,0 +1,110 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CheckIn::Writer" do
+  before(:each) do
+    class TestClass
+      include CheckIn::Writer
+      
+      def work(arg1)
+      end
+      
+      def to_s
+        "identity"
+      end
+    end
+  end
+  
+  after(:each) do
+    Object.send(:remove_const, :TestClass)
+  end
+  
+  it "should create a CheckInConfiguration constant in the class which included CheckIn::Recorder" do
+    lambda{TestClass::check_in_configuration}.should_not raise_error
+  end
+  
+  it "should default the service name to the name of the including class" do
+    TestClass::check_in_configuration.service_name.should == "TestClass"
+  end
+  
+  it "should allow the service name to be set" do
+    TestClass::check_in_configuration.service_name = "blarg"
+    TestClass::check_in_configuration.service_name.should == "blarg"
+  end
+  
+  it "should have a list length of 500 by default" do
+    TestClass::check_in_configuration.list_length.should == 500
+  end
+  
+  it "should allow the list length to be set" do
+    TestClass::check_in_configuration.list_length = 2
+    TestClass::check_in_configuration.list_length.should == 2
+  end
+  
+  it "should default to :to_s for the instance name method" do
+    TestClass::check_in_configuration.instance_name_method.should == :to_s
+  end
+  
+  it "should allow the instance name method to be set" do
+    TestClass::check_in_configuration.instance_name_method = :id
+    TestClass::check_in_configuration.instance_name_method.should == :id
+  end
+  
+  it "should allow configuration in a block" do
+    TestClass::check_in_configuration.setup do |c|
+      c.service_name = "harry potter"
+      c.list_length = 3
+      c.instance_name_method = :describe
+    end
+    
+    TestClass::check_in_configuration.service_name.should == "harry potter"
+    TestClass::check_in_configuration.list_length.should == 3
+    TestClass::check_in_configuration.instance_name_method.should == :describe
+  end
+  
+  it "should return the redis key" do
+    TestClass::check_in_configuration.redis_key.should == "checkins:TestClass"
+  end
+  
+  it "should refer to CheckInConfiguration from instances" do
+    TestClass.new.check_in_configuration.should == TestClass::check_in_configuration
+  end
+  
+  it "should redefine work to call check_in" do
+    TestClass::check_in_configuration.check_in_after(:work)
+    t = TestClass.new
+    t.should_receive(:check_in).with("argity")
+    t.work("argity")
+  end
+
+  it "should redefine work to call check_in" do
+    TestClass::check_in_configuration.check_in_before(:work)
+    t = TestClass.new
+    t.should_receive(:check_in).with("argity")
+    t.work("argity")
+  end
+  
+  describe "checkin in" do
+    before(:each) do
+      TestClass::check_in_configuration.check_in_before(:work)
+    end
+    
+    it "should record checkins" do
+      t = TestClass.new
+      t.work("test")
+      
+      r = CheckIn::Reader.new(TestClass)
+      raw_checkin = r.raw_checkins[0]
+      
+      raw_checkin.should match(/^identity \| \w{3} \d\d \d{4} \d\d:\d\d:\d\d$/)
+    end
+  
+    it "should keep only the number of checkins specified by list_length" do
+      TestClass::check_in_configuration.list_length = 2
+      t = TestClass.new
+      3.times{t.work("test")}
+      
+      r = CheckIn::Reader.new(TestClass)
+      r.raw_checkins.size.should == 2
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: check_in
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Daniel Higginbotham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis-namespace
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :runtime
+  version_requirements: *id002
+description: Allow services to check in
+email: daniel@flyingmachinestudios.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- check_in.gemspec
+- lib/check_in.rb
+- lib/check_in/reader.rb
+- lib/check_in/writer.rb
+- spec/check_in_spec.rb
+- spec/redis-test.conf
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/writer_spec.rb
+has_rdoc: true
+homepage: http://github.com/flyingmachine/check_in
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: Allow services to check in
+test_files: 
+- spec/check_in_spec.rb
+- spec/spec_helper.rb
+- spec/writer_spec.rb