adparlor-facebook 0.5.9

data/lib/adparlor/facebook/graph_api/ad.rb

@@ -0,0 +1,43 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class Ad < GraphObject
+        include Fields::Ad
+        include Traits::Methods
+        field_attrs FIELDS
+        allow_method :create
+        allow_local_method :create, :update, :destroy
+
+        def path
+          raise FbError.new('required parameter account_id missing', 500) unless account_id
+          "/act_#{account_id}/ads"
+        end
+
+        def update_path
+          raise FbError.new('required parameter id missing', 500) unless id
+          "/#{id}"
+        end
+
+        def adcreatives
+          @adcreatives ||= CollectionProxy.new AdCreative, "/#{id}/adcreatives", access_token
+        end
+
+        def leads
+          @leads ||= CollectionProxy.new UserLeadGenInfo, "/#{id}/leads", access_token
+        end
+
+        def previews
+          @previews ||= CollectionProxy.new(AdPreview, "/#{id}/previews", access_token)
+        end
+
+        def reachestimate
+          @reachestimate ||= CollectionProxy.new ReachEstimate, "/#{id}/reachestimate", access_token
+        end
+
+        def targetingsentencelines
+          @targetingsentencelines ||= CollectionProxy.new TargetingSentenceLine, "/#{id}/targetingsentencelines", access_token
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_account.rb

