rbitter 0.0.8 → 0.1.0

data/lib/rbitter/xmlrpcd/xmlrpc_auth_server.rb

@@ -1,84 +1,83 @@
-# encoding: utf-8
-#
-
-require "rbitter/xmlrpcd/rpchandles"
-require "rbitter/xmlrpcd/base"
-require "xmlrpc/server"
-require "webrick"
-
-module XMLRPC
-  class HTTPAuthXMLRPCServer < XMLRPC::WEBrickServlet
-    def extract_method(methodname, *args)
-      for name, obj in @handler
-        if obj.kind_of? Proc
-          next unless methodname == name
-        else
-          next unless methodname =~ /^#{name}(.+)$/
-          next unless obj.respond_to? $1
-          return obj.method($1)
-        end
-      end
-      nil
-    end
-
-    def service(request, response)
-      # Taken from xmlrpc/server.rb
-      if @valid_ip
-        raise WEBrick::HTTPStatus::Forbidden unless @valid_ip.any? { |ip| request.peeraddr[3] =~ ip }
-      end
-
-      if request.request_method != "POST"
-        raise WEBrick::HTTPStatus::MethodNotAllowed,
-              "unsupported method `#{request.request_method}'."
-      end
-
-      if parse_content_type(request['Content-type']).first != "text/xml"
-        raise WEBrick::HTTPStatus::BadRequest
-      end
-
-      length = (request['Content-length'] || 0).to_i
-
-      raise WEBrick::HTTPStatus::LengthRequired unless length > 0
-
-      data = request.body
-
-      if data.nil? or data.bytesize != length
-        raise WEBrick::HTTPStatus::BadRequest
-      end
-
-      # Originally, process(data) was here.
-      # We need to check whether a method requires authorization.
-      rpc_method_name, rpc_params = parser().parseMethodCall(data)
-      rpc_method = extract_method(rpc_method_name)
-
-      if RPCHandles.auth.nil?
-        resp = handle(rpc_method_name, *rpc_params)
-      else
-        if rpc_method.owner.ancestors.include?(RPCHandles::BaseHandle::Auth)
-          # Check cookie and check it's valid
-          if request.cookies.size == 1 \
-            and request.cookies[0].name == "auth_key" \
-            and RPCHandles.auth.include?(request.cookies[0].value)
-            resp = handle(rpc_method_name, *rpc_params)
-          else
-            # Permission required
-            raise WEBrick::HTTPStatus::Forbidden
-          end
-        elsif rpc_method.owner.ancestors.include?(RPCHandles::BaseHandle::NoAuth)
-          resp = handle(rpc_method_name, *rpc_params)
-        else
-          raise WEBrick::HTTPStatus::Forbidden
-        end
-      end
-
-      if resp.nil? or resp.bytesize <= 0
-        raise WEBrick::HTTPStatus::InternalServerError
-      end
-
-      response.status = 200
-      response['Content-Length'] = resp.bytesize
-      response['Content-Type']   = "text/xml; charset=utf-8"
-      response.body = resp
-    end
-  end
+# encoding: utf-8
+
+require "rbitter/xmlrpcd/rpchandles"
+require "rbitter/xmlrpcd/base"
+require "xmlrpc/server"
+require "webrick"
+
+module XMLRPC
+  class HTTPAuthXMLRPCServer < XMLRPC::WEBrickServlet
+    def extract_method(methodname, *args)
+      for name, obj in @handler
+        if obj.kind_of? Proc
+          next unless methodname == name
+        else
+          next unless methodname =~ /^#{name}(.+)$/
+          next unless obj.respond_to? $1
+          return obj.method($1)
+        end
+      end
+      nil
+    end
+
+    def service(request, response)
+      # Taken from xmlrpc/server.rb
+      if @valid_ip
+        raise WEBrick::HTTPStatus::Forbidden unless @valid_ip.any? { |ip| request.peeraddr[3] =~ ip }
+      end
+
+      if request.request_method != "POST"
+        raise WEBrick::HTTPStatus::MethodNotAllowed,
+              "unsupported method `#{request.request_method}'."
+      end
+
+      if parse_content_type(request['Content-type']).first != "text/xml"
+        raise WEBrick::HTTPStatus::BadRequest
+      end
+
+      length = (request['Content-length'] || 0).to_i
+
+      raise WEBrick::HTTPStatus::LengthRequired unless length > 0
+
+      data = request.body
+
+      if data.nil? or data.bytesize != length
+        raise WEBrick::HTTPStatus::BadRequest
+      end
+
+      # Originally, process(data) was here.
+      # We need to check whether a method requires authorization.
+      rpc_method_name, rpc_params = parser().parseMethodCall(data)
+      rpc_method = extract_method(rpc_method_name)
+
+      if RPCHandles.auth.nil?
+        resp = handle(rpc_method_name, *rpc_params)
+      else
+        if rpc_method.owner.ancestors.include?(RPCHandles::BaseHandle::Auth)
+          # Check cookie and check it's valid
+          if request.cookies.size == 1 \
+            and request.cookies[0].name == "auth_key" \
+            and RPCHandles.auth.include?(request.cookies[0].value)
+            resp = handle(rpc_method_name, *rpc_params)
+          else
+            # Permission required
+            raise WEBrick::HTTPStatus::Forbidden
+          end
+        elsif rpc_method.owner.ancestors.include?(RPCHandles::BaseHandle::NoAuth)
+          resp = handle(rpc_method_name, *rpc_params)
+        else
+          raise WEBrick::HTTPStatus::Forbidden
+        end
+      end
+
+      if resp.nil? or resp.bytesize <= 0
+        raise WEBrick::HTTPStatus::InternalServerError
+      end
+
+      response.status = 200
+      response['Content-Length'] = resp.bytesize
+      response['Content-Type']   = "text/xml; charset=utf-8"
+      response.body = resp
+    end
+  end
 end

