automatic 12.3.0 → 12.3.1

data/Gemfile

@@ -8,6 +8,7 @@ gem 'hashie'
 gem 'activerecord', '~>3'
 gem 'gcalapi'
 gem 'xml-simple'
+gem 'feedbag'
 
 group :test do
   gem 'rspec'

data/README.md

@@ -3,14 +3,21 @@ Automatic Ruby
 
 **Ruby General Automation Framework**
 
-See doc/README.ja file.
-(document written in Japanese.)
 
+Description
+-----------
+
+This is a general-purpose automatic processing
+ruby framework which can extend the functionality
+by plug-ins.
+
+See doc/README file.
 
-Usage
------
 
-Get started.
+Get Started
+-----------
+
+Installation.
 
 ``` html
 gem install automatic
@@ -22,7 +29,36 @@ Specify any recipe with -c option.
 automatic -c <recipe>
 ```
 
-For more info, refer to the document (doc/README.ja).
+Example.
+
+``` html
+$ automatic -c config/feed2console.yml
+```
+
+
+What is Recipe?
+---------------
+
+Automatic Ruby parses configuration file that was written
+in the form of YAML which including variety of information
+of associated plug-ins.
+
+This YAML file is called "Recipe".
+
+When you start automatic ruby without argument -c option,
+the config/default.yml is called. You can use -c option for
+specify a file name.
+
+The Recipe has an implicit naming convention.
+
+``` html
+plugins:
+  - module: MODULE_NAME
+    config:
+      VARIABLES
+```
+
+For more info, refer to the document (doc/README).
 
 
 Environment
@@ -44,31 +80,13 @@ We need your help.
 
 + https://github.com/id774/automaticruby/issues
 
-**CI**
-
-+ http://id774.net/jenkins/
+**RubyFroge**
 
++ http://rubyforge.org/projects/automatic/
 
-How to Join
------------
-
-1. Fork the repository.
-2. Write new plugin or existing code improvement.
-3. Send pull request!
-
-After that, we will give you the right to commit for a quick fix finely.
-
-
-Coding Rule
------------
+**CI**
 
-+ 2 tabs, soft tabs.
-+ Remove the space at the end of a line.
-+ Namespace and conventions, see the existing code.
-+ {} is recommended than do end (To avoid end end end,,).
-+ RDoc Header is written by creator of the file.
-+ Write RSPec tests.
-+ Aim at 100% coverage.
++ http://id774.net/jenkins/
 
 
 ChangeLog
@@ -87,6 +105,12 @@ Releases will be numbered with the follow format:
 This naming convention is to mimic the Ubuntu.
 
 
+Developers
+----------
+
+See doc/AUTHORS.
+
+
 Author
 ------
 
@@ -96,14 +120,8 @@ Author
 + http://github.com/id774
 
 
-Developers
-----------
-
-See doc/AUTHORS.
-
-
-Copyright and license
----------------------
+License
+-------
 
 Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
 

data/Rakefile

@@ -9,6 +9,20 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
+namespace :spec do 
+  desc "Run RSpec for plugins"
+  RSpec::Core::RakeTask.new(:plugins) do |spec|
+    spec.rspec_opts = ["-c"]
+    spec.pattern = FileList['spec/plugins/**/*_spec.rb']
+  end
+
+  desc "Run RSpec for main procedure"
+  RSpec::Core::RakeTask.new(:lib) do |spec|
+    spec.rspec_opts = ["-c"]
+    spec.pattern = FileList['spec/lib/**/*_spec.rb']
+  end
+end
+
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options

data/VERSION

@@ -1 +1 @@
-12.3.0
+12.3.1

data/automatic.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "automatic"
-  s.version = "12.3.0"
+  s.version = "12.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["id774"]
-  s.date = "2012-03-07"
+  s.date = "2012-03-16"
   s.description = "Ruby General Automation Framework"
   s.email = "idnanashi@gmail.com"
-  s.executables = ["automatic"]
+  s.executables = ["automatic", "automatic-config"]
   s.extra_rdoc_files = [
     "README.md"
   ]
@@ -23,20 +23,25 @@ Gem::Specification.new do |s|
     "VERSION",
     "automatic.gemspec",
     "bin/automatic",
+    "bin/automatic-config",
     "config/default.yml",
     "config/feed2console.yml",
     "db/.gitkeep",
     "doc/AUTHORS",
     "doc/COPYING",
     "doc/ChangeLog",
+    "doc/PLUGINS",
     "doc/PLUGINS.ja",
+    "doc/README",
     "doc/README.ja",
     "lib/automatic.rb",
     "lib/automatic/environment.rb",
     "lib/automatic/feed_parser.rb",
     "lib/automatic/log.rb",
+    "lib/automatic/opml.rb",
     "lib/automatic/pipeline.rb",
     "lib/automatic/recipe.rb",
+    "lib/config/validator.rb",
     "plugins/custom_feed/svn_log.rb",
     "plugins/filter/ignore.rb",
     "plugins/filter/image.rb",
@@ -51,6 +56,10 @@ Gem::Specification.new do |s|
     "plugins/store/target_link.rb",
     "plugins/subscription/feed.rb",
     "script/bootstrap",
+    "script/build",
+    "spec/lib/automatic/pipeline_spec.rb",
+    "spec/lib/automatic_spec.rb",
+    "spec/lib/pipeline_spec.rb",
     "spec/plugins/custom_feed/svn_log_spec.rb",
     "spec/plugins/filter/ignore_spec.rb",
     "spec/plugins/filter/image_spec.rb",
@@ -64,6 +73,8 @@ Gem::Specification.new do |s|
     "spec/plugins/store/target_link_spec.rb",
     "spec/plugins/subscription/feed_spec.rb",
     "spec/spec_helper.rb",
+    "spec/user_dir/plugins/store/mock.rb",
+    "test/fixtures/sampleOPML.xml",
     "test/integration/test_activerecord.yml",
     "test/integration/test_fulltext.yml",
     "test/integration/test_hatenabookmark.yml",
@@ -72,8 +83,6 @@ Gem::Specification.new do |s|
     "test/integration/test_image2local.yml",
     "test/integration/test_svnlog.yml",
     "test/integration/test_tumblr2local.yml",
-    "utils/auto_discovery.rb",
-    "utils/opml_parser.rb",
     "vendor/.gitkeep"
   ]
   s.homepage = "http://github.com/id774/automaticruby"
@@ -92,6 +101,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activerecord>, ["~> 3"])
       s.add_runtime_dependency(%q<gcalapi>, [">= 0"])
       s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
+      s.add_runtime_dependency(%q<feedbag>, [">= 0"])
       s.add_development_dependency(%q<cucumber>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
@@ -102,6 +112,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<activerecord>, ["~> 3"])
       s.add_dependency(%q<gcalapi>, [">= 0"])
       s.add_dependency(%q<xml-simple>, [">= 0"])
+      s.add_dependency(%q<feedbag>, [">= 0"])
       s.add_dependency(%q<cucumber>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
@@ -113,6 +124,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activerecord>, ["~> 3"])
     s.add_dependency(%q<gcalapi>, [">= 0"])
     s.add_dependency(%q<xml-simple>, [">= 0"])
+    s.add_dependency(%q<feedbag>, [">= 0"])
     s.add_dependency(%q<cucumber>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])

data/bin/automatic

@@ -3,13 +3,47 @@
 # Name::      Automatic::Ruby
 # Author::    774 <http://id774.net>
 # Created::   Feb 18, 2012
-# Updated::   Feb 24, 2012
+# Updated::   Mar 16, 2012
 # Copyright:: 774 Copyright (c) 2012
 # License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
 
 root_dir = File.expand_path("..", File.dirname(__FILE__))
 $:.unshift root_dir
 $:.unshift root_dir + '/lib'
-require 'lib/automatic'
+require 'automatic'
+require 'optparse'
 
-Automatic.run(root_dir)
+recipe_path = ""
+parser = OptionParser.new { |parser|
+  parser.banner = "Usage: automatic [options] arg"
+  parser.version = Automatic.const_get(:VERSION)
+  parser.separator "options:"
+  parser.on('-c', '--config FILE', String,
+            "recipe YAML file"){|c| recipe_path = c}
+  parser.on('-h', '--help', "show this message") { 
+    puts parser
+    exit
+  }
+}
+
+begin
+  parser.parse!
+  puts "Loading #{recipe_path}" unless recipe_path.empty?
+rescue OptionParser::ParseError => err
+  $stderr.puts err.message
+  $stderr.puts parser.help
+  exit 1
+end
+
+if recipe_path.to_s.empty? 
+  if ENV["AUTOMATIC_RUBY_ENV"] == "test"
+    recpie_path = File.join(root_dir, 'config/default.yml') 
+  else
+    puts parser
+    exit 0
+  end
+end
+
+recipe = Automatic::Recipe.new(recipe_path)
+Automatic.run(:recipe   => recipe,
+              :root_dir => root_dir)

