twitter-ads 5.2.0 → 8.0.0

data/spec/twitter-ads/client_spec.rb

@@ -55,10 +55,26 @@ describe TwitterAds::Client do
 
     it 'allows additional options' do
       expect {
-        Client.new(consumer_key, consumer_secret, access_token, {})
+        Client.new(consumer_key, consumer_secret, access_token, access_token_secret, options: {})
       }.not_to raise_error
     end
 
+    it 'test client options' do
+      client = Client.new(
+        consumer_key,
+        consumer_secret,
+        access_token,
+        access_token_secret,
+        options: {
+          handle_rate_limit: true,
+          retry_max: 1,
+          retry_delay: 3000,
+          retry_on_status: [404, 500, 503]
+        }
+      )
+      expect(client.options.length).to eq 4
+    end
+
   end
 
   describe '#inspect' do

data/spec/twitter-ads/creative/media_creative_spec.rb

@@ -25,7 +25,7 @@ describe TwitterAds::Creative::MediaCreative do
 
   # check model properties
   subject { described_class.new(account) }
-  read  = %w(id created_at updated_at deleted approval_status serving_status)
+  read  = %w(id created_at updated_at deleted approval_status entity_status)
   write = %w(account_media_id line_item_id landing_url)
   include_examples 'object property check', read, write
 

data/spec/twitter-ads/creative/promoted_tweet_spec.rb

@@ -41,6 +41,24 @@ describe TwitterAds::Creative::PromotedTweet do
       expect { subject.save }.to raise_error(TwitterAds::ClientError)
     end
 
+    it 'sets params[:tweet_ids] from params[:tweet_id]' do
+      request = double('request')
+      response = double('response')
+      allow(response).to receive(:body).and_return({ data: [{}] })
+      allow(request).to receive(:perform).and_return(response)
+      expected_params = { params: { line_item_id: '12345', tweet_ids: 99999999999999999999 } }
+
+      expect(Request).to receive(:new).with(
+        client,
+        :post,
+        "/#{TwitterAds::API_VERSION}/accounts/#{account.id}/promoted_tweets",
+        expected_params
+      ).and_return(request)
+
+      subject.line_item_id = '12345'
+      subject.tweet_id = 99999999999999999999
+      subject.save
+    end
   end
 
 end

data/spec/twitter-ads/creative/tweet_previews_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+require 'spec_helper'
+
+include TwitterAds::Enum
+
+describe TwitterAds::Creative::TweetPreview do
+
+  let!(:resource) { "#{ADS_API}/accounts/2iqph/tweet_previews" }
+
+  before(:each) do
+    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
+    stub_fixture(:get, :tweet_previews, /#{resource}\?.*/)
+  end
+
+  let(:client) do
+    Client.new(
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40)
+    )
+  end
+
+  let(:account) { client.accounts('2iqph') }
+  let(:instance) { described_class.new(account) }
+
+  it 'inspect TweetPreview.load() response' do
+    preview = instance.load(
+      account,
+      tweet_ids: %w(1130942781109596160 1101254234031370240),
+      tweet_type: TweetType::PUBLISHED)
+
+    expect(preview).to be_instance_of(Cursor)
+    expect(preview.count).to eq 2
+    tweet = preview.first
+    expect(tweet.tweet_id).to eq '1130942781109596160'
+  end
+
+end

