facebookbusiness 0.3.0.1

data/lib/facebook_ads/ruby2patch.rb

@@ -0,0 +1,27 @@
+# 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.
+
+class Hash
+  def dig(k, *ks)
+    key?(k) ? (ks.empty? ? self[k] : self[k].dig(*ks)) : nil
+  end unless method_defined?(:dig)
+
+  def compact
+    self.select { |_, value| !value.nil? }
+  end unless method_defined?(:compact)
+end

data/lib/facebook_ads/session.rb

@@ -0,0 +1,99 @@
+# 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 'faraday'
+require 'openssl'
+require 'logger'
+require 'facebook_ads/videos/video_request'
+
+module FacebookAds
+  class Session
+    attr_accessor :access_token, :app_secret, :api_version, :server_host
+
+    def initialize(access_token: nil,
+                   app_secret:   nil,
+                   server_host:  FacebookAds.config.server_host,
+                   api_version:  FacebookAds.config.api_version)
+      @access_token = access_token
+      @app_secret   = app_secret
+      @server_host  = server_host
+      @api_version  = api_version
+    end
+
+    def request(method, path, params = nil)
+      path.gsub!(/^\//,'') #
+      case method
+        when :get, :post, :delete
+          api_conn.send(method, path, params) do |req|
+            req.headers[:user_agent] = "fbbizsdk-ruby-v#{API_VERSION}".freeze
+            req.params[:access_token] = access_token
+            req.params[:appsecret_proof] = appsecret_proof if app_secret
+          end
+        else
+          raise 'Unsupported HTTP method: ' + method
+      end
+    end
+
+    def appsecret_proof
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new('sha256'),
+        @app_secret,
+        @access_token
+      )
+    end
+
+    private
+    def api_conn
+      @api_conn ||= Faraday.new(url: api_base_path) do |faraday|
+        faraday.use FacebookAds::HTTPService::VideoRequest
+        faraday.request  :multipart
+        # TODO Json Request
+        # TODO URL Encode - stringify json
+        faraday.request  :url_encoded
+
+        faraday.response :logger, Utils.logger, bodies: FacebookAds.config.log_api_bodies
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    def api_base_path
+      "https://#{self.server_host}/#{self.api_version}/".freeze
+    end
+
+    class << self
+      def default_session
+        # TODO
+        @default_session ||= new( access_token: FacebookAds.config.access_token,
+                                  app_secret: FacebookAds.config.app_secret)
+      end
+
+      def default_session=(session)
+        # TODO
+        @default_session = session
+      end
+
+      def current_session
+        @@current_session ||= default_session
+      end
+
+      def current_session=(session)
+        @@current_session = session
+      end
+    end
+  end
+end

data/lib/facebook_ads/test.rb

@@ -0,0 +1,23 @@
+# 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/test/config'
+require 'facebook_ads/test/errors'
+require 'facebook_ads/test/base'
+require 'facebook_ads/test/exit_codes'
+require 'facebook_ads/test/exit_hook'

data/lib/facebook_ads/test/base.rb

@@ -0,0 +1,98 @@
+# 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_relative 'config'
+require_relative 'fixtures'
+
+module FacebookAds
+  module Test
+    module FailuresStore
+      def failures
+        @failures ||= []
+      end
+    end
+    extend FailuresStore
+
+    class Base < Minitest::Test
+      attr_accessor :cleanup_queue, :config
+
+      include Fixtures
+
+      def before_setup
+        load_config!
+      end
+
+      def generate(type, *args)
+        method = "create_#{type}".to_sym
+        if respond_to?(method)
+          send(method, *args) do |generated_obj|
+            cleanup_later(generated_obj)
+          end.tap do |obj|
+            cleanup_later(obj)
+          end
+        else
+          raise TestRuntimeError, "#{type} is not a supported generator"
+        end
+      end
+
+      def teardown
+        return unless cleanup_queue
+
+        cleanup_queue.reverse.each do |obj_or_id|
+          if obj_or_id.is_a?(FacebookAds::AdObject)
+            obj_or_id.destroy
+          elsif obj_or_id.is_a?(String) || obj_or_id.is_a?(Numeric)
+            FacebookAds::AdObject.get(obj_or_id).destroy
+          end
+        end
+      end
+
+      def after_teardown
+        # Collect failures for custom exit code
+        FacebookAds::Test.failures.concat(self.failures)
+      end
+
+      private
+      def cleanup_later(obj)
+        @cleanup_queue ||= []
+        @cleanup_queue << obj
+      end
+
+      def load_config!
+        @config = FacebookAds::Test::Config.new.override_from! # load overrides from test_config.json
+
+        FacebookAds.configure do |cf|
+          log_level = case ENV['LOG_LEVEL']
+            when 'debug'
+              ::Logger::DEBUG
+            when 'info'
+              ::Logger::INFO
+            when 'fatal'
+              ::Logger::FATAL
+            when 'error'
+              ::Logger::ERROR
+            else # default to warn
+              ::Logger::WARN
+          end
+          cf.logger = ::Logger.new(STDOUT).tap { |d| d.level = log_level }
+          cf.access_token = config.access_token
+        end
+      end
+    end
+  end
+end

