goldshark_gem 0.1.1 → 0.1.2

data/test/fixtures/vcr_cassettes/test_text.yml

@@ -0,0 +1,67 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://gst.api.igodigital.com/v2_2/7c7a63f6-8bcb-4fee-bc9d-8a2f5e477887/text.json?locale=en
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Fri, 19 Oct 2012 02:00:41 GMT
+      Server:
+      - Apache/2.2.16 (Amazon)
+      Status:
+      - '200'
+      X-Frame-Options:
+      - sameorigin
+      X-Powered-By:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.9
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '3289'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '[{"locale":"en","text_title":"","text_value":"Search by model number","text_type":"search_label"},{"locale":"en","text_title":"","text_value":"Find
+        shaving heads that match your shaver","text_type":"welcome_header"},{"locale":"en","text_title":"","text_value":"Or
+        take the step by step guide","text_type":"start_header"},{"locale":"en","text_title":"","text_value":"Start
+        the guide","text_type":"start_button_text"},{"locale":"en","text_title":"","text_value":"Search","text_type":"search_button_text"},{"locale":"en","text_title":"","text_value":"Find
+        shaving heads that match your shaver","text_type":"header_text"},{"locale":"en","text_title":"","text_value":"Start
+        new search","text_type":"restart_text"},{"locale":"en","text_title":"","text_value":"Next
+        question","text_type":"next_button_text"},{"locale":"en","text_title":"","text_value":"Previous
+        question","text_type":"previous_button_text"},{"locale":"en","text_title":"","text_value":"Where
+        to find this icon on my shaver?","text_type":"where_to_find_text"},{"locale":"en","text_title":"","text_value":"Recommendation","text_type":"recommendation_text"},{"locale":"en","text_title":"","text_value":"Matching
+        shavers","text_type":"match_heading"},{"locale":"en","text_title":"Buy Now","text_value":"Buy
+        Now","text_type":"buy_now_text"},{"locale":"en","text_title":"","text_value":"View
+        product details ","text_type":"view_details_text"},{"locale":"en","text_title":"","text_value":"Download
+        leaflet","text_type":"view_leaflet_text"},{"locale":"en","text_title":"","text_value":"Print
+        advice","text_type":"print_text"},{"locale":"en","text_title":"","text_value":"Register
+        to receive a reminder","text_type":"replacement_advice"},{"locale":"en","text_title":"","text_value":"Receive
+        reminder","text_type":"reminder_text"},{"locale":"en","text_title":"","text_value":"Recommended
+        shaver head","text_type":"recommended_shaver_text"},{"locale":"en","text_title":"","text_value":"How
+        to replace your shaver head","text_type":"how_to_replace_text"},{"locale":"en","text_title":"","text_value":"shaving
+        heads","text_type":"shaving_heads"},{"locale":"en","text_title":"","text_value":"Where
+        can I find my model number?","text_type":"where_to_find_model_text"},{"locale":"en","text_title":"","text_value":"Sorry,
+        we found no results for","text_type":"keyword_results_error"},{"locale":"en","text_title":"","text_value":"If
+        you want to try again please check your model number","text_type":"try_search_again_text"},{"locale":"en","text_title":"","text_value":"results
+        for","text_type":"keyword_results"},{"locale":"en","text_title":"","text_value":"Please
+        check your model number or","text_type":"check_model_text"},{"locale":"en","text_title":"","text_value":"results","text_type":"results_text"},{"locale":"en","text_title":"","text_value":"series","text_type":"series_text"},{"locale":"en","text_title":"","text_value":"We
+        cannot offer a package with 2 heads. This package is compatible.","text_type":"no_compatible_text"},{"locale":"en","text_title":"","text_value":"results
+        so far","text_type":"search_results_text"},{"locale":"en","text_title":"","text_value":"Showing","text_type":"showing_text"},{"locale":"en","text_title":"","text_value":"https://pnregistration.harte-hanks.com/Registration.aspx","text_type":"registration_url"}]'
+    http_version: 
+  recorded_at: Fri, 19 Oct 2012 02:00:41 GMT
+recorded_with: VCR 2.2.5

data/{vcr_cassettes → test/fixtures/vcr_cassettes}/test_tool.yml

@@ -7,33 +7,33 @@ http_interactions:
       encoding: US-ASCII
       string: ''
     headers:
-      accept:
+      Accept:
       - ! '*/*'
-      user-agent:
+      User-Agent:
       - Ruby
   response:
     status:
       code: 200
       message: OK
     headers:
-      content-type:
+      Content-Type:
       - application/json;charset=utf-8
-      date:
-      - Fri, 14 Sep 2012 15:30:07 GMT
-      server:
+      Date:
+      - Fri, 19 Oct 2012 01:58:49 GMT
+      Server:
       - Apache/2.2.16 (Amazon)
-      status:
+      Status:
       - '200'
-      x-frame-options:
+      X-Frame-Options:
       - sameorigin
-      x-powered-by:
-      - Phusion Passenger (mod_rails/mod_rack) 3.0.9
-      x-xss-protection:
+      X-Powered-By:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.11
+      X-Xss-Protection:
       - 1; mode=block
-      content-length:
+      Content-Length:
       - '4495'
-      connection:
-      - Close
+      Connection:
+      - keep-alive
     body:
       encoding: US-ASCII
       string: ! '{"tool_name":"This tool is used for monitoring only --- Philips -
@@ -63,6 +63,6 @@ http_interactions:
         the back side is green","step_option_notes":"","tool_step_option_id":"419ff79f-14a9-4702-bb05-269b7461e2b4","image_type":"jpg"},{"parent_step_option_name":"Yes,
         the shaving head is on a ''neck''","parent_tool_step_option_id":"0031fade-61db-458d-a189-cad2db67427e","sort_order":1,"step_option_desc":"HQ56/52
         ","step_option_name":"No, the back side is not green","step_option_notes":"no-image","tool_step_option_id":"29bf4cd7-1504-443f-8541-fee1fe73c921","image_type":"jpg"}]}]}'
-    http_version: '1.1'
-  recorded_at: Fri, 14 Sep 2012 15:30:06 GMT
+    http_version: 
+  recorded_at: Fri, 19 Oct 2012 01:58:49 GMT
 recorded_with: VCR 2.2.5

data/test/helper.rb

@@ -4,6 +4,7 @@ Bundler.require(:default, :test)
 require 'goldshark_gem'
 require 'minitest/unit'
 require 'turn'
+require 'webmock'
 
 class MiniTest::Unit::TestCase
 	def self.test(name, &block)

data/test/text_test.rb

@@ -0,0 +1,18 @@
+require 'helper'
+require 'minitest/autorun'
+
+class TestText < MiniTest::Unit::TestCase
+
+	def setup
+		@gstxt = GS::Text.new
+		@gstxt.tool_guid("7c7a63f6-8bcb-4fee-bc9d-8a2f5e477887")
+		@gstxt.locale("en")
+	end
+
+	def test_that_can_find_text
+		VCR.use_cassette('test_text') do
+			@gstxt.load_text
+			assert_equal @gstxt.find('showing_text'), 'Showing'
+		end
+	end
+end

data/test/tool_test.rb

@@ -0,0 +1,40 @@
+require 'helper'
+require 'minitest/autorun'
+
+class TestTool < MiniTest::Unit::TestCase
+	
+	def setup
+		@gs = GS::Tool.new
+		@gs.tool_guid('7c7a63f6-8bcb-4fee-bc9d-8a2f5e477887')
+		@gs.locale('en')
+		@gs.session_id('7c7a63f6-8bcb-4fee-bc9d-8a2f5e477887')			
+		@tool_step_option_ids = ['0e1ba264-7ed2-4a85-b9cb-75aa50b2b43c', '1c3d1d63-556d-482d-aaf0-8b3700deb29b', '0031fade-61db-458d-a189-cad2db67427e', '419ff79f-14a9-4702-bb05-269b7461e2b4']
+	end
+	
+	def test_that_can_get_right_session
+    VCR.use_cassette('test_tool') do
+			@tool = @gs.get_tool
+			assert_equal '7c7a63f6-8bcb-4fee-bc9d-8a2f5e477887', @tool[:session_id]
+    end
+  end
+
+	def test_that_can_update_tool_options
+		VCR.use_cassette('test_tool') do
+			@tool = @gs.get_tool
+			@tool[:steps] = @gs.update_tool_options(@tool, @tool_step_option_ids)
+			options = @tool[:steps].map{|step| step[:selected_options]}.reject{|o| o === ''}
+			assert_equal @tool_step_option_ids, options
+		end
+	end
+
+	def test_that_can_return_rank_bigger_than_zero
+		VCR.use_cassette('test_results') do
+			@results = @gs.get_results(@tool_step_option_ids)
+			max_result = @results[:steps][0][:tool_groups].collect{|tg| 
+				tg[:rankings].collect{|r| r[:calculated_rank]}
+			}.flatten!.max
+			assert_equal max_result, 2000
+		end
+	end
+	
+end

data/test/vcr_setup.rb

@@ -1,6 +1,6 @@
 require 'vcr'
 
 VCR.configure do |c|
-	c.cassette_library_dir = 'vcr_cassettes'
-	c.hook_into :fakeweb
+	c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+	c.hook_into :webmock
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goldshark_gem
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,30 +9,69 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
-dependencies: []
+date: 2012-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem to interact with iGodigital GoldShark API
 email:
 - groselli@igodigital.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - .document
 - .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README
-- README.rdoc
+- README.md
 - Rakefile
 - goldshark_gem.gemspec
 - lib/goldshark_gem.rb
-- test/goldshark_gem_test.rb
+- lib/goldshark_gem/ci.rb
+- lib/goldshark_gem/text.rb
+- lib/goldshark_gem/tool.rb
+- test/ci_test.rb
+- test/fixtures/vcr_cassettes/test_channel_intelligence.yml
+- test/fixtures/vcr_cassettes/test_results.yml
+- test/fixtures/vcr_cassettes/test_text.yml
+- test/fixtures/vcr_cassettes/test_tool.yml
 - test/helper.rb
+- test/text_test.rb
+- test/tool_test.rb
 - test/vcr_setup.rb
-- vcr_cassettes/.DS_Store
-- vcr_cassettes/test_tool.yml
 homepage: 
 licenses: []
 post_install_message: 

data/README

@@ -1,124 +0,0 @@
-= goldshark_gem
-
-gem install goldshark_gem
-
-in Gemfile: 
-
-gem 'goldshark_gem'
-
-Initialization:
-
-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
-
-
-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')
-
-To retrieve the 'gs' object variables just call:
-
-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
-
-This call accepts an array of tool step option ids and returns the results tool object.
-
-gs.get_results(tool_step_option_ids)
-
-This call accepts one skus or a string of comma separated values of skus and returns a products array.
-
-gs.get_products_by_skus(skus)
-
-This 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)
-
-This call accepts an attribute name and returns an array of the requested attribute for all products.
-
-gs.get_attribute_by_name(attribute_name)
-
-This call will return all products linked to the retailer_product_id listed.
-
-gs.get_product_links(retailer_product_id)
-
-This call will return the user data of the gs.session_id. The user_id param is optional.
-
-gs.get_user_data(user_id)
-
-This 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)
-
-This 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)
-
-This call will record the event passed on the gs.session_id.
-
-gs.record_events(event_name)
-
-This 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)
-
-== Contributing to goldshark_gem
-
-Gabriele Roselli
-
-== Copyright
-
-Copyright (c) 2012 iGoDigital. See LICENSE.txt for
-further details.
-

data/README.rdoc

@@ -1,124 +0,0 @@
-= goldshark_gem
-
-gem install goldshark_gem
-
-in Gemfile: 
-
-gem 'goldshark_gem'
-
-Initialization:
-
-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
-
-
-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')
-
-To retrieve the 'gs' object variables just call:
-
-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
-
-This call accepts an array of tool step option ids and returns the results tool object.
-
-gs.get_results(tool_step_option_ids)
-
-This call accepts one skus or a string of comma separated values of skus and returns a products array.
-
-gs.get_products_by_skus(skus)
-
-This 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)
-
-This call accepts an attribute name and returns an array of the requested attribute for all products.
-
-gs.get_attribute_by_name(attribute_name)
-
-This call will return all products linked to the retailer_product_id listed.
-
-gs.get_product_links(retailer_product_id)
-
-This call will return the user data of the gs.session_id. The user_id param is optional.
-
-gs.get_user_data(user_id)
-
-This 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)
-
-This 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)
-
-This call will record the event passed on the gs.session_id.
-
-gs.record_events(event_name)
-
-This 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)
-
-== Contributing to goldshark_gem
-
-Gabriele Roselli
-
-== Copyright
-
-Copyright (c) 2012 iGoDigital. See LICENSE.txt for
-further details.
-