runoff 0.3.3 → 1.0.0

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: runoff
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Aigars Dzerviniks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2014-01-01 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
     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: rubyzip
   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: sqlite3
   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: colorize
+  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'
 description: runoff provides functionality to export all the Skype chat history or
@@ -75,7 +89,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,23 +97,16 @@ files:
 - bin/runoff
 - lib/runoff.rb
 - lib/runoff/commands/all.rb
-- lib/runoff/commands/chat.rb
 - lib/runoff/commands/command.rb
-- lib/runoff/composition.rb
+- lib/runoff/commands/some.rb
 - lib/runoff/file_writer.rb
 - lib/runoff/location.rb
 - lib/runoff/skype_data_format.rb
 - lib/runoff/version.rb
 - runoff.gemspec
-- test/all_test.rb
-- test/chat_test.rb
-- test/command_test.rb
-- test/composition_test.rb
-- test/file_writer_test.rb
-- test/location_test.rb
 - test/skype_data_format_test.rb
 - test/test_db.sqlite
-homepage: https://github.com/aidzis/runoff
+homepage: https://github.com/aigarsdz/runoff
 licenses:
 - MIT
 metadata: {}
@@ -109,12 +116,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -124,11 +131,5 @@ signing_key:
 specification_version: 4
 summary: Tool to export Skype chat history from the SQLite database to text files
 test_files:
-- test/all_test.rb
-- test/chat_test.rb
-- test/command_test.rb
-- test/composition_test.rb
-- test/file_writer_test.rb
-- test/location_test.rb
 - test/skype_data_format_test.rb
 - test/test_db.sqlite

data/lib/runoff/commands/chat.rb

@@ -1,37 +0,0 @@
-module Runoff
-  module Commands
-    class Chat < Command
-      # Public: Exports specified chats.
-      #
-      # args - Array containing skype username
-      # options - Hash containing user provided options
-      #
-      # Examples
-      #
-      #   Chat.process ['username'], { from: '~/main.db' }
-      def self.process(args, options = {})
-        if args.empty? && !options.has_key?('from')
-          raise ArgumentError.new 'You must specify a username or a --from option'
-        end
-
-        composition = self.get_composition args[0], options[:from]
-        destination = self.get_destination options[:destination]
-        chatnames, raw_chatnames = composition.get_chatnames
-
-        self.list_chatnames chatnames
-        indecies = ask 'Which chats do you want to export? (Enter indecies) ', Array
-        indecies = indecies.map { |index| index.to_i }
-        selected_chatnames = []
-
-        indecies.each { |index| selected_chatnames << raw_chatnames[index] }
-        self.print_result composition.export_chats(selected_chatnames, destination)
-        self.try_to_archive destination, options
-
-      rescue ArgumentError => e
-        puts e
-      rescue IOError => e
-        puts e
-      end
-    end
-  end
-end

data/lib/runoff/composition.rb

