sklik-api 0.0.16 → 0.1.0

data/lib/sklik-api/sklik_object.rb

@@ -1,6 +1,6 @@
 # -*- encoding : utf-8 -*-
 class SklikApi
-  module Object
+  module SklikObject
     def self.included(base)
       base.send :extend, ClassMethods
       base.send :include, InstanceMethods
@@ -12,6 +12,16 @@ class SklikApi
         SklikApi::Connection.connection
       end
 
+      def get name, id
+        args = ["#{name}.getAttributes", id]
+        return connection.call(*args) { |param|
+          param[name.to_sym].symbolize_keys
+        }
+      rescue SklikApi::NotFound => e
+        puts "#{e.class} - #{e.message}"
+        return nil
+      end
+
       def find name, id = nil
         if id
           args = ["list#{name.pluralize.camelize}", id]
@@ -77,6 +87,16 @@ class SklikApi
         }
       end
 
+      def status_for_update
+        if @args[:status] == :running
+          return "active"
+        elsif @args[:status] == :paused
+          return "suspend"
+        else
+          return nil
+        end
+      end
+
       def update_object
         out = connection.call("#{self.class::NAME}.setAttributes", *update_args ) { |param| true }
       end
@@ -96,6 +116,14 @@ class SklikApi
       def underscore_hash_keys hash
         hash.inject({ }) { |x, (k,v)| x[k.underscore.to_sym] = v; x }
       end
+
+      def clear_errors
+        @errors = []
+      end
+
+      def errors
+        @errors ||= []
+      end
     end
   end
 end

data/lib/sklik-api.rb

@@ -1,7 +1,6 @@
 # -*- encoding : utf-8 -*-
 require 'rubygems'
 require 'rack'
-require 'pp'
 require 'json'
 require 'unicode'
 require 'uri'
@@ -25,11 +24,29 @@ ENV['RACK_ENV'] ||= "development"
 
 #initialzie SklikApi class
 class SklikApi
-  
+
+  def self.use_rollback= how
+    @use_rollback = how
+  end
+
+  #default setting for rollback is true!
+  def self.use_rollback?
+    @use_rollback.nil? || @use_rollback
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def self.log type, message
+    logger.send(type, "SklikApi: #{message}")
+  rescue Exception => e
+    puts "SklikApi.logger Exception: #{e.message}"
+  end
 end
 
 #including sklik-api
-["xmlrpc_setup",  "access", "connection", "sklik_object", "client", "campaign"].each do |file|
+["exceptions", "xmlrpc_setup",  "access", "connection", "sklik_object", "client", "campaign"].each do |file|
   require File.join(File.dirname(__FILE__),"/sklik-api/#{file}.rb")
 end
 

data/sklik-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sklik-api"
-  s.version = "0.0.16"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ondrej Bartas"]
-  s.date = "2013-03-21"
+  s.date = "2013-06-21"
   s.description = "Sklik advertising PPC api for creating campaigns and updating them when they runs"
   s.email = "ondrej@bartas.cz"
   s.extra_rdoc_files = [
@@ -32,12 +32,20 @@ Gem::Specification.new do |s|
     "lib/sklik-api/campaign_parts/keyword.rb",
     "lib/sklik-api/client.rb",
     "lib/sklik-api/connection.rb",
+    "lib/sklik-api/exceptions.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"
+    "test/integration/adgroup_test.rb",
+    "test/integration/adtext_test.rb",
+    "test/integration/campaign_test.rb",
+    "test/integration/errors_test.rb",
+    "test/integration/keyword_test.rb",
+    "test/unit/adgroup_test.rb",
+    "test/unit/campaign_test.rb",
+    "test/unit/client_test.rb"
   ]
   s.homepage = "http://github.com/ondrejbartas/sklik-api"
   s.licenses = ["MIT"]

data/test/integration/adgroup_test.rb

