rss-feed 0.8.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,24 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "feedzirra"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", ">= 0"
+  gem "guard"
+  gem "guard-rspec"
+  gem "pry"
+end
+
+group :test do
+  gem "mongoid"
+  gem "bson_ext"
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.4)
+      activesupport (= 3.1.4)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.4)
+      multi_json (~> 1.0)
+    bson (1.6.2)
+    bson_ext (1.6.2)
+      bson (~> 1.6.2)
+    builder (3.0.0)
+    coderay (1.0.6)
+    curb (0.7.18)
+    diff-lcs (1.1.3)
+    feedzirra (0.1.3)
+      activesupport (~> 3.1.1)
+      builder (>= 2.1.2)
+      curb (~> 0.7.15)
+      i18n (>= 0.5.0)
+      loofah (~> 1.2.0)
+      nokogiri (>= 1.4.4)
+      rake (>= 0.8.7)
+      rdoc (~> 3.8)
+      sax-machine (~> 0.1.0)
+    ffi (1.0.11)
+    git (1.2.5)
+    guard (1.0.1)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.7.0)
+      guard (>= 0.10.0)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    loofah (1.2.0)
+      nokogiri (>= 1.4.4)
+    method_source (0.7.1)
+    mongo (1.6.2)
+      bson (~> 1.6.2)
+    mongoid (2.4.8)
+      activemodel (~> 3.1)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    multi_json (1.2.0)
+    nokogiri (1.5.2)
+    pry (0.9.8.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    sax-machine (0.1.0)
+      nokogiri (> 0.0.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (2.4.4)
+    thor (0.14.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext
+  bundler (~> 1.0.0)
+  feedzirra
+  guard
+  guard-rspec
+  jeweler (~> 1.8.3)
+  mongoid
+  pry
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov

data/Guardfile

@@ -0,0 +1,5 @@
+# vim:set filetype=ruby:
+guard "rspec", all_after_pass: false, cli: "--fail-fast --tty --format documentation --colour" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |match| "spec/#{match[1]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Sebastien Azimi
+
+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.rdoc

@@ -0,0 +1,70 @@
+= RSS Feed
+
+== Synopsis
+
+Fetch RSS feeds, collect entries using Feedzirra gem and feed your database.
+
+== Installation
+
+  gem install rss-feed
+
+Or put in your +Gemfile+:
+
+  gem "rss-feed"
+
+Then (obviously) type +bundle+ in your favorite command line interface.
+
+You may encounter some issue when installing (I did). Some dependencies must be satisfied. On Ubuntu, the dependencies can be satisfied by installing the following packages:
+
+  sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev
+
+Please visit for extra information: https://github.com/taf2/curb
+
+== Usage
+
+In your model:
+
+  class Article
+    include Mongoid::Document
+    include Rss::Feed
+
+    # Add this line to set which RSS feed this model must subscribe to
+    subscribes_to "https://news.google.fr/news/feeds?output=rss"
+  end
+
+Your model get thus some methods:
+
+  # Get subscribed feed url
+  Article.feed_url # => "https://news.google.fr/news/feeds?output=rss"
+
+  # Get already loaded feed entries
+  Article.feed_entries # => [] # because the feed has not been loaded
+
+  # Load feed from feed_url
+  Article.get_feed
+  Article.feed_entries # => the collection of the feed entries
+
+  # (Re)load and store the feed entries as model documents
+  Article.update_from_feed
+
+== Rake task
+
+A Rake task has been implemented to enable you automatically get new feed entries for every models that have subscribed to an RSS feed (i.e. +Model.subscribes_to+ is present in your involved models). Simply do:
+
+  rake rss:feed:update
+
+== Contributing to RSS Feed
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Sebastien Azimi. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rss-feed"
+  gem.homepage = "http://github.com/suruja/rss-feed"
+  gem.license = "MIT"
+  gem.summary     = %q{Simple RSS feed fetcher providing entry document creation}
+  gem.description = %q{This gem fetches RSS feed and allow new feed entry document creations with rake tasks.}
+  gem.email = "sebstp@gmail.com"
+  gem.authors = ["Sebastien Azimi"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rss-crons #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.2

data/lib/rss-feed.rb

@@ -0,0 +1,42 @@
+require "feedzirra"
+require "rss-feed/railtie" if defined?(Rails)
+
+module Rss
+  module Feed
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def feed_entries
+        @feed ? @feed.entries : []
+      end
+
+      def subscribes_to(feed_url)
+        @feed_url = feed_url
+      end
+
+      def feed_url
+        @feed_url
+      end
+
+      def get_feed
+        Feedzirra::Feed.fetch_and_parse(@feed_url).tap do |feed|
+          @feed = feed != 0 ? feed : nil
+        end
+      end
+
+      def update_from_feed
+        get_feed
+        feed_entries.each do |entry|
+          entry.sanitize!
+          entry_attributes = entry.as_json.inject({}) do |mem, (key, value)|
+            mem[key.to_sym] = value; mem
+          end
+          self.find_or_create_by entry_attributes
+        end
+      end
+    end
+  end
+end

data/lib/rss-feed/railtie.rb

@@ -0,0 +1,12 @@
+require "rss-feed"
+require "rails"
+
+module Rss
+  module Feed
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        require "tasks/rss-feed"
+      end
+    end
+  end
+end

data/lib/tasks/rss-feed.rb

@@ -0,0 +1,14 @@
+namespace :rss do
+  namespace :feed do
+    desc 'get and store new feed entries for the models that subscribed to a RSS feed url.'
+    task :update => :environment do
+      Dir[Rails.root.to_s + '/app/models/**/*.rb'].each { |file| load file }
+      models = ObjectSpace.each_object(::Class).select do |klass|
+        klass.include?(Rss::Feed) and klass.feed_url
+      end
+      models.each do |model|
+        model.update_from_feed
+      end
+    end
+  end
+end

data/rss-feed.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rss-feed"
+  s.version = "0.8.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sebastien Azimi"]
+  s.date = "2012-04-14"
+  s.description = "This gem fetches RSS feed and allow new feed entry document creations with rake tasks."
+  s.email = "sebstp@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rss-feed.rb",
+    "lib/rss-feed/railtie.rb",
+    "lib/tasks/rss-feed.rb",
+    "rss-feed.gemspec",
+    "spec/app/models/newspaper.rb",
+    "spec/rss-feed_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/suruja/rss-feed"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Simple RSS feed fetcher providing entry document creation"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<feedzirra>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<feedzirra>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<feedzirra>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/spec/app/models/newspaper.rb

@@ -0,0 +1,4 @@
+class Newspaper
+  include Mongoid::Document
+  include Rss::Feed
+end

data/spec/rss-feed_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Rss::Feed do
+
+  let(:model) do
+    Newspaper
+  end
+
+  let(:feed_url) do
+    "http://www.feedforall.com/sample.xml"
+  end
+
+  before do
+    model.destroy_all
+  end
+
+  describe ".get_subscribes_to" do
+
+    context "when a valid feed url is provided" do
+      it "gets feed entries from the feed url" do
+        model.subscribes_to feed_url
+        model.get_feed
+        model.feed_entries.should_not be_empty
+      end
+    end
+
+    context "when an invalid or empty feed url is provided" do
+      it "does not get anything" do
+        model.subscribes_to 'invalid_url'
+        model.get_feed
+        model.feed_entries.should be_empty
+      end
+    end
+  end
+
+  describe ".update_from_feed" do
+
+    before do
+      model.subscribes_to feed_url
+      model.get_feed
+    end
+
+    it "inserts as many documents as feed entries first" do
+      model.update_from_feed
+      model.count.should be > 0
+      model.count.should equal model.feed_entries.count
+    end
+
+    it "inserts new documents for each unexistant feed entry then" do
+      model.update_from_feed
+      model.count.should equal model.feed_entries.count
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+MODELS = File.join(File.dirname(__FILE__), "app/models")
+SUPPORT = File.join(File.dirname(__FILE__), "support")
+$LOAD_PATH.unshift(MODELS)
+$LOAD_PATH.unshift(SUPPORT)
+
+require 'rspec'
+require 'mongoid'
+require 'rss-feed'
+
+# These environment variables can be set if wanting to test against a database
+# that is not on the local machine.
+ENV["MONGOID_SPEC_HOST"] ||= "localhost"
+ENV["MONGOID_SPEC_PORT"] ||= "27017"
+
+# These are used when creating any connection in the test suite.
+HOST = ENV["MONGOID_SPEC_HOST"]
+PORT = ENV["MONGOID_SPEC_PORT"]
+
+# Convenience for creating a new logger for debugging.
+LOGGER = Logger.new($stdout)
+
+# When testing locally we use the database named mongoid_test. However when
+# tests are running in parallel on Travis we need to use different database
+# names for each process running since we do not have transactions and want a
+# clean slate before each spec run.
+def database_id
+  ENV["CI"] ? "mongoid_#{Process.pid}" : "mongoid_test"
+end
+
+Mongoid.configure do |config|
+  database = Mongo::Connection.new(HOST, PORT).db(database_id)
+  database.add_user("mongoid", "test")
+  config.master = database
+  config.logger = nil
+end
+
+# Autoload every model for the test suite that sits in spec/app/models.
+Dir[ File.join(MODELS, "*.rb") ].sort.each do |file|
+  name = File.basename(file, ".rb")
+  autoload name.camelize.to_sym, name
+end
+
+# Require everything in spec/support.
+Dir[ File.join(SUPPORT, "*.rb") ].each do |file|
+  require File.basename(file)
+end
+
+module Rails
+  class Application
+  end
+end
+
+module MyApp
+  class Application < Rails::Application
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: rss-feed
+version: !ruby/object:Gem::Version
+  version: 0.8.2
+  prerelease: 
+platform: ruby
+authors:
+- Sebastien Azimi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: feedzirra
+  requirement: &21955520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *21955520
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &21978360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *21978360
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &21977260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *21977260
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &21975960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *21975960
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &21974760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *21974760
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &21974040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21974040
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &21973360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21973360
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &21972100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21972100
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &21971160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21971160
+description: This gem fetches RSS feed and allow new feed entry document creations
+  with rake tasks.
+email: sebstp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rss-feed.rb
+- lib/rss-feed/railtie.rb
+- lib/tasks/rss-feed.rb
+- rss-feed.gemspec
+- spec/app/models/newspaper.rb
+- spec/rss-feed_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/suruja/rss-feed
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3059421967855401890
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Simple RSS feed fetcher providing entry document creation
+test_files: []