rbitter 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f1a1e7507e94a8e8fa04802986c0c01d9277e5b
-  data.tar.gz: 410d9d4a7107d40394706f01a2f2af34b482a5b1
+  metadata.gz: 44878b7491619cb57321ab471e8b03279180932b
+  data.tar.gz: a1dbfc5622f0d65b9aa256992a18b8523d425b0d
 SHA512:
-  metadata.gz: 7f58e87ad4cb1ddd5f31d4fe1d9f0672aaf1e48d65630b16a019f33e8b8d034f9d7ec727fce4f2e8c3d3d1154ada8845b421d0d9efba2ba2ddb7d3ccb9cb9348
-  data.tar.gz: 8331188a07b56e71855333703197016e89f634efd006e4ec5709abaf116a07afc9388ad7685f6b0bb0abda3d4b154f50f348b007f77584ad438d88ddcefa1aa5
+  metadata.gz: d82fc7a0b2158f54aacd644d31aad960614f89615b0c4b471fab30d3fd304627cb2f72aae757d141af4bc4267c6bbf7d0140b68f249833a85bdcebd346feead1
+  data.tar.gz: a7c43429c676d18247d8fb274956e289ef537b7fe832f8240f869c0748263e36b6e14ab3702bc72e2b81dd5fec9723a83c8de25e50d8ce4214be7bf14027857e

data/.gitignore

