rawapi 0.1.2 → 0.2.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+* 0.2.1
+* 0.1.2
+* 0.1.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008 CommonThread, LLC
+
+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

@@ -0,0 +1,28 @@
+AwAPI docs at http://code.google.com/apis/feedburner/awareness_api.html
+
+== This Library
+
+The Ruby Awareness API (rAwAPI) provides a ruby interface to the FeedBurner Awareness API (AwAPI)
+
+== What is “Awareness?”
+
+Feed Awareness describes the extent and frequency with which a publisher's feed and its content items are consumed, clicked on, and referred to by independent sources (i.e., "syndicated").
+
+The following data characterizes Feed Awareness:
+
+    * Feed Circulation and Hits: Circulation is a daily measure of feed readership and popularity, recorded over the life of your feed. Hits are a raw measure of request traffic for your feed.
+    * Detailed Item Popularity: The popularity of each item published as determined by itemviews and clickthroughs.
+    * Item Syndication: Redisplay or repurposing of a feed's content on a third party website that generates traffic (as itemviews and clickthroughs).
+
+The reports and charts you see when using The FeedBurner website are based on the same data. Using AwAPI, you can create your own analysis and tracking applications. It's your data. Display it your way!
+
+
+== Example
+
+require 'awareness_api'
+
+opts = {:uri => 'CommonThread'}
+
+puts AwarenessApi.get_feed_data(opts)
+puts AwarenessApi.get_item_data(opts)
+puts AwarenessApi.get_resyndication_data(opts)

data/demo.rb

@@ -0,0 +1,7 @@
+require 'lib/awareness_api'
+
+opts = {:uri => 'CommonThread'}
+
+puts AwarenessApi.get_feed_data(opts)
+puts AwarenessApi.get_item_data(opts)
+puts AwarenessApi.get_resyndication_data(opts)

data/lib/awareness_api/entry.rb

@@ -0,0 +1,9 @@
+module AwarenessApi
+  class Entry
+    include AwarenessApi::FeedAttributes
+
+    def initialize
+      @items = []
+    end
+  end
+end

data/lib/awareness_api/feed.rb

@@ -0,0 +1,11 @@
+module AwarenessApi
+  class Feed
+    include AwarenessApi::FeedAttributes
+
+    attr_accessor :id
+
+    def initialize
+      @entries = []
+    end
+  end
+end

data/lib/awareness_api/item.rb

@@ -0,0 +1,9 @@
+module AwarenessApi
+  class Item
+    include AwarenessApi::FeedAttributes
+
+    def initialize
+      @referers = []
+    end
+  end
+end

data/lib/awareness_api/referer.rb

@@ -0,0 +1,5 @@
+module AwarenessApi
+  class Referer
+    include AwarenessApi::FeedAttributes
+  end
+end

data/lib/awareness_api/response.rb

@@ -0,0 +1,43 @@
+# The Response object is the ruby object version of the webservice response.
+module AwarenessApi
+  class Response
+    attr_accessor :status, :code, :message, :feeds
+
+    def initialize
+      @feeds = []
+    end
+
+    def to_s
+      output = []
+      output << "Status: #{@status}"
+      output << "Code: #{@code}" if @code
+      output << "Message: #{@message}" if @message
+      for feed in @feeds
+        output << "-Feed"
+        feed.attributes.each do |key,val|
+          output << "  #{key}: #{val}"
+        end
+        for entry in feed.entries
+          output << "  -Entry"
+          entry.attributes.each do |key,val|
+            output << "    #{key}: #{val}"
+          end
+          for item in entry.items
+            output << "    -Item"
+            item.attributes.each do |key,val|
+              output << "      #{key}: #{val}"
+            end
+            for referer in item.referers
+              output << "      -Referer"
+              referer.attributes.each do |key,val|
+                output << "        #{key}: #{val}"
+              end
+            end
+          end
+        end
+      end
+
+      return output.join("\n")
+    end
+  end
+end

