keener 0.1.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in keener.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mateo Murphy
+
+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,32 @@
+# Keener
+
+[![Build Status](https://travis-ci.org/mateomurphy/keener.png?branch=master)](https://travis-ci.org/mateomurphy/keener)
+[![Dependency Status](https://gemnasium.com/mateomurphy/keener.png)](https://gemnasium.com/mateomurphy/keener)
+
+Unofficial gem for accessing the keen api, based on [Faraday](https://github.com/lostisland/faraday).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keener'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keener
+
+## Usage
+
+See http://www.rubydoc.info/github/mateomurphy/keener/master/frames, especially the Keener::Api module
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]

data/keener.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keener/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "keener"
+  gem.version       = Keener::VERSION
+  gem.authors       = ["Mateo Murphy"]
+  gem.email         = ["mateo.murphy@gmail.com"]
+  gem.description   = %q{Unofficial gem for accessing keen.io}
+  gem.summary       = %q{An unofficial gem for accessing keen.io}
+  gem.homepage      = "https://github.com/mateomurphy/keener"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency 'faraday', "~> 0.8.5"
+  gem.add_dependency 'faraday_middleware', '~> 0.9.0'
+  gem.add_dependency 'hashie', '~> 1.2.0'
+
+  gem.add_development_dependency "em-synchrony", "~> 1.0.3"
+  gem.add_development_dependency "em-http-request", "~> 1.0.3"
+  gem.add_development_dependency "typhoeus"
+  gem.add_development_dependency "rspec", "~> 2.12"
+  gem.add_development_dependency "vcr", "~> 2.4.0"
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+end

data/lib/keener/api.rb

@@ -0,0 +1,189 @@
+module Keener
+
+  # Implements direct access to the api
+  #
+  # See https://keen.io/docs/api/reference/ for detailed info
+  module Api
+    # GET returns the average across all numeric values for the target property in the event 
+    # collection matching the given criteria. Non-numeric values are ignored.
+    #
+    # @return [Resource]
+    def average(project_id, event_collection, target_property, options = {})
+      options[:event_collection] = event_collection
+      options[:target_property] = target_property
+
+      resource "projects/#{project_id}/queries/average", options
+    end
+
+    # GET returns the number of resources in the event collection matching the given criteria. 
+    #
+    # @return [Resource]
+    def count(project_id, event_collection, options = {})
+      options[:event_collection] = event_collection
+      
+      resource "projects/#{project_id}/queries/count", options
+    end
+
+    # GET returns the number of UNIQUE resources in the event collection matching the given criteria.
+    #
+    # @return [Resource]
+    def count_unique(project_id, event_collection, target_property, options = {})
+      options[:event_collection] = event_collection
+      options[:target_property] = target_property
+
+      resource "projects/#{project_id}/queries/count_unique", options
+    end
+
+    # GET returns the available child resources.
+    #
+    # @return [Resource]
+    def discovery
+      resource ''
+    end
+
+    # GET returns available schema information for this event collection, 
+    # including properties and their type. It also returns links to sub-resources.
+    #
+    # POST is for inserting one event at a time in a single request. Examples below.
+    #
+    # DELETE is for deleting the entire event collection. This is irreversible and will only work for collections under 10k events.
+    #
+    # @return [Resource]
+    def event_collection(project_id, event_collection)
+      resource "projects/#{project_id}/events/#{event_collection}"
+    end
+
+    # GET returns schema information for all the event collections in this project, 
+    # including properties and their type.
+    #
+    # POST is for inserting multiple events in one or more collections, in a single request.
+    #
+    # @return [Resource]    
+    def event_collections(project_id)
+      resource "projects/#{project_id}/events"
+    end
+
+    # GET creates an extraction request for full-form event data with all property values.
+    # If the query string parameter email is specified, then the extraction will be processed 
+    # asynchronously and an e-mail will be sent to the specified address when it completes.
+    # The email will include a link to a downloadable CSV file.
+    # If email is omitted, then the extraction will be processed in-line and results will be returned in the GET request.
+    #
+    # @return [Resource]
+    def extraction(project_id, options = {})
+      resource "projects/#{project_id}/queries/extraction", options
+    end
+
+    # Funnels count relevant events in succession.
+    #
+    # @return [Resource]
+    def funnel(project_id, options = {})
+      resource "projects/#{project_id}/queries/funnel", options
+    end
+
+    # GET returns the maximum numeric value for the target property in the event collection 
+    # matching the given criteria. Non-numeric values are ignored. 
+    #
+    # @return [Resource]
+    def maximum(project_id, event_collection, target_property, options = {})
+      options[:event_collection] = event_collection
+      options[:target_property] = target_property
+
+      resource "projects/#{project_id}/queries/maximum", options
+    end
+
+    # GET returns the minimum numeric value for the target property in the event collection 
+    # matching the given criteria. Non-numeric values are ignored.
+    #
+    # @return [Resource]
+    def minimum(project_id, event_collection, target_property, options = {})
+      options[:event_collection] = event_collection
+      options[:target_property] = target_property
+
+      resource "projects/#{project_id}/queries/minimum", options
+    end
+
+    # GET Returns detailed information about the specific project.
+    #
+    # @return [Resource]    
+    def project(project_id)
+      resource "projects/#{project_id}"
+    end
+
+    # GET Returns the projects accessible to the API user.
+    #
+    # @return [Resource]
+    def projects
+      resource 'projects'
+    end
+
+    # GET returns the property name, type, and a link to sub-resources.
+    #
+    # DELETE is for removing a property and deleting all values stored with that property name.
+    #
+    # @return [Resource]
+    def property(project_id, event_collection, property_name)
+      resource "projects/#{project_id}/events/#{event_collection}/properties/#{property_name}"
+    end
+
+    # GET returns the list of available queries.
+    #
+    # @return [Resource]
+    def queries(project_id)
+      resource "projects/#{project_id}/queries"
+    end
+
+    # Returns a resource object for the given url and options
+    #
+    # @return [Resource]
+    def resource(url, options = {})
+      Resource.new(url, options)
+    end
+
+    # GET returns information about the specified Saved Query and includes links to child-resources.
+    #
+    # PUT either inserts a new Saved Query if it doesn’t already exist, or updates an existing Saved Query if it does exist.
+    #
+    # DELETE just plain old deletes the Saved Query.
+    #
+    # @return [Resource]
+    def saved_query(project_id, saved_query_name, options)
+      resource "projects/#{project_id}/saved_queries/#{saved_query_name}", options
+    end
+
+    # GET returns the results of the specified Saved Query.
+    #
+    # @return [Resource]
+    def saved_query_result(project_id, saved_query_name)
+      resource "projects/#{project_id}/saved_queries/#{saved_query_name}/result"
+    end
+
+    # GET returns all the available Saved Queries for the specified project as well as links to child-resources.
+    #
+    # @return [Resource]
+    def saved_queries(project_id)
+      resource "projects/#{project_id}/saved_queries", options
+    end
+
+    # GET returns a list of UNIQUE resources in the event collection matching the given criteria. 
+    #
+    # @return [Resource]
+    def select_unique(project_id, event_collection, target_property, options = {})
+      options[:event_collection] = event_collection
+      options[:target_property] = target_property
+
+      resource "projects/#{project_id}/queries/select_unique", options
+    end
+
+    # GET returns the sum of all numeric values for the target property in the 
+    # event collection matching the given criteria. Non-numeric values are ignored.
+    #
+    # @return [Resource]
+    def sum(project_id, event_collection, target_property, options = {})
+      options[:event_collection] = event_collection
+      options[:target_property] = target_property
+
+      resource "projects/#{project_id}/queries/sum", options
+    end
+  end
+end

data/lib/keener/config.rb

@@ -0,0 +1,9 @@
+module Keener
+  module Config
+    attr_accessor :api_key
+    attr_accessor :log_responses
+    attr_accessor :adapter
+    attr_accessor :use_ssl
+    attr_accessor :ssl_config
+  end
+end

data/lib/keener/connection.rb

@@ -0,0 +1,35 @@
+module Keener
+  module Connection
+    def url
+      if Keener.use_ssl
+        'https://api.keen.io'
+      else
+        'http://api.keen.io'
+      end
+    end
+
+    def connection
+      @connection ||= ::Faraday.new(:url => url, :ssl => ssl_config) do |config|
+        config.headers['Authorization'] = Keener.api_key
+        config.headers['Content-Type'] = 'application/json'
+
+        config.use Response::Middleware
+        config.response :json
+        config.response :logger if Keener.log_responses
+
+        #config.use      :instrumentation      
+        config.adapter Keener.adapter || ::Faraday.default_adapter
+      end
+    end
+
+    def reset_connection
+      @connection = nil
+    end
+
+    def in_parallel(manager = nil, &block)
+      connection.in_parallel(manager) do
+        block.call(self)
+      end
+    end
+  end
+end

data/lib/keener/errors.rb

@@ -0,0 +1,7 @@
+module Keener
+  class Error < StandardError
+    class ResourceNotFoundError < Error; end
+  end
+end
+
+

data/lib/keener/query.rb

@@ -0,0 +1,70 @@
+module Keener
+  class Query
+    def initialize(project_id, event_collection, options = {})
+      @project_id = project_id
+      @event_collection = event_collection
+      @options = options
+    end
+  end
+
+  class Metric < Query
+    def add_filter(property, operator, value)
+      @options[:filters] ||= []
+      @options[:filters] << {
+        :property_name => property,
+        :operator => operator,
+        :property_value => value
+      }
+      self
+    end
+
+    def interval(interval)
+      @options[:interval] = interval
+      self
+    end
+
+    def timeframe(timeframe)
+      @options[:timeframe] = timeframe
+      self
+    end
+
+    def group_by(group_by)
+      @options[:group_by] = group_by
+      self
+    end
+
+    def count
+      Keened.count(@project_id, @event_collection, @options).get
+    end
+
+    def count_unique(target_property)
+      Keened.count_unique(@project_id, @event_collection, target_property, @options).get
+    end
+
+    def minimum(target_property)
+      Keened.minimum(@project_id, @event_collection, target_property, @options).get
+    end
+
+    def maximum(target_property)
+      Keened.maximum(@project_id, @event_collection, target_property, @options).get
+    end
+
+    def sum(target_property)
+      Keened.sum(@project_id, @event_collection, target_property, @options).get
+    end
+
+    def average(target_property)
+      Keened.average(@project_id, @event_collection, target_property, @options).get
+    end
+  end
+
+  #TODO implement
+  class Funnel < Query
+
+  end
+
+  #TODO implement
+  class Step < Query
+
+  end
+end

data/lib/keener/resource.rb

@@ -0,0 +1,51 @@
+module Keener
+  # This class represents an API resource and supports methods for making calls on it
+  class Resource
+    attr_reader :url, :options
+
+    def initialize(url = '', options = {})
+      @url = url
+      @options = options
+    end
+
+    # Performs a get request on the given resource. A block passed will be used as an on_complete callback
+    #
+    # @return [Hashie::Mash] An object representing the result of the request
+    def get(&block)
+      handle_response Keener.connection.get("#{version}/#{url}", options), &block
+    end
+
+    # Performs a head request on the given resource
+    #
+    # @return [Faraday::Response] A faraday response object
+    def head
+      Keener.connection.head("#{version}/#{url}", options)
+    end
+
+    # Checks the given body to see if it's an error object and raises it if it is
+    def check_for_errors(body)
+      raise body if body.is_a?(Error)
+      body
+    end
+
+    # Handles a faraday response, checking if it's an error, and setting up a callback with the passed block
+    def handle_response(response, &block)
+      if response.finished?
+        response = check_for_errors(response.body)
+      end
+      
+      if block
+        response.on_complete do |env|
+          block.call(env[:body])
+        end
+      end
+        
+      response
+    end
+
+    # Returns the Keen API version to use for requests
+    def version
+      '3.0'
+    end
+  end
+end

data/lib/keener/response.rb

@@ -0,0 +1,28 @@
+require 'hashie/mash'
+
+module Keener
+  class Response
+    class Middleware < ::Faraday::Response::Middleware
+      def check_for_errors(body)
+        if body.respond_to?(:error_code)
+          Error.const_get(body.error_code).new(body.message)
+        else 
+          body
+        end
+      end
+
+      def parse(body)
+        case body
+        when Hash
+          check_for_errors(::Hashie::Mash.new(body))
+        when Array
+          body.map { |item| parse(item) }
+        else
+          body
+        end
+      end
+
+    end
+
+  end
+end

data/lib/keener/version.rb

@@ -0,0 +1,3 @@
+module Keener
+  VERSION = "0.1.0"
+end

data/lib/keener.rb

@@ -0,0 +1,18 @@
+require 'keener/version'
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'keener/config'
+require 'keener/response'
+require 'keener/connection'
+require 'keener/resource'
+require 'keener/errors'
+require 'keener/api'
+require 'keener/query'
+
+module Keener
+  extend Api
+  extend Config
+  extend Connection
+end

data/spec/adapters_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'adapters' do
+  describe 'em-http' do
+    before :all do
+      Keener.reset_connection
+      Keener.adapter = :em_http
+    end
+
+    it_behaves_like "a sync adapter"
+    it_behaves_like "an async adapter"
+    it_behaves_like "a parallel adapter"
+  end
+
+  describe 'em-synchrony' do
+    before :all do
+      Keener.reset_connection
+      Keener.adapter = :em_synchrony
+    end
+
+    it_behaves_like "a sync adapter"
+    it_behaves_like "a parallel adapter"
+  end
+
+  describe 'typhoeus' do
+    before :all do
+      Keener.reset_connection
+      Keener.adapter = :typhoeus
+    end
+
+    it_behaves_like "a sync adapter"
+    it_behaves_like "a parallel adapter"
+  end  
+end

data/spec/config_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Keener::Config do
+  it 'can get and set a config' do
+    Keener.api_key.should eq(API_KEY)
+  end
+end

data/spec/fixtures/vcr_cassettes/count/grouped.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.keen.io/3.0/projects/50e8d5f43843316b28000001/queries/count?group_by=character&event_collection=votes
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - b82b029917fa49af84a5827a43e537a7
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      date:
+      - Thu, 07 Feb 2013 18:39:38 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '597'
+      expires:
+      - Thu, 07 Feb 2013 18:39:38 GMT
+      server:
+      - TornadoServer/2.4.1
+      etag:
+      - ! '"4a71bc462e514e53611cd6f04711fe4d1f68693a"'
+      cache-control:
+      - private, max-age=0, s-maxage=0
+      access-control-allow-origin:
+      - ! '*'
+      access-control-allow-headers:
+      - origin, content-type, accept, authorization, user-agent
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"result\": [\n    {\n      \"character\": \"Troi\", \n      \"result\":
+        101\n    }, \n    {\n      \"character\": \"LaForge\", \n      \"result\":
+        571\n    }, \n    {\n      \"character\": \"No answer\", \n      \"result\":
+        397\n    }, \n    {\n      \"character\": \"Crusher\", \n      \"result\":
+        200\n    }, \n    {\n      \"character\": \"Replicator\", \n      \"result\":
+        171\n    }, \n    {\n      \"character\": \"Worf\", \n      \"result\": 330\n
+        \   }, \n    {\n      \"character\": \"Riker\", \n      \"result\": 280\n
+        \   }, \n    {\n      \"character\": \"Data\", \n      \"result\": 342\n    },
+        \n    {\n      \"character\": \"Picard\", \n      \"result\": 365\n    }\n
+        \ ]\n}"
+    http_version: 
+  recorded_at: Thu, 07 Feb 2013 18:39:38 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/vcr_cassettes/count/no_options.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.keen.io/3.0/projects/50e8d5f43843316b28000001/queries/count?event_collection=votes
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - b82b029917fa49af84a5827a43e537a7
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      date:
+      - Thu, 07 Feb 2013 18:39:38 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '20'
+      expires:
+      - Thu, 07 Feb 2013 18:39:38 GMT
+      server:
+      - TornadoServer/2.4.1
+      etag:
+      - ! '"09d8b72d478662bc62110091a94b0191b8133575"'
+      cache-control:
+      - private, max-age=0, s-maxage=0
+      access-control-allow-origin:
+      - ! '*'
+      access-control-allow-headers:
+      - origin, content-type, accept, authorization, user-agent
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"result\": 2757\n}"
+    http_version: 
+  recorded_at: Thu, 07 Feb 2013 18:39:38 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/vcr_cassettes/count_unique.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.keen.io/3.0/projects/50e8d5f43843316b28000001/queries/count_unique?event_collection=votes&target_property=character
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - b82b029917fa49af84a5827a43e537a7
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      date:
+      - Thu, 07 Feb 2013 18:24:12 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '17'
+      expires:
+      - Thu, 07 Feb 2013 18:24:12 GMT
+      server:
+      - TornadoServer/2.4.1
+      etag:
+      - ! '"07466cb5e5c2fa78072724132267ff0967888ade"'
+      cache-control:
+      - private, max-age=0, s-maxage=0
+      access-control-allow-origin:
+      - ! '*'
+      access-control-allow-headers:
+      - origin, content-type, accept, authorization, user-agent
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"result\": 9\n}"
+    http_version: 
+  recorded_at: Thu, 07 Feb 2013 18:24:12 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/vcr_cassettes/events.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.keen.io/3.0/projects/50e8d5f43843316b28000001/events
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - b82b029917fa49af84a5827a43e537a7
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      date:
+      - Thu, 07 Feb 2013 18:07:17 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '229'
+      expires:
+      - Thu, 07 Feb 2013 18:07:16 GMT
+      server:
+      - TornadoServer/2.4.1
+      etag:
+      - ! '"9ea36ba679175b5949aca20923f1880f41c72528"'
+      cache-control:
+      - private, max-age=0, s-maxage=0
+      access-control-allow-origin:
+      - ! '*'
+      access-control-allow-headers:
+      - origin, content-type, accept, authorization, user-agent
+    body:
+      encoding: US-ASCII
+      string: ! "[\n  {\n    \"name\": \"votes\", \n    \"properties\": {\n      \"character\":
+        \"string\", \n      \"keen.created_at\": \"datetime\", \n      \"keen.timestamp\":
+        \"datetime\"\n    }, \n    \"url\": \"/3.0/projects/50e8d5f43843316b28000001/events/votes\"\n
+        \ }\n]"
+    http_version: 
+  recorded_at: Thu, 07 Feb 2013 18:07:17 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/vcr_cassettes/project.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.keen.io/3.0/projects/50e8d5f43843316b28000001
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - b82b029917fa49af84a5827a43e537a7
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      date:
+      - Thu, 07 Feb 2013 18:16:37 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '718'
+      expires:
+      - Thu, 07 Feb 2013 18:16:36 GMT
+      server:
+      - TornadoServer/2.4.1
+      etag:
+      - ! '"0b93639278b4fbbc87a2ca117e3f58cf638385eb"'
+      cache-control:
+      - private, max-age=0, s-maxage=0
+      access-control-allow-origin:
+      - ! '*'
+      access-control-allow-headers:
+      - origin, content-type, accept, authorization, user-agent
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"api_key\": \"b82b029917fa49af84a5827a43e537a7\", \n  \"events\":
+        [\n    {\n      \"name\": \"votes\", \n      \"url\": \"/3.0/projects/50e8d5f43843316b28000001/votes\"\n
+        \   }\n  ], \n  \"events_url\": \"/3.0/projects/50e8d5f43843316b28000001/events\",
+        \n  \"id\": \"50e8d5f43843316b28000001\", \n  \"name\": \"RubyExampleApp\",
+        \n  \"organization_id\": \"505e1a90897a2c2fbf000000\", \n  \"partners_url\":
+        \"/3.0/projects/50e8d5f43843316b28000001/partners\", \n  \"queries_url\":
+        \"/3.0/projects/50e8d5f43843316b28000001/queries\", \n  \"saved_queries\":
+        [], \n  \"saved_queries_url\": \"/3.0/projects/50e8d5f43843316b28000001/saved_queries\",
+        \n  \"settings\": {\n    \"analysis_limit\": 100, \n    \"event_limit\": 10000\n
+        \ }, \n  \"url\": \"/3.0/projects/50e8d5f43843316b28000001\"\n}"
+    http_version: 
+  recorded_at: Thu, 07 Feb 2013 18:16:37 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/vcr_cassettes/projects.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.keen.io/3.0/projects
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - b82b029917fa49af84a5827a43e537a7
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      date:
+      - Thu, 07 Feb 2013 18:04:31 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '766'
+      expires:
+      - Thu, 07 Feb 2013 18:04:31 GMT
+      server:
+      - TornadoServer/2.4.1
+      etag:
+      - ! '"a8a0a1a620dc6345a3c77036f100da54dd5eb7e3"'
+      cache-control:
+      - private, max-age=0, s-maxage=0
+      access-control-allow-origin:
+      - ! '*'
+      access-control-allow-headers:
+      - origin, content-type, accept, authorization, user-agent
+    body:
+      encoding: US-ASCII
+      string: ! "[\n  {\n    \"api_key\": \"b82b029917fa49af84a5827a43e537a7\", \n
+        \   \"events\": [\n      {\n        \"name\": \"votes\", \n        \"url\":
+        \"/3.0/projects/50e8d5f43843316b28000001/votes\"\n      }\n    ], \n    \"events_url\":
+        \"/3.0/projects/50e8d5f43843316b28000001/events\", \n    \"id\": \"50e8d5f43843316b28000001\",
+        \n    \"name\": \"RubyExampleApp\", \n    \"organization_id\": \"505e1a90897a2c2fbf000000\",
+        \n    \"partners_url\": \"/3.0/projects/50e8d5f43843316b28000001/partners\",
+        \n    \"queries_url\": \"/3.0/projects/50e8d5f43843316b28000001/queries\",
+        \n    \"saved_queries\": [], \n    \"saved_queries_url\": \"/3.0/projects/50e8d5f43843316b28000001/saved_queries\",
+        \n    \"settings\": {\n      \"analysis_limit\": 100, \n      \"event_limit\":
+        10000\n    }, \n    \"url\": \"/3.0/projects/50e8d5f43843316b28000001\"\n
+        \ }\n]"
+    http_version: 
+  recorded_at: Thu, 07 Feb 2013 18:04:31 GMT
+recorded_with: VCR 2.4.0

