keen 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 065f80ef6be231a709d26afe30ae76a8a1138812
-  data.tar.gz: d6a07538cff945becfa38fc12015f1e0244d9032
+  metadata.gz: c47eef1b0e54dae99c1ea8b602cf656cd42802db
+  data.tar.gz: 34f117595df684a9634475892330fff3d22ac7e8
 SHA512:
-  metadata.gz: 40e792c1cd92e85b901b365ad3f27a146e964094cb25475a252b36f903760eb319055d620eb2ceee371ccb7fbb3bc7bfddb306c0b871b07b50d96e741f2f4a5e
-  data.tar.gz: 5b65635514c0be2d55107f3d1aa3a532a2d502f3b9599817daa691e9adcfb6f1e3ff8505e9ad74b6ee2d296fef8f099e4a67080e7717a0a0dbb577c602d44201
+  metadata.gz: 161ab7ad63b06647a52afe0714564cd53cc03ee720f28e3916cca4b7703b2c39ef1b48fc87ba596655795f93c6beb72e89ba0239f9045757727c9f388b59be86
+  data.tar.gz: 5d7bc3a97aedc1b508bda127b133e191088f5cc1b369fe21f0310da92fae78164410396621626abbf66bd356a9e7cd14eb89dc6f07ea1b2ac09c2c668cfaa2a6

data/README.md

@@ -175,6 +175,16 @@ Each query method or alias takes an optional hash of options as an additional pa
 `: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/).
 
+##### Query Logging
+
+You can log all GET and POST queries automatically by setting the `log_queries` option.
+
+``` ruby
+Keen.log_queries = true
+Keen.count('purchases')
+# I, [2016-10-30T11:45:24.678745 #9978]  INFO -- : [KEEN] Send GET query to https://api.keen.io/3.0/projects/<YOUR_PROJECT_ID>/queries/count?event_collection=purchases with options {}
+```
+
 ### Saved Queries
 
 You can manage your saved queries from the Keen ruby client.
@@ -447,6 +457,10 @@ If you want some bot protection, check out the [Voight-Kampff](https://github.co
 
 ### Changelog
 
+##### 1.1.1
++ Added an option to log queries
++ Added a cli option that includes the Keen code
+
 ##### 1.1.0
 + Add support for access keys
 + Move saved queries into the Keen namespace
@@ -602,10 +616,21 @@ Similarly, you can use guard to listen for changes to files and run specs.
 
 `bundle exec guard -g synchrony`
 
+#### Running a Local Console
+
+You can spawn an `irb` session with the local files already loaded for debugging
+or experimentation.
+
+```
+$ bundle exec rake console
+2.2.6 :001 > Keen
+ => Keen 
+```
 ### Community Contributors
 + [alexkwolfe](https://github.com/alexkwolfe)
 + [peteygao](https://github.com/peteygao)
 + [obieq](https://github.com/obieq)
 + [cbartlett](https://github.com/cbartlett)
++ [myrridin](https://github.com/myrridin)
 
 Thanks everyone, you rock!

data/Rakefile

@@ -21,5 +21,10 @@ RSpec::Core::RakeTask.new(:pattern) do |t|
   t.pattern = "spec/#{ENV['PATTERN']}/**/*_spec.rb"
 end
 
+desc "Start a development console with local code loaded"
+task :console do
+  exec "irb -r keen -I ./lib"
+end
+
 task :default => :spec
 task :test => [:spec]

data/lib/keen.rb

@@ -33,7 +33,8 @@ module Keen
                    :write_key, :write_key=,
                    :read_key, :read_key=,
                    :master_key, :master_key=,
-                   :api_url, :api_url=
+                   :api_url, :api_url=,
+                   :log_queries, :log_queries=
 
     def_delegators :default_client,
                    :proxy_url, :proxy_url=,

data/lib/keen/client.rb

@@ -16,7 +16,7 @@ module Keen
     include Keen::Client::QueryingMethods
     include Keen::Client::MaintenanceMethods
 
-    attr_accessor :project_id, :write_key, :read_key, :master_key, :api_url, :proxy_url, :proxy_type, :read_timeout, :open_timeout
+    attr_accessor :project_id, :write_key, :read_key, :master_key, :api_url, :proxy_url, :proxy_type, :read_timeout, :log_queries, :open_timeout
 
     CONFIG = {
       :api_url => "https://api.keen.io",

data/lib/keen/client/querying_methods.rb

@@ -240,6 +240,8 @@ module Keen
         ensure_project_id!
         ensure_read_key!
 
+        log_query("#{self.api_url}#{api_query_resource_path(analysis_type)}", 'POST', params) if log_queries
+
         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, self.open_timeout).post(
@@ -261,6 +263,7 @@ module Keen
       end
 
       def get_response(url, options={})
+        log_query(url) if log_queries
         uri = URI.parse(url)
         Keen::HTTP::Sync.new(self.api_url, self.proxy_url, self.read_timeout, self.open_timeout).get(
           :path => "#{uri.path}?#{uri.query}",
@@ -274,6 +277,10 @@ module Keen
         "/#{self.api_version}/projects/#{self.project_id}/queries/#{analysis_type}"
       end
 
+      def log_query(url, method='GET', options={})
+        Keen.logger.info { "[KEEN] Send #{method} query to #{url} with options #{options}" }
+      end
+
       def request_headers(options={})
         base_headers = api_headers(self.read_key, "sync")
         options.has_key?(:headers) ? base_headers.merge(options[:headers]) : base_headers

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/keen/client/querying_methods_spec.rb

@@ -148,17 +148,45 @@ describe Keen::Client do
         expect(api_response).to eq({ "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 })
+      context "if log_queries is true" do
+        before(:each) { client.log_queries = true }
 
-        expect_keen_post(expected_url, { :steps => steps }, "sync", read_key)
-        expect(response).to eq(api_response["result"])
+        it "logs the query" do
+          expect(client).to receive(:log_query).with(query_url("count", "?event_collection=users"))
+          test_query
+        end
+
+        after(:each) { client.log_queries = false }
+      end
+
+      context "if method option is set to post" do
+        let(:steps) do
+          [{
+            :event_collection => "sign ups",
+            :actor_property => "user.id"
+          }]
+        end
+        let(:expected_url) { query_url("funnel") }
+        before(:each) { stub_keen_post(expected_url, 200, :result => 1) }
+
+        it "should call API with post body" do
+          response = query.call("funnel", nil, { :steps => steps }, { :method => :post })
+
+          expect_keen_post(expected_url, { :steps => steps }, "sync", read_key)
+          expect(response).to eq(api_response["result"])
+        end
+
+        context "if log_queries is true" do
+          before(:each) { client.log_queries = true }
+
+          it "logs the query" do
+            expected_params = {:steps=>[{:event_collection=>"sign ups", :actor_property=>"user.id"}]}
+            expect(client).to receive(:log_query).with(expected_url, 'POST', expected_params)
+            query.call("funnel", nil, { :steps => steps }, { :method => :post })
+          end
+
+          after(:each) { client.log_queries = false }
+        end
       end
 
       it "should add extra headers if you supply them as an option" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Alex Kleissner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-15 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json