bluekai 0.0.1

data/spec/fixtures/vcr_cassettes/Bluekai_Client/reads_a_rule.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://bluekai-domain.com/Services/WS/classificationRules/10380?bksig=NcegM6j6CXThFfxrXyjWoXeIi3RoARMRCqX2Co%2B%2BCsQ=&bkuid=bluekai-api-user-key
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 07 Apr 2015 14:59:48 GMT
+      Set-Cookie:
+      - JSESSIONID=930E123268B67F2E8FA1DD22E61A4024; Path=/Services; HttpOnly
+      Content-Type:
+      - application/json
+      Cneonction:
+      - close
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "name" : "CONVERSION_ACTION_SIMULATION_9126",
+          "id" : 10380,
+          "type" : "phint",
+          "status" : "active",
+          "phints" : [ {
+            "id" : 14420,
+            "key" : "offer_id",
+            "value" : "9126",
+            "operator" : "is"
+          } ],
+          "partner_id" : bluekai-partner-id,
+          "created_at" : "Thu Apr 02 09:50:57 CDT 2015",
+          "updated_at" : "Thu Apr 02 09:50:57 CDT 2015",
+          "categories" : [ {
+            "id" : 421427,
+            "name" : "Simulation"
+          }, {
+            "id" : 421262,
+            "name" : "Action"
+          } ],
+          "sites" : [ {
+            "id" : 23705,
+            "name" : "Cake - Data Collection Tag"
+          } ]
+        }
+    http_version: 
+  recorded_at: Tue, 07 Apr 2015 14:59:49 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/Bluekai_Client/updates_a_category.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://bluekai-domain.com/Services/WS/classificationCategories/424251?bksig=6nWdj4cOVG4Cnjm/9qfmjG5MKJ8h446WQKBzT2AP30w=&bkuid=bluekai-api-user-key
+    body:
+      encoding: UTF-8
+      string: '{"description":"an example category wohooo","name":"Test Category 321"}'
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 08 Apr 2015 10:26:10 GMT
+      Set-Cookie:
+      - JSESSIONID=B2B5C8E137645B87EC6C602FDAF735AC; Path=/Services; HttpOnly
+      Content-Type:
+      - application/json
+      Cneonction:
+      - close
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "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",
+          "navigation_only" : false,
+          "analytics_excluded" : false,
+          "mutex_children" : false,
+          "rules" : [ ]
+        }
+    http_version: 
+  recorded_at: Wed, 08 Apr 2015 10:26:11 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/Bluekai_Client/updates_a_rule.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://bluekai-domain.com/Services/WS/classificationRules/12490?bksig=C5k49xPl8GSTb3AfU9ICjyo5rgDFRyF3DCAzHrG7QQs=&bkuid=bluekai-api-user-key
+    body:
+      encoding: UTF-8
+      string: '{"category_ids":[421262],"name":"CONVERSION_TEST_321","partner_id":"bluekai-partner-id","phints":[{"key":"offer_id","value":321,"operator":"contains"}],"site_ids":[23705],"type":"phint"}'
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 07 Apr 2015 14:59:47 GMT
+      Set-Cookie:
+      - JSESSIONID=9EF5CCE41946BA0101768D0ED2A19FE7; Path=/Services; HttpOnly
+      Content-Type:
+      - application/json
+      Cneonction:
+      - close
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "name" : "CONVERSION_TEST_321",
+          "id" : 12490,
+          "type" : "phint",
+          "status" : "active",
+          "phints" : [ {
+            "id" : 16543,
+            "key" : "offer_id",
+            "value" : "321",
+            "operator" : "contains"
+          } ],
+          "partner_id" : bluekai-partner-id,
+          "created_at" : "Tue Apr 07 07:29:29 CDT 2015",
+          "updated_at" : "Tue Apr 07 09:59:47 CDT 2015",
+          "categories" : [ {
+            "id" : 421262,
+            "name" : "Action"
+          } ],
+          "sites" : [ {
+            "id" : 23705,
+            "name" : "Cake - Data Collection Tag"
+          } ]
+        }
+    http_version: 
+  recorded_at: Tue, 07 Apr 2015 14:59:48 GMT
+recorded_with: VCR 2.9.3

data/spec/lib/bluekai/client_integration_spec.rb

@@ -0,0 +1,153 @@
+require 'bluekai/client'
+require 'bluekai/error'
+
+RSpec.describe Bluekai::Client, :vcr do
+  before :each do
+    allow(subject).to receive(:sign).and_wrap_original do |method, http_method, path, query, body|
+      string_to_sign = http_method + path + query.to_s + body.to_s
+      hash = Digest::SHA256.hexdigest(string_to_sign)
+      file = "spec/fixtures/signatures/#{hash}"
+      next File.read(file) if File.exist?(file)
+      result = method.call(http_method, path, query, body)
+      File.open(file, 'w+') { |f| f.write(result) }
+      result
+    end
+  end
+
+  it 'performs a ping' do
+    expect(subject.ping).to eq(true)
+  end
+
+  it 'lists Bluekai taxonomy nodes' do
+    tax_response = subject.taxonomy(parentID: 186)
+    expect(tax_response).to all(have_key(:nodeID))
+    expect(tax_response).to all(have_key(:nodeName))
+  end
+
+  it 'creates a rule' do
+    rule_body = {
+      name: 'CONVERSION_TEST_123',
+      type: 'phint',
+      phints: [{
+        key: 'offer_id',
+        value: 321,
+        operator: 'is'
+      }],
+      category_ids: [421262],
+      site_ids: [23705]
+    }
+    create_response = subject.rule_create(rule_body)
+    expect(create_response).to include(
+      name: 'CONVERSION_TEST_123',
+      type: 'phint',
+      status: 'active',
+      phints: [{ id: 16552, key: 'offer_id', value: '321', operator: 'is' }],
+      categories: [{ id: 421262, name: 'Action' }],
+      sites: [{ id: 23705, name: 'Cake - Data Collection Tag' }]
+    )
+  end
+
+  it 'updates a rule' do
+    update_body = {
+      name: 'CONVERSION_TEST_321',
+      type: 'phint',
+      phints: [{
+        key: 'offer_id',
+        value: 321,
+        operator: 'contains'
+      }],
+      category_ids: [421262],
+      site_ids: [23705]
+    }
+
+    update_response = subject.rule_update(12490, update_body)
+
+    expect(update_response).to include(
+      name: 'CONVERSION_TEST_321',
+      type: 'phint',
+      status: 'active',
+      phints: [{ id: 16543, key: 'offer_id', value: '321', operator: 'contains' }],
+      categories: [{ id: 421262, name: 'Action' }]
+    )
+  end
+
+  it 'reads a rule' do
+    read_response = subject.rule_read(10380)
+    expect(read_response).to include(
+      categories: [{ id: 421427, name: 'Simulation' },
+                   { id: 421262, name: 'Action' }],
+      created_at: 'Thu Apr 02 09:50:57 CDT 2015',
+      id: 10380,
+      name: 'CONVERSION_ACTION_SIMULATION_9126',
+      phints: [{ id: 14420, key: 'offer_id', value: '9126', operator: 'is' }],
+      sites: [{ id: 23705, name: 'Cake - Data Collection Tag' }],
+      status: 'active',
+      type: 'phint'
+    )
+  end
+
+  it 'lists 10 phint rules' do
+    rule_list = subject.rule_list(offset: 0, size: 10, type: 'phint')
+    expect(rule_list.count).to eq(10)
+    expect(rule_list).to all(include(
+      type: 'phint'
+    ))
+  end
+
+  ###
+  # Categories
+  ###
+
+  it 'reads a category and its reach' do
+    read_response = subject.category_read(category_id: 421262, stats: 'True')
+    expect(read_response).to include(
+      name: 'Action',
+      id: 421262,
+      description: 'People who converted for Action games',
+      leaf: true,
+      parent_id: 421229
+    )
+    expect(read_response[:rules].size).to be > 0
+  end
+
+  it 'lists 4 categories' do
+    list_response = subject.category_list(offset: 0, size: 4)
+    expect(list_response.count).to eq(4)
+    expect(list_response).to all(have_key(:name))
+    expect(list_response).to all(have_key(:rules))
+  end
+
+  it 'creates a category' do
+    category_body = {
+      name: 'Test Category 123',
+      parent_id: '422741',
+      description: 'an example category',
+      analytics_excluded: 'false',
+      navigation_only: 'false',
+      mutex_children: 'false',
+      notes: 'Just an API test'
+    }
+    create_response = subject.category_create(category_body)
+    expect(create_response).to include(
+      name: 'Test Category 123',
+      parent_id: 422741,
+      description: 'an example category',
+      analytics_excluded: false,
+      navigation_only: false,
+      mutex_children: false,
+      notes: 'Just an API test'
+    )
+  end
+
+  it 'updates a category' do
+    category_update_body = {
+      name: 'Test Category 321',
+      description: 'an example category wohooo'
+    }
+    update_response = subject.category_update(424251, category_update_body)
+    expect(update_response).to include(
+      name: 'Test Category 321',
+      description: 'an example category wohooo'
+    )
+  end
+end

data/spec/lib/bluekai/client_spec.rb

@@ -0,0 +1,19 @@
+require 'bluekai/client'
+require 'bluekai/error'
+
+RSpec.describe Bluekai::Client do
+  subject { described_class.new(api_private_key: '1234') }
+
+  describe '#sign' do
+    it 'computes a correct signature' do
+      signature = subject.send(:sign, 'GET', '/Services/WS/classificationCategories/', 'blabli', key1: 'value1', key2: 'value2')
+      expect(signature).to eq('msNdVnof8pNLImtDYxh0KDiMHWqrvjExAEh7UcSLJw8%3D')
+    end
+  end
+
+  describe '#request' do
+    it 'raises ArgumentError if unknown HTTP method is passed' do
+      expect { subject.send(:request, 'FOO', '123', {}, nil) }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,108 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'vcr'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow you to limit a spec run
+  #   # to individual examples or groups you care about by tagging them with
+  #   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  #   # get run.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  #   # For more details, see:
+  #   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end
+
+ENV['BLUEKAI_API_USER_KEY'] ||= 'bluekai-api-user-key'
+ENV['BLUEKAI_API_PRIVATE_KEY'] ||= 'bluekai-private-key'
+ENV['BLUEKAI_DOMAIN'] ||= 'bluekai-domain.com'
+ENV['BLUEKAI_PARTNER_ID'] ||= '2695'
+
+VCR.configure do |c|
+  c.configure_rspec_metadata!
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.filter_sensitive_data('bluekai-api-user-key') { ENV['BLUEKAI_API_USER_KEY'] }
+  c.filter_sensitive_data('bluekai-domain.com') { ENV['BLUEKAI_DOMAIN'] }
+  c.filter_sensitive_data('bluekai-private-key') { ENV['BLUEKAI_API_PRIVATE_KEY'] }
+  c.filter_sensitive_data('bluekai-partner-id') { ENV['BLUEKAI_PARTNER_ID'] }
+  # allow codeclimate-test-reporter to call the mothership
+  c.ignore_hosts 'codeclimate.com'
+end