bing_ads_ruby_sdk 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89dc5300add7a826e0b81dde909dfa4fea569158cbc69262fc88df6aaa3be605
-  data.tar.gz: f6532c9e322b4b3fdf152360f18c372e481dd192a17e3cb0f93832e3a162cfff
+  metadata.gz: e9352d8c5f77aca5732658f3bbf045528f8c813349430af4a9c05a69457df927
+  data.tar.gz: 14762060f02d65b3a9980d4a4b9cd988d46ef2a6163869ee1c1c443f085c4369
 SHA512:
-  metadata.gz: 46ccf557939fcc6310d94e0db8747e9a597e7107f7ce4782892118c2515b8b264612cae449c5c6630df63dccb9308024d0c3b742672fb5731688925c916ee526
-  data.tar.gz: 3edfd79352c1b33cb19e81115287c9b3e19722045660d887591e3b70345e88f831c3baca62fba50bfaaaaf055652996e006dbc7d46179619d5928cbf05ae984c
+  metadata.gz: f3b09a5a61f94c913e54f08ff6145f51c5849f6a743a5ace400d6ba381a639497cf459733b99285f0fe58a8062add0b7f1c0b5b4a949ff2467d81ce46e7e26c9
+  data.tar.gz: 1bc8e7c7c10e25b2a6d4201a692133c0fa317b0c70d5fb38961d3fecc2303dc9001e88c7e112dd5b076c21961f2a31388c4886aff07d075ba78e43f7e3e335da

data/bing_ads_ruby_sdk.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'signet', '~> 0.8.1'
+  spec.add_runtime_dependency 'signet', '>= 0.8.1', '< 0.13.0'
   spec.add_runtime_dependency 'excon', '>= 0.62.0'
   spec.add_runtime_dependency 'lolsoap', '>=0.9.0'
 

data/changelog.md

@@ -1,3 +1,7 @@
+## V1.3.1 Release
+
+- add client secret in signatures
+
 ## V1.3.0 Release
 Allow instrumentation of HTTP requests via ActiveSupport::Notifications
 

data/lib/bing_ads_ruby_sdk/api.rb

@@ -27,12 +27,14 @@ module BingAdsRubySdk
                    environment: :production,
                    developer_token:,
                    client_id:,
-                   oauth_store:)
+                   oauth_store:,
+                   client_secret: nil)
       @version = version
       @environment = environment
       @header = Header.new(
         developer_token: developer_token,
         client_id: client_id,
+        client_secret: client_secret,
         store: oauth_store
       )
     end

data/lib/bing_ads_ruby_sdk/header.rb

@@ -6,9 +6,10 @@ module BingAdsRubySdk
     # @param developer_token
     # @param client_id
     # @param store instance of a store
-    def initialize(developer_token:, client_id:, store:)
+    def initialize(developer_token:, client_id:, store:, client_secret: nil)
       @developer_token = developer_token
       @client_id = client_id
+      @client_secret = client_secret
       @oauth_store = store
       @customer = {}
     end
@@ -20,7 +21,9 @@ module BingAdsRubySdk
         "DeveloperToken" =>      developer_token,
         "CustomerId" =>          customer[:customer_id],
         "CustomerAccountId" =>   customer[:account_id]
-      }
+      }.tap do |hash|
+        hash["ClientSecret"] = client_secret if client_secret
+      end
     end
 
     def set_customer(account_id:, customer_id:)
@@ -31,13 +34,14 @@ module BingAdsRubySdk
 
     private
 
-    attr_reader :oauth_store, :developer_token, :client_id, :customer
+    attr_reader :oauth_store, :developer_token, :client_id, :customer, :client_secret
 
     def auth_handler
       @auth_handler ||= ::BingAdsRubySdk::OAuth2::AuthorizationHandler.new(
         developer_token: developer_token,
         client_id: client_id,
-        store: oauth_store
+        store: oauth_store,
+        client_secret: client_secret
       )
     end
   end

data/lib/bing_ads_ruby_sdk/oauth2/authorization_handler.rb

@@ -9,8 +9,10 @@ module BingAdsRubySdk
       # @param developer_token
       # @param client_id
       # @param store [Store]
-      def initialize(developer_token:, client_id:, store:)
-        @client = build_client(developer_token, client_id)
+      def initialize(developer_token:, client_id:, store:, client_secret: nil)
+        @client = Signet::OAuth2::Client.new(
+          client_params(developer_token, client_id, client_secret)
+        )
         @store  = store
         refresh_from_store
       end
@@ -73,15 +75,17 @@ module BingAdsRubySdk
         query_params.find { |arg| arg.first.casecmp("CODE").zero? }
       end
 
