bluekai 0.0.1 → 0.0.2

data/lib/bluekai/rule.rb

@@ -0,0 +1,165 @@
+module Bluekai
+  class Rule < Client
+    ####
+    #### Classification Rules
+    #### API definition can be found here
+    #### https://kb.bluekai.com/display/PD/Self-Classification+Rule+API
+    ####
+
+    # Public: List the self-classification rules in your private
+    # taxonomy
+    #
+    # sort_by:string - Enter 'status', 'id', 'created_at', 'updated_at',
+    #                  or 'type' to sort the returned self-classification
+    #                  rules by the specified option.
+    #
+    # sorting_order:string  - Enter 'asc' or 'desc' to list the returned
+    #                         self-classification rules in ascending or descending
+    #                         order based on the specified sort option.
+    #
+    # ids:integer - Returns the self-classification rule matching the specified
+    #               rule ID, or returns all the self-classification rules matching
+    #               the specified list of rule IDs. Syntax for passing multiple rule IDs:
+    #               ruleId1&id=ruleId2 Example: 123&id=125
+    #
+    # type:enum  - Enter 'phint' or 'url' to return only the phint or
+    #              URL-based self-classification rules.
+    #
+    # site_ids:string  - Returns all the self-classification rules under the
+    #                    specified site ID or list of site IDs. Syntax for
+    #                    passing multiple site IDs: site_id_1&site_ids=site_id_2
+    #                    Example: 1234&site_ids=1235
+    #
+    # category_ids:string  - Returns all the self-classification rules used
+    #                        to map the specified catgeory ID or list of category IDs.
+    #                        Syntax for passing multiple category
+    #                        IDs: category_id_1&category_ids=category_id_2
+    #                        Example: 1234&category_ids=1235
+    #
+    # offset:integer - Specify the starting index from which to return the
+    #                  self-classification rules.
+    #
+    # size:integer - Specify the maximum number of rules to be included in
+    #                the response. This filter requires the offset filter
+    #                to be specified.
+    #
+    # created_date_range:string - Returns all the self-classification rules
+    #                             created within the specified list of dates.
+    #                             Syntax: YYYY-MM-DD&created_date_range=YYYY-MM-DD
+    #                             Example: 2014-01-01&created_date_range=2014-31-01
+    #
+    # updated_date_range:string  - Returns all the self-classification rules updated
+    #                              within the specified list of dates.
+    #                              Syntax: YYYY-MM-DD&updated_date_range=YYYY-MM-DD
+    #                              Example: 2014-01-01&updated_date_range=2014-31-01
+    #
+    # status:string - Enter 'Active' or 'Creating' to return the
+    #                 self-classification rules based on the specified status referrer
+    #                 boolean  Returns all URL-based self-classification rules that
+    #                 classify the site URL (False) or the referrer URL (True) in
+    #                 the collected URL.
+    #
+    # exact:boolean - Returns all URL-based self-classification rules that classify
+    #                 an exact URL (True) or a top-level URL (False) in the collected URL.
+    # Returns: hash of Bluekai rules
+    def rule_list(query)
+      request('GET', '/Services/WS/classificationRules', query)[:rules]
+    end
+
+    # Public: Reads a self-classification rule
+    #
+    # rule_id:integer - The unique ID assigned to the
+    # self-classification rule to be retrieved
+    #
+    # Returns: hash of Blukkai rule parameters
+    def rule_read(rule_id)
+      request('GET', "/Services/WS/classificationRules/#{rule_id}", {})
+    end
+
+    # Public: Creates a new self-classification rule
+    #
+    # name:string - Enter a string specifying the name of the self-classification rule.
+    #
+    # type:string - {'phint', 'url'} Specify the type of classification rule.
+    #
+    # phints:[{phint}] - If you are creating a phint-based rule,
+    #                    enter a list of your phint definitions.
+    #                    Each phint requires the following properties:
+    #                    key - The phint key operator - The criteria
+    #                    used for determining how the phint value
+    #                    is applied ('is' or 'contains')
+    #                    value - The full or partial phint value,
+    #                    depending on the specified operator.
+    #
+    # urls:[string(s)] - Provide a list of your URL definitions
+    #                    if you are creating for URL-based rules.
+    #
+    # referrer:string - {'True','False'} If you are creating a
+    #                   URL-based rule, specify whether the URL to
+    #                   be classified is the site URL (False) or
+    #                   the referrer URL (True).
+    #
+    # exact:string - {'True','False'} If you are creating a
+    #                URL-based rule, specify whether the URL collected
+    #                from your site must match the URL in your
+    #                rule (True) or match a top-level URL (False) so
+    #                that you can target users visiting the child pages
+    #                without specifying them.
+    #
+    # partner_id:integer - Enter the unique ID assigned to your BlueKai DMP seat.
+    #
+    # site_ids (optional):[interger(s)] - Enter a list of containers/site IDs to which
+    #                                     the self-classification rule applies. If
+    #                                     you do not include this parameter, the
+    #                                     rule is applicable to ALL the
+    #                                     container/site IDs in your seat.
+    #
+    # category_ids:[integer(s)] - a list of category IDs to which
+    #                             the self-classification rule applies.
+    #
+    # JSON example for Phint-based self-classification rule
+    # {
+    # "name": "Phint Example",
+    # "type": "phint",
+    # "phints": [
+    # {
+    # "key": "x",
+    # "value": "123",
+    # "operator": "is"
+    # }
+    # ],
+    # "partner_id": 123,
+    # "site_ids": [1234],
+    # "category_ids": [12345]
+    # }
+    #
+    # JSON example for URL-based self-classiifcation rule
+    # {
+    # "name": "URL Example",
+    # "type": "url",
+    # "urls": ["http://shop.yoursite.com"],
+    # "referrer": false,
+    # "exact": false,
+    # "partner_id": 123,
+    # "site_ids": [1234],
+    # "category_ids": [123456]
+    # }
+    # Returns: hash of created self-classification rule
+    def rule_create(body)
+      body = { partner_id: @partner_id }.merge(body)
+      request('POST', '/Services/WS/classificationRules', {}, body)
+    end
+
+    # Public: Update a self-classification rule
+    #
+    # rule_id:integer (MANDATORY) - id of classification rule to be updated
+    #
+    # for other parameters refer to documentation of rule_create(body)
+    #
+    # Returns: hash of updated self-classification rule
+    def rule_update(rule_id, body)
+      body = { partner_id: @partner_id }.merge(body)
+      request('PUT', "/Services/WS/classificationRules/#{rule_id}", {}, body)
+    end
+  end
+end

data/lib/bluekai/user_data.rb

@@ -0,0 +1,90 @@
+module Bluekai
+  class UserData < Client
+    ####
+    #### User Data
+    ####
+    #### API definition can be found here
+    #### https://kb.bluekai.com/display/PD/User+Data+API
+    ####
+
+    # Public: method to add attributes to a user's online profile,
+    # and to return the categories for which they qualified in one
+    # or more campaigns.
+    #
+    # siteid:integer - Enter the site ID associated with the
+    #                  BlueKai Container you deployed on your site. If you are sending data
+    #                  to BlueKai, the specified site ID must be included in the
+    #                  classification rules used to map your phints (user attributes)
+    #                  to categories in your taxonomy. If you are getting data, the
+    #                  specified site ID must be in the pixel URL of the campaign
+    #                  targeting the user.
+    #
+    # userid:string - Enter the encrypted BlueKai UUID (BKUUID) for the user. The BKUUID may
+    #                 be returned by the ID swap tag you deployed on your site.
+    #
+    # puserid:string - Enter your Partner-based UUID (PUUID) for the user.
+    #
+    # pfield:string - If you entered a puserid that was ID swapped with BlueKai via
+    #                 phints (for example, you used the BlueKai CoreTag to send the
+    #                 puserid to BlueKai), you must do the following in order to use it for
+    #                 sending and getting user data: 1. In the pfield parameter, enter the
+    #                 type of key (fieldname) associated with the puserid you are passing.
+    #                 The pfield is used to uniquely identify your puserid(s) in the
+    #                 BlueKai platform. 2. Contact your BlueKai Account Manager to
+    #                 enable your pfield in the BlueKai system.
+    #
+    # idfa:string - If you are sending or getting data on an iOS mobile app user, enter the
+    #               Identifier for Advertising (IDFA) of the mobile iOS device.
+    #               Note: The data you are sending or getting is linked exclusively to the
+    #               IDFA, which operates in a primary ID space (the data is not linked to
+    #               a BKUUID). You do not need to pass the userid or puserid when passing the
+    #               idfa.If you pass both an idfa and a userid/puserid, the user will be
+    #               looked up based on the userid/puserid.
+    #
+    # adid:string -  If you are sending or getting data on an Android mobile app user,
+    #                enter the Google Advertising ID of the mobile Android device. Note: The
+    #                data you are sending or getting is linked exclusively to the AdID,
+    #                which operates in a primary ID space (the data is not linked to a
+    #                BKUUID). You do not need to pass the userid or puserid when
+    #                passing the adid.If you pass both an adid and a userid/puserid,
+    #                the user will be looked up based on the userid/puserid.
+    #
+    # useragent:string - If you are sending or getting data on a mobile user (via their
+    #                    BlueKai statistical ID), enter the user agent of the mobile device
+    #                    and the ipaddress.
+    #
+    # ipaddress:string - If you are sending or getting data on a mobile user (via their
+    #                    BlueKai statistical ID), enter the IP address of the user's
+    #                    mobile device and the useragent.
+    #
+    # create_profile:string - Enter 1 to create a new user profile in the BlueKai Profile
+    #                         Store, and add the categories specified in the phint field to it.
+    #
+    # phint:string - Enter a phint or a list of phints (key-value pairs that represent user
+    #                attributes) to tag the user with. The maximum number of phints you
+    #                can pass is restricted by the maximum size of the HTTP GET
+    #                request, which is 2,048 bytes.
+    #                Syntax for passing multiple phints: category1=value&phint=category2=value
+    #                Example: v=123&phint=v=345
+    #
+    # filterbycampids:string - Enter a campaign ID or a comma-separated list of campaign IDs
+    #                          to filter the categories returned by the
+    #                          User Data API based on the campaigns that won the user.
+    #
+    #                          Syntax for passing multiple campaign IDs: campaignId1=value&filterbycampids=campaignId2=value
+    #                          Example: 44966&filterbycampids=41674
+    #
+    # target:integer - By default, this flag is set to 1, which means that the User Data
+    #                  API returns the categories that user has been tagged with. Enter 0
+    #                  to disable user targeting and not return any user categories.
+    def user_data(site_id, query)
+      request('GET', "/getdata/#{site_id}/v1.2", query, nil)
+    end
+
+    private
+
+    def domain
+      'http://api.tags.bluekai.com'
+    end
+  end
+end

data/lib/bluekai/version.rb

@@ -1,3 +1,3 @@
 module Bluekai
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/bluekai.rb

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

data/spec/fixtures/signatures/0e01a80ff1ca77f4fd32b58ff48310168539a9a26e4ef527042b7bab78d4648a

@@ -0,0 +1 @@
+6yKY4ELmcOD1mWIoiTNkfeNKtA6P6UlUH0tnW2DuYvk%3D

data/spec/fixtures/signatures/7fe2b3662915bf82890e1fe870480885e0744b12832569c5d7017a0fc42d5527

@@ -0,0 +1 @@
+1CzTegZKodeBp5tYeJoYsPvFcd75MOWRz5SV%2FZrVB1w%3D

data/spec/fixtures/signatures/8cd7ba76199d2b34be042841a2dd69310619dcac0f3dd4f24bae6b5fb5f9e302

@@ -0,0 +1 @@
+%2FOMmOpBsb88KpnipB5og6HaMrTjXEjNPDYuwLoTEgT0%3D

data/spec/fixtures/signatures/95768bffa5416007061da13a2a0368e52a4bea3451ac2dfede43f6a6841ac402

@@ -0,0 +1 @@
+PcRmnygfAQ2726R%2BkEJekFp5rmBboLgbhbcxrq3iCfQ%3D

data/spec/fixtures/vcr_cassettes/{Bluekai_Client → Bluekai_Category}/creates_a_category.yml

@@ -2,11 +2,11 @@
 http_interactions:
 - request:
     method: post
-    uri: https://bluekai-domain.com/Services/WS/classificationCategories?bksig=oiIT/%2BY9Y/IHdSlOu80lscu9p76Ez78X8AGi5tTXKYc=&bkuid=bluekai-api-user-key
+    uri: https://services.bluekai.com/Services/WS/classificationCategories?bksig=1CzTegZKodeBp5tYeJoYsPvFcd75MOWRz5SV/ZrVB1w=&bkuid=bluekai-api-user-key
     body:
       encoding: UTF-8
       string: '{"analytics_excluded":"false","description":"an example category","mutex_children":"false","name":"Test
-        Category 123","navigation_only":"false","notes":"Just an API test","parent_id":"422741"}'
+        Category 123","navigation_only":"false","notes":"Just an API test","parent_id":"424547"}'
     headers:
       Accept:
       - application/json
@@ -18,9 +18,9 @@ http_interactions:
       message: OK
     headers:
       Date:
-      - Wed, 08 Apr 2015 10:21:29 GMT
+      - Wed, 15 Apr 2015 09:55:23 GMT
       Set-Cookie:
-      - JSESSIONID=213DF2DFD4497967DE02681C2EB5EF07; Path=/Services; HttpOnly
+      - JSESSIONID=BFC398D84CD7A9F2E28DA873A55047CF; Path=/Services; HttpOnly
       Content-Type:
       - application/json
       Cneonction:
@@ -32,18 +32,18 @@ http_interactions:
       string: |-
         {
           "name" : "Test Category 123",
-          "id" : 424251,
+          "id" : 426057,
           "description" : "an example category",
           "leaf" : true,
           "notes" : "Just an API test",
-          "parent_id" : 422741,
-          "created_at" : "2015-04-08 05:21:29-0500",
-          "updated_at" : "2015-04-08 05:21:29-0500",
+          "parent_id" : 424547,
+          "created_at" : "2015-04-15 04:55:23-0500",
+          "updated_at" : "2015-04-15 04:55:23-0500",
+          "navigation_only" : false,
           "analytics_excluded" : false,
           "mutex_children" : false,
-          "navigation_only" : false,
           "rules" : [ ]
         }
     http_version: 
-  recorded_at: Wed, 08 Apr 2015 10:21:32 GMT
+  recorded_at: Wed, 15 Apr 2015 09:55:24 GMT
 recorded_with: VCR 2.9.3

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

@@ -0,0 +1,104 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://services.bluekai.com/Services/WS/classificationCategories?bksig=UBH5ABTZ0lJteX19/H5SxV7R70l9pT4Uf5UFFzdFyrE=&bkuid=bluekai-api-user-key&offset=0&size=4&sort_by=name&sorting_order=asc
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 14 Apr 2015 11:56:26 GMT
+      Set-Cookie:
+      - JSESSIONID=762114A14F8B1C4D0769EA1354B105A8; Path=/Services; HttpOnly
+      Content-Type:
+      - application/json
+      Cneonction:
+      - close
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "categories" : [ {
+            "name" : "Accessories",
+            "id" : 424261,
+            "description" : "Accessories category",
+            "leaf" : true,
+            "notes" : "",
+            "parent_id" : 424270,
+            "created_at" : "2015-04-08 08:57:41-0400",
+            "updated_at" : "2015-04-08 09:12:57-0400",
+            "navigation_only" : false,
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "rules" : [ {
+              "id" : 12543,
+              "name" : "ST_SHARE_ACCESSORIES"
+            } ]
+          }, {
+            "name" : "Accessories",
+            "id" : 424276,
+            "description" : "Accessories category",
+            "leaf" : true,
+            "notes" : "",
+            "parent_id" : 424269,
+            "created_at" : "2015-04-08 08:57:41-0400",
+            "updated_at" : "2015-04-08 09:07:20-0400",
+            "navigation_only" : false,
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "rules" : [ {
+              "id" : 12538,
+              "name" : "ST_BUY_ACCESSORIES"
+            } ]
+          }, {
+            "name" : "Accessories",
+            "id" : 424283,
+            "description" : "Accessories category",
+            "leaf" : true,
+            "notes" : "",
+            "parent_id" : 424271,
+            "created_at" : "2015-04-08 08:57:41-0400",
+            "updated_at" : "2015-04-08 09:14:34-0400",
+            "navigation_only" : false,
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "rules" : [ {
+              "id" : 12548,
+              "name" : "ST_DETAIL_ACCESSORIES"
+            } ]
+          }, {
+            "name" : "Accessories",
+            "id" : 424284,
+            "description" : "Accessories category",
+            "leaf" : true,
+            "notes" : "",
+            "parent_id" : 424272,
+            "created_at" : "2015-04-08 08:57:41-0400",
+            "updated_at" : "2015-04-08 09:15:57-0400",
+            "navigation_only" : false,
+            "analytics_excluded" : false,
+            "mutex_children" : false,
+            "rules" : [ {
+              "id" : 12553,
+              "name" : "ST_HEART_ACCESSORIES"
+            } ]
+          } ],
+          "total_count" : 84
+        }
+    http_version: 
+  recorded_at: Tue, 14 Apr 2015 11:56:26 GMT
+recorded_with: VCR 2.9.3