facebook_ads 0.6.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e3af59459c263bb4fa49981b02306356052e2be4
-  data.tar.gz: 8475d3922f3ba087e45259c4f7a27ed75c02af23
+SHA256:
+  metadata.gz: 5a7277800ac2a81f155ef378e2f5a0b78a85cf00c284ccb18c521b0288d6d467
+  data.tar.gz: 603886d3c551084d3b317fa18a0f55a9992113a7a29ae78bd8036490d56bd18c
 SHA512:
-  metadata.gz: 3869ae0fe2d04ede54ebe60459c23ca2bf20c48314b6e747c35806231cdb772c9f8c05338782cac1a3d1bb94431d41f4a3815c28b64e1dc5a320bede55225069
-  data.tar.gz: 7de25dfeccc8c06be316c301b38c35332f99a46f7b68708296b05f073f18e92e18114b3208cf2e357964880b3fdef4a0d8ffbdbc694429ba781a1f5399359be4
+  metadata.gz: c943be4095453ed6ef0da92ec2c8b1e542c92e0f10d898c958855f593e857c769697a36b0d0a6b168f8fa6ef7c47f616b84418807c0916b5dda447665130751b
+  data.tar.gz: 0ccc1ad73365c2791e1a58329265964d18c6af52fb1ffe85d3d95314971f3802ca716a2d6ca5403b7874882922ca2f2fe55c53104d9199f9e91ef1618489ad1c

data/.circleci/config.yml

@@ -0,0 +1,27 @@
+version: 2.1
+
+orbs:
+  aws-cli: circleci/aws-cli@1.2.1
+  ruby: circleci/ruby@1.1.0
+
+jobs:
+  test:
+    docker:
+      - image: circleci/ruby:2.7.0-node
+    executor: ruby/default
+    working_directory: ~/repo
+    environment:
+      APP_BUNDLER_VERSION: '2.1.2'
+    steps:
+      - checkout:
+          path: ~/repo
+      - ruby/install-deps:
+          with-cache: false
+      - ruby/rspec-test
+      - ruby/rubocop-check
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - test

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
+  NewCops: enable
 
 Metrics/AbcSize:
   Enabled: false
@@ -7,9 +8,6 @@ Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/PerceivedComplexity:
   Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
 Metrics/ClassLength:
   Enabled: false
 Metrics/MethodLength:
@@ -19,15 +17,18 @@ Metrics/BlockLength:
 Metrics/ParameterLists:
   Enabled: false
 
-Lint/EndAlignment:
+Layout/ElseAlignment:
   Enabled: false
-
-Layout/IndentationWidth:
+Layout/EndAlignment:
   Enabled: false
-Layout/ElseAlignment:
+Layout/RescueEnsureAlignment:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Layout/IndentationWidth:
   Enabled: false
 
 Style/Documentation:
   Enabled: false
-Style/GuardClause:
-  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+facebook-ruby-ads-sdk

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/CHANGELOG.md

@@ -1,27 +1,48 @@
+## 0.7.0 (2020-09-29)
+  - Add stubborn network call helpers.
+  - Update default version to v7.0.
+  - Switch from TravisCI to CircleCI.
+  - Remove coveralls.
+  - Require ruby 2.5+.
+  - Update Rubocop & fix warnings.
+
+## 0.6.11 (2020-02-28)
+  - Fixed memoization in `FacebookAds::Ad`.
+
+## 0.6.10 (2019-05-06)
+  - Set default version to 3.2.
+  - Removed `relevance_score` from the list of default fields in `AdInsight`.
+
+## 0.6.9 (2019-03-25)
+  - Added the following fields to `AdCreative`: `product_set_id` and `url_tags`. (#37, @cte)
+
+## 0.6.7 (2019-03-07)
+  - Added the following fields to `AdSet`: `attribution_spec`, `start_time` and `end_time`. (#36, @cte)
+
 ## 0.6.6 (2018-11-29)
-  - Added ability to pass date range when fetching `ad_set_activities`.
+  - Added ability to pass date range when fetching `ad_set_activities`. (#34, @amosharrafa)
 
 ## 0.6.5 (2018-11-26)
-  - Expose `ad_set_activities` for `ad_sets`.
+  - Expose `ad_set_activities` for `ad_sets`. (#31, @amosharrafa)
 
 ## 0.6.4 (2018-10-03)
-  - Expose `budget_remaining`, `daily_budget`, `lifetime_budget` for Ad Campaigns. These are needed when we have budgets at the Ad Campaign level and not at the Ad Set level.
+  - Expose `budget_remaining`, `daily_budget`, `lifetime_budget` for the `AdCampaign` object. You now have the option to set the budget ad the campaign level instead of the ad set level.
 
 ## 0.6.3 (2018-05-17)
-  - Replaced deprecated `is_autobid` with new `bid_strategy` field
+  - Replaced deprecated `is_autobid` with new `bid_strategy` field.
 
 ## 0.6.2 (2018-05-08)
-  - Set Product Catalog path to `/owned_product_catalogs` for API v2.11 compatibility
+  - Set Product Catalog path to `/owned_product_catalogs` for API v2.11 compatibility.
 
 ## 0.4 (2017-07-25)
- - Added ability to pass `bid_amount` parameter when creating ad sets
- - Ad Set `is_autobid` parameter now defaults to `nil` rather than `true`
+ - Added ability to pass `bid_amount` parameter when creating ad sets.
+ - Ad Set `is_autobid` parameter now defaults to `nil` rather than `true`.
 
 ## 0.3 (2017-07-24)
- - Added ability to pass `app_link` parameter with ad creatives
+ - Added ability to pass `app_link` parameter with ad creatives.
 
 ## 0.2 (2017-07-20)
- - Added ability to configure App Secret to be included with API requests
+ - Added ability to configure App Secret to be included with API requests.
 
 ## 0.1.12 (2017-05-25)
  - Added complete set of ad campaign objectives. (#9, @cte)

data/Gemfile

@@ -7,14 +7,14 @@ group :development, :test do
   gem 'awesome_print'
   gem 'pry'
   gem 'rake'
-  gem 'rubocop', '0.49.1'
+  gem 'rubocop'
 end
 
 group :test do
   gem 'approvals'
-  gem 'coveralls', require: false
   gem 'multi_json'
   gem 'rspec'
+  gem 'rspec_junit_formatter'
   gem 'vcr'
   gem 'webmock'
 end

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Tophatter, Inc.
+Copyright (c) 2020 Tophatter, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/facebook_ads.svg)](https://badge.fury.io/rb/facebook_ads)
-[![Build Status](https://travis-ci.org/tophatter/facebook-ruby-ads-sdk.svg?branch=master)](https://travis-ci.org/tophatter/facebook-ruby-ads-sdk)
-[![Coverage Status](https://coveralls.io/repos/github/tophatter/facebook-ruby-ads-sdk/badge.svg?branch=master)](https://coveralls.io/github/tophatter/facebook-ruby-ads-sdk?branch=master)
+[![Build Status](https://circleci.com/gh/tophatter/facebook-ruby-ads-sdk.svg?style=svg&circle-token=3fa538bc2aece310fdc07b82ce77d117758afb02)](https://circleci.com/gh/tophatter/facebook-ruby-ads-sdk)
 
 # [Facebook Marketing API](https://developers.facebook.com/docs/marketing-apis) SDK for Ruby
 
@@ -17,7 +16,7 @@ gem install facebook_ads
 Or, add the following to your Gemfile:
 
 ```ruby
-gem 'facebook_ads', '~> 0.1'
+gem 'facebook_ads', '~> 0.7'
 ```
 
 ## Permissions
@@ -36,10 +35,10 @@ FacebookAds.app_secret = '[YOUR_APP_SECRET]'
 
 ## API Version
 
-This gem currently uses v2.9 of the Marketing API (2.10 is released as of 7/18/2017). You can change the version as desired with the following:
+This gem currently defaults v3.2 of the Marketing API. You can change the version as desired with the following:
 
 ```ruby
-FacebookAds.base_uri = 'https://graph.facebook.com/v2.10'
+FacebookAds.base_uri = 'https://graph.facebook.com/[desired-version-here]'
 ```
 
 ## Console

data/bin/facebook_ads_console

@@ -19,7 +19,7 @@ rescue Errno::ENOENT
   puts 'Create a test_business_id file and add your Business ID to it.'
 end
 
-FacebookAds.logger = Logger.new(STDOUT)
+FacebookAds.logger = Logger.new($stdout)
 FacebookAds.logger.level = Logger::Severity::DEBUG
 
 require 'awesome_print'

data/facebook_ads.gemspec

@@ -1,12 +1,11 @@
-# -*- encoding: utf-8 -*-
 # frozen_string_literal: true
 
 # To publish the next version:
 # gem build facebook_ads.gemspec
-# gem push facebook_ads-0.6.6.gem
+# gem push facebook_ads-0.7.0.gem
 Gem::Specification.new do |s|
   s.name        = 'facebook_ads'
-  s.version     = '0.6.6'
+  s.version     = '0.7.0'
   s.platform    = Gem::Platform::RUBY
   s.licenses    = ['MIT']
   s.authors     = ['Chris Estreich']
@@ -17,10 +16,10 @@ Gem::Specification.new do |s|
 
   s.extra_rdoc_files = ['README.md']
 
-  s.required_ruby_version = '~> 2.0'
+  s.required_ruby_version = '>= 2.5'
 
+  s.add_dependency 'hashie'
   s.add_dependency 'rest-client', '>= 1.6'
-  s.add_dependency 'hashie', '~> 3.4'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/facebook_ads.rb

@@ -9,10 +9,31 @@ require 'openssl'
 
 # Internal requires.
 require 'facebook_ads/base'
-Dir[File.expand_path('../facebook_ads/*.rb', __FILE__)].each { |f| require f }
+require 'facebook_ads/account'
+require 'facebook_ads/ad_account'
+require 'facebook_ads/ad_audience'
+require 'facebook_ads/ad_campaign'
+require 'facebook_ads/ad_creative'
+require 'facebook_ads/ad_exception'
+require 'facebook_ads/ad_image'
+require 'facebook_ads/ad_insight'
+require 'facebook_ads/ad_product_catalog'
+require 'facebook_ads/ad_product_feed'
+require 'facebook_ads/ad_product'
+require 'facebook_ads/ad_set_activity'
+require 'facebook_ads/ad_set'
+require 'facebook_ads/ad_targeting'
+require 'facebook_ads/ad_user'
+require 'facebook_ads/ad'
+require 'facebook_ads/advertisable_application'
 
 # The primary namespace for this gem.
 module FacebookAds
+  REQUEST_HEADERS   = { accept: :json, accept_encoding: :identity }.freeze
+  RETRYABLE_ERRORS  = [RestClient::ExceptionWithResponse, Errno::ECONNRESET, Errno::ECONNREFUSED].freeze
+  RETRY_LIMIT       = 10
+  RECOVERABLE_CODES = [1, 2, 2601].freeze
+
   def self.logger=(logger)
     @logger = logger
   end
@@ -31,17 +52,16 @@ module FacebookAds
   end
 
   def self.base_uri
-    @base_uri = "https://graph.facebook.com/v#{api_version}" unless defined?(@base_uri)
-    @base_uri
+    @base_uri ||= "https://graph.facebook.com/v#{api_version}"
   end
 
   def self.api_version=(api_version)
     @api_version = api_version
+    @base_uri    = nil
   end
 
   def self.api_version
-    @api_version = '3.1' unless defined?(@api_version)
-    @api_version
+    @api_version ||= '7.0'
   end
 
   def self.access_token=(access_token)
@@ -71,4 +91,50 @@ module FacebookAds
   def self.business_id
     @business_id
   end
+
+  # Stubborn network calls.
+
+  def self.stubbornly(retry_limit: RETRY_LIMIT, recoverable_codes: RECOVERABLE_CODES, debug: false)
+    raise ArgumentError unless block_given?
+
+    response    = nil
+    retry_count = 0
+
+    loop do
+      response = yield
+      break
+    rescue *RETRYABLE_ERRORS => e
+      if e.is_a?(RestClient::ExceptionWithResponse)
+        error = begin
+          JSON.parse(e.response)
+        rescue JSON::ParserError
+          nil
+        end
+
+        code = error&.[]('code')
+        raise e if code && !recoverable_codes.include?(code)
+      end
+
+      raise e if retry_count >= retry_limit
+
+      retry_count += 1
+      wait = (retry_count**2) + 15 + (rand(15) * (retry_count + 1))
+      puts "retry ##{retry_count} will start in #{wait}s" if debug
+      sleep wait
+    end
+
+    response
+  end
+
+  def self.stubbornly_get(url, retry_limit: RETRY_LIMIT, recoverable_codes: RECOVERABLE_CODES, debug: false)
+    stubbornly(retry_limit: retry_limit, recoverable_codes: recoverable_codes, debug: debug) do
+      RestClient.get(url, REQUEST_HEADERS)
+    end
+  end
+
+  def self.stubbornly_post(url, payload, retry_limit: RETRY_LIMIT, recoverable_codes: RECOVERABLE_CODES, debug: false)
+    stubbornly(retry_limit: retry_limit, recoverable_codes: recoverable_codes, debug: debug) do
+      RestClient.post(url, payload, REQUEST_HEADERS)
+    end
+  end
 end

data/lib/facebook_ads/ad.rb

@@ -10,13 +10,13 @@ module FacebookAds
     # belongs_to ad_account
 
     def ad_account
-      @ad_set ||= AdAccount.find(account_id)
+      @ad_account ||= AdAccount.find(account_id)
     end
 
     # belongs_to ad_campaign
 
     def ad_campaign
-      @ad_set ||= AdCampaign.find(campaign_id)
+      @ad_campaign ||= AdCampaign.find(campaign_id)
     end
 
     # belongs_to ad_set

data/lib/facebook_ads/ad_account.rb

@@ -30,15 +30,15 @@ module FacebookAds
     end
 
     def create_ad_campaign(name:, objective:, status: 'ACTIVE')
-      raise Exception, "Objective must be one of: #{AdCampaign::OBJECTIVES.join(', ')}" unless AdCampaign::OBJECTIVES.include?(objective)
-      raise Exception, "Status must be one of: #{AdCampaign::STATUSES.join(', ')}" unless AdCampaign::STATUSES.include?(status)
+      raise ArgumentError, "Objective must be one of: #{AdCampaign::OBJECTIVES.join(', ')}" unless AdCampaign::OBJECTIVES.include?(objective)
+      raise ArgumentError, "Status must be one of: #{AdCampaign::STATUSES.join(', ')}" unless AdCampaign::STATUSES.include?(status)
       query = { name: name, objective: objective, status: status }
       result = AdCampaign.post("/#{id}/campaigns", query: query)
       AdCampaign.find(result['id'])
     end
 
     def create_dynamic_ad_campaign(name:, product_catalog_id:, status: 'ACTIVE')
-      raise Exception, "Status must be one of: #{AdCampaign::STATUSES.join(', ')}" unless AdCampaign::STATUSES.include?(status)
+      raise ArgumentError, "Status must be one of: #{AdCampaign::STATUSES.join(', ')}" unless AdCampaign::STATUSES.include?(status)
       query = { name: name, objective: 'PRODUCT_CATALOG_SALES', status: status, promoted_object: { product_catalog_id: product_catalog_id } }
       result = AdCampaign.post("/#{id}/campaigns", query: query)
       AdCampaign.find(result['id'])
@@ -73,7 +73,7 @@ module FacebookAds
       end.to_h
 
       response = AdImage.post("/#{id}/adimages", query: files)
-      files.values.each { |file| File.delete(file.path) }
+      files.each_value { |file| File.delete(file.path) }
       !response['images'].nil? ? ad_images(hashes: response['images'].map { |_key, hash| hash['hash'] }) : []
     end
 
@@ -84,8 +84,9 @@ module FacebookAds
     end
 
     def create_ad_creative(creative, creative_type: nil, carousel: false)
-      # Support old deprecated carousel param
+      # Support old deprecated carousel param.
       return create_carousel_ad_creative(creative) if carousel
+
       case creative_type
       when 'carousel'
         create_carousel_ad_creative(creative)
@@ -127,14 +128,11 @@ module FacebookAds
     end
 
     def reach_estimate(targeting:, optimization_goal:, currency: 'USD')
-      raise Exception, "Optimization goal must be one of: #{AdSet::OPTIMIZATION_GOALS.join(', ')}" unless AdSet::OPTIMIZATION_GOALS.include?(optimization_goal)
+      raise ArgumentError, "Optimization goal must be one of: #{AdSet::OPTIMIZATION_GOALS.join(', ')}" unless AdSet::OPTIMIZATION_GOALS.include?(optimization_goal)
 
       if targeting.is_a?(AdTargeting)
-        if targeting.validate!
-          targeting = targeting.to_hash
-        else
-          raise Exception, 'The provided targeting spec is not valid.'
-        end
+        raise ArgumentError, 'The provided targeting spec is not valid.' unless targeting.validate!
+        targeting = targeting.to_hash
       end
 
       query = {
@@ -147,14 +145,11 @@ module FacebookAds
     end
 
     def delivery_estimate(targeting:, optimization_goal:, currency: 'USD')
-      raise Exception, "Optimization goal must be one of: #{AdSet::OPTIMIZATION_GOALS.join(', ')}" unless AdSet::OPTIMIZATION_GOALS.include?(optimization_goal)
+      raise ArgumentError, "Optimization goal must be one of: #{AdSet::OPTIMIZATION_GOALS.join(', ')}" unless AdSet::OPTIMIZATION_GOALS.include?(optimization_goal)
 
       if targeting.is_a?(AdTargeting)
-        if targeting.validate!
-          targeting = targeting.to_hash
-        else
-          raise Exception, 'The provided targeting spec is not valid.'
-        end
+        raise ArgumentError, 'The provided targeting spec is not valid.' unless targeting.validate!
+        targeting = targeting.to_hash
       end
 
       query = {
@@ -172,12 +167,12 @@ module FacebookAds
       required = %i[name page_id link message assets call_to_action_type multi_share_optimized multi_share_end_card]
 
       unless (keys = required - creative.keys).length.zero?
-        raise Exception, "Creative is missing the following: #{keys.join(', ')}"
+        raise ArgumentError, "Creative is missing the following: #{keys.join(', ')}"
       end
 
-      raise Exception, "Creative call_to_action_type must be one of: #{AdCreative::CALL_TO_ACTION_TYPES.join(', ')}" unless AdCreative::CALL_TO_ACTION_TYPES.include?(creative[:call_to_action_type])
+      raise ArgumentError, "Creative call_to_action_type must be one of: #{AdCreative::CALL_TO_ACTION_TYPES.join(', ')}" unless AdCreative::CALL_TO_ACTION_TYPES.include?(creative[:call_to_action_type])
 
-      query = if creative[:product_set_id].present?
+      query = if creative[:product_set_id]
         AdCreative.product_set(
           name: creative[:name],
           page_id: creative[:page_id],
@@ -199,10 +194,10 @@ module FacebookAds
       required = %i[name page_id message link link_title image_hash call_to_action_type]
 
       unless (keys = required - creative.keys).length.zero?
-        raise Exception, "Creative is missing the following: #{keys.join(', ')}"
+        raise ArgumentError, "Creative is missing the following: #{keys.join(', ')}"
       end
 
-      raise Exception, "Creative call_to_action_type must be one of: #{AdCreative::CALL_TO_ACTION_TYPES.join(', ')}" unless AdCreative::CALL_TO_ACTION_TYPES.include?(creative[:call_to_action_type])
+      raise ArgumentError, "Creative call_to_action_type must be one of: #{AdCreative::CALL_TO_ACTION_TYPES.join(', ')}" unless AdCreative::CALL_TO_ACTION_TYPES.include?(creative[:call_to_action_type])
       query = AdCreative.photo(creative)
       result = AdCreative.post("/#{id}/adcreatives", query: query)
       AdCreative.find(result['id'])
@@ -212,7 +207,7 @@ module FacebookAds
       required = %i[name title body object_url link_url image_hash page_id]
 
       unless (keys = required - creative.keys).length.zero?
-        raise Exception, "Creative is missing the following: #{keys.join(', ')}"
+        raise ArgumentError, "Creative is missing the following: #{keys.join(', ')}"
       end
 
       query = AdCreative.link(creative)