@@ -1,105 +0,0 @@
-require 'sequel'
-require 'set'
-
-module Runoff
-  # Public: Provides interaction with a Skype database file.
-  #
-  # Examples
-  #
-  #   composition = Composition.new 'path/to/the/main.db'
-  #   exported_files_count = composition.export 'export/folder'
-  class Composition
-    # Public: Returns a Set object of all the names of the exported files.
-    attr_reader :exported_filenames
-
-    # Public: Initialize a Composition object.
-    #
-    # main_db_file_path - A String with the path to the Skype database file.
-    # skype_username - A String with Skype login.
-    #
-    # Raises IOError if the file cannot be found
-    def initialize(optional_file_path, skype_username = nil)
-      main_db_file_path = optional_file_path || Runoff::Location.default_skype_data_location(skype_username)
-
-      raise IOError, "File doesn't exist" unless File.exists? main_db_file_path
-
-      skype_database = Sequel.connect "sqlite://#{main_db_file_path}"
-      @messages = skype_database.from :Messages
-      @exported_filenames = Set.new
-      @format = Runoff::SkypeDataFormat.new
-      @file_writer = Runoff::FileWriter.new @format
-    end
-
-    # Public: Reads all chat records from database and runs the export process.
-    #
-    # destination_path - A String with folder path, where to put exported files.
-    #
-    # Examples
-    #
-    #   export '/home/username/skype_backup'
-    #   # => 8
-    #
-    # Returns the count of the exported files.
-    def export(destination_path)
-      chat_records = @messages.select(:chatname, :timestamp, :from_dispname, :body_xml)
-
-      run_export chat_records, destination_path
-    end
-
-    # Public: Gets parsed chatnames together with partly parsed chatnames.
-    #
-    # Examples
-    #
-    #   get_chatnames
-    #   # => [['something-more', 'somethindg-else'],
-    #         ['#something/$more;6521032', '#something/$else;8971263']]
-    #
-    # Returns two Array objects containing parsed chatnames and partly parsed chatnames.
-    def get_chatnames
-      chatnames = @messages.select(:chatname)
-      raw_chatnames = chatnames.map { |record| @format.partly_parse_chatname record[:chatname] }.uniq
-      clean_chatnames = raw_chatnames.map { |chatname| @format.parse_chatname chatname }
-
-      return clean_chatnames, raw_chatnames
-    end
-
-    # Public: Exports Skype chat history to text files for specified chats.
-    #
-    # chatnames - Array of chatnames, which will be exported
-    # destination_path - A String with folder path, where to put exported files.
-    #
-    # Examples
-    #
-    #  export_chats ['#something/$more;', '#something/$else;'], '~/skype_backup'
-    #  # => 2
-    #
-    # Returns the count of the exported files.
-    def export_chats(chatnames, destination_path)
-      pattern_chatnames = chatnames.map { |name| "#{name}%" }
-      chat_records = @messages.where(Sequel.like(:chatname, *pattern_chatnames))
-
-      run_export chat_records, destination_path
-    end
-
-    private
-    # Internal: Performs the export process.
-    #
-    # chat_records - Array of chat records read from database
-    #
-    # Examples
-    #
-    #   run_export [{chatname: '#sadsad/$kjhkjh;9878977', 123123213, 'Aidzis', ''}]
-    #   # => 1
-    #
-    # Returns the count of the exported files.
-    def run_export(chat_records, destination_path)
-      chat_records.each do |record|
-        if filename = @file_writer.save_to_file(record, destination_path)
-          @exported_filenames << filename
-        end
-      end
-
-      @exported_filenames.count
-    end
-  end
-end

data/test/all_test.rb

@@ -1,37 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'runoff'
-require 'fileutils'
-
-class TestAll < MiniTest::Test
-  def teardown
-    Dir.glob('test/*.zip').each do |archive|
-      File.delete archive
-    end
-
-    FileUtils.rm_rf 'test/tmp'
-  end
-
-  def test_must_output_an_error_message_if_no_username_or_from_option_is_provided
-    assert_output "You must specify a username or a --from option\n" do
-      Runoff::Commands::All.process []
-    end
-  end
-
-  def test_must_output_result_of_the_command
-    assert_output "Finished: 2 files were exported\n" do
-      Runoff::Commands::All.process [], {
-        from: 'test/test_db.sqlite',
-        destination: 'test/tmp'
-      }
-    end
-  end
-
-  def test_must_put_exported_files_into_an_archive
-    capture_io do
-      Runoff::Commands::All.process [], { from: 'test/test_db.sqlite', destination: 'test/tmp' }
-    end
-
-    assert_equal 1, Dir["test/*.zip"].length, "test directory must contain 1 Zip file"
-  end
-end

data/test/chat_test.rb

@@ -1,11 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'runoff'
-
-class TestChat < MiniTest::Test
-  def test_must_output_an_error_message_if_no_username_or_from_option_is_procided
-    assert_output "You must specify a username or a --from option\n" do
-      Runoff::Commands::Chat.process []
-    end
-  end
-end

data/test/command_test.rb

