facebookbusiness 0.8.0.2 → 0.8.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ec2c3003233735a142a752de0bb91e4119fa931d94c5c10c5a769a9c97110d6
-  data.tar.gz: 7e7094b3c29f41afbab98f3d5d7faf0bec900cae1642d1e39ee17cf19ba8e7d7
+  metadata.gz: 4a33ca32c8748ade89d079a80d94c8b4e6c02a547db4bff11c03e1a2a7979dbc
+  data.tar.gz: 6414909aacd097b547c3ed836eddff3ae622ef2f6d31a5822d35f4d27201101d
 SHA512:
-  metadata.gz: dd97d6ee27e4dea44ab8db1c47a5949b9429e0d67ad51517a20729851050f03ee66f1b35ef80fc1729991dd2cb0cb347aaae28f764be36c0893e014918939db0
-  data.tar.gz: fb4e4a25f44130e2e61b5203ab248da4412c846e59912e736024eff096d8c57bae553423c5e2bccf15a0688d9a3503db1dedd0b2d43ad9ab08e9beb53ca8e4d9
+  metadata.gz: 1d1164b46627d07f5cd9ad5e70815a4617e31fcd5eea8cf80d54f655557ec9ce976550779f63f305f8d148e60cf179610ebe07cc7d2ff214f6dbb85755ebaa01
+  data.tar.gz: ee85a21d581897a5eb06001f0d654242d7b019ffef05870800ca750dcc730c4d3b4b4c075f7eac3a63a00c6f6d87aba9ea2286d9b1dd99be4d7cfe0d16212803

data/lib/facebook_ads/ad_objects/server_side/batch_processor.rb

@@ -0,0 +1,73 @@
+# 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::ServerSide
+  class BatchProcessor
+    attr_accessor :batch_size
+    attr_accessor :concurrent_requests
+
+    # Initializes the object
+    # @param [Integer] batch_size  The number of events to send in each request
+    # @param [Integer] concurrent_requests  The number of threads to use when making requests concurrently
+    def initialize(batch_size=50, concurrent_requests=4)
+      self.batch_size = batch_size
+      self.concurrent_requests = concurrent_requests
+    end
+
+    def process_event_requests(event_requests_async)
+      generator = self.process_event_requests_generator(event_requests_async)
+      generator.each do |batch|
+        Concurrent::Promise.zip(*batch).execute.value!
+      end
+    end
+
+    def process_events(event_request_async_to_clone, events)
+      generator = self.process_events_generator(event_request_async_to_clone, events)
+      generator.each do |batch|
+        Concurrent::Promise.zip(*batch).execute.value!
+      end
+    end
+
+    def process_event_requests_generator(event_requests_async)
+      index = 0
+      Enumerator.new do |generator|
+        while index < event_requests_async.size do
+          batch = event_requests_async[index, concurrent_requests].map(&:execute)
+          generator.yield *[batch]
+          index += concurrent_requests
+        end
+      end
+    end
+
+    def process_events_generator(event_request_async_to_clone, events)
+      index = 0
+      Enumerator.new do |generator|
+        while index < events.size do
+          batch = []
+          while index < events.size && batch.size < concurrent_requests do
+            event_request_async = event_request_async_to_clone.clone_without_events
+            event_request_async.events = events[index, batch_size]
+            batch << event_request_async
+            index += batch_size
+          end
+          generator.yield *[batch.map(&:execute)]
+        end
+      end
+    end
+  end
+end

data/lib/facebook_ads/ad_objects/server_side/event_request.rb

@@ -51,6 +51,9 @@ module FacebookAds
       # The origin/source of data for the dataset to be uploaded.
       attr_accessor :upload_source
 
+      # The HttpServiceInterface client to use for executing the request.
+      attr_accessor :http_service_client
+
       # @param [String] pixel_id
       # @param [Array(FacebookAds::ServerSide::Event)] events
       # @param [String] test_event_code
@@ -59,8 +62,10 @@ module FacebookAds
       # @param [String] upload_id
       # @param [String] upload_tag
       # @param [String] upload_source
+      # @param [HttpServiceInterface] http_service_client
       def initialize(pixel_id: nil, events: nil, test_event_code: nil, partner_agent: nil,
-          namespace_id: nil, upload_id: nil, upload_tag: nil, upload_source: nil)
+          namespace_id: nil, upload_id: nil, upload_tag: nil, upload_source: nil,
+          http_service_client: nil)
         unless pixel_id.nil?
           self.pixel_id = pixel_id
         end
@@ -85,6 +90,9 @@ module FacebookAds
         unless upload_source.nil?
           self.upload_source = upload_source
         end
+        unless http_service_client.nil?
+          self.http_service_client = http_service_client
+        end
       end
 
       # build the object using the input hash
@@ -128,6 +136,10 @@ module FacebookAds
         if attributes.has_key?(:'upload_source')
           self.upload_source = attributes[:'upload_source']
         end
+
+        if attributes.has_key?(:'http_service_client')
+          self.http_service_client = attributes[:'http_service_client']
+        end
       end
 
       # Execute request
@@ -135,18 +147,13 @@ module FacebookAds
         unless valid?
           raise list_invalid_properties
         end
-        normalized_events = normalize
-        ads_pixel = FacebookAds::AdsPixel.get(pixel_id)
-        params = {
-          data: normalized_events
-        }
-        params[:test_event_code] = test_event_code unless test_event_code.nil?
-        params[:partner_agent] = partner_agent unless partner_agent.nil?
-        params[:namespace_id] = namespace_id unless namespace_id.nil?
-        params[:upload_id] = upload_id unless upload_id.nil?
-        params[:upload_tag] = upload_tag unless upload_tag.nil?
-        params[:upload_source] = upload_source unless upload_source.nil?
 
+        if http_service_client
+          return execute_with_client(http_service_client)
+        end
+        params = get_params()
+        params[:data] = normalize
+        ads_pixel = FacebookAds::AdsPixel.get(pixel_id)
         response = ads_pixel.events.create(params)
         json_response_object = JSON.parse(JSON.generate(response), object_class: OpenStruct)
         FacebookAds::ServerSide::EventResponse.new(
@@ -164,6 +171,44 @@ module FacebookAds
         normalized_events
       end
 
+      def get_params
+        params = {}
+        params[:test_event_code] = test_event_code unless test_event_code.nil?
+        params[:partner_agent] = partner_agent unless partner_agent.nil?
+        params[:namespace_id] = namespace_id unless namespace_id.nil?
+        params[:upload_id] = upload_id unless upload_id.nil?
+        params[:upload_tag] = upload_tag unless upload_tag.nil?
+        params[:upload_source] = upload_source unless upload_source.nil?
+        params
+      end
+
+      def execute_with_client http_client
+        url = [
+          "https://#{FacebookAds::DEFAULT_HOST}",
+          FacebookAds::DEFAULT_API_VERSION,
+          pixel_id,
+          'events',
+        ].join('/')
+        headers = {
+          'User-Agent' => "fbbizsdk-ruby-v#{FacebookAds::API_VERSION}"
+        }
+        params = get_params
+        params[:data] = events.map(&:normalize)
+        appsecret = FacebookAds.config.app_secret
+        access_token = FacebookAds.config.access_token
+        params[:access_token] = access_token
+        if appsecret
+          params[:appsecret_proof] = FacebookAds::ServerSide::HttpUtil.appsecret_proof(appsecret, access_token)
+        end
+
+        http_client.execute(
+          url,
+          FacebookAds::ServerSide::HttpMethod::POST,
+          headers,
+          params
+        )
+      end
+
       # Show invalid properties with the reasons. Usually used together with valid?
       # @return Array for valid properties with the reasons
       def list_invalid_properties
@@ -193,7 +238,8 @@ module FacebookAds
             namespace_id == o.namespace_id &&
             upload_id == o.upload_id &&
             upload_tag == o.upload_tag &&
-            upload_source == o.upload_source
+            upload_source == o.upload_source &&
+            http_service_client == o.http_service_client
       end
 
       # @see the `==` method
@@ -213,6 +259,7 @@ module FacebookAds
           upload_id,
           upload_tag,
           upload_source,
+          http_service_client,
         ].hash
       end
 

data/lib/facebook_ads/ad_objects/server_side/event_request_async.rb

@@ -26,6 +26,18 @@ module FacebookAds
           super
         end
       end
+
+      def clone_without_events
+        FacebookAds::ServerSide::EventRequestAsync.new(
+          pixel_id: pixel_id,
+          test_event_code: test_event_code,
+          partner_agent: partner_agent,
+          namespace_id: namespace_id,
+          upload_id: upload_id,
+          upload_tag: upload_tag,
+          upload_source: upload_source,
+        )
+      end
     end
   end
 end

data/lib/facebook_ads/ad_objects/server_side/http_method.rb

@@ -0,0 +1,28 @@
+# 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 ServerSide
+    class HttpMethod
+      POST = 'POST'
+      PUT = 'PUT'
+      GET = 'GET'
+      DELETE = 'DELETE'
+    end
+  end
+end

data/lib/facebook_ads/ad_objects/server_side/http_service_interface.rb

@@ -0,0 +1,33 @@
+# 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 ServerSide
+    class HttpServiceInterface
+
+      # String url            | The graph API endpoint that will be requested
+      # String request_method | The HTTP request method
+      # Hash headers          | Contains HTTP request headers including User-Agent and Accept-Encoding
+      # Hash params           | Contains request parameters including access_token, data, test_event_code, etc.
+      def execute(url, request_method, headers, params)
+        raise Exception.new("Method 'execute' not implemented")
+      end
+    end
+  end
+end

data/lib/facebook_ads/ad_objects/server_side/http_util.rb

@@ -0,0 +1,31 @@
+# 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 ServerSide
+        class HttpUtil
+            def self.appsecret_proof(app_secret, access_token)
+                OpenSSL::HMAC.hexdigest(
+                    OpenSSL::Digest.new('sha256'),
+                    app_secret,
+                    access_token
+                )
+            end
+        end
+    end
+end

data/lib/facebook_ads/version.rb

@@ -19,6 +19,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '0.8.0.2'
+  VERSION = '0.8.0.3'
   API_VERSION = '8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebookbusiness
 version: !ruby/object:Gem::Version
-  version: 0.8.0.2
+  version: 0.8.0.3
 platform: ruby
 authors:
 - Facebook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -610,6 +610,7 @@ files:
 - lib/facebook_ads/ad_objects/saved_audience.rb
 - lib/facebook_ads/ad_objects/saved_message_response.rb
 - lib/facebook_ads/ad_objects/security_settings.rb
+- lib/facebook_ads/ad_objects/server_side/batch_processor.rb
 - lib/facebook_ads/ad_objects/server_side/content.rb
 - lib/facebook_ads/ad_objects/server_side/custom_data.rb
 - lib/facebook_ads/ad_objects/server_side/delivery_category.rb
@@ -617,6 +618,9 @@ files:
 - lib/facebook_ads/ad_objects/server_side/event_request.rb
 - lib/facebook_ads/ad_objects/server_side/event_request_async.rb
 - lib/facebook_ads/ad_objects/server_side/event_response.rb
+- lib/facebook_ads/ad_objects/server_side/http_method.rb
+- lib/facebook_ads/ad_objects/server_side/http_service_interface.rb
+- lib/facebook_ads/ad_objects/server_side/http_util.rb
 - lib/facebook_ads/ad_objects/server_side/user_data.rb
 - lib/facebook_ads/ad_objects/server_side/util.rb
 - lib/facebook_ads/ad_objects/split_test_winner.rb