twitter-ads 5.2.0 → 6.0.0

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter-ads
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 6.0.0
 platform: ruby
 authors:
 - John Babich
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -57,7 +57,6 @@ files:
 - bin/twitter-ads
 - lib/twitter-ads.rb
 - lib/twitter-ads/account.rb
-- lib/twitter-ads/audiences/audience_intelligence.rb
 - lib/twitter-ads/audiences/tailored_audience.rb
 - lib/twitter-ads/campaign/app_list.rb
 - lib/twitter-ads/campaign/campaign.rb
@@ -71,6 +70,7 @@ files:
 - lib/twitter-ads/client.rb
 - lib/twitter-ads/creative/account_media.rb
 - lib/twitter-ads/creative/cards_fetch.rb
+- lib/twitter-ads/creative/draft_tweet.rb
 - lib/twitter-ads/creative/image_app_download_card.rb
 - lib/twitter-ads/creative/image_conversation_card.rb
 - lib/twitter-ads/creative/media_creative.rb
@@ -80,6 +80,7 @@ files:
 - lib/twitter-ads/creative/promoted_tweet.rb
 - lib/twitter-ads/creative/scheduled_tweet.rb
 - lib/twitter-ads/creative/tweet_previews.rb
+- lib/twitter-ads/creative/tweets.rb
 - lib/twitter-ads/creative/video_app_download_card.rb
 - lib/twitter-ads/creative/video_conversation_card.rb
 - lib/twitter-ads/creative/video_website_card.rb
@@ -97,12 +98,14 @@ files:
 - lib/twitter-ads/resources/dsl.rb
 - lib/twitter-ads/resources/persistence.rb
 - lib/twitter-ads/resources/resource.rb
+- lib/twitter-ads/restapi.rb
 - lib/twitter-ads/settings/tax.rb
 - lib/twitter-ads/settings/user.rb
 - lib/twitter-ads/targeting/reach_estimate.rb
 - lib/twitter-ads/targeting_criteria/app_store_category.rb
 - lib/twitter-ads/targeting_criteria/behavior.rb
 - lib/twitter-ads/targeting_criteria/behavior_taxonomy.rb
+- lib/twitter-ads/targeting_criteria/conversation.rb
 - lib/twitter-ads/targeting_criteria/device.rb
 - lib/twitter-ads/targeting_criteria/event.rb
 - lib/twitter-ads/targeting_criteria/interest.rb
@@ -135,7 +138,7 @@ files:
 - spec/fixtures/reach_estimate.json
 - spec/fixtures/tailored_audiences_all.json
 - spec/fixtures/tailored_audiences_load.json
-- spec/fixtures/tweet_preview.json
+- spec/fixtures/tweet_previews.json
 - spec/fixtures/videos_all.json
 - spec/fixtures/videos_load.json
 - spec/quality_spec.rb
@@ -150,17 +153,14 @@ files:
 - spec/twitter-ads/campaign/targeting_criteria_spec.rb
 - spec/twitter-ads/campaign/tweet_spec.rb
 - spec/twitter-ads/client_spec.rb
-- spec/twitter-ads/creative/account_media_spec.rb
-- spec/twitter-ads/creative/image_app_download_card_spec.rb
-- spec/twitter-ads/creative/image_conversation_card_spec.rb
 - spec/twitter-ads/creative/media_creative_spec.rb
 - spec/twitter-ads/creative/promoted_account_spec.rb
 - spec/twitter-ads/creative/promoted_tweet_spec.rb
-- spec/twitter-ads/creative/video_app_download_card_spec.rb
-- spec/twitter-ads/creative/video_conversation_card_spec.rb
-- spec/twitter-ads/creative/website_card_spec.rb
+- spec/twitter-ads/creative/tweet_previews_spec.rb
 - spec/twitter-ads/cursor_spec.rb
 - spec/twitter-ads/placements_spec.rb
+- spec/twitter-ads/rate_limit_spec.rb
+- spec/twitter-ads/retry_count_spec.rb
 - spec/twitter-ads/utils_spec.rb
 - twitter-ads.gemspec
 homepage: https://github.com/twitterdev/twitter-ruby-ads-sdk
@@ -188,37 +188,34 @@ specification_version: 4
 summary: The officially supported Twitter Ads API SDK for Ruby.
 test_files:
 - spec/spec_helper.rb
+- spec/twitter-ads/retry_count_spec.rb
 - spec/twitter-ads/audiences/tailored_audience_spec.rb
 - spec/twitter-ads/cursor_spec.rb
 - spec/twitter-ads/account_spec.rb
 - spec/twitter-ads/client_spec.rb