@@ -0,0 +1,168 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class AdAccount < GraphObject
+        include Fields::AdAccount
+        include Traits::Methods
+        field_attrs FIELDS
+        allow_method :create, :destroy, :update
+
+        class << self
+          def get(path_or_account_id, options = {})
+            path = path_or_account_id
+
+            begin
+              account_id = Integer(path_or_account_id)
+              path = "/#{normalize_account_id(account_id)}"
+            rescue
+              STDERR.puts 'Invalid account id passed to get'
+            end
+
+            super(path, options)
+          end
+
+          def normalize_account_id(account_id)
+            account_id = account_id.to_s.downcase
+            if account_id.include?('act_')
+              account_id = account_id
+            else
+              account_id = "act_#{account_id}"
+            end
+            account_id
+          end
+
+          def parse_data_for_collection(response)
+            response['data'].first.last
+          end
+        end
+
+        def normalized_account_id(account_id)
+          "act_#{account_id}"
+        end
+
+        def activities
+          @activities ||= CollectionProxy.new Activity, endpoint('activities'), access_token
+        end
+
+        def adcreatives
+          @adcreatives ||= CollectionProxy.new AdCreative, endpoint('adcreatives'), access_token
+        end
+
+        def adimages
+          @adimages ||= CollectionProxy.new AdImage, endpoint('adimages'), access_token
+        end
+
+        def adlabels
+          @adlabels ||= CollectionProxy.new AdLabel, endpoint('adlabels'), access_token
+        end
+
+        def ads
+          @ads ||= CollectionProxy.new Ad, endpoint('ads'), access_token
+        end
+
+        def adsets
+          @adsets ||= CollectionProxy.new AdSet, endpoint('adsets'), access_token
+        end
+
+        def adspixels
+          @adspixels ||= CollectionProxy.new AdsPixel, endpoint('adspixels'), access_token
+        end
+
+        def advertisable_applications
+          @advertisable_applications ||= CollectionProxy.new AdvertisableApplication, endpoint('advertisable_applications'), access_token
+        end
+
+        def advideos
+          @advideos ||= CollectionProxy.new AdVideo, endpoint('advideos'), access_token
+        end
+
+        def applications
+          @applications ||= CollectionProxy.new Application, endpoint('applications'), access_token
+        end
+
+        def broadtargetingcategories
+          @broadtargetingcategories ||= CollectionProxy.new BroadTargetingCategory, endpoint('broadtargetingcategories'), access_token
+        end
+
+        # Deprecated in v2.6. Please Use advertisable_applications, pages, places endpoint instead
+        def connectionobjects
+          Kernel::fail("connectionobjects is deprecated in v2.6. Use advertisable_applications, pages, places endpoint instead")
+        end
+
+        def campaigns
+          @campaigns ||= CollectionProxy.new Campaign, endpoint('campaigns'), access_token
+        end
+
+        def customaudiences
+          @customaudiences ||= CollectionProxy.new CustomAudience, endpoint('customaudiences'), access_token
+        end
+
+        def customaudiencestos
+          @customaudiencestos ||= CollectionProxy.new CustomAudienceTos, endpoint('customaudiencestos'), access_token
+        end
+
+        def customconversions
+          @customconversions ||= CollectionProxy.new CustomConversion, endpoint('customconversions'), access_token
+        end
+
+        def delivery_estimate
+          @delivery_estimate ||= CollectionProxy.new DeliveryEstimate, endpoint('delivery_estimate'), access_token
+        end
+
+        def generatepreviews
+          @generatepreviews ||= CollectionProxy.new AdPreview, endpoint('generatepreviews'), access_token
+        end
+
+        def insights
+          @insights ||= CollectionProxy.new Insight, endpoint('insights'), access_token
+        end
+
+        def instagram_accounts
+          @instagram_accounts ||= CollectionProxy.new InstagramAccount, endpoint('instagram_accounts'), access_token
+        end
+
+        def offsitepixels
+          Kernel::fail("offsite_pixels is deprecated in v2.7 and above.")
+        end
+
+        def pages
+          @pages ||= CollectionProxy.new PageAndPlace, 'me/accounts', access_token
+        end
+
+        def places
+          @places ||= CollectionProxy.new PageAndPlace, 'me/accounts', access_token, nil, is_place: true
+        end
+
+        def partnercategories
+          @partnercategories ||= CollectionProxy.new PartnerCategory, endpoint('partnercategories'), access_token
+        end
+
+        def reachestimate
+          @reachestimate ||= CollectionProxy.new ReachEstimate, endpoint('reachestimate'), access_token
+        end
+
+        def reachfrequencypredictions
+          @reachfrequencypredictions ||= CollectionProxy.new ReachFrequencyPrediction, endpoint('reachfrequencypredictions'), access_token
+        end
+
+        def targetingsentencelines
+          @targetingsentencelines ||= CollectionProxy.new TargetingSentenceLine, endpoint('targetingsentencelines'), access_token
+        end
+
+        def targetingsuggestions
+          @targetingsuggestions ||= CollectionProxy.new TargetingSuggestion, endpoint('targetingsuggestions'), access_token
+        end
+
+        def targetingvalidation
+          @targetingvalidation ||= CollectionProxy.new TargetingValidation, endpoint('targetingvalidation'), access_token
+        end
+
+        private
+
+        def endpoint(connection)
+          "/#{normalized_account_id(account_id)}/#{connection}"
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_creative.rb

@@ -0,0 +1,22 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class AdCreative < GraphObject
+        include Fields::AdCreative
+        include Traits::Methods
+        field_attrs FIELDS
+        allow_method :create
+        allow_local_method :update, :destroy
+
+        def update_path
+          raise FbError.new('required parameter id missing', 500) unless id
+          "/#{id}"
+        end
+
+        def previews
+          @previews ||= CollectionProxy.new(AdPreview, "/#{id}/previews", access_token)
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_image.rb

