soapy_bing 0.0.1

data/spec/soapy_bing/oauth_credentials_spec.rb

@@ -0,0 +1,108 @@
+RSpec.describe SoapyBing::OauthCredentials do
+  describe '#initialize' do
+    subject { described_class.new(credentials) }
+
+    context 'when oauth credentials passed explicitly' do
+      let(:credentials) { { client_id: 'foo', client_secret: 'bar', refresh_token: 'baz' } }
+      before do
+        allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_CLIENT_ID').and_return('foo_env')
+        allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_CLIENT_SECRET').and_return('bar_env')
+        allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_REFRESH_TOKEN').and_return('baz_env')
+        allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_TOKEN_URL')
+      end
+
+      it '#client_id is set' do
+        expect(subject.client_id).to eq 'foo'
+      end
+
+      it '#client_secret is set' do
+        expect(subject.client_secret).to eq 'bar'
+      end
+
+      it '#refresh_token is set' do
+        expect(subject.refresh_token).to eq 'baz'
+      end
+    end
+
+    context 'when oauth credentials passed via Enviromenment variables' do
+      let(:credentials) { {} }
+      before do
+        allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_CLIENT_ID').and_return('foo_env')
+        allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_CLIENT_SECRET').and_return('bar_env')
+        allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_REFRESH_TOKEN').and_return('baz_env')
+        allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_TOKEN_URL')
+      end
+
+      it '#client_id is set' do
+        expect(subject.client_id).to eq 'foo_env'
+      end
+
+      it '#client_secret is set' do
+        expect(subject.client_secret).to eq 'bar_env'
+      end
+
+      it '#refresh_token is set' do
+        expect(subject.refresh_token).to eq 'baz_env'
+      end
+    end
+
+    context 'when no oauth credentials passed' do
+      let(:credentials) { { client_id: 'foo', client_secret: 'bar', refresh_token: 'baz' } }
+      before do
+        %w( BING_ADS_OAUTH_CLIENT_ID
+            BING_ADS_OAUTH_CLIENT_SECRET
+            BING_ADS_OAUTH_REFRESH_TOKEN ).each do |var|
+          allow(ENV).to receive(:[]).with(var).and_return(nil)
+        end
+      end
+
+      it 'throws exception on missing :client_id' do
+        credentials.delete(:client_id)
+        expect { subject }.to raise_error SoapyBing::ParamGuard::ParamRequiredError,
+          'client_id have to be passed explicitly or via ENV[\'BING_ADS_OAUTH_CLIENT_ID\']'
+      end
+
+      it 'throws exception on missing :client_secret' do
+        credentials.delete(:client_secret)
+        expect { subject }.to raise_error SoapyBing::ParamGuard::ParamRequiredError,
+          'client_secret have to be passed explicitly or via ENV[\'BING_ADS_OAUTH_CLIENT_SECRET\']'
+      end
+
+      it 'throws exception on missing :refresh_token' do
+        credentials.delete(:refresh_token)
+        expect { subject }.to raise_error SoapyBing::ParamGuard::ParamRequiredError,
+          'refresh_token have to be passed explicitly or via ENV[\'BING_ADS_OAUTH_REFRESH_TOKEN\']'
+      end
+    end
+  end
+
+  describe '#access_token' do
+    let(:credentials) { { client_id: 'foo', client_secret: 'bar', refresh_token: 'baz' } }
+    let(:response) { double(:response) }
+
+    before do
+      expect(response).to receive(:code).once.and_return(status_code)
+      expect(HTTParty).to receive(:post).once.and_return(response)
+    end
+
+    context 'when there is good response' do
+      let(:status_code) { 200 }
+
+      before { expect(response).to receive(:[]).once.with('access_token').and_return('my-token') }
+
+      it 'memoizes http request response' do
+        2.times { expect(subject.access_token).to eq 'my-token' }
+      end
+    end
+
+    context 'when there is bad response' do
+      let(:status_code) { 401 }
+
+      it 'throws exception in case of bad status code' do
+        expect { subject.access_token }.to raise_error(
+          SoapyBing::OauthCredentials::TokenRefreshError
+        )
+      end
+    end
+  end
+end

data/spec/soapy_bing/param_guard_spec.rb

@@ -0,0 +1,43 @@
+RSpec.describe SoapyBing::ParamGuard do
+  describe '#require!' do
+    let(:param_guard) { described_class.new(options, env_namespace: 'MY') }
+    subject { param_guard.require!(:foo) }
+
+    context 'when option is empty' do
+      let(:options) { {} }
+
+      context 'and environment variable is empty too' do
+        it 'thows exception' do
+          expect { subject }.to raise_exception SoapyBing::ParamGuard::ParamRequiredError,
+            'foo have to be passed explicitly or via ENV[\'MY_FOO\']'
+        end
+      end
+
+      context 'but environment variable is present' do
+        before { allow(ENV).to receive(:[]).with('MY_FOO').and_return('bar_env') }
+
+        it 'returns environment variable value' do
+          expect(subject).to eq 'bar_env'
+        end
+      end
+    end
+
+    context 'when option is present' do
+      let(:options) { { foo: 'bar' } }
+
+      context 'and environment variable is present too' do
+        before { allow(ENV).to receive(:[]).with('MY_FOO').and_return('bar_env') }
+
+        it 'returns option value' do
+          expect(subject).to eq 'bar'
+        end
+      end
+
+      context 'but environment variable is empty' do
+        it 'returns option value' do
+          expect(subject).to eq 'bar'
+        end
+      end
+    end
+  end
+end

data/spec/soapy_bing/soap/request/base_spec.rb

@@ -0,0 +1,54 @@
+RSpec.describe SoapyBing::Soap::Request::Base do
+  let(:req_context) { { foo: 'Bar' } }
+  subject { described_class.new(context: req_context) }
+
+  before { stub_const('MyCustomRequest', Class.new(described_class) {}) }
+  let(:my_custom_request) { MyCustomRequest.new(context: req_context) }
+
+  describe '#context' do
+    it 'keeps initialized value' do
+      expect(subject.context).to eq req_context
+    end
+  end
+
+  describe '#post' do
+    let(:body) { 'my body' }
+    let(:headers) { { 'My' => 'Header' } }
+
+    it 'delegates post request to HTTParty' do
+      expect(HTTParty).to receive(:post).with(
+        'http://example.com',
+        hash_including(body: body, headers: hash_including(headers))
+      )
+      subject.post('http://example.com', body: body, headers: headers)
+    end
+  end
+
+  describe '#default_body' do
+    subject { my_custom_request.default_body }
+    it 'renders request body template' do
+      renderer = double('Renderer')
+      expect(SoapyBing::Soap::TemplateRenderer).to receive(:new)
+        .with(hash_including(req_context)).and_return(renderer)
+      expect(renderer).to receive(:render).with('my_custom')
+      subject
+    end
+  end
+
+  describe '#default_headers' do
+    subject { my_custom_request.default_headers }
+    it 'contains soap action' do
+      expect(subject).to include('SOAPAction' => 'MyCustom')
+    end
+    it 'contains default headers' do
+      expect(subject).to include(described_class::DEFAULT_HTTP_HEADERS)
+    end
+  end
+
+  describe '#action_name' do
+    subject { my_custom_request.action_name }
+    it 'resolves request\'s class soap action' do
+      expect(subject).to eq 'MyCustom'
+    end
+  end
+end

data/spec/soapy_bing/soap/request/poll_generate_report_request_spec.rb

