keen 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23a71be7b45d1b303b5b5872cfed224d6ac80732
-  data.tar.gz: 31666e8d77d3d7d0a9c434a5d883fcd7cc9418b8
+  metadata.gz: 982be161aadc1fa73c08a841f36a4056657904c0
+  data.tar.gz: 53ec16352023fac9586003cd097381368e626498
 SHA512:
-  metadata.gz: 4452cce3d9ca6a82aa95f9e773d917c5f7e2ef638e21602dfed113e2fdf27bc7cc5b9b0278babe6b281556c4b9f8af208d4bfd6225402847c64a7ee6ba111a47
-  data.tar.gz: c8b04e2657e971711c99b2983c9cff75f70745de18a1a2d4de5bef3957df0fcd5bf1778e514aef4e49d6e70c0d92830fafae77291adb6311efac1aacc7433eab
+  metadata.gz: fae9fcb9b63d095474b685b872df14c25689251feb04e895c4c23af2f0da6f6002f53b5474473116b9df0032520f890b6ab8292c64668d187a521d8fc2103001
+  data.tar.gz: 782c04eafab7b4f49cf20fd70892c408767491608f20c3426bf66d316956f82d64e2cea8f858cdd3290c001aedbd1cd94b277d34086520713cbf2332fda0580f

data/.travis.yml

@@ -2,7 +2,6 @@ language: ruby
 bundler_args: --without development
 
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
   - 2.2.2
@@ -21,8 +20,6 @@ before_install:
 
 matrix:
   exclude:
-    - rvm: 1.8.7
-      env: PATTERN=synchrony
     - rvm: jruby-19mode
       env: PATTERN=synchrony
 

data/Gemfile

@@ -2,9 +2,9 @@ source "https://rubygems.org"
 
 group :development, :test do
   gem 'rake'
-  gem 'rspec', '~>2'
   gem 'em-http-request'
   gem 'em-synchrony', :require => false
+  gem 'rspec', '~>2'
   gem 'webmock'
 end
 

data/README.md

@@ -16,7 +16,7 @@ or install from Rubygems:
 
     gem install keen
 
-keen is tested with Ruby 1.8 and 1.9 on:
+keen is tested with Ruby 1.9.3 + and on:
 
 * MRI
 * Rubinius
@@ -177,9 +177,30 @@ 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 Caching
+### Saved Queries
 
-You can specify a `max_age` parameter as part of your query request, but make sure you send the request as a `:post` request.
+You can manage your saved queries from the Keen ruby client.
+
+```ruby
+# Create a saved query
+Keen.saved_queries.create("name", saved_query_attributes)
+
+# Get all saved queries
+Keen.saved_queries.all
+
+# Get one saved query
+Keen.saved_queries.get("saved-query-slug")
+
+# Get saved query with results
+Keen.saved_queries.get("saved-query-slug", results: true)
+
+# Update a saved query
+saved_query_attributes = { refresh_rate: 14400 }
+Keen.saved_queries.update("saved-query-slug", saved_query_attributes)
+
+# Delete a saved query
+Keen.saved_queries.delete("saved-query-slug")
+```
 
 ##### Getting Query URLs
 
