twitter-ads 0.3.4

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Video 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
+    tweeted
+    ready_to_tweet
+    duration
+    reasons_not_servable
+    preview_url
+    created_at
+    updated_at
+    deleted
+  )
+
+  write = %w(title description video_media_id)
+
+  include_examples 'object property check', read, write
+
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Creative::Video 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
+    tweeted
+    ready_to_tweet
+    duration
+    reasons_not_servable
+    preview_url
+    created_at
+    updated_at
+    deleted
+  )
+
+  write = %w(title description video_media_id)
+
+  include_examples 'object property check', read, write
+
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Creative::WebsiteCard 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 preview_url created_at updated_at deleted)
+  write = %w(name website_title website_url website_cta image_media_id)
+  include_examples 'object property check', read, write
+
+  it 'raises a warning message each time website_cta is set' do
+    expect(TwitterAds::Utils).to receive(:deprecated).with(
+      'TwitterAds::Creative::WebsiteCard#website_cta',
+      refer: 'https://t.co/deprecated-website-card-cta')
+    subject.website_cta = 'any value'
+  end
+
+end

data/spec/twitter-ads/cursor_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Cursor do
+
+  before(:each) do
+    stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
+    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
+    stub_fixture(:get, :campaigns_all, "#{ADS_API}/accounts/2iqph/campaigns")
+    stub_fixture(:get, :app_lists_all, "#{ADS_API}/accounts/2iqph/app_lists")
+  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 '#last' do
+
+    let(:cursor) { account.campaigns }
+
+    it 'exhausts the Cursor and returns the last object' do
+      expect(cursor).to receive(:each).and_call_original
+      result = cursor.last
+      expect(result).not_to be_nil
+      expect(result).to eq(cursor.instance_variable_get('@collection').last)
+      expect(cursor.exhausted?).to be true
+    end
+
+  end
+
+  describe '#count' do
+
+    context 'for non-standard responses' do
+
+      let(:cursor) { account.app_lists }
+
+      it 'returns the correct count for non-standard responses' do
+        expect(cursor.count).to eq(3)
+        expect(cursor.instance_variable_get('@total_count')).to be_nil
+        expect(cursor.exhausted?).to be true
+      end
+
+    end
+
+    context 'for standard responses' do
+
+      let(:cursor) { account.campaigns }
+
+      it 'returns the correct count for non-standard responses' do
+        expect(cursor.instance_variable_get('@total_count')).not_to be_nil
+        expect(cursor.count).to eq(cursor.instance_variable_get('@total_count'))
+      end
+
+    end
+
+  end
+
+end

data/spec/twitter-ads/placements_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Placement do
+
+  let(:client) do
+    Client.new(
+      Faker::Lorem.characters(15),
+      Faker::Lorem.characters(40),
+      "123456-#{Faker::Lorem.characters(40)}",
+      Faker::Lorem.characters(40)
+    )
+  end
+
+  describe '#valid_combinations' do
+
+    before(:each) do
+      url = Addressable::Template.new "#{ADS_API}/line_items/placements{?product_type}"
+      stub_fixture(:get, :placements, url)
+    end
+
+    let(:product_type) { TwitterAds::Product::PROMOTED_TWEETS }
+
+    it 'successfully fetches valid placement / product type combinations' do
+      expect(TwitterAds::Utils).to receive(:deprecated).and_call_original
+      expect(TwitterAds::LineItem).to receive(:placements).and_call_original
+      result = silence { subject.valid_combinations(client, product_type) }
+      expect(result.size).not_to be_nil
+      expect(result).to all(be_a(Array))
+    end
+
+  end
+
+end

data/spec/twitter-ads/utils_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Utils do
+
+  describe '#to_bool' do
+
+    it 'successfully coerces "nil" to its correct boolean value' do
+      expect(subject.to_bool(nil)).to be false
+    end
+
+    it 'successfully coerces "true" to its correct boolean value' do
+      expect(subject.to_bool(true)).to be true
+    end
+
+    it 'successfully coerces "false" to its correct boolean value' do
+      expect(subject.to_bool(false)).to be false
+    end
+
+    it 'does not coerces numerical values' do
+      expect(subject.to_bool(0)).to be true
+      expect(subject.to_bool(1)).to be true
+      expect(subject.to_bool(999)).to be true
+    end
+
+  end
+
+  describe '#to_time' do
+
+    let(:time) { Time.now }
+
+    context 'when a granularity is not specified' do
+
+      it 'returns the ISO 8601 formatted string' do
+        expect(subject.to_time(time)).to eq(time.iso8601)
+      end
+
+    end
+
+    context 'when a granularity is specified' do
+
+      it 'returns the ISO 8601 formatted string for :hour rounded to the hour' do
+        expected_result = Time.new(time.year, time.month, time.day, time.hour).iso8601
+        expect(subject.to_time(time, :hour)).to eq(expected_result)
+      end
+
+      it 'returns the ISO 8601 formatted string for :day rounded to the day' do
+        expected_result = Time.new(time.year, time.month, time.day).iso8601
+        expect(subject.to_time(time, :day)).to eq(expected_result)
+      end
+
+      it 'returns the ISO 8601 formatted string for all other granularities' do
+        expect(subject.to_time(time, :total)).to eq(time.iso8601)
+      end
+
+    end
+
+  end
+
+  describe '#symbolize!' do
+
+    context 'with a simple object' do
+
+      let(:simple) { { 'key1' => 'foo', 'key2' => 'bar', 'key3' => 1234 } }
+
+      it 'successfully converts all keys to symbols' do
+        result = subject.symbolize!(simple)
+        expect(result.keys).to all(be_a(Symbol))
+      end
+
+    end
+
+    context 'with a nested object' do
+
+      let(:nested) { { 'key1' => 'foo', 'key2' => { 'key3' => 1 } } }
+
+      it 'successfully converts the nested object keys to symbols' do
+        result = subject.symbolize!(nested)
+        expect(result.keys).to all(be_a(Symbol))
+        expect(result[:key2].keys).to all(be_a(Symbol))
+      end
+
+    end
+
+    context 'with a nested collection of objects' do
+
+      let(:nested) { { 'key1' => 'foo', 'key2' => [{ 'key3' => 1 }] } }
+
+      it 'successfully converts the collection of objects keys to symbols' do
+        result = subject.symbolize!(nested)
+        expect(result.keys).to all(be_a(Symbol))
+        expect(result[:key2][0].keys).to all(be_a(Symbol))
+      end
+
+    end
+
+  end
+
+end

