runoff 1.0.1 → 2.0.0

data/lib/runoff/file_writer.rb

@@ -2,83 +2,62 @@ require 'zip'
 require 'fileutils'
 
 module Runoff
+  # Public: Writes data received from the database to text files.
   class FileWriter
-    attr_accessor :selected_entries
-
-    def initialize(db_handler)
-      @db_handler = db_handler
-      @selected_entries = []
+    # Public: Initializes a FileWriter object.
+    #
+    # options - A Hash with commandline options.
+    def initialize(options)
+      @export_path       = Location.get_export_path options
+      @adapter           = Object.const_get("Runoff::Adapters::#{options[:adapter]}").new
+      @current_file_name = nil
+      @buffer            = []
     end
 
-    # Public: Exports all the chats from the database.
+    # Public: Writes a single row of data to a text file.
+    #
+    # messages - An Array of data received from the database.
     #
-    # data_format - an object that defines how the data should be parsed.
-    # export_path - a string that points to the directory where exported files must be saved.
-    def export_database(data_format, export_path, create_archive)
-      @export_path = export_path
+    # Examples
+    #
+    #   write [{ chatname: "#first_user/$second_user;d3d86c6b0e3b8320" ... }, ...]
+    def write(messages)
+      messages.each_with_index do |m, i|
+        file_name = @adapter.get_file_name m[Runoff::COLUMNS[1]]
 
-      schema  = data_format.get_schema
-      dataset = @db_handler[schema[:table]]
-      dataset = dataset.select(*schema[:columns])
+        dump unless @current_file_name.nil? || @current_file_name == file_name
 
-      dataset.each do |row|
-        write data_format.build_entry(row)
-      end
+        @current_file_name = file_name
 
-      archive unless create_archive == false
+        @buffer << @adapter.build_entry(m)
+        dump if i == (messages.count - 1)
+      end
     end
 
-    # Public: Exports specific chats from the database.
-    #
-    # data_format - an object that defines how the data should be parsed.
-    # export_path - a string that points to the directory where exported files must be saved.
-    def export_database_partially(data_format, export_path, create_archive, &block)
-      @export_path = export_path
-
-      schema  = data_format.get_schema
-      dataset = @db_handler[schema[:table]]
-      indices = block.call self, dataset
-      clean_indices = indices.split(',').map { |e| e.strip }
-
-      clean_indices.each do |i|
-        chatname = @selected_entries[i.to_i]
-        approximation = data_format.denormalize chatname
-        dataset = @db_handler[schema[:table]]
-        dataset = dataset.where(Sequel.like(:chatname, "#{approximation}%"))
+    # Public: Saves all the exported files in a Zip archive.
+    def archive
+      archive_name = "#{@export_path}_#{Time.now.to_i}.zip"
 
-        dataset.each { |row| write data_format.build_entry(row) }
+      Zip::File.open archive_name, Zip::File::CREATE do |archive|
+        Dir[File.join(@export_path, '**', '**')].each do |file|
+          archive.add File.basename(file), file
+        end
       end
 
-      archive unless create_archive == false
+      FileUtils.rm_rf @export_path # Delete the folder.
     end
 
     private
 
-    # Internal: Appends a new entry to a file.
-    #
-    # entry - a hash containing "filename" and "content" keys.
-    #
-    # Examples
-    #
-    #   write { filename: "test.txt", content: "test content" }
-    def write(entry)
-      path = "#@export_path/#{entry[:filename]}"
-
-      File.open(path, "a+") { |file| file.write entry[:content] }
-    end
+    # Internal: Dumps the content buffer to a file.
+    def dump
+      content = @adapter.format_file_content @buffer
 
-    # Internal: Creates a Zip file of the destination directory.
-    def archive
-      zip_file_name = "#@export_path-#{Time.now.strftime "%Y%m%d%H%S%S"}.zip"
-
-      Zip::File.open(zip_file_name, Zip::File::CREATE) do |zf|
-        Dir[File.join(@export_path, '**', '**')].each do |f|
-          zf.add(f.sub("#@export_path/", ''), f)
-        end
+      File.open("#{@export_path}/#@current_file_name", "w") do |file|
+        file.puts content
       end
 
