feedcellar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c686258435c3f623b6acaf22885f36748c242c75
+  data.tar.gz: 1e6c1e76be9198e7488fbf7129ec680671c25ae2
+SHA512:
+  metadata.gz: 5bb06174c971e2e78b8628c3d40d499fd6850969a16a7349907c932a79e6c7839d7837586a416ed8337b237f0983020b9a3d87f40f508c478f082be6aa5c8d5f
+  data.tar.gz: 086f9636511ead4c620bcb19b99e047e1894f4ca94168d50c5d07feff75b2fcd8dadf9b2de0f7bdfd3f0d6a9d5845dd449396a63aeea7755cc8121f8843e87d1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Masafumi Yokoyama
+
+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/NEWS.md

@@ -0,0 +1,20 @@
+# NEWS
+
+## Feedcellar 0.0.3: 2013-06-02
+
+### Changes
+
+  * Improvements
+    * Support Atom feed.
+    * Add search command.
+
+## Feedcellar 0.0.2: 2013-06-02
+
+### Changes
+
+  * Improvements
+    * Support register a URL.
+
+## Feedcellar 0.0.1: 2013-06-01
+
+Initial release!

data/README.md

@@ -0,0 +1,55 @@
+# Feedcellar - Storage for Feed Reader
+
+A storage for feed reader. Powered by rroonga.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'feedcellar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install feedcellar
+
+## Usage
+
+Show help
+
+    $ feedcellar
+
+Register URL
+
+    $ feedcellar register http://example.net/rss
+
+Import URL from OPML
+
+    $ feedcellar import registers.xml
+
+Show registers
+
+    $ feedcellar list
+
+Collect feeds (It takes several minutes)
+
+    $ feedcellar collect
+
+Word search from titles and descriptions
+
+    $ feedcellar search ruby
+
+Delete database
+
+    $ rm -r ~/.feedcellar
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1,9 @@
+# TODO
+
+## Improvements
+
+  * Manage TAG outline from OPML format.
+
+## Release
+
+  * Release to RubyGems.org

data/bin/feedcellar

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "feedcellar/command"
+
+Feedcellar::Command.start

data/feedcellar.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feedcellar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "feedcellar"
+  spec.version       = Feedcellar::VERSION
+  spec.authors       = ["Masafumi Yokoyama"]
+  spec.email         = ["myokoym@gmail.com"]
+  spec.description   = %q{A storage for feed reader by rroonga.}
+  spec.summary       = %q{Storage for Feed Reader}
+  spec.homepage      = "https://github.com/myokoym/feedcellar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("rroonga")
+  spec.add_runtime_dependency("thor")
+
+  spec.add_development_dependency("test-unit")
+  spec.add_development_dependency("test-unit-notify")
+  spec.add_development_dependency("test-unit-rr")
+  spec.add_development_dependency("bundler", "~> 1.3")
+  spec.add_development_dependency("rake")
+end

data/lib/feedcellar.rb

@@ -0,0 +1,7 @@
+require "feedcellar/version"
+require "feedcellar/groonga_database"
+require "feedcellar/opml"
+require "feedcellar/command"
+
+module Feedcellar
+end

data/lib/feedcellar/command.rb

