yieldmanager 0.3.0 → 0.3.1

data/README.rdoc

@@ -60,8 +60,8 @@ the partial dataset on-the-fly or accumulating it for later use.
 
 === Pulling reports
 
-Accessing reportware assumes you've used the "Get Report XML"
-functionality in the UI to get your request XML data, or have
+Accessing reportware assumes you've used the "Get request XML"
+functionality in the UI to get your request XML, or have
 crafted one from scratch. Assuming it's in a variable called
 *request_xml*, you'd access the data this way:
 
@@ -73,12 +73,19 @@ crafted one from scratch. Assuming it's in a variable called
 		end
 	end
 
+Column data can be accessed either by index or column name:
+
+	report.headers # => ['advertiser_name','seller_imps']
+	report.data[0][0] # => "Bob's Ads"
+	report.data[0].by_name('advertiser_name') # => "Bob's Ads"
+	report.data[0].by_name(:advertiser_name) # => "Bob's Ads"
+
 *NOTE* Any totals columns your xml requests will be interpreted
 as ordinary data.
 
 === session vs. start_session/end_session
 
-The +session+ method opens a session, gives you a token to use in your service
+The *session* method opens a session, gives you a token to use in your service
 calls, then closes the session when the block ends, even if an exception is
 raised during processing. It's the recommended method to ensure you don't
 hang connections when things go wrong. If you use start/end, make sure you

data/TODO

@@ -13,7 +13,7 @@
 ** DONE Yieldmanager::Report DTO
 *** DONE headers array (for proper column ordering)
 *** DONE data as array of arrays
-*** data as array of hashes
+*** DONE data as array of hashes (string or symbol keys)
 ** DONE hpricot for parsing (http://github.com/hpricot/hpricot/)
 ** how to handle subtotal/total rows?
 ** cast columns to ruby types based on column[data_type]?

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/yieldmanager/report.rb

@@ -3,7 +3,13 @@ module Yieldmanager
   #
   # The #pull method is typically called by Yieldmanager::Client#pull_report.
   #
-  # Data is returned as an array of arrays.
+  # Data is returned as an array that can be accessed either by index
+  # or by column name:
+  #
+  #   report.headers # => ['advertiser_name','seller_imps']
+  #   report.data[0][0] # => "Bob's Ads"
+  #   report.data[0].by_name('advertiser_name') # => "Bob's Ads"
+  #   report.data[0].by_name(:advertiser_name) # => "Bob's Ads"
   # 
   # Column order is stored in the *headers* array.
   class Report
@@ -41,18 +47,27 @@ private
       (doc/"header column").each do |col|
         headers << col.inner_html
       end
-      (doc/"row").each_with_index do |row,idx|
-        # TODO make data available as keyword hashes, too
-        # row_hash = {}
-        # (row/"column").each do |col|
-        #   row_hash[headers[idx]] = col.inner_html
-        # end
-        # data << row_hash
+      (doc/"row").each_with_index do |row_elems,idx|
         # TODO cast elements to appropriate types based on column attrs
-        data << (row/"column").collect do |col|
-          col.inner_html
+        row = ReportRow.new(headers)
+        (row_elems/"column").each do |col|
+          row << col.inner_html
+        end
+        data << row
+      end
+    end
+    
+    class ReportRow < Array
+      def initialize headers
+        @name_lookup = {}
+        headers.each_with_index do |header, idx|
+          @name_lookup[header] = idx
         end
       end
+      
+      def by_name name
+        at(@name_lookup[name.to_s])
+      end
     end
   end
 

data/spec/reports/sample_report.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RWResponse>
+<RESPONSE>
+<DATA>
+<HEADER>
+<COLUMN>first</COLUMN>
+<COLUMN>second</COLUMN>
+</HEADER>
+<ROW>
+  <COLUMN data_type="text" id="5" >one</COLUMN>
+  <COLUMN data_type="numeric" >1</COLUMN>
+</ROW>
+<ROW>
+  <COLUMN data_type="text" id="12" >two</COLUMN>
+  <COLUMN data_type="numeric" >2</COLUMN>
+</ROW>
+</DATA>
+<METADATA tracking_id="1" rows="2" columns="2" domain="network" timeend="2009-11-22 00:00:00" timestart="2009-11-21 00:00:00" timezone="America/New_York"/>
+</RESPONSE>
+</RWResponse>

data/spec/yieldmanager/report_spec.rb

@@ -13,6 +13,7 @@ describe "A Yieldmanager report request" do
 
   before(:each) do
     @ym = Yieldmanager::Client.new(login_args)
+    @sample_report = File.join(File.dirname(__FILE__), '..', 'reports', 'sample_report.xml')
   end
   
   it "returns report object" do
@@ -50,10 +51,16 @@ describe "A Yieldmanager report request" do
   end
   
   it "offers data as array of arrays" do
-    @ym.session do |token|
-      report = @ym.pull_report(token, request_xml)
-      report.data[0][0].should_not be_nil
-    end
+    report = Yieldmanager::Report.new
+    report.send(:retrieve_data, @sample_report)
+    report.data[0][0].should == "one"
+  end
+  
+  it "offers data as array of hashes" do
+    report = Yieldmanager::Report.new
+    report.send(:retrieve_data, @sample_report)
+    report.data[0].by_name('first').should == "one"
+    report.data[1].by_name(:second).should == "2"
   end
   
   it "complains if report token is nil"

data/yieldmanager.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yieldmanager}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bill Gathen"]
-  s.date = %q{2009-11-21}
+  s.date = %q{2009-11-22}
   s.description = %q{This gem offers full access to YieldManager's API tools (read/write) as well as ad-hoc reporting through the Reportware tool}
   s.email = %q{bill@billgathen.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/yieldmanager/builder.rb",
      "lib/yieldmanager/client.rb",
      "lib/yieldmanager/report.rb",
+     "spec/reports/sample_report.xml",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/yieldmanager/builder_spec.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yieldmanager
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Bill Gathen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-21 00:00:00 -05:00
+date: 2009-11-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ files:
 - lib/yieldmanager/builder.rb
 - lib/yieldmanager/client.rb
 - lib/yieldmanager/report.rb
+- spec/reports/sample_report.xml
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/yieldmanager/builder_spec.rb