bonio-facebookbusiness 0.13.0.0

data/lib/facebook_ads/ad_objects/windows_phone_app_link.rb

@@ -0,0 +1,39 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class WindowsPhoneAppLink < AdObject
+
+    field :app_id, 'string'
+    field :app_name, 'string'
+    field :url, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/woodhenge_purchased_payg_receipt.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class WoodhengePurchasedPaygReceipt < AdObject
+
+    field :id, 'string'
+    field :number_of_subscriptions_purchased, 'int'
+    field :purchase_time, 'datetime'
+    field :user, 'User'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/work_user_frontline.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class WorkUserFrontline < AdObject
+
+    field :has_access, 'bool'
+    field :is_frontline, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/api_request.rb

@@ -0,0 +1,123 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'securerandom'
+
+module FacebookAds
+  class APIRequest
+    attr_reader :method, :path, :session, :params,
+                :options, :callback, :batch_proxy
+
+    def initialize(method, path, session: nil, params: nil, options: nil)
+      @method = method
+      @path = path
+      @session = session
+      @params = params
+      @options = options
+      @batch_proxy = nil
+    end
+
+    # Returns either APIResponse instantly if not within a batch, or
+    # a Proxy object to the result if a batch is present.
+    #
+    # ==== Examples
+    #
+    # Illustrate the behaviour of the method using examples. Indent examples:
+    #
+    #    api_request APIRequest.new(:get, '123545') do |response|
+    #      update_attributes(response)
+    #    end
+
+    def execute(&block)
+      @callback = block if block
+      is_in_batch? ? enqueue_to_batch : execute_now
+    end
+
+    def execute_now
+      faraday_response = session.request(method, path, params)
+      create_response(faraday_response.status, faraday_response.headers, faraday_response.body)
+    end
+
+    def enqueue_to_batch
+      current_batch << self
+      @batch_proxy = BatchProxy.new(self)
+    end
+
+    def create_response(status, headers, body)
+      api_response = APIResponse.new(status, headers, body)
+
+      if status.to_i >= 500
+        raise ServerError.new(api_response)
+      elsif status.to_i >= 400
+        raise ClientError.new(api_response)
+      end
+
+      (callback ? callback[api_response] : api_response).tap do |result|
+        batch_proxy.set_result(result) if batch_proxy
+      end
+    end
+
+    def batch_name
+      @batch_name ||= (options.dig(:batch_args, :name) || generate_batch_name)
+    end
+
+    def generate_batch_name
+      SecureRandom.hex(4)
+    end
+
+    def current_batch
+      options.dig(:batch_args, :batch) || Batch.current_batch
+    end
+
+    def is_in_batch?
+      !current_batch.nil?
+    end
+
+    def to_batch_params
+      {
+        name: batch_name,
+        method: method.to_s.upcase,
+        relative_url: path,
+        body: batch_body,
+        omit_response_on_success: false,
+        attached_files: files.empty? ? nil : files.keys.join(','),
+      }.compact
+    end
+
+    # For Batch API
+    def batch_body
+      # TODO Have our own encoders or param flattener?
+      params = Faraday::Utils::ParamsHash[params_without_files]
+      params.to_query(Faraday::FlatParamsEncoder)
+    end
+
+    # For Batch API
+    def params_without_files
+      params.reject do |_,v|
+        v.is_a?(UploadIO)
+      end
+    end
+
+    # For Batch API
+    def files
+      params.select do |_,v|
+        v.is_a?(UploadIO)
+      end
+    end
+  end
+end

data/lib/facebook_ads/api_response.rb

@@ -0,0 +1,51 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module FacebookAds
+  class APIResponse
+    attr_reader :status_code, :headers, :body
+
+    def initialize(status_code, headers, body)
+      @status_code = status_code
+      @headers = headers
+      @body = body
+    end
+
+    def result
+      is_json_response? ? JSON.parse(body) : body
+    end
+
+    def fb_trace_id
+      @headers[:x_fb_trace_id]
+    end
+
+    def raw_body
+      @body
+    end
+
+    def headers
+      @headers
+    end
+
+    private
+    def is_json_response?
+      headers[:content_type] =~ /application\/json/ ||
+      headers[:content_type] =~ /text\/javascript/
+    end
+  end
+end

data/lib/facebook_ads/batch_api/batch.rb

@@ -0,0 +1,88 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module FacebookAds
+  class Batch
+    attr_accessor :operations, :session, :last_api_response
+
+    def initialize
+      @operations = []
+    end
+
+    def <<(api_req)
+      @operations << api_req
+      @session ||= api_req.session
+      api_req
+    end
+
+    def execute
+      return [] if operations.empty?
+      operations.each_slice(50) do |slice|
+        api_response = APIRequest.new(:post, '', session: session, params: batch_args(slice)).execute_now
+        self.last_api_response = api_response
+        slice.zip(api_response.result).map do |req, res|
+          next unless res
+
+          begin
+            req.create_response(
+                res['code'],
+                convert_headers_to_hash(res['headers']),
+                res['body'])
+          rescue APIError => e
+            e
+          end
+        end
+      end
+    end
+
+    def batch_args(slice = operations)
+      {batch: JSON.dump(operations_args(slice))}.merge(files_args)
+    end
+
+    def operations_args(slice)
+      slice.map do |api_req|
+        api_req.to_batch_params
+      end
+    end
+
+    def files_args
+      operations.map do |api_req|
+        api_req.files
+      end.reduce(&:merge)
+    end
+
+    class << self
+      attr_accessor :current_batch
+
+      def with_batch
+        new.tap do |current_batch|
+          self.current_batch = current_batch
+          yield if block_given?
+          self.current_batch = nil
+        end
+      end
+    end
+
+    private
+    def convert_headers_to_hash(headers)
+      Faraday::Utils::Headers.new(
+          Hash[headers.map {|h| [h['name'], h['value']]}]
+      )
+    end
+  end
+end

