pushpop 0.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79ea1e75806eb688afb2c241020437cef7e6f7b4
-  data.tar.gz: 17ec6e91478668059c1ad092f2aa3abf141a432c
+  metadata.gz: d33b1c0d4e1f844e67237d4a11a2869fbf459974
+  data.tar.gz: f96dfd05743df179f3105cc1c514bff5996b2565
 SHA512:
-  metadata.gz: ca946cc80d4bc63344fd341bcf0d1fbe63a8d8f3d0f46084f40c8aebda434bb943a4fbd64d36980efb08d2c9f6ae1ff299611dfc7f39cfbf4f52290f273a7549
-  data.tar.gz: 4d3f0768e22c38c45713640cd4fe9a40547a6aa65fd743ebab2c98e503050a4725ee52b2fc5a63b0adb6cb071d9f1484ba382dc7f51fd3f2175dc684a05d16f7
+  metadata.gz: 809afc53fb27b310504568f9a4456a62c73b4d1c71fd73f5cecb60cceec53b414b8c3c5e6778d09211c8a51685713594aea773588a02c28cbe7484c9cf8c2ee0
+  data.tar.gz: 9a115b8c0a544ee3654ff2a3bd3f3a677d03e97b52281089e011b240833d62068a59af711a90af0f36b99be51f8ca1ca8da867194a8a62add7dbe4e28b9973cb

data/README.md