data/lib/rbitter/xmlrpcd/xmlrpcd.rb

@@ -1,63 +1,69 @@
-# encoding: utf-8
-
-require "rbitter/xmlrpcd/rpchandles"
-require "rbitter/xmlrpcd/xmlrpc_auth_server"
-require "webrick"
-
-module Rbitter
-  RPC_PREFIX="rbitter"
-
-  class RPCServer
-    def initialize bind_host, bind_port
-      @server = WEBrick::HTTPServer.new(:Port => bind_port.to_i, :BindAddress => bind_host.to_s, :MaxClients => 4, :Logger => WEBrick::Log.new($stdout))
-      @core = XMLRPC::HTTPAuthXMLRPCServer.new
-      load_all_handles
-      @core.set_default_handler { |name, *args|
-        "NO_COMMAND: #{name} with args #{args.inspect}"
-      }
-    end
-
-    def load_all_handles
-      Rbitter.env["xmlrpc"]["handles"].each { |path|
-        puts "[xmlrpc] Scanning handles from (#{path})"
-        Dir.entries(path).each { |fname|
-          fname = File.join(path, fname)
-          if File.exist?(fname) and File.file?(fname)
-            if fname.match(/rh_\w+\.rb$/)
-              begin
-                load fname
-              rescue Exception => e
-                # stub
-                puts "Exception while loading #{fname}"
-                puts e.inspect
-              end
-            else
-              puts "Ignored: #{fname}"
-            end
-          end
-        }
-      }
-
-      puts "[xmlrpc] found #{RPCHandles.constants.length} constants."
-      RPCHandles.constants.each { |handler|
-        if RPCHandles.const_get(handler).is_a?(Class)
-          @core.add_handler(RPC_PREFIX, RPCHandles.const_get(handler).new)
-        end
-      }
-    end
-
-    def main_loop
-      puts "RPCServer starts"
-      @server.mount("/", @core)
-      @server.start
-    end
-  end
-end
-
-
-if __FILE__ == $0
-  puts "Local testing server starts..."
-  rpcd = Rbitter::RPCServer.new('127.0.0.1', 1300)
-  rpcd.main_loop
-end
-
+# encoding: utf-8
+
+require "rbitter/xmlrpcd/rpchandles"
+require "rbitter/xmlrpcd/xmlrpc_auth_server"
+require "webrick"
+
+module Rbitter
+  RPC_PREFIX="rbitter"
+
+  class RPCServer
+    def initialize bind_host, bind_port
+      @server = WEBrick::HTTPServer.new(:Port => bind_port.to_i, :BindAddress => bind_host.to_s, :MaxClients => 4, :Logger => WEBrick::Log.new($stdout))
+      @core = XMLRPC::HTTPAuthXMLRPCServer.new
+      @core.set_default_handler { |name, *args|
+        "NO_COMMAND: #{name} with args #{args.inspect}"
+      }
+    end
+
+    def load_all_handles
+      Rbitter["xmlrpc"]["handles"].each { |path|
+        puts "[xmlrpc] Scanning handles from (#{path})"
+        Dir.entries(path).each { |fname|
+          fname = File.join(path, fname)
+          if File.exist?(fname) and File.file?(fname)
+            if fname.match(/rh_\w+\.rb$/)
+              begin
+                load fname
+              rescue Exception => e
+                # stub
+                puts "Exception while loading #{fname}"
+                puts e.inspect
+              end
+            else
+              puts "Ignored: #{fname}"
+            end
+          end
+        }
+      }
+
+      puts "[xmlrpc] found #{RPCHandles.constants.length} constants."
+      RPCHandles.constants.each { |handler|
+        if RPCHandles.const_get(handler).is_a?(Class)
+          @core.add_handler(RPC_PREFIX, RPCHandles.const_get(handler).new)
+        end
+      }
+    end
+
+    def main_loop
+      load_all_handles
+
+      @server.mount("/", @core)
+      @server.start
+
+      puts "[xmlrpc] XMLRPC started"
+    end
+  end
+
+  class DummyRPCServer
+    def initialize bind_host, bind_port; end
+
+    def load_all_handles; end
+
+    def main_loop
+      puts "[xmlrpc] DummyRPCServer started"
+    end
+  end
+
+  class NullRPCServer; end
+end