@@ -0,0 +1,127 @@
+require "thor"
+require "rss"
+require "feedcellar/groonga_database"
+require "feedcellar/opml"
+
+module Feedcellar
+  class Command < Thor
+    def initialize(*args)
+      super
+      @work_dir = File.join(File.expand_path("~"), ".feedcellar")
+    end
+
+    desc "register URL", "Register a URL."
+    def register(url)
+      @database = GroongaDatabase.new
+      @database.open(@work_dir) do |database|
+        begin
+          rss = RSS::Parser.parse(url)
+        rescue RSS::InvalidRSSError
+          rss = RSS::Parser.parse(url, false)
+        rescue
+          $stderr.puts "Warnning: #{$!} (#{url})"
+          return 1
+        end
+
+        unless rss
+          $stderr.puts "Error: Invalid URL"
+          return 1
+        end
+
+        resource = {}
+        resource["xmlUrl"] = url
+        resource["title"] = rss.channel.title
+        resource["htmlUrl"] = rss.channel.link
+        resource["description"] = rss.channel.description
+
+        database.register(rss.channel.title, resource)
+      end
+    end
+
+    desc "import FILE", "Import feed resources by OPML format."
+    def import(opml_xml)
+      @database = GroongaDatabase.new
+      @database.open(@work_dir) do |database|
+        Feedcellar::Opml.parse(opml_xml).each do |resource|
+          database.register(resource["title"], resource)
+        end
+      end
+    end
+
+    desc "list", "Show feed url list."
+    def list
+      @database = GroongaDatabase.new
+      @database.open(@work_dir) do |database|
+        database.resources.each do |record|
+          puts record.title
+          puts "  #{record.xmlUrl}"
+          puts
+        end
+      end
+    end
+
+    desc "collect", "Collect feeds."
+    def collect
+      @database = GroongaDatabase.new
+      @database.open(@work_dir) do |database|
+        resources = database.resources
+
+        resources.each do |record|
+          feed_url = record["xmlUrl"]
+          next unless feed_url
+
+          begin
+            rss = RSS::Parser.parse(feed_url)
+          rescue RSS::InvalidRSSError
+            rss = RSS::Parser.parse(feed_url, false)
+          rescue
+            $stderr.puts "Warnning: #{$!} (#{feed_url})"
+            next
+          end
+          next unless rss
+
+          rss.items.each do |item|
+            if rss.is_a?(RSS::Atom::Feed)
+              title = item.title.content
+              link = item.link.href if item.link
+              description = item.dc_description
+              date = item.dc_date
+            else
+              title = item.title
+              link = item.link
+              description = item.description
+              date = item.date
+            end
+
+            unless link
+              $stderr.puts "Warnning: missing link (#{title})"
+              next
+            end
+
+            database.add(feed_url, title, link, description, date)
+          end
+        end
+      end
+    end
+
+    desc "search WORD", "Search feeds."
+    def search(word)
+      @database = GroongaDatabase.new
+      @database.open(@work_dir) do |database|
+        feeds = @database.feeds
+        resources = @database.resources
+
+        feeds.select {|v| (v.title =~ word) |
+                          (v.description =~ word) }.each do |record|
+          feed_resources = resources.select {|v| v.xmlUrl =~ record.resource }
+          next unless feed_resources
+          puts feed_resources.first.title
+          puts "  #{record.title}"
+          puts "    #{record.date}"
+          puts "      #{record.link}"
+          puts
+        end
+      end
+    end
+  end
+end

data/lib/feedcellar/groonga_database.rb

@@ -0,0 +1,97 @@
+require "groonga"
+
+module Feedcellar
+  class GroongaDatabase
+    def initialize
+      @database = nil
+    end
+
+    def open(base_path, encoding=:utf8)
+      reset_context(encoding)
+      path = File.join(base_path, "feedcellar.db")
+      if File.exist?(path)
+        @database = Groonga::Database.open(path)
+        populate_schema
+      else
+        FileUtils.mkdir_p(base_path)
+        populate(path)
+      end
+      if block_given?
+        begin
+          yield(self)
+        ensure
+          close unless closed?
+        end
+      end
+    end
+
+    def register(key, attributes)
+      feeds = Groonga["Resources"]
+      feeds.add(key, attributes)
+    end
+
+    def add(resource, title, link, description, date)
+      feeds = Groonga["Feeds"]
+      feeds.add(link, :resource    => resource,
+                      :title       => title,
+                      :link        => link,
+                      :description => description,
+                      :date        => date)
+    end
+
+    def close
+      @database.close
+      @database = nil
+    end
+
+    def closed?
+      @database.nil? or @database.closed?
+    end
+
+    def resources
+      @resources ||= Groonga["Resources"]
+    end
+
+    def feeds
+      @feeds ||= Groonga["Feeds"]
+    end
+
+    private
+    def reset_context(encoding)
+      Groonga::Context.default_options = {:encoding => encoding}
+      Groonga::Context.default = nil
+    end
+
+    def populate(path)
+      @database = Groonga::Database.create(:path => path)
+      populate_schema
+    end
+
+    def populate_schema
+      Groonga::Schema.define do |schema|
+        schema.create_table("Resources", :type => :hash) do |table|
+          table.text("text")
+          table.text("isComment")
+          table.text("isBreakpoint")
+          table.text("created")
+          table.text("category")
+          table.text("description")
+          table.text("url")
+          table.text("htmlUrl")
+          table.text("xmlUrl")
+          table.text("title")
+          table.text("version")
+          table.text("language")
+        end
+
+        schema.create_table("Feeds", :type => :hash) do |table|
+          table.text("resource")
+          table.text("title")
+          table.text("link")
+          table.text("description")
+          table.time("date")
+        end
+      end
+    end
+  end
+end

data/lib/feedcellar/opml.rb

@@ -0,0 +1,35 @@
+require "rexml/document"
+
+module Feedcellar
+  class Opml
+    OUTLINE_ATTRIBUTES = [
+      "text",
+      "isComment",
+      "isBreakpoint",
+      "created",
+      "category",
+      "description",
+      "url",
+      "htmlUrl",
+      "xmlUrl",
+      "title",
+      "version",
+      "language",
+    ]
+
+    def self.parse(file)
+      # FIXME improve valiable names
+      # FIXME outline for tags
+      outlines = []
+      doc = REXML::Document.new(File.open(file))
+      REXML::XPath.each(doc, "//outline") do |outline|
+        attributes = {}
+        OUTLINE_ATTRIBUTES.each do |attribute|
+          attributes[attribute] = outline.attributes[attribute]
+        end
+        outlines << attributes
+      end
+      outlines
+    end
+  end
+end