@@ -196,6 +196,26 @@ every 1.week, at: 'Monday 12:30'
 
 See the full range of possibilities on the [Clockwork README](https://github.com/tomykaira/clockwork#event-parameters).
 
+##### Webhooks
+
+Jobs can also be triggered via a webhook, instead of scheduling via `every`. Simply use `webhook` instead of `every`, and pass in a path that should trigger that job. `webhook` also accepts a block, which becomes the first step of the job.
+
+``` ruby
+webhook '/trigger' do
+  if params[:secret] == '12345'
+    params[:name]
+  else
+    false # Returning false cancels the job
+  end
+end
+```
+
+The webhooks are simply a [Sinatra](http://www.sinatrarb.com) app under the hood, so you can reuse a lot of the features that are built-in to Sinatra. Their [routing features](http://www.sinatrarb.com/intro.html#Routes) work out of the box. The webhook block that gets called for every request is also run in the [Sinatra request scope](http://www.sinatrarb.com/intro.html#Request/Instance%20Scope), so you can access the full app (via `settings`), and request params via `params`.
+
+The return value of the webhook block will be passed in as `response` for the first step, and will be stored under `step_responses['webhook']` for all future steps.
+
+*You may want to read about running a [custom HTTP server](#custom-http-server-for-webhooks) if you're going to be using webhooks in production.*
+
 ##### Job workflow
 
 When a job kicks off, steps are run serially in the order they are specified. Each step is invoked with 2
@@ -217,7 +237,7 @@ job do
   end
   step 'add previous steps' do |response, step_responses|
     puts response # prints 6
-    puts step_responses['one'] + step_responses['two'] # prints 6
+    puts step_responses['one'] + step_responses['two'] # prints 7
   end
 end
 ```
@@ -267,6 +287,7 @@ end
 
 In this example, the `twilio` step will only be ran if the `keen` step returned a count greater than 0.
 
+
 #### Steps
 
 Steps have the following attributes:
@@ -300,6 +321,43 @@ Here's a very simple template that uses the `response` variable in context:
 <p>We got <%= response %> new users today!</p>
 ```
 
+## Custom HTTP Server for Webhooks
+
+If you're running Pushpop locally, you can continue to use the CLI for running jobs - `jobs:run` will start the Sinatra app internally if you have any webhooks configured. However, running the app with the CLI in a production environment may not scale well. If your webhooks are going to be hit rapidly in production, you may want to use a beefier HTTP server than the default [WEBrick](http://ruby-doc.org/stdlib-1.9.3/libdoc/webrick/rdoc/WEBrick.html) built in to Ruby.
+
+Here's an example of getting Pushpop running on [Unicorn](http://unicorn.bogomips.org/)
+
+**unicorn.rb**
+
+``` ruby
+require 'pushpop'
+
+# Set this to whatever you want.
+worker_processes 2
+
+# This loads all of the job files in /jobs
+Pushpop.load_jobs
+
+# This configures Clockwork for any scheduled jobs you have.
+# You can omit this if all you are using is Webhooks
+Pushpop.schedule 
+
+# This tells Clockwork to actually start running jobs
+# You can omit this if all you are using is Webhooks
+Pushpop.start_clock
+```
+
+**config.ru**
+``` ruby
+# This tells Unicorn what to run whenever it starts up a worker..  which is the Pushpop web app
+run Pushpop.web.app
+```
+
+And then to run it, just do:
+``` bash
+unicorn -c unicorn.rb
+```
+
 ## Recipes
 
 The community-driven [pushpop-recipes](https://github.com/pushpop-project/pushpop-recipes) repository contains jobs and templates

data/lib/pushpop.rb

@@ -4,6 +4,7 @@ require 'pushpop/version'
 require 'pushpop/job'
 require 'pushpop/step'
 require 'pushpop/cli'
+require 'pushpop/web'
 
 module Pushpop
   class << self
@@ -30,6 +31,23 @@ module Pushpop
       @@jobs
     end
 
+    def web
+      @web ||= Web.new
+    end
+
+    def start_webserver
+      # If we start this thread with no routes, it will throw off the all_waits listener
+      # and we don't want to start the web server willy nilly, because it looks weird
+      # on the CLI interface
+      if web.routes.length > 0
+        Thread.new do
+          @web.app.run!
+        end
+      else
+        false
+      end
+    end
+
     # for jobs and steps
     def random_name
       (0...8).map { (65 + rand(26)).chr }.join
@@ -48,6 +66,29 @@ module Pushpop
       self.jobs.map &:schedule
     end
 
+    def start_clock
+      Thread.new do
+        Clockwork.manager.run
+      end
+    end
+
+    def require_file(file = nil)
+      if file
+        if File.directory?(file)
+          Dir.glob("#{file}/**/*.rb").each { |file|
+            load "#{Dir.pwd}/#{file}"
+          }
+        else
+          load file
+        end
+      else
+        Dir.glob("#{Dir.pwd}/jobs/**/*.rb").each { |file|
+          load file
+        }
+      end
+    end
+    alias :load_jobs :require_file 
+
     def load_plugin(name)
       load "#{File.expand_path("../plugins/#{name}", __FILE__)}.rb"
     end

data/lib/pushpop/cli.rb

@@ -1,6 +1,7 @@
 require 'thor'
 require 'dotenv'
 require 'pushpop'
+require 'thwait'
 
 module Pushpop
   class CLI < Thor
@@ -24,7 +25,7 @@ module Pushpop
 
     def describe_jobs
       Dotenv.load
-      require_file(options[:file])
+      Pushpop.require_file(options[:file])
       Pushpop.jobs.tap do |jobs|
         jobs.each do |job|
           puts job.name
@@ -38,7 +39,7 @@ module Pushpop
 
     def run_jobs_once
       Dotenv.load
-      require_file(options[:file])
+      Pushpop.require_file(options[:file])
       Pushpop.run
     end
 
@@ -48,29 +49,32 @@ module Pushpop
 
     def run_jobs
       Dotenv.load
-      require_file(options[:file])
+      Pushpop.require_file(options[:file])
       Pushpop.schedule
-      Clockwork.manager.run
-    end
 
-    private
+      threads = []
+      threads << Pushpop.start_clock
+
+      Pushpop.web.app.traps = false
+      web_thread = Pushpop.start_webserver
+      threads << web_thread if web_thread
 
-    def require_file(file)
-      if file
-        if File.directory?(file)
-          Dir.glob("#{file}/**/*.rb").each { |file|
-            load "#{Dir.pwd}/#{file}"
-          }
-        else
-          load file
+      # Listen to exit signals, so the CLI doesn't hang infinitely on clock
+      [:INT, :TERM].each do |signal|
+        trap(signal) do
+          threads.each do |thread|
+            thread.exit
+          end
         end
-      else
-        Dir.glob("#{Dir.pwd}/jobs/**/*.rb").each { |file|
-          load file
-        }
       end
-    end
 
+      # Wait for both the clock thread and the sinatra thread to close before exiting
+      ThreadsWait.all_waits(threads) do
+        threads.each do |thread|
+          thread.exit
+        end
+      end
+    end
   end
 end
 

data/lib/pushpop/job.rb

@@ -19,6 +19,8 @@ module Pushpop
 
     attr_accessor :name
     attr_accessor :period
+    attr_accessor :webhook_url
+    attr_accessor :webhook_proc
     attr_accessor :every_options
     attr_accessor :steps
 
@@ -34,6 +36,16 @@ module Pushpop
       self.every_options = options
     end
 
+    def webhook(url, &block)
+      raise 'Webhook is already set' if @webhook_url
+      raise 'Webhook must be set before steps' if self.steps.length > 0
+  
+      self.webhook_url = url
+      self.webhook_proc = block
+
+      Pushpop.web.add_route url, self
+    end
+
     def step(name=nil, plugin=nil, &block)
       if plugin
 
@@ -51,18 +63,16 @@ module Pushpop
     end
 
     def schedule
-      raise 'Set job period via "every"' unless self.period
-      Clockwork.manager.every(period, name, every_options) do
-        run
+      raise 'Set job period via "every"' unless self.period || @webhook_url
+
+      if self.period
+        Clockwork.manager.every(period, name, every_options) do
+          run
+        end
       end
     end
 
-    def run
-
-      # track the last response, and all responses
-      last_response = nil
-      step_responses = {}
-
+    def run(last_response = nil, step_responses = {})
       self.steps.each do |step|
 
         # track the last_response and all responses

data/lib/pushpop/step.rb

@@ -4,7 +4,7 @@ module Pushpop
 
   class Step
 
-    TEMPLATES_DIRECTORY = File.expand_path('../../../templates', __FILE__)
+    TEMPLATES_DIRECTORY = File.expand_path('templates', Dir.pwd)
 
     class ERBContext
       attr_accessor :response

data/lib/pushpop/version.rb

@@ -1,3 +1,3 @@
 module Pushpop
-  VERSION = '0.2'
+  VERSION = '0.3.1'
 end

data/lib/pushpop/web.rb

@@ -0,0 +1,48 @@
+require 'sinatra/base'
+require 'json'
+
+module Pushpop
+  class Web
+
+    def app
+      Sinatra::Application
+    end
+
+    def routes
+      @routes ||= []
+    end
+
+    def add_route(url, job)
+
+      if url[0] != '/'
+        url = "/#{url}"
+      end
+
+      raise "Route #{url} is already set up as a webhook" if routes.include?(url)
+
+      runner = lambda do
+        response = self.instance_eval(&job.webhook_proc)
+
+        if response
+          {
+            status: 'success',
+            job: job.name
+          }.to_json
+        else
+          {
+            status: 'failed',
+            job: job.name,
+            message: 'webhook step did not pass'
+          }.to_json
+        end
+      end
+      
+      Sinatra::Application.get  url, &runner
+      Sinatra::Application.post url, &runner
+      Sinatra::Application.put  url, &runner
+
+      routes.push(url)
+    
+    end
+  end
+end

data/pushpop.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "clockwork"
   s.add_dependency "thor"
+  s.add_dependency "sinatra"
   s.add_dependency "dotenv"
 
   s.files         = `git ls-files`.split("\n")

data/spec/pushpop/job_spec.rb

@@ -37,6 +37,29 @@ describe Pushpop::Job do
     end
   end
 
+  describe '#webhook' do
+    it 'sets the webhook url and proc' do
+      job = empty_job
+      empty_proc = Proc.new{}
+      job.webhook('/test', &empty_proc)
+      expect(job.webhook_url).to eq('/test')
+      expect(job.webhook_proc.class).to be(Proc)
+    end
+
+    it 'raises an error if webhook is already set' do
+      job = empty_job
+      job.webhook('/test1')
+      expect{ job.webhook('/test2') }.to raise_error
+    end
+
+    it 'raises an error if any steps have been created' do
+      job = empty_job
+      empty_proc = Proc.new{}
+      job.step('test', &empty_proc)
+      expect{job.webhook('/test')}.to raise_error
+    end
+  end
+
   describe '#step' do
     it 'adds the step to the internal list of steps' do
       empty_proc = Proc.new {}
@@ -108,11 +131,24 @@ describe Pushpop::Job do
       expect(simple_job.run.first).to eq(4)
     end
 
-     it 'fails if the period was not specified' do
+     it 'fails if neither period nor webhook  was not specified' do
        simple_job = Pushpop::Job.new('foo') do end
        expect {
          simple_job.schedule
        }.to raise_error
+
+       simple_job.period = 5.seconds
+
+       expect {
+         simple_job.schedule
+       }.not_to raise_error
+
+       simple_job.period = nil
+       simple_job.webhook_url = '/test'
+
+       expect {
+         simple_job.schedule
+       }.not_to raise_error
      end
   end
 

data/spec/pushpop/web_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Pushpop::Web do
+  web = nil
+
+  before(:each) do
+    web = Pushpop::Web.new
+  end
+
+  it 'returns a Sinatra Application' do
+    expect(web.app).to equal(Sinatra::Application)
+  end
+
+  describe 'routes' do
+    it 'is an array' do
+      expect(web.routes.class).to equal(Array)
+    end
+    
+    it 'is empty by default' do
+      expect(web.routes.length).to equal(0)
+    end
+
+    it 'gets filled with new routes' do
+      web.add_route('/test', Proc.new{})
+
+      expect(web.routes.length).to equal(1)
+      expect(web.routes[0]).to eq('/test')
+    end
+  end
+
+  describe 'add_route' do
+
+    before(:each) do
+      Sinatra::Application.reset!
+    end
+
+    it 'raises an error for duplicate routes' do
+      empty_proc = Proc.new{}
+
+      web.add_route('/test', empty_proc)
+      expect{web.add_route('/test', empty_proc)}.to raise_error
+    end 
+
+    it 'creates GET, POST, and PUT endpoints' do
+      web.add_route('/test', Proc.new{})
+
+      ['GET', 'POST', 'PUT'].each do |method|
+        expect(web.app.routes.include?(method)).to be_truthy
+        expect(web.app.routes[method].length).to equal(1)
+        expect(web.app.routes[method][0][0].match('/test').length).to equal(1)
+      end
+    end
+  end
+end

data/spec/pushpop_spec.rb

@@ -8,6 +8,9 @@ describe 'job' do
 end
 
 describe Pushpop do
+  before(:each) do
+    Pushpop.web.instance_variable_set(:@routes, [])    
+  end
 
   describe 'add_job' do
     it 'adds a job to the list' do
@@ -23,4 +26,31 @@ describe Pushpop do
     end
   end
 
+  describe 'clock' do
+    it 'starts clock in a thread' do
+      t = Pushpop.start_clock
+      expect(t.class).to be(Thread)
+
+      t.exit
+    end
+  end
+
+  describe 'web' do
+    it 'gets or creates an instance of Web' do
+      expect(Pushpop.web.class).to be(Pushpop::Web)
+    end
+
+    it 'does not start the web app if no routes are defined' do
+      expect(Pushpop.start_webserver).to be_falsey
+    end
+
+    it 'starts the web app in a thread' do
+      Pushpop.web.add_route('/test', Proc.new{})
+      t = Pushpop.start_webserver
+      expect(t.class).to be(Thread)
+
+      t.exit
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushpop
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.3.1
 platform: ruby
 authors:
 - Josh Dzielak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clockwork
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -72,11 +86,13 @@ files:
 - lib/pushpop/job.rb
 - lib/pushpop/step.rb
 - lib/pushpop/version.rb
+- lib/pushpop/web.rb
 - pushpop.gemspec
 - spec/jobs/simple_job.rb
 - spec/pushpop/cli_spec.rb
 - spec/pushpop/job_spec.rb
 - spec/pushpop/step_spec.rb
+- spec/pushpop/web_spec.rb
 - spec/pushpop_spec.rb
 - spec/simple_job_spec.rb
 - spec/spec_helper.rb
@@ -109,6 +125,7 @@ test_files:
 - spec/pushpop/cli_spec.rb
 - spec/pushpop/job_spec.rb
 - spec/pushpop/step_spec.rb
+- spec/pushpop/web_spec.rb
 - spec/pushpop_spec.rb
 - spec/simple_job_spec.rb
 - spec/spec_helper.rb