pushpop-keen 0.1.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+bundler_args: --without development
+
+rvm:
+  - 2.1.1
+
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'pushpop'
+gem 'keen'
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'mail'
+  gem 'twilio-ruby'
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    clockwork (0.7.5)
+      activesupport
+      tzinfo
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    jwt (1.0.0)
+    keen (0.8.2)
+      addressable (~> 2.3.5)
+      multi_json (~> 1.3)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.3)
+    minitest (5.3.4)
+    multi_json (1.10.1)
+    pushpop (0.1.0)
+      clockwork
+      keen
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+    thread_safe (0.3.4)
+    twilio-ruby (3.11.5)
+      builder (>= 2.1.2)
+      jwt (>= 0.1.2)
+      multi_json (>= 1.3.0)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  keen
+  mail
+  pushpop
+  rake
+  rspec
+  twilio-ruby

data/LICENSE

@@ -0,0 +1,21 @@
+Author Josh Dzielak
+Copyright (c) 2014 Keen Labs
+
+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,54 @@
+## pushpop-keen
+
+Keen IO plugin for [Pushpop](https://github.com/pushpop-project/pushpop).
+
+### Installation
+
+Add `pushpop-keen` to your Gemfile:
+
+``` ruby
+gem 'pushpop-keen'
+```
+
+or install it as a gem:
+
+``` shell
+$ gem install pushpop-keen
+```
+
+### Usage
+
+The `keen` plugin gives you a DSL to specify Keen query parameters. Those query parameters are used to query data using the [keen-gem](https://github.com/keenlabs/keen-gem).
+
+Here's an example that shows many of the options you can specify:
+
+``` ruby
+job 'average response time for successful requests last month' do
+
+  keen do
+    event_collection  'checks'
+    analysis_type     'average'
+    target_property   'request.duration'
+    group_by          'check.name'
+    interval          'daily'
+    timeframe         'last_month',
+    filters           [{ property_name: "response.successful",
+                         operator: "eq",
+                         property_value: true }]
+  end
+
+end
+```
+
+A `steps` method is also supported for [funnels](https://keen.io/docs/data-analysis/funnels/),
+as well as `analyses` for doing a [multi-analysis](https://keen.io/docs/data-analysis/multi-analysis/).
+
+The `keen` plugin requires that the following environment variables are set:
+  
++ `KEEN_PROJECT_ID`
++ `KEEN_READ_KEY`
+
+
+### Contributing
+
+Code and documentation issues and pull requests are welcome.

data/Rakefile

@@ -0,0 +1,16 @@
+$stdout.sync = true
+
+$: << File.join(File.dirname(__FILE__), './lib')
+
+begin
+  require 'rspec/core/rake_task'
+  desc 'Run Rspec unit tests'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+
+  task default: :spec
+rescue LoadError
+end
+
+

data/lib/pushpop-keen.rb

@@ -0,0 +1,80 @@
+require 'pushpop'
+require 'keen'
+
+module Pushpop
+
+  class Keen < Step
+
+    PLUGIN_NAME = 'keen'
+
+    Pushpop::Job.register_plugin(Keen::PLUGIN_NAME, Keen)
+
+    attr_accessor :_event_collection
+    attr_accessor :_analysis_type
+    attr_accessor :_timeframe
+    attr_accessor :_target_property
+    attr_accessor :_group_by
+    attr_accessor :_interval
+    attr_accessor :_filters
+    attr_accessor :_steps
+    attr_accessor :_analyses
+
+    def run(last_response=nil, step_responses=nil)
+      self.configure(last_response, step_responses)
+      ::Keen.send(self._analysis_type, self._event_collection, self.to_analysis_options)
+    end
+
+    def configure(last_response=nil, step_responses=nil)
+      self.instance_exec(last_response, step_responses, &block)
+    end
+
+    def to_analysis_options
+      { timeframe: self._timeframe,
+        target_property: self._target_property,
+        group_by: self._group_by,
+        interval: self._interval,
+        filters: self._filters,
+        analyses: self._analyses,
+        steps: self._steps
+      }.delete_if { |_, v| v.nil? }
+    end
+
+    def event_collection(event_collection)
+      self._event_collection = event_collection
+    end
+
+    def analysis_type(analysis_type)
+      self._analysis_type = analysis_type
+    end
+
+    def timeframe(timeframe)
+      self._timeframe = timeframe
+    end
+
+    def target_property(target_property)
+      self._target_property = target_property
+    end
+
+    def group_by(group_by)
+      self._group_by = group_by
+    end
+
+    def interval(interval)
+      self._interval = interval
+    end
+
+    def filters(filters)
+      self._filters = filters
+    end
+
+    def steps(steps)
+      self._steps = steps
+    end
+
+    def analyses(analyses)
+      self._analyses = analyses
+    end
+
+  end
+
+end

data/lib/pushpop-keen/version.rb

@@ -0,0 +1,5 @@
+module Pushpop
+  class Keen
+    VERSION = '0.1.0'
+  end
+end

data/pushpop-keen.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'pushpop-keen/version'
+
+Gem::Specification.new do |s|
+
+  s.name        = "pushpop-keen"
+  s.version     = Pushpop::Keen::VERSION
+  s.authors     = ["Josh Dzielak"]
+  s.email       = "josh@keen.io"
+  s.homepage    = "https://github.com/pushpop-project/pushpop-keen"
+  s.summary     = "Pushpop Keen IO plugin for querying and recording events"
+
+  s.add_dependency "pushpop"
+  s.add_dependency "keen"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/spec/pushpop-keen_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Pushpop::Keen do
+
+  describe '#configure' do
+
+    it 'should set various params' do
+
+      step = Pushpop::Keen.new do
+        event_collection 'pageviews'
+        analysis_type 'count'
+        timeframe 'last_3_days'
+        target_property 'trinkets'
+        group_by 'referer'
+        interval 'hourly'
+        filters [{ property_value: 'referer',
+                   operator: 'ne',
+                   property_value: 'yahoo.com' }]
+        steps [{ event_collection: 'pageviews',
+                 actor_property: 'user.id' }]
+        analyses [{ analysis_type: 'count' }]
+      end
+
+      step.configure
+
+      step._event_collection.should == 'pageviews'
+      step._analysis_type.should == 'count'
+      step._timeframe.should == 'last_3_days'
+      step._group_by.should == 'referer'
+      step._interval.should == 'hourly'
+      step._steps.should == [{
+         event_collection: 'pageviews',
+         actor_property: 'user.id'
+        }]
+      step._analyses.should == [{ analysis_type: 'count' }]
+    end
+
+  end
+
+  describe '#run' do
+    it 'should run the query based on the analysis type' do
+      Keen.stub(:count).with('pageviews', {
+          timeframe: 'last_3_days'
+      }).and_return(365)
+
+      step = Pushpop::Keen.new('one') do
+        event_collection 'pageviews'
+        analysis_type 'count'
+        timeframe 'last_3_days'
+      end
+      response = step.run
+      response.should == 365
+    end
+  end
+
+  describe '#to_analysis_options' do
+    it 'should include various options' do
+      step = Pushpop::Keen.new('one') do end
+      step._timeframe = 'last_4_days'
+      step._group_by = 'referer'
+      step._target_property = 'trinkets'
+      step._interval = 'hourly'
+      step._filters = [{ property_value: 'referer',
+                         operator: 'ne',
+                         property_value: 'yahoo.com' }]
+      step._steps = [{ event_collection: 'pageviews',
+                       actor_property: 'user.id' }]
+      step._analyses = [{ analysis_type: 'count' }]
+      step.to_analysis_options.should == {
+          timeframe: 'last_4_days',
+          target_property: 'trinkets',
+          group_by: 'referer',
+          interval: 'hourly',
+          filters: [{ property_value: 'referer',
+                         operator: 'ne',
+                         property_value: 'yahoo.com' }],
+          steps: [{ event_collection: 'pageviews',
+                       actor_property: 'user.id' }],
+          analyses: [{ analysis_type: 'count' }]
+      }
+    end
+
+    it 'should not include nils' do
+      step = Pushpop::Keen.new('one') do end
+      step.to_analysis_options.should == {}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$: << File.join(File.dirname(__FILE__), '../lib')
+
+require 'pushpop'
+require 'pushpop-keen'
+
+RSpec.configure do |config|
+  config.before :each do
+    Pushpop.jobs.clear
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: pushpop-keen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Dzielak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pushpop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: keen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: josh@keen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/pushpop-keen.rb
+- lib/pushpop-keen/version.rb
+- pushpop-keen.gemspec
+- spec/pushpop-keen_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pushpop-project/pushpop-keen
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pushpop Keen IO plugin for querying and recording events
+test_files:
+- spec/pushpop-keen_spec.rb
+- spec/spec_helper.rb