ppc 0.3.0

data/lib/ppc/api/qihu/account.rb

@@ -0,0 +1,86 @@
+# -*- coding:utf-8 -*-
+require 'json'
+module PPC
+  module API
+    class Qihu
+      class Account < Qihu
+        Service = 'account'
+
+        @map = [
+                [ :id, :uid ],
+                [ :name, :userName ],
+                [ :email, :email],
+                [ :company, :companyName],
+                [ :industry1, :industry1],
+                [ :industry2, :industry2],
+                [ :balance, :balance],
+                [ :budget, :budget],
+                [ :resources, :resources],
+                [ :open_domains, :allowDomain]
+              ]
+        
+        def self.info( auth )
+          response = request( auth, Service, 'getInfo' )
+          process( response, '' ){ |x| reverse_type( x )[0]}
+        end
+
+        def self.update( auth, params )
+          '''
+          对奇虎两个update的在封装。如果所有操作成功，succ为true，否则为false
+          failure中以字符串方式返回失败的操作
+          '''
+          result = {}
+          result[:succ] = true
+          result[:failure] = []
+          result[:result] = []
+
+          if params[:budget] != nil
+            budget_result = update_budget( auth, params[:budget] )
+            result[:succ] = result[:succ] && budget_result[:succ]
+            result[:failure] << 'budget' unless budget_result[:succ]
+          end
+
+          if params[:exclude_ip] != nil
+            ip_result = update_exclude_ip( auth, params[:exclude_ip] )
+            result[:succ] = result[:succ] && ip_result[:succ]
+            result[:failure] << 'exclude_ip' unless budget_result[:succ]
+          end
+
+          return result
+        end
+
+        def self.get_all_object( auth, ids )
+          #文档上面写的输入类型是String？
+          body = { 'idList' =>  ids }
+          response = request( auth, Service, 'getAllObjects' )
+          process( response, 'account_getAllObjects_response' ){ |x| x }
+        end
+
+        def self.get_file_state( auth, id )
+          body = { 'fileId' => id }
+          response = request( auth, Service, 'getAllObjects' , body )
+          process( response, 'account_getFileState_response' ){ |x| x }
+        end
+
+        def self.get_exclude_ip( auth )
+          response = request( auth, Service, 'getExcludeIp' )
+          process( response, 'excludeIpList' ){ |x| x['item'] }
+        end
+
+        private
+        def self.update_budget( auth, budget )
+          response = request( auth, Service, 'updateBudget', { budget:budget })
+          process( response, 'affectedRecords' ){ | x | x.to_i==1?'success':'failure' }
+        end
+
+        private
+        def self.update_exclude_ip( auth, ips )
+          ips = to_json_string( ips )
+          response = request( auth, Service, 'updateExcludeIp', { excludeIpList: ips } )
+          process( response, 'excludeIpList' ){ | x | x }
+        end
+
+      end
+    end
+  end
+end

data/lib/ppc/api/qihu/creative.rb

