logworm 0.6.1

data/CHANGELOG

@@ -0,0 +1,17 @@
+v0.6.1 fixed query builder
+
+v0.6.0 added query builder
+
+v0.5.1 removed memcache dependency, added memcache-client
+
+v0.5.0 removed utils, moved them to separate gem
+
+v0.4.1 added start and end options to lw-compute and lw-tail
+
+v0.4.0 added lw-compute tool, to run aggregate queries
+
+v0.3.0 added lw-heroku tool, to push configuration variables to heroku
+
+v0.2.0 removed app/ libraries. Added tail as a utility, lw-tail as a command
+
+v0.1.0 initial version.

data/Manifest

@@ -0,0 +1,9 @@
+CHANGELOG
+Manifest
+README
+Rakefile
+lib/base/config.rb
+lib/base/db.rb
+lib/base/query_builder.rb
+lib/logworm.rb
+tests/builder_test.rb

data/Rakefile

@@ -0,0 +1,10 @@
+require 'echoe'
+Echoe.new('logworm', '0.6.1') do |p|
+  p.description = "logworm logging tool"
+  p.url = "http://www.logworm.com"
+  p.author = "Pomelo, LLC"
+  p.email  = "schapira@pomelollc.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = ["memcache-client", "hpricot", "oauth"]
+  p.runtime_dependencies = ["memcache-client", "hpricot", "oauth"]
+end

data/lib/base/config.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+
+module Logworm
+  class ConfigFileNotFound < Exception ; end
+  
+  class Config
+    
+    include ::Singleton
+      
+    FILENAME = "./.logworm"
+    
+    def initialize
+      @file_found = false
+      @consumer_key = @consumer_secret = @token_key = @token_secret = nil
+      begin
+        f = File.new(FILENAME, 'r')
+        @consumer_key, @consumer_secret, @token_key, @token_secret = f.readlines.map {|l| l.strip }
+        @file_found = true
+      rescue Errno::ENOENT => e
+      end
+    end
+    
+    def keys
+      [@consumer_key, @consumer_secret, @token_key, @token_secret]
+    end
+    
+    def file_found?
+      @file_found and @consumer_key and @consumer_secret and @token_key and @token_secret
+    end
+    
+  end
+
+end
+

data/lib/base/db.rb

@@ -0,0 +1,74 @@
+require 'oauth'
+require 'json'
+
+module Logworm
+  class ForbiddenAccessException < Exception ; end
+  class DatabaseException < Exception ; end
+  class InvalidQueryException < Exception ; end
+  
+  class DB
+    
+    DB_HOST            = "http://db.logworm.com"
+  
+    def initialize(keys = nil)
+      if keys.is_a? Array and keys.size == 4
+        @consumer_key, @consumer_secret, @token, @token_secret = keys
+      elsif keys.is_a? Array and keys.size == 2
+        @consumer_key    = ENV["#{ENV['APP_ID']}_APPS_KEY"]
+        @consumer_secret = ENV["#{ENV['APP_ID']}_APPS_SECRET"]
+        @token, @token_secret = keys
+      else
+        config = Logworm::Config.instance
+        if config.file_found?
+          @consumer_key, @consumer_secret, @token, @token_secret = config.keys
+        else
+          raise "Could not find .logworm file in current directory." if keys.is_a? FalseClass
+          @consumer_key, @consumer_secret = [ENV['LW_CONSUMER_KEY'], ENV['LW_CONSUMER_SECRET']]
+          @token, @token_secret           = [ENV['LW_PROJECT_KEY'], ENV['LW_PROJECT_SECRET']]
+        end
+      end
+      raise ForbiddenAccessException.new("Missing keys") if @consumer_key.nil? or @consumer_secret.nil? 
+      raise ForbiddenAccessException.new("Missing keys") if @token.nil? or @token_secret.nil?
+      @connection = OAuth::AccessToken.new(OAuth::Consumer.new(@consumer_key, @consumer_secret), @token, @token_secret)
+    end
+  
+    def tables()
+      res = db_call(:get, "#{DB_HOST}/")
+    end
+  
+    def query(table, cond)
+      res = db_call(:post, "#{DB_HOST}/queries", {:table => table, :query => cond})
+    end
+  
+    def results(uri)
+      res = db_call(:get, uri)
+      raise InvalidQueryException.new("#{res['error']}") if res['error']
+      res["results"] = JSON.parse(res["results"])
+      res
+    end
+    
+    def batch_log(entries)
+      db_call(:post, "#{DB_HOST}/log", {:entries => $lr_queue.to_json})
+    end
+
+  private
+    def db_call(method, uri, params = {})
+      begin
+        res = @connection.send(method, uri, params)
+      rescue SocketError
+        raise DatabaseException
+      end
+      raise DatabaseException if res.code.to_i == 404
+      raise DatabaseException.new("Server returned: #{res.body}") if res.code.to_i == 500
+      raise ForbiddenAccessException if res.code.to_i == 403
+      raise InvalidQueryException.new("#{res.body}") if res.code.to_i == 400
+      begin
+        JSON.parse(res.body)
+      rescue Exception => e
+        raise DatabaseException.new("Database reponse cannot be parsed: #{e}")
+      end
+    end
+  end
+
+end
+