-      # Delete the destination directory because it is no longer needed.
-      FileUtils.rm_r @export_path
+      @buffer.clear
     end
   end
 end

data/lib/runoff/location.rb

@@ -5,13 +5,14 @@ module Runoff
   #
   # Examples
   #
-  #   Location::default_skype_data_location skype_username
+  #   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.
+    # Public: Gets a path to the Skype main.db file.
     #
-    # username - A String containing Skype username
-    # options  - A hash containing command-line options passed to the command.
+    # args     - An Array of commandline arguments, which might contain a String
+    #            with the Skype username.
+    # options  - A hash containing commandline options passed to the command.
     #            If the username is empty, then the hash must contain :from key.
     #
     # Examples
@@ -20,14 +21,16 @@ module Runoff
     #   # => Path to the default Skype database location depending on the operating system.
     #
     #   get_database_path('', { from: '~/Desktop/main.db' })
-    #   # => '~/Desktop/main.db'
+    #   # => '/Users/username/Desktop/main.db'
     #
     # Returns a String
-    def self.get_database_path(username, options)
-      if options.from
-        options.from
+    def self.get_database_path(args, options)
+      if options.key?(:from)
+        options[:from]
+      elsif args.count > 0
+        self.default_skype_data_location args[0]
       else
-        self.default_skype_data_location username
+        raise ArgumentError, 'No username or database file path provided.'
       end
     end
 
@@ -40,12 +43,16 @@ module Runoff
     #
     #   On Linux:
     #   default_skype_data_location skype_username
-    #   # => /home/user/.Skype/skype_username/mai.db
+    #   # => /home/user/.Skype/skype_username/main.db
     #
     #   On Windows:
     #   default_skype_data_location skype_username
     #   # =>  /Users/user/AppData/Roaming/Skype/skype_username/main.db
     #
+    #   On Mac OS:
+    #   default_skype_data_location skype_username
+    #   # =>  /Users/user/Library/Application\ Support/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']
@@ -64,25 +71,21 @@ module Runoff
 
     # Public: Composes a path where the exported files must be saved.
     #
-    # options - an object with command line options passed to the runoff executable.
+    # options - A Hash 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 = options[:destination] || "#{ENV['HOME']}"
       path = "#{path}/skype_chat_history"
 
-      unless File.exist?(path)
-        FileUtils::mkdir_p path
-      end
+      FileUtils::mkdir_p path unless File.exist?(path)
 
       path
     end
 
-    private
-
-    # Internal: Replaces backslashes with forward slashes and removes drive letter.
+    # Public: Replaces backslashes with forward slashes and removes drive letter.
     #
-    # path - String containing a directory path.
+    # path - A String containing a directory path.
     #
     # Examples
     #
@@ -95,7 +98,7 @@ module Runoff
       path.gsub(/^[a-zA-Z]:/, '')
     end
 
-    # Internal: Composes the default Skype database location for the Windows 8 operating system.
+    # Public: 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.

data/lib/runoff/version.rb

@@ -1,3 +1,3 @@
 module Runoff
-  VERSION = '1.0.1'
+  VERSION = '2.0.0'
 end

data/lib/runoff.rb

@@ -1,7 +1,15 @@
 require 'runoff/version'
 require 'runoff/location'
-require 'runoff/skype_data_format'
+require 'runoff/adapters/adapter'
+require 'runoff/adapters/txt_adapter'
+require 'runoff/adapters/json_adapter'
 require 'runoff/file_writer'
-require 'runoff/commands/command'
-require 'runoff/commands/all'
-require 'runoff/commands/some'
+require 'runoff/chat'
+
+module Runoff
+  # Public: A String containing the name of the table, where all the chat messages are stored.
+  TABLE = :Messages
+
+  # Public: An Array with all the important column names.
+  COLUMNS = [ :convo_id, :chatname, :timestamp, :from_dispname, :body_xml ]
+end

data/runoff.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |gem|
   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'

data/test/command_all_test.rb

