runoff 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07466177c09c57169067c0d8a59dbc5ad4e4d921
-  data.tar.gz: 660f59d6d1adfa80f4bd7a9931988ebb446aa7d2
+  metadata.gz: 68f134e0964050cf348514719437dde550790071
+  data.tar.gz: 23af26df004e1810c9a6b937ca161932eb157ef1
 SHA512:
-  metadata.gz: 4f26579401ab7ac73d8a7447a9101c190a4241f5dc1d95cd916542018211139b91eb3613f751eef813a372b74ff4c9b75e4d0cd8c4d6d677451c1d47d0c4677e
-  data.tar.gz: db956c7fcc9b3abf62149162b2bf68996b93c34d149d0321f9fb04f710df9b435627ee2fc7555ee05e372b4c103864834f450a150d415810d1fd371970c214d4
+  metadata.gz: ff8e74e3aab2ec0a04d05c08e9544afc4fffeadf1d479549a45349627aeb200e9db76afb3ef52be5113f06ae1733289928d8f8416efd0c07110e6065d7c85963
+  data.tar.gz: f286bd9541f12f7b5b9ab04b2f3e6c2670b8cf27bb15b0c8ef56a979005f717e774bea8473f54f073691b51343d7038e5ef58ca65914ef68cfd164f845f42a0d

data/.gitignore

@@ -1,17 +1,17 @@
-*.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

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,45 +1,42 @@
-# 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 all the files in your home directory
-    runoff all skype_username
-
-    # save the files in a specific directory
-    runoff all skype_username -t ~/skype_backup
-
-    # export database that isn't located in the default path
-    runoff all -f ~/main.db -t ~/skype_backup
-
-To export specific chats.
-
-    runoff chat skype_username -t ~/skype_backup
-
-If you don't want to put files into an archive, use `--no-archive` option
-
-    runoff all skype_username --no-archive
-
-If you're confused, you can get some help.
-
-    runoff help all
-
-## 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 `--no-archive option`.
-- Add some colors.
-
-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 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 `--no-archive` option
+
+    runoff all skype_username -a false
+
+## What else?
+
+Things to do in the future versions:
+
+- Refactore tests (move from MiniTest::Spec to MiniTest::Unit).
+- 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.
+- Add some colors.
+
+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,7 +1,34 @@
-#!/usr/bin/env ruby
-
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
-require 'runoff'
-
-Runoff::Source.start ARGV
+#!/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

data/lib/runoff/commands/all.rb

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

data/lib/runoff/commands/chat.rb

@@ -0,0 +1,37 @@
+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/commands/command.rb

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

data/lib/runoff/composition.rb

@@ -1,103 +1,105 @@
-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
-    include FileWriter
-
-    # 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.
-    #
-    # Raises IOError if the file cannot be found
-    def initialize(main_db_file_path)
-      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
-    end
-
-    # Public: Exports Skype chat history to text files.
-    #
-    # 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| partly_parse_chatname record[:chatname] }.uniq
-      clean_chatnames = raw_chatnames.map { |chatname| 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 = save_to_file(record, destination_path)
-          @exported_filenames << filename
-        end
-      end
-
-      @exported_filenames.count
-    end
-  end
-end
+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