ppc 1.0.6 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef00fb5a5d3113cf2ae07e909ed79dedd8923722
-  data.tar.gz: 4cf8d77c5e0107f635f5248c8a73e04449b01ca5
+  metadata.gz: 66b985632890e757ec89f2c6900764a37f83338e
+  data.tar.gz: dc4a8c7f6e28d9786e8ee89c05673c4abff0cb3d
 SHA512:
-  metadata.gz: c1b4cf5437ed71cfe043a63b2473d229b89020d56c2ca2c341d880a6707fa5812927a9a3a08c9675b5963d59cd8bed3032b1b2df138a71bb567fd6300b05eb61
-  data.tar.gz: 141eb3bb4df485429a22e5e707cf65bbcc51f7ba3ea4919e233a8c235cb8fe337dfd27708cbf0293cedcf6b51885de7e7a67d3d23560716d2a2a296312f9b297
+  metadata.gz: 865cf3580b0a1714812b9d106ea2e17027a82efecbd42b92beb04ba55104166f89614544fcdb5ac4550b0599aba12166910e6a1978d008831e0708e285c2254e
+  data.tar.gz: bbd5984fb1247f4bb37e340d6d2b86397a4f713b7cf33ecaee6834fc95799f8f7b8b43c36dbf5ab52de0cb3952b70c7bd5a9760c21cae0cdff12e37d6ea13074

data/.gitignore

@@ -1,28 +1,36 @@
 *.gem
 *.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
 
-.DS_Store
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
 
-.tags
 
-.tags_sorted_by_file

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 seoaqua
+
+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.md

@@ -1,29 +1,6 @@
-# Ppc
+ppc
+===
 
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'ppc'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ppc
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/ppc/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+    ppc for 'pay per click'.
+#####This is a toolkit designed to provide consistent search engine account managing experience.
+#####For more information please checkout oop branch

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

@@ -0,0 +1,47 @@
+module PPC
+  module API
+    class Baidu
+      class Account< Baidu
+        Service = 'Account'
+
+        @map = [
+                          [:id,:userid],            
+                          [:balance,:balance],         
+                          [:cost,:cost],               
+                          [:payment,:payment],                          
+                          [:status,:userStat],                            
+                          [:budget_type,:budgetType],                   
+                          [:budget,:budget],                              
+                          [:region,:regionTarget],                    
+                          [:exclude_ip,:excludeIp],                        
+                          [:isdynamic,:isDynamicCreative],         
+                          [:dynamic_param,:dynamicCreativeParam], 
+                          [:open_domains,:openDomains],                  
+                          [:reg_domain,:regDomain],                       
+                          [:offline_time,:budgetOfflineTime],         
+                          [:weekly_budget,:weeklyBudget],                
+                          [:opt,:opt]                                  
+                        ]
+
+        def self.info(auth, debug = false)
+          response = request(auth,Service,'getAccountInfo'  )
+          return process( response, 'accountInfoType', debug ){ |x|reverse_type(x) }
+        end
+
+        def self.update(auth, param = {}, debug = false)
+          """
+          update account info
+          @ params : account_info_type
+          @return : account info_type
+          """
+          # for account service, there is not bulk operation
+          infoType = make_type( param )[0]
+          body = { accountInfoType: infoType }
+          response = request(auth,Service,'updateAccountInfo', body)
+          return process( response, 'accountInfoType', debug ){ |x|reverse_type(x) }
+        end
+
+      end
+    end
+  end
+end

data/lib/ppc/api/baidu/bulk.rb