@@ -0,0 +1,106 @@
+# -*- coding:utf-8 -*-
+module PPC
+  module API
+    class Qihu
+      class Creative< Qihu
+        Service = 'creative'
+
+        @map = [
+                 [:id,:id] ,
+                 [:group_id, :groupId],
+                 [:title,:title],
+                 [:description1, :description1],
+                 [:description2, :description2],
+                 [:pc_destination, :destinationUrl],
+                 [:pc_display, :displayUrl]
+                ]
+
+        @status_map = [ 
+                        [:id,:id], 
+                        [:quality,:qualityScore],
+                        [:status,:status]
+                      ]
+
+        def self.get( auth, ids )
+          body  = { 'idList' => to_json_string( ids ) }
+          response = request( auth, Service, 'getInfoByIdList', body )
+          process( response, 'creativeList'){ |x| reverse_type( x['item'] ) }
+        end
+
+        def self.add( auth,  creatives )
+          creative_types = make_type( creatives ).to_json
+          body = { 'creatives' => creative_types}
+          response = request( auth, Service, 'add', body )
+          process( response, 'creativeIdList'){ |x| to_id_hash_list( x['item'] ) }
+        end
+
+        # helper function for self.add() method
+        private
+        def self.to_id_hash_list( str )
+          reuturn [] if str == nil
+          str = [str] unless str.is_a?Array
+          x= []
+          str.each{ |i| x << { id: i.to_i } }
+          return x
+        end
+
+        def self.update( auth, creatives )
+          creative_types = make_type( creatives ).to_json
+          body = { 'creatives' => creative_types}
+          response = request( auth, Service, 'update', body )
+          process( response, 'affectedRecords', 'failCreativeIds' ){ |x| x }        
+        end
+
+         # 对update的再封装实现activate方法,未测试
+        def self.activate( auth, ids )
+          creatives = []
+          ids.each{ |id| creatives << { id: id, status:'enable'} }
+          update( auth, creatives )
+        end       
+
+        def self.delete( auth, ids )
+          ids = to_json_string( ids )
+          body = { 'idList' => ids }
+          response = request( auth, Service, 'deleteByIdList', body )
+          process( response, 'affectedRecords' ){ |x|x }     
+        end
+
+        def self.status( auth, ids )
+          body = { idList: to_json_string( ids ) }
+          response = request( auth, Service, 'getStatusByIdList', body )
+          process( response, 'creativeList' ){ |x| reverse_type( x['item'], @status_map ) }     
+        end
+
+        # quality 本质上和 status 在一个方法里面
+        def self.quality( auth, ids )
+          status( auth, ids)
+        end
+
+        def self.search_id_by_group_id( auth, id, status = nil)
+          # 处理条件  
+          body = {}
+          body['status'] = status if status
+          body['groupId'] = id
+          response = request( auth, Service, 'getIdListByGroupId', body )
+          # 伪装成百度接口
+          process( response, 'creativeIdList' ){ 
+            |x|  
+            [ { group_id:id, creative_ids:to_id_list( x==nil ? nil: x['item'] ) } ] 
+          }     
+        end
+
+        # combine two methods to provide another mether
+        def self.search_by_group_id( auth, id )
+          creative_ids = search_id_by_group_id( auth, id )
+          response = get( auth , creative_ids )
+          # 伪装成百度接口
+          if response[:succ]
+            response[:result] = [ { group_id:id, creatives:response[:result ] } ]
+          end
+          return response
+        end
+
+      end
+    end
+  end
+end

data/lib/ppc/api/qihu/group.rb

