facebookbusiness 0.5.0.2 → 0.5.0.3

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

@@ -0,0 +1,225 @@
+# 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 'digest'
+
+module FacebookAds
+	module ServerSide
+
+		PHONE_NUMBER_IGNORE_CHAR_SET = /[\-\s\(\)]+/
+		PHONE_NUMBER_DROP_PREFIX_ZEROS = /^\+?0{0,2}/
+		US_PHONE_NUMBER_REGEX = /^1\(?\d{3}\)?\d{7}$/
+		INTL_PHONE_NUMBER_REGEX = /^\d{1,4}\(?\d{2,3}\)?\d{4,}$/
+
+		# RFC 2822 for email format
+		EMAIL_REGEX = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+
+		# @return [String] SHA 256 hash of input string
+		def self.sha256Hash(input)
+			unless input.nil?
+				Digest::SHA256.hexdigest input
+			end
+		end
+
+		# Normalizes the input string given the field_type
+		# @param [String] input Input string that needs to be normalized
+		# @param [String] field_type Type/Key for the value provided
+		# @return [String] Normalized value for the input and field_type.
+		def self.normalize(input, field_type)
+
+			if input.nil? or field_type.nil?
+				return nil;
+			end
+
+			input = input.strip.downcase
+
+			# If the data is already hashed, we by-pass input normalization
+			if FacebookAds::ServerSide::is_already_hashed?(input) == true
+				return input
+      end
+
+			normalized_input = input;
+
+			case field_type
+			when 'country'
+				normalized_input = FacebookAds::ServerSide::normalize_country input
+			when 'ct'
+        normalized_input = FacebookAds::ServerSide::normalize_city input
+      when 'currency'
+        return FacebookAds::ServerSide::normalize_currency input
+			when 'em'
+				normalized_input = FacebookAds::ServerSide::normalize_email input
+			when 'ge'
+				normalized_input = FacebookAds::ServerSide::normalize_gender input
+			when 'ph'
+				normalized_input = FacebookAds::ServerSide::normalize_phone input
+			when 'st'
+				normalized_input = FacebookAds::ServerSide::normalize_state input
+			when 'zp'
+				normalized_input = FacebookAds::ServerSide::normalize_zip input
+      end
+
+      normalized_input = FacebookAds::ServerSide::sha256Hash normalized_input
+
+			return normalized_input
+		end
+
+    # Boolean method which checks if a input is already hashed with MD5 or SHA256
+		# @param [String] input Input string that is to be validated
+		# @return [TrueClass|FalseClass] representing whether the value is hashed
+    def self.is_already_hashed?(input)
+
+			# We support Md5 and SHA256, and highly recommend users to use SHA256 for hashing PII keys.
+			md5_match = /^[a-f0-9]{32}$/.match(input)
+      sha256_match = /^[a-f0-9]{64}$/.match(input)
+
+			if md5_match != nil or sha256_match != nil
+				return true
+			end
+
+			return false
+		end
+
+		# Normalizes the given country code and returns acceptable hashed country ISO code
+		def self.normalize_country(country)
+
+			# Replace unwanted characters and retain only alpha characters bounded for ISO code.
+			country = country.gsub(/[^a-z]/,'')
+
+			if country.length != 2
+				raise ArgumentError, "Invalid format for country:'" + country + "'.Please follow ISO 2-letter ISO 3166-1 standard for representing country. eg: us"
+			end
+
+			return  country
+		end
+
+		# Normalizes the given city and returns acceptable hashed city value
+    def self.normalize_city(city)
+
+      # Remove commonly occuring characters from city name.
+			city = city.gsub(/[0-9.\s\-()]/,'')
+
+			return city
+		end
+
+		# Normalizes the given currency code and returns acceptable hashed currency ISO code
+		def self.normalize_currency(currency)
+
+			# Retain only alpha characters bounded for ISO code.
+			currency = currency.gsub(/[^a-z]/,'')
+
+			if currency.length != 3
+				raise ArgumentError, "Invalid format for currency:'" + currency + "'.Please follow ISO 3-letter ISO 4217 standard for representing currency. Eg: usd"
+			end
+
+			return currency;
+		end
+
+		# Normalizes the given email and returns acceptable hashed email value
+		def self.normalize_email(email)
+
+			if EMAIL_REGEX.match(email) == nil
+				return ArgumentError, "Invalid email format for the passed email:' + email + '.Please check the passed email format."
+			end
+
+			return email
+		end
+
+		# Normalizes the given gender and returns acceptable hashed gender value
+    def self.normalize_gender(gender)
+
+      # Replace extra characters with space, to bound under alpha characters set.
+      gender = gender.gsub(/[^a-z]/,'')
+
+			case gender
+			when 'female' , 'f'
+				gender = 'f'
+			when 'male' , 'm'
+				gender = 'm'
+			else
+				return nil
+			end
+
+			return gender
+		end
+
+		# Normalizes the given phone and returns acceptable hashed phone value
+		def self.normalize_phone(phone)
+
+			# Drop the spaces, hyphen and parenthesis from the Phone Number
+			normalized_phone = phone.gsub(PHONE_NUMBER_IGNORE_CHAR_SET, '')
+
+			if(FacebookAds::ServerSide::is_international_number?(normalized_phone))
+				normalized_phone = normalized_phone.gsub(PHONE_NUMBER_DROP_PREFIX_ZEROS, '')
+			end
+
+			if normalized_phone.length < 7 || normalized_phone.length > 15
+				return nil;
+			end
+
+			return normalized_phone
+		end
+
+		# Normalizes the given city and returns acceptable hashed city value
+		def self.normalize_state(state)
+			state = state.gsub(/[0-9.\s\-()]/,'')
+
+			return state
+		end
+
+		# Normalizes the given zip and returns acceptable hashed zip code value
+		def self.normalize_zip(zip)
+
+			# Remove spaces from the Postal code
+			zip = zip.gsub(/[\s]/,'')
+
+      # If the zip code '-', we retain just the first part alone.
+			zip = zip.split('-')[0]
+
+			if zip.length < 2
+				return nil
+			end
+
+			return zip
+		end
+
+    # Boolean method which checks if a given number is represented in international format
+    # @param [String] phone_number that has to be tested.
+		# @return [TrueClass | FalseClass] boolean value representing if a number is international
+		def self.is_international_number?(phone_number)
+
+			# Drop upto 2 leading 0s from the number
+			phone_number = phone_number.gsub(PHONE_NUMBER_DROP_PREFIX_ZEROS, '')
+
+			if phone_number.start_with?('0')
+				return false;
+			end
+
+			if phone_number.start_with?('1') && US_PHONE_NUMBER_REGEX.match(phone_number) != nil
+				return false;
+			end
+
+			if INTL_PHONE_NUMBER_REGEX.match(phone_number) != nil
+				return true;
+			end
+
+			return false;
+		end
+
+	end
+end

data/lib/facebook_ads/ad_objects/user.rb

@@ -79,6 +79,7 @@ module FacebookAds
       "MSN",
       "MYSPACE",
       "NATEON",
+      "OCULUS",
       "OK",
       "ORKUT",
       "OTHERS",
@@ -126,6 +127,7 @@ module FacebookAds
     field :installed, 'bool'
     field :interested_in, { list: 'string' }
     field :is_famedeeplinkinguser, 'bool'
+    field :is_guest_user, 'bool'
     field :is_shared_login, 'bool'
     field :is_verified, 'bool'
     field :languages, { list: 'Experience' }
@@ -305,6 +307,17 @@ module FacebookAds
         api.has_param :business, 'string'
       end
       edge.get 'Business'
+      edge.post 'Business' do |api|
+        api.has_param :email, 'string'
+        api.has_param :name, 'string'
+        api.has_param :primary_page, 'string'
+        api.has_param :sales_rep_email, 'string'
+        api.has_param :survey_business_type, { enum: -> { Business::SURVEY_BUSINESS_TYPE }}
+        api.has_param :survey_num_assets, 'int'
+        api.has_param :survey_num_people, 'int'
+        api.has_param :timezone_id, 'int'
+        api.has_param :vertical, { enum: -> { Business::VERTICAL }}
+      end
     end
 
     has_edge :conversations do |edge|
@@ -722,6 +735,7 @@ module FacebookAds
         api.has_param :ios_bundle_id, 'string'
         api.has_param :is_explicit_location, 'bool'
         api.has_param :is_explicit_place, 'bool'
+        api.has_param :is_visual_search, 'bool'
         api.has_param :manual_privacy, 'bool'
         api.has_param :message, 'string'
         api.has_param :name, 'string'

data/lib/facebook_ads/api_response.rb

@@ -38,6 +38,10 @@ module FacebookAds
       @body
     end
 
+    def headers
+      @headers
+    end
+
     private
     def is_json_response?
       headers[:content_type] =~ /application\/json/ ||

