bluekai 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e6f268e501ed2d86040a3e6267273dcf13c7a9a
-  data.tar.gz: cc98c3655b05748e9cb5f0e37372c72e3aa0ec7a
+  metadata.gz: 51af5eb445beb71937839077803c711846d636b1
+  data.tar.gz: 8358216076ae1562c321988381de79a700c24b36
 SHA512:
-  metadata.gz: 45b3f3c233cdc04d4d932288e28fb6ceeb52b05ac6f722092310452413960469f7d3d5871093b531ce375ac52c6aee955e91adda6fbcc2e8ad082a2c3cd2eb72
-  data.tar.gz: 0241700e4064701a9c834969b087068490e76547abf60c45d50f023494440819e55c43156fe507005e5da4245e875718972ca2e9c1dfe792b66eb85dc25ffd3c
+  metadata.gz: e6ab9bf86b7975e822786df0d50458f5f9051dc59477013ae9149cd9e1f219473ab5f9b15b29fa6dc8da54ecb50ddd6428b06fe5c254f3334e2977e811205e1c
+  data.tar.gz: 68e0deae9ecc2f9f95e745ab3607667927cad730bfcf83b35c7a31671dd3ce2acb3987fbe6db1f14770a8d61ea3cad0d56c3745b199e02f021137c500358a112

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
 ## Usage
 
-Before you start, please ensure the following variables are correctly set in your environment: `ENV['BLUEKAI_DOMAIN']`, `ENV['BLUEKAI_API_USER_KEY']`, `ENV['BLUEKAI_API_PRIVATE_KEY']` and `ENV['BLUEKAI_PARTNER_ID']`
+Before you start, please ensure the following variables are correctly set in your environment: `ENV['BLUEKAI_API_USER_KEY']`, `ENV['BLUEKAI_API_PRIVATE_KEY']` and `ENV['BLUEKAI_PARTNER_ID']`
 
 
 List all self-classification categories

data/lib/bluekai.rb

@@ -1,9 +1,10 @@
-require 'bluekai/version'
 require 'bluekai/client'
 require 'bluekai/error'
-require 'bluekai/rule'
+require 'bluekai/request'
 require 'bluekai/category'
+require 'bluekai/rule'
 require 'bluekai/user_data'
+require 'bluekai/version'
 
 module Bluekai
   # Your code goes here...

data/lib/bluekai/category.rb

@@ -141,5 +141,40 @@ module Bluekai
     def category_update(category_id, body)
       request('PUT', "/Services/WS/classificationCategories/#{category_id}", {}, body)
     end
+
+    # Public: Given the path of a category as array it
+    #         returns the Bluekai CategoryID, if category path was
+    #         not found it returns nil
+    #
+    # name_arr:array_of_string - Self-classification category Path,
+    #                            e.g., ['Self-Classification','Cake','Conversion']
+    #                            for Self-Classification->Cake->Conversion
+    # Returns: Bluekai category id
+    def category_id(name_arr)
+      @category_id_lookup ||= create_category_lookup
+      category_id_lookup[name_arr.map(&:downcase)]
+    end
+
+    private
+
+    attr_accessor :category_id_lookup
+
+    def construct_category_path(id, categories, path = [])
+      entry = categories[id]
+      return path.compact unless entry && entry[:name]
+      path.unshift(entry[:name])
+      construct_category_path(entry[:parent_id], categories, path)
+    end
+
+    def create_category_lookup
+      categories_by_id = category_list.each_with_object({}) do |category, acc|
+        acc[category[:id]] = category
+      end
+
+      categories_by_id.keys.each_with_object({}) do |category_id, acc|
+        key = construct_category_path(category_id, categories_by_id)
+        acc[key.map(&:downcase)] = category_id
+      end
+    end
   end
 end

data/lib/bluekai/version.rb

@@ -1,3 +1,3 @@
 module Bluekai
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/fixtures/signatures/5d4d1a042f84b68a2fdf2cc376c8d96d284a648d003f6d917557b43372f99bba

@@ -0,0 +1 @@
+�X�D݆�r���n&�CA�Ȯ�7F���F

data/spec/fixtures/vcr_cassettes/Bluekai_Category/returns_correct_category_ids.yml