@@ -0,0 +1,59 @@
+RSpec.describe SoapyBing::Soap::Request::PollGenerateReportRequest do
+  describe '#perform' do
+    let(:response_body) do
+      {
+        'Envelope' => {
+          'Body' => {
+            'PollGenerateReportResponse' => {
+              'ReportRequestStatus' => {
+                'Status' => nil,
+                'ReportDownloadUrl' => 'http://example.com'
+              }
+            }
+          }
+        }
+      }
+    end
+
+    let(:pending_response_body) do
+      response_body['Envelope']['Body']['PollGenerateReportResponse']['ReportRequestStatus']
+        .merge!('Status' => 'Pending')
+      response_body
+    end
+    let(:successful_response_body) do
+      response_body['Envelope']['Body']['PollGenerateReportResponse']['ReportRequestStatus']
+        .merge!('Status' => 'Success')
+      response_body
+    end
+
+    before do
+      call_count = 0
+      allow(HTTParty).to receive(:post) do
+        call_count += 1
+        call_count == 3 ? successful_response_body : pending_response_body
+      end
+    end
+
+    subject do
+      described_class
+        .new(
+          context: {
+            oauth: double(:oauth_credentials).as_null_object,
+            account: double(:account).as_null_object
+          }
+        )
+        .perform
+    end
+
+    it 'polls until successful response' do
+      expect(HTTParty).to receive(:post).exactly(3).times
+      expect(subject.payload).to eq 'http://example.com'
+    end
+
+    it 'throws PollingTimeoutError when exceeded polling tries' do
+      stub_const('SoapyBing::Soap::Request::PollGenerateReportRequest::POLLING_TRIES', 1)
+      expect(HTTParty).to receive(:post).once
+      expect { subject }.to raise_error described_class::PollingTimeoutError
+    end
+  end
+end

data/spec/soapy_bing/soap/response/base_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe SoapyBing::Soap::Response::Base do
+  before { stub_const('MyCustomResponse', Class.new(described_class) {}) }
+  let(:response_body) { 'Some response body' }
+  let(:my_custom_response) { MyCustomResponse.new(response_body) }
+
+  describe '#body' do
+    subject { my_custom_response.body }
+    it 'keeps initialized value' do
+      expect(subject).to eq response_body
+    end
+  end
+end

data/spec/soapy_bing/soap/response/payload_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe SoapyBing::Soap::Response::Payload do
+  before do
+    stub_const(
+      'MyCustomResponse',
+      Class
+        .new
+        .include(described_class)
+    )
+  end
+
+  subject { MyCustomResponse.new }
+
+  describe '#payload' do
+    it 'memoize #extract_payload value' do
+      expect_any_instance_of(MyCustomResponse).to receive(:extract_payload).once.and_return(true)
+      2.times { subject.payload }
+    end
+  end
+
+  describe '#extract_payload' do
+    it 'throws NotImplementedError' do
+      expect { subject.extract_payload }.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/soapy_bing/soap/response/poll_generate_report_response_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe SoapyBing::Soap::Response::PollGenerateReportResponse do
+  let(:url) { 'http://my-site.com' }
+  let(:response_hash) do
+    {
+      'Envelope' => {
+        'Body' => {
+          'PollGenerateReportResponse' => {
+            'ReportRequestStatus' => {
+              'ReportDownloadUrl' => url
+            }
+          }
+        }
+      }
+    }
+  end
+  let(:subject) { described_class.new(response_hash) }
+
+  it 'includes ReportStatus' do
+    expect(described_class.ancestors).to include SoapyBing::Soap::Response::ReportStatus
+  end
+
+  it '#extract_payload returns download url' do
+    expect(subject.extract_payload).to eq url
+  end
+end

data/spec/soapy_bing/soap/response/report_status_spec.rb

