sklik-api 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+gem "json"
+gem "unicode", "~> 0.4.0"
+gem "text", "~> 0.2.0"
+gem "i18n", "~> 0.6.0"
+gem "activesupport", "~> 3.1.0"
+
+
+group :development do
+  gem "rack-test"
+  gem 'shoulda-context'
+  gem "turn", "~> 0.8.2"
+  gem "minitest"
+  gem "ansi", "~> 1.2.5"
+  gem "jeweler", "~> 1.8.3"
+  gem "fakeweb"
+  gem "thin"
+  gem "shotgun"
+  gem "rcov", "= 0.9.10"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ondrej Bartas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission 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.

data/README.markdown

@@ -0,0 +1,75 @@
+# Sklik API
+
+Sklik advertising PPC api for creating campaigns
+
+# Implementation
+
+Gemfile.rb
+``` ruby
+gem "sklik-api", :require => "sklik-api"
+```
+
+
+
+# Usage 
+
+``` ruby
+campaign_hash = {
+  :name => "name of your campaign",
+  :cpc => 3.5, # cpc is in CZK and in float and is set for adgroup
+  :budget => 15.4, # budget is in CZK and in float 
+  :customer_id => 123456, #optional without specifying it will be created on logged account
+
+  :network_setting => {
+    :content => true,
+    :search => true
+  },
+  
+  :ad_groups => [
+    {
+      :name => "my adgroup name",
+      :ads => [ 
+        {
+          :headline => "Super headline",
+          :description1 => "Trying to do ",
+          :description2 => "best description ever",
+          :display_url => "bartas.cz",
+          :url => "http://www.bartas.cz"
+        }
+      ],
+      :keywords => [
+        "\"some funny keyword\"",
+        "[myphrase keyword]",
+        "my broad keyword for me",
+        "test of diarcritics âô"
+      ]
+    }
+  ]
+}
+
+#you can set it before every action to sklik api, if you have multiple accounts :-)
+SklikApi::Access.set(
+  :email => "your_email@seznam.cz",
+  :password => "password"
+)
+
+# this will create campaign object and do save to sklik advertising system
+# if you have more than one account where to save your campaigns -> set customer_id where campaign will be created
+SklikApi::Campaign.new(campaign_hash).save
+```
+
+== Contributing to sklik-api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Ondrej Bartas. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "sklik-api"
+  gem.homepage = "http://github.com/ondrejbartas/sklik-api"
+  gem.license = "MIT"
+  gem.summary = %Q{Sklik advertising PPC api for creating campaigns}
+  gem.description = %Q{Sklik advertising PPC api for creating campaigns and updating them when they runs}
+  gem.email = "ondrej@bartas.cz"
+  gem.authors = ["Ondrej Bartas"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+
+#get directories!
+CONF_DIR = File.expand_path(File.join("..", "config"), __FILE__)
+
+#copy example config files for redis and elastic if they don't exists
+unless File.exists?(File.join(CONF_DIR, "access.rb")) 
+  FileUtils.cp(File.join(CONF_DIR, "access.rb.example"), File.join(CONF_DIR, "access.rb") ) 
+  puts "WARNING: you need to setup your config/access.rb -> I created this file for you with example usage"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/unit/*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/unit/*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sklik-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/config/access.rb.example

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+
+### TEST ACCOUNT
+
+SklikApi::Access.set(
+    :email => "email@seznam.cz",
+    :password => "password"
+  )

data/lib/sklik-api.rb

@@ -0,0 +1,42 @@
+# -*- encoding : utf-8 -*-
+require 'rubygems'
+require 'rack'
+require 'pp'
+require 'json'
+require 'unicode'
+require 'uri'
+
+#for sklik miner
+require 'net/http'
+require 'net/https'
+require "xmlrpc/client"
+
+require 'active_support'
+require 'active_support/inflector'
+require 'active_support/inflector/inflections'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/class/inheritable_attributes'
+require 'active_support/core_ext'
+
+require 'date'
+require 'logger'
+
+ENV['RACK_ENV'] ||= "development"
+
+
+#initialzie SklikApi class
+class SklikApi
+  
+end
+
+#including sklik-api
+["xmlrpc_setup",  "access", "connection", "sklik_object", "campaign"].each do |file|
+  require File.join(File.dirname(__FILE__),"/sklik-api/#{file}.rb")
+end
+
+#including config
+["access"].each do |file|
+  require File.join(File.dirname(__FILE__),"../config/#{file}.rb")
+end
+
+

data/lib/sklik-api/access.rb

@@ -0,0 +1,54 @@
+# -*- encoding : utf-8 -*-
+class SklikApi::Access
+
+  #set credentials
+  def self.set args = {}
+    args.symbolize_keys!
+    #check required arguments
+    raise ArgumentError, "email is required" unless args[:email]
+    raise ArgumentError, "password is required" unless args[:password]
+    
+    #save argument to right places
+    @args = args
+    
+    #return this object!
+    return self
+  end
+
+  def self.get
+    Marshal.load( Marshal.dump (@args )) 
+  end
+  
+  #return email
+  def self.email
+    @args[:email].to_s
+  end
+
+  #for login take first part of email "name@seznam.cz" -> "name"
+  def self.login
+    @args[:email].to_s.split("@").first
+  end
+
+  #return customer_id
+  def self.customer_id    
+    @args.has_key?(:customer_id) && @args[:customer_id] ? @args[:customer_id] : nil
+  end
+
+  #return password
+  def self.password
+    @args[:password].to_s
+  end
+    
+  #if you change Access credentials change uniq identifier -> 
+  #used for stroing sessions for multiple logins
+  def self.uniq_identifier 
+    "#{@args[:email]}:#{@args[:password]}"
+  end
+  
+  #to prevent changes in settings dump it
+  def self.access
+    Marshal.load( Marshal.dump( @args ))
+  end
+  
+end
+

data/lib/sklik-api/campaign.rb

@@ -0,0 +1,132 @@
+# -*- encoding : utf-8 -*-
+class SklikApi
+  class Campaign
+
+    NAME = "campaign"
+
+    include Object
+=begin
+Example of input hash
+{
+  :campaign_id => 12345, #(OPTIONAL) -> when setted it will on save do update of existing campaign
+  :name => "my campaign name - #{Time.now.strftime("%Y.%m.%d %H:%M:%S")}",
+  :status => :running,
+  :cpc => 3,
+  :budget => 50,
+
+  :network_setting => {
+    :content => true,
+    :search => true
+  },
+  
+  :ad_groups => [
+    {
+      :name => "my adgroup name",
+      :ads => [ 
+        {
+          :headline => "Super headline",
+          :description1 => "Trying to do ",
+          :description2 => "best description ever",
+          :display_url => "my_test_url.cz",
+          :url => "http://my_test_url.cz"
+        }
+      ],
+      :keywords => [
+        "\"some funny keyword\"",
+        "[phrase keyword]",
+        "broad keyword for me",
+        "test of diarcritics âô"
+      ]
+    }
+  ]
+}
+=end
+    
+    def initialize args
+      #variable where are saved current data from system
+      @campaign_data = nil
+      
+      #initialize adgroups
+      @adgroups = []
+      if args[:ad_groups] && args[:ad_groups].size > 0
+        args[:ad_groups].each do |adgroup|
+          @adgroups << SklikApi::Adgroup.new(self, adgroup)
+        end
+      end
+      
+      @customer_id = args[:customer_id]
+      super args
+    end
+    
+    def self.find args = {}
+      out = []
+      super(NAME, args[:customer_id]).each do |campaign|
+        if args[:campaign_id].nil? || (args[:campaign_id] && args[:campaign_id].to_i == campaign[:id].to_i)
+          out << Campaign.new( 
+            :campaign_id => campaign[:id],
+            :budget => campaign[:dayBudget].to_f/100.0, 
+            :name => campaign[:name], 
+            :status => fix_status(campaign)
+          )
+        end
+      end
+      out
+    end
+    
+    def self.fix_status campaign
+      if campaign[:removed] == true
+        return :stopped
+      elsif campaign[:status] == "active"
+        return :running
+      elsif campaign[:status] == "suspend"
+        return :paused
+      else
+        return :unknown
+      end
+    end
+    
+    def to_hash
+      if @campaign_data
+        @campaign_data
+      else
+        @campaign_data = @args
+        @campaign_data[:ad_groups] = Adgroup.find(self).collect{|a| a.to_hash}
+        @campaign_data
+      end
+    end
+    
+    def create_args
+      out = []
+      
+      #prepare campaign struct
+      args = {}
+      args[:name] = @args[:name]
+      args[:dayBudget] = (@args[:budget] * 100).to_i if @args[:budget]
+      args[:context] = @args[:network_setting][:context] ||= true if @args[:network_setting]
+      out << args
+      
+      #add customer id on which account campaign should be created
+      out << @customer_id if @customer_id
+      pp @customer_id
+      pp out
+      out
+    end
+
+    def save 
+      if @args[:campaign_id]  #do update
+        
+      else                    #do save
+        #create campaign
+        create
+        
+        #create adgroups
+        @adgroups.each{ |adgroup| adgroup.save }
+        
+        @campaign_data = @args
+      end
+    end
+  end
+end
+
+#include campaign parts
+["keyword", "adtext", "adgroup"].each { |file| require File.join(File.dirname(__FILE__), "campaign_parts/#{file}.rb") }

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

@@ -0,0 +1,127 @@
+# -*- encoding : utf-8 -*-
+class SklikApi
+  class Adgroup
+
+    NAME = "group"
+
+    include Object
+=begin
+Example of input hash
+{
+  :adgroup_id => 1234, #(OPTIONAL) -> when setted it will on save do update of existing adgroup
+  :name => "my adgroup name",
+  :ads => [ 
+    {
+      :headline => "Super headline",
+      :description1 => "Trying to do ",
+      :description2 => "best description ever",
+      :display_url => "my_test_url.cz",
+      :url => "http://my_test_url.cz"
+    }
+  ],
+  :keywords => [
+    "\"some funny keyword\"",
+    "[phrase keyword]",
+    "broad keyword for me",
+    "test of diarcritics âô"
+  ]
+}
+
+
+=end
+  
+    def initialize campaign, args
+      @adgroup_data = nil
+      #set adgroup owner campaign
+      @campaign = campaign
+
+      #initialize adgroups
+      @adtexts = []
+      if args[:ads] && args[:ads].size > 0
+        args[:ads].each do |adtext|
+          @adtexts << SklikApi::Adtext.new(self, adtext)
+        end
+      end
+      #initialize adgroups
+      @keywords = []
+      if args[:keywords] && args[:keywords].size > 0
+        args[:keywords].each do |keyword|
+          @keywords << SklikApi::Keyword.new(self, :keyword => keyword)
+        end
+      end
+      
+      super args
+    end
+    
+    def self.find campaign, args = {}
+      out = []
+      super(NAME, campaign.args[:campaign_id]).each do |adgroup|
+        if args[:adgroup_id].nil? || (args[:adgroup_id] && args[:adgroup_id].to_i == adgroup[:id].to_i)
+          out << Adgroup.new( campaign, 
+            :adgroup_id => adgroup[:id],
+            :cpc => adgroup[:cpc].to_f/100.0, 
+            :name => adgroup[:name], 
+            :status => fix_status(adgroup)
+          )
+        end
+      end
+      out
+    end
+    
+    def self.fix_status adgroup
+      if adgroup[:removed] == true
+        return :stopped
+      else
+        return :running
+      end
+    end
+    
+    def to_hash
+      if @adgroup_data
+        @adgroup_data
+      else
+        @adgroup_data = @args
+        @adgroup_data[:ads] = Adtext.find(self).collect{|a| a.to_hash}
+        @adgroup_data[:keywords] = Keyword.find(self).collect{|k| k.to_hash}
+        @adgroup_data
+      end
+    end
+    
+    
+    def create_args
+      raise ArgumentError, "Adgroup need's to know campaign_id" unless @campaign.args[:campaign_id]
+      raise ArgumentError, "Adgroup need's to know campaigns CPC" unless @campaign.args[:cpc]
+
+      out = []
+      #add campaign id to know where to create adgroup
+      out << @campaign.args[:campaign_id] 
+      
+      #add adgroup struct
+      args = {}
+      args[:name] = @args[:name]
+      args[:cpc] = (@campaign.args[:cpc] * 100).to_i if @campaign.args[:cpc]
+      out << args
+      
+      #return output
+      out
+    end
+    
+    def save 
+      if @args[:adgroup_id]  #do update
+        
+      else                    #do save
+        #create adgroup
+        create
+        
+        #create adtexts
+        @adtexts.each{ |adtext| adtext.save }
+        
+        #create keywords
+        @keywords.each{ |keyword| keyword.save }
+      end
+    end
+
+  end
+end
+      
+