pushpop 0.1.0

data/lib/pushpop/step.rb

@@ -0,0 +1,50 @@
+require 'erb'
+
+module Pushpop
+
+  class Step
+
+    TEMPLATES_DIRECTORY = File.expand_path('../../../templates', __FILE__)
+
+    class ERBContext
+      attr_accessor :response
+      attr_accessor :step_responses
+
+      def initialize(response, step_responses)
+        self.response = response
+        self.step_responses = step_responses
+      end
+
+      def get_binding
+        binding
+      end
+    end
+
+    attr_accessor :name
+    attr_accessor :plugin
+    attr_accessor :block
+
+    def initialize(name=nil, plugin=nil, &block)
+      self.name = name || plugin || Pushpop.random_name
+      self.plugin = plugin
+      self.block = block
+    end
+
+    def template(filename, response, step_responses={}, directory=TEMPLATES_DIRECTORY)
+      erb_context = ERBContext.new(response, step_responses)
+      ERB.new(get_template_contents(filename, directory)).result(erb_context.get_binding)
+    end
+
+    def run(last_response=nil, step_responses=nil)
+      self.instance_exec(last_response, step_responses, &block)
+    end
+
+    private
+
+    def get_template_contents(filename, directory)
+      File.read(File.join(directory, filename))
+    end
+
+  end
+
+end

data/lib/pushpop/version.rb

@@ -0,0 +1,3 @@
+module Pushpop
+  VERSION = '0.1.0'
+end

data/pushpop.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'pushpop/version'
+
+Gem::Specification.new do |s|
+
+  s.name        = "pushpop"
+  s.version     = Pushpop::VERSION
+  s.authors     = ["Josh Dzielak"]
+  s.email       = "josh@keen.io"
+  s.homepage    = "https://github.com/keenlabs/pushpop"
+  s.summary     = "Automatic delivery of reports and alerts based on Keen IO events"
+  s.description = "Pushpop is a simple but powerful Ruby app that sends notifications based on events captured with Keen IO."
+
+  s.add_dependency "clockwork"
+  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/jobs/simple_job.rb

@@ -0,0 +1,9 @@
+require 'pushpop'
+
+job 'Simple Math' do
+  every 1.seconds
+  step 'return 10' do 10 end
+  step 'increase by 20' do |response|
+    20 + response
+  end
+end

data/spec/plugins/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/plugins/sendgrid_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+SPEC_TEMPLATES_DIRECTORY ||= File.expand_path('../../templates', __FILE__)
+
+describe Pushpop::Sendgrid do
+
+  describe '#configure' do
+
+    it 'should set various params' do
+
+      step = Pushpop::Sendgrid.new do
+        to 'josh@keen.io'
+        from 'depths@hell.com'
+        subject 'time is up'
+        body 'use code 3:16 for high leniency'
+        preview true
+      end
+
+      step.configure
+
+      step._to.should == 'josh@keen.io'
+      step._from.should == 'depths@hell.com'
+      step._subject.should == 'time is up'
+      step._body.should == 'use code 3:16 for high leniency'
+      step._preview.should be_true
+
+    end
+
+  end
+
+  describe '#run' do
+
+    it 'should send some email' do
+
+      Mail.stub(:deliver)
+
+      step = Pushpop::Sendgrid.new do |response|
+        to 'josh@keen.io'
+        from 'alerts+pushpop@keen.io'
+        subject "There were #{response} Pageviews Today!"
+        body 'hey wats up'
+      end
+
+      step.run(365)
+
+    end
+
+  end
+
+  describe '#body' do
+
+    it 'should use a string if given 1 arg' do
+      step = Pushpop::Sendgrid.new
+      step.body 'hello world'
+      step._body.should == 'hello world'
+    end
+
+    it 'should use a template if more than 1 arg is passed' do
+      step = Pushpop::Sendgrid.new
+      step.body('spec.html.erb', 500, {}, SPEC_TEMPLATES_DIRECTORY)
+      step._body.strip.should == '<pre>500</pre>'
+    end
+
+  end
+
+end

data/spec/pushpop/job_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe Pushpop::Job do
+
+  let (:empty_job) { Pushpop::Job.new('foo') do end }
+  let (:empty_step) { Pushpop::Step.new('bar') do end }
+
+  describe '#register_plugins' do
+    it 'should register a plugin' do
+      Pushpop::Job.register_plugin('blaz', Class)
+      Pushpop::Job.plugins['blaz'].should == Class
+    end
+  end
+
+  describe '#initialize' do
+    it 'should set a name and evaluate a block' do
+      block_ran = false
+      job = Pushpop::Job.new('foo') do block_ran = true end
+      job.name.should == 'foo'
+      job.every_duration.should be_nil
+      job.every_options.should == {}
+      block_ran.should be_true
+    end
+
+    it 'should auto-generate a name' do
+      job = Pushpop::Job.new do end
+      job.name.should_not be_nil
+    end
+  end
+
+  describe '#every' do
+    it 'should set duration and options' do
+      job = empty_job
+      job.every(10.seconds, at: '01:02')
+      job.every_duration.should == 10
+      job.every_options.should == { at: '01:02' }
+    end
+  end
+
+  describe '#step' do
+    it 'should add the step to the internal list of steps' do
+      empty_proc = Proc.new {}
+      job = empty_job
+      job.step('blah', &empty_proc)
+      job.steps.first.name.should == 'blah'
+      job.steps.first.block.should == empty_proc
+    end
+
+    context 'plugin specified' do
+      class FakeStep < Pushpop::Step
+      end
+
+      before do
+        Pushpop::Job.register_plugin('blaz', FakeStep)
+      end
+
+      it 'should use the registered plugin to instantiate the class' do
+        empty_proc = Proc.new {}
+        job = empty_job
+        job.step('blah', 'blaz', &empty_proc)
+        job.steps.first.name.should == 'blah'
+        job.steps.first.plugin.should == 'blaz'
+        job.steps.first.class.should == FakeStep
+        job.steps.first.block.should == empty_proc
+      end
+
+      it 'should throw an exception for an unregistered plugin' do
+        empty_proc = Proc.new {}
+        job = empty_job
+        expect {
+          job.step('blah', 'blaze', &empty_proc)
+        }.to raise_error /No plugin configured/
+      end
+    end
+  end
+
+  describe '#run' do
+    it 'should call each step with the response to the previous' do
+      job = Pushpop::Job.new('foo') do
+        step 'one' do
+          10
+        end
+
+        step 'two' do |response|
+          response + 20
+        end
+      end
+      job.run.should == [30, { 'one' => 10, 'two' => 30 }]
+    end
+  end
+
+  describe '#schedule' do
+    it 'should add the job to clockwork' do
+      frequency = 1.seconds
+      simple_job = Pushpop::Job.new('foo') do
+        every frequency
+        step 'track_times_run' do
+          @times_run ||= 0
+          @times_run += 1
+        end
+      end
+
+      simple_job.schedule
+
+      Clockwork.manager.tick(Time.now)
+      simple_job.run.first.should == 2
+      Clockwork.manager.tick(Time.now + frequency)
+      simple_job.run.first.should == 4
+    end
+  end
+
+  describe '#method_missing' do
+    class FakeStep < Pushpop::Step
+    end
+
+    before do
+    end
+
+    it 'should assume its a registered plugin name and try to create a step' do
+      Pushpop::Job.register_plugin('blaz', FakeStep)
+      simple_job = job do
+        blaz 'hi' do end
+      end
+      simple_job.steps.first.name.should == 'hi'
+      simple_job.steps.first.class.should == FakeStep
+    end
+
+    it 'should not assume a name' do
+      Pushpop::Job.register_plugin('blaz', FakeStep)
+      simple_job = job do
+        blaz do end
+      end
+      simple_job.steps.first.name.should_not be_nil
+      simple_job.steps.first.plugin.should == 'blaz'
+      simple_job.steps.first.class.should == FakeStep
+    end
+
+    it 'should raise an exception if there is no registered plugin' do
+      expect {
+        job do
+          blaze do end
+        end
+      }.to raise_error /undefined method/
+    end
+  end
+
+end

data/spec/pushpop/step_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+SPEC_TEMPLATES_DIRECTORY ||= File.expand_path('../../templates', __FILE__)
+
+describe Pushpop::Step do
+
+  describe 'initialize' do
+
+    it 'should set a name, a plugin, and a block' do
+      empty_proc = Proc.new {}
+      step = Pushpop::Step.new('foo', 'foopie', &empty_proc)
+      step.name.should == 'foo'
+      step.plugin.should == 'foopie'
+      step.block.should == empty_proc
+    end
+
+    it 'should auto-generate a name if not given and plugin not given' do
+      empty_proc = Proc.new {}
+      step = Pushpop::Step.new(&empty_proc)
+      step.name.should_not be_nil
+      step.plugin.should be_nil
+      step.block.should == empty_proc
+    end
+
+    it 'should set name to plugin name if not given' do
+      empty_proc = Proc.new {}
+      step = Pushpop::Step.new(nil, 'keen', &empty_proc)
+      step.name.should == 'keen'
+      step.plugin.should == 'keen'
+      step.block.should == empty_proc
+    end
+
+    it 'should not require a plugin' do
+      empty_proc = Proc.new {}
+      step = Pushpop::Step.new('foo', &empty_proc)
+      step.name.should == 'foo'
+      step.block.should == empty_proc
+    end
+
+  end
+
+  describe 'run' do
+
+    it 'should call the block with the same args' do
+      arg1, arg2 = nil
+      times_run = 0
+      empty_proc = Proc.new { |a1, a2| arg1 = a1; arg2 = a2; times_run += 1 }
+      step = Pushpop::Step.new('foo', &empty_proc)
+      step.run('foo', 'bar')
+      arg1.should == 'foo'
+      arg2.should == 'bar'
+      times_run.should == 1
+    end
+
+    it 'should execute the block bound to the step' do
+      _self = nil
+      step = Pushpop::Step.new(nil, nil) do
+        _self = self
+      end
+      step.run
+      _self.should == step
+    end
+
+  end
+
+  describe 'template' do
+    it 'should render the named template with the response binding' do
+      step = Pushpop::Step.new
+      step.template('spec.html.erb', 500, {}, SPEC_TEMPLATES_DIRECTORY).strip.should == '<pre>500</pre>'
+    end
+
+    it 'should render the named template with the step_response binding' do
+      step = Pushpop::Step.new
+      step.template('spec.html.erb', nil, { test: 600 }, SPEC_TEMPLATES_DIRECTORY).strip.should == '<pre>600</pre>'
+    end
+  end
+
+end