facebook_ads 0.6.11 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9790d052561c68d2593248561f54290c95f66fd1b60461f7632c6a5e7434c507
-  data.tar.gz: 6b800749dd4f0377ec4d27f70a41b0a505b5e7e5d0fac55a8b6c716513a3ba33
+  metadata.gz: 5a7277800ac2a81f155ef378e2f5a0b78a85cf00c284ccb18c521b0288d6d467
+  data.tar.gz: 603886d3c551084d3b317fa18a0f55a9992113a7a29ae78bd8036490d56bd18c
 SHA512:
-  metadata.gz: c723883cb1995a6e1c076cf4ab98792bc847a343ea7ff6e29d723fd29d07d4dbeae5b727acf35d2744c9cd7a4275a10c59b59b2af4b141f3241e037534a8948e
-  data.tar.gz: a807df65c0693da9c43ca1b9e34b7b6dfc8702364a47828347e73bbbcb01c78a768b7b60f8b96448ac2c9fa73dcbde2f2e929a2f7d7b378afdebbb9f1eabbf65
+  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,3 +1,11 @@
+## 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`.
 

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.6'
+gem 'facebook_ads', '~> 0.7'
 ```
 
 ## Permissions

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

@@ -2,10 +2,10 @@
 
 # To publish the next version:
 # gem build facebook_ads.gemspec
-# gem push facebook_ads-0.6.10.gem
+# gem push facebook_ads-0.7.0.gem
 Gem::Specification.new do |s|
   s.name        = 'facebook_ads'
-  s.version     = '0.6.11'
+  s.version     = '0.7.0'
   s.platform    = Gem::Platform::RUBY
   s.licenses    = ['MIT']
   s.authors     = ['Chris Estreich']
@@ -16,7 +16,9 @@ Gem::Specification.new do |s|
 
   s.extra_rdoc_files = ['README.md']
 
-  s.add_dependency 'hashie', '~> 3.4'
+  s.required_ruby_version = '>= 2.5'
+
+  s.add_dependency 'hashie'
   s.add_dependency 'rest-client', '>= 1.6'
 
   s.files         = `git ls-files`.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.2' 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_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)

data/lib/facebook_ads/ad_audience.rb

@@ -14,13 +14,13 @@ module FacebookAds
     # actions
 
     def share(account_id)
-      query = {
-        share_with_object_id: account_id,
-        share_with_object_type: 'Account'
-      }
-      result = AdAccount.post("/#{id}/share_with_objects", query: query)
-      # result['success']
-      result # No idea what this response looks like.
+      AdAccount.post(
+        "/#{id}/share_with_objects",
+        query: {
+          share_with_object_id: account_id,
+          share_with_object_type: 'Account'
+        }
+      )
     end
   end
 end

data/lib/facebook_ads/ad_campaign.rb

@@ -59,10 +59,10 @@ module FacebookAds
       AdSet.paginate("/#{id}/adsets", query: { effective_status: effective_status, limit: limit })
     end
 
-    def create_ad_set(name:, promoted_object: {}, targeting:, daily_budget: nil, lifetime_budget: nil, end_time: nil, optimization_goal:, billing_event: 'IMPRESSIONS', status: 'ACTIVE', bid_strategy: nil, bid_amount: nil)
-      raise Exception, "Optimization goal must be one of: #{AdSet::OPTIMIZATION_GOALS.join(', ')}" unless AdSet::OPTIMIZATION_GOALS.include?(optimization_goal)
-      raise Exception, "Billing event must be one of: #{AdSet::BILLING_EVENTS.join(', ')}" unless AdSet::BILLING_EVENTS.include?(billing_event)
-      raise Exception, "Bid strategy must be one of: #{AdSet::BID_STRATEGIES.join(', ')}" unless AdSet::BID_STRATEGIES.include?(bid_strategy)
+    def create_ad_set(name:, targeting:, optimization_goal:, promoted_object: {}, daily_budget: nil, lifetime_budget: nil, end_time: nil, billing_event: 'IMPRESSIONS', status: 'ACTIVE', bid_strategy: nil, bid_amount: nil)
+      raise ArgumentError, "Optimization goal must be one of: #{AdSet::OPTIMIZATION_GOALS.join(', ')}" unless AdSet::OPTIMIZATION_GOALS.include?(optimization_goal)
+      raise ArgumentError, "Billing event must be one of: #{AdSet::BILLING_EVENTS.join(', ')}" unless AdSet::BILLING_EVENTS.include?(billing_event)
+      raise ArgumentError, "Bid strategy must be one of: #{AdSet::BID_STRATEGIES.join(', ')}" unless AdSet::BID_STRATEGIES.include?(bid_strategy)
 
       if targeting.is_a?(Hash)
         # NOP
@@ -83,9 +83,9 @@ module FacebookAds
         bid_amount: bid_amount
       }
 
-      if daily_budget && lifetime_budget
-        raise Exception 'Only one budget may be set between daily_budget and life_budget'
-      elsif daily_budget
+      raise ArgumentError 'Only one budget may be set between daily_budget and life_budget' if daily_budget && lifetime_budget
+
+      if daily_budget
         query[:daily_budget] = daily_budget
       elsif lifetime_budget
         query[:lifetime_budget] = lifetime_budget

data/lib/facebook_ads/ad_creative.rb

@@ -8,7 +8,7 @@ module FacebookAds
     CALL_TO_ACTION_TYPES = %w[SHOP_NOW INSTALL_MOBILE_APP USE_MOBILE_APP SIGN_UP DOWNLOAD BUY_NOW NO_BUTTON].freeze
 
     class << self
-      def photo(name:, page_id:, instagram_actor_id: nil, message:, link:, app_link: nil, link_title:, image_hash:, call_to_action_type:, link_description: nil)
+      def photo(name:, page_id:, message:, link:, link_title:, image_hash:, call_to_action_type:, instagram_actor_id: nil, app_link: nil, link_description: nil)
         object_story_spec = {
           'page_id' => page_id, # 300664329976860
           'instagram_actor_id' => instagram_actor_id, # 503391023081924
@@ -36,7 +36,7 @@ module FacebookAds
       end
 
       # https://developers.facebook.com/docs/marketing-api/guides/videoads
-      def carousel(name:, page_id:, instagram_actor_id: nil, link:, app_link: nil, message:, assets:, call_to_action_type:, multi_share_optimized:, multi_share_end_card:)
+      def carousel(name:, page_id:, link:, message:, assets:, call_to_action_type:, multi_share_optimized:, multi_share_end_card:, instagram_actor_id: nil, app_link: nil)
         object_story_spec = {
           'page_id' => page_id, # 300664329976860
           'instagram_actor_id' => instagram_actor_id, # 503391023081924

data/lib/facebook_ads/ad_exception.rb

@@ -5,6 +5,7 @@ module FacebookAds
     attr_reader :code, :title, :message
 
     def initialize(code:, title:, message:)
+      super(message)
       @code = code
       @title = title
       @message = message

data/lib/facebook_ads/ad_image.rb

@@ -8,7 +8,7 @@ module FacebookAds
 
     class << self
       def find(_id)
-        raise Exception, 'NOT IMPLEMENTED'
+        raise NotImplementedError
       end
     end
 
@@ -21,7 +21,7 @@ module FacebookAds
     end
 
     def update(_data)
-      raise Exception, 'NOT IMPLEMENTED'
+      raise NotImplementedError
     end
 
     def destroy

data/lib/facebook_ads/ad_insight.rb

@@ -10,16 +10,16 @@ module FacebookAds
 
     class << self
       def find(_id)
-        raise Exception, 'NOT IMPLEMENTED'
+        raise NotImplementedError
       end
     end
 
     def update(_data)
-      raise Exception, 'NOT IMPLEMENTED'
+      raise NotImplementedError
     end
 
     def destroy
-      raise Exception, 'NOT IMPLEMENTED'
+      raise NotImplementedError
     end
   end
 end

data/lib/facebook_ads/ad_set.rb

@@ -81,7 +81,7 @@ module FacebookAds
     # AdCampaign
 
     def ad_campaign
-      @campaign ||= AdCampaign.find(campaign_id)
+      @ad_campaign ||= AdCampaign.find(campaign_id)
     end
 
     # Ad

data/lib/facebook_ads/ad_targeting.rb

@@ -40,16 +40,14 @@ module FacebookAds
 
     def validate!
       { gender: genders, countries: countries, user_os: user_os, user_device: user_device, custom_locations: custom_locations }.each_pair do |key, array|
-        if !array.nil? && !array.is_a?(Array)
-          raise Exception, "#{self.class.name}: #{key} must be an array"
-        end
+        raise ArgumentError, "#{self.class.name}: #{key} must be an array" if !array.nil? && !array.is_a?(Array)
       end
 
       { genders: [genders, GENDERS], user_os: [user_os, OSES], user_device: [user_device, DEVICES] }.each_pair do |key, provided_and_acceptable|
         provided, acceptable = provided_and_acceptable
 
         if !provided.nil? && !(invalid = provided.detect { |value| !acceptable.include?(value) }).nil?
-          raise Exception, "#{self.class.name}: #{invalid} is an invalid #{key}"
+          raise ArgumentError, "#{self.class.name}: #{invalid} is an invalid #{key}"
         end
       end
 

data/lib/facebook_ads/base.rb

@@ -6,13 +6,13 @@ module FacebookAds
     class << self
       # HTTP verbs.
 
-      def get(path, query: {}, objectify:)
+      def get(path, objectify:, query: {})
         query = pack(query, objectify: objectify)
         uri = "#{FacebookAds.base_uri}#{path}?" + build_nested_query(query)
         FacebookAds.logger.debug "GET #{uri}"
 
         response = begin
-          RestClient.get(uri, accept: :json, accept_encoding: :identity)
+          RestClient.get(uri, FacebookAds::REQUEST_HEADERS)
         rescue RestClient::Exception => e
           exception(:get, path, e)
         end
@@ -116,19 +116,12 @@ module FacebookAds
       end
 
       def unpack(response, objectify:)
-        raise Exception, 'Invalid nil response' if response.nil?
+        raise ArgumentError, 'Invalid nil response' if response.nil?
         response = response.body if response.is_a?(RestClient::Response)
+        response = JSON.parse(response) if response.is_a?(String)
 
-        if response.is_a?(String)
-          response = begin
-            JSON.parse(response)
-          rescue JSON::ParserError
-            raise Exception, "Invalid JSON response: #{response.inspect}"
-          end
-        end
-
-        raise Exception, "Invalid response: #{response.class.name} #{response.inspect}" unless response.is_a?(Hash)
-        raise Exception, "[#{response['error']['code']}] #{response['error']['message']} - raw response: #{response.inspect}" unless response['error'].nil?
+        raise ArgumentError, "Invalid response: #{response.class.name} #{response.inspect}" unless response.is_a?(Hash)
+        raise ArgumentError, "[#{response['error']['code']}] #{response['error']['message']} - raw response: #{response.inspect}" unless response['error'].nil?
         return response unless objectify
 
         if response.key?('data') && (data = response['data']).is_a?(Array)
@@ -138,8 +131,8 @@ module FacebookAds
         end
       end
 
-      def escape(s)
-        URI.encode_www_form_component(s)
+      def escape(str)
+        URI.encode_www_form_component(str)
       end
 
       # https://github.com/rack/rack/blob/master/lib/rack/utils.rb
@@ -190,7 +183,7 @@ module FacebookAds
     def save
       return nil if changes.nil? || changes.length.zero?
       data = {}
-      changes.keys.each { |key| data[key] = self[key] }
+      changes.each_key { |key| data[key] = self[key] }
       return nil unless update(data)
       self.class.find(id)
     end

data/spec/facebook_ads/ad_account_spec.rb

@@ -70,19 +70,22 @@ describe FacebookAds::AdAccount do
   describe '.create_ad_creative' do
     it 'creates carousel ad creative', :vcr do
       ad_images = account.create_ad_images(%w[https://img0.etsystatic.com/108/1/13006112/il_570xN.1047856494_l2gp.jpg https://img1.etsystatic.com/143/0/13344107/il_570xN.1141249285_xciv.jpg])
-      carousel_ad_creative = account.create_ad_creative({
-                                                          name: 'Test Carousel Creative',
-                                                          page_id: '300664329976860', # Add your Facebook Page ID here.
-                                                          link: 'http://play.google.com/store/apps/details?id=com.tophatter', # Add your Play Store ID here.
-                                                          message: 'A message.',
-                                                          assets: [
-                                                            { hash: ad_images[0].hash, title: 'Image #1 Title' },
-                                                            { hash: ad_images[1].hash, title: 'Image #2 Title' }
-                                                          ],
-                                                          call_to_action_type: 'SHOP_NOW',
-                                                          multi_share_optimized: true,
-                                                          multi_share_end_card: false
-                                                        }, creative_type: 'carousel')
+      carousel_ad_creative = account.create_ad_creative(
+        {
+          name: 'Test Carousel Creative',
+          page_id: '300664329976860', # Add your Facebook Page ID here.
+          link: 'http://play.google.com/store/apps/details?id=com.tophatter', # Add your Play Store ID here.
+          message: 'A message.',
+          assets: [
+            { hash: ad_images[0].hash, title: 'Image #1 Title' },
+            { hash: ad_images[1].hash, title: 'Image #2 Title' }
+          ],
+          call_to_action_type: 'SHOP_NOW',
+          multi_share_optimized: true,
+          multi_share_end_card: false
+        },
+        creative_type: 'carousel'
+      )
       expect(carousel_ad_creative.id).to eq('120330000008134415')
     end
   end

data/spec/facebook_ads/ad_campaign_spec.rb

@@ -32,9 +32,6 @@ describe FacebookAds::AdCampaign do
     targeting
   end
 
-  xdescribe '.ad_sets' do
-  end
-
   describe '.create_ad_set' do
     it 'creates_valid_ad_set', :vcr do
       ad_set = campaign.create_ad_set(

data/spec/facebook_ads/facebook_ads_spec.rb

@@ -5,24 +5,64 @@ require 'spec_helper'
 # rspec spec/facebook_ads/facebook_ads_spec.rb
 describe FacebookAds do
   describe '#base_uri' do
-    it 'is currently v2.9' do
-      expect(FacebookAds.base_uri.include?('2.9')).to be_truthy
+    subject { FacebookAds.base_uri }
+
+    context 'when the version is not overridden' do
+      it { is_expected.to eq('https://graph.facebook.com/v2.9') }
     end
 
-    it 'can be set to v2.10' do
-      FacebookAds.base_uri = 'https://graph.facebook.com/v2.10'
-      expect(FacebookAds.base_uri.include?('2.10')).to be_truthy
+    context 'when the version is overridden' do
+      before { FacebookAds.api_version = '2.10' }
+      after { FacebookAds.api_version = '2.9' }
+
+      it { is_expected.to eq('https://graph.facebook.com/v2.10') }
     end
   end
 
   describe '#api_version' do
-    it 'is currently 2.9' do
-      expect(FacebookAds.api_version).to eq '2.9'
+    subject { FacebookAds.api_version }
+
+    context 'when the version is not overridden' do
+      it { is_expected.to eq('2.9') }
+    end
+
+    context 'when the version is overridden' do
+      before { FacebookAds.api_version = '2.10' }
+      after { FacebookAds.api_version = '2.9' }
+
+      it { is_expected.to eq('2.10') }
     end
+  end
+
+  describe '#stubbornly' do
+    subject { FacebookAds.stubbornly { true } }
+
+    it { is_expected.to eq(true) }
+  end
+
+  describe '#stubbornly_get', :vcr do
+    subject(:response) { FacebookAds.stubbornly_get('http://worldtimeapi.org/api/ip') }
+
+    let(:parsed_response) { JSON.parse(response) }
 
-    it 'can be set to 2.10' do
-      FacebookAds.api_version = '2.10'
-      expect(FacebookAds.api_version).to eq '2.10'
+    it 'executes the request for the provided url' do
+      expect(parsed_response).to eq(
+        'abbreviation' => 'AKDT',
+        'client_ip' => '66.58.139.118',
+        'datetime' => '2020-09-29T11:59:09.743279-08:00',
+        'day_of_week' => 2,
+        'day_of_year' => 273,
+        'dst' => true,
+        'dst_from' => '2020-03-08T11:00:00+00:00',
+        'dst_offset' => 3600,
+        'dst_until' => '2020-11-01T10:00:00+00:00',
+        'raw_offset' => -32_400,
+        'timezone' => 'America/Anchorage',
+        'unixtime' => 1_601_409_549,
+        'utc_datetime' => '2020-09-29T19:59:09.743279+00:00',
+        'utc_offset' => '-08:00',
+        'week_number' => 40
+      )
     end
   end
 end

data/spec/fixtures/cassettes/FacebookAds/_stubbornly_get/executes_the_request_for_the_provided_url.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://worldtimeapi.org/api/ip
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - identity
+      User-Agent:
+      - Ruby
+      Host:
+      - worldtimeapi.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - ''
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Length:
+      - '401'
+      Content-Type:
+      - application/json; charset=utf-8
+      Cross-Origin-Window-Policy:
+      - deny
+      Date:
+      - Tue, 29 Sep 2020 19:59:09 GMT
+      Server:
+      - Cowboy
+      X-Content-Type-Options:
+      - nosniff
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 28a7b795-69b3-423c-b539-08675ebfa8f9
+      X-Runtime:
+      - 16ms
+      X-Xss-Protection:
+      - 1; mode=block
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"abbreviation":"AKDT","client_ip":"66.58.139.118","datetime":"2020-09-29T11:59:09.743279-08:00","day_of_week":2,"day_of_year":273,"dst":true,"dst_from":"2020-03-08T11:00:00+00:00","dst_offset":3600,"dst_until":"2020-11-01T10:00:00+00:00","raw_offset":-32400,"timezone":"America/Anchorage","unixtime":1601409549,"utc_datetime":"2020-09-29T19:59:09.743279+00:00","utc_offset":"-08:00","week_number":40}'
+  recorded_at: Tue, 29 Sep 2020 19:59:09 GMT
+recorded_with: VCR 6.0.0

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'coveralls'
-Coveralls.wear!
-
 require 'awesome_print'
 require 'facebook_ads'
 
-Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))].each { |f| require f }
+Dir[File.expand_path('support/*.rb', __dir__)].sort.each { |f| require f }

data/spec/support/rest_client.rb

@@ -5,7 +5,7 @@
 module RestClient
   class Request
     def default_headers
-      { accept: 'application/json', accept_encoding: 'identity' }
+      FacebookAds::REQUEST_HEADERS
     end
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: facebook_ads
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.7.0
 platform: ruby
 authors:
 - Chris Estreich
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -47,11 +47,12 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".coveralls.yml"
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -81,16 +82,6 @@ files:
 - lib/facebook_ads/base.rb
 - spec/facebook_ads/ad_account_spec.rb
 - spec/facebook_ads/ad_campaign_spec.rb
-- spec/facebook_ads/ad_creative_spec.rb
-- spec/facebook_ads/ad_image_spec.rb
-- spec/facebook_ads/ad_insight_spec.rb
-- spec/facebook_ads/ad_product_catalog_spec.rb
-- spec/facebook_ads/ad_product_feed_spec.rb
-- spec/facebook_ads/ad_product_set_spec.rb
-- spec/facebook_ads/ad_product_spec.rb
-- spec/facebook_ads/ad_set_activity_spec.rb
-- spec/facebook_ads/ad_set_spec.rb
-- spec/facebook_ads/ad_spec.rb
 - spec/facebook_ads/ad_targeting_spec.rb
 - spec/facebook_ads/facebook_ads_spec.rb
 - spec/fixtures/approvals/facebookads_adaccount/ad_campaigns/lists_campaigns.approved.json
@@ -103,6 +94,7 @@ files:
 - spec/fixtures/approvals/facebookads_adaccount/create_ad_images/creates_an_image.approved.json
 - spec/fixtures/approvals/facebookads_adaccount/find_by/finds_a_specific_account.approved.json
 - spec/fixtures/approvals/facebookads_adaccount/reach_estimate/estimates_the_reach_of_a_targeting_spec.approved.json
+- spec/fixtures/cassettes/FacebookAds/_stubbornly_get/executes_the_request_for_the_provided_url.yml
 - spec/fixtures/cassettes/FacebookAds_AdAccount/_ad_campaigns/lists_campaigns.yml
 - spec/fixtures/cassettes/FacebookAds_AdAccount/_ad_creatives/lists_creatives.yml
 - spec/fixtures/cassettes/FacebookAds_AdAccount/_ad_images/lists_images.yml
@@ -125,7 +117,7 @@ homepage: https://github.com/tophatter/facebook-ruby-ads-sdk
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -141,22 +133,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Facebook Marketing API SDK for Ruby.
 test_files:
 - spec/facebook_ads/ad_account_spec.rb
 - spec/facebook_ads/ad_campaign_spec.rb
-- spec/facebook_ads/ad_creative_spec.rb
-- spec/facebook_ads/ad_image_spec.rb
-- spec/facebook_ads/ad_insight_spec.rb
-- spec/facebook_ads/ad_product_catalog_spec.rb
-- spec/facebook_ads/ad_product_feed_spec.rb
-- spec/facebook_ads/ad_product_set_spec.rb
-- spec/facebook_ads/ad_product_spec.rb
-- spec/facebook_ads/ad_set_activity_spec.rb
-- spec/facebook_ads/ad_set_spec.rb
-- spec/facebook_ads/ad_spec.rb
 - spec/facebook_ads/ad_targeting_spec.rb
 - spec/facebook_ads/facebook_ads_spec.rb
 - spec/fixtures/approvals/facebookads_adaccount/ad_campaigns/lists_campaigns.approved.json
@@ -169,6 +151,7 @@ test_files:
 - spec/fixtures/approvals/facebookads_adaccount/create_ad_images/creates_an_image.approved.json
 - spec/fixtures/approvals/facebookads_adaccount/find_by/finds_a_specific_account.approved.json
 - spec/fixtures/approvals/facebookads_adaccount/reach_estimate/estimates_the_reach_of_a_targeting_spec.approved.json
+- spec/fixtures/cassettes/FacebookAds/_stubbornly_get/executes_the_request_for_the_provided_url.yml
 - spec/fixtures/cassettes/FacebookAds_AdAccount/_ad_campaigns/lists_campaigns.yml
 - spec/fixtures/cassettes/FacebookAds_AdAccount/_ad_creatives/lists_creatives.yml
 - spec/fixtures/cassettes/FacebookAds_AdAccount/_ad_images/lists_images.yml

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
- - 2.3
-script:
-  - bundle exec rubocop
-  - bundle exec rake
-cache: bundler

data/spec/facebook_ads/ad_creative_spec.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::AdCreative do
-end

data/spec/facebook_ads/ad_image_spec.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::AdImage do
-end

data/spec/facebook_ads/ad_insight_spec.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::AdInsight do
-end

data/spec/facebook_ads/ad_product_catalog_spec.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::AdProductCatalog do
-  # def test_all
-  #   vcr do
-  #     catalog = FacebookAds::AdProductCatalog.all.first
-  #     assert_equal '197871307315718', catalog.id
-  #     assert_equal 'Test', catalog.name
-  #     assert_equal 'commerce', catalog.vertical
-  #     assert_equal 1, catalog.product_count
-  #     assert_equal 1, catalog.feed_count
-  #   end
-  # end
-  #
-  # def test_create
-  #   vcr do
-  #     catalog = FacebookAds::AdProductCatalog.create(name: 'Foo Bar')
-  #     assert_equal 'Foo Bar', catalog.name
-  #     assert_equal 'commerce', catalog.vertical
-  #     assert_equal 0, catalog.product_count
-  #     assert_equal 0, catalog.feed_count
-  #     catalog = FacebookAds::AdProductCatalog.find(catalog.id)
-  #     assert_equal true, catalog.destroy
-  #     assert_nil FacebookAds::AdProductCatalog.find_by(name: 'Foo Bar')
-  #   end
-  # end
-end

data/spec/facebook_ads/ad_product_feed_spec.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::AdProductFeed do
-end

data/spec/facebook_ads/ad_product_set_spec.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::AdProductSet do
-end

data/spec/facebook_ads/ad_product_spec.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::AdProduct do
-  # def test_list
-  #   vcr do
-  #     catalog = FacebookAds::AdProductCatalog.find_by(name: 'Test')
-  #     products = catalog.ad_products
-  #     product = products.first
-  #     assert_equal '1489112071104048', product.id
-  #     assert_equal 'retro-ruby-earrings', product.retailer_id
-  #     assert_equal 'Precious Retro .925 Sterling Silver Artificial Ruby Earrings', product.name
-  #     assert_equal '$5 shipping - at your doorstep within 25-27 business days.', product.description
-  #     assert_equal 'Adoration-Precious', product.brand
-  #     assert_equal 'Jewelry | Earrings', product.category
-  #     assert_equal 'USD', product.currency
-  #     assert_equal '$156.00', product.price
-  #     assert_equal 'https://external.xx.fbcdn.net/safe_image.php?d=AQALnOfu1mhkpb4T&url=https%3A%2F%2Fd38eepresuu519.cloudfront.net%2F12c85243d743ac3cb21b71c34192b252%2Flarge.jpg&cfs=1&_nc_hash=AQBlxlDCq59tO6sE', product.image_url
-  #     assert_equal 'https://tophatter.com/lots/23275728', product.url
-  #   end
-  # end
-end

data/spec/facebook_ads/ad_set_activity_spec.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::AdSetActivity do
-end

data/spec/facebook_ads/ad_set_spec.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::AdSet do
-  # def test_create
-  #   vcr do
-  #     ad_campaign = FacebookAds::AdCampaign.find('6069436026057')
-  #     ad_set = ad_campaign.create_ad_set(
-  #       name: 'Test',
-  #       promoted_object: {
-  #         pixel_id: '1472889202927380',
-  #         custom_event_type: 'PURCHASE'
-  #       },
-  #       targeting: {
-  #         age_max: 65,
-  #         age_min: 18,
-  #         app_install_state: 'not_installed',
-  #         excluded_custom_audiences: [{ "name"=>"All-Users-2016-07-28", "id"=>"6068994792257" }],
-  #         genders: [2],
-  #         geo_locations: { countries: %w(US), location_types: %w(home recent) },
-  #         locales: [24, 6],
-  #         publisher_platforms: %w(facebook instagram audience_network),
-  #         device_platforms: %w(desktop),
-  #         facebook_positions: %w(feed right_hand_column)
-  #       },
-  #       daily_budget: 1000,
-  #       optimization_goal: 'OFFSITE_CONVERSIONS'
-  #     )
-  #     assert_equal '6081945233457', ad_set.id
-  #     assert_equal '1000', ad_set.daily_budget
-  #     assert_equal 'OFFSITE_CONVERSIONS', ad_set.optimization_goal
-  #   end
-  # end
-  #
-  # def test_update
-  #   vcr do
-  #     ad_set = FacebookAds::AdSet.find('6078462927057')
-  #     assert ad_set.update(daily_budget: 149900)
-  #   end
-  # end
-  #
-  # def test_destroy
-  #   vcr do
-  #     ad_set = FacebookAds::AdSet.find('6081945233457')
-  #     assert ad_set.destroy
-  #   end
-  # end
-end

data/spec/facebook_ads/ad_spec.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe FacebookAds::Ad do
-end