ppc 1.0.6 → 1.3.0

data/lib/ppc/baidu/report.rb

@@ -16,21 +16,53 @@ module PPC
       end
 
       def file_id_of_query(params = {})
+        begin
+          startDate = DateTime.parse(params[:start]).iso8601
+          endDate = DateTime.parse(params[:end]).iso8601
+        rescue Exception => e
+          startDate = (Time.now - 2*24*3600).utc.iso8601
+          endDate = (Time.now - 24*3600).utc.iso8601
+        end
         options = {
-          performanceData:        params[:fields] || %w(click impression),
-          startDate:              params[:start]  || (Time.now - 2*24*3600).utc.iso8601,
-          endDate:                params[:end]    || (Time.now - 24*3600).utc.iso8601,
-          idOnly:                 params[:id_only]|| false,
-          levelOfDetails:         params[:level]  || 7,
-          # attributes:             nil,
-          format:                 params[:format] || 2,
-          reportType:             params[:type]   || 6,
-          # statIds:                params[:ids]    || nil,
-          statRange:              params[:range]  || 2,
-          unitOfTime:             params[:unit]   || 5,
-          device:                 params[:device] || 0
+          reportRequestType: {
+            performanceData:        params[:fields] || %w(click impression),
+            startDate:              startDate,
+            endDate:                endDate,
+            idOnly:                 params[:id_only]|| false,
+            levelOfDetails:         params[:level]  || 12,
+            format:                 params[:format] || 2,
+            reportType:             params[:type]   || 6,
+            statRange:              params[:range]  || 2,
+            unitOfTime:             params[:unit]   || 5,
+            device:                 params[:device] || 0
+          }
         }
-        options = {'reportRequestType'=>options}
+        get_report_id(options)
+      end
+
+      def file_id_of_cost(params={})
+        begin
+          startDate = DateTime.parse(params[:start]).iso8601
+          endDate = DateTime.parse(params[:end]).iso8601
+        rescue Exception => e
+          startDate = (Time.now - 2*24*3600).utc.iso8601
+          endDate = (Time.now - 24*3600).utc.iso8601
+        end
+        options = {
+          reportRequestType: {
+            performanceData:        params[:fields] || %w(impression click cpc cost ctr cpm position conversion),
+            startDate:              startDate,
+            endDate:                endDate,
+            levelOfDetails:         params[:level]  || 11, #::Baidu::SEM::LevelOfDetails::KEYWORDID,
+            reportType:             params[:type]   || 14, #::Baidu::SEM::ReportType::KEYWORDID,
+            statRange:              params[:range]  || 11, # ::Baidu::SEM::StatRange::KEYWORDID,
+            unitOfTime:             params[:unit]   || 5 #::Baidu::SEM::UnitOfTime::DAY
+          }
+        }
+        get_report_id(options)
+      end
+
+      def get_report_id(options={})
         response = request('getProfessionalReportId',options)
         body = response[:envelope][:body]
         raise "no result" if body.nil?

data/lib/ppc/baidu.rb

@@ -1,40 +1,49 @@
 require 'ppc/baidu/account'
 require 'ppc/baidu/plan'
 require 'ppc/baidu/bulk'
+require 'ppc/baidu/group'
+require 'ppc/baidu/key'
 require 'ppc/baidu/report'
 require 'awesome_print'
-require 'savon'
+require 'net/http'
+require 'net/https'
+require 'json'
+# require 'savon'
 module PPC
   class Baidu
     include ::PPC
 
     def initialize(params = {})
       @service = params[:service] + 'Service'
-      @port_name = params[:service] + 'Service'
       @username = params[:username]
       @password = params[:password]
       @token = params[:token]
-      @client = Savon.new("https://api.baidu.com/sem/sms/v3/#{@service}?wsdl")
       @debug = params[:debug] || false
     end
 
 