@@ -0,0 +1,41 @@
+module PPC
+  module API
+    class Baidu
+      class Bulk < Baidu
+        Service = 'BulkJob'
+
+        def self.get_all_object( auth,params = {})
+          
+          plan_ids = params[:plan_ids]
+
+          unless plan_ids.nil?
+            plan_ids = plan_ids.class == Array ? plan_ids : [plan_ids]
+          end
+
+          options = {
+            campaignIds:              plan_ids              || []      ,
+            includeQuality:           params[:quality]      || true    ,
+            includeTemp:              params[:temp]         || false   ,
+            format:                   params[:format]       || 1       ,
+            newCreativeFiles:         params[:adcopy]       || 0       ,
+            includeTempNewCreatives:  params[:temp_adcopy]  || 0       ,
+            includePhraseType:        params[:phrase]       || 0       ,
+            extended:                 params[:extended]     || 0
+          }
+          response = request( auth, Service, 'getAllObjects',options )
+          response[:get_all_objects_response][:file_id]
+        end
+
+        def self.state( auth, id)
+          raise "empty id" if id.nil? or id.empty?
+          request(auth, Service, 'getFileState',{fileId:id})[:get_file_state_response][:is_generated]
+        end
+
+        def self.path( auth, id)
+          request( auth, Service, 'getFilePath',{fileId:id})[:get_file_path_response][:file_paths]
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+# -*- coding:utf-8 -*-
+module PPC
+  module API
+    class Baidu
+      class Creative< Baidu
+        Service = 'Creative'
+
+        @map =[
+                        [:id,:creativeId],
+                        [:group_id,:adgroupId],
+                        [:title,:title],
+                        [:description1,:description1],
+                        [:description2,:description2],
+                        [:pc_destination,:pcDestinationUrl],
+                        [:pc_display,:pcDisplayUrl],
+                        [:moile_destination,:mobileDestinationUrl],
+                        [:mobile_display,:mobileDisplayUrl],
+                        [:pause,:pause],
+                        [:preference,:devicePreference] 
+                      ]
+
+        def self.add( auth, creatives, debug = false )
+          body = { creativeTypes: make_type( creatives ) }
+          response = request( auth, Service, 'addCreative', body )
+          process( response, 'creativeTypes', debug ){ |x| reverse_type(x) }
+        end
+
+        def self.get( auth, ids,  getTemp = 0, debug = false  )
+          '''
+          \'getCreativeByCreativeId\'
+          @ input : creative ids
+          @ output: creative informations
+          '''
+          ids = [ ids ] unless ids.is_a? Array
+          body = { creativeIds: ids, getTemp: getTemp }
+          response = request( auth, Service, 'getCreativeByCreativeId', body )
+          process( response, 'creativeTypes', debug ){ |x| reverse_type(x) }
+        end
+
+        def self.update( auth, creatives, debug = false )
+          '''
+          根据实际使用情况，更新的时候creative title为必填选
+          '''
+          body = { creativeTypes: make_type( creatives ) }
+          response = request( auth, Service, 'addCreative', body )
+          process( response, 'creativeTypes', debug ){ |x| reverse_type(x) }
+        end
+
+        def self.delete( auth, ids, debug = false )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { creativeIds: ids }
+          response = request( auth, Service, 'deleteCreative', body )
+          process( response, 'result', debug ){ |x| x }
+        end
+
+        def self.activate( auth, ids, debug = false )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { creativeIds: ids }
+          response = request( auth, Service, 'activateCreative', body )
+          process( response, 'creativeTypes', debug ){ |x| reverse_type(x) }
+        end
+
+        def self.status( auth, ids, type, debug = false )
+          ids = [ ids ] unless ids.is_a? Array
+          
+          type = case type
+            when  'plan'      then    3 
+            when  'group'   then     5
+            when  'creative'       then     7
+            else
+              Exception.new( 'type must among: \'plan\',\'group\' and \'key\' ')            
+          end
+
+          body = { ids: ids, type: type }
+          response = request( auth, Service, 'getCreativeStatus', body )
+          process( response, 'CreativeStatus', debug ){ |x| x }
+        end
+
+        def self.search_id_by_group_id( auth, ids,  getTemp = 0, debug = false )
+          '''
+          \'getCreativeIdByAdgroupId\'
+          @ input: group ids
+          @ output:  groupCreativeIds
+          '''
+          ids = [ ids ] unless ids.is_a? Array
+          body = { adgroupIds: ids, getTemp: getTemp }
+          response = request( auth, Service, 'getCreativeIdByAdgroupId', body )
+          process( response, 'groupCreativeIds', debug ){ |x| make_groupCreativeIds( x ) }
+        end
+
+        def self.search_by_group_id( auth, ids,  getTemp = 0, debug = false )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { adgroupIds: ids, getTemp: getTemp }
+          response = request( auth, Service, 'getCreativeByAdgroupId', body )
+          process( response, 'groupCreatives', debug ){ |x| make_groupCreatives( x ) }
+        end
+
+        private
+        def self.make_groupCreativeIds( groupCreativeIds )
+          group_creative_ids = []
+          groupCreativeIds.each do |groupCreativeId|
+            group_creative_id = { }
+            group_creative_id[:group_id] = groupCreativeId['adgroupIds']
+            group_creative_id[:creative_ids] = groupCreativeId['creativeIds']
+            group_creative_ids << group_creative_id
+          end
+          return group_creative_ids
+        end
+
+        private
+        def self.make_groupCreatives( groupCreatives )
+          group_creatives = []
+          groupCreative.each do |groupKeyword|
+            group_creative = {}
+            group_creative[:group_id] = groupCreative['adgroupId']
+            group_creative[:keywords] = reverse_type( groupCreative['keywordTypes'] )
+            group_creatives << group_creative
+          end
+          return group_creatives
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# -*- coding:utf-8  -*-
+module PPC
+  module API
+    class Baidu
+      class Group< Baidu
+        Service = 'Adgroup'
+
+        @map =[
+                        [:plan_id, :campaignId],
+                        [:id, :adgroupId],
+                        [:name, :adgroupName],
+                        [:price, :maxPrice],
+                        [:negative, :negativeWords],
+                        [:exact_negative, :exactNegativeWords],
+                        [:pause, :pause],
+                        [:status, :status],
+                        [:reserved, :reserved]
+                      ]
+
+        def self.ids(auth, debug = false )
+          """
+          @return : Array of campaignAdgroupIds
+          """
+          response = request( auth, Service , "getAllAdgroupId" )
+          process( response, 'campaignAdgroupIds', debug ){ |x| make_planGroupIds( x ) }
+        end
+
+        def self.get( auth, ids, debug = false )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { adgroupIds: ids }
+          response = request(auth, Service, "getAdgroupByAdgroupId",body )
+          process( response, 'adgroupTypes', debug ){ |x| reverse_type(x) }
+        end
+
+        def self.add( auth, groups, debug = false )
+          """
+          @ input : one or list of AdgroupType
+          @ output : list of AdgroupType
+          """
+          adgrouptypes = make_type( groups )
+
+          body = {adgroupTypes:  adgrouptypes }
+          
+          response = request( auth, Service, "addAdgroup", body  )
+          process( response, 'adgroupTypes', debug ){ |x| reverse_type(x) }
+        end
+
+        def self.update( auth, groups, debug = false )
+          """
+          @ input : one or list of AdgroupType
+          @ output : list of AdgroupType
+          """
+          adgrouptypes = make_type( groups )
+          body = {adgroupTypes: adgrouptypes}
+          
+          response = request( auth, Service, "updateAdgroup",body )
+          process( response, 'adgroupTypes', debug ){ |x| reverse_type(x) }
+        end
+
+        def self.delete( auth, ids, debug = false )
+          """
+          delete group body has no message
+          """
+          ids = [ ids ] unless ids.is_a? Array
+          body = { adgroupIds: ids }
+          response = request( auth, Service,"deleteAdgroup", body )
+          process( response, 'nil', debug ){ |x|  x  }
+        end
+
+        def self.search_by_plan_id( auth, ids, debug = false )
+          ids = [ ids ] unless ids.class == Array
+          body = { campaignIds: ids }
+          response = request( auth, Service ,"getAdgroupByCampaignId",  body )
+          process( response, 'campaignAdgroups', debug ){ |x| make_planGroups( x ) }
+        end
+
+        def self.search_id_by_plan_id( auth, ids, debug = false )
+          ids = [ ids ] unless ids.class == Array
+          body = { campaignIds: ids }
+          response = request( auth, Service ,"getAdgroupIdByCampaignId",  body )
+          process( response, 'campaignAdgroupIds', debug ){ |x| make_planGroupIds( x ) }
+        end
+
+        private
+        def self.make_planGroupIds( campaignAdgroupIds )
+          planGroupIds = []
+          campaignAdgroupIds.each do |campaignAdgroupId|
+            planGroupId = { }
+            planGroupId[:plan_id] = campaignAdgroupId['campaignId']
+            planGroupId[:group_ids] = campaignAdgroupId['adgroupIds']
+            planGroupIds << planGroupId
+          end
+          return planGroupIds
+        end
+
+        private
+        def self.make_planGroups( campaignAdgroups )
+          planGroups = []
+          campaignAdgroups.each do |campaignAdgroup|
+            planGroup = {}
+            planGroup[:plan_id] = campaignAdgroup['campaignId']
+            planGroup[:groups] = reverse_type( campaignAdgroup['adgroupTypes'] )
+            planGroups << planGroup
+          end
+          return planGroups
+        end
+
+      end # class group
+    end # class baidu
+  end # API
+end # module

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