@@ -1,41 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'runoff'
-
-class TestCommand < MiniTest::Test
-  def test_must_create_a_composition_object_based_on_a_specified_path_to_database_file
-    assert_instance_of Runoff::Composition, Runoff::Commands::Command.send(:get_composition, nil, 'test/test_db.sqlite')
-  end
-
-  def test_must_return_a_default_destination_path_if_no_optional_path_is_specified
-    assert_equal "#{ENV['HOME']}/skype-backup", Runoff::Commands::Command.send(:get_destination, nil)
-  end
-
-  def test_must_return_a_custom_path_if_an_optional_path_is_specified
-    path = Runoff::Commands::Command.send :get_destination, 'test/test_db.sqlite'
-
-    assert_equal 'test/test_db.sqlite', path
-  end
-
-  def test_must_output_correct_message_based_on_the_exported_items_count
-    assert_output "Finished: 1 file was exported\n" do
-      Runoff::Commands::Command.send :print_result, 1
-    end
-
-    assert_output "Finished: 2 files were exported\n" do
-      Runoff::Commands::Command.send :print_result, 2
-    end
-  end
-
-  def test_must_output_a_list_of_available_chatnames
-    chatnames = ['first-chatname', 'second-chatname']
-
-    assert_output "[0] first-chatname\n[1] second-chatname\n\n" do
-      Runoff::Commands::Command.send :list_chatnames, chatnames
-    end
-  end
-
-  def test_does_not_create_an_archive_if_the_archive_option_is_set_to_false
-    skip
-  end
-end

data/test/composition_test.rb

@@ -1,58 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'runoff'
-require 'fileutils'
-
-class TestComposition < MiniTest::Test
-  def setup
-    @composition = Runoff::Composition.new 'test/test_db.sqlite'
-  end
-
-  def teardown
-    FileUtils.rm_rf 'test/tmp'
-  end
-
-  def test_must_raise_an_IOError_if_the_file_that_is_passed_to_the_constructor_does_not_exist
-    assert_raises IOError do
-      composition = Runoff::Composition.new 'not_existing.db'
-    end
-  end
-
-  def test_must_respond_to_exported_filenames_method
-    assert_respond_to @composition, :exported_filenames
-  end
-
-  def test_must_return_parsed_chatnames_together_with_partly_parsed_chatnames
-    chatnames, raw_chatnames = @composition.get_chatnames
-
-    assert_equal ['something-more', 'something-else'], chatnames
-    assert_equal ['#something/$more;', '#something/$else;'], raw_chatnames
-  end
-
-  def test_must_return_a_count_of_the_exported_filenames
-    file_count = @composition.send(
-      :run_export,
-      [{
-        chatname: '#john/$elis;7687623',
-        timestamp: 123123213,
-        from_dispname: 'John',
-        body_xml: ''
-      }],
-      'test/tmp'
-    )
-
-    assert_equal 1, file_count
-  end
-
-  def test_must_return_a_count_of_the_exported_filenames_when_called_for_all_chats
-    file_count = @composition.export 'test/tmp'
-
-    assert_equal 2, file_count
-  end
-
-  def test_must_return_a_count_of_the_exported_filenames_when_called_for_specific_chats
-    file_count = @composition.export_chats ['#something/$more;', '#something/$else;'], 'test/tmp'
-
-    assert_equal 2, file_count
-  end
-end

data/test/file_writer_test.rb

