chat_stew 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in chat_stew.gemspec
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# Chat Stew
+A pluggable parsing library for chat logs. It handles Adium out of the box.
+
+## Usage
+
+    require 'chat_stew'
+    # my_file can be anything that responds to #read. If it's a String, it's assumed
+    # that it's a filename.
+    chat = ChatStew.parse(my_file)
+    chat.each do |message|
+      message.sender
+      message.receiver
+      message.message
+      message.time # a DateTime
+    end
+
+## Writing your own parser
+A parser is anything that conforms to this specification:
+
+* responds to #can_parse?(file) and returns truish or falsish
+* responds to #parse(file) and returns an Enumerable containing
+  ChatStew::AdiumMessage instances
+
+If two parsers are registered that can both parse a given file, the
+most-recently-registered parser will win. I.E. if you register FooParser and
+then register BarParser, and they can both parse a file called "foo.bar", then
+BarParser will be used to parse it since it was registered after FooParser.
+
+    class FooParser
+      def can_parse?(file)
+        file.path =~ /foo$/
+      end
+
+      def parse(file)
+        # Just return an empty log
+        []
+      end
+    end
+
+    # Register it
+    foo_parser = FooParser.new
+    ChatStew.register(foo_parser)
+    # Will use foo_parser, so parse_result will be an empty array.
+    parse_result = ChatStew.parse("whatever.foo")
+
+## Author
+Gabe Berke-Williams, 2011

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]

data/chat_stew.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "chat_stew/version"
+
+Gem::Specification.new do |s|
+  s.name        = "chat_stew"
+  s.version     = ChatStew::VERSION
+  s.authors     = ["Gabe Berke-Williams"]
+  s.email       = ["gabe@thoughtbot.com"]
+  s.homepage    = ""
+  s.summary     = %q{An Adium log parser with an easy interface. Supports custom parsers too.}
+  s.description = s.summary
+
+  s.rubyforge_project = "chat_stew"
+
+  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.require_paths = ["lib"]
+
+  s.add_dependency("nokogiri", "~> 1.5.0")
+
+  s.add_development_dependency("rspec", "~> 2.6.0")
+  s.add_development_dependency("bourne", "~> 1.0")
+end

data/lib/chat_stew.rb

@@ -0,0 +1,30 @@
+require "chat_stew/version"
+require "chat_stew/adium_message"
+require "chat_stew/parsers/adium"
+
+module ChatStew
+  def self.register(parser)
+    parsers.unshift(parser)
+  end
+
+  def self.parse(input)
+    input = StringIO.new(input) unless input.respond_to?(:read)
+
+    valid_parser = parsers.detect {|parser| parser.can_parse?(input) }
+    if valid_parser.nil?
+      nil
+    else
+      valid_parser.parse(input)
+    end
+  end
+
+  def self.clear_parsers!
+    @parsers = []
+  end
+
+  private
+
+  def self.parsers
+    @parsers ||= []
+  end
+end

data/lib/chat_stew/adium_message.rb

@@ -0,0 +1,3 @@
+module ChatStew
+  AdiumMessage = Struct.new(:sender, :receiver, :alias, :message, :time)
+end

data/lib/chat_stew/parsers/adium.rb

@@ -0,0 +1,31 @@
+require 'nokogiri'
+require 'date'
+require 'time'
+
+module ChatStew
+  module Parsers
+    class Adium
+      def can_parse?(file)
+        contents = file.read
+        file.rewind
+        return contents.include?('<?xml version="1.0" encoding="UTF-8" ?>') &&
+          contents.include?('<chat xmlns="http://purl.org/net/ulf/ns/0.4-02"')
+      end
+
+      def parse(file)
+        doc = Nokogiri.XML(file)
+        chat_messages = doc.search('chat message')
+        account       = doc.at('chat')[:account]
+        other_account = chat_messages.detect{|m| m[:sender] != account }[:sender]
+
+        chat_messages.map do |message|
+          AdiumMessage.new(message[:sender],
+                           message[:sender] == account ? other_account : account,
+                           message[:alias],
+                           message.text,
+                           DateTime.parse(message[:time]))
+        end
+      end
+    end
+  end
+end

data/lib/chat_stew/version.rb

