bwkfanboy 1.4.1 → 2.0.0

data/doc/README.erb

@@ -1,114 +0,0 @@
-= About
-
-bwkfanboy is a converter from a raw HTML to an Atom feed. You can use it
-to watch sites that do not provide its own feed.
-
-The converter is not a magick tool: you'll need to write a plugin (in
-Ruby) for each site you want to watch. bwkfanboy gives guidelines and
-general assistance.
-
-(Plugins from version 1.1.4 are *incompatible* with the 0.1.x
-series. Please reread in doc/plugin.rdoc the example of the skeleton
-plugin.)
-
-= Included Plugins
-
-<% MyDocs.plugins.each { |i| %>  <%= i %>
-<% } %>
-
-= Installation
-
-The easiest way is to type:
-
-  # gem install bwkfanboy
-
-Beware that plugins above are usually updated more frequently than the
-whole gem on rubygems.org, so grab the source before struggling with a
-particular plugin.
-
-If the setup with <tt>gem install ...</tt> fails, go to
-https://rubygems.org/gems/bwkfanboy and click 'Download' link, save the
-file and run:
-
-  # gem install -l /where/is/your/bwkfanboy-x.y.z.gem
-
-= Architecture
-
-== Plugins
-
-The plugin is a Ruby class +Page+ that inherits Bwkfanboy::Parse parent,
-overriding 1 method.
-
-Plugins can be in system
-
-  `gem env gemdir`/gems/bwkfanboy-x.y.z/lib/bwkfanboy/plugins
-
-or user's home
-
-  ~/.bwkfanboy/plugins
-
-directory.
-
-== Pipeline
-
-The program consists of 4 parts:
-
-0. *bwkfanboy* script that takes 1 parameter: the name of a file in
-   plugins directories (without the .rb suffix). So, for example to get
-   an atom feed from dailyprincetonian.com, you type:
-
-     % bwkfanboy bwk
-
-   and it will load
-   <tt>/usr/local/lib/ruby/gems/1.9/gems/bwkfanboy-0.0.1/lib/bwkfanboy/plugins/bwk.rb</tt>
-   file on my FreeBSD machine, fetch and parse the html from
-   dailyprincetonian.com and generate the required feed, dumping it to
-   stdout.
-
-   The script is just a convenient wrapper for 3 separate utils.
-
-1. *bwkfanboy_fetch*
-
-   Reads 1 line from stdin for the URL to fetch from. The result will be
-   dumped to stdout.
-
-2. *bwkfanboy_parse*
-
-   Takes 1 parameter: <em>a full path</em> to a plugin file.
-
-   This util reads stdin, expecting it to be a xhtml, parses it and
-   dumps the result to stdout in JSON-formatted object.
-
-3. *bwkfanboy_generate*
-
-   Reads stdin expecting it to be a proper JSON-formatted object.
-
-   The result will be an Atom feed dumped to stdout in UTF-8.
-
-So, without the wrapper all this together looks like:
-
-  % echo http://example.org | bwkfanboy_fetch | 
-  	bwkfanboy_parse /path/to/my/plugin.rb | bwkfanboy_generate
-
-== Log
-
-All utils write to <tt>/tmp/bwkfanboy/USER/log/general.log</tt> file if
-permissions allows it.
-
-== HTTP
-
-There are 2 method to get an Atom feed via HTTP:
-
-1. <tt>web/bwkfanboy.cgi</tt> (from the program tarball), which you may
-   copy to your Apache cgi directory and run it. This prohibits you from
-   using HOME directory for your own plugins. Also the cgi script
-   requires some manual editing (setting 1 variable in it) before even
-   you can start utilizing it.
-
-2. Small *bwkfanboy_server* HTTP server. It can run from any user and
-   thus is able to inherit env variables for discovering your HOME
-   directory. Read doc/bwkfanboy_server.rdoc to know how to operate it.
-
-= License
-
-<%= File.read(MyDocs::PATH + 'LICENSE') %>

data/doc/README.rdoc

