adcloud 0.7.0

data/lib/adcloud/advertisement.rb

@@ -0,0 +1,28 @@
+module Adcloud
+  class Advertisement < Adcloud::Entity
+    attribute :id, Integer
+    attribute :product_id, Integer
+    attribute :type, String
+    attribute :advertisement_design_id, Integer
+    attribute :target_url, String
+    attribute :name, String
+    attribute :logo, Boolean
+    attribute :image_text, Boolean
+    attribute :flash, Boolean
+    attribute :display, Boolean
+    attribute :tag, Boolean
+    attribute :postview_type, Integer
+    attribute :tag_html, String
+    attribute :image_alt, String
+    attribute :text_headline, String
+    attribute :text_body, String
+    attribute :text_link, String
+    attribute :postview_url, String
+    attribute :keywords, Array
+    attribute :exclusion_keywords, Array
+    attribute :machine_keywords, Array
+    attribute :locations, Array
+    attribute :modified, DateTime
+    attribute :created, DateTime
+  end
+end

data/lib/adcloud/api_error.rb

@@ -0,0 +1,33 @@
+module Adcloud
+
+  class ApiError < StandardError;
+
+    attr_accessor :meta, :response
+
+    def initialize(response)
+      self.response = response
+    end
+
+    def meta
+      self.response.body["_meta"]
+    end
+
+    def details
+      self.meta["details"]
+    end
+
+    def type
+      self.meta["type"]
+    end
+
+    def message
+      self.meta["message"]
+    end
+
+    def status
+      self.meta["status"]
+    end
+
+  end
+
+end

data/lib/adcloud/authentication.rb

@@ -0,0 +1,24 @@
+module Adcloud
+
+  class AuthenticationError    < StandardError ; end
+
+  class Authentication
+
+    attr_accessor :client_id, :client_secret, :token
+
+    def initialize(attr)
+      @client_id = attr[:client_id]
+      @client_secret = attr[:client_secret]
+    end
+
+    def authenticate!
+      response = Connection.new.connection(false).post "oauth/access_token", {:client_id => self.client_id, :client_secret => self.client_secret, :grant_type => "none"}
+      if response.success?
+        @token = response.body['_meta']["access_token"]
+      else
+        raise AuthenticationError.new(@client_id => "Could not authenticate")
+      end
+    end
+
+  end
+end

data/lib/adcloud/campaign.rb

@@ -0,0 +1,69 @@
+module Adcloud
+  class Campaign < Adcloud::Entity
+    TYPES = {
+      cpc: 2,
+      cpx: 3,
+      cpx_plus: 4,
+      cpm: 5,
+      fixed_daily_costs: 6
+    }
+
+    DELIVERY_TYPES = {
+      topic: 1,
+      channel: 2
+    }
+
+    attribute :_meta, Hash
+    attribute :id, Integer
+    attribute :bidding_enabled, Boolean
+    attribute :name, String
+    attribute :customer_id, Integer
+    attribute :company_id, Integer
+    attribute :company_name, String
+    attribute :product_id, Integer
+    attribute :product_name, String
+    attribute :status, Integer
+    attribute :language_id, Integer
+    attribute :start_date, Date
+    attribute :end_date, Date
+    attribute :delivery_boost, Float
+    attribute :frequency_capping, Integer
+    attribute :frequency_capping_days, Integer
+    attribute :cookie_lifetime, Integer
+    attribute :cookie_lifetime_view, Integer
+    attribute :fallback, Boolean
+    attribute :keywords, String
+    attribute :exclusion_keywords, Array
+    attribute :keyword_lifetime, Integer
+    attribute :comment, String
+    attribute :budget_limit, Float
+    attribute :budget_limit_allowed, Boolean
+    attribute :unit_price_maximum, Float
+    attribute :locations, Array
+    attribute :type, Integer
+    attribute :delivery_external, Boolean
+    attribute :delivery_internal, Boolean
+    attribute :delivery_type, Integer
+    attribute :deactivated_on, DateTime
+    attribute :modified, DateTime
+    attribute :created, DateTime
+    # attribute :fixed_price, # missing
+    # attribute :mobile_targeting, # missing
+
+    # @return [void] Validate the campaign against the api
+    def validate
+      result = connection.get('campaigns/validate', { campaign: self.attributes_for_create })
+      if result && result["_meta"] && result["_meta"]["status"] == 226
+        @errors = self.errors.merge(result["_meta"]["details"])
+      else
+        raise AdcloudSucks::InvalidApiResponse.new('Empty response for campaign validation')
+      end
+    end
+
+    # @return [Boolean] True when campaign is valid - otherwise false
+    def valid?
+      self.validate
+      self.errors.empty?
+    end
+  end
+end

