goldshark_gem 0.1.1 → 0.1.2

data/Gemfile

@@ -2,11 +2,12 @@ source 'http://gemcutter.org'
 
 gem 'bundler'
 gem 'rake'
-
+gem "activesupport", "3.2.8", :require => "active_support"
+gem 'libxml-ruby'
 group :test do
 	gem 'minitest'
   gem 'ZenTest'
-  gem 'turn'
+	gem 'webmock'
+	gem 'turn'
 	gem 'vcr'
-	gem 'fakeweb'
 end

data/Gemfile.lock

@@ -2,22 +2,34 @@ GEM
   remote: http://gemcutter.org/
   specs:
     ZenTest (4.8.2)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
     ansi (1.4.3)
-    fakeweb (1.3.0)
+    crack (0.3.1)
+    i18n (0.6.1)
+    libxml-ruby (2.3.3)
     minitest (3.4.0)
+    multi_json (1.3.6)
     rake (0.9.2.2)
     turn (0.9.6)
       ansi
     vcr (2.2.5)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   ZenTest
+  activesupport (= 3.2.8)
   bundler
-  fakeweb
+  libxml-ruby
   minitest
   rake
   turn
   vcr
+  webmock

data/README.md

@@ -0,0 +1,162 @@
+Goldshark Gem
+===
+---
+To Install
+---
+
+	gem install goldshark\_gem
+
+###Put in Rails Gemfile
+
+	gem 'goldshark_gem'
+
+###Usage
+
+	gs = GS::Tool.new(localization)
+	texts = GS::Text.new(localization)
+
+localization is the parameter key you will need to define in the YAML file. The config file has to be named 'tool\_config.yml' and placed in the config folder of the Rails app.
+
+**localization = 'en\_us' or 'fridge\_finder' or whatever you want it to be.**
+
+###YAML file Sample (tool\_config.yml)
+
+	en_us:
+		tool_guid: '12343252'
+		locale: 'en'
+		api_root: 'http://gst.api.igodigital.com/v2_2' # this option is optional it gsaults to v2_2
+
+	fridge_finder:
+		tool_guid: '3255423'
+		locale: 'en'
+		api_root: 'http://gst.api.igodigital.com/v2_2' # this option is optional it gsaults to v2_2
+
+###Without YAML config file
+
+If the tool\_config.yml file is missing or you are not developing in the Rails enveironment. An empty object can be created and the variables can be defined like so:
+
+	gs = GS::Tool.new
+	gs.tool_guid('132424324')
+	gs.session_id('92034802')
+	gs.locale('en')
+	gs.url('http://gst.api.igodigital.com/v2_2')
+
+	texts = GS::Text.new
+	texts.tool_guid('132424324')
+	texts.locale('en')
+
+###Retrieve the 'gs' object variables
+
+	gs.tool_guid or texts.tool_guid
+	=> '1233242'
+
+	gs.session_id
+	=> '322342'
+
+	gs.locale or texts.locale
+	=> 'en'
+
+	gs.url
+	=> 'http://gst.api.igodigital.com/v2_2'
+
+
+**All calls return hashes with symbolized keys and all product calls return a constant structure for the product object**
+
+###Load and Search a text
+After the text object is initialized. The find method returns the value as a string. (The text type is always defined unlike the text name so I picked that param to make the call).
+
+	texts.load_texts
+
+	text.find(text_type)
+
+###Example:
+
+	text.find('buy_now')
+	=> 'Buy Now'
+
+###Grab the tool object with session id if defined, without session id if not defined
+
+	gs.get_tool
+
+The following accepts an **array of tool step option ids** and returns the results tool object.
+
+	gs.get_results(tool_step_option_ids)
+
+###Get Products by skus or product ids
+
+The following call accepts one skus or a string of comma separated values of skus and returns a products array.
+
+	gs.get_products_by_skus(skus)
+
+The following call accepts one retailer\_product\_id or a string of comma separated values of retailer\_product\_ids and returns a products array.
+
+	gs.get_products_by_product_ids(product_ids)
+
+###Get Attributes and Product links
+The following call accepts an attribute name and returns an array of the requested attribute for all products.
+
+	gs.get_attribute_by_name(attribute_name)
+
+The following call will return all products linked to the retailer\_product\_id listed.
+
+	gs.get_product_links(retailer_product_id)
+
+###Interact with User Data
+The following will return the user data of the gs.session\_id. The user\_id param is optional.
+
+	gs.get_user_data(user_id)
+
+The following call accepts session\_data (it can be anything you want to save). And it save it to the user data.
+
+	gs.save_user_data(session_data, user_id)
+
+###Reporting calls
+
+The following call records recommendation based on the gs.session\_id. You will need to pass the group id and the retailer product list (not optional).
+
+	gs.recs(group_id, retailer_product_list)
+
+The following call will record the event passed on the gs.session\_id.
+
+	gs.record_events(event_name)
+
+The following call will record microconversion based on the gs.session\_id and the retailer product id passed (param not optional).
+	gs.micro_convert(retailer_product_id)
+
+###PG CI interaction
+
+Since we often need to pull CI buy now info for PG products. The GS::Ci module will allow you to pass a sku and an rgid value (usually provided
+by the vendor to retreive an array of vendors, vendor logo images and buy now links to build the buy now button for a
+specific product.
+
+	ci = GS::Ci.new
+	buy_now_array = ci.buy_now(pg_product_id, rgid)
+
+The previous call will return:
+
+	[
+		{
+			:id=>"Product Id", 
+			:logo=>"Retailer Logo Image", 
+			:name=>"Retailer Name", 
+			:buy_now_link=>"Buy now Button", 
+			:product_name=>"Product Name", 
+			:price=>"Price", 
+			:product_image=>"Product Image", 
+			:available=>"Y or N"
+		}
+	]
+
+
+
+---
+
+####Contributing to goldshark\_gem
+
+Gabriele Roselli
+
+Copyright
+
+Copyright (c) 2012 iGoDigital. See LICENSE.txt for
+further details.
+

data/goldshark_gem.gemspec

@@ -7,5 +7,11 @@ Gem::Specification.new do |s|
   s.summary     = %q{A gem to interact with iGodigital GoldShark API}
   s.description = %q{A gem to interact with iGodigital GoldShark API}
 	s.files       = `git ls-files`.split($\)
-	s.version     = '0.1.1'
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+	s.add_dependency 'activesupport', "~> 3.2.8"
+  s.add_dependency 'libxml-ruby'
+  s.require_paths = ["lib"]	
+	s.version     = '0.1.2'
 end

data/lib/goldshark_gem.rb

@@ -1,247 +1,11 @@
+require 'rubygems'
 require 'net/http'
 require 'net/https'
 require 'uri'
 require 'json'
 require 'yaml'
+require 'active_support/all'
+require 'xml/libxml'
 
-module GS
-	class Tool
-		def initialize(localization = nil)
-			unless localization.nil?
-				config_file = Rails.root.join("config", "tool_config.yml").to_s
-				tool_info = YAML::load(File.read(config_file))
-				@tool_guid = tool_info[localization]['tool_guid']
-				@locale = tool_info[localization]['locale']
-			end
-			@url = tool_info['api_root'] rescue nil
-			if @url.nil?
-				@url = 'http://gst.api.igodigital.com/v2_2'
-			end
-		end
-
-		def session_id(sid = nil)
-			if sid.nil?
-				@session_id
-			else
-				@session_id = sid
-			end
-		end
-
-		def tool_guid(tool_guid = nil)
-			if tool_guid.nil?
-				@tool_guid
-			else
-				@tool_guid = tool_guid
-			end
-		end
-
-		def locale(locale = nil)
-			if locale.nil?
-				@locale
-			else
-				@locale = locale
-			end
-		end
-
-		def url(url = nil)
-			if url.nil?
-				@url
-			else
-				@url = url
-			end
-		end
-
-		def get_tool
-			unless @session_id.nil?
-				uri = URI.parse("#{@url}/#{@tool_guid}/tool.json?locale=#{@locale}&sid=#{@session_id}")
-			else
-				uri = URI.parse("#{@url}/#{@tool_guid}/tool.json?locale=#{@locale}")
-			end
-			return get_call(uri)
-		end
-
-		def get_settings(setting_name = nil)
-			if setting_name.nil?
-				uri = URI.parse("#{@url}/#{@tool_guid}/settings.json")
-			else
-				uri = URI.parse("#{@url}/#{@tool_guid}/settings.json?name=#{setting_name}")
-			end
-			return get_call(uri)
-		end
-
-		def get_results(tool_step_option_ids = nil, completed = "true")
-			tool = get_tool
-			unless tool_step_option_ids.nil?
-				tool[:steps] = update_tool_options(tool, tool_step_option_ids)
-			end
-			tool[:steps].each{|step| step.reject!{|key, value| ![:tool_step_id, :selected_options, :selected_filter_options].include?(key)}}
-			if @session_id.nil?
-				uri = URI.parse("#{@url}/#{@tool_guid}/tool.json?locale=#{@locale}&sid=#{@session_id}&completed=#{completed}")
-			else
-				uri = URI.parse("#{@url}/#{@tool_guid}/tool.json?locale=#{@locale}&completed=#{completed}")
-			end
-			http = Net::HTTP.new(uri.host, uri.port)
-			request = Net::HTTP::Put.new(uri.request_uri)
-			request.body = tool.to_json
-			response = http.request(request)
-			return JSON.parse(response.body, {symbolize_names: true})
-		end
-
-		def get_products_by_skus(skus)
-			uri = URI.parse("#{@url}/#{@tool_guid}/products.json?sku_list=#{skus}")
-			products = get_call(uri)
-			return products.collect{|p| p[:product]}
-		end
-
-		def get_products_by_product_ids(product_ids)
-			uri = URI.parse("#{@url}/#{@tool_guid}/products.json?product_list=#{product_ids}")
-			products = get_call(uri)
-			return products.collect{|p| p[:product]}
-		end
-
-		def get_attribute_by_name(attribute_name)
-			uri = URI.parse("#{@url}/#{@tool_guid}/product_attributes.json?attribute_name=#{attribute_name}")
-			return get_call(uri)
-		end
-
-		def get_product_links(retailer_product_id)
-			uri = URI.parse("#{@url}/#{@tool_guid}/product_links/#{retailer_product_id}.json")
-			return get_call(uri)
-		end
-
-		def get_user_data(user_id = nil)
-			if !@session_id.nil? && !user_id.nil?
-				uri = URI.parse("#{@url}/#{@tool_guid}/user_data.json?sid=#{@session_id}&user_id=#{user_id}")
-				response = get_call(uri)
-			elsif @session_id.nil? && !user_id.nil?
-				uri = URI.parse("#{@url}/#{@tool_guid}/user_data.json?user_id=#{user_id}")
-				response = get_call(uri).last
-			elsif !@session_id.nil? && user_id.nil?
-				uri = URI.parse("#{@url}/#{@tool_guid}/user_data.json?sid=#{@session_id}")
-				response = get_call(uri)
-			end
-			return response
-		end
-
-		def save_user_data(session_data, user_id = nil)
-			unless session_data.empty?
-				if user_id.nil?
-					uri = URI.parse("#{@url}/#{@tool_guid}/user_data.json?sid=#{@session_id}")
-				else
-					uri = URI.parse("#{@url}/#{@tool_guid}/user_data.json?sid=#{@session_id}&user_id=#{user_id}")
-				end
-				http = Net::HTTP.new(uri.host, uri.port)
-				request = Net::HTTP::Put.new(uri.request_uri)
-				request.body = session_data.to_json
-				response = http.request(request)
-			end
-		end
-
-		def recs(group_id, retailer_product_list)
-			uri = URI.parse("#{@url}/#{@tool_guid}/recommend.json?group_id=#{group_id}&retailer_product_list=#{retailer_product_list}")
-			return get_call(uri)
-		end
-
-		def record_events(event_name)
-			if @session_id.nil?
-				uri = URI.parse("#{@url}/#{@tool_guid}/record_event/#{event_name}.json")
-			else
-				uri = URI.parse("#{@url}/#{@tool_guid}/record_event/#{event_name}.json?sid=#{@session_id}")
-			end
-			return get_call(uri)
-		end
-
-		def micro_convert(retailer_product_id)
-			uri = URI.parse("#{@url}/#{@tool_guid}/micro_conversions.json?sid=#{@session_id}&retailer_product_id=#{retailer_product_id}")
-			return get_call(uri)
-		end
-
-		def get_call(uri)
-			http = Net::HTTP.new(uri.host, uri.port)
-			request = Net::HTTP::Get.new(uri.request_uri)
-			response = http.request(request)
-			return JSON.parse(response.body, {symbolize_names: true})
-		end	
-
-		def update_tool_options(tool, tool_step_option_ids)
-			tool[:steps].each do |step|
-				current_step_options = []
-				unless step[:options].nil?
-					step[:options].each do |option|
-						if Array(tool_step_option_ids).include?(option[:tool_step_option_id])
-							current_step_options << option[:tool_step_option_id]
-						end
-					end
-				end
-				unless current_step_options.empty? 
-					step[:selected_options] = current_step_options.join(',')
-				end
-			end
-		end
-	end
-
-	class Text
-		def initialize(localization = nil)
-			unless localization.nil?
-				config_file = Rails.root.join("config", "tool_config.yml").to_s
-				tool_info = YAML::load(File.read(config_file))
-				@tool_guid = tool_info[localization]['tool_guid']
-				@locale = tool_info[localization]['locale']
-			end
-			@url = tool_info['api_root'] rescue nil
-			if @url.nil?
-				@url = 'http://gst.api.igodigital.com/v2_2'
-			end
-		end
-
-		def locale(locale = nil)
-			if locale.nil?
-				@locale
-			else
-				@locale = locale
-			end
-		end
-
-		def tool_guid(tool_guid = nil)
-			if tool_guid.nil?
-				@tool_guid
-			else
-				@tool_guid = tool_guid
-			end
-		end
-
-		def url(url = nil)
-			if url.nil?
-				@url
-			else
-				@url = url
-			end
-		end
-		
-		def texts(texts = [])
-			if texts.empty?
-				@texts
-			else
-				@texts = texts
-			end
-		end
-
-		def load_text
-			uri = URI.parse("#{@url}/#{@tool_guid}/text.json?locale=#{@locale}")
-			http = Net::HTTP.new(uri.host, uri.port)
-			request = Net::HTTP::Get.new(uri.request_uri)
-			response = http.request(request)
-			@texts = JSON.parse(response.body, {symbolize_names: true})
-			return @texts
-		end
-
-		def find(param)
-    	@texts.each do |x|
-      	if x[:text_type] == param
-        	return x[:text_value]
-	      end
-  	  end
-    	return nil
-	  end
-	end
-end
+require "#{File.dirname(__FILE__)}/goldshark_gem"
+Dir["#{File.dirname(__FILE__)}/goldshark_gem/*.rb"].each { |file| require file.gsub(".rb", "")}