data/spec/integration/api_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Keener::Api do
+  before :all do
+    Keener.reset_connection    
+    Keener.adapter = nil
+  end
+
+  describe 'errors' do
+    it 'raises a not found error' do
+      expect { Keener.project('xxx').get }.to raise_error(Keener::Error::ResourceNotFoundError)
+    end
+  end
+
+  describe '.count' do
+    context 'without options', :vcr => { :cassette_name => 'count/no_options' } do
+      subject :count do
+        Keener.count(PROJECT_ID, COLLECTION_NAME).get
+      end
+
+      its (:result) { should eq(2757) }
+    end
+
+    context 'grouped by character', :vcr => { :cassette_name => 'count/grouped' } do
+      subject :count do
+        Keener.count(PROJECT_ID, COLLECTION_NAME, :group_by => 'character').get.result.first
+      end
+
+      its (:character) { should eq('Troi') }
+      its (:result) { should eq(101) }
+    end    
+  end
+
+  describe '.count_unique', :vcr => { :cassette_name => 'count_unique' } do
+    subject :count_unique do
+      Keener.count_unique(PROJECT_ID, COLLECTION_NAME, 'character').get
+    end
+
+    its (:result) { should eq(9) }
+  end
+
+  describe '.event_collections', :vcr => { :cassette_name => 'events' } do
+    subject :events do
+      Keener.event_collections(PROJECT_ID).get
+    end
+
+    its (:count) { should eq(1)}
+
+    it 'returns votes' do
+      events.first.name.should eq('votes')
+    end
+  end
+
+  describe '.project', :vcr => { :cassette_name => 'project' } do
+    subject :project do
+      Keener.project(PROJECT_ID).get
+    end
+
+    it 'returns the right project id' do
+      project.id.should eq(PROJECT_ID)
+    end
+  end
+
+  describe '.projects', :vcr => { :cassette_name => 'projects' } do
+    subject :projects do
+      Keener.projects.get
+    end
+
+    its (:count) { should eq(1)}
+
+    it 'returns the right project id' do
+      projects.first.id.should eq(PROJECT_ID)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'keener'
+require 'vcr'
+require 'eventmachine'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+
+# Integration test data
+PROJECT_ID = "50e8d5f43843316b28000001"
+API_KEY = "b82b029917fa49af84a5827a43e537a7"
+COLLECTION_NAME = "votes"
+
+Keener.api_key = API_KEY
+
+VCR.configure do |c|  
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :faraday
+  c.configure_rspec_metadata!
+  
+  # Async tests don't work with vcr
+  c.allow_http_connections_when_no_cassette = true
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  #config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}