@@ -0,0 +1,90 @@
+require 'minitest/autorun'
+require 'runoff/commandline/all'
+require 'colorize'
+require 'fileutils'
+
+class CommandAllTest < MiniTest::Unit::TestCase
+  def setup
+    @current_directory      = File.expand_path(File.dirname(__FILE__))
+
+    @default_output_dir     = "#@current_directory/data"
+    @test_database_location = "#@current_directory/data/test_main.db"
+    @expected_message       = 'Exporting...'.colorize(:green) + "\n" + 'Finished.'.colorize(:green) + "\n"
+  end
+
+  def teardown
+    Dir["#@default_output_dir/*"].each do |f|
+      if File.extname(f) == '.zip'
+        File.delete f
+      elsif File.directory?(f) && f !~ /custom_location/
+        FileUtils.rm_rf f
+      end
+    end
+  end
+
+  def test_it_raises_a_ArgumentError_if_called_with_an_empty_list_of_arguments
+    command = Runoff::Commandline::All.new( archive: true, adapter: 'TxtAdapter' )
+
+    assert_raises ArgumentError do
+      assert_output 'Exporting...' do
+        command.execute []
+      end
+    end
+  end
+
+  def test_it_exports_all_chat_history_as_a_zip_archive_and_saves_it_in_the_default_location
+    command     = Runoff::Commandline::All.new( archive: true, adapter: 'TxtAdapter' )
+    ENV['HOME'] = @default_output_dir
+
+    Runoff::Location.stub :default_skype_data_location, @test_database_location do
+      assert_output @expected_message do
+        command.execute ['white_mike']
+      end
+    end
+
+    assert_equal 1, Dir["#@default_output_dir/*.zip"].count
+  end
+
+  def test_it_exports_all_chat_history_as_a_folder_in_the_default_location_if_a_no_archive_option_is_set
+    command     = Runoff::Commandline::All.new( archive: false, adapter: 'TxtAdapter' )
+    ENV['HOME'] = @default_output_dir
+
+    Runoff::Location.stub :default_skype_data_location, @test_database_location do
+      assert_output @expected_message do
+        command.execute ['white_mike']
+      end
+    end
+
+    assert_equal 1, Dir["#@default_output_dir/skype_chat_history"].count;
+  end
+
+  def test_it_exports_all_chat_history_as_a_zip_archive_from_a_custom_location_and_saves_it_in_the_default_location
+    test_custom_database_location = "#@current_directory/data/custom_location/test_main.db"
+
+    command     = Runoff::Commandline::All.new( archive: true, adapter: 'TxtAdapter', from: test_custom_database_location )
+    ENV['HOME'] = @default_output_dir
+
+    Runoff::Location.stub :default_skype_data_location, @test_database_location do
+      assert_output @expected_message do
+        command.execute ['white_mike']
+      end
+    end
+
+    assert_equal 1, Dir["#@default_output_dir/*.zip"].count
+  end
+
+  def test_it_exports_all_chat_history_as_a_zip_archive_and_saves_it_in_a_custom_location
+    custom_output_location = "#@current_directory/data/custom_output_location"
+
+    command     = Runoff::Commandline::All.new( archive: true, adapter: 'TxtAdapter', destination: custom_output_location )
+    ENV['HOME'] = @default_output_dir
+
+    Runoff::Location.stub :default_skype_data_location, @test_database_location do
+      assert_output @expected_message do
+        command.execute ['white_mike']
+      end
+    end
+
+    assert_equal 1, Dir["#@default_output_dir/custom_output_location/*.zip"].count
+  end
+end

data/test/command_some_test.rb

