collin-google_ajax_feed_api 0.0.1

data/README

@@ -0,0 +1,50 @@
+I wanted to do feeds through googles Ajax Feed API.
+
+http://code.google.com/apis/ajaxfeeds/documentation/reference.html
+
+I did.
+
+Use if you see fit.
+
+Run the specs if you have autotest.
+
+Use it?
+
+>> require 'lib/feed'
+=> true
+>> feed = Google::Ajax::Feed.lookup "olympichifi.com"
+=> #<Google::Ajax::Feed:0xb77b660c @url="http://olympichifi.com/feed/">
+>> feed.title
+=> "Olympic Hi-Fi"
+>> feed.link
+=> "http://olympichifi.com"
+>> feed.canonical_id
+=> "http://olympichifi.com/feed/"
+>> post = feed.entries.first
+=> <#Google::Ajax::Feed::Entry link=http://olympichifi.com/2008/10/12/leetle-groove/ title=leetle groove>
+>> post.content
+=> "<p>\nmy first song evarr! it\342\200\231s cheesy, but still, its my first.</p>"
+
+>> feed = Google::Ajax::Feed.lookup "ajaxian.com"
+=> #<Google::Ajax::Feed:0xb75b3a08 @url="http://ajaxian.com/index.xml">
+>> feed.load :limit => 100
+=> 6
+>> feed.entries.size
+=> 20
+
+>> feed = Google::Ajax::Feed.lookup "ajaxian.com"
+=> #<Google::Ajax::Feed:0xb79d82c8 @url="http://ajaxian.com/index.xml">
+>> feed.load :limit => 100, :history => true
+=> 6
+>> feed.entries.size
+=> 100
+
+>> Google::Ajax::Feed.config.limit = 50
+=> 50
+>> Google::Ajax::Feed.config.history = true
+=> true
+>> feed = Google::Ajax::Feed.lookup "ajaxian.com"
+=> #<Google::Ajax::Feed:0xb756ecc8 @url="http://ajaxian.com/index.xml">
+>> feed.entries.size
+=> 50
+

data/Rakefile.rb

@@ -0,0 +1,68 @@
+require 'rubygems'
+require 'pathname'
+require 'spec'
+
+__DIR__ = Pathname.new(__FILE__).dirname
+
+task :default => 'spec:all'
+
+namespace :spec do
+  task :prepare do
+    @specs= Dir.glob("#{__DIR__}/spec/**/*.rb").join(' ')
+  end
+
+  task :all => :prepare do
+    system "spec #{@specs}"
+  end
+  
+  task :doc => :prepare do
+    system "spec #{@specs} --format specdoc"
+  end
+end
+
+task :cleanup do 
+  Dir.glob("**/*.*~")+Dir.glob("**/*~").each{|swap|FileUtils.rm(swap, :force => true)}
+end
+
+namespace :gem do
+  task :version do
+    @version = "0.0.2"
+  end
+
+  task :build => :spec do
+    load __DIR__ + "google_ajax_feed_api.gemspec"
+    Gem::Builder.new(@google_ajax_feed_api_gemspec).build
+  end
+
+  task :install => :build do
+    cmd = "gem install google_ajax_feed_api -l"
+    system cmd unless system "sudo #{cmd}"
+    FileUtils.rm(__DIR__ + "google_ajax_feed_api-#{@version}.gem")
+  end
+
+  task :spec => :version do
+    file = File.new(__DIR__ + "google_ajax_feed_api.gemspec", 'w+')
+    FileUtils.chmod 0755, __DIR__ + "google_ajax_feed_api.gemspec"
+    spec = %{
+Gem::Specification.new do |s|
+  s.name             = "google_ajax_feed_api"
+  s.version          = "#{@version}"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.has_rdoc         = true
+  s.summary          = "Light wrapper for Google Ajax Feed API"
+  s.authors          = ["Collin Miller"]
+  s.email            = "collintmiller@gmail.com"
+  s.homepage         = "http://github.com/collin/fold"
+  s.files            = %w{#{(%w(README Rakefile.rb) + Dir.glob("{lib,spec}/**/*")).reject{|path| path.match /~$/ }.join(' ')}}
+  
+  s.add_dependency  "rake"
+  s.add_dependency  "rspec"
+  s.add_dependency  "json"
+  s.add_dependency  "extlib"
+end
+}
+
+  @google_ajax_feed_api_gemspec = eval(spec)
+  file.write(spec)
+  end
+end

data/lib/google_ajax_feed_api.rb

@@ -0,0 +1,221 @@
+require 'rubygems'
+require 'ostruct'
+require 'extlib'
+require 'json'
+require 'open-uri'
+
+module Google #:nodoc:
+  module Ajax #:nodoc:
+    class Feed
+# = Google Ajax Feed Api
+      class Entry        
+        def inspect # :nodoc:
+          "<#Google::Ajax::Feed::Entry link=#{link} title=#{title}>"
+        end 
+        
+        # The permalink for this entry
+        def link
+          @data["link"]
+        end
+        
+        # The title for this entry
+        def title
+          @data["title"]
+        end
+
+        # The content of this entry
+        def content
+          @data["content"]
+        end        
+
+        # A snippet of this entries content
+        def snippet
+          @data["contentSnippet"]
+        end        
+
+        # The author for this specific entry
+        def author
+          @data["author"]
+        end        
+
+        # The publication date for this entry
+        def created_at
+          @data["publishedDate"]
+        end        
+
+        def initialize data #:nodoc:
+          @data = data
+        end
+      end
+    
+      module API #:nodoc:
+        def self.[] version
+          case version
+          when '1.0'
+            OneZero
+          end
+        end
+        
+        class OneZero
+          class << self
+            # The endpoint URI for lookup requests
+            def lookup
+              "http://ajax.googleapis.com/ajax/services/feed/lookup"
+            end
+            
+            # The endpoint URI for search requests
+            def find
+              "http://ajax.googleapis.com/ajax/services/feed/find"
+            end
+            
+            # The endpoint URI for loading feeds
+            def load 
+              "http://ajax.googleapis.com/ajax/services/feed/load"
+            end
+            
+            # Builds a query to lookup a feed for a url
+            def lookup_query url
+              "#{lookup}#{params url}"
+            end
+            
+            
+            # Builds a query to search for feeds
+            # query is a search term
+            def find_query query
+              "#{find}#{params query}"
+            end
+            
+            
+            # Builds a query
+            # options are overrides for Feed#config options
+            def load_query url, options={}
+              "#{load}#{params url}#{load_params options}"
+            end
+            
+            def load_params options={} #:nodoc
+              options = ({
+                :limit => Feed.config.limit,
+                :history => Feed.config.history
+              }).merge(options)
+              
+              params = "&num=#{options[:limit]}"
+              params << '&scoring=h' if options[:history]
+              params        
+            end
+            
+            def params query #:nodoc:
+              "?v=1.0&q=#{URI.encode query}"
+            end
+          end
+        end
+      end
+
+      class << self     
+        # Default values are:
+        # * config.version = '1.0'
+        #
+        # version specifies what version of the feed API to use.
+        # 1.0 is the only version that exists and thusly the only
+        # option supported. DO NOT CHANGE THIS
+        #
+        # * config.limit   = 15
+        #
+        # limit specifies how many feed items may be fetched at once
+        # Google specifies a hard limit of 100.
+        # But an individual feed might have it's own, lower limit.
+        #
+        # * config.history = false 
+        # Which is where the history option comes into play.
+        # History pulls from Googls cache of the feed, not from the current
+        # state of the feed. With this option you can fetch up to 100 items
+        # from a feed that shows fewer than 100 at any given time.
+        def config
+          @config ||= OpenStruct.new(
+            :version => '1.0',
+            :limit   => 15,
+            :history => false
+          )
+        end
+        
+        # Lookup will take any of these url formats:
+        # * http://example.com
+        # * http://example.com/
+        # * http://www.example.com/
+        # * www.example.com
+        # * example.com/rss
+        # * etc.
+        #
+        # And the object created will have the same Feed#canonical_id
+        # Use of Feed#new is strongly discouraged
+        def lookup url
+          http_response = JSON.parse open(api.lookup_query(url)).read
+          url = http_response["responseData"]["url"]
+          new url
+        end
+        
+        def api #:nodoc:
+          API[config.version]
+        end
+      end
+    
+      # A canonical identifier for the feed. Feeds found with Feed#lookup
+      # will have the some canonical_id even if the url used to find them
+      # was not 100% the same. (Missing '/' etc.)
+      def canonical_id
+        @url
+      end
+      
+      # true if the lookup returned a positive match for a feed
+      def valid?
+        not @url.nil?
+      end
+
+      # The link of the feed.      
+      def link
+        feed["link"]
+      end
+      
+      # The author of the feed.
+      def author
+        feed["author"]
+      end
+      
+      # The title of the feed.
+      def title
+        feed["title"]
+      end
+      
+      # The description of the feed.
+      def description
+        feed["description"]
+      end
+      
+      # List of Entry objects for this feed.
+      def entries
+        @entries ||= feed["entries"].map do |entry| 
+          Entry.new(entry)
+        end
+      end
+      
+      def load options={} #:nodoc:
+        url = self.class.api.load_query @url, options
+        
+        # Very strange json bug. Bye bye tabs        
+        http_response = JSON.parse open(url).read.gsub("\t", '')
+        
+        @feed = http_response["responseData"]["feed"]
+        
+        return @feed.length
+      end
+    
+      def feed #:nodoc:
+        load if @feed.nil?
+        @feed
+      end
+      
+      def initialize url #:nodoc:
+        @url = url
+      end
+    end
+  end
+end

data/spec/google_ajax_feed_spec.rb

@@ -0,0 +1,160 @@
+require 'lib/google_ajax_feed_api'
+require 'rubygems'
+require 'spec'
+
+GAF = Google::Ajax::Feed
+
+describe Google::Ajax::Feed::Entry do
+  before :each do
+    @feed = GAF.lookup('http://ajaxian.com')
+    @entry = @feed.entries.first
+  end
+  
+  describe "entry" do
+    it "exposes title" do
+      @entry.title.should_not be_nil
+    end
+    
+    it "exposes link" do
+      @entry.link.should_not be_nil
+    end
+    
+    it "exposes author" do
+      @entry.author.should_not be_nil
+    end
+    
+    it "exposes content" do
+      @entry.content.should_not be_nil
+    end
+    
+    it "exposes snippet" do
+      @entry.snippet.should_not be_nil
+    end
+  end
+end
+
+describe Google::Ajax::Feed do
+  it "has V1.0 constants" do
+    GAF::API['1.0'].should_not be_nil
+  end
+  
+  it "has 1.0 lookup endpoint" do
+    GAF::API['1.0'].lookup.
+      should == "http://ajax.googleapis.com/ajax/services/feed/lookup"
+  end
+  
+  it "has 1.0 find endpoint" do
+    GAF::API['1.0'].find.
+      should == "http://ajax.googleapis.com/ajax/services/feed/find"
+  end
+  
+  it "has 1.0 load endpoint" do
+    GAF::API['1.0'].load.
+      should == "http://ajax.googleapis.com/ajax/services/feed/load"
+  end
+  
+  it "constructs 1.0 lookups" do
+    blog_url = "http://someblog.com/?blog=franklins passion"
+    GAF::API['1.0'].lookup_query(blog_url).
+      should == "#{GAF::API['1.0'].lookup}?v=1.0&q=#{URI.encode blog_url}"
+  end
+  
+  it "constructs 1.0 finds" do
+    query = "senior superman's @w3s0me l33t <<>> machine"
+    GAF::API['1.0'].find_query(query).
+      should == "#{GAF::API['1.0'].find}?v=1.0&q=#{URI.encode query}"
+  end
+  
+  it "constructs 1.0 loads" do
+    blog_url = "http://someblog.com/?blog=franklins passion"
+    GAF::API['1.0'].load_query(blog_url).
+      should == 
+      "#{GAF::API['1.0'].load}?v=1.0&q=#{URI.encode blog_url}&num=15"
+  end
+  
+  it "constructs 1.0 loads with options" do
+    blog_url = "http://someblog.com/?blog=franklins passion"
+    GAF::API['1.0'].load_query(blog_url, :limit => 100, :history => true).
+      should == 
+      "#{GAF::API['1.0'].load}?v=1.0&q=#{URI.encode blog_url}&num=100&scoring=h"    
+  end
+  
+  it "constructs 1.0 loads with config options" do
+    blog_url = "http://someblog.com/?blog=franklins passion"
+    GAF.config.history = true
+    GAF::API['1.0'].load_query(blog_url).
+      should == 
+      "#{GAF::API['1.0'].load}?v=1.0&q=#{URI.encode blog_url}&num=15&scoring=h"  
+    GAF.config.history = nil
+  end
+  
+  it "has configuration" do
+    GAF.config.should be_is_a(OpenStruct)
+  end
+  
+  it "has default version" do
+    GAF.config.version.should == '1.0'
+  end
+  
+  it "has default number to load" do
+    GAF.config.limit.should == 15
+  end
+  
+  it "api set from config" do
+    GAF.api.should == GAF::API['1.0']
+  end
+  
+  it "looks up feeds" do
+    GAF.lookup('http://ajaxian.com').should_not be_nil
+  end
+   
+  it "validates feeds" do
+    GAF.new(nil).should_not be_valid
+  end
+   
+  it "loads feed" do
+    f = GAF.lookup('http://ajaxian.com')
+    f.load
+    f.feed.should_not be_nil
+  end
+  
+  describe "feed attributes" do
+    before :each do
+      @feed = GAF.lookup('http://ajaxian.com')   
+    end
+    
+    it "exposes title" do
+      @feed.title.should == "Ajaxian » Front Page"
+    end
+    
+    it  "exposes link" do
+      @feed.link.should == "http://ajaxian.com"
+    end
+    
+    it "exposes author" do
+      @feed.author.should == ""
+    end
+    
+    it "exposes description" do
+      @feed.description.should == "Cleaning up the web with Ajax"
+    end
+    
+    it "exposes entries" do
+      @feed.entries.should be_is_a(Array)
+    end
+  end
+   
+  it "feeds have canonical_id" do
+    a= GAF.lookup('http://ajaxian.com')
+    b= GAF.lookup('http://www.ajaxian.com')
+    c= GAF.lookup('http://ajaxian.com/')
+    d= GAF.lookup('http://www.ajaxian.com/')
+    e= GAF.lookup('http://ajaxian.com/index.xml')
+    
+    a.canonical_id.should_not be_nil
+    a.canonical_id.should == b.canonical_id
+    a.canonical_id.should == c.canonical_id
+    a.canonical_id.should == d.canonical_id
+    a.canonical_id.should == e.canonical_id
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: collin-google_ajax_feed_api
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Collin Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: collintmiller@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile.rb
+- lib/google_ajax_feed_api.rb
+- spec/google_ajax_feed_spec.rb
+has_rdoc: true
+homepage: http://github.com/collin/fold
+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: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Light wrapper for Google Ajax Feed API
+test_files: []
+