data/lib/facebook_ads/test/config.rb

@@ -0,0 +1,55 @@
+# 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 Test
+    class Config < FacebookAds::Config
+      setting :app_id
+      setting :app_secret
+      setting :access_token
+      setting :business_id
+      setting :act_id
+      setting :account_id
+      setting :act_timezone
+      setting :page_id
+      setting :app_url
+      setting :instagram_actor_id
+      setting :graph_base_domain
+      setting :secondary_business_id
+      setting :secondary_account_id
+      setting :secondary_page_id
+      setting :secondary_app_id
+
+      setting :image_path, File.expand_path("../../../../tests/image.png", __FILE__)
+      setting :images_zip_path, File.expand_path("../../../../tests/imagez.zip", __FILE__)
+      setting :video_path, File.expand_path("../../../../tests/video.mp4", __FILE__)
+
+      def override_from!(filename = nil)
+        filename ||= File.expand_path("../../../../tests/test_config.json", __FILE__)
+        if File.exists?(filename)
+          settings = JSON.parse(File.read(filename))
+
+          settings.each do |k,v|
+            instance_variable_set("@#{k}", v)
+          end
+        end
+        self
+      end
+    end
+  end
+end

data/lib/facebook_ads/test/errors.rb

@@ -0,0 +1,23 @@
+# 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 Test
+    class TestRuntimeError < Exception; end
+  end
+end

data/lib/facebook_ads/test/exit_codes.rb

@@ -0,0 +1,29 @@
+# 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 Test
+    module ExitCodes
+      EXTERNAL_ERROR = 41
+      FAILURE = 1
+      SUCCESS = 0
+      USER_ERROR = 40
+      USER_SKIP = 42
+    end
+  end
+end

data/lib/facebook_ads/test/exit_hook.rb

@@ -0,0 +1,35 @@
+# 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.
+
+# Intercept Minitest exit routine and return our own custom exit code
+Minitest.after_run {
+  FacebookAds::Test.failures.each do |failure|
+    case failure
+      when Minitest::Skip
+        exit FacebookAds::Test::ExitCodes::USER_SKIP
+      when Minitest::UnexpectedError
+        e = failure.exception
+        if e.is_a?(FacebookAds::ServerError) ||
+            e.is_a?(FacebookAds::ClientError)
+          exit FacebookAds::Test::ExitCodes::EXTERNAL_ERROR
+        else
+          exit FacebookAds::Test::ExitCodes::USER_ERROR
+        end
+    end
+  end
+}

data/lib/facebook_ads/test/fixtures.rb

@@ -0,0 +1,107 @@
+# 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
+  module Test
+    module Fixtures
+      def ad_account
+        FacebookAds::AdAccount.get(config.account_id)
+      end
+
+      def create_adlabel
+        ad_account.adlabels.create({
+          name: randomize('My ad label')
+        })
+      end
+
+      def create_ad(params = {})
+        ad_set ||= create_ad_set.tap { |c| yield c if block_given? }
+        creative ||= create_creative.tap { |c| yield c if block_given? }
+
+        params = {
+          name: 'My Ad',
+          adset_id: ad_set.id,
+          creative: {
+            creative_id: creative.id,
+          },
+          status: 'PAUSED',
+        }
+
+        ad = ad_account.ads.create(params)
+      end
+
+      def create_image
+        images = ad_account.adimages.create({
+          filename: config.image_path
+        })
+        images[0]
+      end
+
+      def create_campaign(params = {})
+        params = {
+          name: randomize('Testing Campaign'),
+          buying_type: 'AUCTION',
+          objective: 'LINK_CLICKS',
+          status: 'PAUSED',
+        }.merge(params)
+
+        ad_account.campaigns.create(params)
+      end
+
+      def create_ad_set(campaign = nil, params = {})
+        # yield generated object to add them to cleanup queue
+        campaign ||= create_campaign.tap { |c| yield c if block_given? }
+
+        ad_account.adsets.create({
+          campaign_id: campaign.id,
+          name: randomize('Test AdSet'),
+          targeting: {
+            geo_locations: { countries: ['US'] }
+          },
+          optimization_goal: 'IMPRESSIONS',
+          billing_event: 'IMPRESSIONS',
+          bid_amount: 100,
+          daily_budget: 1000,
+        })
+      end
+
+      def create_creative(image = nil, params = {})
+        image ||= create_image
+
+        ad_account.adcreatives.create({
+          name: randomize('Test Creative'),
+          object_story_spec: {
+            page_id: config.page_id,
+            link_data: {
+              message: 'try it out',
+              link: config.app_url,
+              caption: 'www.example.com',
+              image_hash: image.hash,
+            }
+          }
+        })
+      end
+
+      def randomize(string)
+        "#{string} #{SecureRandom.hex}"
+      end
+    end
+  end
+end