twitter-ads 0.3.4

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::TailoredAudience 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
+    audience_size
+    audience_type
+    metadata
+    partner_source
+    reasons_not_targetable
+    targetable
+    targetable_types
+  )
+
+  write = %w(name list_type)
+
+  include_examples 'object property check', read, write
+
+end

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

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::AppList 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 apps name)
+  write = []
+  include_examples 'object property check', read, write
+
+  describe '#create' do
+
+    let(:app_list) { TwitterAds::AppList.new(account) }
+    let!(:resource) { "#{ADS_API}/accounts/#{account.id}/app_lists" }
+    let!(:rel_path) { "/0/accounts/#{account.id}/app_lists" }
+
+    before(:each) do
+      stub_fixture(:post, :app_lists_load, /#{resource}\?.*/)
+    end
+
+    it 'creates post request with single app ID and name' do
+      name = 'Some test app list'
+      app = 'io.fabric.samples.cannonball'
+
+      params = { app_store_identifiers: app, name: name }
+      args = [account.client, :post, rel_path, params: params]
+
+      expect(Request).to receive(:new).with(*args).and_call_original
+      app_list.create(name, app)
+    end
+
+    it 'creates post request with multiple app IDs and name' do
+      name = 'Some test app list'
+      apps = ['com.supercell.clashofclans', 'com.functionx.viggle',
+              'io.fabric.samples.cannonball', 'com.hoteltonight.android.prod']
+
+      params = { app_store_identifiers: apps.join(','), name: name }
+      args = [account.client, :post, rel_path, params: params]
+
+      expect(Request).to receive(:new).with(*args).and_call_original
+      app_list.create(name, apps)
+    end
+
+  end
+
+  describe '#apps' do
+
+    let(:app_list) { TwitterAds::AppList.new(account) }
+    let!(:resource) { "#{ADS_API}/accounts/#{account.id}/app_lists/abc2" }
+
+    context 'when @apps is nil' do
+
+      before(:each) do
+        app_list.instance_variable_set('@apps', nil)
+        app_list.instance_variable_set('@id', 'abc2')
+        stub_fixture(:get, :app_lists_load, /#{resource}/)
+      end
+
+      it 'reloads the object from the server' do
+        expect(app_list).to receive(:reload!).and_call_original
+        app_list.apps
+        expect(app_list.instance_variable_get('@apps')).not_to be_nil
+      end
+    end
+
+    context 'when @apps is not nil' do
+
+      let(:apps) {
+        [
+          {
+            'app_store_identifier' => 'io.fabric.samples.cannonball',
+            'os_type' => 'Android'
+          }
+        ]
+      }
+
+      before(:each) do
+        app_list.instance_variable_set('@apps', apps)
+        app_list.instance_variable_set('@id', 'abc2')
+      end
+
+      it 'does not reload the object from the server' do
+        expect(app_list).not_to receive(:reload!)
+        app_list.apps
+        expect(app_list.apps).to eq(apps)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+include TwitterAds::Enum
+
+describe TwitterAds::LineItem 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
+    campaign_id
+    advertiser_domain
+    categories
+    charge_by
+    include_sentiment
+    objective
+    paused
+    primary_web_event_tag
+    product_type
+    placements
+    bid_unit
+    automatically_select_bid
+    bid_amount_local_micro
+    total_budget_amount_local_micro
+  )
+  include_examples 'object property check', read, write
+
+  describe '#placements' do
+
+    before(:each) do
+      url = Addressable::Template.new "#{ADS_API}/line_items/placements{?product_type}"
+      stub_fixture(:get, :placements, url)
+    end
+
+    let(:product_type) { Product::PROMOTED_TWEETS }
+
+    it 'successfully fetches valid placement / product type combinations' do
+      expect(TwitterAds::Utils).not_to receive(:deprecated)
+      result = silence { described_class.placements(client, product_type) }
+      expect(result.size).not_to be_nil
+      expect(result).to all(be_a(Array))
+    end
+
+    it 'allows product_type to be an optional method argument' do
+      expect(TwitterAds::Utils).not_to receive(:deprecated)
+      result = silence { described_class.placements(client) }
+      expect(result.size).not_to be_nil
+      expect(result).to all(be_a(Array))
+    end
+
+  end
+
+  describe '#objective=' do
+
+    context 'when using TwitterAds::Objective::CUSTOM' do
+
+      it 'raises a warning message' do
+        expect(TwitterAds::Utils).to receive(:deprecated).with('TwitterAds::Objective::CUSTOM')
+        subject.objective = TwitterAds::Objective::CUSTOM
+      end
+
+    end
+
+    context 'when using any object other than TwitterAds::Objective::CUSTOM' do
+
+      it 'does not raise a warning message' do
+        expect(TwitterAds::Utils).not_to receive(:deprecated).with(any_args)
+        subject.objective = TwitterAds::Objective::VIDEO_VIEWS
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::ReachEstimate 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 }
+
+  describe '#fetch' do
+
+    let!(:resource) { "#{ADS_API}/accounts/#{account.id}/reach_estimate" }
+    let!(:rel_path) { "/0/accounts/#{account.id}/reach_estimate" }
+
+    before(:each) do
+      stub_fixture(:get, :reach_estimate, /#{resource}\?.*/)
+    end
+
+    it 'creates proper get request with no optional parameters specified' do
+      expected = { product_type: 'PROMOTED_TWEETS', objective: 'WEBSITE_CLICKS',
+                   user_id: 12, bid_type: 'AUTO' }
+      args = [account.client, :get, rel_path, params: expected]
+
+      expect(Request).to receive(:new).with(*args).and_call_original
+      TwitterAds::ReachEstimate.fetch(account, 'PROMOTED_TWEETS', 'WEBSITE_CLICKS', 12)
+    end
+
+    it 'creates proper get request when optional paremeters are specified' do
+
+      expected = { product_type: 'PROMOTED_TWEETS', objective: 'WEBSITE_CLICKS',
+                   user_id: 12, similar_to_followers_of_user: '12', gender: '2', bid_type: 'AUTO' }
+      args = [account.client, :get, rel_path, params: expected]
+
+      expect(Request).to receive(:new).with(*args).and_call_original
+      TwitterAds::ReachEstimate.fetch(
+        account, 'PROMOTED_TWEETS', 'WEBSITE_CLICKS', 12,
+        similar_to_followers_of_user: '12', gender: '2')
+
+    end
+
+    context 'without bid_type specified' do
+
+      it 'defaults bid_type to AUTO for backward compatibility' do
+        expected = { product_type: 'PROMOTED_TWEETS', objective: 'WEBSITE_CLICKS',
+                     user_id: 12, bid_type: 'AUTO' }
+        args = [account.client, :get, rel_path, params: expected]
+
+        expect(Request).to receive(:new).with(*args).and_call_original
+        TwitterAds::ReachEstimate.fetch(account, 'PROMOTED_TWEETS', 'WEBSITE_CLICKS', 12)
+      end
+
+    end
+
+    context 'with bid_type specified' do
+
+      it 'does not default bid_type to AUTO' do
+        expected = { product_type: 'PROMOTED_TWEETS', objective: 'WEBSITE_CLICKS',
+                     user_id: 12, bid_type: 'MAX' }
+        args = [account.client, :get, rel_path, params: expected]
+
+        expect(Request).to receive(:new).with(*args).and_call_original
+        TwitterAds::ReachEstimate.fetch(
+          account, 'PROMOTED_TWEETS', 'WEBSITE_CLICKS', 12, bid_type: 'MAX')
+      end
+
+    end
+
+    context 'with bid_amount_local_micro specified' do
+
+      it 'does not default bid_type to AUTO' do
+        expected = { product_type: 'PROMOTED_TWEETS', objective: 'WEBSITE_CLICKS',
+                     user_id: 12, bid_amount_local_micro: 1500000 }
+        args = [account.client, :get, rel_path, params: expected]
+
+        expect(Request).to receive(:new).with(*args).and_call_original
+        TwitterAds::ReachEstimate.fetch(
+          account, 'PROMOTED_TWEETS', 'WEBSITE_CLICKS', 12, bid_amount_local_micro: 1500000)
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::TargetingCriteria 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 name localized_name created_at updated_at deleted)
+
+  write = %w(
+    line_item_id
+    targeting_type
+    targeting_value
+    tailored_audience_expansion
+    tailored_audience_type
+  )
+
+  include_examples 'object property check', read, write
+
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Tweet 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 }
+
+  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 = { status: '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 = "/0/accounts/#{account.id}/tweet/preview"
+        expected = { status: '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 }
+        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 = "/0/accounts/#{account.id}/tweet/preview"
+        expected = { status: '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] }
+        result = subject.preview(account, params)
+        expect(result.size).not_to be_nil
+        expect(result).to all(include(:platform, :preview))
+      end
+
+    end
+
+  end
+
+end