@@ -0,0 +1,91 @@
+RSpec.describe SoapyBing::Soap::Response::ReportStatus do
+  before do
+    stub_const(
+      'MyCustomResponse',
+      Class
+        .new(SoapyBing::Soap::Response::Base)
+        .include(described_class)
+    )
+  end
+  let(:response_hash) do
+    {
+      'Envelope' => {
+        'Body' => {
+          'MyCustomResponse' => {
+            'ReportRequestStatus' => {
+              'Status' => nil
+            }
+          }
+        }
+      }
+    }
+  end
+  let(:subject) { MyCustomResponse.new(response_hash) }
+
+  describe 'status' do
+    before do
+      response_hash['Envelope']['Body']['MyCustomResponse']['ReportRequestStatus']
+        .merge!('Status' => status)
+    end
+
+    context 'when error' do
+      let(:status) { 'Error' }
+
+      it '#status is Error' do
+        expect(subject.status).to eq status
+      end
+
+      it '#error? is false' do
+        expect(subject).to be_error
+      end
+
+      it '#success? is false' do
+        expect(subject).not_to be_success
+      end
+
+      it '#pending? is false' do
+        expect(subject).not_to be_pending
+      end
+    end
+
+    context 'when success' do
+      let(:status) { 'Success' }
+
+      it '#status is Success' do
+        expect(subject.status).to eq status
+      end
+
+      it '#error? is false' do
+        expect(subject).not_to be_error
+      end
+
+      it '#success? is true' do
+        expect(subject).to be_success
+      end
+
+      it '#pending? is false' do
+        expect(subject).not_to be_pending
+      end
+    end
+
+    context 'when pending' do
+      let(:status) { 'Pending' }
+
+      it '#status is Pending' do
+        expect(subject.status).to eq status
+      end
+
+      it '#error? is false' do
+        expect(subject).not_to be_error
+      end
+
+      it '#success? is false' do
+        expect(subject).not_to be_success
+      end
+
+      it '#pending? is true' do
+        expect(subject).to be_pending
+      end
+    end
+  end
+end

data/spec/soapy_bing/soap/response/submit_generate_report_response_spec.rb

@@ -0,0 +1,19 @@
+RSpec.describe SoapyBing::Soap::Response::SubmitGenerateReportResponse do
+  let(:request_id) { 'foobarbazqux' }
+  let(:response_hash) do
+    {
+      'Envelope' => {
+        'Body' => {
+          'SubmitGenerateReportResponse' => {
+            'ReportRequestId' => request_id
+          }
+        }
+      }
+    }
+  end
+  let(:subject) { described_class.new(response_hash) }
+
+  it '#extract_payload returns request id' do
+    expect(subject.extract_payload).to eq request_id
+  end
+end

data/spec/soapy_bing/soap/template_renderer_spec.rb

@@ -0,0 +1,24 @@
+RSpec.describe SoapyBing::Soap::TemplateRenderer do
+  describe '::TEMPLATE_PATH' do
+    let(:files) { Dir.glob(File.join(described_class::TEMPLATE_PATH, '*.erb.xml')) }
+
+    it 'points to folder with *.erb.xml files' do
+      expect(files.size).to be > 1
+    end
+  end
+
+  describe '#render' do
+    let(:renderer) { described_class.new(greeting: 'Hello', target: 'World', provocation: '< &') }
+
+    before do
+      stub_const(
+        "#{described_class}::TEMPLATE_PATH",
+        File.join('spec', 'fixtures', 'soap_templates')
+      )
+    end
+
+    it 'returns text with interpolated variables' do
+      expect(renderer.render(:simple)).to eq "Hello, World!\n&lt; &amp;\n"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'simplecov_setup'
+
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+  config.expose_dsl_globally = false
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
+require 'soapy_bing'

data/spec/support/dotenv.rb

@@ -0,0 +1,3 @@
+require 'dotenv'
+
+Dotenv.load('.env.local', '.env')

data/spec/support/vcr.rb