@@ -0,0 +1,87 @@
+require 'mime/types'
+require 'open-uri'
+
+module Adparlor
+  module Facebook
+    module GraphApi
+      class AdImage < GraphObject
+        include Fields::AdImage
+        include Traits::Methods
+        field_attrs FIELDS
+        allow_method :create, :destroy
+        allow_local_method :create, :destroy
+
+        def formatted_image
+          return unless @source
+          if %r{https?}.match(@source)
+            file = open(@source)
+
+            # return nil if we can't open the file from the url
+            return nil if file.nil?
+
+            content_type = AdImage.get_content_type(file.content_type, normalized_file_name)
+            extension = AdImage.get_preferred_extension(content_type)
+
+            # if content type or extension doesn't exist, the upload will fail on FB side
+            return nil if content_type.nil? || extension.nil?
+
+            @source = AdImage.upload_file_with_content_type(normalized_file_name, file, content_type, extension)
+          else
+            @source = Faraday::UploadIO.new(normalized_file_name, MIME::Types.type_for(normalized_file_name).first.content_type)
+          end
+        end
+
+        def path
+          raise FbError.new('required parameter account_id missing', 500) unless account_id
+          if account_id.to_s.include?('act_')
+            "/#{account_id}/adimages"
+          else
+            "/act_#{account_id}/adimages"
+          end
+        end
+
+        def post(path, options, method = nil)
+          raise FbError.new('update not available', 500) if method == 'UPDATE'
+          formatted_image
+          super path, options
+        end
+
+        def update_path
+          path
+        end
+
+        class << self
+          def upload_file_with_content_type(normalized_file_name, file, content_type, extension)
+            tmp_file = Tempfile.new([File.basename(normalized_file_name), ".#{extension}"])
+
+            tmp_file.binmode
+            tmp_file.write(file.read)
+            tmp_file.rewind
+
+            Faraday::UploadIO.new(tmp_file.path, content_type)
+          end
+
+          def get_preferred_extension(content_type)
+            MIME::Types[content_type].first.preferred_extension
+          end
+
+          def get_content_type(header_content_type, file_name)
+            content_type = MIME::Types.type_for(file_name)
+
+            return content_type.first.content_type if !file_name.include?('safe_image.php') && !content_type.nil?
+
+            header_content_type.empty? ? nil : header_content_type
+          end
+        end
+
+        private
+
+        # Remove any query string parameters before getting the mime type
+        # should probably be done in mime types gem
+        def normalized_file_name
+          @source.split('?').first
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_label.rb

@@ -0,0 +1,12 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class AdLabel < GraphObject
+        include Fields::AdLabel
+        include Traits::Methods
+        field_attrs FIELDS
+        allow_method :create
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_preview.rb

@@ -0,0 +1,15 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class AdPreview < GraphObject
+        include Fields::AdPreview
+        include Traits::Methods
+        field_attrs FIELDS
+
+        def path
+          '/generatepreviews'
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_set.rb

@@ -0,0 +1,39 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class AdSet < GraphObject
+        include Fields::AdSet
+        include Traits::Methods
+        field_attrs FIELDS
+        allow_method :create
+        allow_local_method :create, :update, :destroy
+
+        def path
+          raise FbError.new('required parameter account_id missing', 500) unless account_id
+          "/act_#{account_id}/adsets"
+        end
+
+        def update_path
+          raise FbError.new('required parameter id missing', 500) unless id
+          "/#{id}"
+        end
+
+        def activities
+          @activities ||= CollectionProxy.new Activity, "/#{id}/activities", access_token
+        end
+
+        def adcreatives
+          @adcreatives ||= CollectionProxy.new AdCreative, "/#{id}/adcreatives", access_token
+        end
+
+        def ads
+          @ads ||= CollectionProxy.new Ad, "/#{id}/ads", access_token
+        end
+
+        def targetingsentencelines
+          @targetingsentencelines ||= CollectionProxy.new TargetingSentenceLine, "/#{id}/targetingsentencelines", access_token
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_search.rb

