runoff 0.3.3 → 1.0.0

data/lib/runoff/location.rb

@@ -1,79 +1,118 @@
-module Runoff
-
-  # Public: Contains class methods for finding out the appropriate file paths.
-  #
-  # Examples
-  #
-  #   Location::default_skype_data_location skype_username
-  #   # => /home/user/.Skype/skype_username/main.db
-  class Location
-
-    # Public: Composes the default Skype database location depending on the operating system.
-    #
-    # skype_username - A String that contains a username of the Skype account,
-    #                  which database we want to access.
-    #
-    # Examples
-    #
-    #   On Linux:
-    #   default_skype_data_location skype_username
-    #   # => /home/user/.Skype/skype_username/mai.db
-    #
-    #   On Windows:
-    #   default_skype_data_location skype_username
-    #   # =>  /Users/user/AppData/Roaming/Skype/skype_username/main.db
-    #
-    # Returns a String that contains the path to the Skype database file.
-    def self.default_skype_data_location(skype_username)
-      case RbConfig::CONFIG['host_os']
-      when /mingw/
-        if File.exist?("#{ENV['APPDATA']}\\Skype")
-          format_windows_path "#{ENV['APPDATA']}\\Skype\\#{skype_username}\\main.db"
-        else
-          format_windows_path self.get_default_skype_data_location_on_windows_8(skype_username)
-        end
-      when /linux/
-        "#{ENV['HOME']}/.Skype/#{skype_username}/main.db"
-      else
-        "#{ENV['HOME']}/Library/Application Support/Skype/#{skype_username}/main.db"
-      end
-    end
-
-    private
-
-    # Internal: Replaces backslashes with forward slashes and removes drive letter.
-    #
-    # path - String containing a directory path.
-    #
-    # Examples
-    #
-    #   format_windows_path 'C:\Users\username\AppData\Roaming\Skype\skype_username\main.db'
-    #   # => /Users/username/AppData/ROaming/Skype/skype_username/main.db
-    #
-    # Returns a String with modified directory path.
-    def self.format_windows_path(path)
-      path = path.gsub(/\\/, '/')
-      path.gsub(/^[a-zA-Z]:/, '')
-    end
-
-    # Internal: Composes the default Skype database location for the Windows 8 operating system.
-    #
-    # skype_username - A String that contains a username of the Skype account,
-    #                  which database we want to access.
-    #
-    # Examples
-    #
-    #   get_default_skype_data_location_on_windows_8 skype_username
-    #   # => C:/Users/user/AppData/Local/Packages/Microsoft.SkypeApp_sakjhds8asd/LocalState/skype_username/main.db
-    #
-    # Returns a String that contains the path to the Skype database file.
-    def self.get_default_skype_data_location_on_windows_8(skype_username)
-      location = "#{ENV['HOME']}/AppData/Local/Packages"
-      skype_folder = Dir["#{location}/Microsoft.SkypeApp*"].first
-
-      raise IOError.new "The default Skype directory doesn't exist." unless skype_folder
-
-      "#{skype_folder}/LocalState/#{skype_username}/main.db"
-    end
-  end
-end
+require 'fileutils'
+
+module Runoff
+  # Contains class methods for finding out the appropriate file paths.
+  #
+  # Examples
+  #
+  #   Location::default_skype_data_location skype_username
+  #   # => /home/user/.Skype/skype_username/main.db
+  class Location
+    # Public: Gets a path to the Skype's main.db file.
+    #
+    # username - A String containing Skype username
+    # options  - A hash containing command-line options passed to the command.
+    #            If the username is empty, then the hash must contain :from key.
+    #
+    # Examples
+    #
+    #   get_database_path('john_doe', {})
+    #   # => Path to the default Skype database location depending on the operating system.
+    #
+    #   get_database_path('', { from: '~/Desktop/main.db' })
+    #   # => '~/Desktop/main.db'
+    #
+    # Returns a String
+    def self.get_database_path(username, options)
+      if options.from
+        options.from
+      else
+        self.default_skype_data_location username
+      end
+    end
+
+    # Public: Composes the default Skype database location depending on the operating system.
+    #
+    # skype_username - A String that contains a username of the Skype account,
+    #                  which database we want to access.
+    #
+    # Examples
+    #
+    #   On Linux:
+    #   default_skype_data_location skype_username
+    #   # => /home/user/.Skype/skype_username/mai.db
+    #
+    #   On Windows:
+    #   default_skype_data_location skype_username
+    #   # =>  /Users/user/AppData/Roaming/Skype/skype_username/main.db
+    #
+    # Returns a String that contains the path to the Skype database file.
+    def self.default_skype_data_location(skype_username)
+      case RbConfig::CONFIG['host_os']
+      when /mingw/
+        if File.exist?("#{ENV['APPDATA']}\\Skype")
+          format_windows_path "#{ENV['APPDATA']}\\Skype\\#{skype_username}\\main.db"
+        else
+          format_windows_path self.get_default_skype_data_location_on_windows_8(skype_username)
+        end
+      when /linux/
+        "#{ENV['HOME']}/.Skype/#{skype_username}/main.db"
+      else
+        "#{ENV['HOME']}/Library/Application Support/Skype/#{skype_username}/main.db"
+      end
+    end
+
+    # Public: Composes a path where the exported files must be saved.
+    #
+    # options - an object with command line options passed to the runoff executable.
+    #
+    # Returns a string with a directory path.
+    def self.get_export_path(options)
+      path = options.destination || "#{ENV['HOME']}"
+      path = "#{path}/skype_chat_history"
+
+      unless File.exist?(path)
+        FileUtils::mkdir_p path
+      end
+
+      path
+    end
+
+    private
+
+    # Internal: Replaces backslashes with forward slashes and removes drive letter.
+    #
+    # path - String containing a directory path.
+    #
+    # Examples
+    #
+    #   format_windows_path 'C:\Users\username\AppData\Roaming\Skype\skype_username\main.db'
+    #   # => /Users/username/AppData/ROaming/Skype/skype_username/main.db
+    #
+    # Returns a String with modified directory path.
+    def self.format_windows_path(path)
+      path = path.gsub(/\\/, '/')
+      path.gsub(/^[a-zA-Z]:/, '')
+    end
+
+    # Internal: Composes the default Skype database location for the Windows 8 operating system.
+    #
+    # skype_username - A String that contains a username of the Skype account,
+    #                  which database we want to access.
+    #
+    # Examples
+    #
+    #   get_default_skype_data_location_on_windows_8 skype_username
+    #   # => C:/Users/user/AppData/Local/Packages/Microsoft.SkypeApp_sakjhds8asd/LocalState/skype_username/main.db
+    #
+    # Returns a String that contains the path to the Skype database file.
+    def self.get_default_skype_data_location_on_windows_8(skype_username)
+      location = "#{ENV['HOME']}/AppData/Local/Packages"
+      skype_folder = Dir["#{location}/Microsoft.SkypeApp*"].first
+
+      raise IOError.new "The default Skype directory doesn't exist." unless skype_folder
+
+      "#{skype_folder}/LocalState/#{skype_username}/main.db"
+    end
+  end
+end

data/lib/runoff/skype_data_format.rb

@@ -1,104 +1,128 @@
-module Runoff
-  # Public: Deals with Skype specific formats.
-  class SkypeDataFormat
-    #Public: Builds an appropriate filename.
-    #
-    # chat_record - A Hash containing necessary data.
-    #
-    # Examples
-    #
-    #   get_filename { chatname: 'demo-chat' }
-    #   # => demo-chat.txt
-    #
-    # Retruns a filename as a String.
-    def get_filename(chat_record)
-      "#{parse_chatname chat_record[:chatname]}.txt"
-    end
-
-    # Public: Creates a String with one entry from the chat.
-    #
-    # chat_record - a Hash containing data about a single chat message.
-    #
-    # Examples
-    #
-    #   build_entry { timestamp: 213213232, from_dispname: 'aidzis', body_xml: 'This is text.' }
-    #   # => [2013-04-13 14:23:57] aidzis: This is text.
-    #
-    # Returns a String with a chat entry.
-    def build_entry(chat_record)
-      datetime = Time.at chat_record[:timestamp]
-      output_record = "[#{datetime.strftime "%Y-%m-%d %H:%M:%S"}] "
-      output_record << "#{chat_record[:from_dispname]}: #{parse_body_xml chat_record[:body_xml]}"
-
-      output_record
-    rescue StandardError
-    end
-
-    # Public: Converts chatname from database to a valid file name.
-    #
-    # raw_chatname - A String with a chatname read from the database.
-    #
-    # Examples
-    #
-    #   parse_chatname '#someone/$someone_else;521357125362'
-    #   # => someone-someone_else.txt
-    #
-    # Returns a String with a valid file name.
-    def parse_chatname(raw_chatname)
-      match = raw_chatname.match(/#(.+)\/\$(.+);|#(.+)\/\$/)
-      first_part, second_part, third_part = match.captures
-      chatname = "#{first_part}-#{second_part}-#{third_part}"
-
-      trim_dashes chatname
-    end
-
-    # Public: Removes extra characters from the end of a chatname.
-    #
-    # raw_chatname - A String with a chatname read from the database
-    #
-    # Examples
-    #
-    #   partly_parse_chatname '#someone/$someone_else;521357125362'
-    #   # => #someone/$someone_else;
-    #
-    # Returns a String with a chatname without extra characters at the end.
-    def partly_parse_chatname(raw_chatname)
-      match = raw_chatname.match(/(#.+\/\$.+;)|(#.+\/\$)/)
-      first_group, second_group = match.captures
-
-      first_group || second_group
-    end
-
-    private
-    # Internal: Remove Skype emotion tags.
-    #
-    # text - String containing XML data
-    #
-    # Examples
-    #
-    #   parse_body_xml "Some text <ss type="laugh">:D</ss>"
-    #   # => "Some text :D"
-    #
-    # Returns the duplicated String.
-    def parse_body_xml(text)
-      clean_text = text.gsub(/<ss type=".+">/, '')
-      clean_text.gsub(/<\/ss>/, '')
-    end
-
-    # Internal: Removes unnecessary dashes from the begining and the end of the string.
-    #
-    # string - A String possibly containing dashes at the beggining or the end
-    #
-    # Examples
-    #
-    #   str = '--example-'
-    #   trim_dashes str
-    #   # => example
-    #
-    # Returns a string without leading and ending dashes.
-    def trim_dashes(string)
-      clean_string = string.gsub(/^-+/, '')
-      clean_string.gsub(/-+$/, '')
-    end
-  end
-end
+module Runoff
+  # Defines methods to hide the specific format that is used in the Skype database.
+  class SkypeDataFormat
+    # Public: Defines what kind of information can be queried from the database.
+    #
+    # Example
+    #
+    #   get_schema do |table, columns|
+    #     # SELSECT *columns FROM table
+    #   end
+    #
+    #   get_schema
+    #   # => { table: :Messages, columns: [:chatname, :timestamp, :from_dispname, :body_xml] }
+    #
+    # Returns a hash with keys "table" and "columns" if no block is given.
+    def get_schema
+      if block_given?
+        yield :Messages, [:chatname, :timestamp, :from_dispname, :body_xml]
+      else
+        return {
+          table: :Messages,
+          columns: [:chatname, :timestamp, :from_dispname, :body_xml]
+        }
+      end
+    end
+
+    # Public: Provides a filename and the data that should be written to the file.
+    #
+    # fields - an array representing a single entry in the database.
+    #
+    # Examples
+    #
+    #   build_entry {
+    #     chatname: "#john/$doe;1243435",
+    #     from_dispname: "John",
+    #     body_xml: "Lorem ipsum",
+    #     timestamp: 12435463
+    #   } # => { filename: john-doe.txt, content: "[2013-12-27 12:23:43] John: Lorem ipsum" }
+    #
+    # Returns a hash with "filename" and "content" keys.
+    def build_entry(fields)
+      chatname = fields[:chatname]
+      username = fields[:from_dispname]
+      message  = parse_xml fields[:body_xml]
+      datetime = Time.at(fields[:timestamp]).strftime "%Y-%m-%d %H:%M:%S"
+
+      {
+        filename: get_filename(chatname),
+        content: "[#{datetime}] #{username}: #{message}\n"
+      }
+    end
+
+    # Public: Parse a into a human readable format.
+    #
+    # chatname - a string that must be normalized.
+    #
+    # Examples
+    #
+    #   normalize "#john/$doe;2354657"
+    #   # => john-doe
+    #
+    # Returns a string without unnecessary characters.
+    def normalize(chatname)
+      pattern = /^#(.+)\/\$(.+)?;.*$/
+      initiator, respondent = chatname.match(pattern).captures
+
+      "#{initiator}-#{respondent}".gsub(/(^-+|-+$)/, '')
+    end
+
+    # Public: Converts a string that is similar to the chat title stored
+    #         in the Skype database.
+    #
+    # dispname - a string that is displayed to the user as a chat title.
+    #
+    # Examples
+    #
+    #   denormalize "john-doe"
+    #   # => "#john/$doe;"
+    #
+    # Returns a string that can be used to query Skype database.
+    def denormalize(dispname)
+      parts = dispname.split '-'
+
+      parts.count == 2 ? "##{parts[0]}/$#{parts[1]};" : "##{parts[0]}/$;"
+    end
+
+    private
+
+    # Internal: Parses a string into a valid file name.
+    #
+    # chatname - a string that must be converted into a valid filename.
+    #
+    # Examples
+    #
+    #   get_filename "#john/$doe;2354657"
+    #   # => john-doe.txt
+    #
+    # Returns a string that can be used as a file name.
+    def get_filename(chatname)
+      normalize(chatname) + ".txt"
+    end
+
+    # Internal: removes unnecessary XML code from the message.
+    #
+    # message - a string to parse
+    #
+    # Examples
+    #
+    #   parse_xml "<ss type="smile">:)</ss>"
+    #   # => ":)"
+    #
+    # Returns an XML-free string.
+    def parse_xml(message)
+      if message
+        message = message.gsub /<ss type=".*">/, ''
+        message = message.gsub /<\/ss>/, ''
+        message = message.gsub /<a href=".*">/, ''
+        message = message.gsub /<\/a>/, ''
+        message = message.gsub /&apos;/, "'"
+        message = message.gsub /&lt;/, '<'
+        message = message.gsub /&gt;/, '>'
+        message = message.gsub /&quot;/, '"'
+      end
+
+      message
+    end
+  end
+end

data/lib/runoff/version.rb

@@ -1,3 +1,3 @@
-module Runoff
-  VERSION = '0.3.3'
-end
+module Runoff
+  VERSION = '1.0.0'
+end

data/lib/runoff.rb

@@ -1,10 +1,7 @@
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
-require "runoff/version"
-require "runoff/location"
-require "runoff/skype_data_format"
-require "runoff/file_writer"
-require "runoff/composition"
-require "runoff/commands/command"
-require "runoff/commands/all"
-require "runoff/commands/chat"
+require 'runoff/version'
+require 'runoff/location'
+require 'runoff/skype_data_format'
+require 'runoff/file_writer'
+require 'runoff/commands/command'
+require 'runoff/commands/all'
+require 'runoff/commands/some'

data/runoff.gemspec

@@ -1,26 +1,27 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'runoff/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "runoff"
-  gem.version       = Runoff::VERSION
-  gem.authors       = ["Aigars Dzerviniks"]
-  gem.email         = ["dzerviniks.aigars@outlook.com"]
-  gem.description   = %q{runoff provides functionality to export all the Skype chat history or only specified chats from the Skype SQLite database file to text files}
-  gem.summary       = %q{Tool to export Skype chat history from the SQLite database to text files}
-  gem.homepage      = 'https://github.com/aidzis/runoff'
-  gem.license       = 'MIT'
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency 'commander'
-  gem.add_dependency 'sequel'
-  gem.add_dependency 'rubyzip'
-  gem.add_dependency 'sqlite3'
-end
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'runoff/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "runoff"
+  gem.version       = Runoff::VERSION
+  gem.authors       = ["Aigars Dzerviniks"]
+  gem.email         = ["dzerviniks.aigars@outlook.com"]
+  gem.description   = %q{runoff provides functionality to export all the Skype chat history or only specified chats from the Skype SQLite database file to text files}
+  gem.summary       = %q{Tool to export Skype chat history from the SQLite database to text files}
+  gem.homepage      = 'https://github.com/aigarsdz/runoff'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'commander'
+  gem.add_dependency 'sequel'
+  gem.add_dependency 'rubyzip'
+  gem.add_dependency 'sqlite3'
+  gem.add_dependency 'colorize'
+end

data/test/skype_data_format_test.rb

@@ -1,71 +1,58 @@
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'runoff'
-
-class TestSkypeDataFormat < MiniTest::Test
-  def setup
-    @format = Runoff::SkypeDataFormat.new
-  end
-
-  def test_must_return_a_valid_filename_from_a_hash
-    record = { chatname: '#brian/$john;521357125362' }
-    filename = @format.get_filename record
-
-    assert_equal 'brian-john.txt', filename
-  end
-
-  def test_must_build_a_string_from_the_necessary_database_record_columns
-    record = {
-      chatname: '#brian/$john;521357125362',
-      timestamp: 1366280218,
-      from_dispname: 'Aidzis',
-      body_xml: 'This is a text.'
-    }
-
-    entry = @format.build_entry record
-
-    assert_equal '[2013-04-18 13:16:58] Aidzis: This is a text.', entry
-  end
-
-  def test_must_return_a_valid_and_readable_name_from_a_raw_chatname
-    raw_chatname = '#something/$else;521357125362'
-    chatname = @format.parse_chatname raw_chatname
-
-    assert_equal 'something-else', chatname
-  end
-
-  def test_must_return_a_valid_and_readable_name_from_a_broken_chatname_record
-    raw_chatname = '#something/$521357125362'
-    chatname = @format.parse_chatname raw_chatname
-
-    assert_equal 'something', chatname
-  end
-
-  def test_must_return_a_chatname_without_the_extra_symbols
-    raw_chatname = '#something/$else;521357125362'
-    chatname = @format.partly_parse_chatname raw_chatname
-
-    assert_equal '#something/$else;', chatname
-  end
-
-  def test_must_return_a_chatname_without_the_extra_symbols_for_a_broken_chatname_record
-    raw_chatname = '#something/$521357125362'
-    chatname = @format.partly_parse_chatname raw_chatname
-
-    assert_equal '#something/$', chatname
-  end
-
-  def test_must_return_a_string_without_skype_emotion_xml_tags
-    string = 'Some text <ss type="laugh">:D</ss>'
-    clean_string = @format.send :parse_body_xml, string
-
-    assert_equal 'Some text :D', clean_string
-  end
-
-  def test_must_remove_all_starting_and_ending_dashes_from_a_string
-    string = '---example--'
-    valid_name = @format.send :trim_dashes, string
-
-    assert_equal 'example', valid_name
-  end
+require 'minitest/autorun'
+require 'runoff'
+
+describe Runoff::SkypeDataFormat do
+  before do
+    @format = Runoff::SkypeDataFormat.new
+  end
+
+  it "must return a schema of the necessary data" do
+    expected = { table: :Messages, columns: [:chatname, :timestamp, :from_dispname, :body_xml] }
+
+    @format.get_schema.must_equal expected
+  end
+
+  it "must yield a schema of the necessary data to a block" do
+    @format.get_schema do |table, columns|
+      table.must_equal :Messages
+      columns.must_equal [:chatname, :timestamp, :from_dispname, :body_xml]
+    end
+  end
+
+  it "must return a hash with 'filename' and 'content' keys based on the input data" do
+    fields = {
+      chatname: "#john/$doe;1243435",
+      from_dispname: "John",
+      body_xml: "Lorem ipsum",
+      timestamp: 1387756800
+    }
+
+    expected = { filename: "john-doe.txt", content: "[2013-12-23 02:00:00] John: Lorem ipsum\n" }
+
+    @format.build_entry(fields).must_equal expected
+  end
+
+  it "must normalize a Skype specific chat title into a human readable string" do
+    @format.normalize('#john/$doe;2354657').must_equal 'john-doe'
+  end
+
+  it "must normalize a Skype specific chat title into a human readable string even in case of invalid title" do
+    @format.normalize('#john/$;2354657').must_equal 'john'
+  end
+
+  it "must parse a Skype specific chat title into a valid file name" do
+    @format.send(:get_filename, '#john/$doe;2354657').must_equal 'john-doe.txt'
+  end
+
+  it "must parse a Skype specific chat title into a valid file name even in case of invalid title" do
+    @format.send(:get_filename, '#john/$;2354657').must_equal 'john.txt'
+  end
+
+  it "must denormalize a human readable chat title into a string that can be used in a database query" do
+    @format.denormalize('john-doe').must_equal '#john/$doe;'
+  end
+
+  it "must denormalize a human readable, invalid chat title into a string that can be used in a database query" do
+    @format.denormalize('john').must_equal '#john/$;'
+  end
 end