sixpack-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTJlYzVkNmZlMDI0ZjNiMmIwMTA5NmQ1OTY0ZThhN2ZlOTg2ZmI5Nw==
+    Njk3MGE1YTljNWIyZjA1MTNiYzY4ZjM0YjY2ODQ3NDU3NzVmNjhkMg==
   data.tar.gz: !binary |-
-    YmFmMDIxOTU2ZWE3ZDBlYmE0OWRmOWM5NTA5OTE3YzczZTVmMzc0Mg==
+    ZmM2ZDcxZmY2MmNjOWEzNjZkZjVhMDU0YzFhNjM1Y2YzZTNjNGRlMA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YmM0ZDdhYWY5NTAwZTA3ZmM4MGU4Y2ZmZDg3MzMwYWQ0M2JhOWEwNzkyMWEz
-    OTYzZDFhNTZlMGM4MWUyZDg4ZmZhZWVmYTczYmE3ZmQ0NzNmODJlM2MxN2E4
-    MzA5NzlmOGU3YWRlODY2Y2I4Njc0NjYwOTBlMmI4M2U2M2Y5M2M=
+    ZWVjNjJjODkzN2UyMjQ4M2I2ODg5Y2M1MzBmN2M5MzExZDAzODIzODhmOGFj
+    ZTBlOTViNjFkNGFhMzU4OTFlM2EzMTNlNDU2OTgyYmU5ZDQyYmM1M2FhN2Rh
+    ZTE5M2ZmMWE5MGJhMDQ0NDQ3Y2NjZTM5MjU2YTM2ZTRlYzk1NDM=
   data.tar.gz: !binary |-
-    NTJhMGE1YjNhYmY1YzFhZWJjNjA3MjMxMDAyZGNiZDU4ZjY1YjlkODE0NmI1
-    NjVmZTIzMDc4ZDAyYzdlYjNlZWYyOWJmMjJiMjY4NzlmODM5ZDMxZWY0MTZj
-    ZTUzOTM4YWE4YWYzZDA3YjExYzBjOGQ2NGM0M2U4MDRmODM5MzI=
+    YTg0YWEwYzEwNmM3NmE5YjZlZDE3M2I2NmE2YjlhYWJkMmEzMmZkNGY4YWY3
+    YmQyNGRhOGM3MjQzMDdlNzM2NTQ3MjdmNDFiYWJkZGIxOTRiYTJiNmFkMWNj
+    ZWQxNWI4ODE2YjQ3OWJmMDQyNjExNDVmYzU3Y2RmY2RkZGI4ZGI=

data/README.md

@@ -1,6 +1,6 @@
 # Sixpack
 
-Ruby client library for SeatGeak's Sixpack ab testing framework.
+Ruby client library for SeatGeek's Sixpack ab testing framework.
 
 ## Installation
 
@@ -26,7 +26,10 @@ require 'sixpack'
 session = Sixpack::Session.new
 
 # Participate in a test (creates the test if necessary)
-session.participate("new-test", ["alternative-1", "alternative-2"])
+resp = session.participate("new-test", ["alternative-1", "alternative-2"])
+if resp["alternative"]["name"] == "alternative-1"
+    css_style = "blue"
+end
 
 # Convert
 session.convert("new-test")
@@ -48,12 +51,17 @@ session = Sixpack::Session.new client_id
 session.convert("new-test")
 ```
 
-Sessions can take an optional `options` dictionary that takes `host` and `timeout` as keys. This allows you to customize Sixpack's location.
+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'}
-    session = Session(client_id="123", options=options)
+    options = {
+        :host => 'http://mysixpacklocation.com',
+    }
+    params = {
+        :ip_address => '1.2.3.4'
+    }
+    session = Session(client_id="123", options=options, params=params)
 
-If Sixpack is unreachable or other errors occur, sixpack-py will provide the control alternative.
+If Sixpack is unreachable or other errors occur, sixpack-rb will provide the control alternative object.
 
 
 ## Contributing

data/lib/sixpack/version.rb

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

data/lib/sixpack.rb

@@ -39,7 +39,7 @@ module Sixpack
       end
     end
 
-    def participate(experiment_name, alternatives, force=nil)
+    def participate(experiment_name, alternatives, force=nil, traffic_fraction=1)
       if !(experiment_name =~ /^[a-z0-9][a-z0-9\-_ ]*$/)
         raise ArgumentError, "Bad experiment_name"
       end
@@ -48,6 +48,10 @@ module Sixpack
         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}"
@@ -57,8 +61,10 @@ module Sixpack
       params = {
         :client_id => @client_id,
         :experiment => experiment_name,
-        :alternatives => alternatives
+        :alternatives => alternatives,
+        :traffic_fraction => traffic_fraction
       }
+
       if !force.nil? && alternatives.include?(force)
         return {"status" => "ok", "alternative" => {"name" => force}, "experiment" => {"version" => 0, "name" => experiment_name}, "client_id" => @client_id}
       end

data/spec/lib/sixpack_spec.rb

@@ -67,6 +67,13 @@ 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
+  end
+
   it "should not allow bad alternatives names" do
     expect {
       sess = Sixpack::Session.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sixpack-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - SeatGeek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake