keen 0.8.9 → 0.8.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8215941d3fa167bb6a6dee9cca7676cbe7eb1747
+  data.tar.gz: 70feb127ffdda8835bab9a88bcb60cc181445d4e
+SHA512:
+  metadata.gz: b84e12067e3cd9407ddc50fa7d84c84f957da770ee00986c830a37ef2f2973e7f28c5acc81dff0705bd955545e0ace977a6eeaca7fbe89944823e1b9402832df
+  data.tar.gz: dec784de84eb32a24c3386b0af53d606f80b5640153ee86e8b33b5c7be9051668f86ff8846a9b0ae86b232de9ea964a9efa482536c27a4fb5a0c2db429544727

data/README.md

@@ -175,6 +175,7 @@ This simplifes querying code where the analysis type is dynamic.
 Each query method or alias takes an optional hash of options as an additional parameter. Possible keys are:
 
 `:response` – Set to `:all_keys` to return the full API response (usually only the value of the `"result"` key is returned).
+`:method` - Set to `:post` to enable post body based query (https://keen.io/docs/data-analysis/post-queries/).
 
 ##### Getting Query URLs
 
@@ -376,8 +377,19 @@ loop has died. This can happen for a variety of reasons, and every app is differ
 If you write a script that uses `publish_async`, you need to keep the script alive long enough for the call(s) to complete.
 EventMachine itself won't do this because it runs in a different thread. Here's an [example gist](https://gist.github.com/dzello/7472823) that shows how to exit the process after the event has been recorded.
 
+### Additional Considerations
+
+##### Bots
+
+It's not just us humans that browse the web. Spiders, crawlers, and bots share the pipes too. When it comes to analytics, this can cause a mild headache. Events generated by bots can inflate your metrics and eat up your event quota.
+
+If you want some bot protection, check out the [Voight-Kampff](https://github.com/biola/Voight-Kampff) gem. Use the gem's `request.bot?` method to detect bots and avoid logging events.
+
 ### Changelog
 
+##### 0.8.10
++ Added support for posting queries. Thanks [@soloman1124](https://github.com/soloman1124).
+
 ##### 0.8.9
 + Fix proxy support for sync client. Thanks [@nvieirafelipe](https://github.com/nvieirafelipe)!
 

data/keen.gemspec

@@ -5,8 +5,8 @@ require "keen/version"
 Gem::Specification.new do |s|
   s.name        = "keen"
   s.version     = Keen::VERSION
-  s.authors     = ["Kyle Wild", "Josh Dzielak", "Daniel Kador"]
-  s.email       = "josh@keen.io"
+  s.authors     = ["Alex Kleissner", "Josh Dzielak", "Joe Wegner"]
+  s.email       = "opensource@keen.io"
   s.homepage    = "https://github.com/keenlabs/keen-gem"
   s.summary     = "Keen IO API Client"
   s.description = "Send events and build analytics features into your Ruby applications."

data/lib/keen/client/querying_methods.rb

@@ -220,8 +220,14 @@ module Keen
       #   filters (optional) [Array]
       #   timezone (optional)
       def query(analysis_type, event_collection, params={}, options={})
-        url = _query_url(analysis_type, event_collection, params, options)
-        response = get_response(url)
+        response =
+          if options[:method] == :post
+            post_query(analysis_type, event_collection, params)
+          else
+            url = _query_url(analysis_type, event_collection, params, options)
+            get_response(url)
+          end
+
         response_body = response.body.chomp
         api_result = process_response(response.code, response_body)
         api_result = api_result["result"] unless options[:response] == :all_keys
@@ -230,6 +236,21 @@ module Keen
 
       private
 
+      def post_query(analysis_type, event_collection, params={})
+        ensure_project_id!
+        ensure_read_key!
+
+        query_params = params.dup
+        query_params[:event_collection] = event_collection.to_s if event_collection
+        Keen::HTTP::Sync.new(self.api_url, self.proxy_url, self.read_timeout).post(
+          :path => api_query_resource_path(analysis_type),
+          :headers => api_headers(self.read_key, "sync"),
+          :body => MultiJson.encode(query_params)
+        )
+      rescue Exception => http_error
+        raise HttpError.new("Couldn't perform #{@analysis_type} on Keen IO: #{http_error.message}", http_error)
+      end
+
       def _query_url(analysis_type, event_collection, params={}, options={})
         ensure_project_id!
         ensure_read_key!

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.8.9"
+  VERSION = "0.8.10"
 end

data/spec/keen/client/querying_methods_spec.rb

@@ -10,7 +10,7 @@ describe Keen::Client do
     :project_id => project_id, :read_key => read_key,
     :api_url => api_url ) }
 
-  def query_url(query_name, query_params)
+  def query_url(query_name, query_params = "")
     "#{api_url}/#{api_version}/projects/#{project_id}/queries/#{query_name}#{query_params}"
   end
 
@@ -147,6 +147,19 @@ describe Keen::Client do
         api_response = query.call("funnel", nil, { :steps => [] }, { :response => :all_keys })
         api_response.should == { "result" => [1] }
       end
+
+      it "should call API with post body if method opton is set to post " do
+        steps = [{
+          :event_collection => "sign ups",
+          :actor_property => "user.id"
+        }]
+        expected_url = query_url("funnel")
+        stub_keen_post(expected_url, 200, :result => 1)
+        response = query.call("funnel", nil, { :steps => steps }, { :method => :post })
+
+        expect_keen_post(expected_url, { :steps => steps }, "sync", read_key)
+        response.should == api_response["result"]
+      end
     end
   end
 

metadata

@@ -1,187 +1,152 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.8.9
-  prerelease: 
+  version: 0.8.10
 platform: ruby
 authors:
-- Kyle Wild
+- Alex Kleissner
 - Josh Dzielak
-- Daniel Kador
+- Joe Wegner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-27 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.5
 - !ruby/object:Gem::Dependency
   name: guard
   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: guard-rspec
   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: rb-inotify
   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: rb-fsevent
   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: rb-fchange
   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: ruby_gntp
   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: rb-readline
   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: debugger
-  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: Send events and build analytics features into your Ruby applications.
-email: josh@keen.io
+email: opensource@keen.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -213,27 +178,26 @@ files:
 homepage: https://github.com/keenlabs/keen-gem
 licenses:
 - MIT
+metadata: {}
 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.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Keen IO API Client
 test_files:
 - spec/integration/api_spec.rb
@@ -248,4 +212,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/synchrony/spec_helper.rb
 - spec/synchrony/synchrony_spec.rb
-has_rdoc: