rss_detector 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 yukihir0
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# RssDetector
+
+'rss_detector' provides feature for feed detection from html document.
+
+## Install
+
+```
+gem install 'rss_detector'
+```
+
+or
+
+```
+gem 'rss_detector'
+```
+
+in your Gemfile.
+
+## How to use
+
+```
+feed = RSSDetector::detect(html)
+```
+
+For more information, please see [here](https://github.com/yukihir0/rss_detector/blob/master/sample/sample.rb)
+
+## License
+
+Copyright © 2013 yukihir0

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+Bundler.setup
+require 'rspec/core/rake_task'
+ 
+desc "run spec"
+RSpec::Core::RakeTask.new(:spec) do |t|
+      t.rspec_opts = ["-c", "-fs"]
+end

data/lib/rss_detector.rb

@@ -0,0 +1,41 @@
+require "rss_detector/version"
+require 'nokogiri'
+
+class RSSDetector 
+    # xpath for feed
+    RSS_XPATH  = '//link[@rel="alternate"][@type="application/rss+xml"]'
+    ATOM_XPATH = '//link[@rel="alternate"][@type="application/atom+xml"]'
+    
+    public
+    def RSSDetector::detect(doc)
+
+        # create html from string
+        html = Nokogiri::HTML(doc)
+
+        # detect rss and atom
+        @rss_feeds  = detectFeed(html, RSS_XPATH)
+        @atom_feeds = detectFeed(html, ATOM_XPATH)
+
+        return @rss_feeds + @atom_feeds
+    end
+
+    private
+    def RSSDetector::detectFeed(html, feed_xpath)
+        
+        # feed list
+        @feeds = Array.new
+
+        # discover feed
+        html.xpath(feed_xpath).each do |link|
+
+            # get feed title and url
+            @feed_title = link.attribute("title")
+            @feed_url   = link.attribute("href")
+
+            # push hash to array
+            @feeds << {title: @feed_title, url: @feed_url}
+        end
+
+        return @feeds
+    end
+end  

data/lib/rss_detector/version.rb

@@ -0,0 +1,3 @@
+module RssDetector
+  VERSION = "0.0.2"
+end

data/rss_detector.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rss_detector/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rss_detector"
+  gem.version       = RssDetector::VERSION
+  gem.authors       = ["yukihir0"]
+  gem.email         = ["yukihiro.cotori@gmail.com"]
+  gem.description   = %q{'rss_detector' provides feature for feed detection from html document.}
+  gem.summary       = %q{'rss_detector' provides feature for feed detection from html document.}
+  gem.homepage      = "https://github.com/yukihir0/rss_detector"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "nokogiri", "~>1.5"
+  gem.add_development_dependency "rspec"
+end

data/sample/sample.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+require 'rubygems'
+require 'open-uri'
+require 'rss_detector'
+
+def get_html(url)
+    html = nil
+
+    begin
+        html = open(url).read
+    rescue OpenURI::HTTPError => ex
+        if ex.io.status[0] == '304'
+            warn ex.message
+        else
+            raise ex
+        end
+    end
+
+    return html
+end
+
+def print_feed(url, feeds)
+    header = "---------- #{url} ----------"
+    footer = '-' * header.length + "\n\n"
+
+    puts header
+    feeds.each { |feed| puts "#{feed[:title]} : #{feed[:url]}" }
+    puts footer
+end
+
+
+# main
+url  = 'http://d.hatena.ne.jp/yukihir0/'
+html = get_html(url)
+feed = RSSDetector::detect(html)
+print_feed(url, feed)

data/spec/rss_detector_spec.rb

@@ -0,0 +1,118 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe RSSDetector do
+    context "init" do
+        describe "#detect" do
+            context "nil input" do
+                it "should be no feed" do
+                    @feeds = RSSDetector::detect(nil)
+                    @feeds.size.should == 0
+                end
+            end
+
+            context "null string input" do
+                it "should be no feed" do
+                    @feeds = RSSDetector::detect("")
+                    @feeds.size.should == 0
+                end
+            end
+
+            context "no contain feed input" do
+                it "should be no feed" do
+                    input = <<-EOS
+                        <html><head>
+                        </head></html>
+                    EOS
+
+                    @feeds = RSSDetector::detect(input)
+                    @feeds.size.should == 0
+                end
+            end
+
+            context "contain 1 rss feed input" do
+                it "should be 1 rss feed" do
+                    input = <<-EOS
+                        <html><head>
+                            <link rel="alternate" type="application/rss+xml" title="test_rss_feed_title" href="http://test_rss_feed_url/"/>
+                        </head></html>
+                    EOS
+
+                    @feeds = RSSDetector::detect(input)
+                    @feeds.length.should == 1
+                    @feeds[0][:title].to_s.should == "test_rss_feed_title"
+                    @feeds[0][:url].to_s.should == "http://test_rss_feed_url/"
+                end
+            end
+
+            context "contain 2 rss feed input" do
+                it "should be 2 rss feed" do
+                    input = <<-EOS
+                        <html><head>
+                            <link rel="alternate" type="application/rss+xml" title="test_rss_feed_title_1" href="http://test_rss_feed_url_1/"/>
+                            <link rel="alternate" type="application/rss+xml" title="test_rss_feed_title_2" href="http://test_rss_feed_url_2/"/>
+                        </head></html>
+                    EOS
+
+                    @feeds = RSSDetector::detect(input)
+                    @feeds.length.should == 2 
+                    @feeds[0][:title].to_s.should == "test_rss_feed_title_1"
+                    @feeds[0][:url].to_s.should == "http://test_rss_feed_url_1/"
+                    @feeds[1][:title].to_s.should == "test_rss_feed_title_2"
+                    @feeds[1][:url].to_s.should == "http://test_rss_feed_url_2/"
+                end
+            end
+
+            context "contain 1 atom feed input" do
+                it "should be 1 atom feed" do
+                    input = <<-EOS
+                        <html><head>
+                            <link rel="alternate" type="application/atom+xml" title="test_atom_feed_title" href="http://test_atom_feed_url/"/>
+                        </head></html>
+                    EOS
+
+                    @feeds = RSSDetector::detect(input)
+                    @feeds.length.should == 1
+                    @feeds[0][:title].to_s.should == "test_atom_feed_title"
+                    @feeds[0][:url].to_s.should == "http://test_atom_feed_url/"
+                end
+            end
+
+            context "contain 2 atom feed input" do
+                it "should be 2 atom feed" do
+                    input = <<-EOS
+                        <html><head>
+                            <link rel="alternate" type="application/atom+xml" title="test_atom_feed_title_1" href="http://test_atom_feed_url_1/"/>
+                            <link rel="alternate" type="application/atom+xml" title="test_atom_feed_title_2" href="http://test_atom_feed_url_2/"/>
+                        </head></html>
+                    EOS
+
+                    @feeds = RSSDetector::detect(input)
+                    @feeds.length.should == 2 
+                    @feeds[0][:title].to_s.should == "test_atom_feed_title_1"
+                    @feeds[0][:url].to_s.should == "http://test_atom_feed_url_1/"
+                    @feeds[1][:title].to_s.should == "test_atom_feed_title_2"
+                    @feeds[1][:url].to_s.should == "http://test_atom_feed_url_2/"
+                end
+            end
+        
+            context "contain rss and atom feed input" do
+                it "should be rss and atom feed" do
+                     input = <<-EOS
+                        <html><head>
+                            <link rel="alternate" type="application/rss+xml" title="test_rss_feed_title" href="http://test_rss_feed_url/"/>
+                            <link rel="alternate" type="application/atom+xml" title="test_atom_feed_title" href="http://test_atom_feed_url/"/>
+                        </head></html>
+                    EOS
+
+                    @feeds = RSSDetector::detect(input)
+                    @feeds.length.should == 2 
+                    @feeds[0][:title].to_s.should == "test_rss_feed_title"
+                    @feeds[0][:url].to_s.should == "http://test_rss_feed_url/"
+                    @feeds[1][:title].to_s.should == "test_atom_feed_title"
+                    @feeds[1][:url].to_s.should == "http://test_atom_feed_url/"
+                end
+            end
+        end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# coding: utf-8
+require 'rubygems'
+require 'rss_detector'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rss_detector
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- yukihir0
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '''rss_detector'' provides feature for feed detection from html document.'
+email:
+- yukihiro.cotori@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rss_detector.rb
+- lib/rss_detector/version.rb
+- rss_detector.gemspec
+- sample/sample.rb
+- spec/rss_detector_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yukihir0/rss_detector
+licenses: []
+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: -2779202382641332666
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2779202382641332666
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! '''rss_detector'' provides feature for feed detection from html document.'
+test_files:
+- spec/rss_detector_spec.rb
+- spec/spec_helper.rb