data/spec/support/shared_examples.rb

@@ -0,0 +1,55 @@
+shared_examples 'a sync adapter' do
+  it 'makes a blocking request' do
+    Keener.projects.get.first.id.should eq(PROJECT_ID)
+  end 
+end
+
+shared_examples 'an async adapter' do
+  it 'calls a passed block' do
+    EventMachine.run do
+      Keener.projects.get { |response|
+        response.first.id.should eq(PROJECT_ID)
+        EventMachine.stop
+      }
+    end
+  end
+
+  it 'returns a response' do
+    EventMachine.run do
+      Keener.projects.get.on_complete { |env|
+        env[:body].first.id.should eq(PROJECT_ID)
+        EventMachine.stop
+      }
+    end
+  end
+
+  it 'returns a body containing a ResourceNotFoundError' do
+    EventMachine.run do
+      Keener.project('xxx').get.on_complete { |env|
+        env[:body].should be_a(Keener::Error::ResourceNotFoundError)
+        EventMachine.stop
+      }
+    end
+  end
+end
+
+shared_examples 'a parallel adapter' do
+  subject :responses do
+    responses = []
+
+    Keener.in_parallel do |k|
+      responses << k.count(PROJECT_ID, COLLECTION_NAME).get
+      responses << k.count_unique(PROJECT_ID, COLLECTION_NAME, 'character').get
+    end
+
+    responses
+  end
+
+  it 'return the count' do
+    responses.first.body.result.should eq(2757)
+  end
+
+  it 'returns the unique count' do
+    responses.last.body.result.should eq(9)
+  end
+end

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification
+name: keener
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mateo Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: em-synchrony
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Unofficial gem for accessing keen.io
+email:
+- mateo.murphy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- keener.gemspec
+- lib/keener.rb
+- lib/keener/api.rb
+- lib/keener/config.rb
+- lib/keener/connection.rb
+- lib/keener/errors.rb
+- lib/keener/query.rb
+- lib/keener/resource.rb
+- lib/keener/response.rb
+- lib/keener/version.rb
+- spec/adapters_spec.rb
+- spec/config_spec.rb
+- spec/fixtures/vcr_cassettes/count/grouped.yml
+- spec/fixtures/vcr_cassettes/count/no_options.yml
+- spec/fixtures/vcr_cassettes/count_unique.yml
+- spec/fixtures/vcr_cassettes/events.yml
+- spec/fixtures/vcr_cassettes/project.yml
+- spec/fixtures/vcr_cassettes/projects.yml
+- spec/integration/api_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/mateomurphy/keener
+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'
+      segments:
+      - 0
+      hash: 134372974807999632
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 134372974807999632
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An unofficial gem for accessing keen.io
+test_files:
+- spec/adapters_spec.rb
+- spec/config_spec.rb
+- spec/fixtures/vcr_cassettes/count/grouped.yml
+- spec/fixtures/vcr_cassettes/count/no_options.yml
+- spec/fixtures/vcr_cassettes/count_unique.yml
+- spec/fixtures/vcr_cassettes/events.yml
+- spec/fixtures/vcr_cassettes/project.yml
+- spec/fixtures/vcr_cassettes/projects.yml
+- spec/integration/api_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+has_rdoc: