facebook_ads 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 103ab340673c4ae87c97e894fa6f6c2dbe3a02c5
-  data.tar.gz: 8db58b179cd4f38150e630b9e2edc87dd5d47890
+  metadata.gz: 35a61cb9e965397a7e50da136ce697ed6ea3437e
+  data.tar.gz: ce5c09cf7acd43f39b0aa8f82d87d3a21962d50e
 SHA512:
-  metadata.gz: 12c9e8bd1be33b94c4cbd339dc149376d30daf1fd6731bfea6e2621343b2d168224c79194c9f59e42d3cb20ebe04889666e9846d2606266a62ffd54622f30460
-  data.tar.gz: 3766749dcfa84ea4c87b47a36340f7095eb9b49660b23abc90d630230f9f8b6144d24e5823a90fec1a1a823d716240391311d3dbb2dc0cafa63f41d58c55afad
+  metadata.gz: 1ad4ac70297f77209589c34323fd9af60d5721e8824cd2b3380e9a320c89de7124b45dd7a1133be489a362a631d35a873e00f059e10c2b9835231eae7f41f9c1
+  data.tar.gz: 365dda2ba4b84cdc4d7d86ca95ba1ccfdfd399dbc34664c2aa800cbba44b2cd41d3e181989653b03dc7821a9071dda4ef96f1b25f947aa71b7fd3861e1d8c236

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.3
 
 Metrics/AbcSize:
   Enabled: false
@@ -22,17 +22,12 @@ Metrics/ParameterLists:
 Lint/EndAlignment:
   Enabled: false
 
-Style/Documentation:
+Layout/IndentationWidth:
   Enabled: false
-Style/IndentationWidth:
+Layout/ElseAlignment:
   Enabled: false
-Style/ElseAlignment:
+
+Style/Documentation:
   Enabled: false
 Style/GuardClause:
   Enabled: false
-Style/NumericLiterals:
-  Enabled: false
-
-# This is temporary - it can be remove after updating rubocop to the latest.
-Style/PercentLiteralDelimiters:
-  Enabled: false

data/.travis.yml

@@ -1,9 +1,6 @@
 language: ruby
 rvm:
- - 2.2
-# branches:
-#   only:
-#     - master
+ - 2.3
 script:
   - bundle exec rubocop
   - bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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.
+
 ## 0.6.3 (2018-05-17)
   - Replaced deprecated `is_autobid` with new `bid_strategy` field
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
 
@@ -5,7 +7,7 @@ group :development, :test do
   gem 'awesome_print'
   gem 'pry'
   gem 'rake'
-  gem 'rubocop', '0.49.0'
+  gem 'rubocop', '0.49.1'
 end
 
 group :test do

data/README.md

@@ -49,7 +49,7 @@ It reads the Access Token from a file called test_access_token.
 
 ```bash
 echo [YOUR_ACCESS_TOKEN] > test_access_token
-bin/console
+bin/facebook_ads_console
 ```
 
 ## Usage Examples