data/lib/adcloud/connection.rb

@@ -0,0 +1,46 @@
+module Adcloud
+
+  class Connection < Adcloud::Entity
+
+    attr_accessor :authentication
+
+    def authentication
+      @authentication ||= begin
+        auth = Adcloud::Authentication.new(:client_id => Adcloud.config.client_id, :client_secret => Adcloud.config.client_secret)
+        auth.authenticate!
+        auth
+      end
+    end
+
+    def url
+      "#{Adcloud.config.protocol}://#{Adcloud.config.host}:#{Adcloud.config.port}/#{Adcloud.config.api_version}/"
+    end
+
+    def authentication_token
+      self.authentication.token
+    end
+
+    def connection(auth = true)
+      auth_header = auth && { :Authorization =>  "Bearer #{authentication_token}" } || {}
+      connection ||= Faraday.new(:url => url, :headers => {}.merge(auth_header)) do |faraday|
+        faraday.request  :url_encoded                     # form-encode POST params
+        # log requests to STDOUT
+        faraday.response :logger if Adcloud.config.debug
+        faraday.use ResponseErrorHandler
+        faraday.adapter  Faraday.default_adapter          # make requests with Net::HTTP
+        faraday.response :json, :content_type => /\bjson$/
+      end
+    end
+
+    def post(path, params = {})
+      response = connection.post path, params
+      response.body
+    end
+
+    def get(path, params = {})
+      response = connection.get path, params
+      response.body
+    end
+
+  end
+end

data/lib/adcloud/customer.rb

@@ -0,0 +1,9 @@
+module Adcloud
+  class Customer < Adcloud::Entity
+    attribute :_meta, Hash
+    attribute :id, Integer
+    attribute :name, Boolean
+    attribute :modified, DateTime
+    attribute :created, DateTime
+  end
+end

data/lib/adcloud/entity.rb

@@ -0,0 +1,84 @@
+module Adcloud
+
+  class Entity
+    include Virtus
+
+    attr_accessor :errors
+
+    attribute :_meta, Hash
+
+    def connection
+      self.class.connection
+    end
+
+    def meta
+      self._meta
+    end
+
+    # @return [Boolean] True when successfully created - otherwise false
+    def create
+      result = connection.post(self.class.api_endpoint, { self.class.api_name => attributes_for_create })
+      if self.respond_to?(:id=) && !result['id'].nil?
+        self.id = result['id']
+      end
+      true
+    rescue Adcloud::BadRequestError => ex
+      derive_errors_from_error(ex)
+      false
+    end
+
+    class << self
+      attr_accessor :api_endpoint, :connection
+
+      def api_endpoint
+        @api_endpoint ||= self.name.demodulize.tableize
+      end
+
+      def api_name
+        self.name.demodulize.underscore
+      end
+
+      def connection
+        @connection ||= Connection.new
+      end
+
+      # @return [Array] Entities matching the criteria or all
+      def all(filter = {}, page = 1, per_page = 50)
+        result = connection.get(self.api_endpoint, :filter => filter, :page => page, :per_page => per_page)
+        result["items"].map { |raw_campaign| self.new(raw_campaign) }
+      end
+
+      # @return [Object] The entity with the unique identifier
+      def find(id)
+        result = connection.get("#{self.api_endpoint}/#{id}")
+        self.new(result)
+      end
+
+      # @return [Enitity] Object has errors when creation failed
+      def create(params = {})
+        entity = self.new(params)
+        entity.create
+        entity
+      end
+    end
+
+    # @return [Hash] Errors hash
+    def errors
+      @errors || {}
+    end
+
+    protected
+
+    # Set the campaign errors from the api response
+    def derive_errors_from_error(error)
+      @errors = self.errors.merge(error.details)
+    end
+
+    # @return [Hash] Attributes without those required for campaign creation
+    def attributes_for_create
+      self.attributes.reject { |i| [:id, :_meta].include?(i) }
+    end
+
+  end
+
+end

data/lib/adcloud/exception_raiser.rb