data/lib/facebook_ads/batch_api/batch_proxy.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module FacebookAds
+  class BatchProxy < BasicObject
+    def initialize(api_request)
+      @api_request = api_request
+      @loaded = false
+      @result = nil
+      @exception = nil
+    end
+
+    def set_result(result)
+      @result = result
+      @loaded = true
+    end
+
+    def set_error(exception)
+      @exception = exception
+      @loaded = true
+    end
+
+    def method_missing(method_name, *args, &block)
+      if @loaded
+        if @result
+          @result.__send__(method_name, *args, &block)
+        else
+          ::Object.send(:raise, @exception)
+        end
+      else
+        __attr_ref(method_name)
+      end
+    end
+
+    def __api_request
+      @api_request
+    end
+
+    def __result
+      @result
+    end
+
+    def __loaded?
+      @loaded
+    end
+
+    def __attr_ref(attr_name)
+      # generate JSONPath of the attribute
+      "{result=#{__api_request.batch_name}:$.#{attr_name}}"
+    end
+  end
+end

data/lib/facebook_ads/config.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module FacebookAds
+  class Config
+    def self.setting(name, default = nil)
+      attr_writer name
+
+      define_method name do
+        unless instance_variable_defined?("@#{name}")
+          instance_variable_set("@#{name}", default)
+        end
+        instance_variable_get("@#{name}")
+      end
+    end
+
+    setting :server_host, FacebookAds::DEFAULT_HOST
+    setting :api_version, FacebookAds::DEFAULT_API_VERSION
+    setting :access_token, ENV['FB_ACCESS_TOKEN']
+    setting :app_secret, ENV['FB_APP_SECRET']
+    setting :crash_logging_enabled, true
+    setting :log_api_bodies, false
+
+    def logger=(logger)
+      Utils.logger = logger
+    end
+  end
+end

data/lib/facebook_ads/crash_logger.rb

@@ -0,0 +1,133 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'facebook_ads/api_request'
+require 'facebook_ads/api_response'
+
+module FacebookAds
+  class CrashLogger
+    class << self
+      private
+      @@enabled = false
+      @@hasRegisteredCrashBlock = false
+
+      def logCrash
+        error = $!
+        if is_facebook_error(error)
+          app_id = get_app_id
+          if app_id.nil?
+            puts "Unable to log the crash: We're missing an app id."
+            return
+          end
+          params = {
+            'bizsdk_crash_report': {
+              'reason': formatted_reason(error),
+              'platform': "ruby #{RUBY_VERSION}",
+              'callstack': error.backtrace
+            }
+          }
+          begin
+            APIRequest.new(
+              :post,
+              "#{app_id}/instruments",
+              session: Session.anonymous_session,
+              params: params,
+              options: {} # batch options, not necessary for now
+            ).execute do |response|
+              if response.result.has_key?('success') && response.result['success'] == true
+                puts 'Successfully sent report'
+                return
+              end
+              puts 'Failed to send report'
+            end
+          rescue
+            puts 'Failed to send report'
+          end
+        end
+      end
+
+      def completion
+        if @@enabled && $! then
+          logCrash()
+        end
+      end
+
+      def is_facebook_error(error)
+        error.backtrace.any? { |frame|
+          frame.match? 'facebook_ads'
+        } if error
+      end
+
+      def formatted_reason(error)
+        if error.kind_of? APIError
+          reason = 'Server Error' if error.kind_of? ServerError
+          reason = 'Client Error' if error.kind_of? ClientError
+          reason += " #{error.message}"
+        else
+          reason = 'SDK Error'
+        end
+        reason
+      end
+
+      def get_app_id
+        params = {
+          'input_token': Session.default_session.access_token,
+          'fields': 'app_id'
+        }
+        begin
+          APIRequest.new(
+            :get,
+            '/debug_token',
+            session: Session.default_session,
+            params: params,
+            options: {} # batch options, not necessary for now
+          ).execute do |response|
+            if (response.result.has_key?('data') &&
+              response.result['data'].has_key?('app_id')
+            )
+              response.result['data']['app_id']
+            else
+              nil
+            end
+          end
+        rescue
+          nil
+        end
+      end
+
+      public
+      # Enable crash reporting
+      def enable
+        if !@@hasRegisteredCrashBlock then
+          at_exit do
+            completion()
+          end
+
+          @@hasRegisteredCrashBlock = true
+        end
+
+        @@enabled = true
+      end
+
+      # Disable crash reporting
+      def disable
+        @@enabled = false
+      end
+    end
+  end
+end