optimizely 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56d6a8e2116a5dc47d782947d5e886d328d2a349
-  data.tar.gz: 6b3fa8d2e138b8f185e143d32e401268860d57b4
+  metadata.gz: ab34ef7520c79ccfce8f1df5f5547f44cece9866
+  data.tar.gz: 6fa648252e54eb29fdbe58fda3cbfef64d8e3d65
 SHA512:
-  metadata.gz: bd5bc338f82f455fb43130946e63bd11cde39bc641a4e6ee605111776d48f64c7ccbc462dda84ada75c27f87632a0efd913eb24189c8a4285ece8c5a2f5ea588
-  data.tar.gz: 17ef6944f4da2efdb93465f27879591824457852b70d2fbec2577b0c1839a90513d342828f98616070f1a0ef2df3972d38ce45649475488057fe6c80d62a8094
+  metadata.gz: b48ab34f7bdc479b9d2ea5105dc3d29a92da7b1ec2def893c44e68ff563941c2b86c9ca3be2ad1b451de55e07580bc320a4b7069c51abfaf65f016b2dabf811b
+  data.tar.gz: b5a027217a0bd5ea375b18e229a460ced92443d23d590de10192ec66f433f93e52f2f3e55adbff89c4454f3bdbd629474fe24b320df0564b12383f124d7a8866

data/README.md

@@ -29,27 +29,43 @@ Don't forget to bundle install:
 	Retrieve all projects:
 		projects = optimizely.projects
 
+	Retrieve a specific project:
+		project = optimizely.project(12345)
+
 ## Experiments
 	
 	Retrieve all experiments for a project:
 		experiments = optimizely.experiments(12345)
 
+	Retrieve a specific experiment:
+		experiment = optimizely.experiment(12345)
+
 ## Variations
 
 	Retrieve all variations for an experiment:
 		variations = optimizely.variations(12345)
 
+	Retrieve a specific variation:
+		variation = optimizely.variation(12345)
+
 ## Audiences
 
 	Retrieve all audiences for an project:
 		audiences = optimizely.audiences(12345)
 
+	Retrieve a specific audience:
+		audience = optimizely.audience(12345)
+
 # Information
 
 ### Changelog
 
+#### 1.1
+* Fix some typos in the errors for having no variable in a function and added extra documentation.
+* Add support for reading specific projects, experiments, variations and audiences.
+
 #### 1.0
-* Add all basic features for the Optimizely Experiment API.
+* Add all basic features for the Optimizely Experiment API for listing projects, experiments, variations and audiences.
 
 ### Bug reports
 

data/lib/optimizely/engine.rb

@@ -32,6 +32,18 @@ module Optimizely
 			@projects
 		end
 
+    # Returns the details for a specific project.
+    #
+    # == Usage
+    #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
+    #  project = optimizely.project(12345) # Look up the project.
+    #
+		def project(id)
+			raise OptimizelyError::NoProjectID, "A Project ID is required to retrieve the project." if id.nil?
+			@project = self.get("projects/#{id}")
+			@project
+		end
+
     # Returns the list of experiments for a specified project.
     #
     # == Usage
@@ -39,11 +51,23 @@ module Optimizely
     #  experiments = optimizely.experiments(12345) # Look up all experiments for a project.
     #
 		def experiments(project_id)
-			raise OptimizelyError::NoProjectID, "A Project ID required to retrieve experiments." if project_id.nil?
+			raise OptimizelyError::NoProjectID, "A Project ID is required to retrieve experiments." if project_id.nil?
 			@experiments = self.get("projects/#{project_id}/experiments") if @experiments.nil?
 			@experiments
 		end
 
+    # Returns the details for a specific experiment.
+    #
+    # == Usage
+    #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
+    #  experiment = optimizely.experiment(12345) # Look up the experiment.
+    #
+		def experiment(id)
+			raise OptimizelyError::NoExperimentID, "An Experiment ID is required to retrieve the experiment." if id.nil?
+			@experiment = self.get("experiments/#{id}")
+			@experiment
+		end
+
     # Returns the list of variations for a specified experiment.
     #
     # == Usage
@@ -51,11 +75,23 @@ module Optimizely
     #  variations = optimizely.variations(12345) # Look up all variations for an experiment.
     #
 		def variations(experiment_id)
-			raise OptimizelyError::NoExperimentID, "An Experiment ID required to retrieve variations." if experiment_id.nil?
+			raise OptimizelyError::NoExperimentID, "An Experiment ID is required to retrieve variations." if experiment_id.nil?
 			@variations = self.get("projects/#{experiment_id}/variations") if @variations.nil?
 			@experiments
 		end
 
+    # Returns the details for a specific variation.
+    #
+    # == Usage
+    #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
+    #  variation = optimizely.variation(12345) # Look up the variation.
+    #
+		def variation(id)
+			raise OptimizelyError::NoVariationID, "A Variation ID is required to retrieve the variation." if id.nil?
+			@variation = self.get("variations/#{id}")
+			@variation
+		end
+
     # Returns the list of audiences for a specified project.
     #
     # == Usage
@@ -63,11 +99,24 @@ module Optimizely
     #  audiences = optimizely.audiences(12345) # Look up all audiences for a project.
     #
 		def audiences(project_id)
-			raise OptimizelyError::NoProjectID, "A Project ID required to retrieve audiences." if project_id.nil?
+			raise OptimizelyError::NoProjectID, "A Project ID is required to retrieve audiences." if project_id.nil?
 			@audiences = self.get("projects/#{project_id}/audiences") if @audiences.nil?
 			@audiences
 		end
 
+    # Returns the details for a specific audience.
+    #
+    # == Usage
+    #  optimizely = Optimizely.new({ api_token: 'oauth2_token' })
+    #  audience = optimizely.audience(12345) # Look up the audience.
+    #
+		def audience(id)
+			raise OptimizelyError::NoAudienceID, "An Audience ID is required to retrieve the audience." if id.nil?
+			@audience = self.get("audiences/#{id}")
+			@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)

data/lib/optimizely/exceptions.rb

@@ -12,4 +12,6 @@ module OptimizelyError
 	# Request Error
 	class NoProjectID < StandardError; end;
 	class NoExperimentID < StandardError; end;
+	class NoVariationID < StandardError; end;
+	class NoAudienceID < StandardError; end;
 end

data/lib/optimizely/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Martijn Scheijbeler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby gem to communicate with the Optimizely Experiments API, it lets
   you create and manage Optimizely projects and the experiments inside of them.