runoff 0.3.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f33b77e8bf4d95208d8ca83a3f60eac94776c49f
-  data.tar.gz: 01b49cd3d84adf0bb8390a5b74683e7fdd1c5deb
+  metadata.gz: 25b2af0e2aa5ad4b5a8a408e3b5d0f61198970c8
+  data.tar.gz: 00cea274e9778ac292e31139cd9b246423e76532
 SHA512:
-  metadata.gz: bd54f5eec46b95cc771ac6e42819b45cc2219c0cefa9b7202f8b788a377762b22a3a93cd2270c04a5bf99f24f21e7491088c1bde8f1e9115ba8ee2ab0dfa916a
-  data.tar.gz: a966fdb49e9f9b109141ec509d123d8e8dcd5e3f3ea549f11360bd448868f0246dda20450a884b12bcc7ec7f86cc1efcb4e251daa902bd3adf9fc19721b820e2
+  metadata.gz: 0f4434fecb2f3b0b6c942a7032cf7ad1892793d641ac4530a7f6e5bb81f64765b3cd4434c115ed6f5f6f9d3c6c98643ac5dd0dc0292ecb26f0e109bf4de61f1d
+  data.tar.gz: bf8051d987612af62f91f421e2fc98057594dbabdf7345167159aea259619f3dc106d6edb6418fed4483828fe06090c36663be117aa326adbc027d72226d550d

data/.gitignore