data/spec/twitter-ads/rate_limit_spec.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Campaign do
+
+  before(:each) do
+    allow_any_instance_of(Object).to receive(:sleep)
+    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
+  end
+
+  let(:client) do
+    Client.new(
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40)
+    )
+  end
+  let(:account) { client_simple.accounts('2iqph') }
+
+  let(:client_simple) do
+    Client.new(
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      options: {
+        handle_rate_limit: true
+      }
+    )
+  end
+  let(:account1) { client_simple.accounts('2iqph') }
+
+  let(:client_combine) do
+    Client.new(
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      options: {
+        handle_rate_limit: true,
+        retry_max: 1,
+        retry_delay: 3000,
+        retry_on_status: [500]
+      }
+    )
+  end
+  let(:account2) { client_combine.accounts('2iqph') }
+
+  it 'test rate-limit handle - success' do
+    stub = stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 429,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': Time.now.to_i + 5
+        }
+      },
+      {
+        body: fixture(:campaigns_all),
+        status: 200
+      }
+    )
+    cusor = described_class.all(account1)
+    expect(cusor).to be_instance_of(Cursor)
+    expect(stub).to have_been_requested.times(2)
+  end
+
+  it 'test rate-limit handle - fail' do
+    stub = stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 429,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': Time.now.to_i + 5
+        }
+      },
+      {
+        body: fixture(:campaigns_all),
+        status: 429,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': 4102444800
+        }
+      }
+    )
+    begin
+      cusor = described_class.all(account1)
+    rescue RateLimit => e
+      cusor = e
+    end
+    expect(cusor).to be_instance_of(RateLimit)
+    expect(stub).to have_been_requested.times(2)
+    expect(cusor.reset_at).to eq 4102444800
+  end
+
+  it 'test rate-limit handle with retry - case 1' do
+    # scenario:
+    #  - 500 (retry) -> 429 (handle rate limit) -> 200 (end)
+    stub = stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 500,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': 4102444800
+        }
+      },
+      {
+        body: fixture(:campaigns_all),
+        status: 429,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': Time.now.to_i + 5
+        }
+      },
+      {
+        body: fixture(:campaigns_all),
+        status: 200
+      }
+    )
+    cusor = described_class.all(account2)
+    expect(cusor).to be_instance_of(Cursor)
+    expect(stub).to have_been_requested.times(3)
+  end
+
+  it 'test rate-limit handle with retry - case 2' do
+    # scenario:
+    #  - 429 (handle rate limit) -> 500 (retry) -> 200 (end)
+    stub = stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 429,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': Time.now.to_i + 5
+        }
+      },
+      {
+        body: fixture(:campaigns_all),
+        status: 500,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': 4102444800
+        }
+      },
+      {
+        body: fixture(:campaigns_all),
+        status: 200
+      }
+    )
+    cusor = described_class.all(account2)
+    expect(cusor).to be_instance_of(Cursor)
+    expect(stub).to have_been_requested.times(3)
+  end
+
+  it 'test rate-limit header access from cusor class' do
+    stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 200,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': 4102444800
+        }
+      }
+    )
+    cusor = described_class.all(account)
+    expect(cusor).to be_instance_of(Cursor)
+    expect(cusor.account_rate_limit_limit).to eq 10000
+    expect(cusor.account_rate_limit_remaining).to eq 9999
+    expect(cusor.account_rate_limit_reset).to eq 4102444800
+  end
+
+  it 'test rate-limit header access from resource class' do
+    stub_request(:any, /accounts\/2iqph\/campaigns\/2wap7/).to_return(
+      {
+        body: fixture(:campaigns_load),
+        status: 200,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': 4102444800
+        }
+      }
+    )
+
+    campaign = described_class.load(account, '2wap7')
+    resource = "/#{TwitterAds::API_VERSION}/accounts/2iqph/campaigns/2wap7"
+    params   = {}
+    response = TwitterAds::Request.new(client, :get, resource, params: params).perform
+    data     = campaign.from_response(response.body[:data], response.headers)
+    expect(data).to be_instance_of(Campaign)
+    expect(data.account_rate_limit_limit).to eq 10000
+    expect(data.account_rate_limit_remaining).to eq 9999
+    expect(data.account_rate_limit_reset).to eq 4102444800
+  end
+
+  it 'test rate-limit header access check instance variables not conflicting' do
+    stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 200,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9999,
+          'x-account-rate-limit-reset': 4102444800
+        }
+      },
+      {
+        body: fixture(:campaigns_all),
+        status: 200,
+        headers: {
+          'x-account-rate-limit-limit': 10000,
+          'x-account-rate-limit-remaining': 9998,
+          'x-account-rate-limit-reset': 4102444800
+        }
+      }
+    )
+
+    campaign_first = described_class.all(account)
+    campaign_second = described_class.all(account)
+
+    expect(campaign_first).to be_instance_of(Cursor)
+    expect(campaign_first.account_rate_limit_limit).to eq 10000
+    expect(campaign_first.account_rate_limit_remaining).to eq 9999
+    expect(campaign_first.account_rate_limit_reset).to eq 4102444800
+
+    expect(campaign_second).to be_instance_of(Cursor)
+    expect(campaign_second.account_rate_limit_limit).to eq 10000
+    expect(campaign_second.account_rate_limit_remaining).to eq 9998
+    expect(campaign_second.account_rate_limit_reset).to eq 4102444800
+  end
+
+end

data/spec/twitter-ads/retry_count_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Campaign do
+
+  before(:each) do
+    allow_any_instance_of(Object).to receive(:sleep)
+    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
+  end
+
+  let(:client) do
+    Client.new(
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      options: {
+        retry_max: 1,
+        retry_delay: 3000,
+        retry_on_status: [404, 500, 503]
+      }
+    )
+  end
+  let(:account) { client.accounts('2iqph') }
+
+  it 'test retry count - success' do
+    stub = stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 404
+      },
+      {
+        body: fixture(:campaigns_all),
+        status: 200
+      }
+    )
+    cusor = described_class.all(account)
+    expect(cusor).to be_instance_of(Cursor)
+    expect(stub).to have_been_requested.times(2)
+  end
+
+  it 'test retry count - fail' do
+    stub = stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 404
+      }
+    ).times(2)
+
+    begin
+      cusor = described_class.all(account)
+    rescue NotFound => e
+      cusor = e
+    end
+    expect(cusor).to be_instance_of(NotFound)
+    expect(stub).to have_been_requested.times(2)
+  end
+
+end

data/spec/twitter-ads/{creative/image_app_download_card_spec.rb → targeting/audience_summary_spec.rb}

@@ -3,11 +3,12 @@
 
 require 'spec_helper'
 
-describe TwitterAds::Creative::ImageAppDownloadCard do
+describe TwitterAds::AudienceSummary do
 
   before(:each) do
     stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
     stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
+    stub_fixture(:post, :audience_summary, "#{ADS_API}/accounts/2iqph/audience_summary")
   end
 
   let(:client) do
@@ -20,24 +21,21 @@ describe TwitterAds::Creative::ImageAppDownloadCard do
   end
 
   let(:account) { client.accounts.first }
+  let(:params) {
+    {
+      targeting_criteria: [{
+        targeting_type: 'LOCATION',
+        targeting_value: '96683cc9126741d1'
+      }]
+    }
+  }
 
   # check model properties
-  subject { described_class.new(account) }
-  read  = %w(id created_at updated_at deleted)
-
-  write = %w(
-    name
-    country_code
-    iphone_app_id
-    iphone_deep_link
-    ipad_app_id
-    ipad_deep_link
-    googleplay_app_id
-    googleplay_deep_link
-    app_cta
-    wide_app_image_media_id
-  )
-
-  include_examples 'object property check', read, write
+  subject { described_class.fetch(account, params) }
+
+  it 'has all the correct properties' do
+    expect(subject[:audience_size][:min]).to eq(41133600)
+    expect(subject[:audience_size][:max]).to eq(50274400)
+  end
 
 end