pidgin2adium 3.3.0 → 4.0.0.beta1

data/lib/pidgin2adium/adium_chat_file_creator.rb

@@ -0,0 +1,64 @@
+require "pathname"
+
+module Pidgin2Adium
+  class AdiumChatFileCreator
+    def initialize(file_path, aliases, output_directory = Runner::ADIUM_LOG_DIRECTORY)
+      @file_path = file_path
+      @aliases = aliases
+      @output_directory = Pathname.new(output_directory.to_s)
+    end
+
+    def create
+      create_containing_directory
+      File.open(path, 'w') do |file|
+        file.puts xml_prolog
+        file.puts opening_chat_tag
+        file.puts chat.to_s
+        file.puts closing_chat_tag
+      end
+    end
+
+    private
+
+    def create_containing_directory
+      FileUtils.mkdir_p(File.dirname(path))
+    end
+
+    def path
+      @output_directory.join(
+        "#{normalized_service}.#{chat.my_screen_name}",
+        chat.their_screen_name,
+        "#{chat.their_screen_name} (#{formatted_start_time}).chatlog",
+        "#{chat.their_screen_name} (#{formatted_start_time}).xml"
+      )
+    end
+
+    def xml_prolog
+      %(<?xml version="1.0" encoding="UTF-8" ?>)
+    end
+
+    def opening_chat_tag
+      %(<chat xmlns="http://purl.org/net/ulf/ns/0.4-02" account="#{chat.my_screen_name}" service="#{normalized_service}" adiumversion="1.5.9">)
+    end
+
+    def closing_chat_tag
+      "</chat>"
+    end
+
+    def formatted_start_time
+      chat.start_time.xmlschema.sub(/:00$/, "00")
+    end
+
+    def normalized_service
+      if chat.service == "aim"
+        "AIM"
+      else
+        chat.service
+      end
+    end
+
+    def chat
+      @chat ||= Pipio.parse(@file_path, @aliases)
+    end
+  end
+end

data/lib/pidgin2adium/file_finder.rb

@@ -0,0 +1,23 @@
+module Pidgin2Adium
+  class FileFinder
+    EXTENSIONS = %w(html htm txt)
+
+    def initialize(directory)
+      @directory = File.expand_path(directory)
+    end
+
+    def find
+      Dir[glob]
+    end
+
+    private
+
+    def glob
+      File.join(@directory, "**/*.{#{comma_separated_extensions}}")
+    end
+
+    def comma_separated_extensions
+      EXTENSIONS.join(",")
+    end
+  end
+end

data/lib/pidgin2adium/runner.rb

@@ -0,0 +1,23 @@
+module Pidgin2Adium
+  class Runner
+    ADIUM_LOG_DIRECTORY = Pathname.new(File.expand_path('~/Library/Application Support/Adium 2.0/Users/Default/Logs/'))
+
+    def initialize(path_to_input_directory, aliases, output_directory = ADIUM_LOG_DIRECTORY)
+      @path_to_input_directory = path_to_input_directory
+      @aliases = aliases
+      @output_directory = output_directory
+    end
+
+    def run
+      files_to_parse.each do |file_path|
+        AdiumChatFileCreator.new(file_path, @aliases, @output_directory).create
+      end
+    end
+
+    private
+
+    def files_to_parse
+      FileFinder.new(@path_to_input_directory).find
+    end
+  end
+end

data/lib/pidgin2adium/version.rb

@@ -1,3 +1,3 @@
 module Pidgin2Adium
-  VERSION = "3.3.0"
+  VERSION = "4.0.0.beta1"
 end

data/pidgin2adium.gemspec

@@ -1,25 +1,29 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "pidgin2adium/version"
 
