feed_cache 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in feed_cache.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/feed_cache.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "feed_cache/version"
+
+Gem::Specification.new do |s|
+  s.name        = "feed_cache"
+  s.version     = FeedCache::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brendon Murphy"]
+  s.email       = ["xternal1+github@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A thin wrapper over Feedzirra with injected caching}
+  s.description = s.summary
+
+  s.add_dependency "feedzirra", "~> 0.0.23"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "activesupport", "~> 2.3.5"
+
+  s.rubyforge_project = "feed_cache"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/feed_cache/fetcher.rb

@@ -0,0 +1,40 @@
+require 'forwardable'
+require 'feedzirra'
+
+module FeedCache
+  class Fetcher
+    extend Forwardable
+
+    attr_reader :url, :options
+
+    def_delegators :@fz_feed, :title, :last_modified, :entries
+
+    def cache
+      FeedCache.cache
+    end
+
+    def initialize(url, options = {})
+      raise "cache must be set with FeedCache.cache=" unless cache
+      @url = url
+      @options = { :expires_in => FeedCache.default_expires_in }.merge options
+    end
+
+    def fetch
+      @fz_feed = cache.fetch(cache_key, options) do
+        Feedzirra::Feed.fetch_and_parse(url)
+      end
+    end
+
+    def valid_feed?
+      # Feedzirra returns fixnums in error conditions, so we
+      # need to type check.
+      @fz_feed && ! @fz_feed.is_a?(Fixnum)
+    end
+
+    private
+
+    def cache_key
+      url
+    end
+  end
+end

data/lib/feed_cache/version.rb

@@ -0,0 +1,3 @@
+module FeedCache
+  VERSION = "0.0.1"
+end

data/lib/feed_cache.rb

@@ -0,0 +1,37 @@
+module FeedCache
+  DEFAULT_ENTRIES_LIMIT = 10
+  DEFAULT_EXPIRES_IN = 900
+
+  class << self
+    attr_accessor :cache
+    attr_writer :default_entries_limit, :default_expires_in
+
+    def default_entries_limit
+      @default_entries_limit || DEFAULT_ENTRIES_LIMIT
+    end
+
+    def default_expires_in
+      @default_expires_in || DEFAULT_EXPIRES_IN
+    end
+
+    def configure(&block)
+      yield self
+    end
+    alias_method :config, :configure
+  end
+
+  def self.fetch(url, options = {})
+    feed = FeedCache::Fetcher.new(url, options)
+    feed.fetch
+    feed.valid_feed? ? feed : nil
+  end
+
+  def self.entries_for(url, options = {})
+    limit = options.delete(:limit) || default_entries_limit
+    feed = fetch(url, options)
+    (feed ? feed.entries : []).take(limit)
+  end
+end
+
+require File.expand_path("feed_cache/fetcher", File.dirname(__FILE__))
+require File.expand_path("feed_cache/version", File.dirname(__FILE__))

data/spec/feed_cache_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'active_support'
+
+# Examples are unforunately coupled to FeedZirra for now because it uses curb which is tough
+# to mock, and the state of other feed parsers isn't compliant with our gemset
+
+describe FeedCache do
+  let(:blog_url) { "http://blog.kajabi.com/rss.xml" }
+  let(:blog_feed) { YAML.load_file(File.join File.dirname(__FILE__), "./fixtures/blog_feed.yaml") }
+  let(:cache) { ActiveSupport::Cache::MemoryStore.new }
+
+  before do
+    Feedzirra::Feed.stub(:fetch_and_parse).with(blog_url).and_return(blog_feed)
+    FeedCache.configure do |fc|
+      fc.cache = cache
+    end
+  end
+
+  describe "fetching a feed" do
+    context "for a valid feed grab" do
+      it "returns the feed with entries" do
+        feed = FeedCache.fetch(blog_url)
+        feed.entries.length.should == 20
+      end
+
+      it "stores the feed lookup in the cache" do
+        cache.exist?(blog_url).should be_false
+        FeedCache.fetch(blog_url)
+        cache.exist?(blog_url).should be_true
+      end
+    end
+
+    context "for an invalid feed grab" do
+      it "returns nil" do
+        Feedzirra::Feed.stub(:fetch_and_parse).with(blog_url).and_return(404)
+        FeedCache.fetch(blog_url).should be_nil
+      end
+    end
+  end
+
+  describe "getting just the entries for a feed" do
+    context "for a valid feed grab" do
+      it "returns the entries array" do
+        FeedCache.entries_for(blog_url).length.should == 10
+      end
+
+      it "takes a limit option to trucate entries" do
+        FeedCache.entries_for(blog_url, :limit => 3).length.should == 3
+      end
+
+      it "respects the default entries limit setting" do
+        FeedCache.default_entries_limit = 7
+        FeedCache.entries_for(blog_url).length.should == 7
+      end
+    end
+
+    context "for an invalid feed grab" do
+      it "returns an empty array" do
+        Feedzirra::Feed.stub(:fetch_and_parse).with(blog_url).and_return(404)
+        FeedCache.entries_for(blog_url).should == []
+      end
+    end
+  end
+end