Deprecation August, 2019 (#206)

* remove Audience Intelligence

* remove old preview endpoints

* fix Faker gem version (~> 1.0)

workaround for breaking change in Faker 2.x: https://github.com/faker-ruby/faker/releases/tag/2.0

Author: smaeda-ks

Gemfile

@@ -7,7 +7,7 @@ gem 'rake'
 group :development, :test do
   gem 'codeclimate-test-reporter', platforms: :mri
   gem 'cucumber'
-  gem 'faker'
+  gem 'faker', '~> 1.0'      # fix for breaking change in faker 2.x
   gem 'rspec'
   gem 'rubocop', '~> 0.50.0'
   gem 'simplecov', '~> 0.13' # fix for breaking change in simplecov

examples/audience_intelligence.rb

@@ -27,7 +27,6 @@
 require 'twitter-ads/http/request'
 require 'twitter-ads/http/response'
 
-require 'twitter-ads/audiences/audience_intelligence'
 require 'twitter-ads/audiences/tailored_audience'
 
 require 'twitter-ads/campaign/app_list'

examples/tweet_preview.rb

@@ -7,52 +7,11 @@ module Tweet
     # cannot instaniate Tweet, only including class methods for stats
     extend TwitterAds::Analytics::ClassMethods
 
-    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tweet/preview' # @api private
-    RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tweet/preview/%{id}' # @api private
-    RESOURCE_CREATE      = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tweet' # @api private
+    RESOURCE_CREATE = "/#{TwitterAds::API_VERSION}/" \
+                      'accounts/%{account_id}/tweet' # @api private
 
     class << self
 
-      # Returns an HTML preview of a tweet, either new or existing
-      #
-      # @example
-      #   Tweet.preview(account, text: 'potatoes can be deadly...')
-      #   Tweet.preview(account, id: 634798319504617472)
-      #
-      # @param client [Client] The Client object instance.
-      # @param account [Account] The Account object instance.
-      # @param opts [Hash] A hash of options.
-      #
-      # @option opts [Integer] :id The ID of an existing Tweet you want to preview.
-      # @option opts [String] :text The text of your status update.
-      # @option opts [Array] :media_ids A list of up to four media IDs to associate with the Tweet.
-      # @option opts [String] :card_id The base-36 ID of a revenue card to be embedded in the Tweet.
-      # @option opts [String] :preview_target The target to render the Tweet preview
-      #   for (eg. TWITTER_TIMELINES).
-      #
-      # @return [Array] An array containing platforms & their respective tweet previews
-      #
-      # @since 0.2.0
-      # @see https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/tweet/preview
-      def preview(account, opts = {})
-        resource = opts.key?(:id) ? RESOURCE : RESOURCE_COLLECTION
-        resource = resource % { account_id: account.id, id: opts.delete(:id) }
-
-        # url encodes status message if present
-        opts[:text] = URI.escape(opts[:text]) if opts.key?(:text)
-
-        # handles array to string conversion for media IDs
-        if opts.key?(:media_ids) && opts[:media_ids].respond_to?(:join)
-          opts[:media_ids] = opts[:media_ids].join(',')
-        end
-
-        response = TwitterAds::Request.new(account.client, :get, resource, params: opts).perform
-        response.body[:data]
-      end
-
       # Creates a "Promoted-Only" Tweet using the specialized Ads API end point.
       #
       # @param opts [Hash] A hash of options.

lib/twitter-ads.rb

@@ -30,27 +30,12 @@ class DraftTweet
                             'accounts/%{account_id}/draft_tweets' # @api private
       RESOURCE = "/#{TwitterAds::API_VERSION}/" \
                  'accounts/%{account_id}/draft_tweets/%{id}' # @api private
-      PREVIEW  = "/#{TwitterAds::API_VERSION}/" \
-               'accounts/%{account_id}/draft_tweets/preview/%{id}' # @api private
 
       def initialize(account)
         @account = account
         self
       end
 
-      def preview(account: @account, draft_tweet_id: nil)
-        if !draft_tweet_id.nil?
-          resource = self.class::PREVIEW % { account_id: account.id, id: draft_tweet_id }
-        elsif @id
-          resource = self.class::PREVIEW % { account_id: account.id, id: id }
-        else
-          raise ArgumentError.new(
-            "object has no 'draft_tweet_id' to preview")
-        end
-        response = TwitterAds::Request.new(account.client, :post, resource).perform
-        response.body
-      end
-
     end
   end
 end

lib/twitter-ads/audiences/audience_intelligence.rb

@@ -35,16 +35,6 @@ class ScheduledTweet
                             'accounts/%{account_id}/scheduled_tweets' # @api private
       RESOURCE = "/#{TwitterAds::API_VERSION}/" \
                  'accounts/%{account_id}/scheduled_tweets/%{id}' # @api private
-      PREVIEW  = "/#{TwitterAds::API_VERSION}/" \
-                 'accounts/%{account_id}/scheduled_tweets/preview/%{id}' # @api private
-
-      def preview(account, opts = {})
-        if @id
-          resource = self.class::PREVIEW % { account_id: account.id, id: id }
-          response = TwitterAds::Request.new(account.client, :get, resource, params: opts).perform
-          response.body[:data]
-        end
-      end
 
       def initialize(account)
         @account = account

lib/twitter-ads/campaign/tweet.rb

@@ -218,11 +218,6 @@ module ConversationType
       HASHTAG = 'HASHTAG'
     end
 
-    module AudienceDefinition
-      TARGETING_CRITERIA = 'TARGETING_CRITERIA'
-      KEYWORD_AUDIENCE = 'KEYWORD_AUDIENCE'
-    end
-
     module LookalikeExpansion
       DEFINED = 'DEFINED'
       EXPANDED = 'EXPANDED'

lib/twitter-ads/creative/draft_tweet.rb

@@ -21,63 +21,4 @@
 
   let(:account) { client.accounts.first }
 
-  describe '#tweet_preview' do
-
-    let!(:resource_collection) { "#{ADS_API}/accounts/#{account.id}/tweet/preview" }
-
-    before(:each) do
-      stub_fixture(:get, :tweet_preview, /#{resource_collection}.*/)
-    end
-
-    context 'with an existing tweet id' do
-
-      it 'successfully returns a preview of the specified tweet' do
-        params = { id: 634798319504617472 }
-        result = subject.preview(account, params)
-        expect(result.size).not_to be_nil
-        expect(result).to all(include(:platform, :preview))
-      end
-
-    end
-
-    context 'when previewing a new tweet' do
-
-      it 'url encodes the status content' do
-        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
-        expect(result).to all(include(:platform, :preview))
-      end
-
-      it 'allows a single value for the media_ids param' do
-        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 = { 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 = "/#{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 = { 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))
-      end
-
-    end
-
-  end
-
 end