-Gem::Specification.new do |s|
-  s.name             = "pidgin2adium"
-  s.date             = "2011-10-16"
-  s.version          = Pidgin2Adium::VERSION
-  s.platform         = Gem::Platform::RUBY
-  s.authors          = ["Gabe Berke-Williams"]
-  s.email            = "gbw@brandeis.edu"
-  s.description      = "Pidgin2Adium is a fast, easy way to convert Pidgin (formerly gaim) logs to the Adium format."
-  s.summary          = "Pidgin2Adium is a fast, easy way to convert Pidgin (formerly gaim) logs to the Adium format"
-  s.extensions       = ["ext/balance_tags_c/extconf.rb"]
-  s.extra_rdoc_files = ["ChangeLog", "LICENSE", "README.rdoc" ]
-  s.files            = `git ls-files`.split("\n")
-  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.homepage         = "http://github.com/gabebw/pidgin2adium"
-  s.require_paths    = ["lib"]
+Gem::Specification.new do |spec|
+  spec.name          = "pidgin2adium"
+  spec.version       = Pidgin2Adium::VERSION
+  spec.authors       = ["Gabe Berke-Williams"]
+  spec.email         = "gabe@thoughtbot.com"
+  spec.description   = "A fast, easy way to convert Pidgin (gaim) logs to the Adium format."
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/gabebw/pidgin2adium"
+  spec.license       = "MIT"
 
-  s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
-  s.add_development_dependency(%q<rspec>, ["~> 2.4.0"])
-end
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
 
+  spec.add_dependency("pipio", "~> 0.0.2")
+
+  spec.add_development_dependency("rspec", "~> 3.0")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("simplecov")
+  spec.add_development_dependency("fakefs")
+end

data/spec/features/parse_pidgin_log_file_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe "Parse a Pidgin log file" do
+  before do
+    FileUtils.rm_rf(tmp_directory)
+  end
+
+  it "outputs to the correct file" do
+    runner = Pidgin2Adium::Runner.new(
+      path_containing_pidgin_logs,
+      ["Gabe B-W"],
+      output_path
+    )
+
+    runner.run
+
+    path = Dir["#{output_path}/**/*.xml"].first
+
+    expect(path).to eq File.join(
+      tmp_directory,
+      "AIM.jiggerificbug",
+      "them@gmail.com",
+      "them@gmail.com (2014-03-16T23:55:43#{tz_offset}).chatlog",
+      "them@gmail.com (2014-03-16T23:55:43#{tz_offset}).xml",
+    )
+  end
+
+  def path_containing_pidgin_logs
+    File.join(SPEC_ROOT, "fixtures", "input")
+  end
+
+  def output_path
+    File.expand_path(File.join(SPEC_ROOT, "..", "tmp"))
+  end
+
+  def path_to_output_fixture
+    File.join(SPEC_ROOT, "fixtures", "output.xml")
+  end
+
+  def tz_offset
+    Time.now.strftime("%z").sub(":", "")
+  end
+
+  def tmp_directory
+    File.join(
+      File.dirname(SPEC_ROOT),
+      "tmp"
+    )
+  end
+end

data/spec/fixtures/input/input.html

@@ -0,0 +1,3 @@
+<head><meta http-equiv="content-type" content="text/html; charset=UTF-8"><title>Conversation with them@gmail.com at 3/16/2014 11:55:43 PM on jiggerificbug (aim)</title></head><h3>Conversation with them@gmail.com at 3/16/2014 11:55:43 PM on jiggerificbug (aim)</h3>
+<font color="#A82F2F"><font size="2">(2014-03-16 23:55:48)</font> <b>Some Rando:</b></font> <span style='background: #ffffff;'><span style='font-weight: bold;'><span style='color: #ff8000;'>Hi</span></span></span><br/>
+<font color="#16569E"><font size="2">(2014-03-15 23:55:50)</font> <b>Gabe B-W:</b></font> <span style='color: #000000;'>Hi back</span><br/>

data/spec/fixtures/output.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<chat xmlns="http://purl.org/net/ulf/ns/0.4-02" account="jiggerificbug" service="AIM" adiumversion="1.5.9">
+<message sender="them@gmail.com" time="2014-03-16T23:55:48-0400" alias="Some Rando"><div><span style="font-family: Helvetica; font-size: 12pt;">Hi</span></div></message>
+<message sender="jiggerificbug" time="2014-03-16T23:55:50-0400"><div><span style="font-family: Helvetica; font-size: 12pt;">Hi back</span></div></message>
+</chat>

