bwkfanboy 1.4.1 → 2.0.0

data/etc/bwkfanboy.yaml

@@ -0,0 +1,2 @@
+--- 
+:foobar: foobar

data/etc/sinatra.rb

@@ -0,0 +1,34 @@
+# This file is loaded by the application at start-up.
+
+# Disable useless rack logger completely! Yay, yay!
+module Rack
+  class CommonLogger
+    def call(env)
+      # do nothing
+      @app.call(env)
+    end
+  end
+end
+
+module Bwkfanboy
+  module MySinatraConfig
+    
+    def self.read o
+      o.configure do
+        # heroku logs
+        $stdout.sync = true
+      end
+  
+      o.configure :production, :development do
+      end
+  
+      o.configure :development do
+      end
+  
+      o.configure :production do
+        o.set :haml, ugly: true
+      end
+    end
+    
+  end
+end

data/lib/bwkfanboy/cliconfig.rb

@@ -0,0 +1,141 @@
+# :erb: ruby-cli
+
+require 'pathname'
+require 'yaml'
+require 'optparse'
+require 'shellwords'
+
+require_relative 'cliutils'
+
+module Bwkfanboy
+
+  # Load configuration from 3 places (starting from least significant):
+  # config file, env variable, command line.
+  class CliConfig
+    # Possible config file locations.
+    DIR_CONFIG = [Pathname.new(Dir.home) + ".#{Meta::NAME}",
+                  Pathname.new('/etc'),
+                  Pathname.new('/usr/etc'),
+                  Pathname.new('/usr/local/etc'),
+                  CliUtils::DIR_LIB_SRC.parent.parent + 'etc']
+
+    # Example:
+    #
+    # conf = CliConfig.new
+    # conf[:my_option] = 123
+    # conf.load
+    def initialize
+      @conf = Hash.new
+      @conf[:verbose] = 0
+      @conf[:banner] = "Usage: #{File.basename($0)} [options]"
+      @conf[:config_name] = Meta::NAME + '.yaml'
+      @conf[:config_env] = Meta::NAME.upcase + '_CONF'
+      @conf[:config_dirs] = DIR_CONFIG
+    end
+
+    # Setter for @conf
+    def []=(key, val)
+      CliUtils.verbose = val if key == :verbose # sync verbosity levels
+      @conf[key] = val
+    end
+
+    # Getter for @conf
+    def [](key)
+      @conf[key]
+    end
+
+    # Return a full path to a config file or nil if no config file found.
+    def getConfigPath
+      if @conf[:config_name].index('/')
+        return @conf[:config_name] if File.file?(@conf[:config_name])
+      else 
+        @conf[:config_dirs].each {|i|
+          r = Pathname.new(i) + @conf[:config_name]
+          return r if File.file?(r)
+        }
+      end
+
+      CliUtils.warnx "no config file '#{@conf[:config_name]}' found" if @conf[:verbose] >= 2
+      return nil
+    end
+
+    # Load a config from file. Return true on success or false otherwise.
+    def loadFile
+      file = getConfigPath
+      return false unless file
+
+      CliUtils::veputs(2, "Loading #{File.basename(file)}... " + CliUtils::NNL_MARK)
+      myconf = YAML.load_file(file) rescue CliUtils.errx(EX_CONFIG, "cannot parse config #{file}: #{$!}")
+      # preserve existing values
+      @conf.merge!(myconf) {|key, oldval, newval| oldval }
+      CliUtils::veputs 2, "OK"
+      return true
+    end
+
+    # Check if options in array opts are in @conf.
+    def requiredOptions?(opts)
+      opts.each {|idx|
+        if !@conf.key?(idx.to_sym) || !@conf[idx.to_sym]
+          CliUtils.errx EX_CONFIG, "option #{idx} is either nil or missing"
+        end
+      }
+    end
+
+    # Parse CLO and env variable. If block is given it is passed with
+    # OptionParser object as a parameter.
+    def optParse
+      OptionParser.new do |o|
+        o.on('-v', 'Be more verbose.') { |i|
+          self[:verbose] += 1
+        }
+        o.on('-V', '--version', 'Show version & exit.') { |i|
+          puts Meta::VERSION
+          exit EX_OK
+        }
+        o.on('--config NAME',
+             "Set a config name or file",
+             "(default is #{@conf[:config_name]}).") {|arg|
+          @conf[:config_name] = arg
+        }
+        o.on('--config-dirs', 'Show possible config locations.') {
+          mark = false
+          @conf[:config_dirs].each { |idx|
+            f = Pathname(idx) + @conf[:config_name]
+            if File.file?(f) && !mark
+              puts "* #{f}"
+              mark = true
+            else
+              puts "  #{f}"
+            end
+          }
+          exit EX_OK
+        }
+
+        yield o if block_given?
+        o.banner = @conf[:banner]
+
+        env = nil
+        env = ENV[@conf[:config_env]].shellsplit if ENV.key?(@conf[:config_env])
+
+        begin
+          [env, ARGV].each { |i| o.parse!(i) if i }
+        rescue
+          CliUtils.errx EX_USAGE, $!.to_s
+        end
+      end
+    end
+
+    # Parse CLO, env variables and load config file.
+    #
+    # [reqOpts] an array of requied options
+    # [&block]  a optional block for OptionParser
+    def load(reqOpts = [], &block)
+      optParse(&block)
+      loadFile
+      requiredOptions?(reqOpts)
+    end
+    
+  end
+end
+
+# Don't remove this: falsework/2.0.0/ruby-cli/2012-03-05T05:04:11+02:00

data/lib/bwkfanboy/cliutils.rb

@@ -0,0 +1,114 @@
+# :erb: ruby-cli
+
+require 'pp'
+require 'open4'
+require 'pathname'
+
+require_relative 'meta'
+
+module Bwkfanboy
+
+  # Preferable exit codes. See sysexits(3) in FreeBSD.
+  EX_OK = 0
+  EX_USAGE = 64
+  EX_DATAERR = 65
+  EX_NOINPUT = 66
+  EX_NOUSER = 67
+  EX_NOHOST = 68
+  EX_UNAVAILABLE = 69
+  EX_SOFTWARE = 70
+  EX_OSERR = 71
+  EX_OSFILE = 72
+  EX_CANTCREAT = 73
+  EX_IOERR = 74
+  EX_TEMPFAIL = 75
+  EX_PROTOCOL = 76
+  EX_NOPERM = 77
+  EX_CONFIG = 78
+  
+  # Common routines useful in any CLI program.
+  class CliUtils
+    # Physical location of program libraries.
+    DIR_LIB_SRC = Pathname.new File.dirname(__FILE__)
+    # veputs uses this to decide to put a newline or not to put.
+    NNL_MARK = '__NNL__'
+
+    # Class-wide verbosity level.
+    @@verbose = 0
+
+    # Setter.
+    def self.verbose=(val)
+      @@verbose = val
+    end
+
+    # Getter.
+    def self.getVerbose
+      @@verbose
+    end
+
+    # A handy check. Use it like:
+    #
+    # puts (CliUtils.debug ? "DEBUG mode" : "")
+    def self.debug
+      @@verbose >= 2
+    end
+
+    # A handy method that return a nicely formatted current global
+    # backtrace.
+    def self.getBacktrace
+      "#{$!}\n\nBacktrace:\n\n#{$!.backtrace.join("\n")}"
+    end
+
+    # Print an error msg & exit if exit_code > 0.
+    def self.errx(exit_code = 0, msg)
+      $stderr.puts File.basename($0) + ' error: ' + msg.to_s
+      exit exit_code if exit_code > 0
+    end
+
+    # Print a warning.
+    def self.warnx(msg)
+      $stderr.puts File.basename($0) + ' warning: ' + msg.to_s
+    end
+
+    # [level] Verbosity level.
+    # [msg]   A message to print.
+    #
+    # Don't print msg with a newline if it contains NNL_MARK at the end.
+    def self.veputs(level, msg)
+      t = msg.dup
+      
+      nnl = false
+      if t.match(/#{NNL_MARK}$/)
+        t.sub!(/#{$&}/, '')
+        nnl = true
+      end
+
+      if @@verbose >= level
+        nnl ? print(t) : print("#{t}\n")
+        $stdout.flush
+      end
+    end
+
+    # Analogue to a shell command +which+.
+    def self.which(file)
+      return true if file =~ %r%\A/% and File.exist? file
+      
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |path|
+        File.exist? File.join(path, file)
+      end
+    end
+    
+    # Execute cmd and return an array [exit_status, stderr, stdout].
+    def self.exec(cmd)
+      so = sr = ''
+      status = Open4::popen4(cmd) { |pid, stdin, stdout, stderr|
+        so = stdout.read
+        sr = stderr.read
+      }
+      [status.exitstatus, sr, so]
+    end
+  end
+
+end
+
+# Don't remove this: falsework/2.0.0/ruby-cli/2012-03-05T05:04:11+02:00

data/lib/bwkfanboy/fetch.rb

@@ -1,36 +1,34 @@
 require 'open-uri'
 
-require_relative 'utils'
-
 module Bwkfanboy
-  class Fetch
-
-    # If no block given, return contents of fetch'ed URI. Otherwise,
-    # execute the block with 1 parameter--stream.
-    def self.cat(uri)
-      uri.chomp!
 
-      Bwkfanboy::Utils.veputs(1, "fetching #{uri}\n")
+  class FetchException < StandardError
+  end
+  
+  module Fetch
+    extend self
+    
+    # Return an array of opened streams.
+    #
+    # [uri]  an array of URIs
+    def openStreams uri
+      return nil unless uri
 
+      streams = []
       begin
-        open(uri, "User-Agent" => Bwkfanboy::Meta::USER_AGENT) {|f|
-          if defined?(f.meta) && f.status[0] != '200' then
-            Bwkfanboy::Utils.errx(1, "cannot fetch #{uri} : HTTP responce: #{f.status[0]}")
-          end
-          Bwkfanboy::Utils.veputs(1, "charset = #{f.content_type_parse[1][1]}\n") if defined?(f.meta)
-          if block_given?
-            yield f
-          else
-            return f.read
-          end
-        }
+        uri.each {|i| streams << open(i) }
       rescue
-        # typically Errno::ENOENT
-        Bwkfanboy::Utils.errx(1, "cannot fetch: #{$!}");
+        raise FetchException, "streams: #{$!}"
       end
-
-      return ""
+      
+      raise FetchException, 'streams: failed to open at least 1' if streams.size == 0
+      streams
     end
 
+    def closeStreams streams
+      streams.each {|i| i.close }
+    rescue 
+      # do nothing
+    end
   end
 end

data/lib/bwkfanboy/generator.rb

@@ -0,0 +1,78 @@
+require 'rss/maker'
+require 'msgpack'
+
+module Bwkfanboy
+
+  # TODO: generate this class automatically via something like
+  # Utils.makeExceptClass 'GeneratorException', prefix: 'generator'
+  class GeneratorException < StandardError
+    def initialize msg
+      super msg
+    end
+
+    alias :orig_to_s :to_s
+    def to_s
+      "generator: #{orig_to_s}"
+    end
+  end
+  
+  module Generator
+    extend self
+
+    def unpack stream
+      p = MessagePack::Unpacker.new stream
+      p.each {|i| return i } # p.first or p[0] Messagepack doesn't implement
+      return nil
+    rescue EOFError
+      return nil
+    end
+
+    # [data]  a hash; see Plugin#pack for the exact format.
+    def atom data
+      raise GeneratorException, 'unpacked input is nil' unless data
+      
+      feed = RSS::Maker.make("atom") { |maker|
+        maker.channel.id = data['channel']['id']
+        maker.channel.updated = data['channel']['updated']
+        maker.channel.author = data['channel']['author']
+        maker.channel.title = data['channel']['title']
+        
+        maker.channel.links.new_link {|i|
+          i.href = data['channel']['link']
+          i.rel = 'alternate'
+          i.type = 'text/html' # eh
+        }
+        
+        maker.items.do_sort = true
+
+        data['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 = data['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
+        }
+      }
+
+      feed
+    rescue
+      raise GeneratorException, $!.to_s
+    end
+    
+  end
+end

data/lib/bwkfanboy/home.rb

@@ -0,0 +1,53 @@
+require 'pathname'
+require 'fileutils'
+
+require_relative 'cliconfig'
+
+module Bwkfanboy
+  class Home
+    # Home root directory
+    ROOT = Pathname.new "#{Dir.home}/.#{Meta::NAME.downcase}"
+    PLUGINS = 'plugins'
+    LOGS = 'log'
+
+    SYSTEM_PLUGINS = CliUtils::DIR_LIB_SRC.parent.parent + 'plugins'
+
+    attr_reader :root, :logs
+    attr_accessor :conf
+    
+    # Load config & create all required directories.
+    def initialize dir = nil # yield loader, o
+      @root = (dir && Pathname(dir)) || ROOT
+      @logs = @root + LOGS
+      
+      CliConfig::DIR_CONFIG.unshift @root
+      @conf = CliConfig.new
+      @conf[:plugins_path] = [@root + PLUGINS, SYSTEM_PLUGINS]
+      @conf.load do |o|
+        yield self, o if block_given?
+        o.on('-I DIR', 'Include DIR in search for plugins.') {|i|
+          @conf[:plugins_path] << Pathname.new(i) if File.directory?(i)
+        }
+        o.on('--plugins-path', 'Print all searchable directories.') {
+          print_plugins_path
+          exit EX_OK
+        }
+      end
+      
+      print_env
+      FileUtils.mkdir_p [@conf[:plugins_path], @logs]
+    end
+
+    def print_plugins_path
+      @conf[:plugins_path].each {|i| puts i }
+    end
+
+    def print_env
+      if @conf[:verbose] >= 2
+        puts "Libs dir: #{CliUtils::DIR_LIB_SRC}"
+        pp @conf
+      end
+    end
+
+  end
+end