ppc 0.3.0

data/lib/ppc/api/sogou/plan.rb

@@ -0,0 +1,66 @@
+module PPC
+  module API
+    class Sogou
+      class Plan< Sogou
+        Service = 'CpcPlan'
+
+        @map = [
+                          [:id,:cpcPlanId],
+                          [:name,:cpcPlanName],
+                          [:budget,:budget], 
+                          [:region,:regions],
+                          [:ip,:excludeIps] ,
+                          [:negative,:negativeWords],
+                          [:exact_negative,:exactNegativeWords],
+                          [:schedule,:schedule], 
+                          [:budget_offline_time,:budgetOfflineTime],
+                          [:show_prob,:showProb],   
+                          [:join_union ,:joinUnion],
+                          [:device,:device],
+                          [:price_ratio,:mobilePriceRate ], 
+                          [:pause,:pause],
+                          [:status,:status],
+                        ]
+
+        def self.all( auth, debug = false )
+          response = request( auth, Service, 'getAllCpcPlan' )
+          process( response, 'cpcPlanTypes' , debug ){ |x| reverse_type(x) }
+        end
+
+        def self.ids( auth, debug = false )
+          response = request( auth, Service, 'getAllCpcPlanId' )
+          process( response, 'cpcPlanIds' , debug ){ |x| x }
+        end
+
+        def self.get( auth, ids, debug = false )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { cpcPlanIds: ids }
+          response = request( auth, Service, 'getCpcPlanByCpcPlanId', body)
+          process( response, 'cpcPlanTypes' , debug ){ |x| reverse_type(x) }
+        end
+
+        def self.add( auth, plans, debug = false )
+          cpcPlanTypes = make_type( plans )
+          body = { cpcPlanTypes: cpcPlanTypes }
+          response = request( auth, Service, 'addCpcPlan', body)
+          process( response, 'cpcPlanTypes' , debug ){ |x| reverse_type(x) }
+        end
+
+        def self.update(auth,plans, debug = false )
+          cpcPlanTypes = make_type( plans )
+          body = { cpcPlanTypes: cpcPlanTypes }
+          response = request( auth, Service, 'updateCpcPlan', body)
+          process( response, 'cpcPlanTypes' , debug ){ |x| reverse_type(x) }
+        end
+
+        def self.delete(auth, ids, debug = false )
+          ids = [ ids ] unless ids.class == Array
+          body = { cpcPlanIds: ids }
+          response = request( auth, Service, 'deleteCpcPlan', body)
+          process( response, '' , debug ){ |x| x }
+        end
+       
+      end # Service
+    end # baidu
+  end # API
+end # PPC

data/lib/ppc/api/sogou/report.rb

@@ -0,0 +1,129 @@
+# -*- coding:utf-8 -*-
+module PPC
+  module API
+    class Sogou
+      class Report< Sogou
+        Service = 'Report'
+      
+        # 需要用到的映射集合
+        Type_map = { 'account' => 1, 'plan'=> 2, 'group'=> 3, 
+                      'keyword'=> 5, 'creative'=> 4, 'pair'=> 15, 
+                       'query'=> 3 }
+
+        Range_map = {  'account' => 1, 'plan' => 2, 'group' => 3, 
+                        'creative' => 4, 'keyword' => 5 }
+
+        Device_map = { 'all' => 0, 'pc' => 1, 'mobile' => 2 }
+
+        Unit_map = { 'day' => 1, 'week' => 2, 'month' => 3 }
+
+        def self.get_id( auth, params, debug = false )
+          request = make_reportrequest( params )
+          body =  { reportRequestType: request }
+          response = request( auth, Service, 'getReportId' ,body) 
+          process( response, 'reportId', debug ){ |x| x }
+        end
+
+        def self.get_state( auth, id, debug = false)
+          '''
+          input id should be string
+          '''
+          status = {'-1'=>'Waiting' ,'0'=>'Opearting' ,'1'=>'Finished'}
+          body = { reportId:  id }
+          response = request( auth, Service, 'getReportState' ,body)
+          process( response, 'isGenerated', debug ){ |x| status[x] }
+        end
+
+        def self.get_url( auth, id, debug = false )
+          body = { reportId:  id }
+          response = request( auth, Service, 'getReportPath' ,body)
+          process( response, 'reportFilePath', debug ){ |x| x }       
+        end
+
+        private
+        def self.make_reportrequest( param )
+          '''
+          make RepoerRequestType
+          ======================
+          For more docs please have a look at
+          ::PPC::API::Baidu::Report:make_reportrequest()
+          '''
+          requesttype = {}
+          requesttype[:performanceData]    =     param[:fields] || %w(click)
+          requesttype[:reportType]         =     Type_map[ param[:type] ]        if  param[:type] 
+          requesttype[:statRange]          =     Range_map[ param[:range] ]      if param[:range]
+          requesttype[:unitOfTime]         =     Unit_map[ param[:unit] ]        if param[:unit] 
+          requesttype[:platform]           =     Device_map[ param[:device] ]    if param[:device]
+          requesttype[:idOnly]             =     param[:id_only]                 if param[:id_only]!=nil
+          requesttype[:startDate] = parse_date( param[:startDate] )
+          requesttype[:endDate]   = parse_date( param[:endDate] )
+          return requesttype
+        end
+
+        private 
+        def self.parse_date( date )
+          """
+          Cast string to time:
+          'YYYYMMDD' => Time
+          """
+          if date
+            y = date[0..3]
+            m = date[4..5]
+            d = date[6..7]
+            date = Time.new( y, m, d )
+          else
+            date = (Time.now - 24*3600)
+          end
+          date.utc.iso8601
+        end
+
+        ###########################
+        # intreface for Operation #
+        ###########################
+        def self.download_report( auth, param, debug = false )
+          response = get_id( auth, param )
+          if response[:succ]
+            id = response[:result]
+            p "Got report id:" + id.to_s if debug 
+            loop do
+              sleep 2 
+              break if get_state( auth, id )[:result] == 'Finished'
+              p "Report is not generated, waiting..." if debug 
+            end
+
+            url = get_url( auth, id )[:result]
+            ActiveSupport::Gzip.decompress( open(url).read )
+          else
+            raise response[:failure][:message]
+          end
+        end
+
+        def self.query_report( auth, param = nil, debug = false )
+          param = {} if not param
+          param[:type]   ||= 'query'
+          param[:fields] ||=  %w(click)
+          param[:range]  ||= 'account'
+          param[:unit]   ||= 'day'
+          download_report( auth, param, debug )
+        end
+
+        def self.creative_report( auth, param = nil, debug = false )
+          param = {} if not param
+          param[:type]   ||= 'creative'
+          param[:fields] ||=  %w( cost cpc click impression ctr )
+          param[:range]  ||= 'account'
+          download_report( auth, param, debug )
+        end
+
+        def self.keyword_report( auth, param = nil, debug = false )
+          param = {} if not param
+          param[:type]   ||= 'keyword'
+          param[:fields] ||=  %w( cost cpc click impression ctr )
+          param[:range]  ||= 'account'
+          download_report( auth, param, debug )
+        end
+
+      end # Repost
+    end # Baidu
+  end # API
+end # PPC

