sixpack-client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Njk3MGE1YTljNWIyZjA1MTNiYzY4ZjM0YjY2ODQ3NDU3NzVmNjhkMg==
+    NzUyMTk0MjllOGI1MGIyYmRiYmY4OTQxOGZjOWFjYjViODNiOGRhNQ==
   data.tar.gz: !binary |-
-    ZmM2ZDcxZmY2MmNjOWEzNjZkZjVhMDU0YzFhNjM1Y2YzZTNjNGRlMA==
+    ZjM0MjFhYzlmNTAzYTE0MGJhNTIxZjgxMTZlMWEyZDY2MzUxNGI3OA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZWVjNjJjODkzN2UyMjQ4M2I2ODg5Y2M1MzBmN2M5MzExZDAzODIzODhmOGFj
-    ZTBlOTViNjFkNGFhMzU4OTFlM2EzMTNlNDU2OTgyYmU5ZDQyYmM1M2FhN2Rh
-    ZTE5M2ZmMWE5MGJhMDQ0NDQ3Y2NjZTM5MjU2YTM2ZTRlYzk1NDM=
+    MDkzZTc0MzI5NTEwOTVmMWQ0NmIyMTJmMWQ0MjRkMGJkMTdjYWQ3NWQ0YWNm
+    MTQxZDVjYzVlODQ2ZGFiZmQ0YzRmNjIyMzI4YTA5NTdmODBmZTAyMDgwMWJi
+    MDg4YTZlZjhmOTk0YzVhNzdiNjRkN2IwNzYwNTk2MzE3ZDk0MGM=
   data.tar.gz: !binary |-
-    YTg0YWEwYzEwNmM3NmE5YjZlZDE3M2I2NmE2YjlhYWJkMmEzMmZkNGY4YWY3
-    YmQyNGRhOGM3MjQzMDdlNzM2NTQ3MjdmNDFiYWJkZGIxOTRiYTJiNmFkMWNj
-    ZWQxNWI4ODE2YjQ3OWJmMDQyNjExNDVmYzU3Y2RmY2RkZGI4ZGI=
+    ZTE0ODFkODkxMDg3YTNlYWFjMTRiYmIzZTFkNGQ1MDg0ODYwYzAwM2M1Yzgy
+    YzMwYjk2MGY3MTg4YWVjZGRjNGYxZTQxNTA3MmEwNDhhZDZjZWUyMzc2OWNk
+    NTEyMjYxZDQzY2NjMzliMmViZDlmMWFhODM3ZDNkYTgxYjZmYzk=

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.2.2
+
+services:
+  - redis-server

data/README.md

@@ -1,5 +1,7 @@
 # Sixpack
 
