Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Launch a private beta for your web site in minutes.
Ruby
branch: master
Failed to load latest commit information.
lib Using Prefinery API v2. Bumping version to 0.2.0
.gitignore Gemify
CONFIG Added ability to get Betas and Testers via REST API
Gemfile Lowering activeresource dependency
Gemfile.lock
MIT-LICENSE Initial commit
README Updating API docs URL
Rakefile Gemify
VERSION Version bump to 0.2.1
init.rb Added ability to get Betas and Testers via REST API
install.rb Initial commit
prefinery-0.2.0.gem Lowering activeresource dependency
prefinery.gemspec Regenerate gemspec for version 0.2.1

README

Prefinery Ruby API
==================

The official Ruby library for interacting with the Prefinery REST API. 

Prefinery (http://www.prefinery.com) helps you launch a private beta in minutes.  
Prefinery collects email addresses, generates invitation codes, and sends 
invitations for your web beta.  Your customers never leave your site and 
e-mail invitations are sent from your address.

The Prefinery Ruby API gets Prefinery integrated into your Rails website in seconds.


Installation
============

  gem 'prefinery'


Configuration
=============

Sign up for a free account on http://www.prefinery.com and create a new web beta.  Once you 
do this, you'll configure Prefinery Ruby API as follows:

You should have something like this in config/initializers/prefinery.rb.

  Prefinery.configure do |config|
    config.subdomain = 'compulsivo'
    config.api_key = '8cc4aae2a2fc0e1278a2079ea95b219e26f6beba'
  end

Documentation
=============

See lib/prefinery.rb

Also, documentation on the REST API can be found at https://www.prefinery.com/api


Examples
========

List testers

 Prefinery::Tester.find(:all, :params => { :beta_id => 74 })
 Prefinery::Tester.find(:all, :params => { :beta_id => 74, :email => "justin@prefinery.com" })

Show a single tester

 tester = Prefinery::Tester.find(1259, :params => { :beta_id => 74 })

Creating a tester

 tester = Prefinery::Tester.new(:beta_id => 74)
 tester.email = 'justin@prefinery.com'
 tester.profile = {:first_name => 'Justin', :last_name => 'Britten'}
 tester.save

Updating a tester

 tester = Prefinery::Tester.find(1259, :params => { :beta_id => 74 })
 tester.profile = {:city => 'Austin', :state => 'TX'}
 tester.save


Helpers
=======

To include Prefinery's invitation javascript on your site's signup page:

<%= prefinery_invitation_javascript(:subdomain => 'acme', :beta_id => 74) %>

To place a link on your site's signup page which will launch the Prefinery invitation widget:

<%= link_to_prefinery_invitation 'Sign up for the beta now!', '#' %>


License
=======

Copyright (c) 2009-2012 Compulsivo, Inc. Released under the MIT license
Something went wrong with that request. Please try again.