@@ -391,6 +412,10 @@ If you want some bot protection, check out the [Voight-Kampff](https://github.co
 
 ### Changelog
 
+##### 0.9.4
++ Add SDK support for Saved Queries
++ Removed support for Ruby MRI 1.8.7
+
 ##### 0.9.2
 + Added support for max_age as an integer.
 

data/lib/keen.rb

@@ -51,7 +51,8 @@ module Keen
                    :event_collections,
                    :project_info,
                    :query_url,
-                   :query
+                   :query,
+                   :saved_queries
 
     attr_writer :logger
 

data/lib/keen/client.rb

@@ -3,6 +3,7 @@ require 'keen/version'
 require 'keen/client/publishing_methods'
 require 'keen/client/querying_methods'
 require 'keen/client/maintenance_methods'
+require 'keen/client/saved_queries'
 require 'openssl'
 require 'multi_json'
 require 'base64'
@@ -53,6 +54,10 @@ module Keen
       self.read_timeout = options[:read_timeout].to_f unless options[:read_timeout].nil?
     end
 
+    def saved_queries
+      @saved_queries ||= SavedQueries.new(self)
+    end
+
     private
 
     def process_response(status_code, response_body)

data/lib/keen/client/saved_queries.rb

@@ -0,0 +1,82 @@
+require "json"
+
+class SavedQueries
+  def initialize(client)
+    @client = client
+  end
+
+  def all
+    process_response(saved_query_response)
+  end
+
+  def get(saved_query_name, results = false)
+    saved_query_path = "/#{saved_query_name}"
+    if results
+      saved_query_path += "/result"
+    end
+    response = saved_query_response(saved_query_path)
+    response_body = JSON.parse(response.body, symbolize_names: true)
+    process_response(response)
+  end
+
+  def create(saved_query_name, saved_query_body)
+    response = Keen::HTTP::Sync.new(client.api_url, client.proxy_url, client.read_timeout).put(
+      path: "#{saved_query_base_url}/#{saved_query_name}",
+      headers: api_headers(client.master_key, "sync"),
+      body: saved_query_body
+    )
+    process_response(response)
+  end
+  alias_method :update, :create
+
+  def delete(saved_query_name)
+    response = Keen::HTTP::Sync.new(client.api_url, client.proxy_url, client.read_timeout).delete(
+      path: "#{saved_query_base_url}/#{saved_query_name}",
+      headers: api_headers(client.master_key, "sync")
+    )
+    process_response(response)
+  end
+
+  private
+
+  attr_reader :client
+
+  def saved_query_response(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")
+    )
+  end
+
+  def saved_query_base_url
+    "/#{client.api_version}/projects/#{client.project_id}/queries/saved"
+  end
+
+  def api_headers(authorization, sync_type)
+    user_agent = "keen-gem, v#{Keen::VERSION}, #{sync_type}"
+    user_agent += ", #{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}"
+    if defined?(RUBY_ENGINE)
+      user_agent += ", #{RUBY_ENGINE}"
+    end
+    { "Content-Type" => "application/json",
+      "User-Agent" => user_agent,
+      "Authorization" => authorization }
+  end
+
+  def process_response(response)
+    case response.code.to_i
+    when 204
+      true
+    when 200..299
+      JSON.parse(response.body, symbolize_names: true)
+    when 400
+      raise Keen::BadRequestError.new(response.body)
+    when 401
+      raise Keen::AuthenticationError.new(response.body)
+    when 404
+      raise Keen::NotFoundError.new(response.body)
+    else
+      raise Keen::HttpError.new(response.body)
+    end
+  end
+end

data/lib/keen/http.rb

@@ -32,6 +32,12 @@ module Keen
         @http.post(path, body, headers)
       end
 
+      def put(options)
+        path, headers, body = options.values_at(
+          :path, :headers, :body)
+        @http.put(path, body, headers)
+      end
+
       def get(options)
         path, headers = options.values_at(
           :path, :headers)

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.9.3"
+  VERSION = "0.9.4"
 end

data/spec/integration/saved_query_spec.rb

@@ -0,0 +1,34 @@
+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) }
+
+  describe "#all" do
+    it "gets all saved_queries" do
+      expect(client.saved_queries.all).to be_instance_of(Array)
+    end
+  end
+
+  describe "#get" do
+    it "gets a single saved query" do
+      all_queries = client.saved_queries.all
+
+      single_saved_query = client.saved_queries.get(all_queries.first[:query_name])
+
+      expect(single_saved_query[:query_name]).to eq(all_queries.first[:query_name])
+      expect(single_saved_query[:results]).to be_nil
+    end
+  end
+
+  describe "#results" do
+    it "gets a single saved query" do
+      all_queries = client.saved_queries.all
+
+      single_saved_query = client.saved_queries.get(all_queries.last[:query_name], results: true)
+
+      expect(single_saved_query[:result]).not_to be_nil
+    end
+  end
+end

data/spec/keen/saved_query_spec.rb