@@ -0,0 +1,101 @@
+require 'cgi'
+require 'vcr'
+require 'active_support/core_ext/hash/conversions'
+
+VCR.configure do |c|
+  c.configure_rspec_metadata!
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.default_cassette_options = { match_requests_on: %i(method uri body) }
+
+  c.filter_sensitive_data('bing-ads-oauth-client-id') { ENV['BING_ADS_OAUTH_CLIENT_ID'] }
+  c.filter_sensitive_data('bing-ads-oauth-client-secret') { ENV['BING_ADS_OAUTH_CLIENT_SECRET'] }
+  c.filter_sensitive_data('bing-ads-oauth-refresh-token') do
+    CGI.escape(ENV['BING_ADS_OAUTH_REFRESH_TOKEN'])
+  end
+  c.filter_sensitive_data('bing-ads-oauth-refresh-token') do |interaction|
+    if interaction.response.headers['Content-Type'].first == 'application/json'
+      JSON.parse(interaction.response.body)['refresh_token']
+    end
+  end
+  c.filter_sensitive_data('bing-ads-oauth-authentication-token') do |interaction|
+    if interaction.response.headers['Content-Type'].first == 'application/json'
+      JSON.parse(interaction.response.body)['access_token']
+    end
+  end
+  c.filter_sensitive_data('bing-ads-oauth-user-id') do |interaction|
+    if interaction.response.headers['Content-Type'].first == 'application/json'
+      JSON.parse(interaction.response.body)['user_id']
+    end
+  end
+  c.filter_sensitive_data('bing-ads-developer-token') { ENV['BING_ADS_DEVELOPER_TOKEN'] }
+  c.filter_sensitive_data('bing-ads-account-id') { ENV['BING_ADS_ACCOUNT_ID'] }
+  c.filter_sensitive_data('bing-ads-customer-id') { ENV['BING_ADS_CUSTOMER_ID'] }
+
+  c.filter_sensitive_data('bing-ads-report-tracking-id') do |interaction|
+    if interaction.response.headers['Content-Type'].first == 'text/xml; charset=utf-8'
+      Hash.from_xml(interaction.response.body)['Envelope']['Header']['TrackingId']
+    end
+  end
+  c.filter_sensitive_data('bing-ads-report-request-id') do |interaction|
+    if interaction.response.headers['Content-Type'].first == 'text/xml; charset=utf-8'
+      body = Hash.from_xml(interaction.response.body)['Envelope']['Body']
+      if body['SubmitGenerateReportResponse']
+        body['SubmitGenerateReportResponse']['ReportRequestId']
+      end
+    end
+  end
+  c.filter_sensitive_data('bing-ads-report-request-id') do |interaction|
+    if interaction.response.headers['Content-Type'].first == 'text/xml; charset=utf-8'
+      body = Hash.from_xml(interaction.request.body)['Envelope']['Body']
+      if body['PollGenerateReportRequest']
+        body['PollGenerateReportRequest']['ReportRequestId']
+      end
+    end
+  end
+  c.filter_sensitive_data('bing-ads-oauth-authentication-token') do |interaction|
+    if interaction.response.headers['Content-Type'].first == 'text/xml; charset=utf-8'
+      Hash.from_xml(interaction.request.body)['Envelope']['Header']['AuthenticationToken']
+    end
+  end
+  c.filter_sensitive_data('bing-ads-report-download-id') do |interaction|
+    if interaction.request.uri =~ %r{https://(.*)\?q=(.*)}
+      Regexp.last_match(2)
+    end
+  end
+  c.filter_sensitive_data('bing-ads-report-download-id') do |interaction|
+    if interaction.response.headers['Content-Type'].first == 'text/xml; charset=utf-8'
+      response = Hash.from_xml(interaction.response.body)
+      report = response['Envelope']['Body']['PollGenerateReportResponse']
+      if report && report ['ReportRequestStatus']
+        if report['ReportRequestStatus']['ReportDownloadUrl'] =~ %r{https://(.*)\?q=(.*)}
+          Regexp.last_match(2)
+        end
+      end
+    end
+  end
+
+  c.before_record do |interaction|
+    # auto-generate report payload fixtures
+    # spec/fixtures/reports/campaign_performance_report.json
+    # spec/fixtures/reports/campaing_performance_report.csv
+    if interaction.response.headers['Content-Type'].first == 'application/x-zip-compressed'
+      # refactor zip into module
+      csv_data = Zip::InputStream.open(StringIO.new(interaction.response.body)) do |archive_io|
+        file_io = archive_io.get_next_entry.get_input_stream
+        file_io.read
+      end
+
+      fixtures_dir = File.join('spec', 'fixtures', 'reports')
+      File.open(File.join(fixtures_dir, 'campaign_performance_report.json'), 'wb') do |file|
+        parser = SoapyBing::Ads::Reports::Parsers::CSVParser.new(csv_data)
+        file.write(JSON.pretty_generate(parser.rows))
+      end
+      File.open(File.join(fixtures_dir, 'campaign_performance_report.csv'), 'wb') do |file|
+        file.write(csv_data)
+      end
+    end
+  end
+
+  c.ignore_hosts 'codeclimate.com' # allow codeclimate-test-reporter to phone home
+end