data/twitter-ads.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require File.expand_path('../lib/twitter-ads/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'twitter-ads'
+  s.version     = TwitterAds::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.authors     = ['Brandon Black']
+  s.email       = ['brandonmblack@gmail.com']
+  s.homepage    = 'https://github.com/twitterdev/twitter-ruby-ads-sdk'
+  s.description = 'The officially supported Twitter Ads API SDK for Ruby.'
+  s.summary     = s.description
+
+  s.required_ruby_version     = '>= 2.0.0'
+  s.required_rubygems_version = '>= 2.0.0'
+
+  if File.exist?('private.pem')
+    s.signing_key = 'private.pem'
+    s.cert_chain  = ['public.pem']
+  else
+    warn 'WARNING:  No private key present, creating unsigned gem.'
+  end
+
+  s.add_dependency 'multi_json', '~> 1.11'
+  s.add_dependency 'oauth', '~> 0.4'
+
+  s.add_development_dependency 'bundler', '~> 1.6'
+
+  s.files = Dir.glob('{bin,lib}/**/*')
+  s.files += %w(twitter-ads.gemspec LICENSE README.md CONTRIBUTING.md Rakefile)
+  s.test_files = Dir.glob('{spec,feature}/**/*')
+  s.executables = 'twitter-ads'
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: twitter-ads
+version: !ruby/object:Gem::Version
+  version: 0.3.4
+platform: ruby
+authors:
+- Brandon Black
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MQ8wDQYDVQQDDAZiYmxh
+  Y2sxFzAVBgoJkiaJk/IsZAEZFgd0d2l0dGVyMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE1MDUxNDIwMzE0OFoXDTE2MDUxMzIwMzE0OFowPzEPMA0GA1UEAwwGYmJs
+  YWNrMRcwFQYKCZImiZPyLGQBGRYHdHdpdHRlcjETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALFcA39CQg7YbcP8v2By
+  AzyhEpVlrxa2ohJ7LFmi8/Xw8cxS3/XvweWJuufambhfpT/KkUcf0FMA4egt3w8c
+  PYanwpUCyBnLCXsMvFWGBnyWQqVNSg6CKTVcY1urtCUSA3Jv5KKBPffSUoTOCL5E
+  uLD3BW9VnPS4Z9SOKzhg7c4aIr0siNBf0/AU0aiwtOhqgJpRkECcd5C74JdYTLdF
+  5Gdxzxifr50Em+lojr+hatfYZ51gOksPBtqotQ4l+vSth9JQB8jX1DOfHf/4LdGJ
+  Y7b9bOORAx4XPncn6VXlNH5YUVRu/pshNf5N0YbQUgXKMG/M0Drxv+VmHpxeg3Ep
+  MSsCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJdU
+  3qERWamEyBidCvO8vyO4Ofj8MB0GA1UdEQQWMBSBEmJibGFja0B0d2l0dGVyLmNv
+  bTAdBgNVHRIEFjAUgRJiYmxhY2tAdHdpdHRlci5jb20wDQYJKoZIhvcNAQEFBQAD
+  ggEBAAEqjpDTcLHBKDhqqSDMmW0gWQTYHBuyKAUuaEleE9fWBS+q9SIPmQSoj2yX
+  aqzkMmCvcTpiIoVlu2QtYvxtI6bef+HM50hkNjF+AeEyhTSucLxRmg232CzykGZa
+  sIuWL8AhyPmyLaIi5gsGXUIChk4aXcXE8iD/VGWyPZ3r8zV/EA8dTnT/iVYkxpTv
+  dUlOT1v22STyPF3Zttqqe5XtOtIN9+i3Szoi1OGueqSB9+XMZyinZoxherrs1BVH
+  8Jwp/juPnThUiQlA6qjWMlKQJW9Junn+gQJWm6jW/hR3klmk4uPIB+wxSW2J2K50
+  aU47pXYcbHgF3qfpEAXAq9qH06E=
+  -----END CERTIFICATE-----
+date: 2016-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: The officially supported Twitter Ads API SDK for Ruby.
+email:
+- brandonmblack@gmail.com
+executables:
+- twitter-ads
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/twitter-ads
+- lib/twitter-ads.rb
+- lib/twitter-ads/account.rb
+- lib/twitter-ads/audiences/tailored_audience.rb
+- lib/twitter-ads/campaign/app_list.rb
+- lib/twitter-ads/campaign/campaign.rb
+- lib/twitter-ads/campaign/funding_instrument.rb
+- lib/twitter-ads/campaign/line_item.rb
+- lib/twitter-ads/campaign/promotable_user.rb
+- lib/twitter-ads/campaign/targeting_criteria.rb
+- lib/twitter-ads/campaign/tweet.rb
+- lib/twitter-ads/client.rb
+- lib/twitter-ads/creative/app_download_card.rb
+- lib/twitter-ads/creative/image_app_download_card.rb
+- lib/twitter-ads/creative/image_conversation_card.rb
+- lib/twitter-ads/creative/lead_gen_card.rb
+- lib/twitter-ads/creative/promoted_account.rb
+- lib/twitter-ads/creative/promoted_tweet.rb
+- lib/twitter-ads/creative/video.rb
+- lib/twitter-ads/creative/video_app_download_card.rb
+- lib/twitter-ads/creative/video_conversation_card.rb
+- lib/twitter-ads/creative/website_card.rb
+- lib/twitter-ads/cursor.rb
+- lib/twitter-ads/enum.rb
+- lib/twitter-ads/error.rb
+- lib/twitter-ads/http/request.rb
+- lib/twitter-ads/http/response.rb
+- lib/twitter-ads/http/ton_upload.rb
+- lib/twitter-ads/legacy.rb
+- lib/twitter-ads/resources/analytics.rb
+- lib/twitter-ads/resources/dsl.rb
+- lib/twitter-ads/resources/persistence.rb
+- lib/twitter-ads/resources/resource.rb
+- lib/twitter-ads/targeting/reach_estimate.rb
+- lib/twitter-ads/utils.rb
+- lib/twitter-ads/version.rb
+- spec/fixtures/accounts_all.json
+- spec/fixtures/accounts_features.json
+- spec/fixtures/accounts_load.json
+- spec/fixtures/app_lists_all.json
+- spec/fixtures/app_lists_load.json
+- spec/fixtures/campaigns_all.json
+- spec/fixtures/campaigns_load.json
+- spec/fixtures/funding_instruments_all.json
+- spec/fixtures/funding_instruments_load.json
+- spec/fixtures/line_items_all.json
+- spec/fixtures/line_items_load.json
+- spec/fixtures/placements.json
+- spec/fixtures/promotable_users_all.json
+- spec/fixtures/promotable_users_load.json
+- spec/fixtures/promoted_tweets_all.json
+- spec/fixtures/promoted_tweets_load.json
+- spec/fixtures/reach_estimate.json
+- spec/fixtures/tailored_audiences_all.json
+- spec/fixtures/tailored_audiences_load.json
+- spec/fixtures/tweet_preview.json
+- spec/fixtures/videos_all.json
+- spec/fixtures/videos_load.json
+- spec/quality_spec.rb
+- spec/shared/properties.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/twitter-ads/account_spec.rb
+- spec/twitter-ads/audiences/tailored_audience_spec.rb
+- spec/twitter-ads/campaign/app_list_spec.rb
+- spec/twitter-ads/campaign/line_item_spec.rb
+- spec/twitter-ads/campaign/reach_estimate_spec.rb
+- 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/app_download_card_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/lead_gen_card_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/video_legacy_spec.rb
+- spec/twitter-ads/creative/video_spec.rb
+- spec/twitter-ads/creative/website_card_spec.rb
+- spec/twitter-ads/cursor_spec.rb
+- spec/twitter-ads/placements_spec.rb
+- spec/twitter-ads/utils_spec.rb
+- twitter-ads.gemspec
+homepage: https://github.com/twitterdev/twitter-ruby-ads-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: The officially supported Twitter Ads API SDK for Ruby.
+test_files:
+- spec/fixtures/accounts_all.json
+- spec/fixtures/accounts_features.json
+- spec/fixtures/accounts_load.json
+- spec/fixtures/app_lists_all.json
+- spec/fixtures/app_lists_load.json
+- spec/fixtures/campaigns_all.json
+- spec/fixtures/campaigns_load.json
+- spec/fixtures/funding_instruments_all.json
+- spec/fixtures/funding_instruments_load.json
+- spec/fixtures/line_items_all.json
+- spec/fixtures/line_items_load.json
+- spec/fixtures/placements.json
+- spec/fixtures/promotable_users_all.json
+- spec/fixtures/promotable_users_load.json
+- spec/fixtures/promoted_tweets_all.json
+- spec/fixtures/promoted_tweets_load.json
+- spec/fixtures/reach_estimate.json
+- spec/fixtures/tailored_audiences_all.json
+- spec/fixtures/tailored_audiences_load.json
+- spec/fixtures/tweet_preview.json
+- spec/fixtures/videos_all.json
+- spec/fixtures/videos_load.json
+- spec/quality_spec.rb
+- spec/shared/properties.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/twitter-ads/account_spec.rb
+- spec/twitter-ads/audiences/tailored_audience_spec.rb
+- spec/twitter-ads/campaign/app_list_spec.rb
+- spec/twitter-ads/campaign/line_item_spec.rb
+- spec/twitter-ads/campaign/reach_estimate_spec.rb
+- 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/app_download_card_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/lead_gen_card_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/video_legacy_spec.rb
+- spec/twitter-ads/creative/video_spec.rb
+- spec/twitter-ads/creative/website_card_spec.rb
+- spec/twitter-ads/cursor_spec.rb
+- spec/twitter-ads/placements_spec.rb
+- spec/twitter-ads/utils_spec.rb
+has_rdoc: