runoff 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 916e6a7065a8cc0db0d4d1622ec2b4ef22a6d81e
-  data.tar.gz: a9294104f13e7413cb485ac18985e843ffe2125d
+  metadata.gz: d4aeef27e77018f295faf0e6f43909ddf9516f71
+  data.tar.gz: 13d13befb22b12e797673c36448a44dfed2467e8
 SHA512:
-  metadata.gz: 719fd36c30dc187090d40894a858a3bcd8c1767743c3ff09df9d31771b837e26f721e7a667b56c0e29e6355f8b7524343f60d565fa3fa09b1e699c4102240a36
-  data.tar.gz: 02d6a60b016a2639b3ab2aa94826061c2a0140bc4c00ddc5793fd49b1ae931e218fc5c0587a38d0495a30f48117f178ab4fac67516cecf7dcf66b99bd25d3878
+  metadata.gz: 2a739d9f63e5176c2563de12886bf4bfcddaf955446e55a6a714d734710e3a3743218569ca6fd78c25677f598eb2fed56b04fd6ccf8e3d04632fa78d9bf2d835
+  data.tar.gz: d58f520e774251942f003a61adcb6576364db95d0656b39584157fe7ea37eaae6a4338f4f5ebf896f15a690c195af89878d76bb160f44d4a831c4f6052729511

data/.gitignore

@@ -1,18 +1,32 @@
 *.gem
 *.rbc
-.bundle
-.config
-.yardoc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.DS_Store
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# additional stuff
+.DS_Store

data/README.md

@@ -1,9 +1,9 @@
 # runoff
 ## About
 