@@ -0,0 +1,64 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class AdTargetingSearch
+        include Adparlor::Facebook::Api
+
+        def initialize(access_token)
+          @access_token = access_token
+        end
+
+        def path
+          '/search'
+        end
+
+        def search(query, type, options = {})
+          type_param = type.respond_to?(:type_param) ? type.type_param : type.name.split('::').last.downcase
+          params = { q: query, type: type_param, access_token: @access_token }
+          params.merge!(type::OPTIONS) if type.const_defined?('OPTIONS')
+          params.merge!(options)
+          response = get(path, params)
+          if response.body['data'].is_a?(Hash)
+            obj = type.new
+            keys = response.body['data'].keys
+            keys.each do |key|
+              vals = []
+              response.body['data'][key].each do |val|
+                vals << parse_value(key, val.last)
+              end
+              obj.send("#{key}=".to_sym, vals)
+            end
+            obj
+          else
+            response.body['data'].map do |data|
+              obj = type.new
+              data.each do |k, v|
+                obj.send("#{k}=".to_sym, v)
+              end
+              obj
+            end
+          end
+        end
+
+        private
+
+        def parse_value(key, value)
+          case key
+          when 'countries'
+            obj = AdTargetingTypes::AdGeolocations::AdCountry.new
+          when 'cities'
+            obj = AdTargetingTypes::AdGeolocations::AdCity.new
+          when 'regions'
+            obj = AdTargetingTypes::AdGeolocations::AdRegion.new
+          when 'zips'
+            obj = AdTargetingTypes::AdGeolocations::AdZipCode.new
+          else
+            return value.to_s
+          end
+          value.each { |k, v| obj.send("#{k}=".to_sym, v) }
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_education_major.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdEducationMajor
+          attr_accessor :coverage, :name, :id
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_education_school.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdEducationSchool
+          attr_accessor :coverage, :name, :id, :subtext
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_geolocation.rb

@@ -0,0 +1,19 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdGeolocation
+          attr_accessor :key, :name, :type, :supports_city, :supports_region,
+                        :country_code, :country_name, :region, :region_id,
+                        :primary_city, :primary_city_id, :geo_hierarchy_level, :geo_hierarchy_name
+
+          class << self
+            def type_param
+              'adgeolocation'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_geolocation_meta.rb

@@ -0,0 +1,16 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdGeolocationMeta
+          attr_accessor :electoral_districts, :cities, :countries, :custom_locations,
+                        :geo_markets, :places, :regions, :zips, :country_groups,
+                        :subneighborhoods, :neighborhoods, :subcities, :metro_areas,
+                        :large_geo_areas, :small_geo_areas, :medium_geo_areas,
+                        :location_cluster_ids
+
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_geolocations/ad_city.rb

@@ -0,0 +1,13 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        module AdGeolocations
+          class AdCity < AdGeolocation
+            OPTIONS = { location_types: %w(city) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_geolocations/ad_country.rb

@@ -0,0 +1,13 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        module AdGeolocations
+          class AdCountry < AdGeolocation
+            OPTIONS = { location_types: %w(country) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_geolocations/ad_geo_market.rb

@@ -0,0 +1,13 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        module AdGeolocations
+          class AdGeoMarket < AdGeolocation
+            OPTIONS = { location_types: %w(geo_market) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_geolocations/ad_region.rb

@@ -0,0 +1,13 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        module AdGeolocations
+          class AdRegion < AdGeolocation
+            OPTIONS = { location_types: %w(region) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_geolocations/ad_zip_code.rb

@@ -0,0 +1,13 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        module AdGeolocations
+          class AdZipCode < AdGeolocation
+            OPTIONS = { location_types: %w(zip) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_interest.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdInterest
+          attr_accessor :id, :audience_size, :description, :name, :path, :topic
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_interest_suggestion.rb

@@ -0,0 +1,12 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdInterestSuggestion
+          attr_accessor :id, :audience_size, :country, :country_access,
+                        :description, :name, :partner, :path, :source, :type, :topic
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_interest_validation.rb

@@ -0,0 +1,18 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdInterestValidation
+          attr_accessor :id, :audience_size, :country, :country_access, :description,
+                        :name, :path, :partner, :source, :topic, :type, :valid
+
+          class << self
+            def type_param
+              'adinterestvalid'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_locale.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdLocale
+          attr_accessor :key, :name
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_radius_suggestion.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdRadiusSuggestion
+          attr_accessor :suggested_radius, :distance_unit
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/ad_targeting_types/ad_targeting_category.rb

@@ -0,0 +1,18 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module AdTargetingTypes
+        class AdTargetingCategory
+          attr_accessor :id, :audience_size, :country, :country_access, :description, :name,
+                        :real_time_cluster, :partner, :path, :source, :type
+
+          class << self
+            def type_param
+              'adTargetingCategory'
+            end
+          end
+        end
+      end
+    end
+  end
+end