runoff 0.2.0 → 0.3.0

data/test/file_writer_test.rb

@@ -0,0 +1,80 @@
+require 'minitest/unit'
+require 'runoff'
+require 'fileutils'
+
+describe Runoff::FileWriter do
+  before do
+    @incorrect_chat_record = {
+      chatname: '#john/$;521357125362',
+      timestamp: 1366280218,
+      from_dispname: 'Aidzis',
+      body_xml: 'This is a text'
+    }
+
+    @chat_record = {
+      chatname: '#braun/$drake;521357125362',
+      timestamp: 1366280218,
+      from_dispname: 'Aidzis',
+      body_xml: 'This is a text.'
+    }
+
+    correct_format = MiniTest::Mock.new
+
+    correct_format.expect :get_filename, 'something-more', [Hash]
+    correct_format.expect :get_filename, 'something-more', [Hash]
+    correct_format.expect :build_entry, '[2013-04-18 13:16:58] Aidzis: This is a text.', [Hash]
+    correct_format.expect :build_entry, '[2013-04-18 13:16:58] Aidzis: This is a text.', [Hash]
+
+    @correct_file_writer = Runoff::FileWriter.new correct_format
+
+    incorrect_format = MiniTest::Mock.new
+
+    incorrect_format.expect :get_filename, 'something', [Hash]
+    incorrect_format.expect :build_entry, '[2013-04-18 13:16:58] Aidzis: This is a text.', [Hash]
+
+    @incorrect_file_writer = Runoff::FileWriter.new incorrect_format
+  end
+
+  describe "#save_to_file" do
+    after do
+      FileUtils.rm_rf 'test/tmp'
+      Dir.glob('test/*.zip').each do |archive|
+        File.delete archive
+      end
+    end
+
+    it 'must write chat content to file' do
+      @correct_file_writer.save_to_file @chat_record, 'test/tmp'
+      @incorrect_file_writer.save_to_file @incorrect_chat_record, 'test/tmp'
+      Dir.glob('test/tmp/*.txt').count.must_equal 2
+    end
+
+    it 'must append to a file if the filename already exists' do
+      @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'
+      Dir.glob('test/tmp/*.txt').count.must_equal 2
+    end
+  end
+
+  it 'must create a Zip file of the file output directory' do
+    output_directory = 'test/tmp'
+    files = %w[first.txt second.txt]
+
+    Dir.mkdir(output_directory) unless File.exists?(output_directory)
+    files.each do |filename|
+      File.new "#{output_directory}/#{filename}", 'w'
+    end
+
+    Runoff::FileWriter.archive output_directory
+    Dir["test/*.zip"].length.must_equal 1
+
+    Dir.glob('test/*.zip').each do |archive|
+      File.delete archive
+    end
+
+    FileUtils.rm_rf 'test/tmp'
+  end
+end

data/test/{runoff_locations_test.rb → location_test.rb}

@@ -1,31 +1,19 @@
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'runoff'
-
-describe Runoff::Location do
-  describe '.default_skype_data_location' do
-    it 'must return a default path depending on the operating system' do
-      path = Runoff::Location.default_skype_data_location 'aidzis_skype'
-
-      if RbConfig::CONFIG['host_os'] =~ /mingw/
-        path.must_match /\/Users\/[a-zA-Z0-9]+\/AppData\/Roaming\/Skype\/aidzis_skype\/main\.db/
-      elsif RbConfig::CONFIG['host_os'] =~ /linux/
-        path.must_match /\/home\/[a-zA-Z0-9]+\/\.Skype\/aidzis_skype\/main\.db/
-      else
-        path.must_match /~\/Library\/Application Support\/Skype\/aidzis_skype\/main\.db/
-      end
-    end
-  end
-
-  describe '.home_path' do
-    it 'must return a path to the user home directory depending on the operating system' do
-      path = Runoff::Location.home_path
-
-      if RbConfig::CONFIG['host_os'] =~ /mingw/
-        path.must_match /[A-Z]:\\Users\\[a-zA-Z0-9]+/
-      else
-        path.must_match /\/home\/[a-zA-Z0-9]+/
-      end
-    end
-  end
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'runoff'
+
+describe Runoff::Location do
+  describe '.default_skype_data_location' do
+    it 'must return a default path depending on the operating system' do
+      path = Runoff::Location.default_skype_data_location 'aidzis_skype'
+
+      if RbConfig::CONFIG['host_os'] =~ /mingw/
+        path.must_match /\/Users\/[a-zA-Z0-9]+\/AppData\/Roaming\/Skype\/aidzis_skype\/main\.db/
+      elsif RbConfig::CONFIG['host_os'] =~ /linux/
+        path.must_match /\/home\/[a-zA-Z0-9]+\/\.Skype\/aidzis_skype\/main\.db/
+      else
+        path.must_match /~\/Library\/Application Support\/Skype\/aidzis_skype\/main\.db/
+      end
+    end
+  end
 end

data/test/skype_data_format_test.rb

@@ -0,0 +1,70 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'runoff'
+
+describe Runoff::SkypeDataFormat do
+  before do
+    @format = Runoff::SkypeDataFormat.new
+  end
+
+  it 'must return a valid filename from a hash (single record in a database)' do
+    record = { chatname: '#brian/$john;521357125362' }
+    filename = @format.get_filename record
+
+    filename.must_equal 'brian-john.txt'
+  end
+
+  it 'must build a string from the necessary database record columns' do
+    record = {
+      chatname: '#brian/$john;521357125362',
+      timestamp: 1366280218,
+      from_dispname: 'Aidzis',
+      body_xml: 'This is a text.'
+    }
+    entry = @format.build_entry record
+
+    entry.must_equal '[2013-04-18 13:16:58] Aidzis: This is a text.'
+  end
+
+  it 'must return a valid and readable name from a raw chatname' do
+    raw_chatname = '#something/$else;521357125362'
+    chatname = @format.parse_chatname raw_chatname
+
+    chatname.must_equal 'something-else'
+  end
+
+  it 'must return a valid and readable name from broken chatname records' do
+    raw_chatname = '#something/$521357125362'
+    chatname = @format.parse_chatname raw_chatname
+
+    chatname.must_equal 'something'
+  end
+
+  it 'must return a chatname without the extra symbols' do
+    raw_chatname = '#something/$else;521357125362'
+    chatname = @format.partly_parse_chatname raw_chatname
+
+    chatname.must_equal '#something/$else;'
+  end
+
+  it 'must return a chatname without the extra symbols for broken chatname records' do
+    raw_chatname = '#something/$521357125362'
+    chatname = @format.partly_parse_chatname raw_chatname
+
+    chatname.must_equal '#something/$'
+  end
+
+  it 'must return a string without Skype emotion XML tags' do
+    string = 'Some text <ss type="laugh">:D</ss>'
+    clean_string = @format.send :parse_body_xml, string
+
+    clean_string.must_equal 'Some text :D'
+  end
+
+  it 'must remove all starting and ending dashes from a string' do
+    string = '---example--'
+    valid_name = @format.send :trim_dashes, string
+
+    valid_name.must_equal 'example'
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: runoff
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aigars Dzerviniks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -82,16 +82,22 @@ files:
 - Rakefile
 - 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/file_writer.rb
 - lib/runoff/location.rb
-- lib/runoff/source.rb
+- lib/runoff/skype_data_format.rb
 - lib/runoff/version.rb
 - runoff.gemspec
-- test/runoff_composition_test.rb
-- test/runoff_file_writer_test.rb
-- test/runoff_locations_test.rb
-- test/runoff_source_test.rb
+- 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
 licenses:
@@ -113,13 +119,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: Tool to export Skype chat history from the SQLite database to text files
 test_files:
-- test/runoff_composition_test.rb
-- test/runoff_file_writer_test.rb
-- test/runoff_locations_test.rb
-- test/runoff_source_test.rb
+- 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/source.rb

