adparlor-facebook 0.5.9

data/lib/adparlor/facebook/graph_api/fields/page.rb

@@ -0,0 +1,121 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module Page
+          FIELDS = [
+            :id,
+            :about,
+            :access_token,
+            :ad_campaign,
+            :affiliation,
+            :app_id,
+            :app_links,
+            :artists_we_like,
+            :attire,
+            :awards,
+            :band_interests,
+            :band_members,
+            :best_page,
+            :bio,
+            :birthday,
+            :booking_agent,
+            :built,
+            :business,
+            :can_checkin,
+            :can_post,
+            :category,
+            :category_list,
+            :company_overview,
+            :contact_address,
+            :context,
+            :country_page_likes,
+            :cover,
+            :culinary_team,
+            :current_location,
+            :description,
+            :description_html,
+            :directed_by,
+            :display_subtext,
+            :emails,
+            :features,
+            :food_styles,
+            :founded,
+            :general_info,
+            :general_manager,
+            :genre,
+            :global_brand_page_name,
+            :global_brand_root_id,
+            :has_added_app,
+            :leadgen_tos_accepted,
+            :hometown,
+            :hours,
+            :impressum,
+            :influences,
+            :is_always_open,
+            :is_community_page,
+            :is_permanently_closed,
+            :is_published,
+            :is_unclaimed,
+            :is_verified,
+            :link,
+            :location,
+            :mission,
+            :mpg,
+            :name,
+            :name_with_location_descriptor,
+            :network,
+            :new_like_count,
+            :offer_eligible,
+            :parent_page,
+            :parking,
+            :payment_options,
+            :personal_info,
+            :personal_interests,
+            :pharma_safety_info,
+            :phone,
+            :plot_outline,
+            :press_contact,
+            :price_range,
+            :produced_by,
+            :products,
+            # NOTE: Documentation still supports these fields but all requests with them
+            # are failing. Removing as it is not currently in use in relevant applications
+            # :promotion_eligible,
+            # :promotion_ineligible_reason,
+            :public_transit,
+            :record_label,
+            :release_date,
+            :restaurant_services,
+            :restaurant_specialties,
+            :schedule,
+            :screenplay_by,
+            :season,
+            :starring,
+            :start_info,
+            :store_location_descriptor,
+            :store_number,
+            :studio,
+            :talking_about_count,
+            :engagement,
+            :single_line_address,
+            :place_type,
+            :unread_message_count,
+            :unread_notif_count,
+            :unseen_message_count,
+            :username,
+            :verification_status,
+            :voip_info,
+            :website,
+            :were_here_count,
+            :written_by,
+            :featured_video,
+            :checkins,
+            :likes,
+            :members
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/page_and_place.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module PageAndPlace
+          FIELDS = [:id, :name, :name_with_location_descriptor].freeze
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/partner_category.rb

@@ -0,0 +1,12 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module PartnerCategory
+          FIELDS = [:id, :name, :approximate_count, :path, :description, :source,
+                    :partner, :type]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/picture.rb

@@ -0,0 +1,17 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module Picture
+          FIELDS = [
+            :cache_key,
+            :height,
+            :is_silhouette,
+            :url,
+            :width
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/post.rb

@@ -0,0 +1,17 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module Post
+          FIELDS = [:id, :admin_creator, :application, :child_attachments, :call_to_action, :caption, :created_time, :description,
+                    :feed_targeting, :from, :icon, :is_instagram_eligible, :is_hidden, :is_published, :link, :message, :message_tags, 
+                    :name, :picture, :place, :privacy, :properties, :shares, :source, :status_type, :story, :story_tags,
+                    :targeting, :to, :type, :updated_time, :with_tags, :object_id, :full_picture, :actions, :likes, :attachments
+                    ]
+
+          CREATE_FIELDS = FIELDS + [:scheduled_published_time]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/product_audience.rb

@@ -0,0 +1,12 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module ProductAudience
+          FIELDS = [:account_id]
+          CREATE_FIELDS = [:account_id, :description, :exclusions, :inclusions, :name, :product_set_id]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/product_catalog.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module ProductCatalog
+          FIELDS = [:id, :access_status, :access_type, :business, :feed_count, :name, :permitted_roles, :product_count]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/product_feed.rb

@@ -0,0 +1,12 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module ProductFeed
+          FIELDS = [:id, :country, :created_time, :default_currency, :deletion_enabled, :delimiter,
+                    :encoding, :file_name, :latest_upload, :name, :product_count, :schedule]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/product_group.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module ProductGroup
+          FIELDS = [:id, :retailer_id, :variants]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/product_item.rb

@@ -0,0 +1,18 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module ProductItem
+          FIELDS = [:id, :additional_image_urls, :age_group, :applinks, :availability, :brand,
+                    :category, :color, :commerce_insights, :condition, :custom_data, :custom_label_0,
+                    :custom_label_1, :custom_label_2, :custom_label_3, :custom_label_4, :description,
+                    :expiration_date, :gender, :gtin, :image_url, :manufacturer_part_number, :material,
+                    :name, :ordering_index, :pattern, :price, :product_feed, :product_type, :retailer_id,
+                    :retailer_product_group_id, :review_rejection_reasons, :review_status, :sale_price,
+                    :sale_price_end_date, :sale_price_start_date, :shipping_weight_unit,
+                    :shipping_weight_value, :size, :start_date, :url, :visibility]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/product_set.rb

@@ -0,0 +1,13 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module ProductSet
+          FIELDS = [:id, :filter, :name, :product_catalog, :product_count]
+          CREATE_FIELDS = [:name, :filter, :product_catalog_id]
+          UPDATE_FIELDS = [:name, :filter, :product_catalog_id]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/reach_estimate.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module ReachEstimate
+          FIELDS = [:users, :bid_estimations, :estimate_ready]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/reach_frequency_prediction.rb

@@ -0,0 +1,24 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module ReachFrequencyPrediction
+          FIELDS = [:id, :account_id, :activity_status, :buying_type, :campaign_group_id, :campaign_id, :campaign_time_start,
+                    :campaign_time_stop, :currency, :daily_impression_curve, :demo_breakdown, :destination_id,
+                    :expiration_time, :external_budget, :external_impression, :external_maximum_budget, :external_maximum_impression,
+                    :external_maximum_reach, :external_minimum_budget, :external_minimum_impression, :external_minimum_reach, :external_reach,
+                    :frequency_cap, :frequency_distribution, :grp_audience_size, :grp_country_audience_size, :grp_dmas_audience_size,
+                    :grp_points, :grp_ratio, :grp_reach_ratio, :grp_status, :holdout_percentage, :impression_curve, :instagram_destination_id,
+                    :interval_frequency_cap, :interval_frequency_cap_reset_period, :is_bonus_media, :is_conversion_goal, :name, :objective_name,
+                    :pause_periods, :placement_breakdown, :prediction_mode, :prediction_progress, :reference_id, :reservation_status, :status,
+                    :story_event_type, :target_audience_size, :target_cpm, :target_spec, :time_created, :time_updated, :timezone_id,
+                    :timezone_name, :topline_id]
+          CREATE_FIELDS = [:action, :budget, :campaign_group_id, :day_parting_schedule, :destination_id, :destination_ids, :end_time,
+                           :frequency_cap, :impression, :interval_frequency_cap_reset_period, :num_curve_points, :objective, :prediction_mode,
+                           :reach, :rf_prediction_id, :rf_prediction_id_to_release, :rf_prediction_id_to_share, :start_time, :stop_time,
+                           :story_event_type, :target_spec]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/targeting_sentence_line.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module TargetingSentenceLine
+          FIELDS = [:id, :params, :targetingsentencelines]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/targeting_suggestion.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module TargetingSuggestion
+          FIELDS = [:id, :audience_size, :description, :name, :path, :type]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/targeting_validation.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module TargetingValidation
+          FIELDS = [:audience_size, :id, :name, :path, :type, :valid]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/user_lead_gen_info.rb

@@ -0,0 +1,18 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module UserLeadGenInfo
+          FIELDS = [
+            :id,
+            :ad_group_id,
+            :created_time,
+            :field_data,
+            :form_id,
+            :post
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/video_thumbnail.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module VideoThumbnail
+          FIELDS = [:id, :height, :is_preferred, :name, :scale, :uri, :width].freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class GraphObject
+        include Fields::FieldDecorator
+        include Adparlor::Facebook::Api
+        attr_accessor :access_token
+
+        class << self
+          def read(attributes = {}, options = {})
+            self.get(new(attributes).path, options)
+          end
+
+          def create(attributes = {}, options = {})
+            obj = new(attributes)
+            obj.post(obj.path, options)
+          end
+
+          def update(attributes = {}, options = {})
+            obj = new(attributes)
+            obj.post(obj.update_path, options, 'UPDATE')
+          end
+
+          def destroy(attributes = {}, options = {})
+            obj = new(attributes)
+            obj.delete(obj.update_path, options)
+          end
+
+          # TODO: make each of the gets a read shift get into method on Adparlor::Facebook::Api
+          def get(path, options = {})
+            max_results = options.delete(:max_results)
+
+            unless max_results.nil?
+              options[:limit] ||= 100
+              options[:limit] = [max_results, options[:limit]].min
+            end
+
+            response = new.get(path.to_s, options).body
+            raise FbError.new(response['error'], 500) if response.key?('error')
+            response['data'] = response.values if options[:ids]
+
+            if response.key?('data')
+              respond_for_data(response, options[:limit], max_results)
+            else
+              obj = new(response)
+              obj.access_token ||= options[:access_token]
+              obj
+            end
+          end
+
+          def respond_for_data(response, limit, max_results)
+            if data_pass_through
+              new(response['data'])
+            else
+              return response['summary'] if response['summary']
+              data = parse_data_for_collection(response)
+              while response['paging'] && response['paging']['next']
+                if max_results.nil? || data.size < max_results
+                  options = max_results.nil? ? {} : { limit: [(max_results - data.size), limit].min } # remaining limit
+                  response = new.get(response['paging']['next'].delete('\\'), options).body
+                  data += parse_data_for_collection(response)
+                else
+                  break
+                end
+              end
+              data.map { |object| new(object) } || []
+            end
+          end
+
+          def parse_data_for_collection(response)
+            response['data']
+          end
+
+          def data_pass_through
+            false
+          end
+        end
+
+        def initialize(attributes = {})
+          self.class.validate_initialize_fields(*attributes.keys) if self.class.respond_to?(:validate_initialize_fields)
+          if self.class != AdImage && attributes[:source]
+            @files = {}
+            attach_file(attributes)
+          end
+          attributes.each { |key, value| instance_variable_set("@#{key}".to_sym, value) }
+          self
+        end
+
+        def batch
+          batch_api = BatchObject.new(self)
+          if block_given?
+            yield batch_api
+            batch_api.execute
+          else
+            batch_api
+          end
+        end
+
+        def create(path, options = {})
+          post(path, options)
+        end
+
+        def destroy(path, options = {})
+          delete(path, options)
+        end
+
+        def update(path, options = {})
+          post(path, options, 'UPDATE')
+        end
+
+        def to_hash
+          {}.tap do |h|
+            self.instance_variables.each do |v|
+              attribute = v.to_s.gsub('@','')
+              h[attribute] = self.send(attribute)
+            end
+          end
+        end
+
+        def to_json
+          self.to_hash.to_json
+        end
+
+        private
+
+        def attach_file(attributes = {})
+          return nil unless attributes[:source]
+          # Strips the query string when present
+          if %r{image}.match(MIME::Types.type_for(attributes[:source].split('?').first).first.content_type)
+            file = AdImage.new(source: attributes.delete(:source)).formatted_image
+            attributes[:image_file] = file.original_filename
+            attached_file = "file#{@files.length}"
+            @files[attached_file] = file
+            attached_file
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class Insight < GraphObject
+        include Fields::Insight
+        include Traits::Methods
+        field_attrs FIELDS
+        allow_method :read
+
+        def path
+          raise FbError.new('required parameter account_id missing', 500) unless account_id
+          body = instance_variables.each_with_object({}) { |var, hash| hash[var.to_s.sub(/@/, '').to_sym] = instance_variable_get(var) }
+          "/act_#{account_id}/insights?#{Faraday::NestedParamsEncoder.encode(body)}"
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,10 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class LeadgenForm < GraphObject
+        include Fields::LeadgenForm
+        field_attrs FIELDS
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class Page < GraphObject
+        include Fields::Page
+        include Traits::Methods
+        field_attrs FIELDS
+
+        def promotable_posts
+          @promotable_posts ||= CollectionProxy.new(Post, "/#{id}/promotable_posts", access_token)
+        end
+
+        def picture
+          @picture ||= CollectionProxy.new(Picture, "/#{id}/picture", access_token)
+        end
+
+        def page_backed_instagram_accounts
+          @page_backed_instagram_accounts ||= CollectionProxy.new(InstagramAccount, "/#{id}/page_backed_instagram_accounts", access_token)
+        end
+
+        def leadgen_forms
+          @leadgen_forms ||= CollectionProxy.new(LeadgenForm, "/#{id}/leadgen_forms", access_token)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class PageAndPlace < GraphObject
+        include Fields::PageAndPlace
+        include Traits::Methods
+        field_attrs FIELDS
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class PartnerCategory < GraphObject
+        include Fields::PartnerCategory
+        include Traits::Methods
+        field_attrs FIELDS
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class Picture < GraphObject
+        include Fields::Picture
+        include Traits::Methods
+        field_attrs FIELDS
+
+        def self.data_pass_through
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class Post < GraphObject
+        include Fields::Post
+        include Traits::Methods
+        field_attrs FIELDS
+        allow_local_method :destroy
+
+        def update_path
+          raise FbError.new('required parameter id missing', 500) unless @id
+          "/#{@id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      class ProductAudience < GraphObject
+        include Fields::ProductAudience
+        include Traits::Methods
+        field_attrs FIELDS
+        allow_local_method :create
+
+        def path
+          raise FbError.new('required parameter account_id missing', 500) unless account_id
+          "/act_#{account_id}/product_audiences"
+        end
+      end
+    end
+  end
+end