data/lib/rbitter.rb

@@ -1,92 +1,86 @@
-# encoding: utf-8
-#
-
-require "rbitter/version"
-require "rbitter/arcserver"
-require "rbitter/env"
-require "rbitter/console"
-require "rbitter/xmlrpc"
-
-module Rbitter
-  def self.rbitter_header
-    puts "Rbitter #{VERSION} on Ruby-#{RUBY_VERSION} (#{RUBY_PLATFORM})"
-  end
-
-  def self.rbitter_help_msg  
-    puts "Rbitter is a Twitter streaming archiver, with XMLRPC access."
-    puts "-------"
-    puts "Usage: rbitter (application-mode)"
-    puts "application-mode's are:"
-    puts "|- serve    : Launch Rbitter full system (Streaming + Database + XMLRPC)"
-    puts "|- console  : Launch console application utilizing XMLRPC"
-    puts "|- configure: Write default configuration file 'config.json' in current folder"
-    puts "|- help     : Show this message"
-    puts "`- logs     : Show Rbitter internal logs"
-  end
-
-  def self.prebootstrap
-    # Due to stalled socket problem, If unpatched twitter gem is installed.
-    # Twitter::Streaming::Connection will be monkey-patched.
-    patch_required = false
-
-    if Twitter::Version.const_defined?(:MAJOR)
-      b5_version = Twitter::Version::MAJOR * 10000
-      + Twitter::Version::MINOR * 100 + Twitter::Version::PATCH
-      if b5_version <= 51400
-        warn "[rbitter] Monkey-patching Twitter::Streaming::Connection..."
-        warn "[rbitter] Gem installed on here seemed that it doesn't handle socket read timeout."
-        warn "[rbitter] Please upgrade twitter gem"
-        patch_required = true
-      end
-    else
-      b6_version = Twitter::Version.to_a
-      if b6_version[0] <= 6 and b6_version[1] <= 0 and b6_version[2] <= 0
-        patch_required = true
-      end
-    end
-
-    require "rbitter/libtwitter_connection_override" if patch_required
-  end
-
-  def self.bootstrap args=[]
-    prebootstrap
-
-    if args.length == 0
-      rbitter_header
-    elsif args[0] == "serve"
-      Rbitter.config_initialize
-
-      main = Rbitter::ArcServer.new
-      if env['xmlrpc']['enable']
-        $rpc_service_thread = Thread.new {
-          rpc_server = Rbitter::RPCServer.new(env['xmlrpc']['bind_host'], env['xmlrpc']['bind_port'])
-          rpc_server.main_loop
-        }
-        $rpc_service_thread.run
-      end
-      main.main_loop
-    elsif args[0] == "configure"
-      require "rbitter/default/config_json"
-
-      puts "Writing config.json now"
-      open(File.join(Dir.pwd, "config.json"), "w") { |io|
-        io.write(DEFAULT_CONFIG_JSON)
-      }
-      puts "Writing finished"
-      puts "You can put config.json one of these locations:"
-      puts "[1] config.json (current folder)"
-      puts "[2] .rbitter/config.json (current folder)"
-    elsif args[0] == "console"
-      Rbitter.config_initialize
-
-      con = Rbitter::Console.new
-      con.start
-    elsif args[0] == "logs"
-      # show log in stdout
-      puts "This feature is in heavy development. Sorry."
-    else
-      rbitter_header
-      rbitter_help_msg
-    end
-  end
-end
+# encoding: utf-8
+#
+
+require "rbitter/version"
+require "rbitter/arcserver"
+require "rbitter/env"
+require "rbitter/console"
+require "rbitter/xmlrpc"
+
+module Rbitter
+  BOOTSTRAP_ARGS = ['configure', 'console', 'help', 'logs', 'serve']
+
+  def self.rbitter_header
+    puts "Rbitter #{VERSION} on #{RUBY_VERSION} (#{RUBY_PLATFORM})"
+  end
+
+  def self.rbitter_help_msg  
+    puts "Rbitter is a Twitter streaming archiver, with XMLRPC access."
+    puts "-------"
+    puts "Usage: rbitter (application-mode)"
+    puts "application-mode's are:"
+    puts "|- serve    : Launch Rbitter full system (Streaming + Database + XMLRPC)"
+    puts "|- console  : Launch console application utilizing XMLRPC"
+    puts "|- configure: Write default configuration file 'config.json' in current folder"
+    puts "|- help     : Show this message"
+    puts "`- logs     : Show Rbitter internal logs"
+  end
+
+  def self.prebootstrap
+    # Due to stalled socket problem, If unpatched twitter gem is installed.
+    # Twitter::Streaming::Connection will be monkey-patched.
+    patch_required = false
+
+    if Twitter::Version.const_defined?(:MAJOR)
+      b5_version = Twitter::Version::MAJOR * 10000
+      + Twitter::Version::MINOR * 100 + Twitter::Version::PATCH
+      if b5_version <= 51400
+        warn "[rbitter] Monkey-patching Twitter::Streaming::Connection"
+        warn "[rbitter] Please upgrade twitter gem to apply streaming read timeout"
+        patch_required = true
+      end
+    else
+      b6_version = Twitter::Version.to_a
+      if b6_version[0] <= 6 and b6_version[1] <= 0 and b6_version[2] <= 0
+        patch_required = true
+      end
+    end
+
+    require "rbitter/libtwitter_connection_override" if patch_required
+  end
+
+  def self.bootstrap_configs
+    require "rbitter/default/config_json"
+
+    open(File.join(Dir.pwd, "config.json"), "w") { |io|
+      io.write(DEFAULT_CONFIG_JSON)
+    }
+  end
+
+  def self.bootstrap args=[]
+    return nil if args.length < 1
+    
+    if args[0] == "serve"
+      prebootstrap
+
+      Rbitter.config_initialize
+      
+      archive_server = Rbitter::ArcServer.new
+      archive_server.main_loop
+    elsif args[0] == "help"
+      rbitter_help_msg
+    elsif args[0] == "configure"
+      bootstrap_configs
+    elsif args[0] == "console"
+      Rbitter.config_initialize
+
+      con = Rbitter::Console.new
+      con.start
+    elsif args[0] == "logs"
+      # show log in stdout
+      puts "Log buffer feature is in heavy development. Sorry."
+    else
+      fail StandardError, "Invalid bootstrap parameter: #{args[0]}"
+    end
+  end
+end