@@ -1,90 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'runoff'
-require 'fileutils'
-
-class TestFileWriter < MiniTest::Test
-  def setup
-    @incorrect_chat_record = {
-      chatname: '#john/$;521357125362',
-      timestamp: 1366280218,
-      from_dispname: 'John',
-      body_xml: 'This is a text'
-    }
-
-    @chat_record = {
-      chatname: '#braun/$drake;521357125362',
-      timestamp: 1366280218,
-      from_dispname: 'Braun',
-      body_xml: 'This is a text.'
-    }
-
-    correct_format = get_correct_format_mock
-    @correct_file_writer = Runoff::FileWriter.new correct_format
-    incorrect_format = get_incorrect_format_mock
-    @incorrect_file_writer = Runoff::FileWriter.new incorrect_format
-  end
-
-  def teardown
-    FileUtils.rm_rf 'test/tmp'
-
-    Dir.glob('test/*.zip').each do |archive|
-      File.delete archive
-    end
-  end
-
-  def test_must_write_chat_content_to_file
-    @correct_file_writer.save_to_file @chat_record, 'test/tmp'
-    @incorrect_file_writer.save_to_file @incorrect_chat_record, 'test/tmp'
-
-    assert_equal 2, Dir['test/tmp/*.txt'].count
-  end
-
-  def test_must_append_to_a_file_if_the_filename_already_exists
-    @additional_chat_record = @chat_record
-
-    @correct_file_writer.save_to_file @chat_record, 'test/tmp'
-    @incorrect_file_writer.save_to_file @incorrect_chat_record, 'test/tmp'
-    @correct_file_writer.save_to_file @additional_chat_record, 'test/tmp'
-
-    assert_equal 2, Dir['test/tmp/*.txt'].count
-  end
-
-  def test_must_create_a_zip_file_of_the_destination_directory
-    output_directory = 'test/tmp'
-    files = %w[first.txt second.txt]
-
-    Dir.mkdir(output_directory) unless File.exists?(output_directory)
-
-    files.each do |filename|
-      file = File.new "#{output_directory}/#{filename}", 'w'
-      file.close
-    end
-
-    Runoff::FileWriter.archive output_directory
-
-    assert_equal 1, Dir['test/*.zip'].count
-  end
-
-  private
-
-  def get_correct_format_mock
-    correct_format = MiniTest::Mock.new
-
-    correct_format.expect :get_filename, 'braun-drake.txt', [Hash]
-    correct_format.expect :get_filename, 'braun-drake.txt', [Hash]
-    correct_format.expect :build_entry, '[2013-04-18 13:16:58] Braun: This is a text.', [Hash]
-    correct_format.expect :build_entry, '[2013-04-18 13:16:58] Braun: This is a text.', [Hash]
-
-    correct_format
-  end
-
-  def get_incorrect_format_mock
-    incorrect_format = MiniTest::Mock.new
-
-    incorrect_format.expect :get_filename, 'john.txt', [Hash]
-    incorrect_format.expect :build_entry, '[2013-04-18 13:16:58] John: This is a text.', [Hash]
-
-    incorrect_format
-  end
-end

data/test/location_test.rb

@@ -1,29 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'runoff'
-
-class TestLocation < MiniTest::Test
-  def test_must_return_a_default_path_depending_on_the_operating_system
-    path = Runoff::Location.default_skype_data_location 'aidzis_skype'
-
-    if RbConfig::CONFIG['host_os'] =~ /mingw/
-      skip
-      if File.exist?("#{ENV['APPDATA']}\\Skype")
-        assert_match /\/Users\/[a-zA-Z0-9]+\/AppData\/Roaming\/Skype\/aidzis_skype\/main\.db/, path
-      else
-        assert_match /\/Users\/[a-zA-Z0-9]+\/AppData\/Local\/Packages\/[a-zA-Z0-9_\/\.]+\/aidzis_skype\/main\.db/, path
-      end
-    elsif RbConfig::CONFIG['host_os'] =~ /linux/
-      assert_match /\/home\/[a-zA-Z0-9]+\/\.Skype\/aidzis_skype\/main\.db/, path
-    else
-      assert_match /~\/Library\/Application Support\/Skype\/aidzis_skype\/main\.db/, path
-    end
-  end
-
-  def test_must_replace_backslashes_with_forward_slashes_and_remowe_drive_letter
-    windows_path = 'C:\\Users\\user\\AppData\\Roaming\\Skype'
-    unix_style_path = Runoff::Location.send :format_windows_path, windows_path
-
-    assert_equal '/Users/user/AppData/Roaming/Skype', unix_style_path
-  end
-end