-      def build_client(developer_token, client_id)
-        Signet::OAuth2::Client.new({
+      def client_params(developer_token, client_id, client_secret)
+        {
           authorization_uri:    'https://login.microsoftonline.com/common/oauth2/v2.0/authorize',
           token_credential_uri: 'https://login.microsoftonline.com/common/oauth2/v2.0/token',
           redirect_uri:         'https://login.microsoftonline.com/common/oauth2/nativeclient',
           developer_token: developer_token,
           client_id: client_id,
           scope: 'offline_access'
-        })
+        }.tap do |hash|
+          hash[:client_secret] = client_secret if client_secret
+        end
       end
 
       def token_data

data/lib/bing_ads_ruby_sdk/services/base.rb

@@ -23,6 +23,11 @@ module BingAdsRubySdk
         postprocess(response)
       end
 
+      def call_wrapper(action, message, *response_nesting)
+        response = call(action, message)
+        wrap_array(dig_response(response, response_nesting))
+      end
+
       def self.service
         raise 'implement me'
       end
@@ -31,11 +36,6 @@ module BingAdsRubySdk
 
       attr_reader :soap_client
 
-      def call_wrapper(action, message, *response_nesting)
-        response = call(action, message)
-        wrap_array(dig_response(response, response_nesting))
-      end
-
       def preprocess(message, operation_name)
         order(
           soap_client.wsdl_wrapper(operation_name),
@@ -80,4 +80,4 @@ module BingAdsRubySdk
       end
     end
   end
-end
+end

data/lib/bing_ads_ruby_sdk/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module BingAdsRubySdk
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.3.1'.freeze
   DEFAULT_SDK_VERSION = :v13
 end

data/spec/bing_ads_ruby_sdk/header_spec.rb

@@ -1,6 +1,14 @@
 RSpec.describe BingAdsRubySdk::Header do
   let(:oauth_store) { double(:oauth_store) }
-  let(:subject) { described_class.new(developer_token: '123abc', client_id: '1a-2b-3c', store: oauth_store) }
+  let(:client_secret) { 'pa$$w0rd' }
+  let(:subject) do
+    described_class.new(
+      developer_token: '123abc',
+      client_id: '1a-2b-3c',
+      client_secret: client_secret,
+      store: oauth_store,
+    )
+  end
   let(:auth_handler) do
     double(:auth_handler, fetch_or_refresh: 'yes/we/can')
   end
@@ -9,6 +17,7 @@ RSpec.describe BingAdsRubySdk::Header do
     expect(::BingAdsRubySdk::OAuth2::AuthorizationHandler).to receive(:new).with(
       developer_token: '123abc',
       client_id: '1a-2b-3c',
+      client_secret: client_secret,
       store: oauth_store
     ).and_return auth_handler
   end
@@ -19,10 +28,23 @@ RSpec.describe BingAdsRubySdk::Header do
         "AuthenticationToken" => 'yes/we/can',
         "DeveloperToken" =>      '123abc',
         "CustomerId" =>          nil,
-        "CustomerAccountId" =>   nil
+        "CustomerAccountId" =>   nil,
+        "ClientSecret" => client_secret
       )
     end
 
+    context "without client_secret" do
+      let(:client_secret) { nil }
+      it do
+        expect(subject.content).to eq(
+          "AuthenticationToken" => 'yes/we/can',
+          "DeveloperToken" =>      '123abc',
+          "CustomerId" =>          nil,
+          "CustomerAccountId" =>   nil
+        )
+      end
+    end
+
     it 'sets customer' do
       subject.set_customer(customer_id: 777, account_id: 666 )
 
@@ -30,7 +52,8 @@ RSpec.describe BingAdsRubySdk::Header do
         "AuthenticationToken" => 'yes/we/can',
         "DeveloperToken" =>      '123abc',
         "CustomerId" =>          777,
-        "CustomerAccountId" =>   666
+        "CustomerAccountId" =>   666,
+        "ClientSecret" => client_secret
       )
     end
   end

data/tasks/bing_ads_ruby_sdk.rake

@@ -2,16 +2,18 @@ require 'dotenv/load'
 
 namespace :bing_token do
   desc "Gets and stores Bing OAuth token in file"
-  task :get, [:filename, :bing_developer_token, :bing_client_id] do |task, args|
+  task :get, [:filename, :bing_developer_token, :bing_client_id, :bing_client_secret] do |task, args|
 
     filename = args[:filename] || ENV.fetch('BING_STORE_FILENAME')
     developer_token = args[:bing_developer_token] || ENV.fetch('BING_DEVELOPER_TOKEN')
     bing_client_id = args[:bing_client_id] || ENV.fetch('BING_CLIENT_ID')
+    bing_client_secret = args[:bing_client_secret] || ENV.fetch('BING_CLIENT_SECRET', nil)
 
     store = ::BingAdsRubySdk::OAuth2::FsStore.new(filename)
     auth = BingAdsRubySdk::OAuth2::AuthorizationHandler.new(
       developer_token: developer_token,
       client_id: bing_client_id,
+      client_secret: bing_client_secret,
       store: store
     )
     puts "Go to #{auth.code_url}",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bing_ads_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Effilab
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2020-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: signet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement