runoff 1.0.1 → 2.0.0

data/lib/runoff/skype_data_format.rb

@@ -1,128 +0,0 @@
-module Runoff
-  # Defines methods to hide the specific format that is used in the Skype database.
-  class SkypeDataFormat
-    # Public: Defines what kind of information can be queried from the database.
-    #
-    # Example
-    #
-    #   get_schema do |table, columns|
-    #     # SELSECT *columns FROM table
-    #   end
-    #
-    #   get_schema
-    #   # => { table: :Messages, columns: [:chatname, :timestamp, :from_dispname, :body_xml] }
-    #
-    # Returns a hash with keys "table" and "columns" if no block is given.
-    def get_schema
-      if block_given?
-        yield :Messages, [:chatname, :timestamp, :from_dispname, :body_xml]
-      else
-        return {
-          table: :Messages,
-          columns: [:chatname, :timestamp, :from_dispname, :body_xml]
-        }
-      end
-    end
-
-    # Public: Provides a filename and the data that should be written to the file.
-    #
-    # fields - an array representing a single entry in the database.
-    #
-    # Examples
-    #
-    #   build_entry {
-    #     chatname: "#john/$doe;1243435",
-    #     from_dispname: "John",
-    #     body_xml: "Lorem ipsum",
-    #     timestamp: 12435463
-    #   } # => { filename: john-doe.txt, content: "[2013-12-27 12:23:43] John: Lorem ipsum" }
-    #
-    # Returns a hash with "filename" and "content" keys.
-    def build_entry(fields)
-      chatname = fields[:chatname]
-      username = fields[:from_dispname]
-      message  = parse_xml fields[:body_xml]
-      datetime = Time.at(fields[:timestamp]).strftime "%Y-%m-%d %H:%M:%S"
-
-      {
-        filename: get_filename(chatname),
-        content: "[#{datetime}] #{username}: #{message}\n"
-      }
-    end
-
-    # Public: Parse a into a human readable format.
-    #
-    # chatname - a string that must be normalized.
-    #
-    # Examples
-    #
-    #   normalize "#john/$doe;2354657"
-    #   # => john-doe
-    #
-    # Returns a string without unnecessary characters.
-    def normalize(chatname)
-      pattern = /^#(.+)\/\$(.+)?;.*$/
-      initiator, respondent = chatname.match(pattern).captures
-
-      "#{initiator}-#{respondent}".gsub(/(^-+|-+$)/, '')
-    end
-
-    # Public: Converts a string that is similar to the chat title stored
-    #         in the Skype database.
-    #
-    # dispname - a string that is displayed to the user as a chat title.
-    #
-    # Examples
-    #
-    #   denormalize "john-doe"
-    #   # => "#john/$doe;"
-    #
-    # Returns a string that can be used to query Skype database.
-    def denormalize(dispname)
-      parts = dispname.split '-'
-
-      parts.count == 2 ? "##{parts[0]}/$#{parts[1]};" : "##{parts[0]}/$;"
-    end
-
-    private
-
-    # Internal: Parses a string into a valid file name.
-    #
-    # chatname - a string that must be converted into a valid filename.
-    #
-    # Examples
-    #
-    #   get_filename "#john/$doe;2354657"
-    #   # => john-doe.txt
-    #
-    # Returns a string that can be used as a file name.
-    def get_filename(chatname)
-      normalize(chatname) + ".txt"
-    end
-
-    # Internal: removes unnecessary XML code from the message.
-    #
-    # message - a string to parse
-    #
-    # Examples
-    #
-    #   parse_xml "<ss type="smile">:)</ss>"
-    #   # => ":)"
-    #
-    # Returns an XML-free string.
-    def parse_xml(message)
-      if message
-        message = message.gsub /<ss type=".*">/, ''
-        message = message.gsub /<\/ss>/, ''
-        message = message.gsub /<a href=".*">/, ''
-        message = message.gsub /<\/a>/, ''
-        message = message.gsub /&apos;/, "'"
-        message = message.gsub /&lt;/, '<'
-        message = message.gsub /&gt;/, '>'
-        message = message.gsub /&quot;/, '"'
-      end
-
-      message
-    end
-  end
-end

data/test/skype_data_format_test.rb

@@ -1,58 +0,0 @@
-require 'minitest/autorun'
-require 'runoff'
-
-describe Runoff::SkypeDataFormat do
-  before do
-    @format = Runoff::SkypeDataFormat.new
-  end
-
-  it "must return a schema of the necessary data" do
-    expected = { table: :Messages, columns: [:chatname, :timestamp, :from_dispname, :body_xml] }
-
-    @format.get_schema.must_equal expected
-  end
-
-  it "must yield a schema of the necessary data to a block" do
-    @format.get_schema do |table, columns|
-      table.must_equal :Messages
-      columns.must_equal [:chatname, :timestamp, :from_dispname, :body_xml]
-    end
-  end
-
-  it "must return a hash with 'filename' and 'content' keys based on the input data" do
-    fields = {
-      chatname: "#john/$doe;1243435",
-      from_dispname: "John",
-      body_xml: "Lorem ipsum",
-      timestamp: 1387756800
-    }
-
-    expected = { filename: "john-doe.txt", content: "[2013-12-23 02:00:00] John: Lorem ipsum\n" }
-
-    @format.build_entry(fields).must_equal expected
-  end
-
-  it "must normalize a Skype specific chat title into a human readable string" do
-    @format.normalize('#john/$doe;2354657').must_equal 'john-doe'
-  end
-
-  it "must normalize a Skype specific chat title into a human readable string even in case of invalid title" do
-    @format.normalize('#john/$;2354657').must_equal 'john'
-  end
-
-  it "must parse a Skype specific chat title into a valid file name" do
-    @format.send(:get_filename, '#john/$doe;2354657').must_equal 'john-doe.txt'
-  end
-
-  it "must parse a Skype specific chat title into a valid file name even in case of invalid title" do
-    @format.send(:get_filename, '#john/$;2354657').must_equal 'john.txt'
-  end
-
-  it "must denormalize a human readable chat title into a string that can be used in a database query" do
-    @format.denormalize('john-doe').must_equal '#john/$doe;'
-  end
-
-  it "must denormalize a human readable, invalid chat title into a string that can be used in a database query" do
-    @format.denormalize('john').must_equal '#john/$;'
-  end
-end