-    def request(method,params = {})
-      operation = make_operation(method)
-      operation.header = operation_header
-      operation.body = {
-        method+'Request' =>params
+    def request(method,params = {}, with_header = false)
+      uri = URI("https://api.baidu.com/json/sms/v3/#{@service}/#{method}")
+      http_body = {
+        header: request_header,
+        body: params
+      }.to_json
+
+      http_header = {
+        'Content-Type' => 'application/json; charset=UTF-8'
       }
-      print_debug(operation.body,'operation.body') if @debug
-      print_debug(operation.build,'operation.build') if @debug
-      response = operation.call.hash
-      process_response(response)
-      print_debug(response,'response') if @debug
-      response
+
+      http = Net::HTTP.new(uri.host, 443)
+      http.set_debug_output $stderr
+      http.use_ssl = true
+
+      response = http.post(uri.path, http_body, http_header)
+      response =  (JSON.parse response.body)
+      # if not needed, only return body
+      return response['body'] unless with_header else response
     end
 
     def operations
-      @client.operations(@service,@service)
     end
 
     protected
@@ -90,18 +99,12 @@ module PPC
 
     private
 
-    def make_operation(operation_name)
-      @client.operation(@service,@service,operation_name)
-    end
 
-    def operation_header
+    def request_header
       {
-        :AuthHeader=>
-        {
-          username:   @username,
-          password:   @password,
-          token:      @token
-        }
+        username:   @username,
+        password:   @password,
+        token:      @token
       }
     end
 

data/lib/ppc/operation/account.rb

@@ -0,0 +1,40 @@
+require 'ppc/operation'
+module PPC
+  module Operation
+    class Account
+      include ::PPC::Operation
+
+      def info
+        info = call('account').info(@auth)
+        @id = info[:result][0][:id] if @id == nil
+        return info
+      end
+
+      def update(account)
+        call('account').update(@auth,account)
+      end
+
+      # plan methods
+      def plans
+        call('plan').all(@auth)
+      end
+
+      def plan_ids
+        call('plan').ids(@auth)
+      end
+
+      # plan operation
+      include ::PPC::Operation::Plan_operation
+
+      # group opeartion
+      include ::PPC::Operation::Group_operation
+
+      # keyword opeartion
+      include ::PPC::Operation::Keyword_operation
+
+      # creative opeartion
+      include ::PPC::Operation::Creative_operation
+
+    end
+  end
+end

data/lib/ppc/operation/creative.rb

@@ -0,0 +1,28 @@
+module PPC
+  module Operation
+    class Creative 
+      include ::PPC::Operation
+
+      def info()
+        ::PPC::API::Baidu::Creative::get( @auth, @id )
+      end
+
+      def update( keywordType )
+        ::PPC::API::Baidu::Keyword::update( @auth, keywordType )
+      end
+
+      def activate()
+        ::PPC::API::Baidu::Creative::activate( @auth, @id )
+      end
+
+      def status()
+        ::PPC::API::Baidu::Creative::status( @auth, @id )
+      end
+
+      def delete()
+        ::PPC::API::Baidu::Creative::delete( @auth, @id )
+      end
+
+    end
+  end
+end

data/lib/ppc/operation/group.rb

@@ -0,0 +1,59 @@
+module PPC
+  module Operation
+    class Group
+      include ::PPC::Operation
+      
+      def info()
+        call('group').get(@auth, @id)
+      end
+
+      def update( info )
+        info[:id] = @id unless info[:id]
+        call('group').update(@auth, info)
+      end
+
+      # =============================== #
+      def keywords()
+        call( 'keyword' ).search_by_group_id( @auth, @id )
+      end
+
+      def keyword_ids()
+        call( 'keyword' ).search_id_by_group_id( @auth, @id )
+      end
+
+      def creatives()
+        call( 'creative' ).search_by_group_id( @auth, @id )
+      end
+
+      def creative_ids()
+        call( 'creative' ).search_id_by_group_id( @auth, @id )
+      end
+
+      # keyword opeartion
+      include ::PPC::Operation::Keyword_operation
+
+      # creative opeartion
+      include ::PPC::Operation::Creative_operation
+
+      # Overwrite add method to provide more function
+      def add_keyword( keywords )
+        call('keyword').add( @auth, add_group_id( keywords ) )
+      end
+
+      def add_creative( creatives )
+        call('creative').add( @auth, add_group_id( creatives ) )
+      end
+      
+      # Auxilary function
+      private
+      def add_group_id( types )
+        types = [types] unless types.is_a? Array
+        types.each do |type|
+          type.merge!( {group_id:@id} )
+        end
+        return types
+      end
+
+    end # Group
+  end # Operation
+end # PPC

data/lib/ppc/operation/keyword.rb

@@ -0,0 +1,32 @@
+module PPC
+  module Operation
+    class Keyword
+      include ::PPC::Operation
+
+      def info()
+        ::PPC::API::Baidu::Keyword::get( @auth, @id )
+      end
+
+      def update( type )
+        ::PPC::API::Baidu::Keyword::update( @auth, type.merge( id:@id) )
+      end
+
+      def activate()
+        ::PPC::API::Baidu::Keyword::activate( @auth, @id )
+      end
+      
+      def status()
+        ::PPC::API::Baidu::Keyword::status( @auth, @id )
+      end
+
+      def quality()
+        ::PPC::API::Baidu::Keyword::quality( @auth, @id )
+      end
+
+      def delete()
+        ::PPC::API::Baidu::Keyword::delete( @auth, @id )
+      end
+
+    end
+  end
+end

data/lib/ppc/operation/plan.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+module PPC
+  module Operation
+    class Plan
+      include ::PPC::Operation
+
+      def info
+        call('plan').get(@auth,@id)
+      end
+
+      def update( plan )
+        call('plan').update( @auth, plan.merge( id:@id ) )
+      end
+
+      def groups()
+        result = call('group').search_by_plan_id(@auth, @id)
+        result[:result] = result[:result][0][:groups]
+        return result
+      end
+
+      def group_ids()
+        result = call('group').search_id_by_plan_id(@auth, @id)
+        result[:result] = result[:result][0][:group_ids]
+        return result
+      end
+
+      # group opeartion
+      include ::PPC::Operation::Group_operation
+
+      # Overwirte add_group method to provide more function
+      def add_group( groups )
+        call('group').add( @auth, add_plan_id( groups ) )
+      end
+
+      # Auxilary function
+      private
+      def add_plan_id( types )
+        types = [types] unless types.is_a? Array
+        types.each do |type|
+          type.merge!({plan_id:@id})
+        end
+        return types
+      end
+
+    end # class plan
+  end # mudole Opeartion
+end # PPC

data/lib/ppc/operation.rb

@@ -0,0 +1,161 @@
+module PPC
+  module Operation
+
+    attr_accessor :id
+    
+    def initialize(params)
+      @id   = params[:id]
+      @se   = params[:se]
+      @auth = {
+        username: params[:username],
+        password: params[:password],
+        token:    params[:token]
+      }
+    end
+
+    def call(service)
+      eval "::PPC::API::#{@se.capitalize}::#{service.capitalize}"
+    end
+
+    def download(params = {})
+      bulk = ::PPC::Baidu::Bulk.new({
+                                      username: @username,
+                                      password: @password,
+                                      token:    @token,
+                                      debug:    @debug
+      })
+
+      params[:extended] = params[:extended] || 2
+
+      begin
+        file_id = bulk.file_id_of_all(params)
+        puts "file_id: #{file_id}" if @debug
+
+        loop do
+          state = bulk.state(file_id)
+          raise "invalid file state: #{state}" unless %w(1 2 3 null).include? state
+          break if state == '3'
+          puts "waiting for #{file_id} to be ready. current state:#{state}" if @debug
+          sleep 3
+        end
+        puts "#{file_id} is ready" if @debug
+        return bulk.path(file_id)
+      rescue
+        raise BulkException.new(file_id,bulk)
+      end  
+
+      return false
+    end
+
+    # ++++++++ #
+    # Lazy Code #
+    # ++++++++ #
+
+    # auxilary fucntion
+    def get_obj( ids, service )
+        '''
+        Return service object. 
+        Providing single id, return single object.
+        Providing multiple ids, return Array of objects
+        '''
+        class_obj =  eval "::PPC::Opeartion::#{service.capitalize}"
+        param = @auth
+        param[:se] = @se
+        objs = []
+
+        ids.each do |id|
+          param[:id] = id
+          objs << class_obj.new( param )
+        end
+
+        return objs[0] if objs.length == 1 else objs 
+    end
+
+    # +++++ Plan opeartion funcitons +++++ #
+    module Plan_operation
+      def get_plan( ids )
+        ::PPC::Opeartion::get_obj( ids, 'plan')
+      end
+
+      def add_plan( plans )
+        call('plan').add(@auth,plans)
+      end
+
+      def update_plan( plans )
+        call('plan').update(@auth,plans)
+      end
+
+      def delete_plan( ids )
+        call('plan').delete(@auth,ids)
+      end
+    end
+
+    # +++++ Group opeartion funcitons +++++ #
+    module Group_operation
+      def get_group( ids )
+        ::PPC::Opeartion::get_obj( ids, 'group')
+      end
+
+      def add_group( groups )
+        call('group').add(@auth,groups )
+      end
+
+      def update_group( groups )
+        call('group').update( @auth, groups )
+      end
+
+      def delete_group( ids )
+        call('group').delete( @auth, ids )
+      end
+    end
+
+    # +++++ Keyword opeartion funcitons +++++ #
+    module Keyword_operation
+      def get_keyword( ids )
+        ::PPC::Opeartion::get_obj( ids, 'keyword')
+      end
+      
+      def add_keyword( keywords )
+        call('keyword').add( @auth, keywords )
+      end
+
+      def update_keyword( keywords)
+        call('keyword').update( @auth, keywords )
+      end
+
+      def delete_keyword( ids )
+         call('keyword').delete( @auth, ids )
+      end
+    end
+
+    # +++++ Creative opeartion funcitons +++++ #
+    module Creative_operation
+      def get_creative( ids )
+        ::PPC::Opeartion::get_obj( ids, 'creative')
+      end
+      
+      def add_creative( creatives )
+        call('creative').add( @auth, creatives )
+      end
+
+      def update_creative( creatives )
+        call('creative').update( @auth, creatives )
+      end
+
+      def delete_creative( ids )
+        call('creative').delete( @auth, ids )
+      end
+    end
+
+  end # Opeartion
+end # PPC
+
+# requires are moved to the end of the file
+# because if we load files before defining the 
+# module ::PPC::Operation. Errors of 'uninitialized constance'
+# will occur
+require 'ppc/operation/account'
+require 'ppc/operation/group'
+require 'ppc/operation/plan'
+require 'ppc/operation/keyword'
+require 'ppc/operation/creative'

data/lib/ppc.rb

@@ -1,11 +1,7 @@
-require 'ppc/baidu'
-require 'ppc/sogou'
+require 'ppc/api'
+require 'ppc/operation'
 module PPC
-  VERSION = "1.0.6"
-  attr_reader :header,:body,:rquota,:quota,:status,:desc,:oprs,:oprtime,:code,:message
-  attr_accessor :username,:password,:token,:debug
-  def initialize(params = {})
-  end
+  VERSION = "1.3.0"
 
   protected
   def print_debug(var,varname=nil)

data/ppc.gemspec

@@ -5,10 +5,10 @@ require 'ppc'
 Gem::Specification.new do |spec|
   spec.name          = "ppc"
   spec.version       = PPC::VERSION
-  spec.authors       = ["charles"]
-  spec.email         = ["charles.liu@corp.elong.com"]
-  spec.summary       = %q{ppc api for google baidu etc}
-  spec.description   = %q{ppc api for google baidu etc}
+  spec.authors       = ["Chienli Ma, 刘梦晨， 刘明"]
+  spec.email         = ["maqianlie@gmail.com, liuyu_tc@163.com, seoaqua@qq.com"]
+  spec.summary       = %q{ppc api for  baidu qihu sogou}
+  spec.description   = %q{ppc api for  baidu qihu sogou}
   spec.homepage      = "http://github.com/seoaqua/ppc"
   spec.license       = "MIT"
 

data/spec/api_baidu_account_spec.rb

@@ -0,0 +1,18 @@
+describe ::PPC::API::Baidu::Account do
+  auth =  {}
+  auth[:username] = $baidu_username
+  auth[:password] = $baidu_password 
+  auth[:token] = $baidu_token
+  
+  it 'can get account info' do
+      result = ::PPC::API::Baidu::Account::info( auth )
+      is_success( result )
+  end
+
+  it 'can update account' do
+    update = {budget:2990}
+    result =  ::PPC::API::Baidu::Account::update( auth, update )
+    is_success( result )
+  end
+
+end

data/spec/api_baidu_creative_spec.rb

@@ -0,0 +1,71 @@
+describe ::PPC::API::Baidu::Creative do
+  auth =  {}
+  auth[:username] = $baidu_username
+  auth[:password] = $baidu_password 
+  auth[:token] = $baidu_token
+
+  Test_group_id = ::PPC::API::Baidu::Group::all( auth )[:result][0]['adgroupIds'][0]
+  Test_plan_id = ::PPC::API::Baidu::Plan::all( auth )[:result][0]['campaignId']
+  Test_creative_id = []
+  Test_domain = $baidu_domain
+
+ it 'can add creative' do
+    creative = { group_id: Test_group_id, 
+                        title: 'Test', preference:1, 
+                        description1:'this is rest',
+                        description2:'also is a test',
+                        pc_destination:Test_domain,
+                        pc_display:Test_domain }
+
+    response = ::PPC::API::Baidu::Creative::add( auth, creative )
+    is_success( response )
+    p "HAHAHAAHAH Creative"
+    p response
+    Test_creative_id << response[:result][0][:id]
+  end
+
+  # # 此测试未能通过，总是会出现莫名其妙的错误。
+  # it 'can update creative' do
+  #   update = { id:Test_creative_id[0], 
+  #                      title:'ElongUpdateTest',
+  #                      description1:'test for update',
+  #                      pause:true} 
+  #   response = ::PPC::API::Baidu::Creative::update( auth, update, true )
+  #   is_successed( response )
+  # end
+
+  it 'can activate creative' do
+    response = ::PPC::API::Baidu::Creative::activate( auth, Test_creative_id )
+    is_success( response )
+  end
+
+  it 'can get status' do
+    response1 = ::PPC::API::Baidu::Creative::status( auth, Test_group_id, 'group' )
+    response2 = ::PPC::API::Baidu::Creative::status( auth, Test_creative_id, 'creative' )
+    response3 = ::PPC::API::Baidu::Creative::status( auth, Test_plan_id, 'plan' )
+    is_success( response1 ) 
+    is_success( response2 ) 
+    is_success( response3 ) 
+  end
+
+  it 'can search id by group id' do
+    response = ::PPC::API::Baidu::Creative::get_by_group_id( auth, Test_group_id, 0 )
+    is_success( response )
+  end
+
+  it 'can search creative by group id' do
+    response = ::PPC::API::Baidu::Creative::search_by_group_id( auth, Test_group_id, 0 )
+    is_success( response )
+  end
+
+  it 'can search creative by creative id' do
+    response = ::PPC::API::Baidu::Creative::get( auth, Test_creative_id, 0 )
+    is_success( response )
+  end
+
+  it 'can delete creative' do 
+    response = ::PPC::API::Baidu::Creative::delete( auth, Test_creative_id )
+    is_success( response )
+  end
+
+end