data/spec/pidgin2adium/adium_chat_file_creator_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+describe Pidgin2Adium::AdiumChatFileCreator do
+  unless on_travis_ci?
+    include FakeFS::SpecHelpers
+  end
+
+  it "creates a file in the correct place" do
+    chat = stub_chat
+
+    chat_file_creator = Pidgin2Adium::AdiumChatFileCreator.new(path_to_file, %w(gabe))
+    chat_file_creator.create
+
+    expect(File.exist?(path_for(chat))).to be true
+  end
+
+  it "writes the correct prolog" do
+    create_file
+
+    expect(file_contents.first).to eq %(<?xml version="1.0" encoding="UTF-8" ?>\n)
+  end
+
+  it "writes the correct opening <chat> tag" do
+    create_file
+
+    second_line = file_contents[1]
+
+    expect(second_line).to eq(
+      %(<chat xmlns="http://purl.org/net/ulf/ns/0.4-02" account="#{chat.my_screen_name}" service="AIM" adiumversion="1.5.9">\n)
+    )
+  end
+
+  it "calls to_s on each message and puts it in the file" do
+    create_file
+
+    lines = file_contents[2, chat.messages.size]
+
+    expect(lines.map(&:chomp)).to eq(chat.messages.map(&:to_s))
+  end
+
+  it "includes a closing </chat> tag" do
+    create_file
+
+    last_line = file_contents.last
+
+    expect(last_line.chomp).to eq("</chat>")
+  end
+
+  def stub_chat(new_chat = chat)
+    allow(Pipio).to receive(:parse).and_return(new_chat)
+    new_chat
+  end
+
+  def chat
+    time = Time.now
+    messages = [:a, 1, 3]
+    double(
+      my_screen_name: "me",
+      their_screen_name: "them",
+      start_time: time,
+      service: "aim",
+      messages: messages,
+      to_s: messages.map(&:to_s).join("\n")
+    )
+  end
+
+  def file_contents
+    File.readlines(path_for(chat))
+  end
+
+  def create_file
+    chat = stub_chat
+    chat_file_creator = Pidgin2Adium::AdiumChatFileCreator.new(path_to_file, %w(gabe))
+    chat_file_creator.create
+  end
+
+  def path_for(chat)
+    Pidgin2Adium::Runner::ADIUM_LOG_DIRECTORY.join(
+      "AIM.#{chat.my_screen_name}",
+      chat.their_screen_name,
+      "#{chat.their_screen_name} (#{xmlschema_for(chat)}).chatlog",
+      "#{chat.their_screen_name} (#{xmlschema_for(chat)}).xml"
+    ).to_s
+  end
+
+  def xmlschema_for(chat)
+    chat.start_time.xmlschema.sub(/:00$/, "00")
+  end
+end

data/spec/pidgin2adium/file_finder_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+describe Pidgin2Adium::FileFinder do
+  if on_travis_ci?
+    before do
+      FileUtils.rm_rf(expanded_directory)
+    end
+  else
+    include FakeFS::SpecHelpers
+  end
+
+  before do
+    FileUtils.mkdir_p(expanded_directory_with_username)
+  end
+
+  it "finds .html files" do
+    create_file_with_extension("html")
+
+    file_finder = Pidgin2Adium::FileFinder.new(unexpanded_directory)
+
+    expect(file_finder.find).to eq ["#{expanded_directory_with_username}/in.html"]
+  end
+
+  it "finds .htm files" do
+    create_file_with_extension("htm")
+
+    file_finder = Pidgin2Adium::FileFinder.new(unexpanded_directory)
+
+    expect(file_finder.find).to eq ["#{expanded_directory_with_username}/in.htm"]
+  end
+
+  it "finds .txt files" do
+    create_file_with_extension("txt")
+
+    file_finder = Pidgin2Adium::FileFinder.new(unexpanded_directory)
+
+    expect(file_finder.find).to eq ["#{expanded_directory_with_username}/in.txt"]
+  end
+
+  it "does not find files with other extensions" do
+    create_file_with_extension("bad")
+
+    file_finder = Pidgin2Adium::FileFinder.new(unexpanded_directory)
+
+    expect(file_finder.find).to eq []
+  end
+
+  def unexpanded_directory
+    "~/input-logs/"
+  end
+
+  def expanded_directory_with_username
+    File.join(expanded_directory, "gabebw")
+  end
+
+  def expanded_directory
+    File.expand_path(unexpanded_directory)
+  end
+
+  def create_file_with_extension(extension)
+    FileUtils.touch(File.join(expanded_directory_with_username, "in.#{extension}"))
+  end
+end

data/spec/spec_helper.rb

@@ -1,71 +1,29 @@
-require 'fileutils'
+require 'simplecov'
 
-# Pidgin2Adium.oops and Pidgin2Adium.warn both use warn() to output errors.
-# Setting $-w (the warning level) to nil suppresses them, which makes for
-# much prettier test output.
-$-w=nil # OMGHAX
+$LOAD_PATH.unshift(File.expand_path('..',  __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
 
-# Wrap it in a lambda so that we can pass it to Spork.prefork, if spork is installed.
-prefork_block = lambda do
-  # Loading more in this block will cause your tests to run faster. However,
-  # if you change any configuration or code from libraries loaded here, you'll
-  # need to restart spork for it take effect.
+require 'pidgin2adium'
+require "fakefs/spec_helpers"
 
-  $LOAD_PATH.unshift(File.dirname(__FILE__))
-  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'ext', 'balance_tags_c'))
+Dir['spec/support/**/*.rb'].each { |f| require File.expand_path(f) }
 
-  require 'pidgin2adium'
-  require 'time' # for Time.zone_offset
+SPEC_ROOT = File.dirname(__FILE__)
 
-  rspec_configure_block = lambda do |config|
-    config.before(:all) do
-      @current_dir = File.dirname(__FILE__)
-      @aliases = %w{gabebw gabeb-w gbw me}.join(',')
-      # -7 => "-0700"
-      @current_tz_offset = sprintf("%+03d00", Time.zone_offset(Time.new.zone) / 3600)
-
-      @logfile_path = File.join(@current_dir, "logfiles/")
-      @text_logfile_path = "#{@logfile_path}/2006-12-21.223606.txt"
-      @htm_logfile_path = "#{@logfile_path}/2008-01-15.071445-0500PST.htm"
-      @html_logfile_path = "#{@logfile_path}/2008-01-15.071445-0500PST.html"
-
-      @nonexistent_output_dir = File.join(@current_dir, "nonexistent_output_dir/")
-      @output_dir = File.join(@current_dir, "output-dir/")
-      FileUtils.rm_r(@nonexistent_output_dir, :force => true)
-    end
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 
-    config.after(:all) do
-      # Clean up.
-      FileUtils.rm_r(@nonexistent_output_dir, :force => true)
-      FileUtils.rm_r(@output_dir, :force => true)
-    end
+  def path_to_file
+    File.join(path_to_directory, "gabebw", "in.html")
   end
 
-  begin
-    # RSpec 2
-    gem 'rspec', '>= 2.0.0.beta.18'
-    require 'rspec'
-    RSpec.configure(&rspec_configure_block)
-  rescue Gem::LoadError
-    # RSpec 1
-    gem 'rspec', '~> 1.3'
-    require 'spec'
-    require 'spec/autorun'
-    Spec::Runner.configure(&rspec_configure_block)
+  def path_to_directory
+    File.expand_path("./in-logs/")
   end
-end
 
-begin
-  require 'rubygems'
-  require 'spork'
-  Spork.prefork(&prefork_block)
-  Spork.each_run do
-    # This code will be run each time you run your specs.
+  def on_travis_ci?
+    ENV['TRAVIS']
   end
-rescue LoadError
-  puts 'To make the tests run faster, run "sudo gem install spork" then run "spork"'
-  puts 'from the base pidgin2adium directory.'
-  # Spork isn't installed.
-  prefork_block.call
 end