baidu 1.2.10 → 2.0.0

data/spec/sem_keyword_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+describe Baidu::SEM::KeywordService do
+  subject{Baidu::SEM::KeywordService.new($auth)}
+  let(:keyword_sample){'XJK测试关键词LZJ'}
+  it "#addKeyword #updateKeyword #getKeywordByKeywordId #deleteKeyword " do
+    #addKeyword
+    # puts $adgroup_id
+    keywordType = {:adgroupId => $adgroup_id,:keyword=>keyword_sample,:matchType => 1,:price => 1}
+    response = subject.addKeyword({:keywordTypes => [keywordType]})
+    response.status.should == 0
+    response.desc.should == 'success'
+    response.quota.should == 2
+    response.rquota.should > 0
+    keyword_id = response.body[:keyword_types][:keyword_id]
+
+    #updateKeyword
+    keywordType = {:keywordId=> keyword_id,:price => 2}
+    response = subject.updateKeyword({:keywordTypes=>[keywordType]})
+    response.status.should == 0
+    response.desc.should == 'success'
+    response.quota.should == 2
+    response.rquota.should > 0
+    # ap response.body
+
+    #getKeywordByKeywordId
+    sleep 3
+    response = subject.getKeywordByKeywordId({:keywordIds => [keyword_id]})
+    response.status.should == 0
+    response.desc.should == 'success'
+    response.quota.should == 2
+    response.rquota.should > 0
+    # ap response.body
+    keyword = response.body[:keyword_types]
+    (keyword.is_a?Hash).should == true
+    keyword[:keyword_id].should == keyword_id
+    keyword[:adgroup_id].should == $adgroup_id
+    keyword[:keyword].should == keyword_sample
+    keyword[:price].should == "2.0"
+
+    #deleteKeyword
+    response = subject.deleteKeyword({:keywordIds => [keyword_id]})
+    response.status.should == 0
+    response.desc.should == 'success'
+    response.quota.should == 2
+    response.rquota.should > 0
+    response.body[:result].should == '1'
+  end
+end

data/spec/sem_report_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+describe Baidu::SEM::ReportService do
+  subject{Baidu::SEM::ReportService.new($auth)}
+    before :each do
+      @options = {}
+      @options[:performanceData] = [Baidu::SEM::PerformanceData::IMPRESSION, Baidu::SEM::PerformanceData::CLICK, Baidu::SEM::PerformanceData::CPC]
+      @options[:startDate] = (Time.now - 24*3600).utc.iso8601
+      @options[:endDate] = Time.now.utc.iso8601
+      @options[:statIds] = $campaign_ids
+      @options[:levelOfDetails] = Baidu::SEM::LevelOfDetails::CAMPAIGN
+      @options[:reportType] = Baidu::SEM::ReportType::CAMPAIGN
+    end
+
+    # describe "ReportService#getProfessionalReportId" do
+    #   @report_id = nil
+    it "返回的id必须是32位数字和小写字母组合" do
+      pending('need to rewrite')
+      response = subject.getProfessionalReportId({:reportRequestType => @options}).body
+      expect{ApiResponse.verify(response)}.not_to raise_error
+      # report_id.class.should == String
+      # report_id.should =~ /^[a-z0-9]{32}$/
+    end
+
+    it "处理未过期有效id(1小时内产生的）应返回ReportState中的枚举值" do
+      pending('need to rewrite')
+      response = subject.getProfessionalReportId({:reportRequestType => @options}).body
+      report_id = response[:report_id]
+      response = subject.getReportState({:reportId=>report_id}).body
+      expect{ApiResponse.verify(response)}.not_to raise_error
+      # report_state = response[:report_state]
+      # [Baidu::SEM::ReportState::PENDING,ReportState::DOING,ReportState::DONE].should include report_state
+    end
+
+    it "处理过期/无效id,应返回false" do
+      expect{subject.getReportState({:reportId=>'7da8438bc705c9e6e747959fafce91f2'}).body}.to raise_error
+      expect{subject.getReportState({:reportId=>'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}).body}.to raise_error
+    end
+end
+
+
+  # describe "ReportService#getReportState" do
+  #
+
+  # end
+  # describe "" do
+  # end
+  # describe "ReportService#getRealTimeQueryData" do
+  # end
+  # describe "ReportService#getRealTimePairData" do
+  # end
+  # describe "ReportService#getRealTimeData" do
+  # end

data/spec/sem_search_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+describe Baidu::SEM::SearchService do
+  subject{Baidu::SEM::SearchService.new($auth)}
+  describe '#getKeywordBySearch' do
+    it "cannot get any results when search for something that does't exists" do
+      respsonse = subject.getKeywordBySearch({:searchWord=>'things_that_not_exist!@$@%',:searchType=>0})
+      respsonse.status.should == 0
+      expect{ApiResponse.verify(respsonse.body)}.not_to raise_error
+      #@TODO
+      # ap respsonse
+      # res.more.should == 0
+      # res.results.should == nil
+
+      respsonse = subject.getKeywordBySearch({:searchWord=>'things_that_not_exist!@$@%',:searchType=>1})
+      #@TODO
+      # res.more.should == 0
+      # res.results.should == nil
+      expect{ApiResponse.verify(respsonse.body)}.not_to raise_error
+      # ap respsonse
+    end
+
+    it "should get some results when search for #{$searchWord}" do
+      respsonse = subject.getKeywordBySearch({:searchWord=>$searchWord,:searchType=>0})
+      expect{ApiResponse.verify(respsonse.body)}.not_to raise_error
+
+      # [0,1].should include res.more
+      # res.results.class.should == Array
+      # res.results.first.class.should == Hash
+      # res.results.first.keys.sort.should == [:keyword_id, :keyword, :adgroup_id,:adgroup_name, :campaign_id, :campaign_name].sort
+    end
+  end
+
+  describe '#getAdgroupBySearch' do
+    it "cannot get any adgroups when search for something that does't exists" do
+      options = {:adgroupName => 'things_that_not_exist!@#$',:searchType => 0}
+      respsonse = subject.getAdgroupBySearch(options)
+      # ap respsonse.body
+      expect{ApiResponse.verify(respsonse.body)}.not_to raise_error
+      # res.more.should == 0
+
+      options = {:adgroupName => 'things_that_not_exist!@#$',:searchType => 1}
+      respsonse = subject.getAdgroupBySearch(options)
+      expect{ApiResponse.verify(respsonse.body)}.not_to raise_error
+
+      # res.more.should == 0
+    end
+
+    it "should get some results when search for #{$searchAdgroup}" do
+      options = {:adgroupName => 'brand_e_air$',:searchType => 0}
+      respsonse = subject.getAdgroupBySearch(options)
+      expect{ApiResponse.verify(respsonse.body)}.not_to raise_error
+      # [0,1].should include res.more
+      # res.results.class.should == Hash
+      # res.results.keys.sort.should == [:adgroup_id, :adgroup_name, :campaign_id, :campaign_name].sort
+    end
+  end
+
+  describe '#getCampaignBySearch' do
+    it "cannot get any campaign when search for something that does't exists" do
+      options = {:campaignName => 'things_that_not_exist!@#$',:searchType => 0}
+      respsonse = subject.getCampaignBySearch(options)
+      expect{ApiResponse.verify(respsonse.body)}.not_to raise_error
+      # res.more.should == 0
+
+      options = {:campaignName => 'things_that_not_exist!@#$',:searchType => 1}
+      respsonse = subject.getCampaignBySearch(options)
+      expect{ApiResponse.verify(respsonse.body)}.not_to raise_error
+      # res.more.should == 0
+    end
+
+    it "should get some results when search for #{$searchCampaign}" do
+      options = {:campaignName => $searchCampaignName,:searchType => 0}
+      respsonse = subject.getCampaignBySearch(options)
+      expect{ApiResponse.verify(respsonse.body)}.not_to raise_error
+      # [0,1].should include res.more
+      # res.results.class.should == Hash
+      # res.results.keys.sort.should == [:campaign_id, :campaign_name].sort
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,356 @@
+require 'baidu'
+require 'time'
+#请根据自己实际情况填写
+BAIDU_MAP_KEY = '' #百度地图TOKEN
+$searchWord = '' #根据Word查已投放关键词
+$searchAdgroupName = '' #根据Adgroup查已投放的单元
+$searchCampaignName = '' #根据Campaign查已投放的计划
+$username = '' #账户 id=13
+$password = '' #密码
+$token = '' #token
+$auth = Baidu::Auth.new
+$auth.username = $username
+$auth.password = $password
+$auth.token = $token
+$startDate = (Time.now - 24*3600).utc.iso8601
+$endDate = Time.now.utc.iso8601
+$pcDestinationUrl = 'http://www.elong.com/'
+$mobileDestinationUrl = 'http://www.elong.com/'
+
+
+cs = Baidu::SEM::CampaignService.new($auth)
+campaigns = cs.getAllCampaign
+campaign = campaigns.body[:campaign_types].first
+$campaign_id = campaign[:campaign_id]
+$campaign_name = campaign[:campaign_name]
+
+ac = Baidu::SEM::AdgroupService.new($auth)
+adgroups = ac.getAdgroupIdByCampaignId({:campaignIds=>[$campaign_id]})
+$adgroup_id = adgroups.body[:campaign_adgroup_ids][:adgroup_ids].first
+
+class ApiResponse
+  class << self
+    def verify(hash)
+      hash.each do |k,v|
+        k = k.to_s
+        next if k.start_with?'@xmlns'
+        send(k,v)
+      end
+    end
+    def changed_creative_ids(changed_creative_ids)
+    end
+    def creative_types(creative_types)
+    end
+    def result(result)
+    end
+
+    def campaign_types(campaign_types)
+    end
+    def money(money)
+      raise "money:#{money}" unless money =~ /\d+\.\d{2}/
+    end
+    alias :balance :money
+    alias :cost :money
+    alias :payment :money
+
+    def budget(budget)
+    end
+
+    alias :budget_type :budget
+
+    def region_target(region_target)
+    end
+
+    def open_domains(open_domains)
+    end
+
+    def reg_domain(reg_domain)
+    end
+
+    def account_info_type(account_info_type)
+      raise "account_info_type:#{account_info_type}" if %w(userid balance cost payment budget_type budget region_target open_domains reg_domain).any?{|key|!account_info_type.has_key?key.to_sym}
+      verify(account_info_type)
+    end
+
+    def scale(scale)
+      raise "scale:#{scale}" unless scale.size == 2 and scale.is_a?Array
+    end
+    alias :changed_campaign_scale :scale
+    alias :changed_adgroup_scale :scale
+    alias :changed_keyword_scale :scale
+    alias :changed_creative_scale :scale
+
+    def campaign_infos(campaign_infos)
+      if campaign_infos.is_a?Hash
+        raise "campaign_infos#{campaign_infos}" if %w(campaign_id campaign_name).any?{|key|!campaign_infos.has_key?key.to_sym}
+        verify(campaign_infos)
+      else
+        raise "campaign_infos#{campaign_infos}"
+      end
+    end
+
+    def campaign_adgroups(campaign_adgroups)
+      if campaign_adgroups.is_a?Array
+        campaign_adgroups.each do |campaign_adgroup|
+          campaign_adgroup(campaign_adgroup)
+        end
+      elsif campaign_adgroups.is_a?Hash
+        verify(campaign_adgroups)
+      else
+        raise "campaign_adgroups:#{campaign_adgroups}"
+      end
+    end
+
+    def campaign_adgroup(campaign_adgroup)
+      raise 'campaign_adgroup' if %w(campaign_id adgroup_types).any?{|key|!campaign_adgroup.has_key?key.to_sym}
+      verify(campaign_adgroup)
+    end
+
+    def exact_negative_words(exact_negative_words)
+      raise "exact_negative_words:#{exact_negative_words}" unless exact_negative_words.is_a?Array or exact_negative_words.is_a?String
+    end
+
+    def negative_words(negative_words)
+      raise "negative_words:#{negative_words}" unless negative_words.is_a?Array or negative_words.is_a?String
+    end
+
+    def adgroup_types(adgroup_types)
+      if adgroup_types.is_a?Array #multiple adgroup_types
+        adgroup_types.each do |adgroup_type|
+          adgroup_type(adgroup_type)
+        end
+      elsif adgroup_types.is_a?Hash #single adgroup_type
+        adgroup_type(adgroup_types)
+      else
+        raise "adgroup_types:#{adgroup_types}"
+      end
+    end
+
+    def campaign_adgroup_ids(campaign_adgroup_ids)
+      if campaign_adgroup_ids.is_a?Array
+        campaign_adgroup_ids.each do |campaign_adgroup_id|
+          campaign_adgroup_id(campaign_adgroup_id)
+        end
+      elsif campaign_adgroup_ids.is_a?Hash
+        campaign_adgroup_id(campaign_adgroup_ids)
+      else
+        raise "campaign_adgroup_ids:#{campaign_adgroup_ids}"
+      end
+    end
+
+    def campaign_adgroup_id(campaign_adgroup_id)
+      raise "campaign_adgroup_id:#{campaign_adgroup_id}" if %w(campaign_id adgroup_ids).any?{|key|!campaign_adgroup_id.has_key?key.to_sym}
+      verify(campaign_adgroup_id)
+    end
+
+    def adgroup_type(adgroup_type)
+      raise "adgroup_type:#{adgroup_type}" if %w(adgroup_id campaign_id adgroup_name max_price pause status).any?{|key|!adgroup_type.has_key?key.to_sym}
+      verify(adgroup_type)
+    end
+
+    def adgroup_ids(adgroup_ids)
+      if adgroup_ids.is_a? String
+        adgroup_id(adgroup_ids)
+      elsif adgroup_ids.is_a?Array
+        adgroup_ids.each do |adgroup_id|
+          adgroup_id(adgroup_id)
+        end
+      else
+        raise "adgroup_ids:#{adgroup_ids}"
+      end
+    end
+
+    def adgroup_infos(adgroup_infos)
+      if adgroup_infos.is_a?Array
+        adgroup_infos.each do |adgroup_info|
+          adgroup_info(adgroup_info)
+        end
+      elsif adgroup_infos.is_a?Hash
+        adgroup_info(adgroup_infos)
+      else
+        raise "adgroup_infos:#{adgroup_infos}"
+      end
+    end
+
+    def adgroup_info(adgroup_info)
+      raise "adgroup_info:#{adgroup_info}" if %w(adgroup_id adgroup_name campaign_id campaign_name).any?{|key|!adgroup_info.has_key?key.to_sym}
+      verify(adgroup_info)
+    end
+
+    def keyword_infos(keyword_infos)
+      if keyword_infos.is_a?Array
+        keyword_infos.each do |keyword_info|
+          keyword_info(keyword_info)
+        end
+      elsif keyword_infos.is_a?Hash
+        keyword_info(keyword_info)
+      else
+        raise "keyword_infos:#{keyword_infos}"
+      end
+    end
+
+    def keyword_info(keyword_info)
+       raise "keyword_info:#{keyword_info}" if %w(keyword_id keyword adgroup_id adgroup_name campaign_id campaign_name).any?{|key|!keyword_info.has_key?key.to_sym}
+       verify(keyword_info)
+    end
+
+    def id(id)
+      raise "id:#{id}" unless id =~ /\d+/
+    end
+    alias :campaign_id :id
+    alias :adgroup_id :id
+    alias :keyword_id :id
+    alias :item_id :id
+    alias :userid :id
+
+    def name(name)
+      raise "name:#{name}" unless name =~ /.+/
+    end
+
+    alias :campaign_name :name
+    alias :adgroup_name :name
+
+
+    def keyword(keyword)
+      raise "keyword:#{keyword}" unless keyword =~ /.+/
+    end
+
+    def more(more)
+      raise "more:#{more}" unless more == '1' or more == '0'
+    end
+
+    alias :more_word :more
+    alias :more_campaign :more
+    alias :more_adgroup :more
+
+    def max_price(max_price)
+      raise "max_price:#{max_price}" unless max_price.to_f.to_s == max_price
+    end
+
+    def pause(pause)
+      raise "pause:#{pause}" unless !!pause == pause
+    end
+
+    def status(status)
+      raise "status:#{status}" unless status =~ /\d+/
+    end
+
+    def file_id(file_id)
+      raise "file_id:#{file_id}" unless file_id =~ /[0-9a-z]{32}/
+    end
+    alias :report_id :file_id
+
+    def file_paths(file_paths)
+      if file_paths.is_a?Array
+        file_paths.each do |file_path|
+          file_path(file_path)
+        end
+      else
+        raise "file_paths:#{file_paths}"
+      end
+    end
+
+    def file_path(file_path)
+      raise "file_path:#{file_path}" unless URI.parse(file_path)
+    end
+
+    alias :account_file_path :file_path
+    alias :campaign_file_path :file_path
+    alias :adgroup_file_path :file_path
+    alias :keyword_file_path :file_path
+    alias :creative_file_path :file_path
+
+    def file_md5(file_md5)
+      raise "file_md5:#{file_md5}" unless file_md5 =~ /[0-9a-z]{32}/
+    end
+    alias :account_file_md5 :file_md5
+    alias :campaign_file_md5 :file_md5
+    alias :adgroup_file_md5 :file_md5
+    alias :keyword_file_md5 :file_md5
+    alias :creative_file_md5 :file_md5
+
+    def is_generated(is_generated)
+      raise "is_generated:#{is_generated}" unless is_generated =~ /\d+/
+    end
+
+    def end_time(end_time)
+      end_time.is_a?DateTime
+    end
+
+
+    def changed_campaign_ids(changed_campaign_ids)
+      if changed_campaign_ids.is_a?Array
+        changed_campaign_ids.each do |changed_campaign_id|
+          changed_campaign_id(changed_campaign_id)
+        end
+      elsif changed_campaign_ids.is_a?Hash
+        changed_campaign_id(changed_campaign_ids)
+      else
+        raise "changed_campaign_ids:#{changed_campaign_ids}"
+      end
+    end
+
+    def changed_campaign_id(changed_campaign_id)
+      raise "changed_campaign_id:#{changed_campaign_id}" unless changed_campaign_id.has_key?(:campaign_id) and changed_campaign_id.has_key?(:operator)
+      verify(changed_campaign_id)
+    end
+
+    def changed_adgroup_ids(changed_adgroup_ids)
+      if changed_adgroup_ids.is_a?Array
+        changed_adgroup_ids.each do |changed_adgroup_id|
+          changed_adgroup_id(changed_adgroup_id)
+        end
+      elsif changed_adgroup_ids.is_a?Hash
+        changed_adgroup_id(changed_adgroup_ids)
+      else
+        raise "changed_adgroup_ids:#{changed_adgroup_ids}"
+      end
+    end
+
+    def changed_adgroup_id(changed_adgroup_id)
+      raise "changed_adgroup_id:#{changed_adgroup_id}" unless changed_adgroup_id.has_key?(:adgroup_id) and changed_adgroup_id.has_key?(:operator)
+      verify(changed_adgroup_id)
+    end
+
+    def changed_keyword_ids(changed_keyword_ids)
+      if changed_keyword_ids.is_a?Array
+        changed_keyword_ids.each do |changed_keyword_id|
+          changed_keyword_id(changed_keyword_id)
+        end
+      elsif changed_keyword_ids.is_a?Hash
+        # p changed_keyword_ids
+        changed_keyword_id(changed_keyword_ids)
+      else
+        raise "changed_keyword_ids:#{changed_keyword_ids}"
+      end
+    end
+
+    def changed_keyword_id(changed_keyword_id)
+       raise "changed_keyword_id:#{changed_keyword_id}" if [:operator, :item_id, :campaign_id, :adgroup_id].any?{|key|!changed_keyword_id.has_key?key}
+       verify(changed_keyword_id)
+    end
+
+    def operator(operator)
+      raise "operator:#{operator}" unless operator =~ /\d+/
+    end
+
+    def response(response)
+      raise "response:#{response}" unless response == 'placeholder'
+    end
+  end
+  # def account_file_md5(file_md5)
+  #   file_md5(file_md5)
+  # end
+  # def campaign_file_md5(file_md5)
+  #   file_md5(file_md5)
+  # end
+  # def adgroup_file_md5(file_md5)
+  #   file_md5(file_md5)
+  # end
+  # def keyword_file_md5(file_md5)
+  #   file_md5(file_md5)
+  # end
+  # def creative_file_md5(file_md5)
+  #   file_md5(file_md5)
+  # end
+end