@@ -0,0 +1,113 @@
+# -*- coding:utf-8 -*-
+module PPC
+  module API
+    class Qihu
+      class Group < Qihu
+        Service = 'group'
+
+        @map = [
+                [:id, :id ],
+                [:plan_id, :campaignId],
+                [:status, :status ],
+                [:name, :name ],
+                [:price, :price ],
+                # negateive为json格式，make_type要定制
+                [:negative, :negativeWords ],
+                [:add_time, :addTime],
+                [:update_time, :updateTime]
+               ]
+
+        # 再次封装提供all和ids
+        def self.ids( auth )
+          '''
+          接口与其他的相同，但是无论如何：succ均为true，不返回任何错误信息
+          因为是重复调用了search的接口，速度非常的慢，* 慎用 *
+          '''
+          plan_ids = ::PPC::API::Qihu::Plan::ids( auth )[:result]
+          plan_group_ids = []
+
+          plan_ids.each do |plan_id|
+            plan_group_id = {}
+            plan_group_id[:plan_id] = plan_id
+            plan_group_id[:group_ids] = search_id_by_plan_id( auth, plan_id )[:result]
+            plan_group_ids << plan_group_id
+          end
+          return { succ: true, failure:nil, result: plan_group_ids }
+        end
+
+        def self.all( auth )
+          '''
+          unimplemented due to ineffciency
+          '''
+          # unimplement
+        end
+
+        # 奇虎组服务不提供批量add,delete和update方法
+        def self.add( auth, group )
+          response = request( auth, Service, 'add', make_type( group )[0] )
+          # 保证接口一致性
+          process( response, 'id' ){ |x| [ { id:x.to_i } ]    }
+        end
+        
+        def self.update( auth, group )
+          response = request( auth, Service, 'update', make_type( group )[0]  )
+          # 保证接口一致性
+          process( response, 'id' ){ |x|[ { id:x.to_i } ]  }
+        end
+
+        def self.get( auth, ids )
+          ids = to_json_string( ids )
+          body = { 'idList' => ids }
+          response = request( auth, Service, 'getInfoByIdList', body  )
+          process( response, 'groupList' ){ |x| reverse_type( x['item'] ) }
+        end
+
+        def self.delete( auth, id )
+          response = request( auth, Service, 'deleteById', { id: id}  )
+          process( response, 'affectedRecords' ){ |x| x == '1' }
+        end
+      
+        def self.search_id_by_plan_id( auth, id )
+          response = request( auth, Service, 'getIdListByCampaignId', { 'campaignId' => id.to_s })
+          #为了保持接口一致性，这里也是伪装成了百度的接口
+          process( response, 'groupIdList' ){ 
+            |x|
+             [ { plan_id:id, group_ids: to_id_list( x==nil ? nil: x['item'] ) } ]
+           }
+        end
+
+        # combine searchIdbyId and get to provide another method
+        def self.search_by_plan_id( auth, id )
+          group_ids = search_id_by_plan_id( auth, id )[:result][0][:group_ids]
+          response = get( auth, group_ids )
+          if response[:succ]
+            response[:result] = [ { plan_id:id, groups:response[:result]}]
+          end
+          return response
+        end
+
+      # customize make type to convert negative word
+      def self.make_type( params, map = @map)
+        '''
+        '''
+        params = [ params ] unless params.is_a? Array
+
+        types = []
+        params.each do |param|
+          type = {}
+
+            map.each do |key|
+              # next line transfer negative param to json
+              key[0]==:negative&&param[:negative] ? value=param[:negative].to_json : value=param[key[0]]
+              type[ key[1] ] = value if value != nil
+            end
+
+          types << type
+        end
+        return types
+      end
+
+      end
+    end
+  end
+end

data/lib/ppc/api/qihu/keyword.rb

@@ -0,0 +1,111 @@
+# -*- coding:utf-8 -*-
+module PPC
+  module API
+    class Qihu
+      class Keyword< Qihu
+        Service = 'keyword'
+
+        @map = [
+                  [:id, :id],
+                  [:group_id, :groupId],
+                  [:keyword, :word],
+                  [:price, :price],
+                  [:match_type, :matchType],
+                  [:pc_destination, :destinationUrl],
+                  [:status, :status]
+                ]
+
+        @status_map = [ 
+                        [:id,:id], 
+                        [:quality,:qualityScore],
+                        [:status,:status]
+                      ]
+
+        def self.get( auth, ids )
+          ids = to_json_string( ids )
+          body  = { 'idList' => ids }
+          response = request( auth, Service, 'getInfoByIdList', body )
+          process( response, 'keywordList'){ |x| reverse_type( x['item'] ) }
+        end
+
+        def self.add( auth,  keywords )
+          keyword_types =  make_type( keywords ).to_json
+          body = { 'keywords' => keyword_types}
+          response = request( auth, Service, 'add', body )
+          process( response, 'keywordIdList'){ |x| to_id_hash_list( x['item'] )  }
+        end
+
+        # helper function for self.add() method
+        private
+        def self.to_id_hash_list( str )
+          reuturn [] if str == nil
+          str = [str] unless str.is_a?Array
+          x= []
+          str.each{ |i| x << { id: i.to_i } }
+          return x
+        end
+
+        def self.update( auth, keywords )
+          keyword_types = make_type( keywords ).to_json
+          body = { 'keywords' => keyword_types}
+          response = request( auth, Service, 'update', body )
+          process( response, 'affectedRecords', 'failKeywordIds' ){ |x| x }        
+        end
+
+        # 对update的再封装实现activate方法
+        def self.activate( auth, ids )
+          keywords = []
+          ids.each{ |id| keywords << { id: id, status:'enable'} }
+          update( auth, keywords )
+        end
+
+        def self.delete( auth, ids )
+          body = { 'idList' => to_json_string( ids ) }
+          response = request( auth, Service, 'deleteByIdList', body )
+          process( response, 'affectedRecords' ){ |x|  x  }     
+        end
+
+        def self.status( auth, ids )
+          body = { idList: to_json_string( ids ) }
+          response = request( auth, Service, 'getStatusByIdList', body )
+          process( response, 'keywordList' ){ |x| reverse_type( x['item'], @status_map ) }     
+        end
+
+        # quality 本质上和 status 在一个方法里面
+        def self.quality( auth, ids )
+          status( auth, ids)
+        end
+        
+        def self.search_id_by_group_id( auth, id, status = nil, match_type = nil )
+          # 处理条件  
+          body = {}
+          body['status'] = status if status
+          body['matchType'] = match_type if match_type
+          body['groupId'] = id
+          response = request( auth, Service, 'getIdListByGroupId', body )
+          # 伪装成百度接口
+          process( response, 'keywordIdList' ){ 
+            |x|
+            [ { group_id:id, keyword_ids:to_id_list( x==nil ? nil: x['item'] ) } ]
+          }     
+        end
+
+        # combine search_id and get to provide another method
+        def self.search_by_group_id( auth, id )
+          keyword_ids = search_id_by_group_id( auth, id )[:result][0][:keyword_ids]
+          response = get( auth, keyword_ids )
+          if response[:succ]
+            # 伪装成百度接口
+            response[:result] = [ { group_id:id, keywords:response[:result] } ]
+          end
+          return response
+        end
+
+        def self.getChangedIdList
+          # unimplemented
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# -*- coding:utf-8 -*-
+module PPC
+  module API
+    class Qihu
+      class Plan < Qihu
+        Service = 'campaign'
+
+        @map = [
+                  [:id, :id],
+                  [:name,:name],
+                  [:budget, :budget],
+                  [:region, :region],
+                  [:schedule, :schedule],
+                  [:startDate, :startDate],
+                  [:endDate, :endDate ],
+                  [:status,:status], 
+                  [:extend_ad_type,:extendAdType]
+                ]
+
+
+        def self.get( auth, ids )
+          '''
+          :Type ids: ( Array of ) String or integer
+          '''
+          ids = to_json_string( ids )    
+          body = { ' idList' =>  ids  }
+          response = request( auth, Service, 'getInfoByIdList', body )
+          process( response, 'campaignList' ){ |x| reverse_type( x['item'] ) }
+        end
+
+        # move getCampaignId to plan module for operation call
+        def self.ids( auth )
+          response = request( auth, 'account', 'getCampaignIdList' )
+          process( response, 'campaignIdList' ){ |x| to_id_list( x['item'])}
+        end 
+
+        # combine two original method to provice new method
+        def self.all( auth )
+          plan_ids = ids( auth )[:result]
+          get( auth, plan_ids )
+        end
+        
+        # 奇虎计划API不提供批量服务
+        def self.add( auth, plan )
+          response = request( auth, Service, 'add', make_type( plan )[0])
+          # 这里将返回的简单int做一个array和hash的封装一保证接口和百度，搜狗的一致性
+          process( response, 'id' ){ |x| [ { id:x.to_i } ] }
+        end
+
+        def self.update( auth, plan ) 
+           response = request( auth, Service, 'update', make_type( plan )[0])
+           #同上，保证接口一致性
+           process( response, 'id' ){ |x| [ { id:x.to_i } ] }
+        end
+
+        def self.delete( auth, id )
+          response = request( auth, Service, 'deleteById', { id: id } )
+          process( response, 'affectedRecords' ){ |x|  x == '1'? 'success' : 'fail' }
+        end
+
+      end
+    end
+  end
+end