twitter-ads 1.1.0 → 2.0.0

data/spec/fixtures/line_items_all.json

@@ -22,7 +22,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "bw2",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],
@@ -50,7 +50,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "c4m",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],
@@ -78,7 +78,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "c5c",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],
@@ -106,7 +106,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "fhu",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],
@@ -134,7 +134,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "fxd",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],
@@ -162,7 +162,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "fxt",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],
@@ -190,7 +190,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "fya",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],
@@ -218,7 +218,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "ghj",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],
@@ -246,7 +246,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "gra",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],
@@ -274,7 +274,7 @@
       "total_budget_amount_local_micro": null,
       "objective": "CUSTOM",
       "id": "gsw",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "account_id": "2iqph",
       "optimization": "DEFAULT",
       "categories": [],

data/spec/fixtures/line_items_load.json

@@ -17,7 +17,7 @@
     "total_budget_amount_local_micro": null,
     "objective": "CUSTOM",
     "id": "bw2",
-    "paused": false,
+    "entity_status": "ACTIVE",
     "account_id": "2iqph",
     "optimization": "DEFAULT",
     "categories": [],

data/spec/fixtures/promoted_tweets_all.json

@@ -8,7 +8,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thl4",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -18,7 +18,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thl3",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -28,7 +28,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thl5",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -38,7 +38,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thl6",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -48,7 +48,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thl7",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -58,7 +58,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thl8",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -68,7 +68,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thlb",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -78,7 +78,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thle",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -88,7 +88,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thlf",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -98,7 +98,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thlg",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -108,7 +108,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thlh",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -118,7 +118,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thln",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -128,7 +128,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thlo",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -138,7 +138,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thlp",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -148,7 +148,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6thlq",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-11T20:50:25Z",
       "updated_at": "2015-04-11T20:50:25Z",
       "approval_status": "ACCEPTED",
@@ -158,7 +158,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6tt7l",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-12T23:47:44Z",
       "updated_at": "2015-04-12T23:47:44Z",
       "approval_status": "ACCEPTED",
@@ -168,7 +168,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6tt7m",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-12T23:47:44Z",
       "updated_at": "2015-04-12T23:47:44Z",
       "approval_status": "ACCEPTED",
@@ -178,7 +178,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6ugv1",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-13T22:19:08Z",
       "updated_at": "2015-04-13T22:19:08Z",
       "approval_status": "ACCEPTED",