data/rbitter.gemspec

@@ -1,42 +1,42 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rbitter/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "rbitter"
-  spec.version       = Rbitter::VERSION
-  spec.authors       = ["Nidev Plontra"]
-  spec.email         = ["nidev.plontra@gmail.com"]
-  spec.summary       = %q{Rbitter is a Twitter client specialized in archiving}
-  spec.description   = %q{Rbitter archives all tweets appeared on user streaming using ActiveRecord. XMLRPC is used to serve archived tweets and useful features}
-  spec.homepage      = "https://github.com/nidev/rbitter"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  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_dependency 'twitter', '~> 5.14'
-  spec.add_dependency 'json', '~> 1.7'
-  spec.add_dependency 'ripl', '~> 0'
-  spec.add_dependency 'activerecord', '~> 4.0'
-
-  if RUBY_PLATFORM == 'java'
-    spec.add_dependency 'activerecord-jdbc-adapter', '~> 1.3'
-    spec.add_dependency 'jdbc-sqlite3', '~> 3.8'
-    spec.add_dependency 'jdbc-mysql', '~> 5.1'
-    spec.add_dependency 'activerecord-jdbcsqlite3-adapter', '~> 1.3'
-    spec.add_dependency 'activerecord-jdbcmysql-adapter', '~> 1.3'
-  else
-    spec.add_dependency 'sqlite3', '~> 1.3'
-    spec.add_dependency 'mysql2', '~> 0.3'
-    spec.add_dependency 'activerecord-mysql2-adapter', '~> 0.0.3'
-  end
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-end
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rbitter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rbitter"
+  spec.version       = Rbitter::VERSION
+  spec.authors       = ["Nidev Plontra"]
+  spec.email         = ["nidev.plontra@gmail.com"]
+  spec.summary       = %q{Rbitter is a Twitter client specialized in archiving}
+  spec.description   = %q{Rbitter archives all tweets appeared on user streaming using ActiveRecord. XMLRPC is used to serve archived tweets and useful features}
+  spec.homepage      = "https://github.com/nidev/rbitter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'twitter', '~> 5.14'
+  spec.add_dependency 'json', '~> 1.7'
+  spec.add_dependency 'ripl', '~> 0.7'
+  spec.add_dependency 'activerecord', '~> 4.0'
+
+  if RUBY_PLATFORM == 'java'
+    spec.add_dependency 'activerecord-jdbc-adapter', '~> 1.3'
+    spec.add_dependency 'jdbc-sqlite3', '~> 3.8'
+    spec.add_dependency 'jdbc-mysql', '~> 5.1'
+    spec.add_dependency 'activerecord-jdbcsqlite3-adapter', '~> 1.3'
+    spec.add_dependency 'activerecord-jdbcmysql-adapter', '~> 1.3'
+  else
+    spec.add_dependency 'sqlite3', '~> 1.3'
+    spec.add_dependency 'mysql2', '~> 0.3'
+    spec.add_dependency 'activerecord-mysql2-adapter', '~> 0.0.3'
+  end
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/config/default.json