@@ -0,0 +1,22 @@
+module Adcloud
+
+  class ExceptionRaiser
+
+    def initialize(response)
+      case response.status
+      when 400
+        raise Adcloud::BadRequestError.new(response)
+      when 401
+        raise Adcloud::Unauthorized.new(response)
+      when 404
+        raise Adcloud::NotFoundError.new(response)
+      when 500
+        raise Adcloud::ServerError.new(response)
+      else
+        raise StandardError.new("Could not handle status #{response.status}")
+      end
+    end
+
+  end
+
+end

data/lib/adcloud/media_file.rb

@@ -0,0 +1,10 @@
+module Adcloud
+  class MediaFile < Adcloud::Entity
+    attribute :id, Integer
+    attribute :uploaded_file, String
+    attribute :product_id, Integer
+    attribute :ad_id, Integer
+    attribute :flash, Boolean
+    attribute :display, Boolean
+  end
+end

data/lib/adcloud/product.rb

@@ -0,0 +1,10 @@
+module Adcloud
+  class Product < Adcloud::Entity
+    attribute :id, Integer
+    attribute :name, String
+    attribute :customer_id, Integer
+    attribute :default_prio, Integer
+    attribute :modified, DateTime
+    attribute :created, DateTime
+  end
+end

data/lib/adcloud/report.rb

@@ -0,0 +1,28 @@
+module Adcloud
+  class Report
+    include Virtus
+
+    attribute :_meta, Hash
+    attribute :items, Array[Adcloud::ReportEntry]
+
+    class << self
+      attr_accessor :api_endpoint, :connection
+
+      def find_by_date(date)
+        result = connection.get(self.api_endpoint, { filter: { date: date.to_s } })
+        return self.new(result)
+      end
+
+      def api_endpoint
+        @api_endpoint ||= self.name.demodulize.tableize
+      end
+
+      def connection
+        @connection ||= Connection.new
+      end
+    end
+
+    # Define this after class methods are added
+    self.api_endpoint = 'reports/advertiser'
+  end
+end

data/lib/adcloud/report_entry.rb

@@ -0,0 +1,48 @@
+module Adcloud
+  class ReportEntry
+    include Virtus
+
+    attribute :date, Date
+    attribute :website_id, Integer
+    attribute :topic_id, Integer
+    attribute :ad_placement_id, Integer
+    attribute :product_id, Integer
+    attribute :ad_id, Integer
+    attribute :booking_id, Integer
+    attribute :page_type, Integer
+    attribute :ad_position, Integer
+    attribute :ad_count, Integer
+    attribute :ad_impressions, Integer
+    attribute :clicks, Integer
+    attribute :clicks_overdelivered, Integer
+    attribute :clicks_filtered, Integer
+    attribute :clicks_image, Integer
+    attribute :clicks_head, Integer
+    attribute :clicks_txt, Integer
+    attribute :clicks_link, Integer
+    attribute :postview_conversions, Integer
+    attribute :postview_conversions_overdelivered, Integer
+    attribute :postview_conversions_filtered, Integer
+    attribute :cancellations, Integer
+    attribute :publisher, String
+    attribute :website, String
+    attribute :position, String
+    attribute :design_id, Integer
+    attribute :design, String
+    attribute :topic, String
+    attribute :ad, String
+    attribute :booking, String
+    attribute :product, String
+    attribute :ad_impressions_costs, Float
+    attribute :clicks_costs, Float
+    attribute :postclick_conversions, Integer
+    attribute :postclick_conversions_overdelivered, Integer
+    attribute :postclick_conversions_filtered, Integer
+    attribute :postclick_conversions_costs, Float
+    attribute :postview_conversions_costs, Float
+    attribute :costs, Float
+    attribute :language, String
+    attribute :country, String
+    attribute :currency, String
+  end
+end

data/lib/adcloud/response_error_handler.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+
+module Adcloud
+
+  class ResponseErrorHandler < Faraday::Response::Middleware
+
+    def call(env)
+      @app.call(env).on_complete do
+        response = env[:response]
+        # Todo comment in when ready
+        # raise AdcloudSucks::InvalidApiResponse unless response.body.has_key?("_meta")
+        if response.success?
+          response.body
+        else
+          Adcloud.logger.debug { response.inspect }
+          ExceptionRaiser.new(response)
+        end
+      end
+    end
+
+  end
+
+end