logworm_client 0.6.0 → 0.6.1

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.6.1
+    Added a bit of documentation
+
 v0.6.0 
     Add support for querying API: lw_query
     

data/Rakefile

@@ -1,5 +1,5 @@
 require 'echoe'
-Echoe.new('logworm_client', '0.6.0') do |p|
+Echoe.new('logworm_client', '0.6.1') do |p|
   p.description = "logworm client utilities"
   p.url = "http://www.logworm.com"
   p.author = "Pomelo, LLC"

data/lib/logworm_client.rb

@@ -11,6 +11,20 @@ end
 ###
 # Perform a query against the logworm server
 # 
+# Requires a log table, and a query
+# The query can be provided as a JSON string, following the syntax described in http://www.logworm.com/docs/query
+#  or as a Hash of options, with the following keys (all optional)
+#   :fields             => String with a comma-separated list of fields (quoted or not), or Array of Strings
+#   :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
+# 
+# See Logworm::QueryBuilder
+# 
 # Returns Hash with
 #  id              ==> id of the query
 #  query_url       ==> URL to GET information about the query
@@ -21,9 +35,10 @@ end
 #  results         ==> array of hashmaps. Each element corresponds to a log entry, with its fields
 #
 # raises Logworm::DatabaseException, Logworm::ForbiddenAccessException, Logworm::InvalidQueryException
+# or just a regular Exception if it cannot find the URL to the logging database
 ###
 def lw_query(table, query) 
-  db = Logworm::DB.from_config                                          # Establish connection to DB
+  db = Logworm::DB.from_config_or_die                                   # Establish connection to DB
   query = Logworm::QueryBuilder.new(query).to_json if query.is_a? Hash  # Turn query into proper JSON string
   query_data = db.query(table, query)                                   # POST to create query
   db.results(query_data["results_uri"])                                 # GET from query's results uri

data/logworm_client.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{logworm_client}
-  s.version = "0.6.0"
+  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"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Pomelo, LLC