keen 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1699510fc2d24980d980c0fc72cd2a8b95db715
-  data.tar.gz: a50d16fe6edff311e4482217a96a89f812b81988
+  metadata.gz: 64f0b30d33e55ce7197790586a4bdb00ad08390a
+  data.tar.gz: 6747562055bfacc541ed9ea647673579d8f78427
 SHA512:
-  metadata.gz: 8d4e6b05301f89eaf477bc95f4b9297ac22ca96706e3133458cccdff0bd2a2a0d0a6f6c377273e5358bee1924a0a52376068e8d34f4fcc875ec20d959a816ec3
-  data.tar.gz: eea17f8068313eefcb15f2c23460f23fccf212e1464e12050ee18f2069980d344581cb39228c38838a02f8363ab6bc0988b62b39cb488e019f9a70b1a092d5f5
+  metadata.gz: eaccbc7ea6b950f3582c06f237c7c49d8dea86bd314857b7842ddaf16b19cc22a8220ebe0e06056ae50cd2bb255598d2afec92f9b890073739e731b33683663e
+  data.tar.gz: 35ae078dbc0234070ecb08c41a4d5328e36ef4b652c4c0270983db1ab927405540a854c02b385f33e92aa2318f68f5fc18d1ec0fe133462373ca403c5395c0ea

data/README.md

@@ -25,15 +25,15 @@ keen is tested with Ruby 1.9.3 + and on:
 ### Usage
 
 Before making any API calls, you must supply keen-gem with a Project ID and one or more authentication keys.