@@ -0,0 +1,3 @@
+module ChatStew
+  VERSION = "0.0.1"
+end

data/spec/chat_stew/adium_parser.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe ChatStew::Parsers::Adium, "#can_parse?" do
+  let(:adium_log)  { File.join('spec', 'support', 'logs', 'adium_log.xml') }
+  let(:random_log) { File.join('spec', 'support', 'logs', 'random_log.html') }
+
+  it "returns true for an Adium log" do
+    subject.can_parse?(adium_log).should be_true
+  end
+
+  it "returns false for a non-Adium log" do
+    subject.can_parse?(random_log).should be_false
+  end
+end
+
+describe ChatStew::Parsers::Adium, "#parse" do
+  let(:adium_log) { File.new(File.join('spec', 'support', 'logs', 'adium_log.xml')) }
+  let(:parsed) { subject.parse(adium_log) }
+
+  it "correctly parses the sender" do
+    parsed[0].sender.should == "this_is_me"
+    parsed[1].sender.should == "this_is_them"
+  end
+
+  it "correctly parses the receiver" do
+    parsed[0].receiver.should == "this_is_them"
+    parsed[1].receiver.should == "this_is_me"
+  end
+
+  it "correctly parses the alias" do
+    parsed[0].alias.should == "my_alias"
+    parsed[1].alias.should == "their_alias"
+  end
+
+  it "correctly parses the message" do
+    parsed[0].message.should == "first message > second message"
+    parsed[1].message.should == "untrue! & I can prove it"
+  end
+
+  it "correctly parses the time" do
+    parsed[0].time.should == DateTime.parse("2009-01-10T10:14:28-05:00")
+    parsed[1].time.should == DateTime.parse("2009-01-10T20:15:30-05:00")
+  end
+end

data/spec/chat_stew_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe ChatStew, ".register" do
+  let(:parser) { stub("Parser", :can_parse? => true, :parse => []) }
+  let(:log)    { stub("Chat Log", :read => "asdf") }
+
+  before { ChatStew.clear_parsers! }
+
+  it "registers the given parser" do
+    ChatStew.register(parser)
+    ChatStew.parse(log)
+
+    parser.should have_received(:parse).with(log)
+  end
+end
+
+describe ChatStew, ".parse" do
+  let(:parser_one)     { stub("Parser", :can_parse? => true, :parse => ['one']) }
+  let(:parser_two)     { stub("Parser", :can_parse? => true, :parse => ['two']) }
+  let(:invalid_parser) { stub("Parser", :can_parse? => false, :parse => ['two']) }
+  let(:log)            { stub("Adium Log", :read => "asdf") }
+
+  before { ChatStew.clear_parsers! }
+
+  it "only uses parsers that can parse the file" do
+    ChatStew.register(parser_one)
+    ChatStew.register(invalid_parser)
+    ChatStew.parse(log)
+
+    invalid_parser.should have_received(:parse).never
+    parser_one.should have_received(:parse).with(log)
+  end
+
+  it "parses with the most-recently-registered parser" do
+    ChatStew.register(parser_one)
+    ChatStew.register(parser_two)
+    ChatStew.parse(log)
+
+    parser_one.should have_received(:parse).never
+    parser_two.should have_received(:parse).with(log)
+  end
+
+  it "returns nil if no parser is available" do
+    ChatStew.parse(log).should be_nil
+  end
+
+  context "input" do
+    let(:adium_log_path) { File.join('spec', 'support', 'logs', 'adium_log.xml') }
+    let(:mock_parser)    { MockParser.new }
+    before { ChatStew.register(mock_parser) }
+
+    it "accepts a String" do
+      ChatStew.parse(adium_log_path)
+      mock_parser.should have_parsed
+      mock_parser.input.should respond_to(:read)
+    end
+
+    it "accepts a File" do
+      ChatStew.parse(File.new(adium_log_path))
+      mock_parser.input.should respond_to(:read)
+    end
+  end
+end
+
+describe ChatStew, ".clear_parsers!" do
+  let(:parser) { stub("Parser", :can_parse? => true, :parse => ['one']) }
+  let(:log)    { stub("Adium Log", :read => "asdf") }
+
+  it "clears all parsers" do
+    ChatStew.register(parser)
+    ChatStew.clear_parsers!
+    ChatStew.parse(log)
+    parser.should have_received(:parse).never
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "rspec"
+require "bourne"
+
+require "chat_stew"
+
+require "./spec/support/mock_parser"
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+end

data/spec/support/logs/adium_log.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<chat xmlns="http://purl.org/net/ulf/ns/0.4-02" account="this_is_me" service="AIM">
+  <message sender="this_is_me" time="2009-01-10T10:14:28-05:00" alias="my_alias"><div><span style="font-family: Helvetica; font-size: 12pt;">first message &gt; second message</span></div></message>
+  <message sender="this_is_them" time="2009-01-10T20:15:30-05:00" alias="their_alias"><div><span style="font-family: Helvetica; font-size: 12pt;">untrue! &amp; I can prove it</span></div></message>
+</chat>

data/spec/support/logs/random_log.html

@@ -0,0 +1,8 @@
+<head><meta http-equiv="content-type" content="text/html; charset=UTF-8"><title>Conversation with buddy_screen_name at 2007-06-16 13:51:36 on my screen name (aim)</title></head><h3>Conversation with buddy_screen_name at 2007-06-16 13:51:36 on my screen name (aim)</h3>
+<font color="#A82F2F"><font size="2">(13:51:35)</font> <b>buddy_alias:</b></font> <font sml="AIM/ICQ">received</font><br/>
+<font color="#16569E"><font size="2">(14:37:20)</font> <b>my_alias:</b></font> <font sml="AIM/ICQ"><span style='font-size: small; '>sent</span></font><br/>
+<font color="#16569E"><font size="2">(14:39:05)</font> <b>my_alias:</b></font> <font sml="AIM/ICQ"><span style='font-size: small; '><a HREF="http://www.crazymonkeygames.com/Boxhead-2Play-Rooms.html">http://www.crazymonkeygames.com/Boxhead-2Play-Rooms.html</a></span></font><br/>
+<font color="#6C2585"><font size="2">(14:39:20)</font> <b>***my_alias:</b></font> <font sml="AIM/ICQ"><span style='font-size: small; '>meified</span></font><br/>
+<font color="#6C2585"><font size="2">(14:39:21)</font> <b>my_alias:</b></font> <font sml="AIM/ICQ"><span style='font-size: small; '>extra link<a HREF="http://www.nytimes.com/aponline/us/AP-Suspicious-Devices.html?_r=1&amp;ref=us&amp;oref=slogin"></a></span></font><br/>
+<font size="2">(14:53:22)</font><b> buddy_screen_name logged out.</b><br/>
+<font color="#FF0000"><font size="2">(14:54:00)</font><b> Unable to send message: Refused by client</b></font><br/>

data/spec/support/mock_parser.rb

@@ -0,0 +1,24 @@
+class MockParser
+  attr_reader :input
+
+  def initialize
+    @did_parse = false
+    @input     = nil
+  end
+
+  def can_parse?(anything)
+    true
+  end
+
+  def parse(input)
+    @did_parse = true
+    @input     = input
+
+    []
+  end
+
+  def has_parsed?
+    @did_parse == true
+  end
+end
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: chat_stew
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gabe Berke-Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-18 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  name: nokogiri
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  name: rspec
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  name: bourne
+  version_requirements: *id003
+description: An Adium log parser with an easy interface. Supports custom parsers too.
+email: 
+- gabe@thoughtbot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- chat_stew.gemspec
+- lib/chat_stew.rb
+- lib/chat_stew/adium_message.rb
+- lib/chat_stew/parsers/adium.rb
+- lib/chat_stew/version.rb
+- spec/chat_stew/adium_parser.rb
+- spec/chat_stew_spec.rb
+- spec/spec_helper.rb
+- spec/support/logs/adium_log.xml
+- spec/support/logs/random_log.html
+- spec/support/mock_parser.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: chat_stew
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: An Adium log parser with an easy interface. Supports custom parsers too.
+test_files: 
+- spec/chat_stew/adium_parser.rb
+- spec/chat_stew_spec.rb
+- spec/spec_helper.rb
+- spec/support/logs/adium_log.xml
+- spec/support/logs/random_log.html
+- spec/support/mock_parser.rb