twitter-ads 5.2.0 → 8.0.0

data/lib/twitter-ads/targeting/audience_summary.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+module TwitterAds
+  module AudienceSummary
+
+    include TwitterAds::DSL
+    include TwitterAds::Resource
+
+    RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/audience_summary'
+
+    property :audience_size, read_only: true
+
+    class << self
+
+      # Get an audience summary for the specified targeting criteria.
+      #
+      # @example
+      #   TwitterAds::AudienceSummary.fetch(
+      #     account,
+      #     params: {targeting_criteria:[{targeting_type:'LOCATION',
+      #             targeting_value:'96683cc9126741d1'}]}
+      #   )
+      #
+      # @param params [Hash] A hash of input targeting criteria values
+      #
+      # @return [Hash] A hash containing the min and max audience size.
+      #
+      # @since 7.0.0
+      # @see https://developer.twitter.com/en/docs/ads/campaign-management/api-reference/audience-summary
+      def fetch(account, params)
+        resource = RESOURCE % { account_id: account.id }
+        headers = { 'Content-Type' => 'application/json' }
+
+        response = TwitterAds::Request.new(account.client,
+                                           :post,
+                                           resource,
+                                           headers: headers,
+                                           body: params.to_json).perform
+        response.body[:data]
+      end
+
+    end
+
+  end
+end

data/lib/twitter-ads/targeting_criteria/{behavior.rb → conversation.rb}

@@ -2,22 +2,18 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  class Behavior
+  class Conversation
 
     include TwitterAds::DSL
     include TwitterAds::Resource
 
-    property :id, read_only: true
     property :name, read_only: true
     property :targeting_type, read_only: true
     property :targeting_value, read_only: true
-    property :audience_code, read_only: true
-    property :country_code, read_only: true
-    property :partner_source, read_only: true
-    property :targetable_type, read_only: true
+    property :conversation_type, read_only: true
 
     RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
-                          'targeting_criteria/behaviors' # @api private
+                          'targeting_criteria/conversations' # @api private
 
     def initialize(account)
       @account = account

data/lib/twitter-ads/targeting_criteria/event.rb

@@ -21,6 +21,7 @@ module TwitterAds
     property :gender_breakdown_percentage, read_only: true
     property :device_breakdown_percentage, read_only: true
     property :country_breakdown_percentage, read_only: true
+    property :targeting_value, read_only: true
 
     RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
                           'targeting_criteria/events' # @api private

data/lib/twitter-ads/utils.rb

@@ -70,6 +70,29 @@ module TwitterAds
         warn message
       end
 
+      def extract_response_headers(headers)
+        values = {}
+        # only get "X-${name}" custom response headers
+        headers.each { |key, value|
+          if key =~ /^x-/
+            values[key.gsub(/^x-/, '').tr('-', '_')] = \
+              value.first =~ /^[0-9]*$/ ? value.first.to_i : value.first
+          end
+        }
+        values
+      end
+
+      def flatten_params(args)
+        params = args
+        params.each { |key, value|
+          if value.is_a?(Array)
+            next if value.empty?
+            params[key] = value.join(',')
+          end
+        }
+        params
+      end
+
     end
 
   end

data/lib/twitter-ads/version.rb

@@ -2,5 +2,5 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  VERSION = '5.2.0'
+  VERSION = '8.0.0'
 end

data/spec/fixtures/audience_summary.json

@@ -0,0 +1,14 @@
+{
+  "request": {
+    "params": {
+      "targeting_criteria": null,
+      "account_id": "2iqph"
+    }
+  },
+  "data": {
+    "audience_size": {
+      "min": 41133600,
+      "max": 50274400
+    }
+  }
+} 

data/spec/fixtures/line_items_all.json

@@ -29,7 +29,6 @@
       "currency": "USD",
       "created_at": "2011-07-11T20:36:11Z",
       "updated_at": "2011-09-04T19:39:51Z",
-      "include_sentiment": null,
       "campaign_id": "2wap7",
       "deleted": false
     },
@@ -57,7 +56,6 @@
       "currency": "USD",
       "created_at": "2011-07-13T20:56:39Z",
       "updated_at": "2011-09-04T19:39:04Z",
-      "include_sentiment": null,
       "campaign_id": "2wamv",
       "deleted": false
     },
@@ -85,7 +83,6 @@
       "currency": "USD",
       "created_at": "2011-07-14T00:04:47Z",
       "updated_at": "2011-09-04T19:39:39Z",
-      "include_sentiment": null,
       "campaign_id": "2wai9",
       "deleted": false
     },
@@ -113,7 +110,6 @@
       "currency": "USD",
       "created_at": "2011-08-22T22:42:18Z",
       "updated_at": "2011-09-04T19:40:02Z",
-      "include_sentiment": null,
       "campaign_id": "2of1n",
       "deleted": false
     },
@@ -141,7 +137,7 @@
       "currency": "JPY",
       "created_at": "2011-08-26T20:51:14Z",
       "updated_at": "2011-08-26T21:30:25Z",
-      "include_sentiment": "POSITIVE_ONLY",
+    
       "campaign_id": "2w9n1",
       "deleted": true
     },
@@ -169,7 +165,7 @@
       "currency": "USD",
       "created_at": "2011-08-26T21:38:51Z",
       "updated_at": "2011-08-26T22:24:37Z",
-      "include_sentiment": "POSITIVE_ONLY",
+    
       "campaign_id": "2vuug",
       "deleted": true
     },
@@ -197,7 +193,6 @@
       "currency": "JPY",
       "created_at": "2011-08-26T22:28:55Z",
       "updated_at": "2011-09-04T19:38:46Z",
-      "include_sentiment": null,
       "campaign_id": "2vuj3",
       "deleted": false
     },
@@ -225,7 +220,6 @@
       "currency": "USD",
       "created_at": "2011-09-01T17:25:04Z",
       "updated_at": "2011-09-16T02:56:55Z",
-      "include_sentiment": null,
       "campaign_id": "2v3c4",
       "deleted": true
     },
@@ -253,7 +247,6 @@
       "currency": "JPY",
       "created_at": "2011-09-06T17:42:52Z",
       "updated_at": "2011-09-30T18:54:18Z",
-      "include_sentiment": null,
       "campaign_id": "2ttv3",
       "deleted": false
     },
@@ -281,7 +274,6 @@
       "currency": "USD",
       "created_at": "2011-09-06T22:44:13Z",
       "updated_at": "2011-09-20T01:32:27Z",
-      "include_sentiment": null,
       "campaign_id": "2ttv3",
       "deleted": true
     }

data/spec/fixtures/line_items_load.json

@@ -24,7 +24,6 @@
     "currency": "USD",
     "created_at": "2011-07-11T20:36:11Z",
     "updated_at": "2011-09-04T19:39:51Z",
-    "include_sentiment": null,
     "campaign_id": "2wap7",
     "deleted": false
   },

data/spec/fixtures/tailored_audiences_all.json

@@ -14,6 +14,7 @@
       ],
       "audience_type": "WEB",
       "id": "abc2",
+      "owner_account_id": "18ce54uhdu0",
       "reasons_not_targetable": [
         "TOO_SMALL"
       ],
@@ -33,6 +34,7 @@
       ],
       "audience_type": "CRM",
       "id": "abc1",
+      "owner_account_id": "18ce54uhdu0",
       "reasons_not_targetable": [],
       "list_type": "DEVICE_ID",
       "created_at": "2014-05-22T17:37:12Z",
@@ -50,6 +52,7 @@
       ],
       "audience_type": "CRM",
       "id": "abc3",
+      "owner_account_id": "18ce54uhdu0",
       "reasons_not_targetable": [
         "TOO_SMALL"
       ],

data/spec/fixtures/targeted_audiences.json

@@ -0,0 +1,33 @@
+{
+    "request": {
+      "params": {
+        "account_id": "2iqph",
+        "tailored_audience_id": "abc2"
+      }
+    },
+    "next_cursor": null,
+    "data": [
+      {
+        "campaign_id": "59hod",
+        "campaign_name": "test-campaign",
+        "line_items": [
+          {
+            "id": "5gzog",
+            "name": "test-line-item",
+            "servable": true
+          }
+        ]
+      },
+      {
+        "campaign_id": "arja7",
+        "campaign_name": "Untitled campaign",
+        "line_items": [
+          {
+            "id": "bjw1q",
+            "name": null,
+            "servable": true
+          }
+        ]
+      }
+    ]
+}  

data/spec/fixtures/tweet_previews.json

@@ -0,0 +1,23 @@
+{
+  "data_type": "tweet_previews",
+  "request": {
+    "params": {
+      "tweet_ids": [
+        "1130942781109596160",
+        "1101254234031370240"
+      ],
+      "tweet_type": "PUBLISHED",
+      "account_id": "2iqph"
+    }
+  },
+  "data": [
+    {
+      "tweet_id": "1130942781109596160",
+      "preview": "<iframe class='tweet-preview' src='https://ton.smf1.twitter.com/ads-manager/tweet-preview/index.html?data=c29tZSByYW5kb20gYmFzZTY0IHN0cmluZ3MgaGVyZS4uLg=='>"
+    },
+    {
+      "tweet_id": "1101254234031370240",
+      "preview": "<iframe class='tweet-preview' src='https://ton.smf1.twitter.com/ads-manager/tweet-preview/index.html?data=c29tZSByYW5kb20gYmFzZTY0IHN0cmluZ3MgaGVyZS4uLg=='>"
+    }
+  ]
+}

data/spec/spec_helper.rb

@@ -3,12 +3,10 @@
 
 unless RUBY_PLATFORM =~ /java/ || RUBY_ENGINE =~ /rbx/
   require 'simplecov'
-  require 'codeclimate-test-reporter'
 
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
     [
-      SimpleCov::Formatter::HTMLFormatter,
-      CodeClimate::TestReporter::Formatter
+      SimpleCov::Formatter::HTMLFormatter
     ]
   )
 
@@ -22,7 +20,6 @@ require 'rubocop'
 require 'faker'
 
 require 'webmock/rspec'
-WebMock.disable_net_connect!(allow: 'codeclimate.com')
 
 require 'twitter-ads'
 include TwitterAds

data/spec/twitter-ads/audiences/tailored_audience_spec.rb

@@ -7,7 +7,12 @@ describe TwitterAds::TailoredAudience do
 
   before(:each) do
     stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
-    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
+    stub_fixture(:get,
+                 :tailored_audiences_load,
+                 "#{ADS_API}/accounts/2iqph/tailored_audiences/abc2?with_deleted=true")
+    stub_fixture(:get,
+                 :targeted_audiences,
+                 "#{ADS_API}/accounts/2iqph/tailored_audiences/abc2/targeted")
   end
 
   let(:client) do
@@ -20,7 +25,7 @@ describe TwitterAds::TailoredAudience do
   end
 
   let(:account) { client.accounts.first }
-
+  let(:tailored_audience) { described_class.load(account, 'abc2') }
   # check model properties
   subject { described_class.new(account) }
 
@@ -29,6 +34,7 @@ describe TwitterAds::TailoredAudience do
     created_at
     updated_at
     deleted
+    owner_account_id
     audience_size
     audience_type
     metadata
@@ -42,4 +48,21 @@ describe TwitterAds::TailoredAudience do
 
   include_examples 'object property check', read, write
 
+  describe '#targeted' do
+
+    let(:cursor) { tailored_audience.targeted }
+
+    it 'has all the correct properties' do
+      result = cursor.first
+      expect(result).to eq(cursor.instance_variable_get('@collection').first)
+      expect(result).to be_instance_of(TwitterAds::TargetedTailoredAudience)
+      expect(cursor).to be_instance_of(Cursor)
+    end
+
+    it 'raises error when TailoredAudience is not loaded' do
+      result = TwitterAds::TailoredAudience.new(account)
+      expect(result).to receive(:validate_loaded).and_call_original
+      expect { result.targeted }.to raise_error(ArgumentError)
+    end
+  end
 end

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

@@ -32,7 +32,6 @@ describe TwitterAds::LineItem do
     advertiser_domain
     categories
     charge_by
-    include_sentiment
     objective
     entity_status
     primary_web_event_tag

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

@@ -30,8 +30,8 @@ describe TwitterAds::TargetingCriteria do
     line_item_id
     targeting_type
     targeting_value
+    operator_type
     tailored_audience_expansion
-    tailored_audience_type
   )
 
   include_examples 'object property check', read, write

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

@@ -21,63 +21,4 @@ describe TwitterAds::Tweet do
 
   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