@@ -230,9 +230,9 @@ image_ad_creative = account.create_ad_creative({
 Create a single creative for a web link:
 ```ruby
 image_ad_creative = account.create_ad_creative({
-  title: 'Test Link Title', 
-  body: 'Link Description Text', 
-  object_url: 'www.example.com/my-ad-link', 
+  title: 'Test Link Title',
+  body: 'Link Description Text',
+  object_url: 'www.example.com/my-ad-link',
   link_url: 'www.example.com/my-ad-link',
   image_hash: ad_images.first.hash,
 }, creative_type: 'link')

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec

data/bin/{console → facebook_ads_console}

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'facebook_ads'

data/facebook_ads.gemspec

@@ -1,11 +1,12 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 # To publish the next version:
 # gem build facebook_ads.gemspec
-# gem push facebook_ads-0.6.2.gem
+# gem push facebook_ads-0.6.4.gem
 Gem::Specification.new do |s|
   s.name        = 'facebook_ads'
-  s.version     = '0.6.3'
+  s.version     = '0.6.4'
   s.platform    = Gem::Platform::RUBY
   s.licenses    = ['MIT']
   s.authors     = ['Chris Estreich']

data/lib/facebook_ads.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # External requires.
 require 'json'
 require 'rest-client'
@@ -38,7 +40,7 @@ module FacebookAds
   end
 
   def self.api_version
-    @api_version = '2.9' unless defined?(@api_version)
+    @api_version = '3.1' unless defined?(@api_version)
     @api_version
   end
 
@@ -59,11 +61,7 @@ module FacebookAds
   end
 
   def self.appsecret_proof
-    OpenSSL::HMAC.hexdigest(
-      OpenSSL::Digest.new('sha256'),
-      @app_secret,
-      @access_token
-    )
+    OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @app_secret, @access_token)
   end
 
   def self.business_id=(business_id)

data/lib/facebook_ads/account.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FacebookAds
+  class Account < Base
+    FIELDS = %w[].freeze
+
+    class << self
+      def all(query = {})
+        get('/me/accounts', query: query, objectify: true)
+      end
+    end
+  end
+end

data/lib/facebook_ads/ad.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # An ad belongs to an ad set. It is created using an ad creative.
   # https://developers.facebook.com/docs/marketing-api/reference/adgroup

data/lib/facebook_ads/ad_account.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 module FacebookAds
-  # An ad account has many ad campaigns, ad images, and ad creatives.
   # https://developers.facebook.com/docs/marketing-api/reference/ad-account
   class AdAccount < Base
     FIELDS = %w[id account_id account_status age created_time currency name].freeze
@@ -8,17 +9,21 @@ module FacebookAds
       def all(query = {})
         get('/me/adaccounts', query: query, objectify: true)
       end
+    end
 
-      def find_by(conditions)
-        all.detect do |object|
-          conditions.all? do |key, value|
-            object.send(key) == value
-          end
-        end
-      end
+    # AdvertisableApplication
+
+    def advertisable_applications(limit: 100)
+      AdvertisableApplication.paginate("/#{id}/advertisable_applications", query: { limit: limit })
+    end
+
+    # AdUser
+
+    def ad_users(limit: 100)
+      AdCampaign.paginate("/#{id}/users", query: { limit: limit })
     end
 
-    # has_many campaigns
+    # AdCampaign
 
     def ad_campaigns(effective_status: ['ACTIVE'], limit: 100)
       AdCampaign.paginate("/#{id}/campaigns", query: { effective_status: effective_status, limit: limit })
@@ -39,7 +44,19 @@ module FacebookAds
       AdCampaign.find(result['id'])
     end
 
-    # has_many ad_images
+    # AdSet
+
+    def ad_sets(effective_status: ['ACTIVE'], limit: 100)
+      AdSet.paginate("/#{id}/adsets", query: { effective_status: effective_status, limit: limit })
+    end
+
+    # Ad
+
+    def ads(effective_status: ['ACTIVE'], limit: 100)
+      Ad.paginate("/#{id}/ads", query: { effective_status: effective_status, limit: limit })
+    end
+
+    # AdImage
 
     def ad_images(hashes: nil, limit: 100)
       if !hashes.nil?
@@ -60,7 +77,7 @@ module FacebookAds
       !response['images'].nil? ? ad_images(hashes: response['images'].map { |_key, hash| hash['hash'] }) : []
     end
 
-    # has_many ad_creatives
+    # AdCreative
 
     def ad_creatives(limit: 100)
       AdCreative.paginate("/#{id}/adcreatives", query: { limit: limit })
@@ -81,25 +98,27 @@ module FacebookAds
       end
     end
 
-    # has_many ad_sets
-
-    def ad_sets(effective_status: ['ACTIVE'], limit: 100)
-      AdSet.paginate("/#{id}/adsets", query: { effective_status: effective_status, limit: limit })
-    end
-
-    # has_many ads
+    # AdAudience
 
-    def ads(effective_status: ['ACTIVE'], limit: 100)
-      Ad.paginate("/#{id}/ads", query: { effective_status: effective_status, limit: limit })
+    def ad_audiences(limit: 100)
+      AdAudience.paginate("/#{id}/customaudiences", query: { limit: limit })
     end
 
-    # has_many ad_audiences
+    def create_ad_audience_with_pixel(name:, pixel_id:, event_name:, subtype: 'WEBSITE', retention_days: 15)
+      query = {
+        name: name,
+        pixel_id: pixel_id,
+        subtype: subtype,
+        retention_days: retention_days,
+        rule: { event: { i_contains: event_name } }.to_json,
+        prefill: 1
+      }
 
-    def ad_audiences
-      AdAudience.paginate("/#{id}/customaudiences")
+      result = AdAudience.post("/#{id}/customaudiences", query: query)
+      AdAudience.find(result['id'])
     end
 
-    # has_many ad_insights
+    # AdInsight
 
     def ad_insights(range: Date.today..Date.today, level: 'ad', time_increment: 1)
       ad_campaigns.map do |ad_campaign|
@@ -123,6 +142,7 @@ module FacebookAds
         optimize_for: optimization_goal,
         currency: currency
       }
+
       self.class.get("/#{id}/reachestimate", query: query, objectify: false)
     end
 
@@ -142,29 +162,8 @@ module FacebookAds
         optimization_goal: optimization_goal,
         currency: currency
       }
-      self.class.get("/#{id}/delivery_estimate", query: query, objectify: false)
-    end
-
-    # has_many applications
-
-    def applications
-      self.class.get("/#{id}/advertisable_applications", objectify: false)
-    end
-
-    # hash_many ad_audiences
-
-    def create_ad_audience_with_pixel(name:, pixel_id:, event_name:, subtype: 'WEBSITE', retention_days: 15)
-      query = {
-        name: name,
-        pixel_id: pixel_id,
-        subtype: subtype,
-        retention_days: retention_days,
-        rule: { event: { i_contains: event_name } }.to_json,
-        prefill: 1
-      }
 
-      result = AdAudience.post("/#{id}/customaudiences", query: query)
-      AdAudience.find(result['id'])
+      self.class.get("/#{id}/delivery_estimate", query: query, objectify: false)
     end
 
     private

data/lib/facebook_ads/ad_audience.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # https://developers.facebook.com/docs/marketing-api/reference/custom-audience
   class AdAudience < Base

data/lib/facebook_ads/ad_campaign.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 module FacebookAds
-  # An ad campaign has many ad sets and belongs to an ad account.
   # https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group
   class AdCampaign < Base
     FIELDS = %w[
@@ -15,6 +16,7 @@ module FacebookAds
       start_time
       stop_time
       updated_time spend_cap
+      budget_remaining daily_budget lifetime_budget
     ].freeze
 
     STATUSES = %w[
@@ -45,13 +47,13 @@ module FacebookAds
       VIDEO_VIEWS
     ].freeze
 
-    # belongs_to ad_account
+    # AdAccount
 
     def ad_account
       @ad_account ||= AdAccount.find("act_#{account_id}")
     end
 
-    # has_many ad_sets
+    # AdSet
 
     def ad_sets(effective_status: ['ACTIVE'], limit: 100)
       AdSet.paginate("/#{id}/adsets", query: { effective_status: effective_status, limit: limit })
@@ -94,7 +96,7 @@ module FacebookAds
       AdSet.find(result['id'])
     end
 
-    # has_many ad_insights
+    # AdInsight
 
     def ad_insights(range: Date.today..Date.today, level: 'ad', time_increment: 1)
       query = {
@@ -102,6 +104,7 @@ module FacebookAds
         time_increment: time_increment,
         time_range: { since: range.first.to_s, until: range.last.to_s }
       }
+
       AdInsight.paginate("/#{id}/insights", query: query)
     end
   end

data/lib/facebook_ads/ad_creative.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # Ad ad creative has many ad images and belongs to an ad account.
   # https://developers.facebook.com/docs/marketing-api/reference/ad-creative

data/lib/facebook_ads/ad_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FacebookAds
   class AdException < StandardError
     attr_reader :code, :title, :message

data/lib/facebook_ads/ad_image.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 module FacebookAds
-  # An ad image belongs to an ad account.
   # An image will always produce the same hash.
   # https://developers.facebook.com/docs/marketing-api/reference/ad-image
   class AdImage < Base
@@ -11,10 +12,10 @@ module FacebookAds
       end
     end
 
-    # @TODO:
-    # You are setting a key that conflicts with a built-in method FacebookAds::AdImage#hash defined in Hash.
-    # This can cause unexpected behavior when accessing the key via as a property.
-    # You can still access the key via the #[] method.
+    # @FIXME: You are setting a key that conflicts with a built-in method
+    # FacebookAds::AdImage#hash defined in Hash.
+    disable_warnings
+
     def hash
       self[:hash]
     end

data/lib/facebook_ads/ad_insight.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # Ad insights exist for ad accounts, ad campaigns, ad sets, and ads.
   # A lot more can be done here.

data/lib/facebook_ads/ad_product.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # https://developers.facebook.com/docs/marketing-api/reference/product-item
   class AdProduct < Base

data/lib/facebook_ads/ad_product_catalog.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # https://developers.facebook.com/docs/marketing-api/reference/product-catalog
   class AdProductCatalog < Base
@@ -8,14 +10,6 @@ module FacebookAds
         get("/#{FacebookAds.business_id}/owned_product_catalogs", query: query, objectify: true)
       end
 
-      def find_by(conditions)
-        all.detect do |object|
-          conditions.all? do |key, value|
-            object.send(key) == value
-          end
-        end
-      end
-
       def create(name:)
         query = { name: name }
         result = post("/#{FacebookAds.business_id}/owned_product_catalogs", query: query)

data/lib/facebook_ads/ad_product_feed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # https://developers.facebook.com/docs/marketing-api/reference/product-feed
   class AdProductFeed < Base

data/lib/facebook_ads/ad_product_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # https://developers.facebook.com/docs/marketing-api/reference/product-set
   class AdProductSet < Base

data/lib/facebook_ads/ad_set.rb

@@ -1,38 +1,45 @@
+# frozen_string_literal: true
+
 module FacebookAds
-  # An ad set belongs to a campaign and has many ads.
-  # https://developers.facebook.com/docs/marketing-api/reference/ad-campaign
+  # https://developers.facebook.com/docs/marketing-api/reference/ad-account/adsets
   class AdSet < Base
-    # Full set of fields:
-    # FIELDS = %w(
-    #   id account_id adlabels adset_schedule attribution_window_days
-    #   bid_amount bid_info billing_event budget_remaining
-    #   campaign campaign_id configured_status created_time
-    #   creative_sequence daily_budget effective_status end_time
-    #   frequency_cap frequency_cap_reset_period
-    #   frequency_control_specs instagram_actor_id
-    #   bid_strategy lifetime_budget
-    #   lifetime_frequency_cap lifetime_imps name optimization_goal
-    #   pacing_type promoted_object recommendations
-    #   recurring_budget_semantics rf_prediction_id rtb_flag
-    #   start_time status targeting time_based_ad_rotation_id_blocks
-    #   time_based_ad_rotation_intervals updated_time
-    #   use_new_app_click
-    # ).freeze
-
-    # Fields we might actually care about:
     FIELDS = %w[
-      id account_id campaign_id
+      id
+      account_id
+      campaign_id
       name
-      status configured_status effective_status
-      bid_strategy bid_amount billing_event optimization_goal pacing_type
-      daily_budget budget_remaining lifetime_budget
+      status
+      configured_status
+      effective_status
+      bid_strategy
+      bid_amount
+      billing_event
+      optimization_goal
+      pacing_type
+      daily_budget
+      budget_remaining
+      lifetime_budget
       promoted_object
       targeting
-      created_time updated_time
+      created_time
+      updated_time
     ].freeze
 
-    STATUSES           = %w[ACTIVE PAUSED DELETED PENDING_REVIEW DISAPPROVED PREAPPROVED PENDING_BILLING_INFO CAMPAIGN_PAUSED ARCHIVED ADSET_PAUSED].freeze
-    BILLING_EVENTS     = %w[APP_INSTALLS IMPRESSIONS].freeze
+    STATUSES = %w[
+      ACTIVE
+      PAUSED
+      DELETED
+      PENDING_REVIEW
+      DISAPPROVED
+      PREAPPROVED
+      PENDING_BILLING_INFO
+      CAMPAIGN_PAUSED
+      ARCHIVED
+      ADSET_PAUSED
+    ].freeze
+
+    BILLING_EVENTS = %w[APP_INSTALLS IMPRESSIONS].freeze
+
     OPTIMIZATION_GOALS = %w[
       NONE
       APP_INSTALLS
@@ -55,25 +62,26 @@ module FacebookAds
       APP_DOWNLOADS
       LANDING_PAGE_VIEWS
     ].freeze
+
     BID_STRATEGIES = %w[
       LOWEST_COST_WITHOUT_CAP
       LOWEST_COST_WITH_BID_CAP
       TARGET_COST
     ].freeze
 
-    # belongs_to ad_account
+    # AdAccount
 
     def ad_account
       @ad_account ||= AdAccount.find("act_#{account_id}")
     end
 
-    # belongs_to ad_campaign
+    # AdCampaign
 
     def ad_campaign
       @campaign ||= AdCampaign.find(campaign_id)
     end
 
-    # has_many ads
+    # Ad
 
     def ads(effective_status: ['ACTIVE'], limit: 100)
       Ad.paginate("/#{id}/ads", query: { effective_status: effective_status, limit: limit })
@@ -84,5 +92,21 @@ module FacebookAds
       result = Ad.post("/act_#{account_id}/ads", query: query)
       Ad.find(result['id'])
     end
+
+    # AdInsight
+
+    # levels = enum {ad, adset, campaign, account}
+    # breakdowns = list<enum {..., product_id, ...}>
+    def ad_insights(range: Date.today..Date.today, level: nil, breakdowns: [], fields: [], limit: 1_000)
+      query = {
+        time_range: { since: range.first.to_s, until: range.last.to_s },
+        level: level,
+        breakdowns: breakdowns&.join(','),
+        fields: fields&.join(','),
+        limit: limit
+      }.reject { |_key, value| value.nil? || (value.respond_to?(:empty?) && value.empty?) }
+
+      AdInsight.paginate("/#{id}/insights", query: query)
+    end
   end
 end

data/lib/facebook_ads/ad_targeting.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # https://developers.facebook.com/docs/marketing-api/targeting-specs
   class AdTargeting
     MEN                = 1
     WOMEN              = 2
     GENDERS            = [MEN, WOMEN].freeze
-    ANDROID_OS         = 'Android'.freeze
-    APPLE_OS           = 'iOS'.freeze
+    ANDROID_OS         = 'Android'
+    APPLE_OS           = 'iOS'
     OSES               = [ANDROID_OS, APPLE_OS].freeze
     ANDROID_DEVICES    = %w[Android_Smartphone Android_Tablet].freeze
     APPLE_DEVICES      = %w[iPhone iPad iPod].freeze
     DEVICES            = ANDROID_DEVICES + APPLE_DEVICES
-    INSTALLED          = 'installed'.freeze
-    NOT_INSTALLED      = 'not_installed'.freeze
+    INSTALLED          = 'installed'
+    NOT_INSTALLED      = 'not_installed'
     APP_INSTALL_STATES = [INSTALLED, NOT_INSTALLED].freeze
 
     attr_accessor :genders, :age_min, :age_max, :countries, :user_os, :user_device, :app_install_state, :custom_locations, :income

data/lib/facebook_ads/ad_user.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FacebookAds
+  # An ad user belongs to an ad account.
+  # https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group
+  class AdUser < Base
+    FIELDS = %w[].freeze
+
+    # belongs_to ad_account
+
+    def ad_account
+      @ad_account ||= AdAccount.find("act_#{account_id}")
+    end
+  end
+end

data/lib/facebook_ads/advertisable_application.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FacebookAds
+  # https://developers.facebook.com/docs/marketing-api/reference/ad-account/advertisable_applications
+  class AdvertisableApplication < Base
+    FIELDS = %w[].freeze
+
+    # belongs_to ad_account
+
+    def ad_account
+      @ad_account ||= AdAccount.find("act_#{account_id}")
+    end
+  end
+end

data/lib/facebook_ads/base.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module FacebookAds
   # The base class for all ads objects.
   class Base < Hashie::Mash
     class << self
-      def find(id)
-        get("/#{id}", objectify: true)
-      end
+      # HTTP verbs.
 
       def get(path, query: {}, objectify:)
-        query = pack(query, objectify: objectify) # Adds access token, fields, etc.
+        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)
         rescue RestClient::Exception => e
           exception(:get, path, e)
         end
+
         unpack(response, objectify: objectify)
       end
 
@@ -22,11 +24,13 @@ module FacebookAds
         query = pack(query, objectify: false)
         uri = "#{FacebookAds.base_uri}#{path}"
         FacebookAds.logger.debug "POST #{uri} #{query}"
+
         response = begin
           RestClient.post(uri, query)
         rescue RestClient::Exception => e
           exception(:post, path, e)
         end
+
         unpack(response, objectify: false)
       end
 
@@ -34,28 +38,50 @@ module FacebookAds
         query = pack(query, objectify: false)
         uri = "#{FacebookAds.base_uri}#{path}?" + build_nested_query(query)
         FacebookAds.logger.debug "DELETE #{uri}"
+
         response = begin
           RestClient.delete(uri)
         rescue RestClient::Exception => e
           exception(:delete, path, e)
         end
+
         unpack(response, objectify: false)
       end
 
+      # Common idioms.
+
+      def all(_query = {})
+        raise StandardError, 'Subclass must implement `all`.'
+      end
+
+      def find(id)
+        get("/#{id}", objectify: true)
+      end
+
+      def find_by(conditions)
+        all.detect do |object|
+          conditions.all? do |key, value|
+            object.send(key) == value
+          end
+        end
+      end
+
       def paginate(path, query: {})
-        query[:limit] ||= 100
-        limit = query[:limit]
-        response = get(path, query: query.merge(fields: self::FIELDS.join(',')), objectify: false)
-        data = response['data'].nil? ? [] : response['data']
+        query    = query.merge(limit: 100) unless query[:limit]
+        query    = query.merge(fields: self::FIELDS.join(',')) unless query[:fields] || self::FIELDS.empty?
+        response = get(path, query: query, objectify: false)
+        data     = response['data'].nil? ? [] : response['data']
 
-        if data.length == limit
+        if data.length == query[:limit]
           while !(paging = response['paging']).nil? && !(url = paging['next']).nil?
             FacebookAds.logger.debug "GET #{url}"
+
             response = begin
               RestClient.get(url)
             rescue RestClient::Exception => e
               exception(:get, url, e)
             end
+
             response = unpack(response, objectify: false)
             data += response['data'] unless response['data'].nil?
           end
@@ -85,8 +111,8 @@ module FacebookAds
       def pack(hash, objectify:)
         hash = hash.merge(access_token: FacebookAds.access_token)
         hash = hash.merge(appsecret_proof: FacebookAds.appsecret_proof) if FacebookAds.app_secret
-        hash = hash.merge(fields: self::FIELDS.join(',')) if objectify
-        hash.delete_if { |_k, v| v.nil? }
+        hash = hash.merge(fields: self::FIELDS.join(',')) if objectify && !hash[:fields] && !self::FIELDS.empty?
+        hash.reject { |_key, value| value.nil? || (value.respond_to?(:empty?) && value.empty?) }
       end
 
       def unpack(response, objectify:)

data/spec/facebook_ads/ad_account_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 # FACEBOOK_ACCESS_TOKEN=... rspec spec/facebook_ads/ad_account_spec.rb

data/spec/facebook_ads/ad_campaign_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 # FACEBOOK_ACCESS_TOKEN=... rspec spec/facebook_ads/ad_campaign_spec.rb

data/spec/facebook_ads/ad_creative_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::AdCreative do

data/spec/facebook_ads/ad_image_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::AdImage do

data/spec/facebook_ads/ad_insight_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::AdInsight do

data/spec/facebook_ads/ad_product_catalog_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::AdProductCatalog do

data/spec/facebook_ads/ad_product_feed_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::AdProductFeed do

data/spec/facebook_ads/ad_product_set_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::AdProductSet do

data/spec/facebook_ads/ad_product_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::AdProduct do

data/spec/facebook_ads/ad_set_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::AdSet do

data/spec/facebook_ads/ad_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::Ad do

data/spec/facebook_ads/ad_targeting_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe FacebookAds::AdTargeting do

data/spec/facebook_ads/facebook_ads_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 # rspec spec/facebook_ads/facebook_ads_spec.rb

data/spec/fixtures/cassettes/FacebookAds_AdAccount/_ad_campaigns/lists_campaigns.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://graph.facebook.com/v<api_version>/act_10152335766987003/campaigns?access_token=<access_token>&appsecret_proof=<appsecret_proof>&effective_status%5B%5D=ACTIVE&fields=id,account_id,buying_type,can_use_spend_cap,configured_status,created_time,effective_status,name,objective,start_time,stop_time,updated_time,spend_cap&limit=100
+    uri: https://graph.facebook.com/v<api_version>/act_10152335766987003/campaigns?access_token=<access_token>&appsecret_proof=<appsecret_proof>&effective_status%5B%5D=ACTIVE&fields=id,account_id,buying_type,can_use_spend_cap,configured_status,created_time,effective_status,name,objective,start_time,stop_time,updated_time,spend_cap,budget_remaining,daily_budget,lifetime_budget&limit=100
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/cassettes/FacebookAds_AdAccount/_create_ad_campaign/creates_a_new_ad_campaign.yml

@@ -61,7 +61,7 @@ http_interactions:
   recorded_at: Wed, 26 Apr 2017 00:48:41 GMT
 - request:
     method: get
-    uri: https://graph.facebook.com/v<api_version>/6076262393242?access_token=<access_token>&appsecret_proof=<appsecret_proof>&fields=id,account_id,buying_type,can_use_spend_cap,configured_status,created_time,effective_status,name,objective,start_time,stop_time,updated_time,spend_cap
+    uri: https://graph.facebook.com/v<api_version>/6076262393242?access_token=<access_token>&appsecret_proof=<appsecret_proof>&fields=id,account_id,buying_type,can_use_spend_cap,configured_status,created_time,effective_status,name,objective,start_time,stop_time,updated_time,spend_cap,budget_remaining,daily_budget,lifetime_budget
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/cassettes/FacebookAds_AdCampaign/_destroy/sets_effective_status_to_deleted.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://graph.facebook.com/v<api_version>/6076262142242?access_token=<access_token>&appsecret_proof=<appsecret_proof>&fields=id,account_id,buying_type,can_use_spend_cap,configured_status,created_time,effective_status,name,objective,start_time,stop_time,updated_time,spend_cap
+    uri: https://graph.facebook.com/v<api_version>/6076262142242?access_token=<access_token>&appsecret_proof=<appsecret_proof>&fields=id,account_id,buying_type,can_use_spend_cap,configured_status,created_time,effective_status,name,objective,start_time,stop_time,updated_time,spend_cap,budget_remaining,daily_budget,lifetime_budget
     body:
       encoding: US-ASCII
       string: ''
@@ -110,7 +110,7 @@ http_interactions:
   recorded_at: Wed, 26 Apr 2017 00:52:20 GMT
 - request:
     method: get
-    uri: https://graph.facebook.com/v<api_version>/6076262142242?access_token=<access_token>&appsecret_proof=<appsecret_proof>&fields=id,account_id,buying_type,can_use_spend_cap,configured_status,created_time,effective_status,name,objective,start_time,stop_time,updated_time,spend_cap
+    uri: https://graph.facebook.com/v<api_version>/6076262142242?access_token=<access_token>&appsecret_proof=<appsecret_proof>&fields=id,account_id,buying_type,can_use_spend_cap,configured_status,created_time,effective_status,name,objective,start_time,stop_time,updated_time,spend_cap,budget_remaining,daily_budget,lifetime_budget
     body:
       encoding: US-ASCII
       string: ''

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'coveralls'
 Coveralls.wear!
 

data/spec/support/approvals.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'approvals/rspec'
 
 Approvals.configure do |c|

data/spec/support/facebook_ads.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FacebookAds.business_id  = '760977220612233'
 FacebookAds.access_token = ENV['FACEBOOK_ACCESS_TOKEN'] || 'fake-facebook-access-token'
 FacebookAds.app_secret   = ENV['FACEBOOK_APP_SECRET']   || 'fake-facebook-app-secret'

data/spec/support/rest_client.rb

@@ -1,13 +1,11 @@
+# frozen_string_literal: true
+
 # Force the request headers to only accept JSON, and disable gzip.
 # This makes our VCR cassettes human readable.
 module RestClient
   class Request
     def default_headers
-      {
-        accept: 'application/json',
-        accept_encoding: 'identity',
-        user_agent: RestClient::Platform.default_user_agent
-      }
+      { accept: 'application/json', accept_encoding: 'identity' }
     end
   end
 end

data/spec/support/vcr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'vcr'
 
 VCR.configure do |c|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook_ads
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Chris Estreich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -42,7 +42,7 @@ description: This gem allows to easily manage your Facebook ads via Facebook's M
   API in ruby.
 email: chris@tophatter.com
 executables:
-- console
+- facebook_ads_console
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -57,9 +57,10 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- bin/console
+- bin/facebook_ads_console
 - facebook_ads.gemspec
 - lib/facebook_ads.rb
+- lib/facebook_ads/account.rb
 - lib/facebook_ads/ad.rb
 - lib/facebook_ads/ad_account.rb
 - lib/facebook_ads/ad_audience.rb
@@ -74,6 +75,8 @@ files:
 - lib/facebook_ads/ad_product_set.rb
 - lib/facebook_ads/ad_set.rb
 - lib/facebook_ads/ad_targeting.rb
+- lib/facebook_ads/ad_user.rb
+- lib/facebook_ads/advertisable_application.rb
 - lib/facebook_ads/base.rb
 - spec/facebook_ads/ad_account_spec.rb
 - spec/facebook_ads/ad_campaign_spec.rb
@@ -136,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Facebook Marketing API SDK for Ruby.