@@ -0,0 +1,193 @@
+# -*- coding:utf-8 -*-
+module PPC
+  module API
+    class Baidu
+      class Keyword< Baidu
+        Service = 'Keyword'
+
+        Match_type  = { 'exact' => 1, 'pharse' => 2, 'wide' => 3 }
+        Match_type_r  = { 1 => 'exact', 2=> 'pharse' , 3 => 'wide' }
+        
+        Device          = { 'pc' => 0, 'mobile' => 1, 'all' => 2 }
+        Type              = { 'plan' => 3, 'group' => 5, 'keyword' => 11 }
+        
+        @map  = [
+                            [:id,:keywordId],
+                            [:group_id,:adgroupId],
+                            [:keyword,:keyword],
+                            [:price,:price],
+                            [:pc_destination,:pcDestinationUrl],
+                            [:mobile_destination,:mobileDestinationUrl],
+                            [:match_type,:matchType],
+                            [:phrase_type,:phraseType]
+                        ]
+
+        @quality10_map = [
+                                          [ :id, :id ],
+                                          [ :group_id, :adgroupId ],
+                                          [ :plan_id, :Campaigned ],
+                                          [ :pc_quality, :pcQuality ],
+                                          [ :pc_reliable, :pcReliable ],
+                                          [ :pc_reason, :pcReason ],
+                                          [ :pc_scale, :pcScale ],
+                                          [ :mobile_quality, :mobileQuality ],
+                                          [ :mobile_reliable, :mobileReliable ],
+                                          [ :mobile_reason, :mobileReason ],
+                                          [ :mobile_scale, :mobileScale ]
+                                        ]
+
+        # 后面改成info方法
+        def self.get( auth, ids, debug = false )
+          '''
+          getKeywordByKeywordId
+          '''
+          ids = [ ids ] unless ids.is_a? Array
+          body = { keywordIds: ids}
+          response = request( auth, Service, 'getKeywordByKeywordId', body )
+          return process(response, 'keywordTypes', debug){|x| reverse_type( x ) }
+        end
+
+        def self.add( auth, keywords, debug = false )
+          '''
+          '''
+          keywordtypes = make_type( keywords ) 
+          body = { keywordTypes: keywordtypes }
+          response = request( auth, Service, "addKeyword", body )
+          return process(response, 'keywordTypes', debug){|x| reverse_type(x)  }
+        end
+
+        def self.update( auth, keywords, debug = false  )
+          '''
+          '''
+          keywordtypes = make_type( keywords ) 
+          body = { keywordTypes: keywordtypes }
+          response = request( auth, Service, "updateKeyword", body )
+          return process(response, 'keywordTypes', debug){|x| reverse_type(x)  }
+        end
+
+        def self.delete( auth, ids, debug = false )
+          """
+          """
+          ids = [ ids ] unless ids.is_a? Array
+          body = { keywordIds: ids}
+          response = request( auth, Service, 'deleteKeyword', body )
+          return process(response, 'result', debug){|x| x }
+        end
+
+        def self.activate( auth, ids, debug =false )
+          """
+          """
+          ids = [ ids ] unless ids.is_a? Array
+          body = { keywordIds: ids }
+          response = request( auth, Service, 'activateKeyword', body)
+          return process(response, 'keywordTypes', debug){|x| reverse_type(x)  }
+        end
+
+        def self.search_by_group_id( auth, group_ids, debug = false  )
+          """
+          getKeywordByGroupIds
+          @input: list of group id
+          @output:  list of groupKeyword
+          """
+          group_ids = [ group_ids ] unless group_ids.is_a? Array
+          body = { adgroupIds: group_ids }
+          response = request( auth, Service, "getKeywordByAdgroupId", body )
+          return process(response, 'groupKeywords', debug){|x| make_groupKeywords( x ) }
+        end
+
+        def self.search_id_by_group_id( auth, group_ids, debug = false  )
+          group_ids = [ group_ids ] unless group_ids.is_a? Array
+          body = { adgroupIds: group_ids }
+          response = request( auth, Service, "getKeywordIdByAdgroupId", body )
+          return process(response, 'groupKeywordIds', debug){|x| make_groupKeywordIds( x ) }
+        end
+
+        # 下面三个操作操作对象包括计划，组和关键字
+        # 不知道放在这里合不合适
+        def self.status( auth, ids, type, debug = false )
+          ids = [ ids ] unless ids.is_a? Array
+          body = { ids: ids, type: Type[type]}
+          response = request( auth, Service, 'getKeywordStatus', body )
+          return process(response, 'keywordStatus', debug){|x| reverse_type( x ) }
+        end
+
+        def self.quality( auth ,ids, type, device, debug = false )
+          '''
+          Return 10Quanlity *Not the old Quality* of given ketword id
+          '''
+          ids = [ ids ] unless ids.is_a? Array
+          body = { ids: ids, type: Type[type], device:Device[device] }
+          response = request( auth, Service, 'getKeyword10Quality', body )
+          return process(response, 'keyword10Quality', debug){|x| reverse_type( x, @quality10_map ) }
+        end
+
+        private
+        def self.make_groupKeywordIds( groupKeywordIds )
+          group_keyword_ids = []
+          groupKeywordIds.each do |groupKeywordId|
+            group_keyword_id = { }
+            group_keyword_id[:group_id] = groupKeywordId['adgroupIds']
+            group_keyword_id[:keyword_ids] = groupKeywordId['keywordIds']
+            group_keyword_ids << group_keyword_id
+          end
+          return group_keyword_ids
+        end
+
+        private
+        def self.make_groupKeywords( groupKeywords )
+          group_keywords = []
+          groupKeywords.each do |groupKeyword|
+            group_keyword = {}
+            group_keyword[:group_id] = groupKeyword['adgroupId']
+            group_keyword[:keywords] = reverse_type( groupKeyword['keywordTypes'] )
+            group_keywords << group_keyword
+          end
+          return group_keywords
+        end
+
+        # Override
+       def self.make_type( params, map = @map)
+          params = [ params ] unless params.is_a? Array
+          types = []
+          params.each do |param|
+            type = {}
+              map.each do |key|
+                # 增加对matchtype的自动转换
+                if key[0] == :match_type
+                   value = param[ key[0] ]
+                  type[ key[1] ] = Match_type[ value ] if value                 
+                else
+                  value = param[ key[0] ]
+                  type[ key[1] ] = value if value
+                end
+              end
+            types << type
+          end
+          return types
+        end
+
+        # Overwrite
+        def self.reverse_type( types, map = @map )
+          types = [ types ] unless types.is_a? Array
+          params = []
+          types.each do |type|
+            param = {}
+             # 增加对matchtype的自动转换
+              map.each do |key|
+                if key[0] == :match_type
+                   value = type[ key[1].to_s ]
+                  param[ key[0] ] = Match_type_r[ value ] if value                 
+                else
+                  value = type[ key[1].to_s ]
+                  param[ key[0] ] = value if value
+                end
+              end # map.each
+            params << param
+          end # types.each
+          return params
+        end
+
+      end # keyword
+    end # Baidu
+  end # API
+end # PPC