data/lib/facebook_ads/errors.rb

@@ -24,7 +24,7 @@ module FacebookAds
 
   class APIError < Error
     ERROR_ATTRS = [
-      :fb_message, :type, :code,
+      :headers, :fb_message, :type, :code,
       :error_subcode, :is_transient, :error_user_title,
       :error_user_msg, :fbtrace_id,
     ]
@@ -32,6 +32,7 @@ module FacebookAds
     attr_accessor *ERROR_ATTRS
 
     def initialize(api_response)
+      send("headers=", api_response.headers)
       error_obj = api_response.result
       @api_response = api_response
 
@@ -47,6 +48,10 @@ module FacebookAds
         super(error_obj)
       end
     end
+
+    def getHeaders
+      self.headers
+    end
   end
 
   class ServerError < APIError; end

data/lib/facebook_ads/version.rb

@@ -19,6 +19,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '0.5.0.2'
+  VERSION = '0.5.0.3'
   API_VERSION = '5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebookbusiness
 version: !ruby/object:Gem::Version
-  version: 0.5.0.2
+  version: 0.5.0.3
 platform: ruby
 authors:
 - Facebook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-11 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -344,7 +344,6 @@ files:
 - lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb
 - lib/facebook_ads/ad_objects/business_page_request.rb
 - lib/facebook_ads/ad_objects/business_pixel_tos.rb
-- lib/facebook_ads/ad_objects/business_project.rb
 - lib/facebook_ads/ad_objects/business_role_request.rb
 - lib/facebook_ads/ad_objects/business_unit.rb
 - lib/facebook_ads/ad_objects/business_user.rb
@@ -464,6 +463,7 @@ files:
 - lib/facebook_ads/ad_objects/native_offer.rb
 - lib/facebook_ads/ad_objects/native_offer_discount.rb
 - lib/facebook_ads/ad_objects/native_offer_view.rb
+- lib/facebook_ads/ad_objects/null_node.rb
 - lib/facebook_ads/ad_objects/offline_conversion_data_set.rb
 - lib/facebook_ads/ad_objects/offline_terms_of_service.rb
 - lib/facebook_ads/ad_objects/offsite_pixel.rb
@@ -549,6 +549,13 @@ 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/content.rb
+- lib/facebook_ads/ad_objects/server_side/custom_data.rb
+- lib/facebook_ads/ad_objects/server_side/event.rb
+- lib/facebook_ads/ad_objects/server_side/event_request.rb
+- lib/facebook_ads/ad_objects/server_side/event_response.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_config.rb
 - lib/facebook_ads/ad_objects/split_test_winner.rb
 - lib/facebook_ads/ad_objects/store_catalog_settings.rb

data/lib/facebook_ads/ad_objects/business_project.rb

@@ -1,86 +0,0 @@
-# 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 BusinessProject < AdObject
-
-    field :business, 'Business'
-    field :created_time, 'datetime'
-    field :creator, 'object'
-    field :id, 'string'
-    field :name, 'string'
-
-    has_edge :adaccounts do |edge|
-      edge.delete do |api|
-        api.has_param :adaccount_id, 'string'
-      end
-      edge.get 'AdAccount'
-      edge.post 'BusinessProject' do |api|
-        api.has_param :adaccount_id, 'string'
-      end
-    end
-
-    has_edge :apps do |edge|
-      edge.delete do |api|
-        api.has_param :app_id, 'string'
-      end
-      edge.get 'Application'
-      edge.post 'BusinessProject' do |api|
-        api.has_param :app_id, 'string'
-      end
-    end
-
-    has_edge :assets do |edge|
-      edge.delete do |api|
-        api.has_param :asset_id, 'string'
-      end
-      edge.post 'BusinessProject' do |api|
-        api.has_param :asset_id, 'string'
-      end
-    end
-
-    has_edge :pages do |edge|
-      edge.delete do |api|
-        api.has_param :page_id, 'int'
-      end
-      edge.get 'Page'
-      edge.post 'BusinessProject' do |api|
-        api.has_param :page_id, 'int'
-      end
-    end
-
-    has_edge :product_catalogs do |edge|
-      edge.delete do |api|
-        api.has_param :product_catalog_id, 'string'
-      end
-      edge.get 'ProductCatalog'
-      edge.post 'BusinessProject' do |api|
-        api.has_param :product_catalog_id, 'string'
-      end
-    end
-
-  end
-end