facebookads 0.0.1 → 0.2.9

data/lib/facebook_ads/field_types/integer.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 FieldTypes
+    class Integer < Base
+      register 'int', 'integer'
+
+      def deserialize(value, session = nil)
+        value.is_a?(::Integer) ? value : value.to_s[/[0-9]+/].to_i
+      end
+
+      def serialize(value)
+        value.to_s
+      end
+    end
+  end
+end

data/lib/facebook_ads/field_types/list.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.
+
+module FacebookAds
+  module FieldTypes
+    class List < Base
+      register :list, 'list'
+
+      def initialize(sub_type)
+        @sub_type = self.class.for(sub_type)
+      end
+
+      def deserialize(value, session = nil)
+        case value
+          when String
+            JSON.parse(value).map { |v|
+              @sub_type.deserialize(v, session)
+            }
+          when Array
+            value.map { |v|
+              @sub_type.deserialize(v, session)
+            }
+          when Hash
+            # Special handle for images
+            if value.length == 1 && value.keys.first == 'images'
+              value = value['images']
+            end
+
+            value.map { |_,v|
+              @sub_type.deserialize(v, session)
+            }
+          else
+            [value]
+        end
+      end
+
+      def serialize(value)
+        JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/facebook_ads/field_types/object.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 FieldTypes
+    class Object < Base
+      register 'hash', 'map', 'object'
+
+      def deserialize(value, session = nil)
+        value.is_a?(String) ? JSON.parse(value) : value
+      end
+
+      def serialize(value)
+        JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/facebook_ads/field_types/string_type.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 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)
+        value.to_s
+      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/field_types.rb

@@ -0,0 +1,65 @@
+# 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 'facebook_ads/field_types/base'
+
+module FacebookAds
+  module FieldTypes
+    def register(*type_names)
+      @@registry ||= {}
+      type_names.each do |type_name|
+        @@registry[type_name] = self
+      end
+    end
+
+    def lookup(type_name)
+      @@registry && @@registry[type_name]
+    end
+
+    def for(type_spec)
+      if type_spec.is_a?(Hash)
+        type_key = type_spec.keys[0]
+
+        if field_type = lookup(type_key)
+          field_type.new(type_spec[type_key])
+        else
+          raise "Invalid type: #{type_key}"
+        end
+      else
+        if (field_type = lookup(type_spec))
+          field_type.new
+        else
+          begin
+            ad_object_class = FacebookAds.const_get(type_spec)
+            field_type = lookup('ad_object')
+            field_type.new(ad_object_class)
+          rescue NameError
+            # fallback to string class if nothing matches
+            lookup('string').new
+          end
+        end
+      end
+    end
+
+    extend self
+  end
+end
+
+Dir.glob(File.expand_path(File.join(__FILE__, '..', 'field_types', '*.rb'))).each do |file|
+  require file
+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 !fields.include?(name)
+            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
+          @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