data/lib/awareness_api.rb

@@ -0,0 +1,160 @@
+require 'open-uri'
+require 'rexml/document'
+include REXML
+
+# 
+# The Ruby Awareness API (rAwAPI) provides a ruby interface to the FeedBurner Awareness API (AwAPI)
+# 
+# AwAPI docs at http://code.google.com/apis/feedburner/awareness_api.html
+# 
+# In rAwAPI calls, date ranges may be expressed as follows:
+# 
+#   * 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.
+# 
+module AwarenessApi
+  ROOT_API_URL = 'http://api.feedburner.com/awareness/1.0/'
+  
+  # 
+  # Current Basic Feed Awareness Data
+  # 
+  # Arguments
+  #   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)
+  # 
+  def self.get_feed_data(options)
+    raise "options must include a feed id or uri" unless options[:id] or options[:uri]
+    option_string = parse_options(options)
+
+    response_xml = open("#{ROOT_API_URL}GetFeedData?#{option_string}").read
+    return parse_xml(response_xml)
+  end
+
+  # 
+  # Current Item Awareness Data
+  # 
+  # Arguments
+  #   uri       The URI of the feed (same as http://feeds.feedburner.com/<feeduri>)
+  #   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)
+  # 
+  def self.get_item_data(options)
+    raise "options must include a feed uri" unless options[:uri]
+    option_string = parse_options(options)
+
+    response_xml = open("#{ROOT_API_URL}GetItemData?#{option_string}").read
+    return parse_xml(response_xml)
+  end
+
+  # 
+  # Current Item Resyndication Feed Awareness Data
+  # 
+  # Arguments
+  #   uri       The URI of the feed (same as http://feeds.feedburner.com/<feeduri>)
+  #   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)
+  #
+  def self.get_resyndication_data(options)
+    raise "options must include a feed uri" unless options[:uri]
+    option_string = parse_options(options)
+
+    response_xml = open("#{ROOT_API_URL}GetResyndicationData?#{option_string}").read
+    return parse_xml(response_xml)
+  end
+
+  private
+  def self.parse_options(options)
+    options[:uri] = nil if options[:id] and options[:uri]
+
+    return options.collect {|key, value| "#{key}=#{value}" unless value.nil?}.compact.join('&')
+  end
+
+  def self.parse_xml(response_xml)
+    response = Response.new
+
+    xml = Document.new(response_xml)
+    rsp_node = xml.root
+
+    response.status = rsp_node.attributes['stat']
+
+    if response.status == 'fail'
+      response.code = rsp_node.elements[1].attributes['code']
+      response.message = rsp_node.elements[1].attributes['msg']
+    elsif response.status == 'ok'
+      for feed_node in rsp_node.elements
+        feed = Feed.new
+
+        feed_node.attributes.each do |key,value|
+          feed.send(key+"=", value)
+        end
+
+        response.feeds << feed
+
+        for entry_node in feed_node.elements
+          entry = Entry.new
+
+          entry_node.attributes.each do |key,value|
+            entry.send(key+"=", value)
+          end
+
+          feed.entries << entry
+
+          for item_node in entry_node.elements
+            item = Item.new
+
+            item_node.attributes.each do |key,value|
+              item.send(key+"=", value)
+            end
+
+            entry.items << item
+            
+            for referer_node in item_node.elements
+              referer = Referer.new
+
+              referer_node.attributes.each do |key,value|
+                referer.send(key+"=", value)
+              end
+
+              item.referers << referer
+            end
+          end
+        end
+      end
+    end
+
+    return response
+  end
+  
+  # 
+  # Adds the dynamic attributes to each feed class
+  # 
+  module FeedAttributes
+    def attributes
+      attribute_hash = {}
+
+      self.instance_variables.each do |var|
+        var_symbol = var[1..-1].to_sym
+        attribute_hash[var_symbol] = self.send(var_symbol) unless self.send(var_symbol).is_a?(Array)
+      end
+
+      attribute_hash
+    end
+
+    def method_missing(method, *params, &block)
+      method = method.to_s
+      if method =~ /=/
+        self.instance_variable_set("@#{method[0..-2]}", params[0])
+      else
+        self.instance_variable_get("@#{method}")
+      end
+    end
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__), 'awareness_api/**/*.rb')].sort.each { |lib| require lib }