+- spec/twitter-ads/rate_limit_spec.rb
 - spec/twitter-ads/placements_spec.rb
 - spec/twitter-ads/campaign/targeting_criteria_spec.rb
 - spec/twitter-ads/campaign/app_list_spec.rb
 - spec/twitter-ads/campaign/reach_estimate_spec.rb
 - spec/twitter-ads/campaign/line_item_spec.rb
 - spec/twitter-ads/campaign/tweet_spec.rb
-- spec/twitter-ads/creative/account_media_spec.rb
-- spec/twitter-ads/creative/website_card_spec.rb
-- spec/twitter-ads/creative/video_app_download_card_spec.rb
+- spec/twitter-ads/creative/tweet_previews_spec.rb
 - spec/twitter-ads/creative/media_creative_spec.rb
 - spec/twitter-ads/creative/promoted_tweet_spec.rb
-- spec/twitter-ads/creative/image_conversation_card_spec.rb
-- spec/twitter-ads/creative/video_conversation_card_spec.rb
 - spec/twitter-ads/creative/promoted_account_spec.rb
-- spec/twitter-ads/creative/image_app_download_card_spec.rb
 - spec/twitter-ads/utils_spec.rb
 - spec/shared/properties.rb
 - spec/support/helpers.rb
 - spec/fixtures/line_items_load.json
 - spec/fixtures/promotable_users_all.json
 - spec/fixtures/reach_estimate.json
-- spec/fixtures/tweet_preview.json
 - spec/fixtures/accounts_features.json
 - spec/fixtures/videos_all.json
 - spec/fixtures/line_items_all.json
 - spec/fixtures/placements.json
 - spec/fixtures/promotable_users_load.json
+- spec/fixtures/tweet_previews.json
 - spec/fixtures/tailored_audiences_all.json
 - spec/fixtures/promoted_tweets_all.json
 - spec/fixtures/funding_instruments_load.json

data/lib/twitter-ads/audiences/audience_intelligence.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2019 Twitter, Inc.
-
-module TwitterAds
-  class AudienceIntelligence
-
-    include TwitterAds::DSL
-    include TwitterAds::Resource::InstanceMethods
-
-    attr_reader :account
-
-    # writable
-    property :conversation_type
-    property :targeting_inputs
-    property :audience_definition
-
-    # demographics-only
-    property :start_time, type: :time
-    property :end_time, type: :time
-
-    # read
-    property :operator_type, read_only: true
-    property :targeting_type, read_only: true
-    property :targeting_value, read_only: true
-    property :localized, read_only: true
-
-    RESOURCE_CONVERSATIONS  = "/#{TwitterAds::API_VERSION}/" \
-                              'accounts/%{account_id}/audience_intelligence/' \
-                              'conversations' # @api private
-    RESOURCE_DEMOGRAPHICS   = "/#{TwitterAds::API_VERSION}/" \
-                              'accounts/%{account_id}/audience_intelligence/' \
-                              'demographics' # @api private
-
-    def initialize(account)
-      @account = account
-      self
-    end
-
-    def conversations
-      headers = { 'Content-Type' => 'application/json' }
-      params = {
-        conversation_type: conversation_type,
-        audience_definition: audience_definition,
-        targeting_inputs: targeting_inputs
-      }
-      resource = RESOURCE_CONVERSATIONS % { account_id: account.id }
-      request = Request.new(account.client, :post, resource, body: params.to_json, headers: headers)
-      Cursor.new(self.class, request, init_with: [account])
-    end
-
-    def demographics
-      headers = { 'Content-Type' => 'application/json' }
-      params = {
-        audience_definition: audience_definition,
-        targeting_inputs: targeting_inputs
-      }
-      resource = RESOURCE_DEMOGRAPHICS % { account_id: account.id }
-      response = Request.new(
-        account.client,
-        :post,
-        resource,
-        body: params.to_json,
-        headers: headers).perform
-      response.body[:data]
-      # cannot use cursor here given that the response "keys" are dynmaic based on input values
-    end
-  end
-end

data/spec/fixtures/tweet_preview.json

