sixpack-client 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~
+*#*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 SeatGeek
+
+MIT License
+
+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.md

@@ -0,0 +1,65 @@
+# Sixpack
+
+Ruby client library for SeatGeak's Sixpack ab testing framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sixpack-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sixpack-client
+
+## Usage
+
+Basic example:
+
+```ruby
+require 'sixpack'
+
+session = Sixpack::Session.new
+
+# Participate in a test (creates the test if necessary)
+session.participate("new-test", ["alternative-1", "alternative-2"])
+
+# Convert
+session.convert("new-test")
+```
+
+Each session has a `client_id` associated with it that must be preserved across requests. Here's what the first request might look like:
+
+```ruby
+session = Sixpack::Session.new
+session.participate("new-test", ["alternative-1", "alternative-2"])
+set_cookie_in_your_web_framework("sixpack-id", session.client_id)
+```
+
+For future requests, create the `Session` using the `client_id` stored in the cookie:
+
+```ruby
+client_id = get_cookie_from_web_framework("sixpack-id")
+session = Sixpack::Session.new client_id
+session.convert("new-test")
+```
+
+If you already have a client_id (you can generate one using `Sixpack.generate_client_id()`) you can use the `simple_participate()` and `simple_convert()` methods to avoid instantiating a `Session`:
+
+```ruby
+Sixpack::simple_partipate("new-test", ["alternative-1", "alternative-2"], client_id)
+
+Sixpack::simple_convert("new-test", client_id)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/sixpack.rb

@@ -0,0 +1,87 @@
+require "net/http"
+require "json"
+
+require "uuid"
+
+require "sixpack/version"
+
+module Sixpack
+  def self.simple_participate(experiment_name, alternatives, client_id=nil, force=nil)
+    session = Session.new(client_id)
+    res = session.participate(experiment_name, alternatives, force)
+    res["alternative"]
+  end
+
+  def self.simple_convert(experiment_name, client_id)
+    session = Session.new(client_id)
+    session.convert(experiment_name)["status"]
+  end
+
+  def self.generate_client_id
+    uuid = UUID.new
+    uuid.generate
+  end
+
+  class Session
+    attr_accessor :host, :port, :client_id
+
+    def initialize(client_id=nil, options={})
+      default_options = {:host => "localhost", :port => 5000}
+      options = default_options.merge(options)
+      @host = options[:host]
+      @port = options[:port]
+
+      if client_id.nil?
+        @client_id = Sixpack::generate_client_id()
+      else
+        @client_id = client_id
+      end
+    end
+
+    def participate(experiment_name, alternatives, force=nil)
+      if !(experiment_name =~ /[a-z0-9][a-z0-9\-_ ]*/)
+        raise ArgumentError, "Bad experiment_name"
+      end
+
+      if alternatives.length < 2
+        raise ArgumentError, "Must specify at least 2 alternatives"
+      end
+
+      alternatives.each { |alt|
+        if !(alt =~ /[a-z0-9][a-z0-9\-_ ]*/)
+          raise ArgumentError, "Bad alternative name: #{alt}"
+        end
+      }
+
+      params = {
+        :client_id => @client_id,
+        :experiment => experiment_name,
+        :alternatives => alternatives
+      }
+      if !force.nil? && alternatives.include?(force)
+        params[:force] = force
+      end
+
+      self.get_response("/participate", params)
+    end
+
+    def convert(experiment_name)
+      params = {
+        :client_id => @client_id,
+        :experiment => experiment_name
+      }
+      self.get_response("/convert", params)
+    end
+
+    def get_response(endpoint, params)
+      uri = URI("http://#{@host}:#{@port}" + endpoint)
+      uri.query = URI.encode_www_form(params)
+      res = Net::HTTP.get_response(uri)
+      if res.code == "500"
+        {"status" => "failed", "response" => res.body}
+      else
+        JSON.parse(res.body)
+      end
+    end
+  end
+end

data/lib/sixpack/version.rb

@@ -0,0 +1,3 @@
+module Sixpack
+  VERSION = "0.0.1"
+end

data/sixpack.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sixpack/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["SeatGeek"]
+  gem.email         = ["hi@seatgeek.com"]
+  gem.description   = %q{Ruby library for interacting with SeatGeek's sixpack.}
+  gem.summary       = %q{Ruby library for interacting with SeatGeek's sixpack.}
+  gem.homepage      = "http://www.seatgeek.com"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sixpack-client"
+  gem.require_paths = ["lib"]
+  gem.version       = Sixpack::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'redis'
+
+  gem.add_runtime_dependency 'uuid'
+end

data/spec/lib/sixpack_spec.rb

@@ -0,0 +1,82 @@
+require 'redis'
+
+require 'spec_helper'
+
+describe Sixpack do
+  before(:each) do
+    redis = Redis.new
+    redis.keys("*").each do |k|
+      redis.del(k)
+    end
+  end
+
+  it "should return an alternative for simple_participate" do
+    alternative = Sixpack.simple_participate('show-bieber', ['trolled', 'not-trolled'], "mike")
+    ['trolled', 'not-trolled'].should include(alternative)
+  end
+
+  it "should auto generate a client_id" do
+    alternative = Sixpack.simple_participate('show-bieber', ['trolled', 'not-trolled'], nil)
+    ['trolled', 'not-trolled'].should include(alternative)
+  end
+
+  it "should return ok for simple_convert" do
+    alternative = Sixpack.simple_participate('show-bieber', ['trolled', 'not-trolled'], "mike")
+    Sixpack.simple_convert("show-bieber", "mike").should == "ok"
+  end
+
+  it "should return ok for multiple_converts" do
+    alternative = Sixpack.simple_participate('show-bieber', ['trolled', 'not-trolled'], "mike")
+    Sixpack.simple_convert("show-bieber", "mike").should == "ok"
+    Sixpack.simple_convert("show-bieber", "mike").should == "ok"
+  end
+
+  it "should not return ok for simple_convert with new id" do
+    Sixpack.simple_convert("show-bieber", "unknown_id").should == "failed"
+  end
+
+  it "should not return ok for simple_convert with new experiment" do
+    alternative = Sixpack.simple_participate('show-bieber', ['trolled', 'not-trolled'], "mike")
+    Sixpack.simple_convert("show-blieber", "mike").should == "failed"
+  end
+
+  it "should not allow bad experiment names" do
+    expect {
+      Sixpack.simple_participate('%%', ['trolled', 'not-trolled'], nil)
+    }.to raise_error
+  end
+
+  it "should not allow bad alternatives names" do
+    expect {
+      Sixpack.simple_participate('show-bieber', ['trolled'], nil)
+    }.to raise_error
+
+    expect {
+      Sixpack.simple_participate('show-bieber', ['trolled', '%%'], nil)
+    }.to raise_error
+  end
+
+  it "should work without using the simple methods" do
+    session = Sixpack::Session.new
+    session.convert("testing")["status"].should == "failed"
+    alt_one = session.participate("testing", ["one", "two"])["alternative"]
+    3.times do |n|
+      session.participate("testing", ["one", "two"])["alternative"].should == alt_one
+    end
+    session.convert("testing")["status"].should == "ok"
+
+    old_client_id = session.client_id
+    session.client_id = Sixpack::generate_client_id()
+    session.convert("testing")["status"].should == "failed"
+    alt_two = session.participate("testing", ["one", "two"])["alternative"]
+    3.times do |n|
+      session.participate("testing", ["one", "two"])["alternative"].should == alt_two
+    end
+    session.convert("testing")["status"].should == "ok"
+
+    session = Sixpack::Session.new old_client_id
+    3.times do |n|
+      session.participate("testing", ["one", "two"])["alternative"].should == alt_one
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'sixpack'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: sixpack-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- SeatGeek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby library for interacting with SeatGeek's sixpack.
+email:
+- hi@seatgeek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sixpack.rb
+- lib/sixpack/version.rb
+- sixpack.gemspec
+- spec/lib/sixpack_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.seatgeek.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Ruby library for interacting with SeatGeek's sixpack.
+test_files:
+- spec/lib/sixpack_spec.rb
+- spec/spec_helper.rb