@@ -0,0 +1,126 @@
+# -*- encoding : utf-8 -*-
+require 'helper'
+class AdgroupIntegrationTest < Test::Unit::TestCase
+  context "Integration:Adgroup" do
+
+    setup do
+      @campaign_hash = {
+        :name => "integration adgroup - #{Time.now.strftime("%Y.%m.%d %H:%M:%S.%L")}",
+        :status => :running,
+        :budget => 15.0,
+        :customer_id => 192495,
+        :excluded_search_services => [2,3,4,5,6,7,8], #choose only seznam.cz
+        :network_setting => {
+          :content => true,
+          :search => true
+        },
+        :ad_groups => []
+      }
+      @campaign = SklikApi::Campaign.new(@campaign_hash)
+      unless @campaign.save
+        raise "Unable to continue - Campaign: #{@campaign.errors}"
+      end
+
+      @adgroup_hash = {
+        :name => "my adgroup name - #{Time.now.strftime("%Y.%m.%d %H:%M:%S.%L")}",
+        :cpc => 6.0,
+        :campaign_id => @campaign.args[:campaign_id],
+        :keywords => [],
+        :ads => [],
+        :status => :running,
+      }
+
+      @adgroup = SklikApi::Adgroup.new(@adgroup_hash)
+      unless @adgroup.save
+        raise "Unable to continue - Adgroup: #{@adgroup.errors}"
+      end
+    end
+
+    def teardown
+      @campaign.remove if SklikApi::Campaign.get(@campaign.args[:campaign_id]).args[:status] != :stopped
+    end
+
+    should "create paused adgroup" do
+      @adgroup_hash[:name] += "Paused"
+      @adgroup_hash[:status] = :paused
+      adgroup = SklikApi::Adgroup.new(@adgroup_hash)
+      assert adgroup.save, "Problem with creating adgroup: #{adgroup.errors}"
+
+      assert_equal SklikApi::Adgroup.get(adgroup.args[:adgroup_id]).args[:status], :paused
+    end
+
+    should "create stopped adgroup" do
+      @adgroup_hash[:name] += "Stopped"
+      @adgroup_hash[:status] = :stopped
+      adgroup = SklikApi::Adgroup.new(@adgroup_hash)
+      assert adgroup.save, "Problem with creating adgroup: #{@adgroup.errors}"
+
+      assert_equal SklikApi::Adgroup.get(adgroup.args[:adgroup_id]).args[:status], :stopped
+    end
+
+    should "find" do
+      assert_equal SklikApi::Adgroup.find(@adgroup.args[:adgroup_id]).to_hash.to_a.sort, @adgroup_hash.to_a.sort
+      assert_equal SklikApi::Adgroup.find(adgroup_id: @adgroup.args[:adgroup_id]).first.to_hash.to_a.sort, @adgroup_hash.to_a.sort
+    end
+
+    should "get" do
+      assert_equal SklikApi::Adgroup.get(@adgroup.args[:adgroup_id]).to_hash.to_a.sort, @adgroup_hash.to_a.sort
+    end
+
+    should "update" do
+      adgroup = SklikApi::Adgroup.get(@adgroup.args[:adgroup_id])
+
+      new_attributes = {
+        name: adgroup.args[:name] + " T1",
+        status: :stopped,
+        cpc: 5.0,
+      }
+      adgroup.update new_attributes
+
+      adgroup = SklikApi::Adgroup.get(@adgroup.args[:adgroup_id])
+      assert_equal adgroup.to_hash.to_a.sort, @adgroup_hash.merge(new_attributes).to_a.sort, "First update"
+
+      new_attributes = {
+        name: adgroup.args[:name] + " T2",
+        status: :paused,
+        cpc: 8.0,
+      }
+      adgroup.update new_attributes
+      adgroup = SklikApi::Adgroup.get(@adgroup.args[:adgroup_id])
+      assert_equal adgroup.to_hash.to_a.sort, @adgroup_hash.merge(new_attributes).to_a.sort, "Second update"
+
+    end
+
+    should "create adgroup with specified KW" do
+      adgroup_hash = {
+        :name => "my adgroup name - #{Time.now.strftime("%Y.%m.%d %H:%M:%S.%L")} - Testing KW",
+        :cpc => 6.0,
+        :campaign_id => @campaign.args[:campaign_id],
+        :keywords => [
+          { :keyword => "[super kw]", :url => 'http://super.bartas.cz/', :cpc => 3.0},
+          { :keyword => "\"other kw\"", :url => 'http://mega.bartas.cz/', :cpc => 9.1}
+        ],
+        :ads => [],
+        :status => :running,
+      }
+
+      adgroup = SklikApi::Adgroup.new(adgroup_hash)
+      assert adgroup.save, "Should be saved but got: #{adgroup.errors}"
+
+
+      adgroup = SklikApi::Adgroup.get(adgroup.args[:adgroup_id])
+      returned_hash = adgroup.to_hash
+
+      returned_hash[:keywords].each do |kw|
+        kw.delete(:keyword_id)
+        kw.delete(:adgroup_id)
+        kw.delete(:status)
+      end
+
+      returned_hash[:keywords] = returned_hash[:keywords].to_a.collect{|h|h.to_a.sort}.sort
+      adgroup_hash[:keywords] = adgroup_hash[:keywords].to_a.collect{|h|h.to_a.sort}.sort
+      assert_equal returned_hash.to_a.sort, adgroup_hash.to_a.sort
+    end
+
+  end
+end

