facebookads 0.0.1 → 0.2.9

data/lib/facebook_ads/edge.rb

@@ -0,0 +1,184 @@
+# 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 EdgeHasGet
+    include Enumerable
+
+    extend Forwardable
+    def_delegators :@collection, :length, :count
+
+    DEFAULT_PAGE_SIZE = 10
+    attr_accessor :has_next_page, :next_page_cursor
+
+    def [](idx)
+      # TODO Handle delegate
+      fetch_next_page until idx < collection.length || !has_next_page?
+      collection[idx]
+    end
+
+    def all
+      fetch_next_page until !has_next_page?
+      collection
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      idx = 0
+
+      while (e = self[idx])
+        yield e
+        idx += 1
+      end
+
+      self
+    end
+
+    def reload!
+      @collection = Array.new
+      self.has_next_page = true
+    end
+
+    private
+    def fetch_next_page
+      fetch_options = {limit: DEFAULT_PAGE_SIZE}.merge(serialized_options)
+      fetch_options = fetch_options.merge({after: next_page_cursor}) if next_page_cursor
+
+      node.get_edge(name, fetch_options) do |response|
+        response["data"].each do |data|
+          field_type = self.class.return_types[:get]
+
+          obj = field_type.deserialize(data, node.session)
+          collection << obj
+        end
+
+        self.next_page_cursor = response.dig('paging', 'cursors', 'after')
+        self.has_next_page = !(response['data'].length < fetch_options[:limit])
+      end
+    end
+
+    def collection
+      @collection ||= Array.new
+    end
+
+    def has_next_page?
+      self.has_next_page.nil? ? (self.has_next_page = true) : self.has_next_page
+    end
+
+    def loaded?
+      @loaded
+    end
+  end
+
+  module EdgeHasPost
+    def create(params)
+      if self.class.param_set_for_post
+        params = self.class.param_set_for_post.to_params(params)
+      end
+
+      node.post_edge(name, graph_params.merge(params)) do |response|
+        # TODO params check
+        # TODO Add new object to collection?
+
+        field_type = self.class.return_types[:post]
+
+        obj = field_type.deserialize(response, node.session)
+        yield obj if block_given?
+        obj
+      end
+    end
+  end
+
+  module EdgeHasDelete
+    def destroy(params)
+      params = @param_set_for_delete.to_params(params) if @param_set_for_delete
+
+      node.delete_edge(name, params) do |response|
+        yield response if block_given?
+        response
+      end
+    end
+  end
+
+  class Edge
+    attr_reader :name, :node, :options, :should_delegate
+
+    def initialize(name, node, should_delegate, options)
+      @name = name
+      @node = node
+      @options = options || {}
+      @should_delegate = should_delegate
+    end
+
+    def serialized_options
+      Hash[options.map { |k,v|
+        v = (k == :fields && v.is_a?(Array)) ?
+             v.join(',') : v
+        [k,v]
+      }]
+    end
+
+    # TODO refactor
+    # sending this along with params to leverage read-after-write
+    def graph_params
+      {fields: options[:fields]}.compact
+    end
+
+    class << self
+      attr_reader :param_set_for_get, :param_set_for_post, :param_set_for_delete
+
+      def get(return_type = 'AdObject')
+        include EdgeHasGet
+
+        yield (@param_set_for_get = ParamSet.new) if block_given?
+
+        return_types(:get, return_type)
+      end
+
+      def post(return_type = 'AdObject')
+        include EdgeHasPost
+
+        yield (@param_set_for_post = ParamSet.new) if block_given?
+
+        return_types(:post, return_type)
+      end
+
+      def delete(return_type = 'AdObject')
+        include EdgeHasDelete
+
+        yield (@param_set_for_delete = ParamSet.new) if block_given?
+
+        return_types(:delete, return_type)
+      end
+
+      # TODO refactor?
+      def return_types(action = nil, return_type = nil)
+        if action
+          if return_type
+            @return_types ||= {}
+            @return_types[action] = FieldTypes.for(return_type)
+          end
+          @return_types[action]
+        else
+          @return_types
+        end
+      end
+    end
+  end
+end

data/lib/facebook_ads/errors.rb

@@ -0,0 +1,55 @@
+# 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 'irb'
+
+module FacebookAds
+  class Error < StandardError; end;
+  class InvalidParameterError < Error; end;
+
+  class APIError < Error
+    ERROR_ATTRS = [
+      :fb_message, :type, :code,
+      :error_subcode, :is_transient, :error_user_title,
+      :error_user_msg, :fbtrace_id,
+    ]
+
+    attr_accessor *ERROR_ATTRS
+
+    def initialize(api_response)
+      error_obj = api_response.result
+      @api_response = api_response
+
+      if error_obj.is_a?(Hash)
+        error_obj = error_obj['error'] if error_obj.has_key?('error')
+        error_obj.each do |k,v|
+          k = "fb_#{k}" if k == 'message'
+          send("#{k}=", v) if ERROR_ATTRS.include?(k.to_sym)
+        end
+
+        super("#{self.fb_message}: #{self.error_user_title} (fbtrace_id: #{self.fbtrace_id})")
+      else
+        super(error_obj)
+      end
+    end
+  end
+
+  class ServerError < APIError; end
+
+  class ClientError < APIError; end
+end

data/lib/facebook_ads/field_types/ad_object.rb

@@ -0,0 +1,37 @@
+# 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 AdObject < Base
+      register 'ad_object'
+
+      def initialize(ad_object_class)
+        @ad_object_class = ad_object_class
+      end
+
+      def deserialize(value, session = nil)
+        @ad_object_class.new(value, value.keys, session)
+      end
+
+      def serialize(value)
+        value.to_json
+      end
+    end
+  end
+end

data/lib/facebook_ads/field_types/base.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 Base
+      extend FieldTypes
+
+      def deserialize(value, session = nil)
+        value
+      end
+
+      def serialize(value)
+        value
+      end
+    end
+  end
+end

data/lib/facebook_ads/field_types/boolean.rb

@@ -0,0 +1,25 @@
+# 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 Boolean < Base
+      register 'bool', 'boolean'
+    end
+  end
+end

data/lib/facebook_ads/field_types/datetime.rb

@@ -0,0 +1,47 @@
+# 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 'date'
+
+module FacebookAds
+  module FieldTypes
+    class DateTime < Base
+      register 'datetime'
+
+      def deserialize(value, session = nil)
+        case value
+          when String
+            DateTime.strptime(value, '%FT%T%:z')
+          else
+            Time.at(value).to_datetime
+        end
+      end
+
+      def serialize(value)
+        case value
+          when DateTime, Time
+            value.to_time.to_i
+          when String
+            DateTime.parse(value).to_time.to_i
+          else
+            value
+        end
+      end
+    end
+  end
+end

data/lib/facebook_ads/field_types/double.rb

@@ -0,0 +1,29 @@
+# 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 Double < Base
+      register 'float', 'double'
+
+      def deserialize(value, session = nil)
+        value.is_a?(String) ? value[/[0-9.]+/].to_f : value
+      end
+    end
+  end
+end

data/lib/facebook_ads/field_types/enum.rb

@@ -0,0 +1,31 @@
+# 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 Enum < Base
+      register :enum, 'enum'
+
+      def initialize(vals)
+        @values = (vals.is_a?(Proc) ? vals.call : vals )
+      end
+
+      # TODO Valid Value checking?
+    end
+  end
+end