+[![Build Status](https://travis-ci.org/seatgeek/sixpack-rb.svg?branch=master)](https://travis-ci.org/seatgeek/sixpack-rb)
+
 Ruby client library for SeatGeek's Sixpack ab testing framework.
 
 ## Installation
@@ -47,14 +49,14 @@ For future requests, create the `Session` using the `client_id` stored in the co
 
 ```ruby
 client_id = get_cookie_from_web_framework("sixpack-id")
-session = Sixpack::Session.new client_id
+session = Sixpack::Session.new(client_id)
 session.convert("new-test")
 ```
 
 Sessions can take an optional `options` hash that takes `:base_url`, and a params hash that takes `:ip_address`, and `:user_agent` a keys. If you would like to instantiate a session with a known client id, you can do that here. IP address and user agent can be passed to assist in bot detection.
 
     options = {
-        :host => 'http://mysixpacklocation.com',
+        :base_url => 'http://mysixpacklocation.com'
     }
     params = {
         :ip_address => '1.2.3.4'
@@ -63,6 +65,36 @@ Sessions can take an optional `options` hash that takes `:base_url`, and a param
 
 If Sixpack is unreachable or other errors occur, sixpack-rb will provide the control alternative object.
 
+## Configuration
+
+You can configure the Sixpack in the configure block:
+
+```ruby
+Sixpack.configure do |config|
+  config.base_url = 'http://10.20.30.40:5000'
+end
+```
+
+You can use the `configure` block when initializing your app, for instance in a
+Rails initializer.
+
+Note that options, passed directly into `Session` constructor override the configuration options.
+
+```ruby
+Sixpack.configure do |config|
+  config.base_url = 'http://foo:5000'
+end
+
+s = Sixpack::Session.new(id, base_url: 'http://bar:6000')
+
+expect(s.base_url).to eq 'http://bar:6000' #=> true
+```
+### Configuration options
+
+* base_url - to set the base_url for the sixpack API server (can be
+  overriden in the Session constructor)
+* user - set http basic authentication user
+* password - set http basic authentication password
 
 ## Contributing
 

data/lib/sixpack/configuration.rb

@@ -0,0 +1,16 @@
+module Sixpack
+  class Configuration
+    attr_accessor :base_url, :user, :password
+
+    def initialize
+      @base_url = 'http://localhost:5000'
+    end
+
+    def to_hash
+      config = {base_url: @base_url}
+      config[:user] = @user unless @user.nil?
+      config[:password] = @password unless @password.nil?
+      config
+    end
+  end
+end

data/lib/sixpack/version.rb

@@ -1,3 +1,3 @@
 module Sixpack
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/sixpack.rb

@@ -1,30 +1,40 @@
 require "addressable/uri"
 require "net/http"
 require "json"
-require "uuid"
 require "uri"
 
 require "sixpack/version"
+require "sixpack/configuration"
 
 module Sixpack
-  extend self
 
-  attr_accessor :base_url
+  class << self
 
-  @base_url = "http://localhost:5000"
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
 
-  def generate_client_id
-    uuid = UUID.new
-    uuid.generate
+    def generate_client_id
+      SecureRandom.uuid
+    end
   end
 
+
   class Session
-    attr_accessor :base_url, :client_id, :ip_address, :user_agent
+    attr_reader :base_url
+    attr_accessor :client_id, :ip_address, :user_agent
 
     def initialize(client_id=nil, options={}, params={})
-      default_options = {:base_url => Sixpack.base_url}
-      options = default_options.merge(options)
+      # options supplied directly will override the configured options
+      options = Sixpack.configuration.to_hash.merge(options)
+
       @base_url = options[:base_url]
+      @user = options[:user]
+      @password = options[:password]
 
       default_params = {:ip_address => nil, :user_agent => :nil}
       params = default_params.merge(params)
@@ -39,32 +49,26 @@ module Sixpack
       end
     end
 
-    def participate(experiment_name, alternatives, force=nil, traffic_fraction=1)
+    def participate(experiment_name, alternatives, force=nil)
       if !(experiment_name =~ /^[a-z0-9][a-z0-9\-_ ]*$/)
-        raise ArgumentError, "Bad experiment_name"
+        raise ArgumentError, "Bad experiment_name, must be lowercase, start with an alphanumeric and contain alphanumerics, dashes and underscores"
       end
 
       if alternatives.length < 2
         raise ArgumentError, "Must specify at least 2 alternatives"
       end
 
-      if traffic_fraction.to_f < 0 || traffic_fraction > 1
-        raise ArgumentError, "Invalid Traffic Fraction"
-      end
-
       alternatives.each { |alt|
         if !(alt =~ /^[a-z0-9][a-z0-9\-_ ]*$/)
-          raise ArgumentError, "Bad alternative name: #{alt}"
+          raise ArgumentError, "Bad alternative name: #{alt}, must be lowercase, start with an alphanumeric and contain alphanumerics, dashes and underscores"
         end
       }
 
       params = {
         :client_id => @client_id,
         :experiment => experiment_name,
-        :alternatives => alternatives,
-        :traffic_fraction => traffic_fraction
+        :alternatives => alternatives
       }
-
       if !force.nil? && alternatives.include?(force)
         return {"status" => "ok", "alternative" => {"name" => force}, "experiment" => {"version" => 0, "name" => experiment_name}, "client_id" => @client_id}
       end
@@ -96,7 +100,7 @@ module Sixpack
     end
 
     def get_response(endpoint, params)
-      uri = URI.parse(@base_url)
+      uri = URI.parse(@base_url)      
       http = Net::HTTP.new(uri.host, uri.port)
 
       if uri.scheme == "https"
@@ -109,17 +113,26 @@ module Sixpack
       query = Addressable::URI.form_encode(self.build_params(params))
 
       begin
-        res = http.start do |http|
-          http.get(uri.path + endpoint + "?" + query)
+        req = Net::HTTP::Get.new(uri.path + endpoint + "?" + query)
+        # basic auth
+        if @user && @password
+          req.basic_auth(@user, @password)
         end
+        res = http.request(req)
       rescue
         return {"status" => "failed", "error" => "http error"}
       end
       if res.code == "500"
         {"status" => "failed", "response" => res.body}
       else
-        JSON.parse(res.body)
+        parse_response(res)
       end
     end
+
+    def parse_response(res)
+      JSON.parse(res.body)
+    rescue JSON::ParserError
+      {"status" => "failed", "response" => res.body}
+    end
   end
 end

data/sixpack.gemspec

@@ -20,6 +20,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'redis'
 
   gem.add_runtime_dependency 'json'
-  gem.add_runtime_dependency 'uuid'
   gem.add_runtime_dependency 'addressable'
 end

data/spec/lib/sixpack_spec.rb

@@ -2,62 +2,65 @@ require 'redis'
 
 require 'spec_helper'
 
-describe Sixpack do
+RSpec.describe Sixpack do
   before(:each) do
     redis = Redis.new
-    redis.keys("*").each do |k|
-      redis.del(k)
+    redis.flushdb
+  end
+
+  context 'configuration' do
+    it 'should contain default base_url' do
+      s = Sixpack::Session.new("foo")
+      expect(s.base_url).to eq 'http://localhost:5000'
+    end
+
+    it 'should allow specifying the base_url in Session options' do
+      s = Sixpack::Session.new("foo", base_url: 'http://0.0.0.0:5555')
+      expect(s.base_url).to eq 'http://0.0.0.0:5555'
+    end
+
+    it 'should allow specifying the base_url in configuration block' do
+      Sixpack.configure do |config|
+        config.base_url = 'http://4.4.4.4'
+      end
+      s = Sixpack::Session.new("foo")
+      expect(s.base_url).to eq 'http://4.4.4.4'
+    end
+
+    it 'session base_url should override configuration base_url' do
+      Sixpack.configure do |config|
+        config.base_url = 'http://4.4.4.4'
+      end
+      s = Sixpack::Session.new("foo", base_url: 'http://5.5.5.5')
+      expect(s.base_url).to eq 'http://5.5.5.5'
     end
   end
 
   it "should return an alternative for participate" do
     sess = Sixpack::Session.new("mike")
     resp = sess.participate('show-bieber', ['trolled', 'not-trolled'])
-    ['trolled', 'not-trolled'].should include(resp["alternative"]["name"])
+    expect(['trolled', 'not-trolled']).to include(resp["alternative"]["name"])
   end
 
   it "should return the correct alternative for participate with force" do
     sess = Sixpack::Session.new("mike")
     alt = sess.participate('show-bieber', ['trolled', 'not-trolled'], "trolled")["alternative"]["name"]
-    alt.should == "trolled"
+    expect(alt).to eq "trolled"
 
-    alternative = sess.participate('show-bieber', ['trolled', 'not-trolled'], "not-trolled")["alternative"]["name"]
-    alternative.should == "not-trolled"
+    alt = sess.participate('show-bieber', ['trolled', 'not-trolled'], "not-trolled")["alternative"]["name"]
+    expect(alt).to eq "not-trolled"
   end
 
   it "should allow ip and user agent to be passed to a session" do
     params = {:ip_address => '8.8.8.8', :user_agent => 'FirChromari'}
     session = Sixpack::Session.new('client_id', {}, params)
-    session.ip_address.should == '8.8.8.8'
-    session.user_agent.should == 'FirChromari'
+    expect(session.ip_address).to eq '8.8.8.8'
+    expect(session.user_agent).to eq'FirChromari'
   end
 
   it "should auto generate a client_id" do
     sess = Sixpack::Session.new
-    sess.client_id.length.should == 36
-  end
-
-  it "should return ok for convert" do
-    sess = Sixpack::Session.new("mike")
-    alternative = sess.participate('show-bieber', ['trolled', 'not-trolled'])
-    sess.convert("show-bieber")["status"].should == "ok"
-  end
-
-  it "should return ok for multiple_converts" do
-    sess = Sixpack::Session.new("mike")
-    sess.participate('show-bieber', ['trolled', 'not-trolled'])
-    sess.convert("show-bieber")["status"].should == "ok"
-    sess.convert("show-bieber")["status"].should == "ok"
-  end
-
-  it "should not return ok for convert with new id" do
-    sess = Sixpack::Session.new("unknown_id")
-    sess.convert("show-bieber")["status"].should == "failed"
-  end
-
-  it "should not return ok for convert with new experiment" do
-    sess = Sixpack::Session.new
-    sess.convert("show-blieber")['status'].should == "failed"
+    expect(sess.client_id.length).to eq 36
   end
 
   it "should not allow bad experiment names" do
@@ -67,11 +70,12 @@ describe Sixpack do
     }.to raise_error
   end
 
-  it "should not allow bad traffic tractions" do
-    expect {
-      sess = Sixpack::Session.new
-      sess.participate('testing', ['trolled', 'not-trolled'], nil, 2)
-    }.to raise_error
+  it "should not try parse bad response body data" do
+    sess = Sixpack::Session.new
+    response = double(body: 'something unexpected', code: 200)
+    allow_any_instance_of(Net::HTTP).to receive(:get).and_return(response)
+    res = sess.participate('show-bieber', ['trolled', 'not-trolled'])
+    expect(res["status"]).to eq('failed')
   end
 
   it "should not allow bad alternatives names" do
@@ -86,27 +90,4 @@ describe Sixpack do
     }.to raise_error
   end
 
-  it "should work" 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sixpack-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - SeatGeek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-03 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,20 +66,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: uuid
-  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: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -102,12 +88,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/sixpack.rb
+- lib/sixpack/configuration.rb
 - lib/sixpack/version.rb
 - sixpack.gemspec
 - spec/lib/sixpack_spec.rb