-(If you need a Keen IO account, [sign up here](https://keen.io/signup?s=gh-gem) - it's free.) 
+(If you need a Keen IO account, [sign up here](https://keen.io/signup?s=gh-gem) - it's free.)
 
-Setting a write key is required for publishing events. Setting a read key is required for running queries. 
+Setting a write key is required for publishing events. Setting a read key is required for running queries.
 Setting a master key is required for performing deletes. You can find keys for all of your projects
 on [keen.io](https://keen.io?s=gh-gem).
 
-The recommended way to set keys is via the environment. The keys you can set are 
+The recommended way to set keys is via the environment. The keys you can set are
 `KEEN_PROJECT_ID`, `KEEN_WRITE_KEY`, `KEEN_READ_KEY` and `KEEN_MASTER_KEY`.
-You only need to specify the keys that correspond to the API calls you'll be performing. 
+You only need to specify the keys that correspond to the API calls you'll be performing.
 If you're using [foreman](http://ddollar.github.com/foreman/), add this to your `.env` file:
 
     KEEN_PROJECT_ID=aaaaaaaaaaaaaaa
@@ -57,8 +57,8 @@ Publishing events requires that `KEEN_WRITE_KEY` is set. Publish an event like t
 Keen.publish(:sign_ups, { :username => "lloyd", :referred_by => "harry" })
 ```
 
-This will publish an event to the `sign_ups` collection with the `username` and `referred_by` properties set. 
-The event properties can be any valid Ruby hash. Nested properties are allowed. Lists of objects are also allowed, but not recommended because they can be difficult to query over. See alternatives to lists of objects [here](http://stackoverflow.com/questions/24620330/nested-json-objects-in-keen-io). You can learn more about data modeling with Keen IO with the [Data Modeling Guide](https://keen.io/docs/event-data-modeling/event-data-intro/?s=gh-gem). 
+This will publish an event to the `sign_ups` collection with the `username` and `referred_by` properties set.
+The event properties can be any valid Ruby hash. Nested properties are allowed. Lists of objects are also allowed, but not recommended because they can be difficult to query over. See alternatives to lists of objects [here](http://stackoverflow.com/questions/24620330/nested-json-objects-in-keen-io). You can learn more about data modeling with Keen IO with the [Data Modeling Guide](https://keen.io/docs/event-data-modeling/event-data-intro/?s=gh-gem).
 
 Protip: Marshalling gems like [Blockhead](https://github.com/vinniefranco/blockhead) make converting structs or objects to hashes easier.
 
@@ -131,21 +131,21 @@ Keen.count("purchases", :timeframe => "today", :filters => [{
     "operator" => "eq",
     "property_value" => "harry"
   }]) # => 2
-  
+
 # Relative timeframes
 Keen.count("purchases", :timeframe => "today") # => 10
 
 # Absolute timeframes
-Keen.count("purchases", :timeframe => { 
-  :start => "2015-01-01T00:00:00Z", 
-  :end => "2015-31-01T00:00:00Z" 
+Keen.count("purchases", :timeframe => {
+  :start => "2015-01-01T00:00:00Z",
+  :end => "2015-31-01T00:00:00Z"
 }) # => 5
 
 # Extractions
 Keen.extraction("purchases", :timeframe => "today")  # => [{ "keen" => { "timestamp" => "2014-01-01T00:00:00Z" }, "price" => 20 }]
 
 # Funnels
-Keen.funnel(:steps => [{ 
+Keen.funnel(:steps => [{
   :actor_property => "username", :event_collection => "purchases", :timeframe => "yesterday" }, {
   :actor_property => "username", :event_collection => "referrals", :timeframe => "yesterday" }]) # => [20, 15]
 
@@ -259,7 +259,7 @@ Keen stores all date and time information in UTC!
 Keen.publish(:sign_ups, {
   :keen => { :timestamp => "2012-12-14T20:24:01.123000+00:00" },
   :username => "lloyd",
-  :referred_by => "harry" 
+  :referred_by => "harry"
 })
 ```
 
@@ -283,7 +283,7 @@ Keen.publish_batch(
 This call would publish 2 `signups` events and 2 `purchases` events - all in just one API call.
 Batch publishing is ideal for loading historical events into Keen IO.
 
-#### Asynchronous batch publishing 
+#### Asynchronous batch publishing
 
 Ensuring the above guidance is followed for asynchronous publishing, batch publishing logic can used asynchronously with `publish_batch_async`:
 
@@ -393,7 +393,7 @@ keen = Keen::Client.new(:proxy_type => 'socks5', :proxy_url => 'http://localhost
 
 ##### EventMachine
 
-If you run into `Keen::Error: Keen IO Exception: An EventMachine loop must be running to use publish_async calls` or 
+If you run into `Keen::Error: Keen IO Exception: An EventMachine loop must be running to use publish_async calls` or
 `Uncaught RuntimeError: eventmachine not initialized: evma_set_pending_connect_timeout`, this means that the EventMachine
 loop has died. This can happen for a variety of reasons, and every app is different. [Issue #22](https://github.com/keenlabs/keen-gem/issues/22) shows how to add some extra protection to avoid this situation.
 
@@ -412,6 +412,9 @@ If you want some bot protection, check out the [Voight-Kampff](https://github.co
 
 ### Changelog
 
+##### 0.9.6
++ Updated behavior of saved queries to allow fetching results using the READ KEY as opposed to requiring the MASTER KEY, making the gem consistent with https://keen.io/docs/api/#getting-saved-query-results 
+
 ##### 0.9.5
 + Fix bug with scoped key generation not working with newer Keen projects.
 
@@ -518,7 +521,7 @@ server-side querying processes require a Read key that should not be made public
 ### Questions & Support
 
 For questions, bugs, or suggestions about this gem:
-[File a Github Issue](https://github.com/keenlabs/keen-gem/issues). 
+[File a Github Issue](https://github.com/keenlabs/keen-gem/issues).
 
 For other Keen-IO related technical questions:
 ['keen-io' on Stack Overflow](http://stackoverflow.com/questions/tagged/keen-io)

data/lib/keen/client/saved_queries.rb

@@ -6,15 +6,18 @@ class SavedQueries
   end
 
   def all
-    process_response(saved_query_response)
+    process_response(saved_query_response(client.master_key))
   end
 
   def get(saved_query_name, results = false)
     saved_query_path = "/#{saved_query_name}"
+    api_key = client.master_key
     if results
       saved_query_path += "/result"
+      # The results path should use the READ KEY
+      api_key = client.read_key
     end
-    response = saved_query_response(saved_query_path)
+    response = saved_query_response(api_key, saved_query_path)
     response_body = JSON.parse(response.body, symbolize_names: true)
     process_response(response)
   end
@@ -41,10 +44,10 @@ class SavedQueries
 
   attr_reader :client
 
-  def saved_query_response(path = "")
+  def saved_query_response(api_key, path = "")
     Keen::HTTP::Sync.new(client.api_url, client.proxy_url, client.read_timeout).get(
       path: saved_query_base_url + path,
-      headers: api_headers(client.master_key, "sync")
+      headers: api_headers(api_key, "sync")
     )
   end
 

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.9.5"
+  VERSION = "0.9.6"
 end

data/spec/integration/saved_query_spec.rb

@@ -3,7 +3,8 @@ require File.expand_path("../spec_helper", __FILE__)
 describe "Saved Queries" do
   let(:project_id) { ENV["KEEN_PROJECT_ID"] }
   let(:master_key) { ENV["KEEN_MASTER_KEY"] }
-  let(:client) { Keen::Client.new(project_id: project_id, master_key: master_key) }
+  let(:read_key) { ENV["KEEN_READ_KEY"] }
+  let(:client) { Keen::Client.new(project_id: project_id, master_key: master_key, read_key: read_key) }
 
   describe "#all" do
     it "gets all saved_queries" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Alex Kleissner
@@ -9,132 +9,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.5
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fchange
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby_gntp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-readline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Send events and build analytics features into your Ruby applications.
@@ -143,9 +143,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
@@ -189,17 +189,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Keen IO API Client