rawapi 0.1.1 → 0.1.2

data/Manifest.txt

@@ -5,6 +5,11 @@ README.txt
 Rakefile
 
 lib/rawapi.rb
+lib/rawapi/entry.rb
+lib/rawapi/feed.rb
+lib/rawapi/item.rb
+lib/rawapi/response.rb
+lib/rawapi/referer.rb
 lib/rawapi/version.rb
 setup.rb
 test/test_helper.rb

data/lib/rawapi/entry.rb

@@ -0,0 +1,7 @@
+class Entry
+  attr_accessor :date, :circulation, :hits, :items
+  
+  def initialize
+    @items = []
+  end
+end

data/lib/rawapi/feed.rb

@@ -0,0 +1,7 @@
+class Feed
+  attr_accessor :id, :uri, :entries
+  
+  def initialize
+    @entries = []
+  end
+end

data/lib/rawapi/item.rb

@@ -0,0 +1,7 @@
+class Item
+  attr_accessor :title, :url, :itemviews, :clickthroughs, :referers
+  
+  def initialize
+    @referers = []
+  end
+end

data/lib/rawapi/referer.rb

@@ -0,0 +1,3 @@
+class Referer
+  attr_accessor :url, :itemviews, :clickthroughs
+end

data/lib/rawapi/response.rb

@@ -0,0 +1,42 @@
+# The Response object is the ruby object version of the webservice response.
+class Response
+  attr_accessor :status, :code, :message, :feeds
+  
+  def initialize
+    @feeds = []
+  end
+  
+  # returns a formated string representing the response object. good for debugging.
+  def to_s
+    output = []
+    output << "Status: #{@status}"
+    output << "Code: #{@code}" if @code
+    output << "Message: #{@message}" if @message
+    for feed in @feeds
+      output << "-Feed"
+      output << "  Id: #{feed.id}" if feed.id
+      output << "  URI: #{feed.uri}" if feed.uri
+      for entry in feed.entries
+        output << "  -Entry"
+        output << "    Date: #{entry.date}" if entry.date
+        output << "    Circulation: #{entry.circulation}" if entry.circulation
+        output << "    Hits: #{entry.hits}" if entry.hits
+        for item in entry.items
+          output << "    -Item"
+          output << "      Title: #{item.title}" if item.title
+          output << "      URL: #{item.url}" if item.url
+          output << "      ItemViews: #{item.itemviews}" if item.itemviews
+          output << "      Clickthoughs: #{item.clickthroughs}" if item.clickthroughs
+          for referer in item.referers
+            output << "      -Referer"
+            output << "        URL: #{referer.url}" if referer.url
+            output << "        ItemViews: #{referer.itemviews}" if referer.itemviews
+            output << "        Clickthoughs: #{referer.clickthroughs}" if referer.clickthroughs
+          end
+        end
+      end
+    end
+    
+    return output.join("\n")
+  end
+end

data/lib/rawapi/version.rb

@@ -2,7 +2,7 @@ module Rawapi #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    BUILD  = 1
+    BUILD  = 2
 
     STRING = [MAJOR, MINOR, BUILD].join('.')
   end

data/lib/rawapi.rb

@@ -4,9 +4,25 @@ require 'open-uri'
 require 'rexml/document'
 include REXML
 
+# Class to provide the interface to the Awareness API
+#
+# dates:
+#  * Individual dates always use this format: YYYY-MM-DD
+#  * Date ranges are expressed with a comma: YYYY-MM-D1, YYYY-MM-D7 means all dates between and including D1 and D7
+#  * If a range is specified, the second date must always be later than the first date
+#  * A single date will be interpreted as a range of one date: YYYY-MM-D1 = YYYY-MM-D1, YYYY-MM-D1
+#  * Discrete ranges are separated by a slash: YYYY-MM-D1/YYYY-MM-D5/YYYY-MM-D7,YYYY-MM-D14 means D1 and D5 and all dates between and including D7 and D14. Multiple discrete ranges may also be provided by using multiple date parameters in a single GET request.
+#  * If no date is specified, Yesterday's date is assumed. "Current" is always yesterday's data. "Live" daily data is not yet available.
+#  * An individual date starts at 12am CDT (GMT -5) and ends 12am CDT the next day. Custom timezone support is not yet available.
 class AwarenessApi
   ROOT_API_URL = 'http://api.feedburner.com/awareness/1.0/'
   
+  # Get Basic Feed Awareness Data
+  #
+  # options:
+  #  * uri: The URI of the feed (same as http://feeds.feedburner.com/<feeduri>) Must be used if id is not specified
+  #  * id: The FeedBurner id of the feed (visible when editing a feed in your account, e.g., http://www.feedburner.com/fb/a/optimize?id=<id>). May be used instead if uri is not specified.
+  #  * dates: Dates are used to specify the period for which data is need (see note on dates above)
   def get_feed_data(options)
     option_string = parse_options(options)
     
@@ -14,6 +30,13 @@ class AwarenessApi
     return parse_xml(response_xml)
   end
   
+  # Get Individual Item Awareness Data (TotalStats pro)
+  #
+  # options:
+  #  * uri: The URI of the feed (same as http://feeds.feedburner.com/<feeduri>) Must be used if id is not specified
+  #  * id: The FeedBurner id of the feed (visible when editing a feed in your account, e.g., http://www.feedburner.com/fb/a/optimize?id=<id>). May be used instead if uri is not specified.
+  #  * itemurl: The source URL of item (not the FeedBurner generated URL, but the original source URL). Multiple itemurl parameters may be provided in a single request in order to retrieve additional items.
+  #  * dates: Dates are used to specify the period for which data is need (see note on dates above)
   def get_item_data(options)
     option_string = parse_options(options)
     
@@ -21,13 +44,19 @@ class AwarenessApi
     return parse_xml(response_xml)
   end
   
-  # add GetResyndicationData
-  # def get_resyndication_data(options)
-  #   option_string = parse_options(options)
-  #   
-  #   response_xml = open("#{ROOT_API_URL}GetResyndicationData?#{option_string}").read
-  #   return parse_xml(response_xml)
-  # end
+  # Get Resyndication Feed Awareness Data (TotalStats pro)
+  #
+  # options:
+  #  * uri: The URI of the feed (same as http://feeds.feedburner.com/<feeduri>)
+  #  * id: The FeedBurner id of the feed (visible when editing a feed in your account, e.g., http://www.feedburner.com/fb/a/optimize?id=<id>). May be used instead if uri is not specified.
+  #  * itemurl: The source URL of item (not the FeedBurner generated URL, but the original source URL). Multiple itemurl parameters may be provided in a single request in order to retrieve additional items.
+  #  * dates: Dates are used to specify the period for which data is need (see note on dates above)
+  def get_resyndication_data(options)
+    option_string = parse_options(options)
+    
+    response_xml = open("#{ROOT_API_URL}GetResyndicationData?#{option_string}").read
+    return parse_xml(response_xml)
+  end
   
   private
   def parse_options(options)
@@ -76,6 +105,16 @@ class AwarenessApi
             item.clickthroughs = item_node.attributes['clickthroughs']
             
             entry.items << item
+            
+            for referer_node in item_node.elements
+              referer = Referer.new
+              
+              referer.url = referer_node.attributes['url']
+              referer.itemviews = referer_node.attributes['itemviews']
+              referer.clickthroughs = referer_node.attributes['clickthroughs']
+              
+              item.referers << referer
+            end
           end
         end
       end
@@ -89,4 +128,5 @@ end
 # opts = {:uri => 'CommonThread', :dates => '2007-03-20,2007-03-23'}
 # 
 # puts rawapi.get_feed_data(opts)
-# puts rawapi.get_item_data(opts)
+# puts rawapi.get_item_data(opts)
+# puts rawapi.get_resyndication_data(opts)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: rawapi
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-03-25 00:00:00 -05:00
+  version: 0.1.2
+date: 2007-03-26 00:00:00 -05:00
 summary: Ruby interface to the FeedBurner Awareness API.
 require_paths: 
 - lib
@@ -35,6 +35,11 @@ files:
 - README.txt
 - Rakefile
 - lib/rawapi.rb
+- lib/rawapi/entry.rb
+- lib/rawapi/feed.rb
+- lib/rawapi/item.rb
+- lib/rawapi/response.rb
+- lib/rawapi/referer.rb
 - lib/rawapi/version.rb
 - setup.rb
 - test/test_helper.rb