-A few years ago I had enough of loosing my Skype chat history every time I reinstalled the operating system, so I decided to write a small application that could export it as plain text files. The application is called [SDBR](https://github.com/arvislacis/SDBR) and it is an open source project that I do not  maintain anymore. Why? I could say that I lost my interest in it, but the real reason probably is the implementation.
+A few years ago I had enough of loosing my Skype chat history every time I reinstalled the operating system, so I decided to write a small application that could export it as plain text files. The application was called SDBR and it was an open source project that I do not  maintain anymore. Why? I could say that I lost my interest in it, but the real reason probably is the implementation.
 
-SDBR is written in C# using WPF, therefore it runs only on Windows. Moreover, it is a GUI application. Yeah, that's a problem, because you don't need the GUI for this kind of functionality. runoff is a command-line tool, that automates the process of exporting your chat history.
+SDBR was written in C# using WPF, therefore it ran only on Windows. Moreover, it was a GUI application. Yeah, that's a problem, because you don't need the GUI for this kind of functionality. runoff is a command-line tool, that automates the process of exporting your chat history.
 
 ## Install
 
@@ -26,12 +26,18 @@ To export specific chats.
 
     runoff some skype_username
 
-If you don't want to put files into an archive, use `--no-archive` option
+If you don't want to put files into an archive, use `--no-archive` option.
 
     runoff all skype_username --no-archive
 
     runoff some skype_username --no-archive
 
+Sometimes you might want to use the exported data in a different app, therefore runoff has an option to export in JSON instead of TXT. You just need to specify an adapter using `-A` option.
+
+    runoff all skype_username -A json
+
+The resulting JSON file contains an array of objects with 3 keys: `date`, `user` and `message`. Each object represents a single chat record.
+
 ## What else?
 
 Things to do in the future versions:

data/bin/runoff

@@ -1,58 +1,31 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
-require 'commander/import'
-require 'runoff'
 require 'colorize'
 
-program :name, 'runoff'
-program :version, Runoff::VERSION
-program :description, 'runoff is a simple application to create Skype backups'
-program :help, 'Author', 'Aigars Dzerviniks <dzerviniks.aigars@outlook.com>'
-
-default_command :help
-
-command :all do |c|
-  c.syntax = 'runoff all [SKYPE_USERNAME] [OPTIONS]'
-  c.description = 'Export all chat history'
-  c.option '-f', '--from FILE', 'Location of the main.db file'
-  c.option '-d', '--destination DIR', 'Location for the exoprted files'
-  c.option '--[no-]archive', 'Indicates whether to create an archive'
-
-  c.action do |args, options|
-    begin
-      puts "Exporting...".colorize :green
-      Runoff::Commands::All.process args, options
-      puts "Export finished.".colorize :green
-    rescue ArgumentError => e
-      puts e.message.colorize :red
-    rescue Sequel::DatabaseError
-      puts "Error: To use runoff you must make sure that the Skype is not running".colorize :red
-    rescue StandardError => e
-      puts e.message.colorize :red
-    end
-  end
-end
-
-command :some do |c|
-  c.syntax = 'runoff some [SKYPE_USERNAME] [OPTIONS]'
-  c.description = "Export only some chats' history"
-  c.option '-f', '--from FILE', 'Location of the main.db file'
-  c.option '-d', '--destination DIR', 'Location for the exoprted files'
-  c.option '--[no-]archive', 'Indicates whether to create an archive'
-
-  c.action do |args, options|
-    begin
-      puts "Exporting...".colorize :green
-      Runoff::Commands::Some.process args, options
-      puts "Export finished.".colorize :green
-    rescue ArgumentError => e
-      puts e.message.colorize :red
-    rescue Sequel::DatabaseError
-      puts "Error: To use runoff you must make sure that the Skype is not running".colorize :red
-    rescue StandardError => e
-      puts e.message.colorize :red
-    end
-  end
+require_relative '../lib/runoff/commandline/none'
+require_relative '../lib/runoff/commandline/all'
+require_relative '../lib/runoff/commandline/some'
+
+options  = { archive: true, adapter: 'TxtAdapter' }
+available_commands = {
+  '_none' => Runoff::Commandline::None.new(options),
+  'all'   => Runoff::Commandline::All.new(options),
+  'some'  => Runoff::Commandline::Some.new(options)
+}
+
+available_commands['_none'].parser.order!
+command = available_commands[ARGV.shift]
+
+if command
+  command.parser.order!
+  command.parser.parse!
+
+  #begin
+    command.execute ARGV
+  #rescue StandardError => e
+  #  warn e.message.colorize :red
+  #  puts 'Terminated.'.colorize :yellow
+  #end
+else
+  puts available_commands['_none'].parser.help
 end

data/lib/runoff/adapters/adapter.rb

@@ -0,0 +1,31 @@
+module Runoff
+  module Adapters
+    class Adapter
+      protected
+
+      # Internal: Converts a Unix timestamp to a datetime string.
+      #
+      # timestamp - An integer with a Unix timestamp value.
+      #
+      # Examples
+      #
+      #   format_timestamp 1397852412
+      #   # => "2014-18-04 20:20:12"
+      #
+      # Returns a datetime string in a format of YYY-DD-MM HH:MM::SS
+      def format_timestamp(timestamp)
+        Time.at(timestamp).strftime '%Y-%m-%d %H:%M:%S'
+      end
+
+      # Internal: Skip.
+      def format_from_dispname(dispname)
+        dispname
+      end
+
+      # Internal: Skip.
+      def format_body_xml(xml_content)
+        xml_content
+      end
+    end
+  end
+end

data/lib/runoff/adapters/json_adapter.rb

@@ -0,0 +1,88 @@
+require 'json'
+
+module Runoff
+  module Adapters
+    class JsonAdapter < Adapter
+      # Public: A format String used to build a single entry.
+      ENTRY_FORMAT = '{ "date": "%s", "user": "%s", "message": %s }'
+
+      # Public: Builds a single entry.
+      #
+      # row - An Array containing a single row of data from the database.
+      #
+      # Examples
+      #
+      #   build_entry { chatname: "#first_user/$second_user;d3d86c6b0e3b8320" ... }
+      #   # => "{ "date": "2014-04-18 20:20:12", "user": "first_user", "message": "This is a text" }"
+      def build_entry(row)
+        formated_data = []
+
+        # NOTE: The first column in the array is used for the grouping by id and
+        # the second is used for the filename.
+        Runoff::COLUMNS[2..-1].each do |column|
+          formated_data << send("format_#{column}", row[column])
+        end
+
+        ENTRY_FORMAT % formated_data
+      end
+
+      # Public: returns a file name.
+      #
+      # chatname - A String with a Skype chatname
+      #
+      # Examples
+      #
+      #   get_file_name "#first_user/$second_user;d3d86c6b0e3b8320"
+      #   # => first_user_second_user.json
+      #
+      # Returns a valid file name.
+      def get_file_name(chatname)
+        parse_chatname(chatname) + '.json'
+      end
+
+      # Public: Parses a chatname into a human readable name.
+      #
+      # raw_chatname - A String with a Skype chatname.
+      #
+      # Examples
+      #
+      #   parse_chatname "#first_user/$second_user;d3d86c6b0e3b8320"
+      #   # => first_user_second_user
+      #
+      # Returns a valid name.
+      def parse_chatname(raw_chatname)
+        pattern = /^#(.*)\/\$(.*);.*$/
+        parts = raw_chatname.match(pattern).captures
+
+        parts.reject(&:empty?).join('_')
+      end
+
+      # Public: Formats the provided data buffer so that it could be writter to
+      #         a JSON file.
+      #
+      # buffer - An Array containing all the chat entries.
+      #
+      # Returns a String
+      def format_file_content(buffer)
+        content = buffer.join(",\n")
+
+        "[#{content}]"
+      end
+
+      protected
+
+      # Internal: Escapes the message body so that it could be used in a JSON string
+      #
+      # xml_content - A String containing the chat message
+      #
+      # Examples
+      #
+      #   format_body_xml 'foo' # => "\"foo\""
+      #
+      # Returns a String
+      def format_body_xml(xml_content)
+        JSON.generate(xml_content, quirks_mode: true)
+      end
+    end
+  end
+end

data/lib/runoff/adapters/txt_adapter.rb

@@ -0,0 +1,69 @@
+module Runoff
+  module Adapters
+    class TxtAdapter < Adapter
+      # Public: A format String used to build a single entry.
+      ENTRY_FORMAT = "[%s] %s: %s"
+
+      # Public: Builds a single entry.
+      #
+      # row - An Array containing a single row of data from the database.
+      #
+      # Examples
+      #
+      #   build_entry { chatname: "#first_user/$second_user;d3d86c6b0e3b8320" ... }
+      #   # => "[2014-04-18 20:20:12] first_user: This is a text"
+      def build_entry(row)
+        formated_data = []
+
+        # NOTE: The first column in the array is used for the grouping by id and
+        # the second is used for the filename.
+        Runoff::COLUMNS[2..-1].each do |column|
+          formated_data << send("format_#{column}", row[column])
+        end
+
+        ENTRY_FORMAT % formated_data
+      end
+
+      # Public: returns a file name.
+      #
+      # chatname - A String with a Skype chatname
+      #
+      # Examples
+      #
+      #   get_file_name "#first_user/$second_user;d3d86c6b0e3b8320"
+      #   # => first_user_second_user.txt
+      #
+      # Returns a valid file name.
+      def get_file_name(chatname)
+        parse_chatname(chatname) + '.txt'
+      end
+
+      # Public: Parses a chatname into a human readable name.
+      #
+      # raw_chatname - A String with a Skype chatname.
+      #
+      # Examples
+      #
+      #   parse_chatname "#first_user/$second_user;d3d86c6b0e3b8320"
+      #   # => first_user_second_user
+      #
+      # Returns a valid name.
+      def parse_chatname(raw_chatname)
+        pattern = /^#(.*)\/\$(.*);.*$/
+        parts = raw_chatname.match(pattern).captures
+
+        parts.reject(&:empty?).join('_')
+      end
+
+      # Public: Formats the provided data buffer so that it could be writter to
+      #         a text file.
+      #
+      # buffer - An Array containing all the chat entries.
+      #
+      # Returns a String
+      def format_file_content(buffer)
+        buffer.join("\n")
+      end
+    end
+  end
+end

data/lib/runoff/chat.rb

@@ -0,0 +1,38 @@
+require 'sequel'
+require 'set'
+
+module Runoff
+  # Public: Reads data from the SQLite database used by Skype/
+  class Chat
+
+    # Public: Initializes a Chat object.
+    #
+    # db_location - A String with a path to the database file.
+    def initialize(db_location, options)
+      @messages = Sequel.sqlite(db_location)[Runoff::TABLE]
+      @adapter  = Object.const_get("Runoff::Adapters::#{options[:adapter]}").new
+    end
+
+    # Public: Returns a list of all the records in the databse.
+    def get_messages
+      @messages.select(*Runoff::COLUMNS).all.sort_by do |row|
+        [row[Runoff::COLUMNS[0]], row[Runoff::COLUMNS[2]]]
+      end
+    end
+
+    # Public: Creates a collection with all chats available for export.
+    #
+    # Returns a Set with hashes e.g. [{ id: 12, name: "chatname" }, ... ]
+    def get_chatname_options
+      options = Set.new
+
+      @messages.select(*Runoff::COLUMNS[0..1]).each do |row|
+        readable_name = @adapter.parse_chatname row[Runoff::COLUMNS[1]]
+
+        options << { id: row[Runoff::COLUMNS[0]], name: readable_name }
+      end
+
+      options
+    end
+  end
+end

data/lib/runoff/commandline/all.rb

@@ -0,0 +1,53 @@
+require_relative 'command'
+
+module Runoff
+  # Public: Command classes used by the executable.
+  module Commandline
+    # Public: A command class that is used to export all chat history.
+    #
+    # Examples
+    #
+    #   command = All.new { archive: true }
+    #   command.execute [ 'skype_username' ]
+    class All < Command
+      # Public: initialize a new All command object.
+      #
+      # options - A Hash of commandline options (default { archive: true, adapter: 'TxtAdapter' }).
+      def initialize(options = {})
+        @options = options
+        @parser = OptionParser.new do |opts|
+          opts.banner = 'Exports all chats: runoff all [SKYPE_USERNAME] [OPTIONS]'
+          opts.on '-h', '--help', 'Displays help' do
+            puts opts
+            exit
+          end
+
+          opts.on '-f', '--from PATH', 'Specifies the location of the database file (main.db)' do |path|
+            @options[:from] = path
+          end
+
+          opts.on '-d', '--destination PATH', 'Changes the default path for the exported files' do |path|
+            @options[:destination] = path
+          end
+
+          opts.on '-a', '--[no-]archive', 'Toggles archiving feature' do |enable|
+            @options[:archive] = enable
+          end
+
+          opts.on '-A', '--adapter [NAME]', 'Uses a specific file type adapter' do |adapter|
+            @options[:adapter] = adapter.capitalize + 'Adapter'
+          end
+        end
+      end
+
+      # Public: executes the command.
+      #
+      # args - An Array of commandline arguments.
+      def execute(args)
+        super args do |chat, file_writer|
+          file_writer.write chat.get_messages
+        end
+      end
+    end
+  end
+end

data/lib/runoff/commandline/command.rb

@@ -0,0 +1,34 @@
+require 'optparse'
+require 'colorize'
+
+require_relative '../../runoff'
+
+module Runoff
+  # Public: Command classes used by the executable.
+  module Commandline
+    # Public: A base class for all runoff commands except None.
+    #
+    # Should be used only by inheriting.
+    class Command
+      # Public: Returns an OptionParser object
+      attr_reader :parser
+
+      # Public: executes the command.
+      #
+      # args - An Array of commandline arguments.
+      def execute(args)
+        puts 'Exporting...'.colorize :green
+
+        db_location = Location.get_database_path args, @options
+        chat = Chat.new db_location, @options
+        file_writer = FileWriter.new @options
+
+        yield chat, file_writer if block_given?
+
+        file_writer.archive if @options[:archive]
+
+        puts 'Finished.'.colorize :green
+      end
+    end
+  end
+end

data/lib/runoff/commandline/none.rb

@@ -0,0 +1,45 @@
+require 'optparse'
+require_relative '../../runoff.rb'
+
+module Runoff
+  # Public: Command classes used by the executable.
+  module Commandline
+    # Public: The default class that is used when the executable is called
+    #         without any commands.
+    #
+    # Examples
+    #
+    #   command = None.new { archive: false }
+    class None
+      # Public: Returns an OptionParser object
+      attr_reader :parser
+
+      # Public: initialize a new None command object.
+      #
+      # options - A Hash of commandline options (default { archive: false }).
+      def initialize(options = {})
+        @option = options
+        @parser = OptionParser.new do |opts|
+          opts.banner = <<END
+  runoff - a simple application to create Skype backups
+
+  Usage:
+
+    runoff <COMMAND> [SKYPE_USERNAME] [OPTIONS]
+
+END
+
+          opts.on '-h', '--help', 'Displays help' do
+            puts opts
+            exit
+          end
+
+          opts.on '-v', '--version', 'Displays a version number' do
+            puts Runoff::VERSION
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/runoff/commandline/some.rb

@@ -0,0 +1,84 @@
+require_relative 'command'
+require 'pry'
+
+module Runoff
+  # Public: Command classes used by the executable.
+  module Commandline
+    # Public: A command class that is used to export specified chat history.
+    #
+    # Examples
+    #
+    #   command = Some.new { archive: true }
+    #   command.execute [ 'skype_username' ]
+    class Some < Command
+      # Public: initialize a new All command object.
+      #
+      # options - A Hash of commandline options (default { archive: true }).
+      def initialize(options = {})
+        @options = options
+        @parser = OptionParser.new do |opts|
+          opts.banner = 'Exports specified chats: runoff some [SKYPE_USERNAME] [OPTIONS]'
+          opts.on '-h', '--help', 'Displays help' do
+            puts opts
+            exit
+          end
+
+          opts.on '-f', '--from PATH', 'Specifies the location of the database file (main.db)' do |path|
+            @options[:from] = path
+          end
+
+          opts.on '-d', '--destination PATH', 'Changes the default path for the exported files' do |path|
+            @options[:destination] = path
+          end
+
+          opts.on '-a', '--[no-]archive', 'Toggles archiving feature' do |enable|
+            @options[:archive] = enable
+          end
+
+          opts.on '-A', '--adapter [NAME]', 'Uses a specific file type adapter' do |adapter|
+            @options[:adapter] = adapter.capitalize + 'Adapter'
+          end
+        end
+      end
+
+      # Public: executes the command.
+      #
+      # args - An Array of commandline arguments.
+      def execute(args)
+        super args do |chat, file_writer|
+          ids      = prompt_for_chatnames chat
+          messages = chat.get_messages
+
+          selected_messages = messages.keep_if { |m| ids.include? m[Runoff::COLUMNS[0]] }
+
+          file_writer.write selected_messages
+        end
+      end
+
+      # Public: Asks user to specify, which chats to export.
+      #
+      # chat - A Chat object.
+      #
+      # Examples
+      #
+      #   get_requested_chatnames Chat.new('/path/to/main.db')
+      #   # => [120, 86, 201]
+      #
+      # Returns an Array of conversation ids.
+      def prompt_for_chatnames(chat)
+        puts 'Specify numbers of the chats that you want to export (e.g., 201, 86, 120)'
+        puts
+
+        chat.get_chatname_options.each do |opt|
+          puts "[#{opt[:id]}] #{opt[:name]}"
+        end
+
+        puts
+        print "Numbers: "
+        options = STDIN.gets # NOTE: For some reason just gets throws an error here.
+
+        options.split(',').map(&:to_i)
+      end
+    end
+  end
+end