data/bin/automatic-config

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+# Name::      Automatic::Ruby
+# Author::    kzgs
+# Created::   Mar 11, 2012
+# Updated::   Mar 11, 2012
+# Copyright:: kzgs Copyright (c) 2012
+# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+
+root_dir = File.expand_path("..", File.dirname(__FILE__))
+$:.unshift root_dir + '/lib'
+
+require 'rubygems'
+require 'optparse'
+
+parser = OptionParser.new { |opt|
+}
+
+def abort_with_usage(subcommand, message)
+  top_filename = File.basename($0)
+  abort("Usage: #{top_filename} #{subcommand} #{message}")
+end
+
+subparsers = {
+  'scaffold' => lambda { |argv|
+    Dir::entries(root_dir + '/plugins').sort.each { |path|
+      require 'fileutils'
+      dir = (File.expand_path('~/.automatic/plugins/' + path))
+      unless File.exist?(dir)
+        FileUtils.mkdir_p(dir)
+        puts "Create Directory #{dir}"
+      end
+    }
+  },
+  'autodiscovery' => lambda { |argv|
+    require 'pp'
+    require 'feedbag'
+    url = argv.shift || abort_with_usage("autodiscovery", "<url>")
+    pp Feedbag.find(url)
+  },
+  'opmlparser' => lambda { |argv|
+    require 'automatic/opml'
+    path = argv.shift
+    if path.nil?
+      abort_with_usage("opmlparser", "<opml path>")
+    end
+    parser = Automatic::OPML::Parser.new(File.read(path))
+    parser.each_outline {|opml, o|
+      puts "#{o.xmlUrl}"
+    }
+  },
+  'feedparser' => lambda { |argv|
+    require 'pp'
+    require 'automatic/feed_parser'
+    url = argv.shift || abort_with_usage("feedparser", "<url>")
+    rss_results = Automatic::FeedParser.get_rss(url)
+    pp rss_results
+  },
+  'log' => lambda { |argv|
+    require 'automatic/log'
+    level = argv.shift || abort_with_usage("log", "<level> <message>")
+    message = ARGV.shift
+    Automatic::Log.puts(level, message)
+  }
+}
+
+parser.order!(ARGV)
+
+if ARGV.empty?
+  puts "Available commands: #{subparsers.keys.join(", ")}"
+  exit 1
+end
+
+Hash.new { |h, k|
+  puts "No such subcommand: #{k}"
+  exit 1
+}.update(subparsers)[ARGV.shift].call(ARGV)

data/config/default.yml

@@ -9,21 +9,18 @@ plugins:
   - module: SubscriptionFeed
     config:
       feeds:
-        - http://example.com/rss2
-
-  - module: FilterIgnore
-    config:
-      exclude:
-        - hoge
-        - fuga
+        - http://reretlet.tumblr.com/rss
 
   - module: StorePermalink
     config:
-      db: permalink.db
+      db: tumblr.db
+
+  - module: FilterImage
+
+  - module: FilterTumblrResize
 
-  - module: PublishHatenaBookmark
+  - module: StoreTargetLink
     config:
-      username: your_hatena_id
-      password: your_password
-      interval: 5
+      path: /tmp
+      interval: 2
 

data/doc/ChangeLog

@@ -1,8 +1,32 @@
+=== 12.3.1 / 2012-03-16
+
+* English Documents.
+
+  * doc/README
+  * doc/PLUGINS
+
+* The user who installed the gem package be able to create own plugins.
+
+  * ~/.automatic/plugins
+
+* Utils merged to automatic-config command and added following subcommand.
+
+  * scaffold
+  * autodiscovery
+  * opmlparser
+  * feedparser
+  * log
+
+* Added Integration Test Script for CI.
+
+  * script/build
+
+
 === 12.03 / 2012-03-07
 
-* Distribute as a gem library
+* Distribute as a gem library.
 
-* Plugins added
+* Plugins added.
 
   * CustomFeed::SVNLog
   * Notify::Ikachan
@@ -10,27 +34,27 @@
   * Filter::Image
   * Store::TargetLink
 
-* CI / Build scripts
+* CI / Build scripts.
 
   * script/bootstrap
 
-* Signficant Refactoring
+* Signficant Refactoring.
 
 
 === 12.02.1 / 2012-02-25
 
-* Point release
+* Point release.
 
   * Big Refactoring for core.
-	* Reorganization of the namespace.
+  * Reorganization of the namespace.
   * A few plugins added.
 
 
 === 12.02 / 2012-02-18
 
-* First release
+* First release.
 
   * Scratch of this script.
-	* Plugin existing only for hatenabookmark.
+  * Plugin existing only for hatenabookmark.
 
 

data/doc/PLUGINS

@@ -0,0 +1,205 @@
+===========================
+Description of the plug-ins
+===========================
+
+SubscriptionFeed
+----------------
+[Path]
+ /plugins/subscription/feed.rb
+
+[Abstract]
+ Subscribe to feed.
+
+[Syntax]
+  - module: SubscriptionFeed
+    config:
+      feeds:
+        - FEED
+        - FEED ...
+
+
+FilterIgnore
+------------
+[Path]
+ /plugins/filter/ignore.rb
+
+[Abstract]
+ To exclude the NG word.
+
+[Syntax]
+  - module: FilterIgnore
+    config:
+      exclude:
+        - KEYWORD
+        - KEYWORD ...
+
+
+FilterImage
+------------
+[Path]
+ /plugins/filter/image.rb
+
+[Abstract]
+ Rewrite the permalink to link of the image in the contents.
+ If there is no link of image, the permalink will be nil.
+
+[Syntax]
+  - module: FilterImage
+
+
+FilterTumblrResize
+--------------------
+[Path]
+ /plugins/filter/tumblr_resize.rb
+
+[Abstract]
+ To rewrite the permalink to the maximum size of
+ the Tumblr (High Res).
+
+[Assumption]
+ It has already been rewritten to perm link image link
+
+[Syntax]
+  - module: FilterTumblrResize
+
+
+StorePermalink
+--------------
+[Path]
+ /plugins/store/permalink.rb
+
+[Abstract]
+ To save a permanent link.
+ The duplicate permalink will be discarded.
+
+[Syntax]
+  - module: StoreBookmark
+    config:
+      db: DB_NAME
+
+
+StoreFullText
+-------------
+[Path]
+ /plugins/store/full_text.rb
+
+[Abstract]
+ To save a full text of contents.
+
+ Saved text can be viewed in the viewer below
+ https://github.com/id774/blog_viewer
+
+[Syntax]
+  - Module: StoreFullText
+    config:
+      db: DB_NAME
+
+
+StoreTargetLink
+---------------
+[Path]
+ /plugins/store/target_link.rb
+
+[Abstract]
+ To store target locally.
+ This emulate "Right click to save".
+
+[Syntax]
+  - Module: StoreTargetLink
+    config:
+      path: SAVE_TO_PATH
+      interval: INTERVAL_FOR_DOWNLOAD (in seconds.)
+
+
+PublishConsole
+--------------
+[Path]
+ /plugins/publish/console.rb
+
+[Abstract]
+ Output pipeline to the console.
+
+[Syntax]
+  - module: PublishConsole
+
+
+PublishHatenaBookmark
+---------------------
+[Path]
+ /plugins/publish/hatenabookmark.rb
+
+[Abstract]
+ To Hatena Bookmark (Social Bookmark).
+
+[Description]
+ To generate the XML for submission to
+ Hatena Bookmark API.
+
+[Syntax]
+  - Modu  - module: PublishHatenaBookmark
+    config:
+      username: HATENA_ID
+      passowrd: PASSWORD
+      interval: INTERVAL_FOR_BOOKMARK (in seconds.)
+
+
+PublishGoogleCalendar
+---------------------
+[Path]
+ /plugins/publish/google_calendar.rb
+
+[Abstract]
+ To register an appointment to Google Calendar.
+
+[Description]
+ Register item.title to Google Calendar.
+
+[Notation recipe]
+  - module: PublishGoogleCalendar
+    config:
+      username: GOOGLE_ACCOUNT
+      password: PASSWORD
+      interval: INTERVAL
+
+
+NotifyIkachan
+-------------
+[Path]
+ /plugins/notify/ikachan.rb
+
+[Abstract]
+ To send a message to ikachan.
+
+[Description]
+ POST to ikachan via HTTP.
+ ikachan is: http://blog.yappo.jp/yappo/archives/000760.html
+
+[Syntax]
+  - module: NotifyIkachan
+    config:
+      url: http://sample.com
+      port: 4979             # port number, the default is 4979.
+      channels: foo,bar,#baz # '#' is priced automatically, multiple by ','
+      command: notice        # privmsg,notice etc..
+      interval: 5            # post interval. (s)
+
+
+CustomFeedSVNLog
+----------------
+[Path]
+ /plugins/custom/feed_svn_log.rb
+
+[Abstract]
+ Get new revision info from SVN.
+
+[Description]
+ To get the number that is specified by fetch_items.
+
+[Notation recipe]
+  - Module: CustomFeedSVNLog
+  - module: CustomFeedSVNLog
+    config:
+      target: http://redmine.rubyforge.org/svn
+      fetch_items: 2 # If not specified, 30
+
+

data/doc/PLUGINS.ja

@@ -135,7 +135,7 @@ PublishHatenaBookmark
 送信する
 
 [レシピ記法]
-  - module: AutoBookmark
+  - module: PublishHatenaBookmark
     config:
       username: はてな ID
       passowrd: パスワード
@@ -151,8 +151,7 @@ PublishGoogleCalendar
  Google Calendar に予定を登録する
 
 [説明]
- item.title を当日の Google カレンダーに
-登録する
+ item.title を Google カレンダーに登録する
 
 [レシピ記法]
   - module: PublishGoogleCalendar