@@ -0,0 +1,49 @@
+require 'minitest/autorun'
+require 'runoff/commandline/some'
+require 'colorize'
+require 'fileutils'
+
+class CommandSomeTest < MiniTest::Unit::TestCase
+  def setup
+    @current_directory      = File.expand_path(File.dirname(__FILE__))
+
+    @default_output_dir     = "#@current_directory/data"
+    @test_database_location = "#@current_directory/data/test_main.db"
+    @expected_message       = 'Exporting...'.colorize(:green) + "\n" + 'Finished.'.colorize(:green) + "\n"
+  end
+
+  def teardown
+    Dir["#@default_output_dir/*"].each do |f|
+      if File.extname(f) == '.zip'
+        File.delete f
+      elsif File.directory?(f) && f !~ /custom_location/
+        FileUtils.rm_rf f
+      end
+    end
+  end
+
+  def test_it_raises_a_ArgumentError_if_called_with_an_empty_list_of_arguments
+    command = Runoff::Commandline::Some.new( archive: true, adapter: 'TxtAdapter' )
+
+    assert_raises ArgumentError do
+      assert_output 'Exporting...' do
+        command.execute []
+      end
+    end
+  end
+
+  def test_it_exports_specified_chat_history_as_a_zip_archive_and_saves_it_in_the_default_location
+    command     = Runoff::Commandline::Some.new( archive: true, adapter: 'TxtAdapter' )
+    ENV['HOME'] = @default_output_dir
+
+    Runoff::Location.stub :default_skype_data_location, @test_database_location do
+      assert_output @expected_message do
+        command.stub :prompt_for_chatnames, [1] do
+          command.execute ['white_mike']
+        end
+      end
+    end
+
+    assert_equal 1, Dir["#@default_output_dir/*.zip"].count
+  end
+end

data/test/location_test.rb

@@ -0,0 +1,78 @@
+require 'minitest/autorun'
+require 'runoff'
+
+describe Runoff::Location do
+  it 'must return the default Skype database location on Windows 8.1' do
+    skype_username = 'skype_username'
+    path = "/AppData/Local/Packages/Microsoft.SkypeApp_124nb4j3654/LocalState/#{skype_username}/main.db"
+
+    Dir.stub :[], ['/AppData/Local/Packages/Microsoft.SkypeApp_124nb4j3654'] do
+      Runoff::Location.get_default_skype_data_location_on_windows_8(skype_username)
+                      .must_equal(path)
+    end
+  end
+
+  it 'must convert a path string from Windows style to Unix style' do
+    original_path = 'C:\Users\Neo\main.db'
+    expected_path = '/Users/Neo/main.db'
+
+    Runoff::Location.format_windows_path(original_path).must_equal(expected_path)
+  end
+
+  it 'must build a path for a directory, where the files are supposed to be saved, if the destination option is specified' do
+    path    = '/Users/Neo/backups'
+    options = { destination: path }
+
+    File.stub :exist?, true do
+      Runoff::Location.get_export_path(options).must_equal("#{path}/skype_chat_history")
+    end
+  end
+
+  it 'must build a path for a directory, where the files are supposed to be saved, if the destination option is not specified' do
+    options     = { destination: nil }
+    ENV['HOME'] = '/Users/Neo'
+
+    File.stub :exist?, true do
+      Runoff::Location.get_export_path(options).must_equal("#{ENV['HOME']}/skype_chat_history")
+    end
+  end
+
+  it 'must return the default Skype database location for Windows Desktop app' do
+    RbConfig::CONFIG['host_os'] = 'mingw'
+    ENV['APPDATA'] = 'C:\Users\Neo\AppData\Roaming'
+
+    skype_username = 'skype_username'
+    expected_path  = "/Users/Neo/AppData/Roaming/Skype/#{skype_username}/main.db"
+
+    File.stub :exist?, true do
+      Runoff::Location.default_skype_data_location(skype_username).must_equal(expected_path)
+    end
+  end
+
+  it 'must return the default Skype database location on Linux' do
+    RbConfig::CONFIG['host_os'] = 'linux'
+    ENV['HOME'] = '/home/Neo'
+
+    skype_username = 'skype_username'
+    expected_path = "#{ENV['HOME']}/.Skype/#{skype_username}/main.db"
+
+    Runoff::Location.default_skype_data_location(skype_username).must_equal(expected_path)
+  end
+
+  it 'must return the default Skype database location on Mac OS' do
+    RbConfig::CONFIG['host_os'] = 'darvin'
+    ENV['HOME'] = '/Users/Neo'
+
+    skype_username = 'skype_username'
+    expected_path = "#{ENV['HOME']}/Library/Application Support/Skype/#{skype_username}/main.db"
+
+    Runoff::Location.default_skype_data_location(skype_username).must_equal(expected_path)
+  end
+
+  it 'must return the path that are specified in the from option' do
+    path    = '/Users/Neo/Desktop/main.db'
+    options = { from: path }
+
+    Runoff::Location.get_database_path('Neo', options).must_equal(path)
+  end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: runoff
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Aigars Dzerviniks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-04 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: commander
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -96,16 +82,23 @@ files:
 - Rakefile
 - bin/runoff
 - lib/runoff.rb