@@ -1,24 +0,0 @@
-{
-  "data_type": "tweet_preview",
-  "data": [
-    {
-      "platform": "web",
-      "preview": "   <div><img><div><div><div><a>AdsAPI</a><a>@AdsAPI</a></div></div><div>Hello World!</div><div><div><img><div><div></div><div><span> Ratings/pricing not available for preview </span><span> Ratings/pricing not available for preview </span></div><div></div>  INSTALL  </div></div></div><a><img></a><div><div><span></span><span>Promoted by AdsAPI</span></div></div></div></div>"
-    },
-    {
-      "platform": "android",
-      "preview": "   <div><img><div><div><div><a>AdsAPI</a><a>@AdsAPI</a></div></div><div>Hello World!</div><div><div><img><div><div></div><div><span> Ratings/pricing not available for preview </span><span> Ratings/pricing not available for preview </span></div><div></div>  INSTALL  </div></div></div><a><img></a><div><div><span></span><span>Promoted by AdsAPI</span></div></div></div></div>"
-    },
-    {
-      "platform": "iphone",
-      "preview": "   <div><img><div><div><div><a>AdsAPI</a><a>@AdsAPI</a></div></div><div>Hello World!</div><div><div><img><div><div></div><div><span> Ratings/pricing not available for preview </span><span> Ratings/pricing not available for preview </span></div><div></div>  INSTALL  </div></div></div><a><img></a><div><div><span></span><span>Promoted by AdsAPI</span></div></div></div></div>"
-    }
-  ],
-  "request": {
-    "params": {
-      "status": "Hello World!",
-      "card_id": "pfs",
-      "account_id": "2iqph"
-    }
-  }
-}

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2019 Twitter, Inc.
-
-require 'spec_helper'
-
-include TwitterAds::Enum
-
-describe TwitterAds::Creative::AccountMedia do
-
-  before(:each) do
-    stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
-    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
-  end
-
-  let(:client) do
-    Client.new(
-      Faker::Lorem.characters(15),
-      Faker::Lorem.characters(40),
-      "123456-#{Faker::Lorem.characters(40)}",
-      Faker::Lorem.characters(40)
-    )
-  end
-
-  let(:account) { client.accounts.first }
-
-  # check model properties
-  subject { described_class.new(account) }
-  read  = %w(id created_at updated_at deleted media_url)
-  write = %w(media_id creative_type video_id)
-  include_examples 'object property check', read, write
-
-end

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

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2019 Twitter, Inc.
-
-require 'spec_helper'
-
-describe TwitterAds::Creative::ImageAppDownloadCard do
-
-  before(:each) do
-    stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
-    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
-  end
-
-  let(:client) do
-    Client.new(
-      Faker::Lorem.characters(15),
-      Faker::Lorem.characters(40),
-      "123456-#{Faker::Lorem.characters(40)}",
-      Faker::Lorem.characters(40)
-    )
-  end
-
-  let(:account) { client.accounts.first }
-
-  # 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
-
-end

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2019 Twitter, Inc.
-
-require 'spec_helper'
-
-describe TwitterAds::Creative::ImageConversationCard do
-
-  before(:each) do
-    stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
-    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
-  end
-
-  let(:client) do
-    Client.new(
-      Faker::Lorem.characters(15),
-      Faker::Lorem.characters(40),
-      "123456-#{Faker::Lorem.characters(40)}",
-      Faker::Lorem.characters(40)
-    )
-  end
-
-  let(:account) { client.accounts.first }
-
-  # check model properties
-  subject { described_class.new(account) }
-  read  = %w(id image deleted created_at updated_at)
-  write = %w(
-    name
-    title
-    first_cta
-    first_cta_tweet
-    second_cta
-    second_cta_tweet
-    thank_you_text
-    thank_you_url
-    image_media_id
-  )
-  include_examples 'object property check', read, write
-
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2019 Twitter, Inc.
-
-require 'spec_helper'
-
-describe TwitterAds::Creative::VideoAppDownloadCard do
-
-  before(:each) do
-    stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
-    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
-  end
-
-  let(:client) do
-    Client.new(
-      Faker::Lorem.characters(15),
-      Faker::Lorem.characters(40),
-      "123456-#{Faker::Lorem.characters(40)}",
-      Faker::Lorem.characters(40)
-    )
-  end
-
-  let(:account) { client.accounts.first }
-
-  # check model properties
-  subject { described_class.new(account) }
-  read  = %w(id video_url video_poster_url deleted created_at updated_at)
-  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
-    image_media_id
-    video_id
-  )
-  include_examples 'object property check', read, write
-
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2019 Twitter, Inc.
-
-require 'spec_helper'
-
-describe TwitterAds::Creative::VideoConversationCard do
-
-  before(:each) do
-    stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
-    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
-  end
-
-  let(:client) do
-    Client.new(
-      Faker::Lorem.characters(15),
-      Faker::Lorem.characters(40),
-      "123456-#{Faker::Lorem.characters(40)}",
-      Faker::Lorem.characters(40)
-    )
-  end
-
-  let(:account) { client.accounts.first }
-
-  # check model properties
-  subject { described_class.new(account) }
-
-  read = %w(
-    id
-    video_url
-    video_poster_url
-    deleted
-    created_at
-    updated_at
-  )
-
-  write = %w(
-    name
-    title
-    first_cta
-    first_cta_tweet
-    second_cta
-    second_cta_tweet
-    thank_you_text
-    thank_you_url
-    image_media_id
-    video_id
-  )
-
-  include_examples 'object property check', read, write
-
-end