twitter-ads 0.3.4

data/spec/fixtures/tailored_audiences_load.json

@@ -0,0 +1,29 @@
+{
+  "data_type": "tailored_audiences",
+  "data": {
+    "targetable": false,
+    "name": "TA #2",
+    "targetable_types": [
+      "WEB",
+      "EXCLUDED_WEB"
+    ],
+    "audience_type": "WEB",
+    "id": "abc2",
+    "reasons_not_targetable": [
+      "TOO_SMALL"
+    ],
+    "list_type": null,
+    "created_at": "2014-03-09T20:35:41Z",
+    "updated_at": "2014-06-11T09:38:06Z",
+    "partner_source": "OTHER",
+    "deleted": false,
+    "audience_size": null
+  },
+  "request": {
+    "params": {
+      "account_id": "2iqph",
+      "name": "TA #2",
+      "list_type": "EMAIL"
+    }
+  }
+}

data/spec/fixtures/tweet_preview.json

@@ -0,0 +1,24 @@
+{
+  "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/fixtures/videos_all.json

@@ -0,0 +1,50 @@
+{
+  "data_type": "video",
+  "data": [
+    {
+      "tweeted": false,
+      "ready_to_tweet": true,
+      "duration": 289149,
+      "reasons_not_servable": [],
+      "description": "youtubz",
+      "preview_url": "https://amp.twimg.com/prod/multibr_v_1/video/2015/09/24/21/d5e3ae4d-34c4-4f49-894e-0c17735916a4-libx264-baseline-2528k.mp4?rYDB9GoYJcfWyizjXnBZra4UnGQMTkzUkIuW6OKjlXw%3D",
+      "id": "d5e3ae4d-34c4-4f49-894e-0c17735916a4",
+      "created_at": "2015-09-24T21:21:00Z",
+      "title": "video #1",
+      "updated_at": "2015-09-24T21:25:42Z",
+      "deleted": false
+    },
+    {
+      "tweeted": false,
+      "ready_to_tweet": true,
+      "duration": 16517,
+      "reasons_not_servable": [],
+      "description": "my favorite video",
+      "preview_url": "https://amp.twimg.com/prod/multibr_v_1/video/2015/09/24/21/a6d50810-c0bd-408e-b703-b789a82981ce-libx264-baseline-2528k.mp4?rYDB9GoYJcfWyizjXnBZra4UnGQMTkzUkIuW6OKjlXw%3D",
+      "id": "a6d50810-c0bd-408e-b703-b789a82981ce",
+      "created_at": "2015-09-24T21:11:01Z",
+      "title": "video #2",
+      "updated_at": "2015-09-24T21:11:41Z",
+      "deleted": false
+    },
+    {
+      "tweeted": false,
+      "ready_to_tweet": false,
+      "duration": 16517,
+      "reasons_not_servable": ["ERROR"],
+      "description": "another great video",
+      "preview_url": "https://amp.twimg.com/prod/multibr_v_1/video/2015/09/24/21/3beaeaca-0f2f-4aff-a025-e0d53a0aef2c-libx264-baseline-2528k.mp4?rYDB9GoYJcfWyizjXnBZra4UnGQMTkzUkIuW6OKjlXw%3D",
+      "id": "3beaeaca-0f2f-4aff-a025-e0d53a0aef2c",
+      "created_at": "2015-09-24T21:08:55Z",
+      "title": "video #3",
+      "updated_at": "2015-09-24T21:10:01Z",
+      "deleted": true
+    }
+  ],
+  "request": {
+    "params": {
+      "account_id": "2iqph"
+    }
+  },
+  "next_cursor": null
+}

data/spec/fixtures/videos_load.json

@@ -0,0 +1,22 @@
+{
+  "data_type": "video",
+  "data": {
+    "tweeted": false,
+    "ready_to_tweet": true,
+    "duration": 289149,
+    "reasons_not_servable": [],
+    "description": "youtubz",
+    "preview_url": "https://amp.twimg.com/prod/multibr_v_1/video/2015/09/24/21/d5e3ae4d-34c4-4f49-894e-0c17735916a4-libx264-baseline-2528k.mp4?rYDB9GoYJcfWyizjXnBZra4UnGQMTkzUkIuW6OKjlXw%3D",
+    "id": "d5e3ae4d-34c4-4f49-894e-0c17735916a4",
+    "created_at": "2015-09-24T21:21:00Z",
+    "title": "video #1",
+    "updated_at": "2015-09-24T21:25:42Z",
+    "deleted": false
+  },
+  "request": {
+    "params": {
+      "video_id": "d5e3ae4d-34c4-4f49-894e-0c17735916a4",
+      "account_id": "2iqph"
+    }
+  }
+}

data/spec/quality_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe 'Code Style & Quality', :quality do
+
+  # If this test fails, you need to run 'rubocop' to see what needs to be fixed.
+  # Please see the CONTRIBUTING.md file for additional style guide information.
+  it 'has no style guide or quality violations', :style do
+    result = silence { RuboCop::CLI.new.run([]) }
+    expect(result).to eq(0)
+  end unless RUBY_ENGINE =~ /rbx/
+
+end

data/spec/shared/properties.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+RSpec.shared_examples 'object property check' do |read, write|
+
+  it 'has all the correct write properties' do
+    write.each do |prop|
+      expect(subject.respond_to?(prop)).to be true
+      expect(subject.respond_to?("#{prop}=")).to be true
+    end
+  end
+
+  it 'has all the correct read-only properties' do
+    read.each do |prop|
+      expect(subject.respond_to?(prop)).to be true
+      expect(subject.respond_to?("#{prop}=")).not_to be true
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+unless RUBY_PLATFORM =~ /java/ || RUBY_ENGINE =~ /rbx/
+  require 'simplecov'
+  require 'codeclimate-test-reporter'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter
+  ]
+
+  SimpleCov.start do
+    add_filter '/spec/'
+    minimum_coverage(80.00)
+  end
+end
+
+require 'rubocop'
+require 'faker'
+
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow: 'codeclimate.com')
+
+require 'twitter-ads'
+include TwitterAds
+
+# Require All Support Files
+Dir['./spec/support/*.rb'].sort.each { |file| require file }
+
+ADS_API    = 'https://ads-api.twitter.com/0'.freeze
+TON_API    = 'https://ton.twitter.com'.freeze
+UPLOAD_API = 'https://upload.twitter.com/1.1'.freeze
+
+RSpec.configure do |config|
+  # Helpers & Custom Matchers
+  include Helpers
+
+  # General
+  config.color     = true
+  config.fail_fast = true unless ENV['CI']
+  config.formatter = ENV['CI'] ? 'documentation' : 'progress'
+  config.profile_examples = 5
+
+  # Expectations
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # Mocking
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Test Order & Filtering
+  config.order = :random
+  Kernel.srand config.seed
+end
+
+# Require All Shared Examples
+Dir['./spec/shared/*.rb'].sort.each { |file| require file }

data/spec/support/helpers.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+# Helper module for custom test matchers and utilities.
+module Helpers
+
+  # Helper method to temporarily redirect stdout and stderr for
+  # a given block of code.
+  #
+  # @param &block [Block] The code block to be executed.
+  #
+  # @return [Object] The result of the block.
+  def silence(&block)
+    original_stdout = $stdout
+    original_stderr = $stderr
+    $stdout = $stderr = File.new('/dev/null', 'w')
+    yield block
+  ensure
+    $stdout = original_stdout
+    $stderr = original_stderr
+  end
+
+  # Helper method for returning a JSON fixture file.
+  #
+  # @param name [Symbol] The name of the fixture file to be returned.
+  #
+  # @return [File] The file instance of the fixture specified.
+  def fixture(name)
+    File.new(File.expand_path("../../fixtures/#{name}.json", __FILE__))
+  end
+
+  # Helper method to stub a request with a fixture by name.
+  #
+  # @param method [Symbol] The HTTP method (:get, :put, :post, :delete)
+  # @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)
+  end
+
+end

data/spec/twitter-ads/account_spec.rb

@@ -0,0 +1,315 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Account 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 '#initialize' do
+
+    let(:account) { TwitterAds::Account.new(client) }
+    let(:methods) {
+      %w(features promotable_users funding_instruments campaigns line_items)
+    }
+
+    it 'raises an ArgumentError error if used without initialization' do
+      expect(account).to receive(:validate_loaded).and_call_original.exactly(methods.size).times
+      methods.each { |meth| expect { account.send(meth) }.to raise_error(ArgumentError) }
+    end
+
+  end
+
+  describe '#inspect' do
+
+    it 'includes the object id value' do
+      expect(account.inspect).to include(account.object_id.to_s)
+    end
+
+    it 'includes the class.name value' do
+      expect(account.inspect).to include(account.class.name)
+    end
+
+    it 'includes the Account ID value' do
+      expect(account.inspect).to include(account.id)
+    end
+
+  end
+
+  describe '#features' do
+
+    before(:each) do
+      stub_fixture(:get, :accounts_features, "#{ADS_API}/accounts/#{account.id}/features")
+    end
+
+    it 'successfully returns a list of features available' do
+      features = account.features
+      expect(features).not_to be_nil
+      expect(features).to all(be_a(String))
+    end
+
+  end
+
+  describe '#promotable_users' do
+
+    before(:each) do
+      resource_collection = "#{ADS_API}/accounts/#{account.id}/promotable_users"
+      stub_fixture(:get, :promotable_users_all, resource_collection)
+
+      resource = "#{ADS_API}/accounts/#{account.id}/promotable_users/4k"
+      stub_fixture(:get, :promotable_users_load, /#{resource}\?.*/)
+    end
+
+    context 'with an id specified' do
+
+      it 'succesfully loads the specified promoted tweet' do
+        result = account.promotable_users('4k')
+        expect(result).not_to be_nil
+        expect(result.class).to eq(TwitterAds::PromotableUser)
+        expect(result.id).to eq('4k')
+      end
+
+    end
+
+    context 'without an id specified' do
+
+      it 'succesfully returns a Cursor with all promoted tweets' do
+        result = account.promotable_users
+        expect(result.size).to eq(5)
+        expect(result.class).to eq(TwitterAds::Cursor)
+        expect(result.first.class).to eq(TwitterAds::PromotableUser)
+        expect(result.first.id).to eq('4k')
+      end
+
+    end
+
+  end
+
+  describe '#funding_instruments' do
+
+    before(:each) do
+      resource_collection = "#{ADS_API}/accounts/#{account.id}/funding_instruments"
+      stub_fixture(:get, :funding_instruments_all, resource_collection)
+
+      resource = "#{ADS_API}/accounts/#{account.id}/funding_instruments/5aa0p"
+      stub_fixture(:get, :funding_instruments_load, /#{resource}\?.*/)
+    end
+
+    context 'with an id specified' do
+
+      it 'succesfully loads the specified promoted tweet' do
+        result = account.funding_instruments('5aa0p')
+        expect(result).not_to be_nil
+        expect(result.class).to eq(TwitterAds::FundingInstrument)
+        expect(result.id).to eq('5aa0p')
+      end
+
+    end
+
+    context 'without an id specified' do
+
+      it 'succesfully returns a Cursor with all promoted tweets' do
+        result = account.funding_instruments
+        expect(result.size).to eq(3)
+        expect(result.class).to eq(TwitterAds::Cursor)
+        expect(result.first.class).to eq(TwitterAds::FundingInstrument)
+        expect(result.first.id).to eq('5aa0p')
+      end
+
+    end
+
+  end
+
+  describe '#campaigns' do
+
+    before(:each) do
+      resource_collection = "#{ADS_API}/accounts/#{account.id}/campaigns"
+      stub_fixture(:get, :campaigns_all, resource_collection)
+
+      resource = "#{ADS_API}/accounts/#{account.id}/campaigns/2wap7"
+      stub_fixture(:get, :campaigns_load, /#{resource}\?.*/)
+    end
+
+    context 'with an id specified' do
+
+      it 'succesfully loads the specified promoted tweet' do
+        result = account.campaigns('2wap7')
+        expect(result).not_to be_nil
+        expect(result.class).to eq(TwitterAds::Campaign)
+        expect(result.id).to eq('2wap7')
+      end
+
+    end
+
+    context 'without an id specified' do
+
+      it 'succesfully returns a Cursor with all promoted tweets' do
+        result = account.campaigns
+        expect(result.size).to eq(10)
+        expect(result.class).to eq(TwitterAds::Cursor)
+        expect(result.first.class).to eq(TwitterAds::Campaign)
+        expect(result.first.id).to eq('2wap7')
+      end
+
+    end
+
+  end
+
+  describe '#line_items' do
+
+    before(:each) do
+      resource_collection = "#{ADS_API}/accounts/#{account.id}/line_items"
+      stub_fixture(:get, :line_items_all, resource_collection)
+
+      resource = "#{ADS_API}/accounts/#{account.id}/line_items/bw2"
+      stub_fixture(:get, :line_items_load, /#{resource}\?.*/)
+    end
+
+    context 'with an id specified' do
+
+      it 'succesfully loads the specified promoted tweet' do
+        result = account.line_items('bw2')
+        expect(result).not_to be_nil
+        expect(result.class).to eq(TwitterAds::LineItem)
+        expect(result.id).to eq('bw2')
+      end
+
+    end
+
+    context 'without an id specified' do
+
+      it 'succesfully returns a Cursor with all promoted tweets' do
+        result = account.line_items
+        expect(result.size).to eq(10)
+        expect(result.class).to eq(TwitterAds::Cursor)
+        expect(result.first.class).to eq(TwitterAds::LineItem)
+        expect(result.first.id).to eq('bw2')
+      end
+
+    end
+
+  end
+
+  describe '#app_lists' do
+
+    before(:each) do
+      resource_collection = "#{ADS_API}/accounts/#{account.id}/app_lists"
+      stub_fixture(:get, :app_lists_all, resource_collection)
+
+      resource = "#{ADS_API}/accounts/#{account.id}/app_lists/abc2"
+      stub_fixture(:get, :app_lists_load, /#{resource}\?.*/)
+    end
+
+    context 'with an id specified' do
+
+      it 'successfully loads the specified app list' do
+        result = account.app_lists('abc2')
+        expect(result).not_to be_nil
+        expect(result.class).to eq(TwitterAds::AppList)
+        expect(result.id).to eq('abc2')
+      end
+
+    end
+
+    context 'without an id specified' do
+
+      it 'succesfully returns a cursor with all app lists' do
+        result = account.app_lists
+        expect(result.to_a.size).to eq(3)
+        expect(result.class).to eq(TwitterAds::Cursor)
+        expect(result.first.class).to eq(TwitterAds::AppList)
+        expect(result.first.id).to eq('abc2')
+      end
+
+    end
+
+  end
+
+  describe '#tailored_audiences' do
+
+    before(:each) do
+      resource_collection = "#{ADS_API}/accounts/#{account.id}/tailored_audiences"
+      stub_fixture(:get, :tailored_audiences_all, resource_collection)
+
+      resource = "#{ADS_API}/accounts/#{account.id}/tailored_audiences/abc2"
+      stub_fixture(:get, :tailored_audiences_load, /#{resource}\?.*/)
+    end
+
+    context 'with an id specified' do
+
+      it 'successfully loads the specified tailored audience' do
+        result = account.tailored_audiences('abc2')
+        expect(result).not_to be_nil
+        expect(result.class).to eq(TwitterAds::TailoredAudience)
+        expect(result.id).to eq('abc2')
+      end
+
+    end
+
+    context 'without an id specified' do
+
+      it 'succesfully returns a cursor with all tailored audiences' do
+        result = account.tailored_audiences
+        expect(result.to_a.size).to eq(3)
+        expect(result.class).to eq(TwitterAds::Cursor)
+        expect(result.first.class).to eq(TwitterAds::TailoredAudience)
+        expect(result.first.id).to eq('abc2')
+      end
+
+    end
+
+  end
+
+  describe '#videos' do
+
+    let!(:video_id) { 'd5e3ae4d-34c4-4f49-894e-0c17735916a4' }
+
+    before(:each) do
+      resource_collection = "#{ADS_API}/accounts/#{account.id}/videos"
+      stub_fixture(:get, :videos_all, resource_collection)
+
+      resource = "#{ADS_API}/accounts/#{account.id}/videos/#{video_id}"
+      stub_fixture(:get, :videos_load, /#{resource}\?.*/)
+    end
+
+    context 'with an id specified' do
+
+      it 'successfully loads the specified video' do
+        result = account.videos(video_id)
+        expect(result).not_to be_nil
+        expect(result.class).to eq(TwitterAds::Video)
+        expect(result.id).to eq(video_id)
+      end
+
+    end
+
+    context 'without an id specified' do
+
+      it 'succesfully returns a cursor with all videos' do
+        result = account.videos
+        expect(result.to_a.size).to eq(3)
+        expect(result.class).to eq(TwitterAds::Cursor)
+        expect(result.first.class).to eq(TwitterAds::Video)
+        expect(result.first.id).to eq(video_id)
+      end
+
+    end
+
+  end
+
+end