sem4r 0.1.2 → 0.1.3

data/spec/sem4r/report_definition/fixtures/mutate-add-report-req.xml

@@ -0,0 +1,63 @@
+<!-- Post to 'https://adwords-sandbox.google.com/api/adwords/cm/v201008/ReportDefinitionService' -->
+ 
+<env:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:env='http://schemas.xmlsoap.org/soap/envelope/' xmlns='https://adwords.google.com/api/adwords/cm/v201008'>
+  <env:Header>
+    <RequestHeader env:mustUnderstand='0'>
+      <authToken>
+        ***censured***
+      </authToken>
+      <userAgent>
+        Sem4r Adwords Ruby Client Library (http://github.com/sem4r/sem4r)
+      </userAgent>
+      <developerToken>
+        ***censured***
+      </developerToken>
+    </RequestHeader>
+  </env:Header>
+  <env:Body>
+    <mutate>
+      <operations xsi:type='n1:ReportDefinitionOperation' xmlns:n1='https://adwords.google.com/api/adwords/cm/v201008'>
+        <operator>
+          ADD
+        </operator>
+        <operand>
+          <selector>
+            <fields>
+              AdGroupId
+            </fields>
+            <fields>
+              Id
+            </fields>
+            <fields>
+              KeywordText
+            </fields>
+            <fields>
+              KeywordMatchType
+            </fields>
+            <fields>
+              Impressions
+            </fields>
+            <fields>
+              Clicks
+            </fields>
+            <fields>
+              Cost
+            </fields>
+          </selector>
+          <reportName>
+            Keywords performance report #1290336379254
+          </reportName>
+          <reportType>
+            KEYWORDS_PERFORMANCE_REPORT
+          </reportType>
+          <dateRangeType>
+            LAST_WEEK
+          </dateRangeType>
+          <downloadFormat>
+            CSV
+          </downloadFormat>
+        </operand>
+      </operations>
+    </mutate>
+  </env:Body>
+</env:Envelope>

data/spec/sem4r/report_definition/fixtures/mutate-add-report-res.xml

@@ -0,0 +1,68 @@
+<soap:Envelope xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'>
+  <soap:Header>
+    <ResponseHeader xmlns='https://adwords.google.com/api/adwords/cm/v201008'>
+      <requestId>
+        0789bb35587ef7a3c09857e7dc98f468
+      </requestId>
+      <operations>
+        1
+      </operations>
+      <responseTime>
+        342
+      </responseTime>
+      <units>
+        1
+      </units>
+    </ResponseHeader>
+  </soap:Header>
+  <soap:Body>
+    <mutateResponse xmlns='https://adwords.google.com/api/adwords/cm/v201008'>
+      <rval>
+        <id>
+          9257
+        </id>
+        <selector>
+          <fields>
+            AdGroupId
+          </fields>
+          <fields>
+            Id
+          </fields>
+          <fields>
+            KeywordText
+          </fields>
+          <fields>
+            KeywordMatchType
+          </fields>
+          <fields>
+            Impressions
+          </fields>
+          <fields>
+            Clicks
+          </fields>
+          <fields>
+            Cost
+          </fields>
+        </selector>
+        <reportName>
+          Keywords performance report #1290336379254
+        </reportName>
+        <reportType>
+          KEYWORDS_PERFORMANCE_REPORT
+        </reportType>
+        <hasAttachment>
+          false
+        </hasAttachment>
+        <dateRangeType>
+          LAST_WEEK
+        </dateRangeType>
+        <downloadFormat>
+          CSV
+        </downloadFormat>
+        <creationTime>
+          20101210 105826 America/Los_Angeles
+        </creationTime>
+      </rval>
+    </mutateResponse>
+  </soap:Body>
+</soap:Envelope>

data/spec/sem4r/report_definition/report_definition_service_spec.rb

@@ -20,7 +20,6 @@
 # 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.
-# 
 # -------------------------------------------------------------------------
 
 require File.expand_path(File.dirname(__FILE__) + '/../../rspec_helper')
@@ -33,13 +32,14 @@ describe ReportDefinitionService do
   end
 
   it "should define 'mutate'" do
-    pending "test"
-    response_xml = read_xml("report_definition", "mutate-res.xml")
+    @credentials.stub(:mutable?).and_return(true)
+    response_xml = read_xml("report_definition", "mutate-add-report-res.xml")
     connector = mock("connector")
     connector.should_receive(:send).and_return(response_xml)
+
     service = ReportDefinitionService.new(connector)
-    soap_message = service.all( @credentials )
-    els = soap_message.response.xpath("//getResponse")
+    soap_message = service.mutate(@credentials ,"xml")
+    els = soap_message.response.xpath("//mutateResponse")
     els.should_not be_empty
   end
 

data/spec/sem4r/report_definition/report_definition_spec.rb

@@ -20,7 +20,6 @@
 # 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.
-# 
 # -------------------------------------------------------------------------
 
 require File.expand_path(File.dirname(__FILE__) + '/../../rspec_helper')
@@ -36,13 +35,13 @@ describe ReportDefinition do
     @account = stub_account(services)
   end
 
-#  it "create should accept a block (instance_eval)" do
-#    rd = ReportDefinition.create(@account) do
-#      name "report"
-#    end
-#    rd.name.should  == "report"
-#    rd.id.should    == 10
-#  end
+  it "create should accept a block (instance_eval)" do
+    rd = ReportDefinition.create(@account) do
+      name "report"
+    end
+    rd.name.should  == "report"
+    rd.id.should  == 9257
+  end
 
 
   #  it "create should accept a block (call)" do
@@ -62,47 +61,33 @@ describe ReportDefinition do
 #    end
 #    adgroup.bids.should be_instance_of(ManualCPCAdGroupBids)
 #  end
-#
-#  it "create should accept a manual cpm bids" do
-#    adgroup = AdGroup.create(@campaign) do
-#      name "sem4r library"
-#      manual_cpm_bids do
-#        max_cpm 10000
-#      end
-#    end
-#    adgroup.bids.should be_instance_of(ManualCPMAdGroupBids)
-#  end
 #
 
   it "should build xml (input for google)" do
-    pending "test"
     report_definition = ReportDefinition.new(@account) do
-      name "report"
-#      manual_cpc_bids do
-#        keyword_max_cpc 20000000
-#        site_max_cpc 30000000
-#      end
+      name       "Keywords performance report #1290336379254"
+      type       "KEYWORDS_PERFORMANCE_REPORT"
+      date_range "LAST_WEEK"
+      format     "CSV"
+
+      field "AdGroupId"
+      field "Id"
+      field "KeywordText"
+      field "KeywordMatchType"
+      field "Impressions"
+      field "Clicks"
+      field "Cost"
     end
-    expected_xml = read_model("//operand", "report_definition", "mutate_add-req.xml")
-    puts expected_xml.to_s
-    report_definition.to_xml("operand").should xml_equivalent(expected_xml)
+    expected_xml = read_model("//operand", "report_definition", "mutate-add-report-req.xml")
+    report_definition.should xml_equivalent(expected_xml)
   end
 
-  #
-#  it "should parse xml (produced by google)" do
-#    el = read_model("//entries", "services", "ad_group", "get-first-res.xml")
-#    adgroup = AdGroup.from_element(@campaign, el)
-#    adgroup.id.should == 3060217923
-#    adgroup.name.should == "test adgroup"
-#    adgroup.status.should == "ENABLED"
-#  end
-#
-#  it "should parse xml (produced by google) with manual cpm bids" do
-#    el = read_model("//entries", "services", "ad_group", "get-manual-cpm-bids-res.xml")
-#    adgroup = AdGroup.from_element(@campaign, el)
-#    adgroup.bids.should be_instance_of(ManualCPMAdGroupBids)
-#  end
-    
-
+  it "should parse xml (produced by google)" do
+    el = read_model("//entries", "report_definition", "get-list-repdef-res.xml")
+    repdef = ReportDefinition.from_element(@account, el)
+    # adgroup.id.should == 3060217923
+    repdef.name.should == "Keywords performance report #1290336379254"
+    repdef.type.should == ReportDefinition::KEYWORDS_PERFORMANCE_REPORT
+  end
 
 end

data/{lib/sem4r/cli/commands/cli_list_report.rb → spec/sem4r/report_definition/report_field_spec.rb}

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
-# 
+#
 # 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
@@ -9,10 +9,10 @@
 # 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
@@ -20,15 +20,17 @@
 # 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.
-# 
 # -------------------------------------------------------------------------
 
-module Sem4r
+require File.expand_path(File.dirname(__FILE__) + '/../../rspec_helper')
 
-  CliListReport = CliCommand.define_command("reports", "list reports") do |account|
-    report(account.reports, :id, :name, :status)
-    account.adwords.p_counters
-    true
+describe ReportField do
+  include Sem4rSpecHelper
+
+  it "should parse xml (produced by google)" do
+    el = read_model("//rval", "report_definition", "getReportFields-res.xml")
+    report_field = ReportField.from_element(el)
+    report_field.field_name.should == "AdGroupId"
   end
 
-end
+end

data/spec/sem4r/rexml_parsing_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/spec/sem4r/{services/service_spec.rb → service_spec.rb}

@@ -23,7 +23,7 @@
 # 
 # -------------------------------------------------------------------------
 
-require File.expand_path(File.dirname(__FILE__) + '/../../rspec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../rspec_helper')
 
 describe Service do
   include Sem4rSpecHelper

data/spec/sem4r/targeting_idea/targeting_idea_selector_spec.rb

@@ -26,7 +26,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../rspec_helper')
 
 describe TargetingIdeaSelector do
-  include Sem4rSpecHelper, AggregatesSpecHelper
+  include Sem4rSpecHelper
 
   it "should produce xml (input for google)" do
     idea_selector = TargetingIdeaSelector.new do

data/spec/sem4r/targeting_idea/targeting_idea_service_spec.rb

@@ -37,7 +37,7 @@ describe TargetingIdeaService do
     connector = mock("connector")
     connector.should_receive(:send).and_return(response_xml)
     service = TargetingIdeaService.new(connector)
-    soap_message = service.get( @credentials,  "xml" )
+    soap_message = service.get( @credentials, "xml" )
     els = soap_message.response.xpath("//getResponse")
     els.should_not be_empty
   end

data/spec/sem4r/targeting_idea/targeting_idea_spec.rb

@@ -26,7 +26,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../rspec_helper')
 
 describe TargetingIdea do
-  include Sem4rSpecHelper, AggregatesSpecHelper
+  include Sem4rSpecHelper
 
   it "should parse xml (produced by google)" do
     el = read_model("//entries", "targeting_idea", "get-res.xml")

data/spec/sem4r/v13_account/account_service_spec.rb

@@ -39,7 +39,7 @@ describe AccountService do
     connector.should_receive(:send).and_return(response_xml)
 
     service = AccountService.new(connector)
-    soap_message = service.account_info( @credentials )
+    soap_message = service.account_info(@credentials)
 
     els = soap_message.response.xpath("//getAccountInfoResponse")
     els.should_not be_empty
@@ -52,7 +52,7 @@ describe AccountService do
     connector.should_receive(:send).and_return(response_xml)
 
     service = AccountService.new(connector)
-    soap_message = service.client_accounts( @credentials )
+    soap_message = service.client_accounts(@credentials)
 
     els = soap_message.response.xpath("//getClientAccountsResponse")
     els.should_not be_empty

data/spec/sem4r/v13_report/report_service_spec.rb

@@ -39,7 +39,7 @@ describe ReportService do
     connector.should_receive(:send).and_return(response_xml)
 
     report_service = ReportService.new(connector)
-    soap_message = report_service.all( @credentials )
+    soap_message = report_service.all(@credentials)
 
     els = soap_message.response.xpath("//getAllJobsReturn")
     els.should_not be_empty
@@ -53,7 +53,7 @@ describe ReportService do
     connector.should_receive(:send).and_return(response_xml)
 
     report_service = ReportService.new(connector)
-    soap_message = report_service.validate( @credentials, "xml" )
+    soap_message = report_service.validate(@credentials, "xml" )
 
     els = soap_message.response.xpath("//getAllJobsReturn")
     els.should_not be_empty

data/spec/{sem4r/cli → sem4r_cli}/cli_spec.rb

@@ -23,48 +23,43 @@
 #
 # -------------------------------------------------------------------------
 
-require File.dirname(__FILE__) + '/../../rspec_helper'
+require File.dirname(__FILE__) + '/../rspec_helper'
 
 describe "cli" do
   include Sem4rSpecHelper
 
-  describe CliSem do
-    
+  describe Sem4rCli::CliSem do
+
     it "should show help" do
       out = with_stdout_captured do
-        cli = CliSem.new
+        cli  = Sem4rCli::CliSem.new
         args = %w{ -h }
         cli.parse_and_run(args)
       end
-      out.should match("Usage")  
+      out.should match("Usage")
     end
-    
   end
 
-  describe CliCommonArgs do
-
-    it "should show help and exit" do
-      ret = true
-      out = with_stdout_captured do
-        args = %w{ -h }
-        cmd = CliCommonArgs.new
-        ret = cmd.parse(args)
-      end
-      out.should match("Usage")
-      ret.should be_false
+  it "should show help and exit" do
+    ret = true
+    out = with_stdout_captured do
+      args = %w{ -h }
+      cmd  = Sem4rCli::CliSem.new
+      ret  = cmd.parse_and_run(args)
     end
+    out.should match("Usage")
+    ret.should be_true
+  end
 
-    it "should show version and exit" do
-      ret = true
-      out = with_stdout_captured do
-        args = %w{ --version }
-        cmd = CliCommonArgs.new
-        ret = cmd.parse(args)
-      end
-      out.should match("sem4r version")
-      ret.should be_false
+  it "should show version and exit" do
+    ret = true
+    out = with_stdout_captured do
+      args = %w{ --version }
+      cmd  = Sem4rCli::CliSem.new
+      ret  = cmd.parse_and_run(args)
     end
-
+    out.should match("sem4r version")
+    ret.should be_true
   end
 
 end

data/spec/{soap_helpers → sem4r_soap}/soap_attributes_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -19,15 +20,14 @@
 # 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.
-#
 # -------------------------------------------------------------------------
 
 require File.expand_path(File.dirname(__FILE__) + '/../rspec_helper')
 
-describe SoapAttributes do
+describe Sem4rSoap::SoapAttributes do
 
   class TSoapAttributes
-    include Sem4r::SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     enum :Types,   [:Daily, :Monthly, :Weekly, :Yearly]
     enum :Columns, [:Id, :Campaign, :Keyword]

data/spec/{sem4r/services/soap_message_v13_spec.rb → sem4r_soap/soap_response_spec.rb}

@@ -20,29 +20,24 @@
 # 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.
-# 
 # -------------------------------------------------------------------------
 
-require File.expand_path(File.dirname(__FILE__) + '/../../rspec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../rspec_helper')
 
-describe SoapMessageV13 do
+describe Sem4rSoap::SoapResponse do
   include Sem4rSpecHelper
 
-  before do
-    @credentials = stub_credentials
-  end
-
-  it "should update counters" do
+  it "should update counters (v13 api)" do
     response_xml = read_xml("v13_report", "get_all_jobs-res.xml")
-    connector = mock("connector")
-    connector.should_receive(:send).and_return(response_xml)
-
-    message_v13 = SoapMessageV13.new(connector, @credentials)
-    message_v13.body = ""
-    message_v13.send("service_url", "soap_action")
-
+    message_v13 = Sem4rSoap::SoapResponse.new.parse_response(response_xml)
     message_v13.counters.should_not be_empty
     message_v13.counters.should ==  { :response_time => 177, :operations => 4, :units => 4 }
   end
 
+  it "should update counters (v2010 api)" do
+    response_xml = read_xml("ad_group", "get-first-res.xml")
+    message = Sem4rSoap::SoapResponse.new.parse_response(response_xml)
+    message.counters.should_not be_empty
+    message.counters.should ==  { :response_time => 170, :operations => 2, :units => 2 }
+  end
 end

data/spec/{sem4r/services/soap_call_spec.rb → sem4r_soap/soap_service_spec.rb}

@@ -20,32 +20,26 @@
 # 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.
-# 
 # -------------------------------------------------------------------------
 
-require File.expand_path(File.dirname(__FILE__) + '/../../rspec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../rspec_helper')
 
-describe SoapCall do
+describe Sem4rSoap::SoapService do
   include Sem4rSpecHelper
 
-  def mock_connector
-    mock("connector", :send => "send")
-  end
-
-  class TSoapService
-    include SoapCall
+  class TSoapService < Sem4rSoap::SoapServiceV2010
 
     def initialize(connector)
+      super()
       @connector = connector
     end
 
-    soap_call_v2010 :get,          :mutate => false
-    soap_call_v2010 :get_with_arg, :mutate => false
-    soap_call_v2010 :mutate
-    soap_call_v2010 :mutate_bis,   :mutate => true
-
-    private
+    soap_call :get,          :mutate => false
+    soap_call :get_with_arg, :mutate => false
+    soap_call :mutate
+    soap_call :mutate_bis,   :mutate => true
 
+    # private
 
     def _get(xml)
       <<-EOFS
@@ -58,59 +52,46 @@ describe SoapCall do
     end
   end
 
+  before do
+    @connector = mock("connector", :send => "send")
+    @readonly_credentials = stub_credentials
+    @service = TSoapService.new(@connector)
+  end
 
-  it "should define a new method" do
-    t = TSoapService.new(mock_connector)
-    r = t.methods.grep /^get$/
-    # t.methods.should include(:get)
+  it "should define a new method get" do
+    @service.methods.should include(:get)    if RUBY_VERSION =~ /1\.9/
+    @service.methods.should include("get")   if RUBY_VERSION =~ /1\.8/
+    r = @service.methods.grep /^get$/
     r.length.should == 1
   end
 
-#  it "should add a parameter to private method" do
-#    pending "test"
-#    get = TSoapService.instance_method(:get)
-#    _get = TSoapService.instance_method(:_get)
-#    get.arity.should == _get.arity + 1
-#  end
-
   it "calling 'get' should call private method _get" do
-    pending "Test"
-    credentials = stub_credentials
-    @connector = mock("connector", :send => "send")
-    # @connector.should_receive().with("get")
-    t = TSoapService.new(@connector)
-    t.should_receive(:_get).with("foo").and_return("get")
-    soap_message = t.get(credentials, "foo")
-    # soap_message.response.should == "send"
+    @service.should_receive(:_get).with("foo").and_return("get")
+    soap_message = @service.get(@readonly_credentials, "foo")
   end
 
   it "calling 'get_with_arg' should call private method _get_with_arg" do
-    credentials = stub_credentials
-    t = TSoapService.new(mock_connector)
-    t.get_with_arg(credentials, "foo")
+    @service.should_receive(:_get_with_arg).with("foo").and_return("get")
+    @service.get_with_arg(@readonly_credentials, "foo")
   end
 
   it "calling 'mutate' should raise an exception with read_only profile" do
-    credentials = stub_credentials
-    credentials.should_receive(:mutable?).and_return(false)
-    t = TSoapService.new(mock_connector)
-    t.should_not_receive(:_mutate)
-    lambda{ t.mutate(credentials, "foo")}.should raise_error(RuntimeError)
+    @service.should_not_receive(:_mutate)
+    lambda{ @service.mutate(@readonly_credentials, "foo")}.should raise_error(RuntimeError)
   end
 
-  it "call 'mutate' should call private methods _mutate with the right profile" do
-    credentials = stub_credentials
-    credentials.should_receive(:mutable?).and_return(true)
-    t = TSoapService.new(mock_connector)
-    t.should_receive(:_mutate).with("foo").and_return("")
-    t.mutate(credentials, "foo")
+  it "call 'mutate_bis' should raise an exception with read_only profile" do
+    @service.should_not_receive(:_mutate_bis)
+    lambda{ @service.mutate_bis(@readonly_credentials, "foo")}.should raise_error(RuntimeError)
   end
 
-  it "call 'mutate_bis' should raise an exception with read_only profile" do
-    credentials = stub_credentials
-    credentials.should_receive(:mutable?).and_return(false)
-    t = TSoapService.new(mock_connector)
-    t.should_not_receive(:_mutate_bis)
-    lambda{ t.mutate_bis(credentials, "foo")}.should raise_error(RuntimeError)
+  it "call 'mutate' should call private methods _mutate with the right profile" do
+    @mutable_credentials = stub_credentials
+    @mutable_credentials.should_receive(:mutable?).and_return(true)
+    @mutable_service = TSoapService.new(@connector)
+    
+    @mutable_service.should_receive(:_mutate).with("foo").and_return("")
+    @mutable_service.mutate(@mutable_credentials, "foo")
   end
+
 end