data/test/integration/adtext_test.rb

@@ -0,0 +1,106 @@
+# -*- encoding : utf-8 -*-
+require 'helper'
+class AdtextIntegrationTest < Test::Unit::TestCase
+  context "Integration:Adtext" do
+
+    setup do
+      @campaign_hash = {
+        :name => "integration adtext - #{Time.now.strftime("%Y.%m.%d %H:%M:%S.%L")}",
+        :status => :running,
+        :budget => 15.0,
+        :customer_id => 192495,
+        :excluded_search_services => [2,3,4,5,6,7,8], #choose only seznam.cz
+        :network_setting => {
+          :content => true,
+          :search => true
+        },
+        :ad_groups => []
+      }
+      @campaign = SklikApi::Campaign.new(@campaign_hash)
+      unless @campaign.save
+        raise "Unable to continue - Campaign: #{@campaign.errors}"
+      end
+
+      @adgroup_hash = {
+        :name => "my adgroup name - #{Time.now.strftime("%Y.%m.%d %H:%M:%S.%L")}",
+        :cpc => 6.0,
+        :campaign_id => @campaign.args[:campaign_id],
+        :keywords => [],
+        :ads => [],
+        :status => :running,
+      }
+
+      @adgroup = SklikApi::Adgroup.new(@adgroup_hash)
+      unless @adgroup.save
+        raise "Unable to continue - Adgroup: #{@adgroup.errors}"
+      end
+
+      @adtext_hash = {
+        :adgroup_id => @adgroup.args[:adgroup_id],
+        :headline => "Super headline",
+        :description1 => "Trying to do ",
+        :description2 => "best description ever",
+        :display_url => "bartas.cz",
+        :url => "http://www.bartas.cz/",
+        :status => :running,
+      }
+      @adtext = SklikApi::Adtext.new(@adtext_hash)
+      unless @adtext.save
+        raise "Unable to continue - Adtext: #{@adtext.errors}"
+      end
+
+    end
+
+    def teardown
+      @campaign.remove if SklikApi::Campaign.get(@campaign.args[:campaign_id]).args[:status] != :stopped
+    end
+
+    should "create paused adtext" do
+      @adtext_hash[:headline] += "Paused"
+      @adtext_hash[:status] = :paused
+      adtext = SklikApi::Adtext.new(@adtext_hash)
+      assert adtext.save, "Problem with creating adgroup: #{adtext.errors}"
+
+      assert_equal SklikApi::Adtext.get(adtext.args[:adtext_id]).args[:status], :paused
+    end
+
+    should "create stopped adtext" do
+      @adtext_hash[:headline] += "Stopped"
+      @adtext_hash[:status] = :stopped
+      adtext = SklikApi::Adtext.new(@adtext_hash)
+      assert adtext.save, "Problem with creating adgroup: #{adtext.errors}"
+
+      assert_equal SklikApi::Adtext.get(adtext.args[:adtext_id]).args[:status], :stopped
+    end
+
+    should "find" do
+      assert_equal SklikApi::Adtext.find(@adtext.args[:adtext_id]).to_hash.to_a.sort, @adtext_hash.to_a.sort, "By ID"
+      assert_equal SklikApi::Adtext.find(adtext_id: @adtext.args[:adtext_id]).first.to_hash.to_a.sort, @adtext_hash.to_a.sort, "By Hash with ID"
+    end
+
+    should "get" do
+      assert_equal SklikApi::Adtext.get(@adtext.args[:adtext_id]).to_hash.to_a.sort, @adtext_hash.to_a.sort
+    end
+
+    should "update" do
+      adtext = SklikApi::Adtext.get(@adtext.args[:adtext_id])
+
+      new_attributes = {
+        status: :stopped,
+      }
+      adtext.update new_attributes
+
+      adtext = SklikApi::Adtext.get(@adtext.args[:adtext_id])
+      assert_equal adtext.to_hash.to_a.sort, @adtext_hash.merge(new_attributes).to_a.sort, "First update"
+
+      new_attributes = {
+        status: :paused,
+      }
+      adtext.update new_attributes
+      adtext = SklikApi::Adtext.get(@adtext.args[:adtext_id])
+      assert_equal adtext.to_hash.to_a.sort, @adtext_hash.merge(new_attributes).to_a.sort, "Second update"
+
+    end
+
+  end
+end