@@ -1,141 +0,0 @@
-= About
-
-bwkfanboy is a converter from a raw HTML to an Atom feed. You can use it
-to watch sites that do not provide its own feed.
-
-The converter is not a magick tool: you'll need to write a plugin (in
-Ruby) for each site you want to watch. bwkfanboy gives guidelines and
-general assistance.
-
-(Plugins from version 1.1.4 are *incompatible* with the 0.1.x
-series. Please reread in doc/plugin.rdoc the example of the skeleton
-plugin.)
-
-= Included Plugins
-
-  NAME                 VER DESCRIPTION
-
-  bwk                    2 Brian Kernighan's articles from Daily Princetonian
-  freebsd-ports-update   3 News from FreeBSD ports
-  inc                    1 Articles (per-user) from inc.com
-  econlib                1 Latest articles from econlib.org
-
-
-= Installation
-
-The easiest way is to type:
-
-  # gem install bwkfanboy
-
-Beware that plugins above are usually updated more frequently than the
-whole gem on rubygems.org, so grab the source before struggling with a
-particular plugin.
-
-If the setup with <tt>gem install ...</tt> fails, go to
-https://rubygems.org/gems/bwkfanboy and click 'Download' link, save the
-file and run:
-
-  # gem install -l /where/is/your/bwkfanboy-x.y.z.gem
-
-= Architecture
-
-== Plugins
-
-The plugin is a Ruby class +Page+ that inherits Bwkfanboy::Parse parent,
-overriding 1 method.
-
-Plugins can be in system
-
-  `gem env gemdir`/gems/bwkfanboy-x.y.z/lib/bwkfanboy/plugins
-
-or user's home
-
-  ~/.bwkfanboy/plugins
-
-directory.
-
-== Pipeline
-
-The program consists of 4 parts:
-
-0. *bwkfanboy* script that takes 1 parameter: the name of a file in
-   plugins directories (without the .rb suffix). So, for example to get
-   an atom feed from dailyprincetonian.com, you type:
-
-     % bwkfanboy bwk
-
-   and it will load
-   <tt>/usr/local/lib/ruby/gems/1.9/gems/bwkfanboy-0.0.1/lib/bwkfanboy/plugins/bwk.rb</tt>
-   file on my FreeBSD machine, fetch and parse the html from
-   dailyprincetonian.com and generate the required feed, dumping it to
-   stdout.
-
-   The script is just a convenient wrapper for 3 separate utils.
-
-1. *bwkfanboy_fetch*
-
-   Reads 1 line from stdin for the URL to fetch from. The result will be
-   dumped to stdout.
-
-2. *bwkfanboy_parse*
-
-   Takes 1 parameter: <em>a full path</em> to a plugin file.
-
-   This util reads stdin, expecting it to be a xhtml, parses it and
-   dumps the result to stdout in JSON-formatted object.
-
-3. *bwkfanboy_generate*
-
-   Reads stdin expecting it to be a proper JSON-formatted object.
-
-   The result will be an Atom feed dumped to stdout in UTF-8.
-
-So, without the wrapper all this together looks like:
-
-  % echo http://example.org | bwkfanboy_fetch | 
-  	bwkfanboy_parse /path/to/my/plugin.rb | bwkfanboy_generate
-
-== Log
-
-All utils write to <tt>/tmp/bwkfanboy/USER/log/general.log</tt> file if
-permissions allows it.
-
-== HTTP
-
-There are 2 method to get an Atom feed via HTTP:
-
-1. <tt>web/bwkfanboy.cgi</tt> (from the program tarball), which you may
-   copy to your Apache cgi directory and run it. This prohibits you from
-   using HOME directory for your own plugins. Also the cgi script
-   requires some manual editing (setting 1 variable in it) before even
-   you can start utilizing it.
-
-2. Small *bwkfanboy_server* HTTP server. It can run from any user and
-   thus is able to inherit env variables for discovering your HOME
-   directory. Read doc/bwkfanboy_server.rdoc to know how to operate it.
-
-= License
-
-(The MIT License)
-
-Copyright (c) 2010 Alexander Gromnitsky.
-
-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/doc/TODO

@@ -1,7 +0,0 @@
--*-org-*-
-
-- Add plugin listing to _server.
-- Several http requests to _fetch.
-+ Inject falsework template.
-+ econlib.org articles plugin.
-- Rewrite Utils module to be more compatible with falsework.

data/doc/bwkfanboy_fetch.rdoc

@@ -1,4 +0,0 @@
-= bwkfanboy_fetch
-
-Read stdin for a URI or a full path to the local file, download it (or
-read from the local file) and print the result to stdout.

data/doc/bwkfanboy_generate.rdoc

@@ -1,7 +0,0 @@
-= bwkfanboy_generate
-
-Read stdin for JSON, generate from it an Atom feed and print the
-result to stdout in UTF-8.
-
-One can validate the JSON by providing '--check' command line option
-(by default the validating is off).

data/doc/bwkfanboy_parse.rdoc

@@ -1,7 +0,0 @@
-= bwkfanboy_parse
-
-Takes 1 command line parameter: a full path to a plugin.
-
-Reads stdin for a HTML, parses it and prints the result to stdout in
-JSON format. If '-vv' command line parameters were given, output will
-be in 'key: value' pairs and <em>not</em> in JSON.

data/doc/bwkfanboy_server.rdoc

@@ -1,35 +0,0 @@
-= bwkfanboy_server
-
-Start a HTTP server (by default on 127.0.0.1:9042). To get Atom feeds
-from it, initiate GET request with URI
-
-  http://localhost:9042/?p=PLUGIN
-
-where +PLUGIN+ is a name of a bwkfanboy's plugin (without '.re' suffix).
-If the plugin requires additional options you can specify them like:
-
-  http://localhost:9042/?p=PLUGIN&o=opt1%20%22opt2%20has%20spaces%22
-
-where <tt>opt1%20%22opt2%20has%20spaces%22</tt> is a encoded string
-<tt>opt1 "opt2 has spaces"</tt>.
-
-To list all available plugins, point you browser to
-
-  http://localhost:9042/list
-
-The server is intended to run from a non-root user from
-<tt>~/.login</tt> file. It can detach from a terminal if you give it
-'-d' command line option.
-
-For other help, type:
-
- bwkfanboy_server -h
-
-The server maintains 2 logs:
-
-  /tmp/bwkfanboy/USER/log/bwkfanboy_server.log
-  /tmp/bwkfanboy/USER/log/bwkfanboy_server-access.log
-
-The file with a pid:
-
-  /tmp/bwkfanboy/USER/bwkfanboy_server.pid

data/doc/rakefile.rb

@@ -1,59 +0,0 @@
-# -*-ruby-*-
-
-require 'erb'
-require 'json'
-require 'pathname'
-
-module MyDocs
-  PATH = Pathname.new File.dirname(__FILE__)
-
-  # our targets
-  RDOC = FileList["#{PATH}/*.erb"].sub(/\.erb$/, '.rdoc')
-  RDOC_RELATIVE = RDOC.pathmap '%-1d/%f'
-
-  BWK = PATH.parent + 'bin/bwkfanboy'
-  PLUGINS_DIR = PATH.parent + 'lib/bwkfanboy/plugins'
-  PLUGINS = Dir["#{PLUGINS_DIR}/*.rb"].map {|i| i.pathmap '%{\.rb$}f' }
-
-  # Return a list of plugins with description for each plugin.
-  # This is used in .erb files.
-  def self.plugins
-    plugin_name_max = 20
-
-    r = [format("%-#{plugin_name_max}s %s %s\n", 'NAME', 'VER', 'DESCRIPTION')]
-    PLUGINS.each {|i|
-      pr = `#{BWK} -i #{i} q w e r t y`.split("\n")
-      ver = pr[0].split(':')[1..-1].join.strip
-      desc = pr[2].split(':')[1..-1].join.strip
-      r << format("%-#{plugin_name_max}s %3s %s", i, ver, desc)
-    }
-    r
-  end
-end
-
-namespace 'mydocs' do
-  rule '.rdoc' => ['.erb', MyDocs::PLUGINS_DIR.to_s] do |i|
-    File.open(i.name, 'w+') {|fp|
-      puts i.source.pathmap('%-1d/%f') + ' > ' + i.name.pathmap('%-1d/%f')
-      fp.puts ERB.new(File.read(i.source)).result(binding)
-    }
-  end
-
-  desc "Generate all"
-  task :default => MyDocs::RDOC
-
-  desc "Clean all crap"
-  task :clean do
-    rm(MyDocs::RDOC, verbose: true, force: true)
-  end
-
-  desc "Print a list of plugins"
-  task :plugins do
-    MyDocs.plugins.each {|i| puts i}
-  end
-
-  desc "Print all staff that _can_ be generated"
-  task :print_gen do
-    puts MyDocs::RDOC.to_a.to_json
-  end
-end

data/lib/bwkfanboy/generate.rb

@@ -1,63 +0,0 @@
-require 'rss/maker'
-require 'date'
-require 'json'
-require 'jsonschema'
-
-require_relative 'utils'
-
-module Bwkfanboy
-  class Generate
-
-    def self.validate(t)
-      schema = Bwkfanboy::Utils.gem_dir_system() + '/schema.js'
-      begin
-        JSON::Schema.validate(t, JSON.parse(File.read(schema)))
-      rescue
-        Bwkfanboy::Utils.errx(1, "JSON validation with schema (#{schema}) failed");
-      end
-    end
-    
-    def self.atom(src)
-      feed = RSS::Maker.make("atom") { |maker|
-        maker.channel.id = src['channel']['id']
-        maker.channel.updated = src['channel']['updated']
-        maker.channel.author = src['channel']['author']
-        maker.channel.title = src['channel']['title']
-        
-        maker.channel.links.new_link {|i|
-          i.href = src['channel']['link']
-          i.rel = 'alternate'
-          i.type = 'text/html' # eh
-        }
-        
-        maker.items.do_sort = true
-
-        src['x_entries'].each { |i|
-          maker.items.new_item do |item|
-            item.links.new_link {|k|
-              k.href = i['link']
-              k.rel = 'alternate'
-              k.type = 'text/html' # only to make happy crappy pr2nntp gateway
-            }
-            item.title = i['title']
-            item.author = i['author']
-            item.updated = i['updated']
-            item.content.type = src['channel']['x_entries_content_type']
-      
-            case item.content.type
-            when 'text'
-              item.content.content = i['content']
-            when 'html'
-              item.content.content = i['content']
-            else
-              item.content.xhtml = i['content']
-            end
-          end
-        }
-      }
-
-      return feed
-    end
-    
-  end
-end