prefinery 0.1.0

data/CONFIG

@@ -0,0 +1,15 @@
+
+
+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
+

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  # gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.4"
+  # gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Compulsivo, Inc.
+
+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

@@ -0,0 +1,82 @@
+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 http://app.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

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "prefinery"
+  gem.homepage = "https://github.com/compulsivo/prefinery-ruby-api"
+  gem.license = "MIT"
+  gem.summary = %Q{Launch a private beta for your web site in minutes with Prefinery.}
+  gem.description = %Q{Ruby API for Prefinery.com}
+  gem.email = "support@prefinery.com"
+  gem.authors = ["Justin Britten"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "prefinery #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,3 @@
+require 'prefinery'
+require 'helpers/invitation_helper'
+ActionView::Base.send :include, Prefinery::ViewHelper

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'CONFIG'))

data/lib/helpers/invitation_helper.rb

@@ -0,0 +1,33 @@
+module Prefinery
+  module ViewHelper
+    def prefinery_invitation_javascript(options = {})
+      options.symbolize_keys!
+      <<-HTML
+      <script type="text/javascript">
+        var prefineryJsHost = 'http://www.prefinery.com/';
+        document.write(unescape("%3Cscript src='" + prefineryJsHost + "javascripts/widget.js' type='text/javascript'%3E%3C/script%3E"))
+      </script>
+      <script type='text/javascript' charset='utf-8'>
+        var prefinery_apply_options = {
+          account: "#{options[:subdomain]}",
+          beta_id: "#{options[:beta_id]}",
+          link_id: "prefinery_apply_link"
+        };
+        Prefinery.apply(prefinery_apply_options);
+      </script>
+      HTML
+    end
+
+    def prefinery_embed_invitation_form(options = {})
+      options.symbolize_keys!
+      <<-HTML
+      <iframe id='prefinery_iframe_inline' allowTransparency='true' width='100%' height='600' scrolling='no' frameborder='0' src="#{Prefinery.url}/betas/#{options[:beta_id]}/testers/new?display=inline"></iframe>
+      HTML
+    end
+    
+    def link_to_prefinery_invitation(name, options = {}, html_options = {})
+      html_options.merge!({:id => 'prefinery_invite_link'})
+      link_to name, options, html_options
+    end
+  end
+end

data/lib/prefinery.rb

@@ -0,0 +1,167 @@
+# Ruby lib for working with the Prefinery API's XML interface.
+#
+# You should have something like this in config/initializers/prefinery.rb.
+# 
+#   Prefinery.configure do |config|
+#     config.subdomain = 'compulsivo'
+#     config.secure = false
+#     config.api_key = 8cc4aae2a2fc0e1278a2079ea95b219e26f6beba
+#   end
+#
+#
+# Read the docs at:
+# http://app.prefinery.com/api
+#
+
+if Rails::VERSION::STRING.to_i < 3
+  require 'rubygems'
+  require 'activesupport'
+  require 'activeresource'
+end
+
+module Prefinery
+
+  class << self
+    attr_accessor :subdomain, :host, :port, :secure, :api_key, :host_format
+
+    def configure
+      yield self
+      resources.each do |klass|
+        klass.site = klass.site_format % (host_format % [protocol, host, port])
+        klass.user = api_key
+        klass.password = "X"
+      end
+    end
+    
+    def subdomain
+      @subdomain
+    end
+    
+    def host
+      @host ||= "#{subdomain}.prefinery.com"
+    end
+    
+    def port
+      @port || (secure ? 443 : 80)
+    end
+
+    def api_key
+      @api_key
+    end
+    
+    def protocol
+      secure ? "https" : "http"
+    end
+
+    def url
+      URI.parse("#{protocol}://#{host}:#{port}")
+    end
+    
+    def resources
+      @resources ||= []
+    end
+    
+  end
+  self.host_format   = '%s://%s:%s/api/v1'
+  
+  class Base < ActiveResource::Base
+    def self.inherited(base)
+      Prefinery.resources << base
+      class << base
+        attr_accessor :site_format
+      end
+      base.site_format = '%s'
+      super
+    end
+  end
+  
+  # List betas
+  #
+  #  Prefinery::Beta.find(:all)
+  #
+  # Show a single beta
+  #
+  #  beta = Prefinery::Beta.find(1)
+  #
+  # List testers
+  #
+  #  beta.testers
+  #
+  # Find a tester by email
+  #
+  #  beta.testers(:email => 'justin@prefinery.com')
+  #
+  class Beta < Base
+    def testers(options = {})
+      Tester.find(:all, :params => options.update(:beta_id => id))
+    end
+  end
+  
+  # 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.status = 'active'
+  #  tester.invitation_code = 'TECHCRUNCH'
+  #  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
+  #
+  # Deleting a tester
+  #
+  #  tester = Prefinery::Tester.find(1259, :params => { :beta_id => 74 })
+  #  tester.destroy
+  #
+  # Check-in a tester
+  #
+  #  tester = Prefinery::Tester.find(1259, :params => { :beta_id => 74 })
+  #  tester.checkin
+  class Tester < Base
+    site_format << '/betas/:beta_id'
+    
+    def profile=(profile_attributes)
+      attributes['profile'] = profile_attributes
+    end
+    
+    def verified?(invitation_code)
+      begin
+        get(:verify, :invitation_code => invitation_code)
+        true
+      rescue
+        false
+      end
+    end
+    
+    def checkin
+      begin
+        post(:checkin)
+        true
+      rescue
+        false
+      end
+    end
+    
+  end
+  
+  # Check-in a tester by email address
+  #
+  #  Prefinery::Checkin.create(:beta_id => 74, :email => 'justin@prefinery.com')
+  class Checkin < Base
+    site_format << '/betas/:beta_id'
+  end
+  
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: prefinery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Justin Britten
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Ruby API for Prefinery.com
+email: support@prefinery.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- CONFIG
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/helpers/invitation_helper.rb
+- lib/prefinery.rb
+homepage: https://github.com/compulsivo/prefinery-ruby-api
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 319700071470589539
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Launch a private beta for your web site in minutes with Prefinery.
+test_files: []