@@ -1,171 +0,0 @@
-require 'thor'
-
-# Public: Provides the functionality to back up Skype chat history.
-#
-# Examples
-#
-#   runoff all skype_username
-#   # => Finished: 8 files were exported
-module Runoff
-
-  # Public: Entry point for the executable. Processes the CLI input from the user.
-  class Source < Thor
-    desc 'all [SKYPE_USERNAME] [OPTIONS]', 'Export all chat history'
-
-    long_desc <<-LONGDESC
-      runoff all [SKYPE_USERNAME] [OPTIONS] will export all your Skype chat history as text files.
-
-      SKYPE_USERNAME - the Skype account username, which data you want to access
-    LONGDESC
-
-    method_option :from, aliases: '-f', desc: 'Specify the location of the main.db file'
-    method_option :to, aliases: '-t', desc: 'Specify where to put export files'
-    method_option :archive, aliases: '-a', type: :boolean, default: true,
-                  desc: 'Specify whether to save files in a Zip archive'
-
-    # Public: Exports all chat history from the Skype database.
-    #
-    # skype_username - A String that contains a username of the Skype account,
-    #                  which database we want to access.
-    #
-    # Examples
-    #
-    #   all 'skype_username'
-    #   # => Finished: 8 files were exported
-    def all(skype_username = nil)
-      composition = get_composition skype_username
-      destination = get_destination
-
-      print_result composition.export(destination)
-      try_to_archive composition, destination
-
-    rescue IOError => e
-      puts e
-    rescue StandardError => e
-      puts e
-    end
-
-    desc 'chat [SKYPE_USERNAME] [OPTIONS]', 'Export pecified chats history'
-
-    long_desc <<-LONGDESC
-      runoff chat [SKYPE_USERNAME] [OPTIONS] will export all your Skype chat history as text files.
-
-      SKYPE_USERNAME - the Skype account username, which data you want to access
-    LONGDESC
-
-    method_option :from, aliases: '-f', desc: 'Specify the location of the main.db file'
-    method_option :to, aliases: '-t', desc: 'Specify where to put export files'
-    method_option :archive, aliases: '-a', type: :boolean, default: true,
-                  desc: 'Specify whether to save files in a Zip archive'
-
-    # Public: Exports specified chats from the Skype database.
-    #
-    # skype_username - A String that contains a username of the Skype account,
-    #                  which database we want to access.
-    #
-    # Examples
-    #
-    #   chat 'skype_username'
-    #   # => Finished: 3 files were exported
-    def chat(skype_username = nil)
-      composition = get_composition skype_username
-      destination = get_destination
-      chatnames, raw_chatnames = composition.get_chatnames
-
-      list_chatnames chatnames
-      indecies = ask 'Which chats do you want to export? (Enter indecies) '
-      indecies = indecies.split.map { |index| index.to_i }
-      selected_chatnames = []
-
-      indecies.each { |index| selected_chatnames << raw_chatnames[index] }
-      print_result composition.export_chats(selected_chatnames, destination)
-      try_to_archive composition, destination
-
-    rescue IOError => e
-      puts e
-    rescue StandardError => e
-      puts e
-    end
-
-    private
-
-    # Internal: Gets a Composition object.
-    #
-    # skype_username - A String that contains a username of the Skype account,
-    #                  which database we want to access.
-    #
-    # Examples
-    #
-    #   get_composition 'skype_username'
-    #   # => #<Composition:0x00002324212>
-    #
-    # Returns a Composition object with a reference to a specific Skype database.
-    # Raises StandardError if no Skype username or --from option is provided.
-    def get_composition(skype_username)
-      unless skype_username || options[:from]
-        raise StandardError, 'You must provide a Skype username or a --from option'
-      end
-
-      main_db_file_location = options[:from] || Location.default_skype_data_location(skype_username)
-      Composition.new main_db_file_location
-    end
-
-    # Internal: Gets a destination path depending on the entered options.
-    #
-    # Examples
-    #
-    #   get_destination
-    #   # => '~/skype_backup'
-    #
-    # Returns a String containing a path to the destination directory.
-    def get_destination
-      options[:to] || "#{Location.home_path}/skype-backup"
-    end
-
-    # Internal: Informs the user that the application has finished running.
-    #
-    # count - A number of files that have been exported
-    #
-    # Examples
-    #
-    #   print_result 4
-    #   # => Finished: 4 files were exported
-    def print_result(count)
-      if count == 1
-        puts 'Finished: 1 file was exported'
-      elsif count > 1
-        puts "Finished: #{count} files were exported"
-      end
-    end
-
-    # Internal: Prints available chatnames.
-    #
-    # chatnames - An Array containing the chatname strings
-    #
-    # Examples
-    #
-    #   list_chatnames ['something-more', 'something-else']
-    #   # => [0] something-more
-    #        [1] something-else
-    def list_chatnames(chatnames)
-      chatnames.each_with_index { |n, i| puts "[#{i}] #{n}" }
-      puts
-    end
-
-    # Internal: performs archiving if an --archive option is provided
-    #
-    # composition - A Compositon object
-    # destination - A String containing a path to the export directory.
-    #
-    # Examples
-    #
-    #   try_to_archive composition, '/home/username/skype-backup'
-    def try_to_archive(composition, destination)
-      if options[:archive]
-        composition.archive destination
-      end
-    rescue StandardError
-      puts 'Faild to create an archive'
-    end
-  end
-end

data/test/runoff_file_writer_test.rb

@@ -1,115 +0,0 @@
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'runoff'
-
-describe Runoff::FileWriter do
-  before do
-    @incorrect_chat_record = {
-      chatname: '#something/$;521357125362',
-      timestamp: 1366280218,
-      from_dispname: 'Aidzis',
-      body_xml: ''
-    }
-    @chat_record = {
-      chatname: '#something/$more;521357125362',
-      timestamp: 1366280218,
-      from_dispname: 'Aidzis',
-      body_xml: 'This is a text.'
-    }
-
-    class ClassWithFileWriterMixin
-      include Runoff::FileWriter
-    end
-
-    @test_object = ClassWithFileWriterMixin.new
-  end
-
-  it 'must return a string without Skype emotion XML tags' do
-    string = 'Some text <ss type="laugh">:D</ss>'
-    clean_string = @test_object.parse_body_xml string
-
-    clean_string.must_equal 'Some text :D'
-  end
-
-  it 'must remove all starting and ending dashes from a string' do
-    string = '---example--'
-    valid_name = @test_object.trim_dashes string
-
-    valid_name.must_equal 'example'
-  end
-
-  it 'must return a valid and readable name from a raw chatname' do
-    raw_chatname = '#something/$else;521357125362'
-    chatname = @test_object.parse_chatname raw_chatname
-
-    chatname.must_equal 'something-else'
-  end
-
-  it 'must return a valid and readable name from broken chatname records' do
-    raw_chatname = '#something/$521357125362'
-    chatname = @test_object.parse_chatname raw_chatname
-
-    chatname.must_equal 'something'
-  end
-
-  it 'must return a chatname without the extra symbols' do
-    raw_chatname = '#something/$else;521357125362'
-    chatname = @test_object.partly_parse_chatname raw_chatname
-
-    chatname.must_equal '#something/$else;'
-  end
-
-  it 'must return a chatname without the extra symbols for broken chatname records' do
-    raw_chatname = '#something/$521357125362'
-    chatname = @test_object.partly_parse_chatname raw_chatname
-
-    chatname.must_equal '#something/$'
-  end
-
-  it 'must build a chat entry from a database record' do
-    entry = @test_object.build_entry @chat_record
-
-    entry.must_equal '[2013-04-18 13:16:58] Aidzis: This is a text.'
-  end
-
-  describe "#save_to_file" do
-    after do
-      FileUtils.rm_rf 'test/tmp/.'
-      Dir.glob('test/*.zip').each do |archive|
-        File.delete archive
-      end
-    end
-
-    it 'must write chat content to file' do
-      @test_object.save_to_file @chat_record, 'test/tmp'
-      @test_object.save_to_file @incorrect_chat_record, 'test/tmp'
-      Dir['test/tmp/**/*'].length.must_equal 2
-    end
-
-    it 'must append to a file if the filename already exists' do
-      @additional_chat_record = @chat_record
-
-      @test_object.save_to_file @chat_record, 'test/tmp'
-      @test_object.save_to_file @incorrect_chat_record, 'test/tmp'
-      @test_object.save_to_file @additional_chat_record, 'test/tmp'
-      Dir['test/tmp/**/*'].length.must_equal 2
-    end
-  end
-
-  it 'must create a Zip file of the file output directory' do
-    output_directory = 'test/tmp'
-    files = %w[first.txt second.txt]
-
-    Dir.mkdir(output_directory) unless File.exists?(output_directory)
-    files.each do |filename|
-      File.new "#{output_directory}/#{filename}", 'w'
-    end
-
-    @test_object.archive output_directory
-    Dir["test/*.zip"].length.must_equal 1
-
-    Dir.glob('test/*.zip').each do |archive|
-      File.delete archive
-    end
-  end
-end

data/test/runoff_source_test.rb

@@ -1,35 +0,0 @@
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'runoff'
-
-describe Runoff::Source do
-  before { @source = Runoff::Source.new }
-
-  after do
-    FileUtils.rm_rf 'test/tmp/.'
-    Dir.glob('test/*.zip').each do |archive|
-      File.delete archive
-    end
-  end
-
-  it 'must export all the chats from a Skype database into text files and print a count of the exported files' do
-    command = 'all -f test/test_db.sqlite -t test/tmp'
-
-    ->{ Runoff::Source.start command.split }.must_output "Finished: 2 files were exported\n"
-  end
-
-  it 'must raise a StandardError if no Skype username or --form option is provided' do
-    ->{ @source.send :get_composition, nil }.must_raise StandardError
-  end
-
-  it 'must print how many files were exported' do
-    ->{ @source.send :print_result, 1 }.must_output "Finished: 1 file was exported\n"
-    ->{ @source.send :print_result, 5 }.must_output "Finished: 5 files were exported\n"
-  end
-
-  it 'must print all available chatnames' do
-    chatnames = ['something-more', 'something-else']
-
-    ->{ @source.send :list_chatnames, chatnames }.must_output "[0] something-more\n[1] something-else\n\n"
-  end
-end