@@ -1,17 +1,18 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# gem's dependencies are specified in runoff.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# gem's dependencies are specified in runoff.gemspec
+gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2013 Aigars Dzerviniks
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+Copyright (c) 2013 Aigars Dzerviniks
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,40 +1,41 @@
-# 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.
-
-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 commandline tool, that automates the process of exporting your chat history.
-
-## Install
-
-    gem install runoff
-
-## Usage
-
-To export all the chat history.
-
-    # save a Zip archive in your home directory
-    runoff all skype_username
-
-    # save a Zip archive in a specific directory
-    runoff all skype_username -d ~/backups
-
-    # export database that isn't located in the default path
-    runoff all -f ~/main.db -d ~/backups
-
-To export specific chats.
-
-    runoff chat skype_username
-
-If you don't want to put files into an archive, use `-a` option
-
-    runoff all skype_username -a false
-
-## What else?
-
-Things to do in the future versions:
-
-- Parse body_xml to filter XML tags and character entities.
-- Append only new messages to the previously genetrated files instead of appending everything or create different versions for the files when using `-a false` option.
-
-If you have something to say about this gem or anything else, you can find me on Twitter as [@aigarsdz](http://twitter.com/aigarsdz "@aigarsdz").
+# 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.
+
+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.
+
+## Install
+
+    gem install runoff
+
+## Usage
+
+To export all the chat history.
+
+    # save a Zip archive in your home directory
+    runoff all skype_username
+
+    # save a Zip archive in a specific directory
+    runoff all skype_username -d ~/backups
+
+    # export database that isn't located in the default path
+    runoff all -f ~/main.db -d ~/backups
+
+To export specific chats.
+
+    runoff some skype_username
+
+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
+
+## What else?
+
+Things to do in the future versions:
+
+Nothing. For now.
+
+If you have something to say about this gem or anything else, you can find me on Twitter as [@aigarsdz](http://twitter.com/aigarsdz "@aigarsdz").

data/Rakefile

@@ -1,8 +1,8 @@
-require "bundler/gem_tasks"
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.test_files = FileList['test/*_test.rb']
-  t.verbose = true
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
 end

data/bin/runoff

@@ -1,34 +1,58 @@
-#!/usr/bin/env ruby
-
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
-require 'commander/import'
-require 'runoff'
-
-program :name, 'runoff'
-program :version, Runoff::VERSION
-program :description, 'runoff is a simple application to create Skype backups'
-
-default_command :help
-
-global_option '-f', '--from FILE', 'Location of the main.db file'
-global_option '-d', '--destination DIR', 'Location for the exoprted files'
-global_option '-a', '--archive', 'Save files in a Zip archive (defaults to true)'
-
-command :all do |command|
-  command.syntax = 'runoff all [SKYPE_USERNAME] [OPTIONS]'
-  command.description = 'Export all chat history'
-
-  command.action do |args, options|
-    Runoff::Commands::All.process args, options.__hash__
-  end
-end
-
-command :chat do |command|
-  command.syntax = 'runoff chat [SKYPE_USERNAME] [OPTIONS]'
-  command.description = 'Export pecified chats history'
-
-  command.action do |args, options|
-    Runoff::Commands::Chat.process args, options.__hash__
-  end
-end
+#!/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.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.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.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.colorize :red
+    end
+  end
+end

data/lib/runoff/commands/all.rb

@@ -1,36 +1,22 @@
-module Runoff
-  # Public: Commands that can be executed by the application.
-  module Commands
-    # Public: Command to export all Skype chat history.
-    #
-    # Examples
-    #
-    #   All.process ['username'], { from: '/path/to/main.db' }
-    class All < Command
-      # Public: Export all chats.
-      #
-      # args - Array containing skype username
-      # options - Hash containing user provided options
-      #
-      # Examples
-      #
-      #   All.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]
-
-        self.print_result composition.export(destination)
-        self.try_to_archive destination, options[:archive]
-
-      rescue ArgumentError => e
-        puts e
-      rescue IOError => e
-        puts e
-      end
-    end
-  end
-end
+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,85 +1,19 @@
-module Runoff
-  # Public: Commands that can be executed by the application.
-  module Commands
-    # Public: Methods that are shared between different commands.
-    class Command
-      private
-      # Internal: Gets a Composition object.
-      #
-      # skype_username - A String that contains a username of the Skype account,
-      #                  which database we want to access.
-      # optional_path - A String that contains path to a main.db file (Skype's database).
-      #
-      # Examples
-      #
-      #   get_composition 'skype_username', ''
-      #   # => #<Composition:0x00002324212>
-      #
-      # Returns a Composition object with a reference to a specific Skype database.
-      def self.get_composition(skype_username, optional_path)
-        Runoff::Composition.new optional_path, skype_username
-      end
-
-      # Internal: Gets a destination path depending on the entered options.
-      #
-      # optional_path - A String that contains path where to save exported files.
-      #
-      # Examples
-      #
-      #   get_destination ''
-      #   # => '~/skype_backup'
-      #
-      # Returns a String containing a path to the destination directory.
-      def self.get_destination(optional_path)
-        optional_path || "#{ENV['HOME']}/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 self.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 self.list_chatnames(chatnames)
-        chatnames.each_with_index { |n, i| puts "[#{i}] #{n}" }
-        puts
-      end
-
-      # Internal: performs archiving if an --archive option is provided
-      #
-      # destination - A String containing a path to the export directory.
-      # is_archive_enebled - A flag indicating whether to create an archive.
-      #
-      # Examples
-      #
-      #   try_to_archive '/home/username/skype-backup', { archive: false }
-      def self.try_to_archive(destination, is_archive_enebled)
-        unless is_archive_enebled
-          Runoff::FileWriter.archive destination
-        end
-      rescue StandardError => e
-        puts e
-        puts 'Faild to create an archive'
-      end
-    end
-  end
+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 '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

@@ -0,0 +1,38 @@
+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

data/lib/runoff/file_writer.rb

@@ -1,53 +1,84 @@
-require 'zip'
-require 'fileutils'
-
-module Runoff
-  # Public: Methods used for writing to files.
-  class FileWriter
-    # Public: Initialize a FileWriter object.
-    #
-    # format - An object containing necessary methods for data formating.
-    def initialize(format)
-      @format = format
-    end
-    # Public: Saves a single chat message to a file.
-    #
-    # record - a Hash containing data about a single chat message.
-    # output_directory - A String with the path to the directory, wher the file will be saved.
-    #
-    # Examples
-    #
-    #   save_to_file record, '/home/username/skype_backup'
-    def save_to_file(record, output_directory)
-      filename = "#{output_directory}/#{@format.get_filename(record)}"
-
-      Dir.mkdir(output_directory) unless File.exists?(output_directory)
-      File.open(filename, 'a') do |file|
-        file.puts @format.build_entry(record)
-      end
-
-      filename
-    end
-
-    # Public: Compresses all the exported files into a Zip archive.
-    #
-    # output_directory - A String with the path to the directory, wher the file will be saved.
-    #
-    # Examples
-    #
-    #   archive '/home/username/skype-backup'
-    def self.archive(output_directory)
-      timestamp = Time.now.strftime "%Y%m%d%H%M%S"
-
-      Zip::File.open "#{output_directory}-#{timestamp}.zip", Zip::File::CREATE do |zipfile|
-        Dir.entries(output_directory).each do |file|
-          if File.file?("#{output_directory}/#{file}")
-            zipfile.add file, "#{output_directory}/#{file}"
-          end
-        end
-      end
-
-      FileUtils.rm_rf output_directory
-    end
-  end
-end
+require 'zip'
+require 'fileutils'
+
+module Runoff
+  class FileWriter
+    attr_accessor :selected_entries
+
+    def initialize(db_handler)
+      @db_handler = db_handler
+      @selected_entries = []
+    end
+
+    # Public: Exports all the 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(data_format, export_path, create_archive)
+      @export_path = export_path
+
+      schema  = data_format.get_schema
+      dataset = @db_handler[schema[:table]]
+      dataset = dataset.select(*schema[:columns])
+
+      dataset.each do |row|
+        write data_format.build_entry(row)
+      end
+
+      archive unless create_archive == false
+    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}%"))
+
+        dataset.each { |row| write data_format.build_entry(row) }
+      end
+
+      archive unless create_archive == false
+    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: 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
+      end
+
+      # Delete the destination directory because it is no longer needed.
+      FileUtils.rm_r @export_path
+    end
+  end
+end