data/lib/feedcellar/version.rb

@@ -0,0 +1,3 @@
+module Feedcellar
+  VERSION = "0.1.0"
+end

data/test/fixtures/subscriptions.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<opml version="1.0">
+    <head>
+        <title>M の リーダー登録フィード</title>
+    </head>
+    <body>
+        <outline text="my_letter" title="my_letter" type="rss"
+            xmlUrl="http://myokoym.github.com/entries.rss" htmlUrl="http://myokoym.github.com/"/>
+        <outline text="Rubygems | Latest Versions for shogi-ruby"
+            title="Rubygems | Latest Versions for shogi-ruby" type="rss"
+            xmlUrl="https://rubygems.org/gems/shogi-ruby/versions.atom" htmlUrl="https://rubygems.org/gems"/>
+        <outline title="shogi" text="shogi">
+            <outline text="函館将棋情報のブログ" title="函館将棋情報のブログ" type="rss"
+                xmlUrl="http://blogs.yahoo.co.jp/mi807258/rss.xml" htmlUrl="http://rd.yahoo.co.jp/rss/l/blog/myblog/rss2/url/*http://blogs.yahoo.co.jp/mi807258"/>
+        </outline>
+    </body>
+</opml>

data/test/run-test.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "test-unit"
+require "test/unit/notify"
+require "test/unit/rr"
+
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+$LOAD_PATH.unshift(File.join(base_dir, "lib"))
+$LOAD_PATH.unshift(File.join(base_dir, "test"))
+
+exit Test::Unit::AutoRunner.run(true)

data/test/test-command.rb

@@ -0,0 +1,46 @@
+require "fileutils"
+require "stringio"
+require "feedcellar/command"
+require "feedcellar/groonga_database"
+
+class CommandTest < Test::Unit::TestCase
+  def setup
+    @tmpdir = File.join(File.dirname(__FILE__), "tmp", "database")
+    FileUtils.mkdir_p(@tmpdir)
+    @command = Feedcellar::Command.new
+    @command.instance_variable_set(:@work_dir, @tmpdir)
+  end
+
+  def test_command
+    s = ""
+    io = StringIO.new(s)
+    $stderr = io
+    assert_equal(1, @command.register("hoge"))
+    assert_equal("Error: Invalid URL\n", s)
+    $stderr = STDERR
+
+    @command.register("http://myokoym.github.io/entries.rss")
+    Feedcellar::GroongaDatabase.new.open(@tmpdir) do |database|
+      assert_equal(1, database.resources.size)
+    end
+
+    file = File.join(File.dirname(__FILE__), "fixtures", "subscriptions.xml")
+    @command.import(file)
+    @command.collect
+    Feedcellar::GroongaDatabase.new.open(@tmpdir) do |database|
+      assert_equal(4, database.resources.size)
+      assert_true(database.feeds.count > 0)
+    end
+
+    s = ""
+    io = StringIO.new(s)
+    $stdout = io
+    @command.search("ruby")
+    assert_true(s.size > 500)
+    $stdout = STDOUT
+  end
+
+  def teardown
+    FileUtils.rm_rf(@tmpdir)
+  end
+end

data/test/test-opml.rb

@@ -0,0 +1,12 @@
+require "feedcellar/opml"
+
+class OpmlTest < Test::Unit::TestCase
+  def setup
+  end
+
+  def test_parse
+    file = File.join(File.dirname(__FILE__), "fixtures", "subscriptions.xml")
+    outlines = Feedcellar::Opml.parse(file)
+    assert_equal(4, outlines.size) # FIXME (feed * 3) + (tag * 1)
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: feedcellar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masafumi Yokoyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rroonga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-notify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A storage for feed reader by rroonga.
+email:
+- myokoym@gmail.com
+executables:
+- feedcellar
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- NEWS.md
+- README.md
+- Rakefile
+- TODO.md
+- bin/feedcellar
+- feedcellar.gemspec
+- lib/feedcellar.rb
+- lib/feedcellar/command.rb
+- lib/feedcellar/groonga_database.rb
+- lib/feedcellar/opml.rb
+- lib/feedcellar/version.rb
+- test/fixtures/subscriptions.xml
+- test/run-test.rb
+- test/test-command.rb
+- test/test-opml.rb
+homepage: https://github.com/myokoym/feedcellar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Storage for Feed Reader
+test_files:
+- test/fixtures/subscriptions.xml
+- test/run-test.rb
+- test/test-command.rb
+- test/test-opml.rb
+has_rdoc: