fnordmetric-client 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sw?

data/.rspec

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ilya Averyanov
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Fnordmetric::Client
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fnordmetric-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fnordmetric-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/fnordmetric-client.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/fnordmetric-client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ilya Averyanov"]
+  gem.email         = ["av@fun-box.ru"]
+  gem.description   = %q{Standalone client for fnordmetric}
+  gem.summary       = %q{Standalone and a safer client for fnordmetric https://github.com/paulasmuth/fnordmetric}
+  gem.homepage      = "https://github.com/savonarola/fnordmetric-client"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "fnordmetric-client"
+  gem.require_paths = ["lib"]
+  gem.version       = FnordmetricClient::VERSION
+
+  gem.add_runtime_dependency('json')
+
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('mock_redis')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('timecop')
+end

data/lib/fnordmetric-client/version.rb

@@ -0,0 +1,3 @@
+class FnordmetricClient
+  VERSION = "0.0.1"
+end

data/lib/fnordmetric-client.rb

@@ -0,0 +1,46 @@
+require "fnordmetric-client/version"
+require 'securerandom'
+require 'json/add/core'
+
+class FnordmetricClient
+  DEFAULT_EVENT_TTL = 3600
+  DEFAULT_PREFIX = 'fnordmetric'
+  DEFAULT_OVERFLOW_LIMIT = 50000
+
+  def initialize(opts ={})
+    raise ArgumentError, "Bad options" unless opts.is_a?(Hash)
+
+    @redis = opts[:redis]
+    raise ArgumentError, "Bad :redis passed" unless %w{hincrby set lpush expire llen}.all?{|m| @redis.respond_to?(m) }
+
+    @prefix = opts[:prefix] || DEFAULT_PREFIX
+    @event_ttl = opts[:event_ttl] || DEFAULT_EVENT_TTL
+    @overflow_limit = opts[:overflow_limit] || DEFAULT_OVERFLOW_LIMIT
+  end
+
+  def event(type, args = {})
+    push_event({'_type' => type.to_s}.merge(args))
+  end
+
+  private 
+
+    def key(*elements)
+      elements.map(&:to_s).unshift(@prefix).join('-')
+    end
+
+    def push_event(event_data)    
+      return if @redis.llen(key(:queue)) >= @overflow_limit
+
+      event_id = get_next_uuid
+      @redis.hincrby(key(:testdata), "events_received", 1)
+      @redis.hincrby(key(:stats), "events_received", 1)
+      @redis.set(key(:event, event_id), event_data.to_json)
+      @redis.expire(key(:event, event_id), @event_ttl)
+      @redis.lpush(key(:queue), event_id)
+      event_id
+    end
+  
+    def get_next_uuid
+      SecureRandom.hex(16)
+    end
+end

data/spec/fnordmetric-client_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe FnordmetricClient do
+  let(:redis){ MockRedis.new }
+  let(:prefix){ 'pref' }
+  let(:event_ttl){ 10 }
+  let(:overflow_limit){ 5 }
+  let(:client){ described_class.new(:redis => redis, :prefix => prefix, :overflow_limit => overflow_limit, :event_ttl => event_ttl) }
+
+  before(:each) do
+    redis.flushall
+  end
+
+  describe "#new" do
+    it "should raise exception when receives a non-hashlike object" do
+      expect{ described_class.new(123) }.to raise_exception(ArgumentError)
+    end
+
+    it "should raise exception when redis is not passed" do
+      expect{ described_class.new({:redis => 123}) }.to raise_exception(ArgumentError)
+      expect{ described_class.new({}) }.to raise_exception(ArgumentError)
+    end
+  end
+
+  describe '#event' do
+    
+    context "when redis is not overflown" do
+      it "should put event id into queue" do
+        client.event('foo', :some => 'payload')
+        redis.llen("#{prefix}-queue").to_i.should == 1
+      end
+      
+      it "should put event data by the key pushed into queue" do
+        client.event('foo', :some => 'payload')
+        event_id = redis.lrange("#{prefix}-queue", 0, 1).first
+        event_data_json = redis.get "#{prefix}-event-#{event_id}"
+        event_data_json.should_not be_nil
+        event_data = JSON.parse(event_data_json)
+        event_data.should == {'_type' => 'foo', 'some' => 'payload'}
+      end
+
+      it "should increase stat counters" do
+        client.event('foo', :some => 'payload')
+        redis.hget("#{prefix}-stats", "events_received").to_i.should == 1
+        redis.hget("#{prefix}-testdata", "events_received").to_i.should == 1
+        client.event('foo', :some => 'payload')
+        redis.hget("#{prefix}-stats", "events_received").to_i.should == 2
+        redis.hget("#{prefix}-testdata", "events_received").to_i.should == 2
+      end
+
+      it "should generate different event ids" do
+        client.event('foo', :some => 'payload')
+        client.event('foo', :some => 'payload')
+        redis.llen("#{prefix}-queue").to_i.should == 2
+      end
+
+      it "should expire event data" do
+        client.event('foo', :some => 'payload')
+        event_id = redis.lrange("#{prefix}-queue", 0, 1).first
+        event_data_json = redis.get "#{prefix}-event-#{event_id}"
+        event_data_json.should_not be_nil
+        Timecop.freeze(Time.now + event_ttl + 1) do
+          event_data_json = redis.get "#{prefix}-event-#{event_id}"
+          event_data_json.should be_nil
+        end
+      end
+
+    end
+
+    context "when redis is overflown" do
+      it "should not send events to queue" do
+        overflow_limit.times{ redis.lpush "#{prefix}-queue", "xxx" }
+        client.event('foo', :some => 'payload')
+        redis.llen("#{prefix}-queue").to_i.should == overflow_limit
+        redis.keys('*').size.should == 1
+      end
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :development, :test)
+require File.join(File.dirname(__FILE__), '../lib/fnordmetric-client')
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fnordmetric-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ilya Averyanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70354132801040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70354132801040
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70354132800620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354132800620
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: &70354132800200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354132800200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70354132799780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354132799780
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70354132799360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354132799360
+description: Standalone client for fnordmetric
+email:
+- av@fun-box.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fnordmetric-client.gemspec
+- lib/fnordmetric-client.rb
+- lib/fnordmetric-client/version.rb
+- spec/fnordmetric-client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/savonarola/fnordmetric-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Standalone and a safer client for fnordmetric https://github.com/paulasmuth/fnordmetric
+test_files:
+- spec/fnordmetric-client_spec.rb
+- spec/spec_helper.rb