sklik-api 0.0.16 → 0.1.0

data/lib/sklik-api/campaign_parts/adtext.rb

@@ -8,7 +8,7 @@ class SklikApi
       :premiseMode, :premiseID
     ]
 
-    include Object
+    include SklikObject
 =begin
 Example of input hash
 {
@@ -22,10 +22,23 @@ Example of input hash
 
 =end
 
-    def initialize adgroup, args
+    def initialize args, deprecated_args = {}
+
+      #deprecated way to set up new adgroup!
+      if args.is_a?(SklikApi::Adgroup)
+        puts "DEPRECATION WARNING: Please update your code for SklikApi::Adtext.new(adgroup, args) to SklikApi::Adtext.new(args = {}) possible to add parent adgroup by adding :adgroup => your adgroup"
+        #set adgroup owner campaign
+        @adgroup = args
+        args = deprecated_args
+      #new way to set adgroups!
+      else
+        #set adgroup owner campaign
+        #if in input args there is pointer to parent campaign!
+        @adgroup = args.delete(:adgroup)
+      end
+      @args = args
+
       @adtext_data = nil
-      #set adtext owner adgroup
-      @adgroup = adgroup
 
       super args
     end
@@ -35,50 +48,106 @@ Example of input hash
     end
 
     def create_args
-      raise ArgumentError, "Adtexts need's to know adgroup_id" unless @adgroup.args[:adgroup_id]
+      raise ArgumentError, "Adtexts need's to know adgroup_id" unless @args[:adgroup_id] || @adgroup.args[:adgroup_id]
       out = []
       #add campaign id to know where to create adgroup
-      out << @adgroup.args[:adgroup_id]
+      out << @args[:adgroup_id] || @adgroup.args[:adgroup_id]
 
       #add adtext struct
-      args = {}
-      args[:creative1] = @args[:headline]
-      args[:creative2] = @args[:description1]
-      args[:creative3] = @args[:description2]
-      args[:clickthruText] = @args[:display_url]
-      args[:clickthruUrl] = @args[:url]
+      c_args = {}
+      c_args[:creative1] = @args[:headline]
+      c_args[:creative2] = @args[:description1]
+      c_args[:creative3] = @args[:description2]
+      c_args[:clickthruText] = @args[:display_url]
+      c_args[:clickthruUrl] = @args[:url]
+      c_args[:status] = status_for_update if status_for_update
 
       ADDITIONAL_FIELDS.each do |add_info|
         field_name = add_info.to_s.underscore.to_sym
-        args[add_info] = @args[field_name] if @args[field_name]
+        c_args[add_info] = @args[field_name] if @args[field_name]
       end
 
-      out << args
+      out << c_args
 
       #return output
       out
     end
 
-    def self.find adgroup, args = {}
-       out = []
-       super(NAME, adgroup.args[:adgroup_id]).each do |adtext|
+    def update_args
+      out = []
+
+      #add campaign id on which will be performed update
+      out << @args[:adtext_id]
+
+      #prepare campaign struct
+      u_args = {}
+      u_args[:status] = status_for_update if status_for_update
+
+      out << u_args
+      ADDITIONAL_FIELDS.each do |add_info|
+        field_name = add_info.to_s.underscore.to_sym
+        u_args[add_info] = @args[field_name] if @args[field_name]
+      end
+
+      out
+    end
+
+    def self.get id
+      if adtext = super(NAME, id)
+        SklikApi::Adtext.new(process_sklik_data adtext)
+      else
+        nil
+      end
+    end
+
+    def self.find args, deprecated_args = {}
+      out = []
+
+      if args.is_a?(Integer)
+        return get args
+
+      #asking for adgroup deprecated way!
+      elsif args.is_a?(SklikApi::Adgroup)
+        puts "DEPRECATION WARNING: Please update your code for SklikApi::Adtext.find(adgroup, args) to SklikApi::Adtext.find(adgroup_id: 1234) possible to add parent adgroup by adding :adgroup => your adgroup"
+        adgroup_id = args.args[:adgroup_id]
+        args = deprecated_args
+
+      #asking for adgroup by hash with keyword_id
+      elsif args.is_a?(Hash) && args[:adtext_id]
+        if adtext = get(args[:adtext_id])
+          return [adtext]
+        else
+          return []
+        end
+
+      #asking for keyword by hash
+      else
+        adgroup_id = args[:adgroup_id]
+      end
+
+      return [] unless adgroup_id
+
+       super(NAME, adgroup_id).each do |adtext|
          if args[:adtext_id].nil? || (args[:adtext_id] && args[:adtext_id].to_i == adtext[:id].to_i)
-           out << SklikApi::Adtext.new(
-             adgroup,
-             :adtext_id => adtext[:id],
-             :headline => adtext[:creative1],
-             :description1 => adtext[:creative2],
-             :description2 => adtext[:creative3],
-             :display_url =>adtext[:clickthruText],
-             :url => adtext[:clickthruUrl],
-             :name => adtext[:name],
-             :status => fix_status(adtext)
-           )
+           out << SklikApi::Adtext.new(process_sklik_data adtext)
          end
        end
        out
      end
 
+     def self.process_sklik_data adtext = {}
+      {
+        :adgroup_id => adtext[:groupId],
+        :adtext_id => adtext[:id],
+        :headline => adtext[:creative1],
+        :description1 => adtext[:creative2],
+        :description2 => adtext[:creative3],
+        :display_url =>adtext[:clickthruText],
+        :url => adtext[:clickthruUrl],
+        :status => fix_status(adtext)
+      }
+    end
+
      def self.fix_status adtext
        if adtext[:removed] == true
          return :stopped
@@ -99,14 +168,79 @@ Example of input hash
       end
     end
 
+    def self.get_current_status args = {}
+      raise ArgumentError, "Adtext_id is required" unless args[:adtext_id]
+      if adgroup = self.get(args[:adtext_id])
+        adgroup.args[:status]
+      else
+        raise ArgumentError, "Adtext by #{args.inspect} couldn't be found!"
+      end
+    end
+
+    def get_current_status
+      self.class.get_current_status :adtext_id => @args[:adtext_id]
+    end
+
+    def valid?
+      clear_errors
+      log_error "headline is required or too long" unless args[:headline] && args[:headline].size > 0 && args[:headline].size <= 35
+      log_error "description1 is required or too long" unless args[:description1] && args[:description1].size > 0 && args[:description1].size <= 45
+      log_error "description2 is required or too long" unless args[:description2] && args[:description2].size > 0 && args[:description2].size <= 45
+      log_error "display_url is required or too long" unless args[:display_url] && args[:display_url].size > 0 && args[:display_url].size <= 45
+      log_error "url is required" unless args[:url] && args[:url].size > 0 && args[:url].size <= 45
+      log_error "adgroup_id is required" unless args[:adgroup_id] || (@adgroup && @adgroup.args[:adgroup_id])
+      !errors.any?
+    end
+
+    def update args = {}
+      @args.merge!(args)
+      save
+    end
+
     def save
+      clear_errors
       if @args[:adtext_id]  #do update
 
-      else                    #do save
-        #create adtext
-        create
+        #get current status of campaign
+        before_status = get_current_status
+
+        #restore campaign before update
+        restore if before_status == :stopped
+
+        begin
+          update_object
+
+        rescue Exception => e
+          log_error e.message
+        end
+
+        #remove it if new status is stopped or status doesn't changed and before it was stopped
+        remove if (@args[:status] == :stopped) || (@args[:status].nil? && before_status == :stopped)
+
+      else                  #do save
+        @args[:adgroup_id] = @adgroup.args[:adgroup_id] if !@args[:adgroup_id] && @adgroup.args[:adgroup_id]
+
+        begin
+          #create adtext
+          create
+        rescue Exception => e
+          log_error e.message
+          #don't continue with creating campaign!
+          return false
+        end
+
+        #remove it if new status is stopped
+        remove if @args[:status] && @args[:status].to_s.to_sym == :stopped
       end
+
+      !errors.any?
     end
+
+    def log_error message
+      @adgroup.log_error "Adtext: #{@args[:headline]} -> #{message}" if @adgroup
+      errors << message
+    end
+
   end
 end
 

data/lib/sklik-api/campaign_parts/keyword.rb

@@ -4,52 +4,109 @@ class SklikApi
 
     NAME = "keyword"
 
-    include Object
+    ADDITIONAL_FIELDS = [
+      :cpc, :url
+    ]
+    ADDITIONAL_READ_FIELDS = [
+      :disabled, :cpc, :url, :minCpc
+    ]
+
+    include SklikObject
 =begin
 Example of input hash
 {
   :keyword => "\"some funny keyword\""
 }
 =end
-      
-    def initialize adgroup, args
+
+    def initialize args, deprecated_args = {}
+
+      #deprecated way to set up new adgroup!
+      if args.is_a?(SklikApi::Adgroup)
+        puts "DEPRECATION WARNING: Please update your code for SklikApi::Keyword.new(adgroup, args) to SklikApi::Keyword.new(args = {}) possible to add parent adgroup by adding :adgroup => your adgroup"
+        #set adgroup owner campaign
+        @adgroup = args
+        args = deprecated_args
+
+      #new way to set adgroups!
+      else
+        #set adgroup owner campaign
+        #if in input args there is pointer to parent campaign!
+        @adgroup = args.delete(:adgroup)
+      end
+      @args = args
+
       @keyword_data = nil
-      #set keyword owner adgroup
-      @adgroup = adgroup
 
       super args
     end
-     
+
     def create_args
-      raise ArgumentError, "Keyword need's to know adgroup_id" unless @adgroup.args[:adgroup_id]
+      raise ArgumentError, "Keyword need's to know adgroup_id" unless @args[:adgroup_id] || @adgroup.args[:adgroup_id]
       out = []
       #add campaign id to know where to create adgroup
-      out << @adgroup.args[:adgroup_id] 
-      
+      out << @args[:adgroup_id] || @adgroup.args[:adgroup_id]
+
       #add adtext struct
-      args = {}
-      args[:name] = strip_match_type @args[:keyword]
-      args[:matchType] = get_math_type @args[:keyword]
-      out << args
-      
+      c_args = {}
+      c_args[:name] = strip_match_type @args[:keyword]
+      c_args[:matchType] = get_math_type @args[:keyword]
+      #Currently not working :(
+      c_args[:status] = status_for_update if status_for_update
+
+      ADDITIONAL_FIELDS.each do |add_info|
+        field_name = add_info.to_s.underscore.to_sym
+        c_args[add_info] = @args[field_name] if @args[field_name]
+      end
+
+      if @args[:cpc]
+        c_args[:cpc] = (@args[:cpc] * 100).to_i
+      end
+
+
+      out << c_args
+
       #return output
       out
     end
-    
+
+    def update_args
+      out = []
+
+      #add campaign id on which will be performed update
+      out << @args[:keyword_id]
+
+      #prepare campaign struct
+      u_args = {}
+      u_args[:status] = status_for_update if status_for_update
+
+      ADDITIONAL_FIELDS.each do |add_info|
+        field_name = add_info.to_s.underscore.to_sym
+        u_args[add_info] = @args[field_name] if @args[field_name]
+      end
+      if @args[:cpc]
+        u_args[:cpc] = (@args[:cpc] * 100).to_i
+      end
+      out << u_args
+
+      #return output
+      out
+    end
+
     def strip_match_type keyword
       keyword.gsub(/(\[|\]|\")/, "").gsub(/^-/, "")
     end
-    
+
     def get_math_type keyword
-      if /^-\[.*\]$/  =~ keyword 
+      if /^-\[.*\]$/  =~ keyword
         return "negativeExact"
-      elsif /^\[.*\]$/  =~ keyword 
+      elsif /^\[.*\]$/  =~ keyword
         return "exact"
-      elsif /^-\".*\"$/  =~ keyword 
+      elsif /^-\".*\"$/  =~ keyword
         return "negativePhrase"
-      elsif /^\".*\"$/  =~ keyword 
+      elsif /^\".*\"$/  =~ keyword
         return "phrase"
-      elsif /^-.*$/  =~ keyword 
+      elsif /^-.*$/  =~ keyword
         return "negativeBroad"
       else
         return "broad"
@@ -67,22 +124,66 @@ Example of input hash
       else keyword
       end
     end
-    
-    def self.find adgroup, args = {}
+
+    def self.get id
+      if keyword = super(NAME, id)
+        SklikApi::Keyword.new(process_sklik_data keyword)
+      else
+        nil
+      end
+    end
+
+    def self.find args, deprecated_args = {}
       out = []
-      super(NAME, adgroup.args[:adgroup_id]).each do |keyword|
+
+      if args.is_a?(Integer)
+        return get args
+
+      #asking for adgroup deprecated way!
+      elsif args.is_a?(SklikApi::Adgroup)
+        puts "DEPRECATION WARNING: Please update your code for SklikApi::Keyword.find(adgroup, args) to SklikApi::Keyword.find(adgroup_id: 1234) possible to add parent adgroup by adding :adgroup => your adgroup"
+        adgroup_id = args.args[:adgroup_id]
+        args = deprecated_args
+
+      #asking for adgroup by hash with keyword_id
+      elsif args.is_a?(Hash) && args[:keyword_id]
+        if keyword = get(args[:keyword_id])
+          return [keyword]
+        else
+          return []
+        end
+
+      #asking for keyword by hash
+      else
+        adgroup_id = args[:adgroup_id]
+      end
+
+      return [] unless adgroup_id
+
+      super(NAME, adgroup_id).each do |keyword|
         if args[:keyword_id].nil? || (args[:keyword_id] && args[:keyword_id].to_i == keyword[:id].to_i)
-          out << SklikApi::Keyword.new( 
-            adgroup,
-            :keyword_id => keyword[:id],
-            :keyword => apply_math_type(keyword[:name], keyword[:matchType] ),
-            :status => fix_status(keyword)
-          )
+          out << SklikApi::Keyword.new(process_sklik_data keyword)
         end
       end
       out
     end
 
+    def self.process_sklik_data keyword = {}
+      out = {
+        :adgroup_id => keyword[:groupId],
+        :keyword_id => keyword[:id],
+        :keyword => apply_math_type(keyword[:name], keyword[:matchType] ),
+        :status => fix_status(keyword)
+      }
+      ADDITIONAL_READ_FIELDS.each do |add_info|
+        field_name = add_info.to_s.underscore.to_sym
+        out[field_name] = keyword[add_info] if keyword[add_info]
+      end
+      out[:cpc] = keyword[:cpc].to_f/100.0 if keyword[:cpc]
+
+      out
+    end
+
     def self.fix_status keyword
       if keyword[:removed] == true
         return :stopped
@@ -101,18 +202,71 @@ Example of input hash
       if @keyword_data
         @keyword_data
       else
-        @keyword_data = {:keyword => @args[:keyword], :status => @args[:status]}
+        @keyword_data = @args      end
+    end
+
+
+    def self.get_current_status args = {}
+      raise ArgumentError, "Keyword_id is required" unless args[:keyword_id]
+      if adgroup = self.get(args[:keyword_id])
+        adgroup.args[:status]
+      else
+        raise ArgumentError, "Keyword by #{args.inspect} couldn't be found!"
       end
     end
-    
-    def save 
+
+    def get_current_status
+      self.class.get_current_status :keyword_id => @args[:keyword_id]
+    end
+
+    def update args = {}
+      @args.merge!(args)
+      save
+    end
+
+    def save
+      @args[:adgroup_id] = @adgroup.args[:adgroup_id] if !@args[:adgroup_id] && @adgroup.args[:adgroup_id]
+
       if @args[:keyword_id]  #do update
-        
+        #get current status of campaign
+        before_status = get_current_status
+
+        #restore campaign before update
+        restore if before_status == :stopped
+
+        begin
+          update_object
+
+        rescue Exception => e
+          log_error e.message
+        end
+
+        #remove it if new status is stopped or status doesn't changed and before it was stopped
+        remove if (@args[:status] == :stopped) || (@args[:status].nil? && before_status == :stopped)
       else                    #do save
-        #create adtext
-        create        
+        #create keyword
+        begin
+          create
+
+        rescue Exception => e
+          log_error e.message
+
+          return false
+        end
+
+        #remove it if new status is stopped
+        remove if @args[:status] && @args[:status].to_s.to_sym == :stopped
       end
-    end 
+
+      !errors.any?
+    end
+
+    def log_error message
+      puts message
+      @adgroup.log_error "Keyword: #{@args[:keyword]} -> #{message}" if @adgroup
+      errors << message
+    end
+
   end
 end
-      
+

data/lib/sklik-api/client.rb

@@ -4,15 +4,15 @@ class SklikApi
 
     NAME = "client"
 
-    include Object
-        
+    include SklikObject
+
     def initialize args = {}
       super args
     end
-    
+
     def self.find args = {}
       out = connection.call("client.getAttributes") { |param|
-        ([param[:user]]|param[:foreignAccounts]).collect{|u| 
+        ([param[:user]]|param[:foreignAccounts]).collect{|u|
           u.symbolize_keys!
           SklikApi::Client.new(
             :customer_id => u[:userId],

data/lib/sklik-api/connection.rb

@@ -1,21 +1,21 @@
 # -*- encoding : utf-8 -*-
 class SklikApi
   class Connection
-    
+
     MAX_RETRIES = 3
     DEFAULTS = {
       :debug => false,
       :timeout => 100
     }
-    
+
     def initialize args = {}
       @args = DEFAULTS.merge(args)
     end
-    
+
     def self.connection
       @connection ||= SklikApi::Connection.new(:debug => false)
     end
-    
+
     #prepare connection to sklik
     def connection
       path = (ENV['RACK_ENV'] || ENV['RAILS']) == "test" ? "/sandbox/RPC2" : "/RPC2"
@@ -24,11 +24,11 @@ class SklikApi
       #fix of UTF-8 encoding
       server.extend(XMLRPCWorkAround)
       #debug mode to see what XMLRPC is doing
-      server.set_debug(File.open("log/xmlrpc-#{Time.now.strftime("%Y_%m_%d-%H_%M_%S")}.log","a:UTF-8")) if @args[:debug] 
-      
+      server.set_debug(File.open("log/xmlrpc-#{Time.now.strftime("%Y_%m_%d-%H_%M_%S")}.log","a:UTF-8")) if @args[:debug]
+
       server
     end
-    
+
     #Get session is method for login into sklik
     #save session for other requests until it expires
     #every taxonomy has its own session!
@@ -38,7 +38,10 @@ class SklikApi
         @session[SklikApi::Access.uniq_identifier]
       else
         begin
+          SklikApi.log(:debug, "Getting session for #{SklikApi::Access.email}")
           param = connection.call("client.login", SklikApi::Access.email, SklikApi::Access.password).symbolize_keys
+          SklikApi.log(:debug, "Session received: #{param.inspect}")
+
           if param[:status] == 401
             raise ArgumentError, "Invalid login for: #{SklikApi::Access.email}"
           elsif param[:status] == 200
@@ -53,32 +56,52 @@ class SklikApi
         end
       end
     end
-    
+
     # method to wrap method call to sklik -> allow retry and problem with session expiration
     def call method, *args
+
+      SklikApi.log(:debug, "Calling api: #{method} [#{args}]") unless method == "client.login"
       retry_count = MAX_RETRIES
-      begin 
+      begin
         #get response from sklik
         param = connection.call( method, get_session, *args ).symbolize_keys
-        if [200,404].include?(param[:status])
+        SklikApi.log(:debug, "Response from api: #{param.inspect}") unless method == "client.login"
+        if [200].include?(param[:status])
           return yield(param)
+        elsif param[:status] == 400
+          raise SklikApi::InvalidArguments, "Calling method: #{method} with invalid arguments: #{args}, #{param.inspect}"
+        elsif param[:status] == 404
+          raise SklikApi::NotFound, "Calling method: #{method} with params: #{args} was not found"
         elsif param[:status] == 406
-          raise ArgumentError, "Sklik returned: #{method}: #{param[:statusMessage]} #{args.inspect}"
+          raise SklikApi::InvalidData, print_errors(param[:errors])
         elsif param[:statusMessage] == "Session has expired or is malformed."
           raise ArgumentError, "session has expired"
         else
-          raise ArgumentError, "There is error from sklik #{method}: #{param[:statusMessage]}: #{args.inspect}"
+          raise ArgumentError, "There is error from sklik #{method}: #{param.inspect}: #{args.inspect}"
         end
       rescue Exception => e
+        #when know exception which is not fault of sklik don't retry!
+        raise e if e.class.name =~ /SklikApi::/
+
         retry_count -= 1
         pp "Rescuing from request by: #{e.class} - #{e.message}"
         #if session expired then get new one! and retry
         get_session(true) if e.message == "session has expired"
         #don't retry if there is problem with Invalid paramaters od Data
-        retry_count = 0 if e.message.include?("Invalid") 
+        retry_count = 0 if e.message.include?("Invalid")
         retry if retry_count > 0
         raise e
       end
     end
+
+    def print_errors error_hash
+      error_hash.collect do |one_error|
+        out = "#{one_error.delete("id").humanize} ("
+        out += one_error.to_a.collect do |key, value|
+          "#{key} = #{value}"
+        end.join(", ")
+        out + ")"
+      end.join("; ")
+    end
   end
 end

data/lib/sklik-api/exceptions.rb

@@ -0,0 +1,6 @@
+class SklikApi
+
+  class NotFound < Exception; end
+  class InvalidArguments < Exception; end
+  class InvalidData < Exception; end
+end