keen 0.1.12 → 0.2.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 dorkitude
+Copyright (c) 2012 Keen Labs
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:minor: 1
-:build: 
-:patch: 12
 :major: 0
+:minor: 2
+:patch: 0
+:build: 

data/keen.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{keen}
-  s.version = "0.1.12"
+  s.name = "keen"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["dorkitude"]
-  s.date = %q{2012-06-22}
-  s.description = %q{See the github repo or examples.rb for usage information.}
-  s.email = %q{kyle@keen.io}
+  s.date = "2012-10-02"
+  s.description = "See the github repo or examples.rb for usage information."
+  s.email = "kyle@keen.io"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -46,11 +46,11 @@ Gem::Specification.new do |s|
     "lib/keen/version.rb",
     "send.rb"
   ]
-  s.homepage = %q{http://github.com/dorkitude/keen}
+  s.homepage = "http://github.com/dorkitude/keen"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.2}
-  s.summary = %q{A library for batching and sending arbitrary events to the Keen API at http://keen.io}
+  s.rubygems_version = "1.8.19"
+  s.summary = "A library for batching and sending arbitrary events to the Keen API at http://keen.io"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/keen/client.rb

@@ -15,7 +15,7 @@ module Keen
       if @options[:base_url]
         @options[:base_url]
       else
-        "https://api.keen.io/2.0"
+        "https://api.keen.io/3.0"
       end
     end
 
@@ -44,6 +44,8 @@ module Keen
       @cache_locally = options[:cache_locally]
 
       if @cache_locally
+        raise "Local caching not supported in this version."
+
         @storage_class = options[:storage_class]
         unless @storage_class and @storage_class < Keen::Async::Storage::BaseStorageHandler
           raise "The Storage Class you send must extend BaseStorageHandler.  You sent: #{@storage_class}"
@@ -63,73 +65,64 @@ module Keen
       @storage_handler
     end
 
-    def add_event(collection_name, event_body, timestamp=nil)
+    def add_event(event_collection, event_properties, timestamp=nil)
       #
-      # `collection_name` should be a string
+      # `event_collection` should be a string
       #
-      # `event_body` should be a JSON-serializable hash
+      # `event` should be a JSON-serializable hash
       #
       # `timestamp` is optional. If sent, it should be a Time instance.  
       #  If it's not sent, we'll use the current time.
       
-      validate_collection_name(collection_name)
+      validate_event_collection(event_collection)
 
-      unless timestamp
-        timestamp = Time.now
+      if timestamp
+        timestamp = timestamp.utc.iso8601
       end
 
-      timestamp = timestamp.utc.iso8601
+      event = Keen::Event.new(event_collection, event_properties)
 
-      event = Keen::Event.new(timestamp, collection_name, event_body)
+      # build the request:
+      url = "#{base_url}/projects/#{project_id}/events/#{event_collection}"
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.ca_file = Keen::Async::SSL_CA_FILE
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.verify_depth = 5
 
-      if @cache_locally
-        job = Keen::Async::Job.new(storage_handler, {
-          :timestamp => event.timestamp,
-          :project_id => @project_id,
-          :auth_token => @auth_token,
-          :collection_name => collection_name,
-          :event_body => event.body,
-        })
-
-        job.save
-      else
-        # build the request:
-        url = "#{base_url}/projects/#{project_id}/#{collection_name}"
-        uri = URI.parse(url)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        http.ca_file = Keen::Async::SSL_CA_FILE
-        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        http.verify_depth = 5
-
-        request = Net::HTTP::Post.new(uri.path)
-        request.body = JSON.generate({
-          :header => {
-            :timestamp => event.timestamp,
-          },
-          :body => event.body
-        })
-
-        request["Content-Type"] = "application/json"
-        request["Authorization"] = @auth_token
-
-        response = http.request(request)
-        JSON.parse response.body
+      request = Net::HTTP::Post.new(uri.path)
+
+      body = event.properties
+
+      if timestamp
+        request.body[:keen] = {
+          :timestamp => timestamp
+        }
       end
+
+      request.body = JSON.generate(body)
+
+      request["Content-Type"] = "application/json"
+      request["Authorization"] = @auth_token
+
+      response = http.request(request)
+      JSON.parse response.body
+
     end
 
     def send_batch(events)
       # make the request body:
       request_body = {}
       events.each { |event| 
-        unless request_body.has_key? event.collection_name
-          request_body[event.collection_name] = []
+        unless request_body.has_key? event.event_collection
+          request_body[event.event_collection] = []
         end
 
         header = {"timestamp" => event.timestamp}
         body = event.body
         item = {"header" => header, "body" => body}
-        request_body[event.collection_name].push(item)
+        request_body[event.event_collection].push(item)
       }
       request_body = request_body.to_json
     
@@ -154,10 +147,9 @@ module Keen
       end
 
       return JSON.parse resp.body
-
     end
 
-    def validate_collection_name(collection_name)
+    def validate_event_collection(event_collection)
       # TODO
     end
 

data/lib/keen/event.rb

@@ -1,12 +1,12 @@
 module Keen
   class Event
 
-    attr_accessor :timestamp, :collection_name, :body
+    attr_accessor :event_collection, :properties, :timestamp
 
-    def initialize(timestamp, collection_name, body)
+    def initialize(event_collection, properties, timestamp=nil)
+      @event_collection = event_collection
+      @properties = properties
       @timestamp = timestamp
-      @collection_name = collection_name
-      @body = body
     end
 
   end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: keen
 version: !ruby/object:Gem::Version 
-  hash: 3
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 12
-  version: 0.1.12
+  version: 0.2.0
 platform: ruby
 authors: 
 - dorkitude
@@ -15,132 +10,96 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-22 00:00:00 -07:00
-default_executable: 
+date: 2012-10-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: json
-  type: :runtime
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 6
-        - 5
         version: 1.6.5
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  type: :runtime
   prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: redis
-  type: :runtime
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+  type: :runtime
   prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: shoulda
-  type: :development
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rdoc
-  type: :development
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 3
-        - 12
         version: "3.12"
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: bundler
-  type: :development
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 1
-        - 4
         version: 1.1.4
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: jeweler
-  type: :development
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 1
-        - 8
-        - 3
         version: 1.8.3
-  requirement: *id006
-- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 2
-        - 9
-        - 0
         version: 2.9.0
-  requirement: *id007
-- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: cucumber
-  type: :development
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 2
-        - 1
         version: 1.2.1
-  requirement: *id008
+  type: :development
+  prerelease: false
+  version_requirements: *id008
 description: See the github repo or examples.rb for usage information.
 email: kyle@keen.io
 executables: []
@@ -179,7 +138,6 @@ files:
 - lib/keen/utils.rb
 - lib/keen/version.rb
 - send.rb
-has_rdoc: true
 homepage: http://github.com/dorkitude/keen
 licenses: 
 - MIT
@@ -193,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 742359420627870706
       segments: 
       - 0
       version: "0"
@@ -202,14 +160,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: A library for batching and sending arbitrary events to the Keen API at http://keen.io