bluekai 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51af5eb445beb71937839077803c711846d636b1
-  data.tar.gz: 8358216076ae1562c321988381de79a700c24b36
+  metadata.gz: 774cef3b18775e0f088571f7d474faf5646202ba
+  data.tar.gz: f9e04b63d36e4e3c9b7d9742fad2d12a2d1060f3
 SHA512:
-  metadata.gz: e6ab9bf86b7975e822786df0d50458f5f9051dc59477013ae9149cd9e1f219473ab5f9b15b29fa6dc8da54ecb50ddd6428b06fe5c254f3334e2977e811205e1c
-  data.tar.gz: 68e0deae9ecc2f9f95e745ab3607667927cad730bfcf83b35c7a31671dd3ce2acb3987fbe6db1f14770a8d61ea3cad0d56c3745b199e02f021137c500358a112
+  metadata.gz: 6345648e62bcd0ecba25bca44b82a09167ff2ab5a90173251f153021189e7d80dd957220cab30fff2c36ed3b9a0a24f772e3385c3b6e76f009e89d7bc03b4734
+  data.tar.gz: 90670e389cb1e762c5734c65b1bd8ae69265d88266c5dd7655a656f452aa2fd4f7a12c117b8258cc0928dc5eb24c4d3f0595429d41af0b7692d6a23b7924b74e

data/README.md

@@ -1,8 +1,8 @@
 # Bluekai
 [![Gem Version](http://img.shields.io/gem/v/bluekai.svg)](http://rubygems.org/gems/bluekai)
-[![Circle CI](https://circleci.com/gh/ad2games/bluekai.png?style=shield&circle-token=323d6ce1376f1473cab4474d89f8fc7287446595)](https://circleci.com/gh/ad2games/bluekai)
-[![Code Climate](https://codeclimate.com/repos/5523e6d8695680516e00144d/badges/40648ea53c768dd15de5/gpa.svg)](https://codeclimate.com/repos/5523e6d8695680516e00144d/feed)
-[![Test Coverage](https://codeclimate.com/repos/5523e6d8695680516e00144d/badges/40648ea53c768dd15de5/coverage.svg)](https://codeclimate.com/repos/5523e6d8695680516e00144d/feed)
+[![Circle CI](https://circleci.com/gh/ad2games/bluekai.svg?style=svg)](https://circleci.com/gh/ad2games/bluekai)
+[![Code Climate](https://codeclimate.com/github/ad2games/bluekai/badges/gpa.svg)](https://codeclimate.com/github/ad2games/bluekai)
+[![Test Coverage](https://codeclimate.com/github/ad2games/bluekai/badges/coverage.svg)](https://codeclimate.com/github/ad2games/bluekai/coverage)
 
 
 ## Installation

data/lib/bluekai/request.rb

@@ -20,6 +20,13 @@ module Bluekai
       JSON.parse(response.body, symbolize_names: true)
     end
 
+    # HMAC-SHA256(Secret key, HTTP_METHOD + URI_PATH + QUERY_ARG_VALUES + POST_DATA)
+    def signature
+      digest = OpenSSL::Digest.new('sha256')
+      hmac = OpenSSL::HMAC.digest(digest, api_private_key, string_to_sign)
+      CGI.escape(Base64.strict_encode64(hmac))
+    end
+
     private
 
     attr_reader :method, :path, :query, :body, :domain
@@ -42,13 +49,8 @@ module Bluekai
     end
 
     def url
-      "#{domain}#{path}?#{query_url_formatted}"\
-        "bkuid=#{api_user_key}&bksig=#{signature}"
-    end
-
-    def query_values
-      return nil unless query
-      query.values.join
+      "#{domain}#{path}?#{query_string}"\
+        "&bkuid=#{api_user_key}&bksig=#{signature}"
     end
 
     def body_sorted
@@ -63,20 +65,21 @@ module Bluekai
       }
     end
 
-    def query_url_formatted
+    def query_values
       return nil unless query
-      query.map { |k, v| "#{k}=#{v}" }.join('&') + '&'
+      query_string.split('&').map { |p| p.split('=', 2)[1] }.join
     end
 
-    def string_to_sign
-      method + path + query_values.to_s + body_sorted.to_s
+    def query_string(params = nil, prefix = '')
+      # converts a (nested) hash of query parameters into a query string.
+      (params || query || {})
+        .map { |k, v| v.is_a?(Hash) ? query_string(v, "#{k}=") : "#{prefix}#{k}=#{v}" }
+        .join('&')
     end
 
-    # HMAC-SHA256(Secret key, HTTP_METHOD + URI_PATH + QUERY_ARG_VALUES + POST_DATA)
-    def signature
-      digest = OpenSSL::Digest.new('sha256')
-      hmac = OpenSSL::HMAC.digest(digest, api_private_key, string_to_sign)
-      CGI.escape(Base64.strict_encode64(hmac))
+    def string_to_sign
+      # see the example here: https://kb.bluekai.com/display/PD/Programming+Example
+      method + path + query_values.to_s + body_sorted.to_s
     end
   end
 end

data/lib/bluekai/version.rb

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

data/spec/lib/bluekai/request_spec.rb

@@ -1,14 +1,25 @@
 RSpec.describe Bluekai::Request do
-  describe '#sign' do
+  describe '#signature' do
     it 'computes a correct signature' do
-      rq = described_class.new(
+      subject = described_class.new(
         'GET',
         '/Services/WS/classificationCategories/',
         { ho: 'blabli' },
         { key1: 'value1', key2: 'value2' },
         'https://services.bluekai.com')
-      rq.api_private_key = '1234'
-      expect(rq.send(:signature)).to eq('t%2BE36Yup7ORbC3WRux5xY7ohUxqFo5AGsKrGjJYDCKs%3D')
+      subject.api_private_key = '1234'
+      expect(subject.signature).to eq('t%2BE36Yup7ORbC3WRux5xY7ohUxqFo5AGsKrGjJYDCKs%3D')
+    end
+
+    it 'accounts for nested GET url params' do
+      subject = described_class.new(
+        'GET',
+        '/getdata/1234/v1.2',
+        { puserid: '42', phint: { event: 'click', offer_id: 1234 } },
+        {},
+        'https://services.bluekai.com')
+      subject.api_private_key = '1234'
+      expect(subject.signature).to eq('KOl1c80m2SQ6%2Fv5K0OLAUKejcrw6zXEsQ9crbcV6n3Y%3D')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bluekai
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - ad2games GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Simple client for the BlueKai API