@@ -188,7 +188,7 @@
     {
       "line_item_id": "2b7xw",
       "id": "6w7b5",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-16T17:01:56Z",
       "updated_at": "2015-04-16T17:01:56Z",
       "approval_status": "ACCEPTED",
@@ -198,7 +198,7 @@
     {
       "line_item_id": "2dw80",
       "id": "70dbj",
-      "paused": false,
+      "entity_status": "ACTIVE",
       "created_at": "2015-04-23T20:27:27Z",
       "updated_at": "2015-04-23T20:27:27Z",
       "approval_status": "ACCEPTED",

data/spec/fixtures/promoted_tweets_load.json

@@ -3,7 +3,7 @@
   "data": {
     "line_item_id": "2b7xw",
     "id": "6thl4",
-    "paused": false,
+    "entity_status": "ACTIVE",
     "created_at": "2015-04-11T20:50:25Z",
     "updated_at": "2015-04-11T20:50:25Z",
     "approval_status": "ACCEPTED",

data/spec/spec_helper.rb

@@ -28,7 +28,7 @@ include TwitterAds
 # Require All Support Files
 Dir['./spec/support/*.rb'].sort.each { |file| require file }
 
-ADS_API    = 'https://ads-api.twitter.com/1'.freeze
+ADS_API    = "https://ads-api.twitter.com/#{TwitterAds::API_VERSION}".freeze
 TON_API    = 'https://ton.twitter.com'.freeze
 UPLOAD_API = 'https://upload.twitter.com/1.1'.freeze
 

data/spec/support/helpers.rb

@@ -35,8 +35,8 @@ module Helpers
   # @param name [String] The fixture name.
   # @param url [String] The URL match pattern or regular expression.
   # @param status [Integer] The response code to return with the fixture.
-  def stub_fixture(method, name, url, status = 200)
-    stub_request(method, url).to_return(body: fixture(name), status: status)
+  def stub_fixture(method, name, url, status: 200, headers: {})
+    stub_request(method, url).to_return(body: fixture(name), status: status, headers: headers)
   end
 
 end

data/spec/twitter-ads/campaign/app_list_spec.rb

@@ -31,7 +31,7 @@ describe TwitterAds::AppList do
 
     let(:app_list) { TwitterAds::AppList.new(account) }
     let!(:resource) { "#{ADS_API}/accounts/#{account.id}/app_lists" }
-    let!(:rel_path) { "/1/accounts/#{account.id}/app_lists" }
+    let!(:rel_path) { "/#{TwitterAds::API_VERSION}/accounts/#{account.id}/app_lists" }
 
     before(:each) do
       stub_fixture(:post, :app_lists_load, /#{resource}\?.*/)

data/spec/twitter-ads/campaign/line_item_spec.rb

@@ -34,7 +34,7 @@ describe TwitterAds::LineItem do
     charge_by
     include_sentiment
     objective
-    paused
+    entity_status
     primary_web_event_tag
     product_type
     placements

data/spec/twitter-ads/campaign/reach_estimate_spec.rb

@@ -24,7 +24,7 @@ describe TwitterAds::ReachEstimate do
   describe '#fetch' do
 
     let!(:resource) { "#{ADS_API}/accounts/#{account.id}/reach_estimate" }
-    let!(:rel_path) { "/1/accounts/#{account.id}/reach_estimate" }
+    let!(:rel_path) { "/#{TwitterAds::API_VERSION}/accounts/#{account.id}/reach_estimate" }
 
     before(:each) do
       stub_fixture(:get, :reach_estimate, /#{resource}\?.*/)

data/spec/twitter-ads/campaign/tweet_spec.rb

@@ -43,7 +43,7 @@ describe TwitterAds::Tweet do
     context 'when previewing a new tweet' do
 
       it 'url encodes the status content' do
-        params = { status: 'Hello World!', card_id: '19v69' }
+        params = { text: 'Hello World!', card_id: '19v69' }
         expect(URI).to receive(:escape).at_least(:once).and_call_original
         result = subject.preview(account, params)
         expect(result.size).not_to be_nil
@@ -51,26 +51,26 @@ describe TwitterAds::Tweet do
       end
 
       it 'allows a single value for the media_ids param' do
-        resource = "/1/accounts/#{account.id}/tweet/preview"
-        expected = { status: 'Hello%20World!', media_ids: 634458428836962304 }
+        resource = "/#{TwitterAds::API_VERSION}/accounts/#{account.id}/tweet/preview"
+        expected = { text: 'Hello%20World!', media_ids: 634458428836962304 }
 
         expect(TwitterAds::Request).to receive(:new).with(
           account.client, :get, resource, params: expected).and_call_original
 
-        params = { status: 'Hello World!', media_ids: 634458428836962304 }
+        params = { text: 'Hello World!', media_ids: 634458428836962304 }
         result = subject.preview(account, params)
         expect(result.size).not_to be_nil
         expect(result).to all(include(:platform, :preview))
       end
 
       it 'allows an array of values for the media_ids param' do
-        resource = "/1/accounts/#{account.id}/tweet/preview"
-        expected = { status: 'Hello%20World!', media_ids: '634458428836962304,634458428836962305' }
+        resource = "/#{TwitterAds::API_VERSION}/accounts/#{account.id}/tweet/preview"
+        expected = { text: 'Hello%20World!', media_ids: '634458428836962304,634458428836962305' }
 
         expect(TwitterAds::Request).to receive(:new).with(
           account.client, :get, resource, params: expected).and_call_original
 
-        params = { status: 'Hello World!', media_ids: [634458428836962304, 634458428836962305] }
+        params = { text: 'Hello World!', media_ids: [634458428836962304, 634458428836962305] }
         result = subject.preview(account, params)
         expect(result.size).not_to be_nil
         expect(result).to all(include(:platform, :preview))

data/spec/twitter-ads/client_spec.rb

@@ -99,7 +99,8 @@ describe TwitterAds::Client do
       let!(:account_id) { '2iqph' }
 
       before(:all) do
-        stub_fixture(:get, :accounts_load, /(.*\/1\/accounts\/)([a-zA-Z0-9]*)\z/)
+        stub_fixture(:get, :accounts_load,
+                     /(.*\/#{TwitterAds::API_VERSION}\/accounts\/)([a-zA-Z0-9]*)\z/)
       end
 
       it 'returns a specific Account object' do

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

@@ -23,8 +23,8 @@ describe TwitterAds::Creative::PromotedTweet do
 
   # check model properties
   subject { described_class.new(account) }
-  read  = %w(id approval_status created_at updated_at deleted)
-  write = %w(line_item_id tweet_id paused)
+  read  = %w(id approval_status created_at updated_at deleted entity_status)
+  write = %w(line_item_id tweet_id)
   include_examples 'object property check', read, write
 
   describe '#save' do

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

@@ -23,15 +23,21 @@ describe TwitterAds::Creative::WebsiteCard do
 
   # check model properties
   subject { described_class.new(account) }
-  read  = %w(id preview_url created_at updated_at deleted)
-  write = %w(name website_title website_url website_cta image_media_id)
+  read = %w(
+    card_type
+    card_uri
+    created_at
+    deleted
+    id
+    image
+    image_display_height
+    image_display_width
+    preview_url
+    website_dest_url
+    website_display_url
+    updated_at
+  )
+  write = %w(image_media_id name website_title website_url)
   include_examples 'object property check', read, write
 
-  it 'raises a warning message each time website_cta is set' do
-    expect(TwitterAds::Utils).to receive(:deprecated).with(
-      'TwitterAds::Creative::WebsiteCard#website_cta',
-      refer: 'https://t.co/deprecated-website-card-cta')
-    subject.website_cta = 'any value'
-  end
-
 end

data/spec/twitter-ads/http/ton_upload_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+require 'tempfile'
+
+describe TwitterAds::TONUpload do
+  before(:each) do
+    stub_fixture(
+      :post, :no_content, "#{TON_API}/1.1/ton/bucket/#{bucket_name}",
+      headers: {
+        'location' => location_path
+      }
+    )
+    stub_fixture(
+      :post, :no_content, "#{TON_API}/1.1/ton/bucket/#{bucket_name}?resumable=true",
+      headers: {
+        'location' => "#{location_path}?resumable=true&resumeId=1234567",
+        'x-ton-min-chunk-size' => '1048576'
+      }
+    )
+  end
+  let(:bucket_name) { 'ta_partner' }
+  let(:location_path) { '/1.1/ton/data/ta_partner/123456789/tYfALUIK-F3ZMxj.txt' }
+
+  around(:each) do |example|
+    example.run
+    file.unlink
+  end
+  let!(:file) do
+    Tempfile.open(['', '.dat'], File.expand_path('../../../tmp/', __FILE__)) do |fp|
+      fp.tap { |f| f.write(SecureRandom.random_bytes(file_size)) }
+    end
+  end
+  let(:file_size) { 100 }
+
+  let(:ton_upload) { described_class.new(client, file_path) }
+  let(:client) do
+    Client.new(
+      Faker::Lorem.characters(15),
+      Faker::Lorem.characters(40),
+      "123456-#{Faker::Lorem.characters(40)}",
+      Faker::Lorem.characters(40)
+    )
+  end
+  let(:file_path) { file.path }
+
+  describe '#initialize' do
+
+    subject { ton_upload }
+    it { is_expected.to be_an_instance_of described_class }
+
+    context 'when the file path is invalid' do
+      let(:file_path) { '/invalid/file/path' }
+
+      it do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe '#perform' do
+    subject { ton_upload.perform }
+
+    it 'should call TwitterAds::Request#perform exactly once' do
+      expect_any_instance_of(TwitterAds::Request).to receive(:perform).once.and_call_original
+      subject
+    end
+
+    it { is_expected.to eq '/1.1/ton/data/ta_partner/123456789/tYfALUIK-F3ZMxj.txt' }
+
+    context 'when the file size is larger than 64MB' do
+      before(:each) do
+        allow(ton_upload).to receive(:upload_chunk)
+      end
+      let(:file_size) { 65 * 1024 * 1024 }
+
+      it { is_expected.to eq '/1.1/ton/data/ta_partner/123456789/tYfALUIK-F3ZMxj.txt' }
+      it 'should call TwitterAds::Request#perform exactly once' do
+        expect(ton_upload).to receive(:upload_chunk).at_least(:twice)
+        subject
+      end
+    end
+  end
+
+  describe '#inspect' do
+    subject { ton_upload.inspect }
+
+    it do
+      is_expected.to include(described_class.name)
+      is_expected.to include(ton_upload.object_id.to_s)
+      is_expected.to include(bucket_name)
+      is_expected.to include(file_path)
+    end
+  end
+end