@@ -0,0 +1,165 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Keen do
+  let(:client) do
+    Keen::Client.new(
+      project_id: "12341234",
+      master_key: "abcdef",
+      api_url: "https://notreal.keen.io"
+    )
+  end
+
+  describe "#saved_queries" do
+    describe "#all" do
+
+      it "returns all saved queries" do
+        all_saved_queries = [ {
+          refresh_rate: 0,
+          last_modified_date: "2015-10-19T20:14:29.797000+00:00",
+          query_name: "Analysis-API-Calls-this-1-day",
+          query: {
+            filters: [],
+            analysis_type: "count",
+            timezone: "UTC",
+            timeframe: "this_1_days",
+            event_collection: "analysis_api_call"
+          },
+          metadata: {
+            visualization: { chart_type: "metric"}
+          }
+        } ]
+        stub_keen_get(saved_query_endpoint, 200, all_saved_queries)
+
+        all_saved_queries_response = client.saved_queries.all
+
+        expect(all_saved_queries_response).to eq(all_saved_queries)
+      end
+    end
+
+    describe "#get" do
+      it "returns a specific saved query given a query id" do
+        saved_query = {
+          refresh_rate: 0,
+          last_modified_date: "2015-10-19T20:14:29.797000+00:00",
+          query_name: "Analysis-API-Calls-this-1-day",
+          query: {
+            filters: [],
+            analysis_type: "count",
+            timezone: "UTC",
+            timeframe: "this_1_days",
+            event_collection: "analysis_api_call"
+          },
+          metadata: {
+            visualization: { chart_type: "metric"}
+          }
+        }
+        stub_keen_get(
+          saved_query_endpoint + "/#{saved_query[:query_name]}",
+          200,
+          saved_query
+        )
+
+        saved_query_response = client.saved_queries.get("Analysis-API-Calls-this-1-day")
+
+        expect(saved_query_response).to eq(saved_query)
+      end
+
+      it "throws an exception if service can't find saved query" do
+        saved_query = {
+          message: "Resource not found",
+          error_code: "ResourceNotFoundError"
+        }
+        stub_keen_get(
+          saved_query_endpoint + "/missing-query",
+          404,
+          saved_query
+        )
+
+        expect {
+          client.saved_queries.get("missing-query")
+        }.to raise_error(Keen::NotFoundError)
+      end
+    end
+
+    describe "#create" do
+      it "returns the created saved query when creation is successful" do
+        saved_query = {
+          refresh_rate: 0,
+          last_modified_date: "2015-10-19T20:14:29.797000+00:00",
+          query_name: "new-query",
+          query: {
+            filters: [],
+            analysis_type: "count",
+            timezone: "UTC",
+            timeframe: "this_1_days",
+            event_collection: "analysis_api_call"
+          },
+          metadata: {
+            visualization: { chart_type: "metric"}
+          }
+        }
+        stub_keen_put(
+          saved_query_endpoint + "/#{saved_query[:query_name]}", 201, saved_query
+        )
+
+        saved_query_response = client.saved_queries.create(saved_query[:query_name], saved_query)
+
+        expect(saved_query_response).to eq(saved_query)
+      end
+
+      it "raises an error when creation is unsuccessful" do
+        stub_keen_put(
+          saved_query_endpoint + "/saved-query-name", 400, {}
+        )
+
+        expect {
+          client.saved_queries.create("saved-query-name", {})
+        }.to raise_error(Keen::BadRequestError)
+      end
+    end
+
+    describe "#update" do
+      it "returns the created saved query when update is successful" do
+        saved_query = {
+          refresh_rate: 0,
+          last_modified_date: "2015-10-19T20:14:29.797000+00:00",
+          query_name: "new-query",
+          query: {
+            filters: [],
+            analysis_type: "count",
+            timezone: "UTC",
+            timeframe: "this_1_days",
+            event_collection: "analysis_api_call"
+          },
+          metadata: {
+            visualization: { chart_type: "metric"}
+          }
+        }
+        stub_keen_put(
+          saved_query_endpoint + "/#{saved_query[:query_name]}", 200, saved_query
+        )
+
+        saved_query_response = client.saved_queries.update(saved_query[:query_name], saved_query)
+
+        expect(saved_query_response).to eq(saved_query)
+      end
+    end
+
+    describe "#delete" do
+      it "returns true with deletion is successful" do
+        query_name = "query-to-be-deleted"
+        stub_keen_delete(
+          saved_query_endpoint + "/#{query_name}", 204
+        )
+
+        saved_query_response = client.saved_queries.delete(query_name)
+
+        expect(saved_query_response).to eq(true)
+      end
+    end
+  end
+
+  def saved_query_endpoint
+    client.api_url + "/#{client.api_version}/projects/#{client.project_id}/queries/saved"
+  end
+end

data/spec/spec_helper.rb

@@ -19,6 +19,10 @@ module Keen::SpecHelpers
     stub_keen_request(:post, url, status, MultiJson.encode(response_body))
   end
 
+  def stub_keen_put(url, status, response_body)
+    stub_keen_request(:put, url, status, MultiJson.encode(response_body))
+  end
+
   def stub_keen_get(url, status, response_body)
     stub_keen_request(:get, url, status, MultiJson.encode(response_body))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Alex Kleissner
@@ -9,132 +9,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-11-13 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
@@ -159,16 +159,19 @@ files:
 - lib/keen/client/maintenance_methods.rb
 - lib/keen/client/publishing_methods.rb
 - lib/keen/client/querying_methods.rb
+- lib/keen/client/saved_queries.rb
 - lib/keen/http.rb
 - lib/keen/scoped_key.rb
 - lib/keen/version.rb
 - spec/integration/api_spec.rb
+- spec/integration/saved_query_spec.rb
 - spec/integration/spec_helper.rb
 - spec/keen/client/maintenance_methods_spec.rb
 - spec/keen/client/publishing_methods_spec.rb
 - spec/keen/client/querying_methods_spec.rb
 - spec/keen/client_spec.rb
 - spec/keen/keen_spec.rb
+- spec/keen/saved_query_spec.rb
 - spec/keen/scoped_key_spec.rb
 - spec/keen/spec_helper.rb
 - spec/spec_helper.rb
@@ -184,28 +187,30 @@ 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.0.14
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Keen IO API Client
 test_files:
 - spec/integration/api_spec.rb
+- spec/integration/saved_query_spec.rb
 - spec/integration/spec_helper.rb
 - spec/keen/client/maintenance_methods_spec.rb
 - spec/keen/client/publishing_methods_spec.rb
 - spec/keen/client/querying_methods_spec.rb
 - spec/keen/client_spec.rb
 - spec/keen/keen_spec.rb
+- spec/keen/saved_query_spec.rb
 - spec/keen/scoped_key_spec.rb
 - spec/keen/spec_helper.rb
 - spec/spec_helper.rb