facebookbusiness 0.3.0.1

data/lib/facebook_ads/field_types/string_type.rb

@@ -0,0 +1,39 @@
+# 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 FieldTypes
+    # StringType instead of String to avoid name clash with the String class
+    class StringType < Base
+      register 'string'
+
+      def deserialize(value, session = nil)
+        value.is_a?(Array) ? (value * ',') : value.to_s
+      end
+
+      def serialize(value)
+        case value
+          when Hash
+            JSON.generate(value)
+          else
+            value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/facebook_ads/field_types/upload_file.rb

@@ -0,0 +1,121 @@
+# 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 'tempfile'
+
+module FacebookAds
+  module FieldTypes
+    class UploadFile < Base
+      register 'file'
+
+      MIME_TYPES = {
+        zip: {
+          'zip'   => 'application/zip'
+        },
+        image: {
+          'jpg'   => 'image/jpeg',
+          'jpeg'  => 'image/jpeg',
+          'png'   => 'image/png',
+          'gif'   => 'image/gif',
+          'tiff'  => 'image/tiff',
+        },
+        video: {
+          '3g2'   => 'video/3gpp2',
+          '3gp'   => 'video/3gpp',
+          '3gpp'  => 'video/3gpp',
+          'asf'   => 'application/vnd.ms-asf',
+          'avi'   => 'video/x-msvideo',
+          'dat'   => 'application/octet-stream',
+          'divx'  => 'video/divx',
+          'dv'    => 'video/DV',
+          'f4v'   => 'video/mp4',
+          'flv'   => 'video/x-flv',
+          'gif'   => 'image/gif',
+          'm2ts'  => 'video/mpeg',
+          'm4v'   => 'video/vnd.objectvideo',
+          'mkv'   => 'video/x-matroska',
+          'mod'   => 'video/mod',
+          'mov'   => 'video/quicktime',
+          'mp4'   => 'application/mp4',
+          'mpe'   => 'video/mpeg',
+          'mpeg'  => 'video/mpeg',
+          'mpeg4' => 'video/mpeg',
+          'mpg'   => 'video/mpeg',
+          'mts'   => 'model/vnd.mts',
+          'nsv'   => 'application/x-winamp',
+          'ogm'   => 'application/octet-stream',
+          'ogv'   => 'video/ogg',
+          'qt'    => 'video/quicktime',
+          'tod'   => 'application/octet-stream',
+          'ts'    => 'video/MP2T',
+          'vob'   => 'video/x-ms-vob',
+          'wmv'   => 'video/x-ms-wmv',
+        },
+        product_feed: {
+          'csv'   => 'text/csv',
+          'tsv'   => 'text/tab-separated-values',
+          'xml'   => 'text/xml ',
+        }
+      }
+
+      def serialize(value)
+        case value
+          when String, File, Tempfile
+            if value.is_a?(String)
+              raise InvalidParameterError, "No such file: #{value}" unless File.exists?(value)
+              value = File.new(value)
+            end
+
+            ext = File.extname(value.path).gsub(/^./,'')
+            category, content_type = content_type_for(ext)
+
+            raise 'This type of file is not supported' unless content_type
+
+            if category == :video
+              FacebookAds::VideoIO.new(value, content_type)
+            else
+              ::UploadIO.new(value, content_type)
+            end
+          when UploadIO
+            value
+          # when etc etc TODO Rails/Sinatra Upload
+          else
+            raise 'Unknown data type this field'
+        end
+      end
+
+      private
+      def content_type_for(ext)
+        MIME_TYPES.each do |category, types|
+          if type = types[ext]
+            return [category, type]
+          end
+        end
+        nil
+      end
+
+      def self.acceptable?(value)
+        [File, Tempfile, UploadIO].each do |type|
+          return true if value.is_a?(type)
+        end
+
+        value.is_a?(String) ? File.exists?(value) : false
+      end
+    end
+  end
+end

data/lib/facebook_ads/fields.rb

@@ -0,0 +1,66 @@
+# 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 Fields
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      attr_accessor :deserializer, :field_types
+
+      def field(name, type, *args)
+        self.field_types ||= {}
+        self.field_types[name] = type
+
+        unless name == :id
+          define_reader(name)
+          define_writer(name)
+        end
+
+        self.deserializer ||= ParamSet.new
+        self.deserializer.has_param(name, type, *args)
+      end
+
+      def define_reader(name)
+        define_method(name) do
+          if !@__all_fields.include?(name)
+            @__all_fields << name
+            Utils.logger.warn("#{name} not in the fields")
+          end
+
+          load! unless loaded?
+
+          if changes.has_key?(name)
+            changes[name]
+          else
+            @attributes[name]
+          end
+        end
+      end
+
+      def define_writer(name)
+        define_method("#{name}=") do |val|
+          changes[name] = val
+          @__all_fields.add(name.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/facebook_ads/helpers/edge_helpers.rb

@@ -0,0 +1,57 @@
+# 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/md5'
+require 'json'
+
+module FacebookAds
+  module GraphEdges
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def edge_classes
+        @edge_classes
+      end
+
+      def has_edge(name, &block)
+        edge_class = Class.new(Edge)
+        yield edge_class
+
+        @edge_classes ||= {}
+        @edge_classes[name] = edge_class
+
+        # delegate to field if name collides
+        should_delegate = field_types.keys.include?(name)
+
+        define_method(name) do |opts = {}|
+          @edge_proxies ||= {}
+
+          @edge_proxies["#{name}_#{self.class.options_hash(opts)}"] ||= begin
+            edge_class.new(name, self, should_delegate, opts)
+          end
+        end
+      end
+
+      def options_hash(opts)
+        Digest::MD5.hexdigest(JSON.generate(opts))
+      end
+    end
+  end
+end

data/lib/facebook_ads/helpers/node_helpers.rb

@@ -0,0 +1,80 @@
+# 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 GraphNodes
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def has_no_get
+        include NodeHasNoGet
+      end
+
+      def has_no_id
+        include NodeHasNoID
+      end
+
+      def has_no_post
+        include NodeHasNoPost
+      end
+
+      def has_no_delete
+        include NodeHasNoDelete
+      end
+    end
+  end
+
+  module NodeHasNoGet
+    def load!
+      raise 'load! is not supported for this object'
+    end
+  end
+
+  module NodeHasNoID
+    def self.included(base)
+      base.send(:include, NodeHasNoGet)
+      base.instance_eval do
+        def get(id, *args)
+          raise '#get is not supported for this object'
+        end
+      end
+    end
+
+    def id
+      raise 'This node has no id'
+    end
+  end
+
+  module NodeHasNoPost
+    def self.included(base)
+      base.class_eval do
+        undef :save
+      end
+    end
+  end
+
+  module NodeHasNoDelete
+    def self.included(base)
+      base.class_eval do
+        undef :destroy
+      end
+    end
+  end
+end

data/lib/facebook_ads/helpers/shortcuts.rb

@@ -0,0 +1,34 @@
+# 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 Shortcuts
+    def me
+      User.get('me')
+    end
+
+    def ad_account(act_id)
+      act_id = 'act_' + act_id unless id =~ /^act_/
+      AdAccount.get(act_id)
+    end
+
+    def business(biz_id)
+      Business.get(biz_id)
+    end
+  end
+end

data/lib/facebook_ads/param_set.rb

@@ -0,0 +1,74 @@
+# 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
+  class ParamSet
+    def initialize
+      @params = {}
+      @accepts_files = false
+    end
+
+    def has_param(name, type)
+      @params[name.to_sym] = FieldTypes.for(type)
+    end
+
+    def accepts_files!
+      @accepts_files = true
+    end
+
+    def accepts_files?
+      @accepts_files
+    end
+
+    def to_params(data)
+      Hash[data.map do |key,val|
+        key = key.to_sym
+        field_type = @params[key]
+
+        if (!field_type && accepts_files? && FieldTypes::UploadFile.acceptable?(val))
+          field_type = FieldTypes::UploadFile.new
+        end
+
+        if (!field_type && val.is_a?(Array)) # dynamic ads
+          val = JSON.generate(val)
+        end
+
+        [key, (field_type ? field_type.serialize(val) : val)]
+        # TODO CollectionProxy=
+      end]
+    end
+
+    def from_params(data)
+      Hash[data.map do |key,val|
+        key = key.to_sym
+        field_type = @params[key]
+
+        [key, (field_type ? field_type.deserialize(val) : val)]
+      end]
+    end
+
+    # TODO
+    def deserialize(data)
+      from_params(data)
+    end
+
+    def empty?
+      @params.empty?
+    end
+  end
+end