Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A simple library that makes it easy to create drip marketing campaigns (or anything that should be performed on an offset schedule)
branch: master
Failed to load latest commit information.
lib The passage of time made me realize that my initial implementation wa…
spec The passage of time made me realize that my initial implementation wa…
.document
.gitignore Initial commit to dripper.
.rspec
Gemfile Relax a bit on the activesupport dependency
Gemfile.lock Relax a bit on the activesupport dependency
LICENSE.txt Initial commit to dripper.
README.markdown Update readme
Rakefile
VERSION Version bump to 0.1.2
dripper.gemspec Relax a bit on the activesupport dependency
test test commit

README.markdown

Dripper

Description

Dripper is a lightweight library that makes it easy to setup a series of scheduled events to be fired off. It was originally written to help me setup drip marketing campaigns for Planscope.

Usage

To install

gem 'dripper'

Define a class, and include a Dripper adapter (at the moment, only ResqueScheduler is supported)

class UserDrip
  include Dripper::ResqueScheduler
end

Dripper needs a few things defined in order to work properly. First, a series of blocks to be executed.

after 5.minutes do |user|
  UserMailer.welcome(user).deliver!
end

after 10.days do |user|
  UserMailer.trial_expiring_soon(user).deliver!
end

No presumptions are made about how you go about finding an instance to yield into an after block, so define a class level lookup method:

def self.fetch_instance(options={})
  User.find(options[:id])
end

By default Dripper will fire a block after the offset you provide has elapsed, but sending emails in the middle of the night isn't always ideal. By specifying the offset in hours and minutes (relative to midnight), you can make sure your messages are sent at the ideal time.

send_at [9, 0] # send at 9am

You can also have Dripper not perform blocks on weekends. When enabled, any delayed job that's supposed to run on Saturday will run exactly 24 hours prior, on Friday. Likewise, jobs on Sunday will run on Monday.

send_at [15, 0], weekends: false

If you don't want certain blocks to be fired, the only way to do that now is to add the right conditions in your blocks. A good use case would be sending out "come back! we miss you!" emails - it's likely that you don't want those sent to paying customers.

Here's what a complete implementation might look like:

class UserDrip
  include Dripper::ResqueScheduler

  send_at [9, 0], weekends: false

  after 5.minutes do |user|
    # send "welcome!" email
  end

  after 1.day do |user|
    # send "getting started" email
  end

  after 27.days do |user|
    # send "trial expiring in 3 days" email
  end

  after 30.days do |user|
    # send "trial expired" email unless subscribed
  end

  after 60.days do |user|
    # send "come back!" email unless subscribed
  end

end

Usage is pretty simple.

  UserDrip.new(current_user).schedule!

At the moment you must provide an object that responds to #id and #created_at. ID is used for the delayed job, and the timestamp is used to determine the contact schedule.

Modifying the times that these blocks will be fired off is tricky. Because Dripper queues up a list of absolute timestamps within resque-scheduler, the only way to safely add, remove or change a schedule is to purge it from Redis and add it again.

  UserDrip.new(current_user).clear!
  UserDrip.new(current_user).schedule!

If you're interested in seeing the list of times generated: UserDrip.new(current_user).scheduled_times

Dependencies

At the moment, ResqueScheduler is the only job scheduler supported. However, it would be pretty trivial to fork and add in a hook to your own scheduler (hint hint!)

Additionally, ActiveSupport is required.

Contributing to Dripper

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2012 Brennan Dunn. See LICENSE.txt for further details.

Something went wrong with that request. Please try again.