facebookbusiness 0.3.0.1

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,47 @@
+# 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
+
+    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,86 @@
+# 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?
+      api_response = APIRequest.new(:post, '', session: session, params: batch_args).execute_now
+      self.last_api_response = api_response
+      operations.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
+
+    def batch_args
+      {batch: JSON.dump(operations_args)}.merge(files_args)
+    end
+
+    def operations_args
+      operations.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 :log_api_bodies, false
+
+    def logger=(logger)
+      Utils.logger = logger
+    end
+  end
+end

data/lib/facebook_ads/edge.rb

@@ -0,0 +1,184 @@
+# 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
+  module EdgeHasGet
+    include Enumerable
+
+    extend Forwardable
+    def_delegators :@collection, :length, :count
+
+    DEFAULT_PAGE_SIZE = 10
+    attr_accessor :has_next_page, :next_page_cursor
+
+    def [](idx)
+      # TODO Handle delegate
+      fetch_next_page until idx < collection.length || !has_next_page?
+      collection[idx]
+    end
+
+    def all
+      fetch_next_page until !has_next_page?
+      collection
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      idx = 0
+
+      while (e = self[idx])
+        yield e
+        idx += 1
+      end
+
+      self
+    end
+
+    def reload!
+      @collection = Array.new
+      self.has_next_page = true
+    end
+
+    private
+    def fetch_next_page
+      fetch_options = {limit: DEFAULT_PAGE_SIZE}.merge(serialized_options)
+      fetch_options = fetch_options.merge({after: next_page_cursor}) if next_page_cursor
+
+      node.get_edge(name, fetch_options) do |response|
+        response["data"].each do |data|
+          field_type = self.class.return_types[:get]
+
+          obj = field_type.deserialize(data, node.session)
+          collection << obj
+        end
+
+        self.next_page_cursor = response.dig('paging', 'cursors', 'after')
+        self.has_next_page = !(response['data'].length < fetch_options[:limit])
+      end
+    end
+
+    def collection
+      @collection ||= Array.new
+    end
+
+    def has_next_page?
+      self.has_next_page.nil? ? (self.has_next_page = true) : self.has_next_page
+    end
+
+    def loaded?
+      @loaded
+    end
+  end
+
+  module EdgeHasPost
+    def create(params)
+      if self.class.param_set_for_post
+        params = self.class.param_set_for_post.to_params(params)
+      end
+
+      node.post_edge(name, graph_params.merge(params)) do |response|
+        # TODO params check
+        # TODO Add new object to collection?
+        
+        field_type = self.class.return_types[:post]
+
+        obj = field_type.deserialize(response, node.session)
+        yield obj if block_given?
+        obj
+      end
+    end
+  end
+
+  module EdgeHasDelete
+    def destroy(params)
+      params = @param_set_for_delete.to_params(params) if @param_set_for_delete
+
+      node.delete_edge(name, params) do |response|
+        yield response if block_given?
+        response
+      end
+    end
+  end
+
+  class Edge
+    attr_reader :name, :node, :options, :should_delegate
+
+    def initialize(name, node, should_delegate, options)
+      @name = name
+      @node = node
+      @options = options || {}
+      @should_delegate = should_delegate
+    end
+
+    def serialized_options
+      Hash[options.map { |k,v|
+        v = (k == :fields && v.is_a?(Array)) ?
+             v.join(',') : v
+        [k,v]
+      }]
+    end
+
+    # TODO refactor
+    # sending this along with params to leverage read-after-write
+    def graph_params
+      {fields: options[:fields]}.compact
+    end
+
+    class << self
+      attr_reader :param_set_for_get, :param_set_for_post, :param_set_for_delete
+
+      def get(return_type = 'AdObject')
+        include EdgeHasGet
+
+        yield (@param_set_for_get = ParamSet.new) if block_given?
+
+        return_types(:get, return_type)
+      end
+
+      def post(return_type = 'AdObject')
+        include EdgeHasPost
+
+        yield (@param_set_for_post = ParamSet.new) if block_given?
+
+        return_types(:post, return_type)
+      end
+
+      def delete(return_type = 'AdObject')
+        include EdgeHasDelete
+
+        yield (@param_set_for_delete = ParamSet.new) if block_given?
+
+        return_types(:delete, return_type)
+      end
+
+      # TODO refactor?
+      def return_types(action = nil, return_type = nil)
+        if action
+          if return_type
+            @return_types ||= {}
+            @return_types[action] = FieldTypes.for(return_type)
+          end
+          @return_types[action]
+        else
+          @return_types
+        end
+      end
+    end
+  end
+end