-- lib/runoff/commands/all.rb
-- lib/runoff/commands/command.rb
-- lib/runoff/commands/some.rb
+- lib/runoff/adapters/adapter.rb
+- lib/runoff/adapters/json_adapter.rb
+- lib/runoff/adapters/txt_adapter.rb
+- lib/runoff/chat.rb
+- lib/runoff/commandline/all.rb
+- lib/runoff/commandline/command.rb
+- lib/runoff/commandline/none.rb
+- lib/runoff/commandline/some.rb
 - lib/runoff/file_writer.rb
 - lib/runoff/location.rb
-- lib/runoff/skype_data_format.rb
 - lib/runoff/version.rb
 - runoff.gemspec
-- test/skype_data_format_test.rb
-- test/test_db.sqlite
+- test/command_all_test.rb
+- test/command_some_test.rb
+- test/data/custom_location/test_main.db
+- test/data/test_main.db
+- test/location_test.rb
 homepage: https://github.com/aigarsdz/runoff
 licenses:
 - MIT
@@ -126,10 +119,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Tool to export Skype chat history from the SQLite database to text files
 test_files:
-- test/skype_data_format_test.rb
-- test/test_db.sqlite
+- test/command_all_test.rb
+- test/command_some_test.rb
+- test/data/custom_location/test_main.db
+- test/data/test_main.db
+- test/location_test.rb

data/lib/runoff/commands/all.rb

@@ -1,22 +0,0 @@
-require 'sequel'
-
-module Runoff
-  # Commands that can be executed by the application.
-  module Commands
-    class All < Command
-      # Public: Exports all Skyoe chat history.
-      #
-      # args - an array containing skype username
-      # options - a hash containing user provided options
-      #
-      # Examples
-      #
-      #   All.process ['username'], { from: '~/main.db' }
-      def self.process(args, options = {})
-        file_writer, export_path = self.get_file_writer_components args, options
-
-        file_writer.export_database Runoff::SkypeDataFormat.new, export_path, options.archive
-      end
-    end
-  end
-end

data/lib/runoff/commands/command.rb

@@ -1,19 +0,0 @@
-module Runoff
-  # Commands that can be executed by the application.
-  module Commands
-    # The base class for every runoff command.
-    class Command
-      def self.get_file_writer_components(args, options)
-        if args.empty? && !options.from
-          raise ArgumentError.new 'Error: You must specify the Skype username or a --from option'
-        end
-
-        main_db_path = Runoff::Location.get_database_path args[0], options
-        export_path  = Runoff::Location.get_export_path options
-        db_handler   = Sequel.sqlite main_db_path
-
-        return Runoff::FileWriter.new(db_handler), export_path
-      end
-    end
-  end
-end

data/lib/runoff/commands/some.rb

@@ -1,38 +0,0 @@
-require 'sequel'
-require 'set'
-
-module Runoff
-  # Commands that can be executed by the application.
-  module Commands
-    class Some < Command
-      # Public: Exports a specified part of Skyoe chat history.
-      #
-      # args - an array containing skype username
-      # options - a hash containing user provided options
-      #
-      # Examples
-      #
-      #   Some.process ['username'], { from: '~/main.db' }
-      def self.process(args, options = {})
-        file_writer, export_path = self.get_file_writer_components args, options
-        format = Runoff::SkypeDataFormat.new
-
-        file_writer.export_database_partially format, export_path, options.archive do |w, d|
-          chatname_dataset = d.select(:chatname)
-          chatnames = Set.new # Set is necessary to filter out duplicate chatnames.
-
-          chatname_dataset.each { |row| chatnames.add format.normalize(row[:chatname]) }
-
-          # In order to use indices we need an array.
-          w.selected_entries = chatnames.to_a
-
-          w.selected_entries.each_with_index { |e, i| puts "[#{i}] #{e}" }
-
-          puts # Ensure a blank line.
-          # Return the user response back to the FileWriter class.
-          next ask("Specify which chats to export separating each number with a comma:")
-        end
-      end
-    end
-  end
-end