@@ -0,0 +1,247 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://services.bluekai.com/Services/WS/classificationCategories?bksig=GMFY2UTdhs1yuOD4bibpQ0GjyK4T9A43RpSzC7hGHg4=&bkuid=bluekai-api-user-key&sort_by=name&sorting_order=asc
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 11 May 2015 12:47:27 GMT
+      Set-Cookie:
+      - JSESSIONID=393EAFDCCAFB4EC941C71A77CB4B91AB; Path=/Services; HttpOnly
+      Content-Type:
+      - application/json
+      Cneonction:
+      - close
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "categories" : [ {
+            "name" : "a brand new one",
+            "id" : 422741,
+            "description" : "Brand new category",
+            "leaf" : false,
+            "notes" : "too new to be true",
+            "parent_id" : 280098,
+            "created_at" : "2015-04-01 07:16:01-0500",
+            "updated_at" : "2015-04-01 07:16:01-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "Bengals",
+            "id" : 307234,
+            "description" : "Football Team",
+            "leaf" : true,
+            "notes" : null,
+            "parent_id" : 280098,
+            "created_at" : "2014-02-26 01:43:51-0600",
+            "updated_at" : "2014-09-15 18:44:04-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ {
+              "id" : 802,
+              "name" : "Bengals"
+            } ]
+          }, {
+            "name" : "BurtCorp - Private",
+            "id" : 280097,
+            "description" : null,
+            "leaf" : false,
+            "notes" : null,
+            "parent_id" : 344,
+            "created_at" : null,
+            "updated_at" : "2015-04-07 15:08:42-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "Green",
+            "id" : 314012,
+            "description" : "Users who's favorite color is green",
+            "leaf" : true,
+            "notes" : null,
+            "parent_id" : 280098,
+            "created_at" : "2014-03-13 08:48:07-0500",
+            "updated_at" : "2014-09-15 18:44:04-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ {
+              "id" : 883,
+              "name" : "Green Rule"
+            } ]
+          }, {
+            "name" : "new test",
+            "id" : 289898,
+            "description" : "new test",
+            "leaf" : true,
+            "notes" : null,
+            "parent_id" : 280098,
+            "created_at" : "2014-01-09 20:35:17-0600",
+            "updated_at" : "2014-09-15 18:44:04-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "NewYorkCold",
+            "id" : 312784,
+            "description" : "Category for Testing Taxonomy Permissioning",
+            "leaf" : true,
+            "notes" : "Sample notes",
+            "parent_id" : 280098,
+            "created_at" : "2014-03-06 12:07:56-0600",
+            "updated_at" : "2014-03-06 12:07:56-0600",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "sanat cat new hello",
+            "id" : 289897,
+            "description" : "sanat test cat hello",
+            "leaf" : true,
+            "notes" : null,
+            "parent_id" : 280098,
+            "created_at" : "2014-01-09 15:37:46-0600",
+            "updated_at" : "2014-09-15 18:44:04-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "Self-Classification",
+            "id" : 280098,
+            "description" : null,
+            "leaf" : false,
+            "notes" : null,
+            "parent_id" : 280097,
+            "created_at" : "2013-11-20 11:37:55-0600",
+            "updated_at" : "2014-09-16 23:06:10-0500",
+            "analytics_excluded" : true,
+            "mutex_children" : false,
+            "navigation_only" : true,
+            "rules" : [ ]
+          }, {
+            "name" : "TaxPermissionTest",
+            "id" : 312783,
+            "description" : "Category for Testing Taxonomy Permissioning",
+            "leaf" : true,
+            "notes" : "Sample notes",
+            "parent_id" : 280098,
+            "created_at" : "2014-03-06 11:45:31-0600",
+            "updated_at" : "2014-03-06 11:45:31-0600",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "Test Category",
+            "id" : 289895,
+            "description" : "Category for testing",
+            "leaf" : true,
+            "notes" : null,
+            "parent_id" : 280098,
+            "created_at" : "2014-01-09 15:09:50-0600",
+            "updated_at" : "2014-09-15 18:44:04-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "Test Category 123",
+            "id" : 425787,
+            "description" : "an example category",
+            "leaf" : true,
+            "notes" : "Just an API test",
+            "parent_id" : 422741,
+            "created_at" : "2015-04-14 07:43:34-0500",
+            "updated_at" : "2015-04-14 07:43:34-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "Test Category 321",
+            "id" : 424251,
+            "description" : "an example category wohooo",
+            "leaf" : true,
+            "notes" : "",
+            "parent_id" : 422741,
+            "created_at" : "2015-04-08 05:21:29-0500",
+            "updated_at" : "2015-04-08 05:26:10-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "updated name",
+            "id" : 422749,
+            "description" : "Brand new category",
+            "leaf" : true,
+            "notes" : "too new to be true",
+            "parent_id" : 280098,
+            "created_at" : "2015-04-01 09:57:58-0500",
+            "updated_at" : "2015-04-01 10:22:17-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ ]
+          }, {
+            "name" : "User Data API Test Category 1",
+            "id" : 289896,
+            "description" : "New Test Category",
+            "leaf" : true,
+            "notes" : null,
+            "parent_id" : 280098,
+            "created_at" : "2014-01-09 15:13:31-0600",
+            "updated_at" : "2014-09-15 18:44:04-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ {
+              "id" : 357,
+              "name" : "Vcat"
+            }, {
+              "id" : 663,
+              "name" : "User Data API Test Rule for category 293896"
+            } ]
+          }, {
+            "name" : "User Data API Test Category 2",
+            "id" : 293885,
+            "description" : "Test Category for the User Data API sim",
+            "leaf" : true,
+            "notes" : null,
+            "parent_id" : 280098,
+            "created_at" : "2014-01-17 09:08:50-0600",
+            "updated_at" : "2014-09-15 18:44:04-0500",
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "navigation_only" : false,
+            "rules" : [ {
+              "id" : 658,
+              "name" : "User Data API Test Rule 2 "
+            }, {
+              "id" : 884,
+              "name" : "User Data API Test Rule for 293885 "
+            } ]
+          } ],
+          "total_count" : 15
+        }
+    http_version: 
+  recorded_at: Mon, 11 May 2015 12:47:27 GMT
+recorded_with: VCR 2.9.3

data/spec/lib/bluekai/category_integration_spec.rb

@@ -53,4 +53,15 @@ RSpec.describe Bluekai::Category, :vcr do
       description: 'an example category wohooo'
     )
   end
+
+  it 'returns correct category ids' do
+    green_id = subject.category_id(['BurtCorp - Private', 'Self-Classification', 'Green'])
+    test_id = subject.category_id([
+      'BurtCorp - Private',
+      'Self-Classification',
+      'a brand new one',
+      'Test Category 123'])
+    expect(green_id).to eq(314012)
+    expect(test_id).to eq(425787)
+  end
 end

data/spec/lib/bluekai/category_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+RSpec.describe Bluekai::Category do
+  describe 'category_id' do
+    let(:bluekai_category_list) do
+      [
+        { name: 'A', id: 1, parent_id: 0 },
+        { name: 'B', id: 2, parent_id: 1 },
+        { name: 'C', id: 3, parent_id: 2 },
+        { name: 'D', id: 4, parent_id: 2 },
+        { name: 'E', id: 5, parent_id: 4 }
+      ]
+    end
+
+    it 'creates, updates and deletes bluekai rules' do
+      expect_any_instance_of(described_class)
+        .to receive(:category_list).and_return(bluekai_category_list)
+
+      expect(subject.category_id(['A'])).to eq(1)
+      expect(subject.category_id(%w(A B))).to eq(2)
+      expect(subject.category_id(%w(A B C))).to eq(3)
+      expect(subject.category_id(%w(A B D))).to eq(4)
+      expect(subject.category_id(%w(A B D E))).to eq(5)
+
+      # case insignificance
+      expect(subject.category_id(['a'])).to eq(1)
+      expect(subject.category_id(%w(a b c))).to eq(3)
+      expect(subject.category_id(%w(A b D e))).to eq(5)
+
+      # nonexistent paths
+      expect(subject.category_id(%w(A B C D))).to be_nil
+      expect(subject.category_id([])).to be_nil
+      expect(subject.category_id(['B'])).to be_nil
+      expect(subject.category_id(%w(B C))).to be_nil
+      expect(subject.category_id(%w(B A))).to be_nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bluekai
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - ad2games GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -123,6 +123,7 @@ files:
 - spec/fixtures/signatures/1a4aff70f9ce0f00680a85710f1bcf9d294239c7748dc1a23ce2bc7b3e1dca77
 - spec/fixtures/signatures/2db01e685f73149994efc9824c10fa91e704fb7256d748c4305101513444f49f
 - spec/fixtures/signatures/3c33aa44e5fbea304ffda0390ac2e413a02d187d5425f67c3edab34684b2b18f
+- spec/fixtures/signatures/5d4d1a042f84b68a2fdf2cc376c8d96d284a648d003f6d917557b43372f99bba
 - spec/fixtures/signatures/78f40f967bf9cb1ae030412e7c28267a8050926a538226c685fb2dec6f23b44a
 - spec/fixtures/signatures/7fe2b3662915bf82890e1fe870480885e0744b12832569c5d7017a0fc42d5527
 - spec/fixtures/signatures/8cd7ba76199d2b34be042841a2dd69310619dcac0f3dd4f24bae6b5fb5f9e302
@@ -136,6 +137,7 @@ files:
 - spec/fixtures/vcr_cassettes/Bluekai_Category/creates_a_category.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Category/lists_4_categories.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Category/reads_a_category_and_its_reach.yml
+- spec/fixtures/vcr_cassettes/Bluekai_Category/returns_correct_category_ids.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Category/updates_a_category.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Client/_ping/when_we_get_a_pong_from_bluekai/.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Client/lists_Bluekai_taxonomy_nodes.yml
@@ -147,6 +149,7 @@ files:
 - spec/fixtures/vcr_cassettes/Bluekai_Rule/updates_a_rule.yml
 - spec/fixtures/vcr_cassettes/Bluekai_UserData/reads_user_information_given_bkuuid.yml
 - spec/lib/bluekai/category_integration_spec.rb
+- spec/lib/bluekai/category_spec.rb
 - spec/lib/bluekai/client_integration_spec.rb
 - spec/lib/bluekai/client_spec.rb
 - spec/lib/bluekai/request_spec.rb
@@ -174,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Simple client for the BlueKai API
@@ -184,6 +187,7 @@ test_files:
 - spec/fixtures/signatures/1a4aff70f9ce0f00680a85710f1bcf9d294239c7748dc1a23ce2bc7b3e1dca77
 - spec/fixtures/signatures/2db01e685f73149994efc9824c10fa91e704fb7256d748c4305101513444f49f
 - spec/fixtures/signatures/3c33aa44e5fbea304ffda0390ac2e413a02d187d5425f67c3edab34684b2b18f
+- spec/fixtures/signatures/5d4d1a042f84b68a2fdf2cc376c8d96d284a648d003f6d917557b43372f99bba
 - spec/fixtures/signatures/78f40f967bf9cb1ae030412e7c28267a8050926a538226c685fb2dec6f23b44a
 - spec/fixtures/signatures/7fe2b3662915bf82890e1fe870480885e0744b12832569c5d7017a0fc42d5527
 - spec/fixtures/signatures/8cd7ba76199d2b34be042841a2dd69310619dcac0f3dd4f24bae6b5fb5f9e302
@@ -197,6 +201,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/Bluekai_Category/creates_a_category.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Category/lists_4_categories.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Category/reads_a_category_and_its_reach.yml
+- spec/fixtures/vcr_cassettes/Bluekai_Category/returns_correct_category_ids.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Category/updates_a_category.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Client/_ping/when_we_get_a_pong_from_bluekai/.yml
 - spec/fixtures/vcr_cassettes/Bluekai_Client/lists_Bluekai_taxonomy_nodes.yml
@@ -208,6 +213,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/Bluekai_Rule/updates_a_rule.yml
 - spec/fixtures/vcr_cassettes/Bluekai_UserData/reads_user_information_given_bkuuid.yml
 - spec/lib/bluekai/category_integration_spec.rb
+- spec/lib/bluekai/category_spec.rb
 - spec/lib/bluekai/client_integration_spec.rb
 - spec/lib/bluekai/client_spec.rb
 - spec/lib/bluekai/request_spec.rb