sklik-api 0.0.1

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

@@ -0,0 +1,99 @@
+# -*- encoding : utf-8 -*-
+class SklikApi
+  class Adtext
+
+    NAME = "ad"
+
+    include Object
+=begin
+Example of input hash
+{
+  :headline => "Super headline",
+  :description1 => "Trying to do ",
+  :description2 => "best description ever",
+  :display_url => "my_test_url.cz",
+  :url => "http://my_test_url.cz"
+}
+
+
+=end
+
+    def initialize adgroup, args
+      @adtext_data = nil
+      #set adtext owner adgroup
+      @adgroup = adgroup
+      
+      super args
+    end
+      
+      
+    def create_args
+      raise ArgumentError, "Adtexts need's to know adgroup_id" unless @adgroup.args[:adgroup_id]
+      out = []
+      #add campaign id to know where to create adgroup
+      out << @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]
+      out << args
+      
+      #return output
+      out
+    end
+    
+    def self.find adgroup, args = {}
+       out = []
+       super(NAME, adgroup.args[:adgroup_id]).each do |adtext|
+         if args[:adtext_id].nil? || (args[:adtext_id] && args[:adtext_id].to_i == adtext[:id].to_i)
+           out << 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)
+           )
+         end
+       end
+       out
+     end
+
+     def self.fix_status adtext
+       if adtext[:removed] == true
+         return :stopped
+       elsif adtext[:status] == "active"
+         return :running
+       elsif adtext[:status] == "suspend"
+         return :paused
+       else
+         return :unknown
+       end
+     end
+
+     def to_hash
+      if @adtext_data
+        @adtext_data
+      else
+        @adtext_data = @args
+      end
+    end
+    
+    def save 
+      if @args[:adtext_id]  #do update
+        
+      else                    #do save
+        #create adtext
+        create        
+      end
+    end
+  end
+end
+      

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

@@ -0,0 +1,109 @@
+# -*- encoding : utf-8 -*-
+class SklikApi
+  class Keyword
+
+    NAME = "keyword"
+
+    include Object
+=begin
+Example of input hash
+{
+  :keyword => "\"some funny keyword\""
+}
+=end
+      
+    def initialize adgroup, 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]
+      out = []
+      #add campaign id to know where to create adgroup
+      out << @adgroup.args[:adgroup_id] 
+      
+      #add adtext struct
+      args = {}
+      args[:name] = strip_match_type @args[:keyword]
+      args[:matchType] = get_math_type @args[:keyword]
+      out << args
+      
+      #return output
+      out
+    end
+    
+    def strip_match_type keyword
+      keyword.gsub(/(\[|\]|\")/, "")
+    end
+    
+    def get_math_type keyword
+      if /^\[.*\]$/  =~ keyword 
+        return "exact"
+      elsif /^\".*\"$/  =~ keyword 
+        return "phrase"
+      else
+        return "broad"
+      end
+    end
+
+    def self.apply_math_type keyword, match_type
+      return case match_type
+      when "broad" then keyword
+      when "phrase" then "\"#{keyword}\""
+      when "exact" then "[#{keyword}]"
+      else keyword
+      end
+    end
+    
+    def self.find adgroup, args = {}
+       out = []
+       super(NAME, adgroup.args[:adgroup_id]).each do |keyword|
+         if args[:keyword_id].nil? || (args[:keyword_id] && args[:keyword_id].to_i == keyword[:id].to_i)
+           out << Keyword.new( 
+             adgroup,
+             :keyword_id => keyword[:id],
+             :keyword => apply_math_type(keyword[:name], keyword[:matchType] ),
+             :status => fix_status(keyword)
+           )
+         end
+       end
+       out
+     end
+
+     def self.fix_status keyword
+       if keyword[:removed] == true
+         return :stopped
+       elsif keyword[:status] == "active"
+         return :running
+       elsif keyword[:status] == "suspend"
+         return :paused
+       elsif keyword[:status] == "nonactive"
+         return :paused_by_low_cpc
+       else
+         return :unknown
+       end
+     end
+
+     def to_hash
+      if @keyword_data
+        @keyword_data
+      else
+        @keyword_data = @args[:keyword]
+      end
+    end
+    
+    def save 
+      if @args[:keyword_id]  #do update
+        
+      else                    #do save
+        #create adtext
+        create        
+      end
+    end 
+  end
+end
+      

data/lib/sklik-api/connection.rb

@@ -0,0 +1,82 @@
+# -*- 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
+      server = XMLRPC::Client.new3(:host => "api.sklik.cz", :path => "/RPC2", :port => 443, :use_ssl => true, :timeout => @args[:timeout])
+      server.instance_variable_get(:@http).instance_variable_set(:@verify_mode, OpenSSL::SSL::VERIFY_NONE)
+      #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
+    end
+    
+    #Get session is method for login into sklik
+    #save session for other requests until it expires
+    #every taxonomy has its own session!
+    def get_session force = false
+      @session ||= {}
+      if @session.has_key?(SklikApi::Access.uniq_identifier) && !force
+        @session[SklikApi::Access.uniq_identifier]
+      else
+        begin
+          param = connection.call("client.login", SklikApi::Access.email, SklikApi::Access.password).symbolize_keys
+          if param[:status] == 401
+            raise ArgumentError, "Invalid login for: #{SklikApi::Access.email}"
+          elsif param[:status] == 200
+            return @session[SklikApi::Access.uniq_identifier] = param[:session]
+          else
+            raise ArgumentError, param[:statusMessage]
+          end
+        rescue XMLRPC::FaultException => e
+          raise ArgumentError, "#{e.faultString}, #{e.faultCode}"
+        rescue Exception => e
+          raise e
+        end
+      end
+    end
+    
+    # method to wrap method call to sklik -> allow retry and problem with session expiration
+    def call method, *args
+      retry_count = MAX_RETRIES
+      begin 
+        #get response from sklik
+        param = connection.call( method, get_session, *args ).symbolize_keys
+        if param[:status] == 200
+          return yield(param)
+        elsif param[:status] == 406
+          raise ArgumentError, "Sklik returned: #{param[:statusMessage]} \n #{args.inspect}"
+        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]}"
+        end
+      rescue Exception => e
+        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"
+
+        retry_count -= 1
+        retry if retry_count > 0
+        raise e
+      end
+    end
+  end
+end

data/lib/sklik-api/sklik_object.rb

@@ -0,0 +1,60 @@
+# -*- encoding : utf-8 -*-
+class SklikApi
+  module Object
+    def self.included(base) 
+      base.send :extend, ClassMethods         
+      base.send :include, InstanceMethods  
+    end
+    
+    module ClassMethods
+      
+      def connection
+        SklikApi::Connection.connection
+      end
+      
+      def find name, id = nil
+        if id
+          args = ["list#{name.pluralize.camelize}", id]
+        else
+          args = ["list#{name.pluralize.camelize}"]
+        end
+        return connection.call(*args) { |param|
+          #return list of all objects
+          param[name.pluralize.to_sym].collect{|c| c.symbolize_keys }
+        }
+      end
+    end    
+
+    module InstanceMethods
+      #get connection for request
+      def connection
+        SklikApi::Connection.connection
+      end
+
+      def initialize args
+        @args = args
+        return self
+      end
+
+      def args
+        @args
+      end
+
+      def create
+        out = connection.call("#{self.class::NAME}.create", *create_args ) { |param|
+           param["#{self.class::NAME}Id".to_sym]
+        }
+        @args["#{self.class.to_s.downcase.split(":").last}_id".to_sym] = out
+        @args
+      end
+            
+      def create_args
+        raise(NoMethodError, "Please implement 'create_args' method in class: #{self.class} - should return array which will be placed into create method")
+      end
+
+      def to_hash
+        raise(NoMethodError, "Please implement 'to_hash' method in class: #{self.class} - should return hash which contains all data")
+      end
+    end
+  end
+end

data/lib/sklik-api/xmlrpc_setup.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+
+#Settings for sklik & eTarget
+XMLRPC::Config.const_set(:ENABLE_NIL_PARSER, true)
+XMLRPC::Config.const_set(:ENABLE_NIL_CREATE, true)
+
+#Hack for enabling debug mode!
+class XMLRPC::Client
+  def set_debug out = $stderr
+    @http.set_debug_output(out);
+  end
+end
+
+#Hack for force encoding to UTF-8
+module XMLRPCWorkAround
+  def do_rpc(request, async=false)
+    data = super
+    data.force_encoding("UTF-8")
+    data
+  end
+end

data/sklik-api.gemspec

@@ -0,0 +1,101 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sklik-api"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ondrej Bartas"]
+  s.date = "2012-03-25"
+  s.description = "Sklik advertising PPC api for creating campaigns and updating them when they runs"
+  s.email = "ondrej@bartas.cz"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "config/access.rb.example",
+    "lib/sklik-api.rb",
+    "lib/sklik-api/access.rb",
+    "lib/sklik-api/campaign.rb",
+    "lib/sklik-api/campaign_parts/adgroup.rb",
+    "lib/sklik-api/campaign_parts/adtext.rb",
+    "lib/sklik-api/campaign_parts/keyword.rb",
+    "lib/sklik-api/connection.rb",
+    "lib/sklik-api/sklik_object.rb",
+    "lib/sklik-api/xmlrpc_setup.rb",
+    "sklik-api.gemspec",
+    "test/fake_web.rb",
+    "test/helper.rb",
+    "test/unit/campaign.rb"
+  ]
+  s.homepage = "http://github.com/ondrejbartas/sklik-api"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Sklik advertising PPC api for creating campaigns"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<unicode>, ["~> 0.4.0"])
+      s.add_runtime_dependency(%q<text>, ["~> 0.2.0"])
+      s.add_runtime_dependency(%q<i18n>, ["~> 0.6.0"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.1.0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+      s.add_development_dependency(%q<shoulda-context>, [">= 0"])
+      s.add_development_dependency(%q<turn>, ["~> 0.8.2"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<ansi>, ["~> 1.2.5"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<thin>, [">= 0"])
+      s.add_development_dependency(%q<shotgun>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, ["= 0.9.10"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<unicode>, ["~> 0.4.0"])
+      s.add_dependency(%q<text>, ["~> 0.2.0"])
+      s.add_dependency(%q<i18n>, ["~> 0.6.0"])
+      s.add_dependency(%q<activesupport>, ["~> 3.1.0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<shoulda-context>, [">= 0"])
+      s.add_dependency(%q<turn>, ["~> 0.8.2"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<ansi>, ["~> 1.2.5"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<thin>, [">= 0"])
+      s.add_dependency(%q<shotgun>, [">= 0"])
+      s.add_dependency(%q<rcov>, ["= 0.9.10"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<unicode>, ["~> 0.4.0"])
+    s.add_dependency(%q<text>, ["~> 0.2.0"])
+    s.add_dependency(%q<i18n>, ["~> 0.6.0"])
+    s.add_dependency(%q<activesupport>, ["~> 3.1.0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<shoulda-context>, [">= 0"])
+    s.add_dependency(%q<turn>, ["~> 0.8.2"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<ansi>, ["~> 1.2.5"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<thin>, [">= 0"])
+    s.add_dependency(%q<shotgun>, [">= 0"])
+    s.add_dependency(%q<rcov>, ["= 0.9.10"])
+  end
+end
+