data/test/integration/campaign_test.rb

@@ -0,0 +1,87 @@
+# -*- encoding : utf-8 -*-
+require 'helper'
+class CampaignIntegrationTest < Test::Unit::TestCase
+  context "Integration:Campaign" do
+
+    setup do
+      @only_campaign_hash = {
+        :name => "integration campaign - #{Time.now.strftime("%Y.%m.%d %H:%M:%S.%L")}",
+        :status => :running,
+        :budget => 15.0,
+        :customer_id => 192495,
+        :excluded_search_services => [2,3,4,5,6,7,8], #choose only seznam.cz
+        :network_setting => {
+          :content => true,
+          :search => true
+        },
+        :ad_groups => []
+      }
+      @campaign = SklikApi::Campaign.new(@only_campaign_hash)
+      unless @campaign.save
+        raise "Unable to continue: #{@campaign.errors}"
+      end
+    end
+
+    def teardown
+      @campaign.remove if @campaign.args[:campaign_id] && SklikApi::Campaign.get(@campaign.args[:campaign_id]).args[:status] != :stopped
+    end
+
+    should "create paused campaign" do
+      @only_campaign_hash[:name] += "Paused"
+      @only_campaign_hash[:status] = :paused
+      campaign = SklikApi::Campaign.new(@only_campaign_hash)
+      assert campaign.save, "Problem with creating campaing: #{@campaign.errors}"
+
+      assert_equal SklikApi::Campaign.get(campaign.args[:campaign_id]).args[:status], :paused
+    end
+
+    should "create stopped campaign" do
+      @only_campaign_hash[:name] += "Stopped"
+      @only_campaign_hash[:status] = :stopped
+      campaign = SklikApi::Campaign.new(@only_campaign_hash)
+      assert campaign.save, "Problem with creating campaing: #{campaign.errors}"
+
+      assert_equal SklikApi::Campaign.get(campaign.args[:campaign_id]).args[:status], :stopped
+    end
+
+    should "find" do
+      assert_equal SklikApi::Campaign.find(@campaign.args[:campaign_id]).to_hash.to_a.sort, @only_campaign_hash.to_a.sort
+      assert_equal SklikApi::Campaign.find(campaign_id: @campaign.args[:campaign_id]).first.to_hash.to_a.sort, @only_campaign_hash.to_a.sort
+    end
+
+    should "get" do
+      assert_equal SklikApi::Campaign.get(@campaign.args[:campaign_id]).to_hash.to_a.sort, @only_campaign_hash.to_a.sort
+    end
+
+    should "update" do
+      campaign = SklikApi::Campaign.get(@campaign.args[:campaign_id])
+
+      new_attributes = {
+        status: :stopped,
+        budget: 12.0,
+        :network_setting => {
+          :content => false,
+          :search => true
+        }
+      }
+      campaign.update new_attributes
+
+      campaign = SklikApi::Campaign.get(@campaign.args[:campaign_id])
+      assert_equal campaign.to_hash.to_a.sort, @only_campaign_hash.merge(new_attributes).to_a.sort, "First update"
+
+      new_attributes = {
+        status: :paused,
+        budget: 17.0,
+        :network_setting => {
+          :content => true,
+          :search => true
+        }
+      }
+      campaign.update new_attributes
+      campaign = SklikApi::Campaign.get(@campaign.args[:campaign_id])
+      assert_equal campaign.to_hash.to_a.sort, @only_campaign_hash.merge(new_attributes).to_a.sort, "Second update"
+
+    end
+
+  end
+end

data/test/integration/errors_test.rb

@@ -0,0 +1,164 @@
+# -*- encoding : utf-8 -*-
+require 'helper'
+class ErrorsIntegrationTest < Test::Unit::TestCase
+  context "Integration:Error - Campaign" do
+
+    setup do
+      @campaign_hash = {
+        :name => "integration error - #{Time.now.strftime("%Y.%m.%d %H:%M:%S.%L")}",
+        :status => :running,
+        :budget => 15.0,
+        :customer_id => 192495,
+        :excluded_search_services => [2,3,4,5,6,7,8], #choose only seznam.cz
+        :network_setting => {
+          :content => true,
+          :search => true
+        },
+        :ad_groups => []
+      }
+      @campaign = SklikApi::Campaign.new(@campaign_hash)
+    end
+
+    def teardown
+      @campaign.remove if @campaign.args[:campaign_id] && SklikApi::Campaign.get(@campaign.args[:campaign_id]).args[:status] != :stopped
+    end
+
+    should "return errors for invalid campaign" do
+      @campaign.args[:budget] = 0
+      refute @campaign.valid?
+      assert @campaign.errors.any?, "Campaign validation should have errors #{@campaign.errors}"
+
+      @campaign.args[:budget] = 2
+      assert @campaign.valid?, "Should be valid but got error on save"
+      refute @campaign.save
+
+      assert @campaign.errors.any?, "Campaign should have errors #{@campaign.errors}"
+      assert_equal @campaign.errors, ["Campaign daybudget is too low (field = dayBudget, minimum = 1000)"]
+    end
+
+    context "-> Adgroup" do
+
+      setup do
+        #save campaign before testing!
+        @campaign.save
+
+        @adgroup_hash = {
+          :name => "my adgroup name - #{Time.now.strftime("%Y.%m.%d %H:%M:%S.%L")}",
+          :cpc => 6.0,
+          :campaign_id => @campaign.args[:campaign_id],
+          :keywords => [],
+          :ads => [],
+          :status => :running,
+        }
+        @adgroup = SklikApi::Adgroup.new(@adgroup_hash)
+      end
+
+      should "return errors to invalid adgroup" do
+        @adgroup.args[:cpc] = 0
+        refute @adgroup.valid?
+        assert @adgroup.errors.any?, "Adgroup validation should have errors #{@adgroup.errors}"
+
+        @adgroup.args[:cpc] = 0.01
+        assert @adgroup.valid?, "Should be valid but got error on save"
+        refute @adgroup.save
+
+        assert @adgroup.errors.any?, "Adgroup should have errors #{@adgroup.errors}"
+        assert_equal @adgroup.errors, ["Group cpc is too low (field = cpc, minimum = 20)"]
+      end
+
+      should "return adgroups error into campaign errors" do
+        @adgroup_hash[:cpc] = 0.01
+        @campaign_hash[:ad_groups] = [@adgroup_hash]
+        @campaign_hash.delete(:campaign_id)
+        @campaign_hash[:name] += " Second level"
+        @campaign = SklikApi::Campaign.new(@campaign_hash)
+        refute @campaign.save, "Shouldn't be saved"
+        assert @campaign.errors.any?, "Campaign should have errors #{@campaign.errors}"
+        assert @campaign.errors.first =~ /Group cpc is too low/, "#{@campaign.errors} should have error from adgroup /Group cpc si too low/"
+      end
+
+      should "return adgroups error into campaign errors && rollback!" do
+
+        SklikApi.use_rollback = true
+
+        @adgroup_hash[:cpc] = 0.01
+        @campaign_hash[:ad_groups] = [@adgroup_hash]
+        @campaign_hash.delete(:campaign_id)
+        @campaign_hash[:name] += " Second level"
+        old_name = "#{@campaign_hash[:name]}"
+        @campaign = SklikApi::Campaign.new(@campaign_hash)
+        refute @campaign.save, "Shouldn't be saved"
+        assert @campaign.errors.any?, "Campaign should have errors #{@campaign.errors}"
+        assert @campaign.errors.first =~ /Group cpc is too low/, "#{@campaign.errors} should have error from adgroup /Group cpc si too low/"
+
+        campaign = SklikApi::Campaign.get(@campaign.args[:campaign_id])
+        assert_not_equal old_name, campaign.args[:name], "Names should be diferent: #{@campaign_hash[:name]} != #{campaign.args[:name]}"
+        assert_equal campaign.args[:status], :stopped, "Campaign should be stopped after rollback"
+      end
+
+      should "return adgroups error into campaign errors && dont rollback!" do
+
+        SklikApi.use_rollback = false
+
+        @adgroup_hash[:cpc] = 0.01
+        @campaign_hash[:ad_groups] = [@adgroup_hash]
+        @campaign_hash.delete(:campaign_id)
+        @campaign_hash[:name] += " Second level"
+        @campaign = SklikApi::Campaign.new(@campaign_hash)
+        refute @campaign.save, "Shouldn't be saved"
+        assert @campaign.errors.any?, "Campaign should have errors #{@campaign.errors}"
+        assert @campaign.errors.first =~ /Group cpc is too low/, "#{@campaign.errors} should have error from adgroup /Group cpc si too low/"
+
+        campaign = SklikApi::Campaign.get(@campaign.args[:campaign_id])
+        assert_equal @campaign_hash[:name], campaign.args[:name], "Names should be same: #{@campaign_hash[:name]} == #{campaign.args[:name]}"
+        assert_equal campaign.args[:status], :running, "Campaign should be running and without rollback"
+      end
+
+      context "-> Adtext" do
+
+        setup do
+          @adgroup.save
+          @adtext_hash = {
+            :adgroup_id => @adgroup.args[:adgroup_id],
+            :headline => "Super headline",
+            :description1 => "Trying to do ",
+            :description2 => "best description ever",
+            :display_url => "bartas.cz",
+            :url => "http://www.bartas.cz/",
+            :status => :running,
+          }
+          @adtext = SklikApi::Adtext.new(@adtext_hash)
+        end
+
+        should "return errors to invalid adtext" do
+          @adtext.args[:headline] = ""
+          refute @adtext.valid?
+          assert @adtext.errors.any?, "Adtext validation should have errors #{@adtext.errors}"
+
+          @adtext.args[:headline] = "Long head valid not by sklik"
+          assert @adtext.valid?, "Should be valid - got: #{@adtext.errors}"
+          refute @adtext.save
+
+          assert @adtext.errors.any?, "Adtext should have errors #{@adtext.errors}"
+          assert_equal @adtext.errors, ["Creative1 is too long (field = creative1)"]
+        end
+
+        should "return adgroups error into campaign errors" do
+          @adgroup_hash.delete(:adgroup_id)
+          @campaign_hash.delete(:campaign_id)
+
+          @adtext_hash[:headline] = "Long head valid not by sklik"
+          @adgroup_hash[:ads] = [@adtext_hash]
+          @adgroup_hash[:name] += " Third level"
+          @campaign_hash[:ad_groups] = [@adgroup_hash]
+          @campaign_hash[:name] += " Third level"
+          @campaign = SklikApi::Campaign.new(@campaign_hash)
+          refute @campaign.save, "Shouldn't be saved"
+          assert @campaign.errors.any?, "Campaign should have errors #{@campaign.errors}"
+          assert @campaign.errors.first =~ /Creative1 is too long/, "#{@campaign.errors} should have error from adgroup /Creative1 is too long/"
+        end
+
+      end
+    end
+  end
+end