@@ -1,21 +1,21 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/build/
-/vendor/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-*.gem
-*.json
-*.sqlite
-.rbitter
-.rbitter/*
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/build/
+/vendor/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+*.json
+*.sqlite
+.rbitter
+.rbitter/*

data/.rspec

@@ -1,2 +1,2 @@
---color
---require spec_helper
+--color
+--require spec_helper

data/.travis.yml

@@ -1,9 +1,15 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.1.0
-  - 2.2.0
-  - ruby-head
-  - jruby-19mode
-  - jruby-head
-  - rbx-2
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - 2.2.0
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+
+env: LANG="en_US.UTF-8" LC_ALL="en_US.UTF-8"
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-2

data/Gemfile

@@ -1,11 +1,12 @@
-source "https://rubygems.org"
-
-group :test do
-  gem 'rspec', '~>3.0'
-  gem 'simplecov', :require => false, :group => :test
-end
-
-gem "bundler"
-gem 'jruby-openssl', platforms: :jruby
-
-gemspec
+source "https://rubygems.org"
+
+group :test do
+  gem 'rspec', '~>3.0'
+  gem 'simplecov', :require => false, :group => :test
+  gem 'coveralls', :require => false
+end
+
+gem "bundler"
+gem 'jruby-openssl', platforms: :jruby
+
+gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2015 Nidev Plontra
-
-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.
+Copyright (c) 2015 Nidev Plontra
+
+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/README.md

@@ -1,19 +1,22 @@
 # Rbitter #
 [![Build Status](https://travis-ci.org/nidev/rbitter.svg?branch=master)](https://travis-ci.org/nidev/rbitter)
+[![Gem Version](https://badge.fury.io/rb/rbitter.svg)](http://badge.fury.io/rb/rbitter)
+[![Coverage Status](https://coveralls.io/repos/nidev/rbitter/badge.svg?branch=master)](https://coveralls.io/r/nidev/rbitter?branch=master)
 
 Rbitter is a Twitter streaming client specialized in tweet archiving with remote access via XMLRPC, which is written in Ruby.
 
-You can save all tweets appeared on timeline and watch them later.
-
-**Rbitter can be built into a Ruby gem by typing 'gem build rbitter.gemspec'. It is not yet uploaded due to testing.**
+You can save all tweets appeared on your home timeline and watch them later.
 
 ## Requirements ##
+Rbitter is tested under [MRI](https://www.ruby-lang.org), [JRuby](http://jruby.org) and [Rubinius](http://rubini.us). So you can choose one of these implementations.
+
+It can run under both Windows and Linux.
 
-'bundle update' may install every gem Rbitter needs.
+Gem dependencies will be installed during installation of this gem.
 
-Ruby 2.0.0 or above
-Sqlite3
-Mysql(MariaDB)
+* Ruby 1.9.3 or above
+* Sqlite3
+* Mysql(MariaDB)
 
 ## Configuration ##
 You can simply manipulate default configuration file by:
@@ -24,16 +27,13 @@ $ rbitter configure
 
 Put your customized config.json to one of below locations.
 
-1. $HOME/config.json
-2. $HOME/.rbitter/config.json
-3. ./config.json (current folder)
-4. ./.rbitter/config.json (current folder)
-
-For location #3 and #4, they're referred when #1 and #2 are not available. In those cases, *rbitter* must be executed from the directory where config.json exists.
+1. ./config.json (current folder)
+2. ./.rbitter/config.json (current folder)
 
 ## Set up and run ##
-1. With config.json,
-2. Get Twitter token and copy them properly.
+With config.json,
+
+1. Get Twitter token and copy them properly.
 2. Choose preferred ActiveRecord backend.
 3. Modify default location where Twitter images are downloaded.
 4. Configure XMLRPC server
@@ -55,7 +55,14 @@ See XMLRPC.md
 ## Issue report or feature request ##
 It's recommended to open an issue even it seemed too small. A small flaw may result in instability or bad situation. So every feature requests/bug reports are welcomed.
 
-Please attach stack trace, Ruby version, and detail description.
+Please attach stack trace, Ruby version, Rbitter version, and detail description.
+
+If you installed from [RubyGems], please report with Git tag. Git tag is your gem version.
+
+[RubyGems]: https://rubygems.org
+
+## Application Versioning ##
+Rbitter follows [Sementic Versioning 2.0](http://semver.org/spec/v2.0.0.html).
 
 ## Disclaimer ##
 Rbitter is intended for personal usage. Archived data should not be shared over Internet. Please keep them secure and safe, and protect privacy.

data/Rakefile

@@ -1,8 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new
-
-task :default => :spec
-task :basic_test => :spec
-
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :basic_test => :spec
+

data/XMLRPC.md

@@ -1,19 +1,19 @@
-# What is RPC handle ? #
-## Commands ##
-### Authentication ###
-### Revoke Authentication Token ###
-### Echo ###
-### Last Active ###
-### Retriever ###
-### Statistic ###
-# How to write own RPC handle? #
-RPC handle is a Ruby class. Writing a method in Ruby class, that's it. Names of methods are treated as XMLRPC command.
-
-When you write a new class for your own RPC handle, you must inherit either Auth or NoAuth class from rpc/base.rb.
-
-* class Auth < Object: Methods in a Ruby class inheriting Auth requires *auth_key* to access.
-* class NoAuth < Object: Methods in a Ruby class inheriting NoAuth doesn't require *auth_key* and these XMLRPC commands can be called by anonymous user.
-
-Filename should start with 'rh_'. It's prefix to be autoloaded by xmlrpc.rb.
-
-Refer rpc/rh_echo.rb as an example.
+# What is RPC handle ? #
+## Commands ##
+### Authentication ###
+### Revoke Authentication Token ###
+### Echo ###
+### Last Active ###
+### Retriever ###
+### Statistic ###
+# How to write own RPC handle? #
+RPC handle is a Ruby class. Writing a method in Ruby class, that's it. Names of methods are treated as XMLRPC command.
+
+When you write a new class for your own RPC handle, you must inherit either Auth or NoAuth class from rpc/base.rb.
+
+* class Auth < Object: Methods in a Ruby class inheriting Auth requires *auth_key* to access.
+* class NoAuth < Object: Methods in a Ruby class inheriting NoAuth doesn't require *auth_key* and these XMLRPC commands can be called by anonymous user.
+
+Filename should start with 'rh_'. It's prefix to be autoloaded by xmlrpc.rb.
+
+Refer rpc/rh_echo.rb as an example.

data/bin/rbitter

@@ -1,6 +1,20 @@
-#!/usr/bin/env ruby
-
-require "rbitter"
-
-Rbitter.bootstrap(ARGV)
-
+#!/usr/bin/env ruby
+
+require "rbitter"
+
+Rbitter.rbitter_header
+
+if ARGV.length < 1 || (not Rbitter::BOOTSTRAP_ARGS.include?(ARGV[0]))
+  Rbitter.rbitter_help_msg
+  exit -1
+else
+  Rbitter.bootstrap(ARGV)
+
+  if ARGV[0] == "configure"
+    puts "Writing config.json done"
+    puts "You can put config.json one of these locations:"
+    puts "[1] config.json (current folder)"
+    puts "[2] .rbitter/config.json (current folder)"
+  end
+end
+

data/lib/rbitter/arcserver.rb

@@ -1,97 +1,126 @@
-# encoding: utf-8
-
-require "json"
-require "date"
-require "twitter"
-require "resolv"
-
-require "rbitter/records"
-require "rbitter/streaming"
-require "rbitter/dlthread"
-require "rbitter/xmlrpc"
-
-module Rbitter
-  class ArcServer
-    def initialize
-      ARSupport.connect_database
-
-      if not ARSupport.prepared?
-        puts "Initiate database table..."
-        if Rbitter.env['activerecord'] == 'mysql2'
-          ARSupport.prepare "DEFAULT CHARSET=utf8mb4"
-        else
-          ARSupport.prepare
-        end
-      end
-
-      ARSupport.update_database_scheme
-
-      @t = StreamClient.new(Rbitter.env['twitter'].dup)
-      @dt = DLThread.new(Rbitter.env['media_downloader']['download_dir'], Rbitter.env['media_downloader']['cacert_path'])
-    end
-
-    def write_marker(message)
-      Record.create({:marker => 1,
-        :marker_msg => message, 
-        :userid => nil,
-        :username => nil,
-        :tweetid => nil,
-        :tweet => nil,
-        :date => ARSupport.any_to_datestring(DateTime.now),
-        :rt_count => 0,
-        :fav_count => 0})
-    end
-
-    def write_init_marker
-      write_marker "Archiving service started"
-    end
-
-    def write_halt_marker
-      write_marker "Archiving service halted"
-    end
-
-    def main_loop
-      begin
-        write_init_marker
-        @t.run { |a|
-          record = Record.find_or_initialize_by(tweetid: a['tweetid'])
-          record.update({:marker => 0,
-            :marker_msg => "normal", 
-            :userid => a['userid'],
-            :username => a['screen_name'],
-            :tweetid => a['tweetid'],
-            :tweet => a['tweet'],
-            :date => a['date'],
-            :rt_count => a['rt_count'],
-            :fav_count => a['fav_count']})
-
-          record.save
-          @dt.execute_urls(a['media_urls'])
-        }
-      rescue Interrupt => e
-        puts ""
-        puts "Interrupted..."
-        if Rbitter.env['xmlrpc']['enable']
-          puts "Finishing RPCServer"
-          if $rpc_service_thread.alive?
-            $rpc_service_thread.terminate
-            $rpc_service_thread.join
-          end
-        end
-        exit 0
-      rescue Twitter::Error::Unauthorized => e
-        puts "Please configure your Twitter token on config.json."
-        exit -1
-      rescue Twitter::Error::ServerError, Resolv::ResolvError => e
-        puts "Service unavailable now. Retry in 5 second..."
-        sleep 5
-        retry
-      rescue Twitter::Error => e
-        puts "Twitter Error: #{e.inspect}"
-        exit -1
-      ensure
-        write_halt_marker
-      end
-    end
-  end
-end
+# encoding: utf-8
+
+require "json"
+require "date"
+require "twitter"
+require "resolv"
+
+require "rbitter/records"
+require "rbitter/streaming"
+require "rbitter/dlthread"
+require "rbitter/xmlrpc"
+
+module Rbitter
+  class ArcServer
+    LOG_NORMAL = 0
+    LOG_INIT = 1
+    LOG_HALT = 2
+
+    def initialize(xmlrpcd_class = Rbitter::RPCServer)
+      @xmlrpcd_class = xmlrpcd_class
+
+      ARSupport.connect_database
+
+      if not ARSupport.prepared?
+        puts "Initiate database table..."
+        if Rbitter['activerecord'] == 'mysql2'
+          ARSupport.prepare "DEFAULT CHARSET=utf8mb4"
+        else
+          ARSupport.prepare
+        end
+      end
+
+      ARSupport.update_database_scheme
+
+      @dt = DLThread.new(
+        Rbitter['media_downloader']['download_dir'],
+        Rbitter['media_downloader']['cacert_path'],
+        Rbitter['media_downloader']['large_image'])
+    end
+
+    def xmlrpcd_start
+      if Rbitter['xmlrpc']['enable']
+        @rpc_service = Thread.new {
+          rpc_server = @xmlrpcd_class.new(Rbitter['xmlrpc']['bind_host'], Rbitter['xmlrpc']['bind_port'])
+          rpc_server.main_loop
+        }
+      else
+        @rpc_service = nil
+      end
+    end
+
+    def xmlrpcd_stop
+      unless @rpc_service.nil?
+        if @rpc_service.alive?
+          puts "Finishing RPCServer (impl: #{@xmlrpcd_class})"
+          @rpc_service.terminate
+          @rpc_service.join
+          @rpc_service = nil
+        end
+      end
+    end
+
+    def mark(code, message)
+      Record.create({:marker => code,
+        :marker_msg => message, 
+        :userid => nil,
+        :username => nil,
+        :tweetid => nil,
+        :replyto => nil,
+        :tweet => nil,
+        :date => ARSupport.any_to_datestring(DateTime.now),
+        :rt_count => 0,
+        :fav_count => 0})
+    end
+
+    def write_init_marker
+      mark(LOG_INIT, "Archiving service started")
+    end
+
+    def write_halt_marker
+      mark(LOG_HALT, "Archiving service halted")
+    end
+
+    def main_loop(streaming_adapter = Rbitter::StreamClient)
+      xmlrpcd_start if Rbitter['xmlrpc']['enable']
+
+      begin
+        write_init_marker
+
+        streaming_adapter.new(Rbitter['twitter'].dup).run { |a|
+          @dt << a['media_urls']
+
+          record = Record.find_or_initialize_by(tweetid: a['tweetid'])
+          record.update({:marker => 0,
+            :marker_msg => "normal", 
+            :userid => a['userid'],
+            :username => a['screen_name'],
+            :tweetid => a['tweetid'],
+            :replyto => a['replyto'],
+            :tweet => a['tweet'],
+            :date => a['date'],
+            :rt_count => a['rt_count'],
+            :fav_count => a['fav_count']})
+
+          record.save
+        }
+      rescue Interrupt => e
+        puts ""
+        puts "Interrupted..."
+      rescue Twitter::Error::Unauthorized => e
+        puts "Please configure your Twitter token on config.json."
+      rescue Twitter::Error::ServerError, Resolv::ResolvError => e
+        puts "Service unavailable now. Retry in 5 second..."
+        sleep 5
+        retry
+      rescue Twitter::Error => e
+        puts "Twitter Error: #{e.inspect}"
+      ensure
+        xmlrpcd_stop if Rbitter['xmlrpc']['enable']
+        @dt.job_cleanup
+
+        write_halt_marker
+      end
+    end
+  end
+end