@@ -1,33 +1,33 @@
-{
-  "twitter": {
-    "consumer_key": "",
-    "consumer_secret": "",
-    "access_token": "",
-    "access_token_secret": ""
-  },
-  "activerecord": "sqlite3",
-  "sqlite3": {
-    "dbfile": "rbitter.sqlite"
-  },
-  "mysql2": {
-    "host": "localhost",
-    "port": 3306,
-    "dbname": "archive",
-    "username": "",
-    "password": ""
-  },
-  "media_downloader": {
-    "cacert_path": "/cacerts/cacert.pem",
-    "download_dir": "imgs/"
-  },
-  "xmlrpc": {
-    "enable": true,
-    "bind_host": "0.0.0.0",
-    "bind_port": 1400,
-    "auth": {
-      "username": "username",
-      "password": "password"
-    },
-    "handles": ["/path/to/handles"]
-  }
+{
+  "twitter": {
+    "consumer_key": "",
+    "consumer_secret": "",
+    "access_token": "",
+    "access_token_secret": ""
+  },
+  "activerecord": "sqlite3",
+  "sqlite3": {
+    "dbfile": "rbitter.sqlite"
+  },
+  "mysql2": {
+    "host": "localhost",
+    "port": 3306,
+    "dbname": "archive",
+    "username": "",
+    "password": ""
+  },
+  "media_downloader": {
+    "cacert_path": "/cacerts/cacert.pem",
+    "download_dir": "imgs/"
+  },
+  "xmlrpc": {
+    "enable": true,
+    "bind_host": "0.0.0.0",
+    "bind_port": 1400,
+    "auth": {
+      "username": "username",
+      "password": "password"
+    },
+    "handles": ["/path/to/handles"]
+  }
 }