data/lib/base/query_builder.rb

@@ -0,0 +1,112 @@
+require 'rubygems'
+require 'json'
+
+###
+# Receives a hash with options, and provides a to_json method that returns the query ready to be sent to the logworm server
+# Switches (all optional)
+#   :fields             => String with a comma-separated list of fields (quoted or not), or Array of Strings
+#   :force_ts           => Boolean, specifies whether _ts should be added to the list of fields
+#   :aggregate_function => String
+#   :aggregate_argument => String
+#   :aggregate_group    => String with a comma-separated list of fields (quoted or not), or Array of Strings
+#   :conditions         => String with comma-separated conditions (in MongoDB syntax), or Array of Strings
+#   :start              => String or Integer (for year)
+#   :end                => String or Integer (for year)
+#   :limit              => String or Integer
+###
+module Logworm
+  class QueryBuilder
+    
+    attr_accessor :fields, :groups, :aggregate, :conditions, :tf, :limit
+    
+    def initialize(options = {})
+      @options = options
+      @query = build()
+    end
+  
+    def to_json
+      @query
+    end
+  
+    private
+    def build()
+      query_opts = []
+    
+      ###
+      # Fields : Array, or Comma-separated string
+      ###
+      @fields = to_array(@options[:fields])
+      query_opts << '"fields":' + (@options[:force_ts] ? @fields + ["_ts"] : @fields).to_json if @fields.size > 0
+
+      ###
+      # Aggregate
+      #  aggregate_function: String
+      #  aggregate_argument: String (or empty)
+      #  aggregate_group: String or Array
+      ###
+      @groups = to_array(@options[:aggregate_group])
+      @aggregate = {}
+      @aggregate[:function] = @options[:aggregate_function] if is_set?(@options[:aggregate_function])
+      @aggregate[:argument] = @options[:aggregate_argument] if is_set?(@options[:aggregate_argument])
+      @aggregate[:group_by] = groups[0] if groups.size == 1
+      @aggregate[:group_by] = groups if groups.size > 1
+      query_opts << '"aggregate":' + @aggregate.to_json if @aggregate.keys.size > 0
+    
+      if @fields.size > 0 and @aggregate.keys.size > 0
+        raise Logworm::InvalidQueryException.new("Queries cannot contain both fields and aggregates") 
+      end
+    
+      ###
+      # Conditions : Array, or Comma-separated string
+      # ['"a":10' , '"b":20']
+      # "a:10", "b":20
+      ###
+      @conditions = to_string(@options[:conditions])
+      query_opts << '"conditions":{' + conditions + "}" if conditions.size > 0
+
+      ###
+      # Timeframe: String
+      ###
+      @tf = {}
+      @tf[:start] = unquote(@options[:start]).to_s if is_set?(@options[:start]) or is_set?(@options[:start], Integer, 0)
+      @tf[:end] = unquote(@options[:end]).to_s if is_set?(@options[:end]) or is_set?(@options[:end], Integer, 0)
+      query_opts << '"timeframe":' + @tf.to_json if @tf.keys.size > 0
+
+      ###
+      # Limit
+      # String or Integer
+      ###
+      if (is_set?(@options[:limit], Integer, 200) or is_set?(@options[:limit], String, ""))
+        @limit = @options[:limit].to_s
+        query_opts << '"limit":' + @limit
+      end
+
+      # And the string
+      "{#{query_opts.join(", ")}}"
+    end
+  
+    def to_array(arg)
+      return [] if arg.nil?
+      return arg if arg.is_a? Array
+      return arg.split(",").map {|e| unquote(e.strip)} if arg.is_a? String and arg.split != ""
+      []
+    end
+
+    def to_string(arg)
+      return "" if arg.nil?
+      return arg.split(",").map {|e| e.strip}.join(",") if arg.is_a? String
+      return arg.join(",") if arg.is_a? Array and arg.size > 0
+      ""
+    end
+  
+    def unquote(str)
+      return str unless str.is_a? String
+      str.gsub(/^"/, '').gsub(/"$/,'')
+    end
+
+    def is_set?(elt, klass = String, empty_val = "")
+      elt and elt.is_a?(klass) and elt != empty_val
+    end
+  
+  end
+end

data/lib/logworm.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/base/db'
+require File.dirname(__FILE__) + '/base/config'
+require File.dirname(__FILE__) + '/base/query_builder'

data/logworm.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{logworm}
+  s.version = "0.6.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pomelo, LLC"]
+  s.date = %q{2010-03-01}
+  s.description = %q{logworm logging tool}
+  s.email = %q{schapira@pomelollc.com}
+  s.extra_rdoc_files = ["CHANGELOG", "README", "lib/base/config.rb", "lib/base/db.rb", "lib/base/query_builder.rb", "lib/logworm.rb"]
+  s.files = ["CHANGELOG", "Manifest", "README", "Rakefile", "lib/base/config.rb", "lib/base/db.rb", "lib/base/query_builder.rb", "lib/logworm.rb", "tests/builder_test.rb", "logworm.gemspec"]
+  s.homepage = %q{http://www.logworm.com}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Logworm", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{logworm}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{logworm logging tool}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<memcache-client>, [">= 0"])
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
+      s.add_runtime_dependency(%q<oauth>, [">= 0"])
+      s.add_development_dependency(%q<memcache-client>, [">= 0"])
+      s.add_development_dependency(%q<hpricot>, [">= 0"])
+      s.add_development_dependency(%q<oauth>, [">= 0"])
+    else
+      s.add_dependency(%q<memcache-client>, [">= 0"])
+      s.add_dependency(%q<hpricot>, [">= 0"])
+      s.add_dependency(%q<oauth>, [">= 0"])
+      s.add_dependency(%q<memcache-client>, [">= 0"])
+      s.add_dependency(%q<hpricot>, [">= 0"])
+      s.add_dependency(%q<oauth>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<memcache-client>, [">= 0"])
+    s.add_dependency(%q<hpricot>, [">= 0"])
+    s.add_dependency(%q<oauth>, [">= 0"])
+    s.add_dependency(%q<memcache-client>, [">= 0"])
+    s.add_dependency(%q<hpricot>, [">= 0"])
+    s.add_dependency(%q<oauth>, [">= 0"])
+  end
+end

data/tests/builder_test.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'test/unit'
+require '../lib/base/query_builder'
+
+class BuilderTest < Test::Unit::TestCase
+  
+  def setup
+  end
+	
+  def teardown
+  end
+
+  def test_empty
+    assert_equal "{}", Logworm::QueryBuilder.new({}).to_json
+  end
+
+  def test_fields
+    assert_equal '{"fields":["a","b"]}', Logworm::QueryBuilder.new(:fields => 'a, b').to_json
+    assert_equal '{"fields":["a","b"]}', Logworm::QueryBuilder.new(:fields => '"a", "b"').to_json
+    assert_equal '{"fields":["a","b"]}', Logworm::QueryBuilder.new(:fields => ["a", "b"]).to_json
+  end
+  
+  def test_aggregate
+    q = {:aggregate_function => "count"}
+    assert_equal '{"aggregate":{"function":"count"}}', Logworm::QueryBuilder.new(q).to_json
+    q = {:aggregate_function => "a", :aggregate_argument => "b"}
+    assert_equal '{"aggregate":{"argument":"b","function":"a"}}', Logworm::QueryBuilder.new(q).to_json
+    q = {:aggregate_function => "a", :aggregate_argument => "b", :aggregate_group => "a,b,c"}
+    assert_equal '{"aggregate":{"argument":"b","group_by":["a","b","c"],"function":"a"}}', Logworm::QueryBuilder.new(q).to_json
+    q = {:aggregate_function => "a", :aggregate_argument => "b", :aggregate_group => ["a","b","c"]}
+    assert_equal '{"aggregate":{"argument":"b","group_by":["a","b","c"],"function":"a"}}', Logworm::QueryBuilder.new(q).to_json
+  end
+
+  def test_conditions
+    assert_equal '{"conditions":{"a":10,"b":"c"}}', Logworm::QueryBuilder.new(:conditions => '"a":10,  "b":"c"').to_json
+    assert_equal '{"conditions":{"a":10,"b":"c"}}', Logworm::QueryBuilder.new(:conditions => ['"a":10',  '"b":"c"']).to_json
+  end
+
+  def test_times
+    assert_equal '{}', Logworm::QueryBuilder.new(:blah => "2009").to_json
+    assert_equal '{"timeframe":{"start":"2009"}}', Logworm::QueryBuilder.new(:start => "2009").to_json
+    assert_equal '{"timeframe":{"end":"2009"}}', Logworm::QueryBuilder.new(:end => "2009").to_json
+    assert_equal '{"timeframe":{"start":"2009","end":"2010"}}', Logworm::QueryBuilder.new(:start => "2009", :end => "2010").to_json
+    assert_equal '{"timeframe":{"start":"2009","end":"2010"}}', Logworm::QueryBuilder.new(:start => 2009, :end => 2010).to_json
+  end
+  
+  def test_limit
+    assert_equal '{"limit":10}', Logworm::QueryBuilder.new(:limit => 10).to_json
+    assert_equal '{}', Logworm::QueryBuilder.new(:limit => 200).to_json
+  end
+
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: logworm
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 1
+  version: 0.6.1
+platform: ruby
+authors: 
+- Pomelo, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: logworm logging tool
+email: schapira@pomelollc.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- README
+- lib/base/config.rb
+- lib/base/db.rb
+- lib/base/query_builder.rb
+- lib/logworm.rb
+files: 
+- CHANGELOG
+- Manifest
+- README
+- Rakefile
+- lib/base/config.rb
+- lib/base/db.rb
+- lib/base/query_builder.rb
+- lib/logworm.rb
+- tests/builder_test.rb
+- logworm.gemspec
+has_rdoc: true
+homepage: http://www.logworm.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Logworm
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: logworm
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: logworm logging tool
+test_files: []
+