facebookads 0.0.1 → 0.2.9

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

data/lib/facebook_ads/ruby2patch.rb

@@ -0,0 +1,27 @@
+# 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.
+
+class Hash
+  def dig(k, *ks)
+    key?(k) ? (ks.empty? ? self[k] : self[k].dig(*ks)) : nil
+  end unless method_defined?(:dig)
+
+  def compact
+    self.select { |_, value| !value.nil? }
+  end unless method_defined?(:compact)
+end

data/lib/facebook_ads/session.rb

@@ -0,0 +1,99 @@
+# 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 'faraday'
+require 'openssl'
+require 'logger'
+require 'facebook_ads/videos/video_request'
+
+module FacebookAds
+  class Session
+    attr_accessor :access_token, :app_secret, :api_version, :server_host
+
+    def initialize(access_token: nil,
+                   app_secret:   nil,
+                   server_host:  FacebookAds.config.server_host,
+                   api_version:  FacebookAds.config.api_version)
+      @access_token = access_token
+      @app_secret   = app_secret
+      @server_host  = server_host
+      @api_version  = api_version
+    end
+
+    def request(method, path, params = nil)
+      path.gsub!(/^\//,'') #
+      case method
+        when :get, :post, :delete
+          api_conn.send(method, path, params) do |req|
+            req.headers[:user_agent] = "fb-ruby-ads-api-sdk-#{VERSION}".freeze
+            req.params[:access_token] = access_token
+            req.params[:appsecret_proof] = appsecret_proof if app_secret
+          end
+        else
+          raise 'Unsupported HTTP method: ' + method
+      end
+    end
+
+    def appsecret_proof
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new('sha256'),
+        @app_secret,
+        @access_token
+      )
+    end
+
+    private
+    def api_conn
+      @api_conn ||= Faraday.new(url: api_base_path) do |faraday|
+        faraday.use FacebookAds::HTTPService::VideoRequest
+        faraday.request  :multipart
+        # TODO Json Request
+        # TODO URL Encode - stringify json
+        faraday.request  :url_encoded
+
+        faraday.response :logger, Utils.logger, bodies: FacebookAds.config.log_api_bodies
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    def api_base_path
+      "https://#{self.server_host}/#{self.api_version}/".freeze
+    end
+
+    class << self
+      def default_session
+        # TODO
+        @default_session ||= new( access_token: FacebookAds.config.access_token,
+                                  app_secret: FacebookAds.config.app_secret)
+      end
+
+      def default_session=(session)
+        # TODO
+        @default_session = session
+      end
+
+      def current_session
+        @@current_session ||= default_session
+      end
+
+      def current_session=(session)
+        @@current_session = session
+      end
+    end
+  end
+end

data/lib/facebook_ads/utils/utils.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.
+
+require 'logger'
+
+module FacebookAds
+  module Utils
+    extend self
+
+    attr_accessor :logger
+    self.logger = Logger.new(STDERR)
+    self.logger.level = Logger::ERROR
+  end
+end

data/lib/facebook_ads/version.rb

@@ -0,0 +1,24 @@
+# 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.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  VERSION = '0.2.9'
+  API_VERSION = '2.9'
+end

data/lib/facebook_ads/videos/video_io.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
+  class VideoIO < ::UploadIO
+    def is_video?
+      true
+    end
+  end
+end

data/lib/facebook_ads/videos/video_request.rb

@@ -0,0 +1,42 @@
+# 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 'faraday'
+
+module FacebookAds
+  module HTTPService
+    class VideoRequest < Faraday::Middleware
+      def call(env)
+        if env.body && body_has_video?(env.body)
+          env.url.host = env.url.host.gsub(/^graph/, 'graph-video')
+        end
+        @app.call env
+      end
+
+      def body_has_video?(body)
+        if body.respond_to?(:each) && !body.is_a?(String)
+          (body.respond_to?(:values) ? body.values : body).any? do |val|
+            val.is_a?(FacebookAds::VideoIO)
+          end
+        else
+          false
+        end
+      end
+    end
+  end
+end