metadata

@@ -1,60 +1,64 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: rawapi
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2007-03-26 00:00:00 -05:00
-summary: Ruby interface to the FeedBurner Awareness API.
-require_paths: 
-- lib
-email: ben@commonthread.com
-homepage: http://rawapi.rubyforge.org
-rubyforge_project: rawapi
-description: Ruby interface to the FeedBurner Awareness API.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.2.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Ben Wyrosdick
-files: 
-- CHANGELOG.txt
-- History.txt
-- Manifest.txt
-- 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
-- test/test_rawapi.rb
-test_files: []
-
-rdoc_options: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
-extra_rdoc_files: []
+date: 2008-03-05 00:00:00 -06:00
+default_executable: 
+dependencies: []
 
+description: The Ruby Awareness API (rAwAPI) provides a ruby interface to the FeedBurner Awareness API (AwAPI)
+email: ben@commonthread.com
 executables: []
 
 extensions: []
 
+extra_rdoc_files: []
+
+files: 
+- README
+- CHANGELOG
+- LICENSE
+- demo.rb
+- lib/awareness_api.rb
+- lib/awareness_api/entry.rb
+- lib/awareness_api/feed.rb
+- lib/awareness_api/item.rb
+- lib/awareness_api/referer.rb
+- lib/awareness_api/response.rb
+- test/test_helper.rb
+- test/test_rawapi.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/rawapi/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: rawapi
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: The Ruby Awareness API (rAwAPI) provides a ruby interface to the FeedBurner Awareness API (AwAPI)
+test_files: []
 

data/Manifest.txt

@@ -1,16 +0,0 @@
-CHANGELOG.txt
-History.txt
-Manifest.txt
-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
-test/test_rawapi.rb

data/README.txt

@@ -1,3 +0,0 @@
-README for rawapi
-=================
-

data/Rakefile

@@ -1,54 +0,0 @@
-require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/contrib/rubyforgepublisher'
-require 'fileutils'
-require 'hoe'
-include FileUtils
-require File.join(File.dirname(__FILE__), 'lib', 'rawapi', 'version')
-
-AUTHOR = "Ben Wyrosdick"  # can also be an array of Authors
-EMAIL = "ben@commonthread.com"
-DESCRIPTION = "Ruby interface to the FeedBurner Awareness API."
-GEM_NAME = "rawapi" # what ppl will type to install your gem
-RUBYFORGE_PROJECT = "rawapi" # The unix name for your project
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-
-
-NAME = "rawapi"
-REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
-VERS = ENV['VERSION'] || (Rawapi::VERSION::STRING + (REV ? ".#{REV}" : ""))
-                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
-RDOC_OPTS = ['--quiet', '--title', "rawapi documentation",
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
-
-class Hoe
-  def extra_deps 
-    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
-  end 
-end
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-hoe = Hoe.new(GEM_NAME, VERS) do |p|
-  p.author = AUTHOR 
-  p.description = DESCRIPTION
-  p.email = EMAIL
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/*_test.rb"]
-  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
-  
-  # == Optional
-  #p.changes        - A description of the release's latest changes.
-  #p.extra_deps     - An array of rubygem dependencies.
-  #p.spec_extras    - A hash of extra values to set in the gemspec.
-end

data/lib/rawapi/entry.rb

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

data/lib/rawapi/feed.rb

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

data/lib/rawapi/item.rb

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

data/lib/rawapi/referer.rb

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

data/lib/rawapi/response.rb

@@ -1,42 +0,0 @@
-# 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

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