optimizely 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9e48555c06465e2d96afa5d32ffef4ce2f3f153
-  data.tar.gz: 291e3967815cddb539da8ba5ff298b81c6398e9d
+  metadata.gz: 16e4c9c9f52348b79e7fcad30925d0b718658925
+  data.tar.gz: 4a8b4e33663afe5bdc4f627ab040d78e08579e23
 SHA512:
-  metadata.gz: 6cb3586e8fd419984b65956423a7581c554436e9dd26517fad5b2e7e9b16e4fd9a8d04accc024995d1a6fa0d8defcda029d07a8a26416836647de7a10c78c9b2
-  data.tar.gz: 35c1ff56dfd0c1505eed79f9debbd8b8325863ec409657b5e575a9849d4b7e0b22f6168e28ac056c90b28c59becad98b187deae08f0d7e52323ec25b8a37c282
+  metadata.gz: 2d9d10c4893688e1cb96fd4542e6892b510f8fda1d13e562642bba5144d8d8c0707126a8dbfdea4dc3690c47b5cfd6ed6b803a3fc270f6c0ea2119e7a36edc55
+  data.tar.gz: d7c300fe8d53ddb225dd9bb28eb68d7446db43c8847fb4a63cea86c8bf21a10f797965060811b9682c3c2e8fc6c57a56b09bb22ac5b7ea0add33a11314937b9f

data/.gitignore

@@ -1 +1,2 @@
-.DS_Store
+.DS_Store
+*.swp

data/Gemfile

@@ -1,4 +1,2 @@
-source "http://www.rubygems.org"
+source 'http://www.rubygems.org'
 gemspec
-gem "bundler"
-gem "json"    # 1.8.1

data/Gemfile.lock

@@ -2,18 +2,33 @@ PATH
   remote: .
   specs:
     optimizely (1.2.1)
+      json (~> 1.8.3)
 
 GEM
   remote: http://www.rubygems.org/
   specs:
-    json (1.8.1)
-    rake (10.3.1)
+    coderay (1.1.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    power_assert (0.2.4)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    slop (3.6.0)
+    test-unit (3.1.2)
+      power_assert
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
-  json
+  bundler (~> 1.10.6)
   optimizely!
-  rake
+  pry (~> 0.10.1)
+  rake (~> 10.4.2)
+  test-unit (~> 3.1.2)
+
+BUNDLED WITH
+   1.10.6

data/lib/optimizely/engine.rb

@@ -1,24 +1,24 @@
 module Optimizely
-	class Engine
-
-		BASE_URL = "https://www.optimizelyapis.com/experiment/v1/"
-
-		attr_accessor :url
-
-		# Initialize Optimizely using an API token.
-		#
-		# == Options:
-		# +:api_token+:: Use an API token you received before.
-		# +:timeout+::   Set Net:HTTP timeout in seconds (default is 300).
-		#
-		def initialize(options={})
-			@options = options
-	  	check_init_auth_requirements
-		end
-
-		# Initalize the Token so it can be used in every request we'll do later on.
-		# Besides that also set the authentication header.
-	  def token=(token)
+  class Engine
+
+    BASE_URL = "https://www.optimizelyapis.com/experiment/v1/"
+
+    attr_accessor :url
+
+    # Initialize Optimizely using an API token.
+    #
+    # == Options:
+    # +:api_token+:: Use an API token you received before.
+    # +:timeout+::   Set Net:HTTP timeout in seconds (default is 300).
+    #
+    def initialize(options={})
+      @options = options
+      check_init_auth_requirements
+    end
+
+    # Initalize the Token so it can be used in every request we'll do later on.
+    # Besides that also set the authentication header.
+    def token=(token)
       @token = token
       set_headers
     end
@@ -29,13 +29,13 @@ module Optimizely
     #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
     #  projects = optimizely.projects # Look up all projects.
     #
-		def projects
-			if @projects.nil?
-				response = self.get("projects")
-				@projects = response.collect { |project_json| Project.new(project_json) }
-			end
-			@projects
-		end
+    def projects
+      if @projects.nil?
+        response = self.get("projects")
+        @projects = response.collect { |project_json| Project.new(project_json) }
+      end
+      @projects
+    end
 
     # Returns the details for a specific project.
     #
@@ -43,16 +43,13 @@ module Optimizely
     #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
     #  project = optimizely.project(12345) # Look up the project.
     #
-		def project(id)
-			@url = "projects/#{id}"
-			raise OptimizelyError::NoProjectID, "A Project ID is required to retrieve the project." if id.nil?
+    def project(id)
+      @url = "projects/#{id}"
+      raise OptimizelyError::NoProjectID, "A Project ID is required to retrieve the project." if id.nil?
 
-			if @project.nil?
-				response = self.get(@url)
-				@project = Project.new(response)
-			end
-			@project
-		end
+      response = self.get(@url)
+      Project.new(response)
+    end
 
     # Returns the list of experiments for a specified project.
     #
@@ -60,15 +57,12 @@ module Optimizely
     #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
     #  experiments = optimizely.experiments(12345) # Look up all experiments for a project.
     #
-		def experiments(project_id)
-			raise OptimizelyError::NoProjectID, "A Project ID is required to retrieve experiments." if project_id.nil?
+    def experiments(project_id)
+      raise OptimizelyError::NoProjectID, "A Project ID is required to retrieve experiments." if project_id.nil?
 
-			if @experiments.nil?
-				response = self.get("projects/#{project_id}/experiments")
-				@experiments = response.collect { |response_json| Experiment.new(response_json) }
-			end
-			@experiments
-		end
+      response = self.get("projects/#{project_id}/experiments")
+      response.collect { |response_json| Experiment.new(response_json) }
+    end
 
     # Returns the details for a specific experiment.
     #
@@ -76,16 +70,13 @@ module Optimizely
     #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
     #  experiment = optimizely.experiment(12345) # Look up the experiment.
     #
-		def experiment(id)
-			@url = "experiments/#{id}"
-			raise OptimizelyError::NoExperimentID, "An Experiment ID is required to retrieve the experiment." if id.nil?
+    def experiment(id)
+      @url = "experiments/#{id}"
+      raise OptimizelyError::NoExperimentID, "An Experiment ID is required to retrieve the experiment." if id.nil?
 
-			if @experiment.nil?
-				response = self.get(@url)
-				@experiment = Experiment.new(response)
-			end
-			@experiment
-		end
+      response = self.get(@url)
+      Experiment.new(response)
+    end
 
     # Returns the list of variations for a specified experiment.
     #
@@ -93,15 +84,12 @@ module Optimizely
     #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
     #  variations = optimizely.variations(12345) # Look up all variations for an experiment.
     #
-		def variations(experiment_id)
-			raise OptimizelyError::NoExperimentID, "An Experiment ID is required to retrieve variations." if experiment_id.nil?
+    def variations(experiment_id)
+      raise OptimizelyError::NoExperimentID, "An Experiment ID is required to retrieve variations." if experiment_id.nil?
 
-			if @variations.nil?
-				response = self.get("projects/#{experiment_id}/variations")
-				@variations = response.collect { |variation_json| Variation.new(variation_json) }
-			end
-			@variations
-		end
+      response = self.get("experiments/#{experiment_id}/variations")
+      response.collect { |variation_json| Variation.new(variation_json) }
+    end
 
     # Returns the details for a specific variation.
     #
@@ -109,16 +97,13 @@ module Optimizely
     #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
     #  variation = optimizely.variation(12345) # Look up the variation.
     #
-		def variation(id)
-			@url = "variations/#{id}"
-			raise OptimizelyError::NoVariationID, "A Variation ID is required to retrieve the variation." if id.nil?
+    def variation(id)
+      @url = "variations/#{id}"
+      raise OptimizelyError::NoVariationID, "A Variation ID is required to retrieve the variation." if id.nil?
 
-			if @variation.nil?
-				response = self.get(@url)
-				@variation = Variation.new(response)
-			end
-			@variation
-		end
+      response = self.get(@url)
+      Variation.new(response)
+    end
 
     # Returns the list of audiences for a specified project.
     #
@@ -126,15 +111,12 @@ module Optimizely
     #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
     #  audiences = optimizely.audiences(12345) # Look up all audiences for a project.
     #
-		def audiences(project_id)
-			raise OptimizelyError::NoProjectID, "A Project ID is required to retrieve audiences." if project_id.nil?
+    def audiences(project_id)
+      raise OptimizelyError::NoProjectID, "A Project ID is required to retrieve audiences." if project_id.nil?
 
-			if @audiences.nil?
-				response = self.get("projects/#{project_id}/audiences")
-				@audiences = response.collect { |audience_json| Audience.new(audience_json) }
-			end
-			@audiences
-		end
+      response = self.get("projects/#{project_id}/audiences")
+      response.collect { |audience_json| Audience.new(audience_json) }
+    end
 
     # Returns the details for a specific audience.
     #
@@ -142,78 +124,75 @@ module Optimizely
     #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
     #  audience = optimizely.audience(12345) # Look up the audience.
     #
-		def audience(id)
-			@url = "audiences/#{id}"
-			raise OptimizelyError::NoAudienceID, "An Audience ID is required to retrieve the audience." if id.nil?
-
-			if @audience.nil?
-				response = self.get(@url)
-				@audience = Audience.new(response)
-			end
-			@audience
-		end
-
-		# Return the parsed JSON data for a request that is done to the Optimizely REST API.
-	  def get(url)
-	  	uri 		 = URI.parse("#{BASE_URL}#{url}/")
-	  	https    = Net::HTTP.new(uri.host, uri.port)
-	  	https.read_timeout = @options[:timeout] if @options[:timeout]
-	  	https.verify_mode = OpenSSL::SSL::VERIFY_NONE
-	    https.use_ssl = true
-	    request  = Net::HTTP::Get.new(uri.request_uri, @headers)
-	    response = https.request(request)
-
-	    # Response code error checking
+    def audience(id)
+      @url = "audiences/#{id}"
+      raise OptimizelyError::NoAudienceID, "An Audience ID is required to retrieve the audience." if id.nil?
+
+      response = self.get(@url)
+      Audience.new(response)
+    end
+
+    # Return the parsed JSON data for a request that is done to the Optimizely REST API.
+    def get(url)
+      uri      = URI.parse("#{BASE_URL}#{url}/")
+      https    = Net::HTTP.new(uri.host, uri.port)
+      https.read_timeout = @options[:timeout] if @options[:timeout]
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      https.use_ssl = true
+      request  = Net::HTTP::Get.new(uri.request_uri, @headers)
+      response = https.request(request)
+
+      # Response code error checking
       if response.code != '200'
         check_response(response.code, response.body)
       else
-		  	parse_json(response.body)
-		  end
-	  end
-
-	  def post
-	  	uri 		 = URI.parse("#{BASE_URL}#{url}/")
-	  	https    = Net::HTTP.new(uri.host, uri.port)
-	  	https.read_timeout = @options[:timeout] if @options[:timeout]
-	  	https.verify_mode = OpenSSL::SSL::VERIFY_NONE
-	    https.use_ssl = true
-	    request  = Net::HTTP::Post.new(uri.request_uri, @headers)
-	    response = https.request(request)
-
-	    # Response code error checking
+        parse_json(response.body)
+      end
+    end
+
+    def post
+      uri      = URI.parse("#{BASE_URL}#{url}/")
+      https    = Net::HTTP.new(uri.host, uri.port)
+      https.read_timeout = @options[:timeout] if @options[:timeout]
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      https.use_ssl = true
+      request  = Net::HTTP::Post.new(uri.request_uri, @headers)
+      response = https.request(request)
+
+      # Response code error checking
       check_response(response.code, response.body) if response.code != '201'
-	  end
-
-	  def put
-	  	uri 		 = URI.parse("#{BASE_URL}#{url}/")
-	  	https    = Net::HTTP.new(uri.host, uri.port)
-	  	https.read_timeout = @options[:timeout] if @options[:timeout]
-	  	https.verify_mode = OpenSSL::SSL::VERIFY_NONE
-	    https.use_ssl = true
-	    request  = Net::HTTP::Put.new(uri.request_uri, @headers)
-	    response = https.request(request)
-
-	    # Response code error checking
+    end
+
+    def put
+      uri      = URI.parse("#{BASE_URL}#{url}/")
+      https    = Net::HTTP.new(uri.host, uri.port)
+      https.read_timeout = @options[:timeout] if @options[:timeout]
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      https.use_ssl = true
+      request  = Net::HTTP::Put.new(uri.request_uri, @headers)
+      response = https.request(request)
+
+      # Response code error checking
       check_response(response.code, response.body) if response.code != '202'
-	  end
+    end
 
-	  def delete
-	  	raise OptimizelyError::NoId, "An ID is required to delete data." if @url.nil?
+    def delete
+      raise OptimizelyError::NoId, "An ID is required to delete data." if @url.nil?
 
-	  	uri 		 = URI.parse("#{BASE_URL}#{@url}")
-	  	https    = Net::HTTP.new(uri.host, uri.port)
-	  	https.read_timeout = @options[:timeout] if @options[:timeout]
-	  	https.verify_mode = OpenSSL::SSL::VERIFY_NONE
-	    https.use_ssl = true
-	    request  = Net::HTTP::Delete.new(uri.request_uri, @headers)
-	    response = https.request(request)
+      uri      = URI.parse("#{BASE_URL}#{@url}")
+      https    = Net::HTTP.new(uri.host, uri.port)
+      https.read_timeout = @options[:timeout] if @options[:timeout]
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      https.use_ssl = true
+      request  = Net::HTTP::Delete.new(uri.request_uri, @headers)
+      response = https.request(request)
 
-	    # Response code error checking
+      # Response code error checking
       check_response(response.code, response.body) if response.code != '204'
-	  end
+    end
 
-	  def check_response(code, body)
-	  	case code
+    def check_response(code, body)
+      case code
       when '400'
         raise OptimizelyError::BadRequest, body + "Your request was not sent in valid JSON. (status code: #{code})."
       when '401'
@@ -221,37 +200,37 @@ module Optimizely
       when '403'
         raise OptimizelyError::Forbidden, body + "You provided an API token but it was invalid or revoked, or if you don't have read/ write access to the entity you're trying to view/edit (status code: #{code})."
       when '404'
-      	raise OptimizelyError::NotFound, body + "The id used in the request was inaccurate or you didn't have permission to view/edit it (status code: #{code})."
+        raise OptimizelyError::NotFound, body + "The id used in the request was inaccurate or you didn't have permission to view/edit it (status code: #{code})."
       else
         raise OptimizelyError::UnknownError, body + " (status code: #{code})."
       end
-	  end
-
-
-	  private
-
-
-		# If there is no API token or an empty API token raise an exception.
-	  def check_init_auth_requirements
-	  	if @options[:api_token].nil? || @options[:api_token].empty?
-		    raise OptimizelyError::NoAPIToken, "An API token is required to initialize Optimizely."
-		  else
-		  	self.token = @options[:api_token]
-		  end
-	  end
-
-	  # As the authentication for the Optimizely Experiments API is handled via the
-	  # Token header in every request we set the header + also make clear we expect JSON.
-	  def set_headers
-	  	@headers = {}
-	  	@headers['Token'] = @token
-	  	@headers['Content-Type'] = "application/json"
-	  end
-
-	  # Parse the JSON data that's been requested through the get method.
-	  def parse_json(data)
-	  	json = JSON.parse(data)
-	  	json
-	  end
-	end
+    end
+
+
+    private
+
+
+    # If there is no API token or an empty API token raise an exception.
+    def check_init_auth_requirements
+      if @options[:api_token].nil? || @options[:api_token].empty?
+        raise OptimizelyError::NoAPIToken, "An API token is required to initialize Optimizely."
+      else
+        self.token = @options[:api_token]
+      end
+    end
+
+    # As the authentication for the Optimizely Experiments API is handled via the
+    # Token header in every request we set the header + also make clear we expect JSON.
+    def set_headers
+      @headers = {}
+      @headers['Token'] = @token
+      @headers['Content-Type'] = "application/json"
+    end
+
+    # Parse the JSON data that's been requested through the get method.
+    def parse_json(data)
+      json = JSON.parse(data)
+      json
+    end
+  end
 end

data/lib/optimizely/experiment.rb

@@ -1,9 +1,10 @@
 module Optimizely
-	class Experiment
+  class Experiment
 
     attr_reader :id, :project_id, :variation_ids, :edit_url, :status
 
     def initialize(json)
+      @json = json
       @id = json['id']
       @project_id = json['project_id']
       @variation_ids = json['variation_ids']
@@ -11,5 +12,9 @@ module Optimizely
       @status = json['status']
     end
 
-	end
+    def [](x)
+      return @json[x]
+    end
+
+  end
 end

data/lib/optimizely/project.rb

@@ -1,14 +1,19 @@
 module Optimizely
-	class Project
+  class Project
 
     attr_reader :project_name, :project_status, :id, :account_id
 
     def initialize(json)
+      @json = json
       @project_name = json['project_name']
       @project_status = json['project_status']
       @id = json['id']
       @account_id = json['account_id']
     end
 
-	end
+    def [](x)
+      return @json[x]
+    end
+
+  end
 end

data/lib/optimizely/variation.rb

@@ -1,21 +1,26 @@
 module Optimizely
-	class Variation
+  class Variation
 
     attr_reader :is_paused, :description, :weight, :created, :variation_id,
-    						:section_id, :js_component, :experiment_id, :project_id, :id
+      :section_id, :js_component, :experiment_id, :project_id, :id
 
     def initialize(json)
-    	@is_paused = json['is_paused']
-			@description = json['description']
-			@weight = json['weight']
-			@created = DateTime.parse(json['created'])
-			@variation_id = json['variation_id']
-			@section_id = json['section_id']
-			@js_component = json['js_component']
-			@experiment_id = json['experiment_id']
-			@project_id = json['project_id']
-			@id = json['id']
+      @json = json
+      @is_paused = json['is_paused']
+      @description = json['description']
+      @weight = json['weight']
+      @created = DateTime.parse(json['created'])
+      @variation_id = json['variation_id']
+      @section_id = json['section_id']
+      @js_component = json['js_component']
+      @experiment_id = json['experiment_id']
+      @project_id = json['project_id']
+      @id = json['id']
     end
 
-	end
+    def [](x)
+      return @json[x]
+    end
+
+  end
 end

data/lib/optimizely/version.rb

@@ -1,3 +1,3 @@
 module Optimizely
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/optimizely.gemspec

@@ -17,5 +17,11 @@ Gem::Specification.new do |s|
   s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths    = ["lib"]
   s.extra_rdoc_files = ["README.md"]
-  s.add_development_dependency 'rake'
-end
+
+  s.add_runtime_dependency 'json', '~> 1.8.3'
+
+  s.add_development_dependency 'bundler', '~> 1.10.6'
+  s.add_development_dependency 'rake', '~> 10.4.2'
+  s.add_development_dependency 'test-unit', '~> 3.1.2'
+  s.add_development_dependency 'pry', '~> 0.10.1'
+end

metadata

@@ -1,29 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: optimizely
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Martijn Scheijbeler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.10.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
 description: A Ruby gem to communicate with the Optimizely Experiments API, it lets
   you create and manage Optimizely projects and experiments.
 email: martijn@marusem.com
@@ -67,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: The Optimizely Experiment API lets you create and manage Optimizely projects