data/lib/ppc/ext.rb

@@ -0,0 +1,9 @@
+class String
+  def snake_case
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end

data/lib/ppc/operation.rb

@@ -0,0 +1,196 @@
+module PPC
+  module Operation
+
+    attr_accessor :id
+    
+    def initialize( params )
+      
+      if params[:se] == nil
+        raise 'please specific a search engine'
+      else 
+        @se = params[:se]
+      end
+      @id = params[:id]
+      @auth = {
+        username: params[:username],
+        password: params[:password],
+        # 在qihu360的api中，apikey就是auth[:token]
+        token:    params[:token]
+      }
+      # add support for qihu360
+      if  @se == 'qihu' && params[:accessToken] == nil 
+        raise "you are using qihu service, please enter cipherkey" if params[:cipherkey] == nil
+        raise "you are using qihu service, please enter cipheriv" if params[:cipheriv] == nil
+        cipher = { key: params[:cipherkey], iv: params[:cipheriv] } 
+        @auth[:accessToken] = qihu_refresh_token( @auth, cipher )
+      else
+        @auth[:accessToken] = params[:accessToken]
+      end
+    end
+
+    def qihu_refresh_token( auth, cipher )
+        cipher_aes = OpenSSL::Cipher::AES.new(128, :CBC)
+        cipher_aes.encrypt
+        cipher_aes.key = cipher[:key]
+        cipher_aes.iv = cipher[:iv]
+        encrypted = (cipher_aes.update(Digest::MD5.hexdigest( auth[:password] )) + cipher_aes.final).unpack('H*').join
+        url = "https://api.e.360.cn/account/clientLogin"
+        response = HTTParty.post(url,
+          :body => {
+          :username => auth[:username],
+          :passwd => encrypted[0,64]
+          },
+          :headers => {'apiKey' => auth[:token] }
+        )
+        data = response.parsed_response
+        data["account_clientLogin_response"]["accessToken"]
+    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 #
+    # ++++++++ #
+
+    # helper 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.length == 1 ? objs[0] : 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/report'
+require 'ppc/operation/account'
+require 'ppc/operation/group'
+require 'ppc/operation/plan'
+require 'ppc/operation/keyword'
+require 'ppc/operation/creative'
+

data/lib/ppc/operation/account.rb

@@ -0,0 +1,53 @@
+module PPC
+  module Operation
+    class Account
+      include ::PPC::Operation
+
+      # self operations
+      def info
+        info = call('account').info(@auth)
+        p info
+        @id = info[:result][:id] if @id == nil
+        return info
+      end
+
+      def update(account)
+        call('account').update(@auth,account)
+      end
+
+      # subobject(plan) operations
+      def plans
+        call('plan').all(@auth)
+      end
+
+      def plan_ids
+        call('plan').ids(@auth)
+      end
+      
+      # some useful keyword operations
+      def keywords(group_id)
+        call( 'keyword' ).search_by_group_id( @auth, group_id )
+      end
+
+      def keyword_ids(group_id)
+        call( 'keyword' ).search_id_by_group_id( @auth, group_id )
+      end
+      
+      # plan operations
+      include ::PPC::Operation::Plan_operation
+
+      # group opeartions
+      include ::PPC::Operation::Group_operation
+
+      # keyword opeartions
+      include ::PPC::Operation::Keyword_operation
+
+      # creative opeartions
+      include ::PPC::Operation::Creative_operation
+
+      # report operations
+      include ::PPC::Operation::Report
+
+    end
+  end
+end