pipio 0.0.1

data/spec/pipio/cleaners/text_cleaner_spec.rb

@@ -0,0 +1,29 @@
+describe Pipio::Cleaners::TextCleaner, '.clean' do
+  it 'removes \r' do
+    expect(clean("\r")).to eq('')
+  end
+
+  it 'converts & to &' do
+    expect(clean('&')).to eq('&')
+  end
+
+  it 'converts < to &lt;' do
+    expect(clean('<')).to eq('&lt;')
+  end
+
+  it 'converts > to &gt;' do
+    expect(clean('>')).to eq('&gt;')
+  end
+
+  it 'converts " to &quot;' do
+    expect(clean('"')).to eq('&quot;')
+  end
+
+  it "converts ' to &apos;" do
+    expect(clean("'")).to eq('&apos;')
+  end
+
+  def clean(line)
+    Pipio::Cleaners::TextCleaner.clean(line)
+  end
+end

data/spec/pipio/file_reader_spec.rb

@@ -0,0 +1,130 @@
+require 'tempfile'
+
+module FileReaderHelpers
+  def no_op_cleaner
+    Class.new do
+      def self.clean(line)
+        line
+      end
+    end
+  end
+
+  def dirty_cleaner
+    Class.new do
+      def self.clean(line)
+        if line == "dirty"
+          "clean"
+        else
+          line
+        end
+      end
+    end
+  end
+
+  def temporary_file
+    Tempfile.new('whatever').tap do |file|
+      yield file
+      file.flush
+    end
+  end
+end
+
+describe Pipio::FileReader, 'with a nonexistent file' do
+  include FileReaderHelpers
+
+  it 'does not crash' do
+    file_reader = Pipio::FileReader.new('nonexistent', no_op_cleaner)
+    expect { file_reader.read }.not_to raise_error
+  end
+
+  it 'has empty first_line' do
+    file_reader = Pipio::FileReader.new('nonexistent', no_op_cleaner)
+    file_reader.read
+    expect(file_reader.first_line).to eq('')
+  end
+
+  it 'has empty other_lines' do
+    file_reader = Pipio::FileReader.new('nonexistent', no_op_cleaner)
+    file_reader.read
+    expect(file_reader.other_lines).to eq([])
+  end
+end
+
+describe Pipio::FileReader, '#first_line' do
+  include FileReaderHelpers
+
+  it 'returns the first line' do
+    file = temporary_file do |f|
+      f.puts 'first'
+      f.puts 'second'
+    end
+
+    file_reader = Pipio::FileReader.new(file.path, no_op_cleaner)
+    file_reader.read
+    expect(file_reader.first_line).to eq('first')
+  end
+
+  it 'does not clean the first line' do
+    file = temporary_file do |f|
+      f.puts "dirty"
+    end
+
+    file_reader = Pipio::FileReader.new(file.path, dirty_cleaner)
+    file_reader.read
+    expect(file_reader.first_line).to eq("dirty")
+  end
+end
+
+describe Pipio::FileReader, '#other_lines' do
+  include FileReaderHelpers
+
+  it 'grabs the other lines' do
+    file = temporary_file do |f|
+      f.puts 'first'
+      f.puts 'second'
+      f.puts 'third'
+    end
+
+    file_reader = Pipio::FileReader.new(file.path, no_op_cleaner)
+    file_reader.read
+    expect(file_reader.other_lines).to eq(%w(second third))
+  end
+
+  it 'cleans the other lines' do
+    file = temporary_file do |f|
+      f.puts "first"
+      f.puts "dirty"
+    end
+
+    file_reader = Pipio::FileReader.new(file.path, dirty_cleaner)
+    file_reader.read
+    expect(file_reader.other_lines).to eq(%w(clean))
+  end
+
+
+  it 'removes empty lines from the other lines' do
+    file = temporary_file do |f|
+      f.puts "first"
+      f.puts "before"
+      f.puts
+      f.puts "after"
+    end
+
+    file_reader = Pipio::FileReader.new(file.path, no_op_cleaner)
+    file_reader.read
+    expect(file_reader.other_lines).to eq(%w(before after))
+  end
+
+  it 'removes all-whitespace lines from the other lines' do
+    file = temporary_file do |f|
+      f.puts "first"
+      f.puts "before"
+      f.puts "  "
+      f.puts "after"
+    end
+
+    file_reader = Pipio::FileReader.new(file.path, no_op_cleaner)
+    file_reader.read
+    expect(file_reader.other_lines).to eq(%w(before after))
+  end
+end

data/spec/pipio/messages/auto_reply_message_spec.rb

@@ -0,0 +1,40 @@
+describe Pipio::AutoReplyMessage, '#to_s' do
+  it 'has the correct sender_screen_name' do
+    expect(auto_reply_message(sender_screen_name: "hello").to_s).to include 'sender="hello"'
+  end
+
+  it 'has the correct alias' do
+    expect(auto_reply_message(sender_alias: "garner").to_s).to include 'alias="garner"'
+  end
+
+  it 'has the correct time' do
+    time = Time.now
+    formatted_time = time.xmlschema
+    expect(auto_reply_message(time: time).to_s).to include %(time="#{formatted_time}")
+  end
+
+  it 'has the correct body' do
+    body = "hello"
+    styled_body = %(<div><span style="font-family: Helvetica; font-size: 12pt;">#{body}</span></div>)
+    expect(auto_reply_message(body: body).to_s).to include styled_body
+  end
+
+  it 'has the auto attribute set to true' do
+    expect(auto_reply_message.to_s).to include 'auto="true"'
+  end
+
+  def auto_reply_message(options = {})
+    options = default_options.merge(options)
+    Pipio::AutoReplyMessage.new(options[:sender_screen_name],
+      options[:time], options[:sender_alias], options[:body])
+  end
+
+  def default_options
+    {
+      sender_screen_name: 'jim_sender',
+      time: Time.now,
+      sender_alias: 'jim alias',
+      body: 'body'
+    }
+  end
+end

data/spec/pipio/messages/event_spec.rb

@@ -0,0 +1,41 @@
+describe Pipio::Event, '#to_s' do
+  it 'has the correct sender screen name' do
+    sender_screen_name = 'bob'
+    result = create_event(sender_screen_name: sender_screen_name).to_s
+    expect(result).to include %(sender="#{sender_screen_name}")
+  end
+
+  it 'has the correct time' do
+    time = Time.now
+    formatted_time = time.xmlschema
+    result = create_event(time: time).to_s
+    expect(result).to include %(time="#{formatted_time}")
+  end
+
+  it 'has the correct alias' do
+    sender_alias = 'jane_alias'
+    result = create_event(sender_alias: sender_alias).to_s
+    expect(result).to include %(alias="#{sender_alias}")
+  end
+
+  it 'has the correct body' do
+    body = 'body'
+    styled_body = %(<div><span style="font-family: Helvetica; font-size: 12pt;">#{body}</span></div>)
+    result = create_event(body: body).to_s
+    expect(result).to include styled_body
+  end
+
+  it 'is an event tag' do
+    expect(create_event.to_s).to match(/^<event/)
+  end
+
+  def create_event(opts = {})
+    opts[:sender_screen_name] ||= 'jim_sender'
+    opts[:time] ||= Time.now
+    opts[:sender_alias] ||= 'jane_alias'
+    opts[:body] ||= 'body'
+    opts[:event_type] ||= 'libPurpleEvent'
+
+    Pipio::Event.new(opts[:sender_screen_name], opts[:time], opts[:sender_alias], opts[:body], opts[:event_type])
+  end
+end

data/spec/pipio/messages/status_message_spec.rb

@@ -0,0 +1,43 @@
+describe Pipio::StatusMessage, '#to_s' do
+  it 'has the correct sender' do
+    sender_screen_name = 'bob'
+    result = create_status_message(sender_screen_name: sender_screen_name).to_s
+    expect(result).to include %(sender="#{sender_screen_name}")
+  end
+
+  it 'has the correct time' do
+    time = Time.now
+    formatted_time = time.xmlschema
+    result = create_status_message(time: time).to_s
+    expect(result).to include %(time="#{formatted_time}")
+  end
+
+  it 'has the correct alias' do
+    sender_alias = 'jane_alias'
+    result = create_status_message(sender_alias: sender_alias).to_s
+    expect(result).to include %(alias="#{sender_alias}")
+  end
+
+  it 'has the correct status' do
+    status = 'status'
+    result = create_status_message(status: status).to_s
+    expect(result).to include %(type="#{status}")
+  end
+
+  it 'is a status tag' do
+    expect(create_status_message.to_s).to match(/^<status/)
+  end
+
+  it 'ends in a newline' do
+    expect(create_status_message.to_s).to match(/\n$/)
+  end
+
+  def create_status_message(opts = {})
+    opts[:sender_screen_name] ||= 'jim_sender'
+    opts[:time] ||= Time.now
+    opts[:sender_alias] ||= 'jane_alias'
+    opts[:status] ||= 'status'
+
+    Pipio::StatusMessage.new(opts[:sender_screen_name], opts[:time], opts[:sender_alias], opts[:status])
+  end
+end

data/spec/pipio/messages/xml_message_spec.rb

@@ -0,0 +1,55 @@
+describe Pipio::XMLMessage, '#to_s' do
+  it 'has the correct sender_screen_name' do
+    expect(create_xml_message(sender_screen_name: 'jim').to_s).to include %(sender="jim")
+  end
+
+  it 'has the correct alias' do
+    expect(create_xml_message(sender_alias: 'Jim Alias').to_s).to include %(alias="Jim Alias")
+  end
+
+  it 'has the correct time' do
+    time = Time.now
+    formatted_time = time.xmlschema
+    expect(create_xml_message(time: time).to_s).to include %(time="#{formatted_time}")
+  end
+
+  it 'has the correct body' do
+    unstyled_body = 'unstyled'
+    styled_body = %(<div><span style="font-family: Helvetica; font-size: 12pt;">#{unstyled_body}</span></div>)
+    expect(create_xml_message(body: unstyled_body).to_s).to include styled_body
+  end
+
+  context "normalization" do
+    it 'balances the tags in the body' do
+      unbalanced_body = '<div>unbalanced'
+      expect(create_xml_message(body: unbalanced_body).body).to eq('<div>unbalanced</div>')
+    end
+
+    it 'removes *** from the beginning of the sender alias' do
+      alias_with_stars = '***Jim'
+      alias_without_stars = 'Jim'
+      expect(create_xml_message(sender_alias: alias_with_stars).to_s).to include %(alias="#{alias_without_stars}")
+    end
+
+    it 'escapes & to &amp;' do
+      expect(create_xml_message(body: '&').body).to eq('&amp;')
+    end
+
+    %w(lt gt amp quot apos).each do |entity|
+      it "does not escape &#{entity};" do
+        entity_body = "&#{entity};"
+        expect(create_xml_message(body: entity_body).body).to eq(entity_body)
+      end
+    end
+  end
+
+  def create_xml_message(opts = {})
+    opts[:sender_screen_name] ||= 'jim_sender'
+    opts[:time] ||= Time.now
+    opts[:sender_alias] ||= 'jane_alias'
+    opts[:body] ||= 'body'
+    opts[:event_type] ||= 'libPurpleEvent'
+
+    Pipio::XMLMessage.new(opts[:sender_screen_name], opts[:time], opts[:sender_alias], opts[:body])
+  end
+end

data/spec/pipio/metadata_parser_spec.rb

@@ -0,0 +1,81 @@
+describe Pipio::MetadataParser do
+  context '#parse' do
+    it "finds my screen name" do
+      file = create_chat_file('log.html') do |b|
+        b.first_line from: 'JIM'
+      end
+
+      metadata = Pipio::MetadataParser.new(first_line_of(file)).parse
+      expect(metadata[:my_screen_name]).to eq('JIM')
+    end
+
+    it "finds their screen name" do
+      file = create_chat_file('log.html') do |b|
+        b.first_line to: 'lady anne'
+      end
+
+      metadata = Pipio::MetadataParser.new(first_line_of(file)).parse
+      expect(metadata[:their_screen_name]).to eq('lady anne')
+    end
+
+    it 'finds the start time' do
+      time_string = '2008-04-01 22:36:06'
+      file = create_chat_file('log.html') do |b|
+        b.first_line time: time_string
+      end
+
+      metadata = Pipio::MetadataParser.new(first_line_of(file)).parse
+      expect(metadata[:start_time]).to eq(Time.parse(time_string))
+    end
+
+    it 'finds the correct service' do
+      path = create_chat_file('log.html') do |b|
+        b.first_line service: 'aim'
+      end
+
+      metadata = Pipio::MetadataParser.new(first_line_of(path)).parse
+
+      expect(metadata[:service]).to eq 'aim'
+    end
+
+    it 'can detect peculiar times' do
+      time_string = "1/15/2008 7:14:45 AM"
+      expected_time = Time.parse('2008-01-15 07:14:45')
+      file = create_chat_file('log.html') do |b|
+        b.first_line time: time_string
+      end
+
+      metadata = Pipio::MetadataParser.new(first_line_of(file)).parse
+      expect(metadata[:start_time]).to eq(expected_time)
+    end
+
+    it 'sets all attributes to nil when initialized with an empty string' do
+      metadata = Pipio::MetadataParser.new('').parse
+      assert_all_attributes_nil(metadata)
+    end
+
+    it 'sets all attributes to nil when initialized with nil' do
+      metadata = Pipio::MetadataParser.new(nil).parse
+      assert_all_attributes_nil(metadata)
+    end
+
+    it 'resets all attributes to nil when given a non-standard file to parse' do
+      file = FileBuilder.create_file('nonstandard.html')
+      file.write '<HTML><BODY BGCOLOR="#ffffff"><B><FONT COLOR="#ff0000" LANG="0">jiggerific bug<!-- (3:22:29 PM)--></B></FONT><FONT COLOR="#ff0000" BACK="#ffffff">:</FONT><FONT COLOR="#000000"> try direct IM now</FONT><BR>'
+      file.close
+
+      metadata = Pipio::MetadataParser.new(first_line_of(file)).parse
+      assert_all_attributes_nil(metadata)
+    end
+  end
+
+  def first_line_of(file)
+    File.readlines(file).first
+  end
+
+  def assert_all_attributes_nil(metadata)
+    expect(metadata[:start_time]).to be_nil
+    expect(metadata[:their_screen_name]).to be_nil
+    expect(metadata[:my_screen_name]).to be_nil
+  end
+end

data/spec/pipio/metadata_spec.rb

@@ -0,0 +1,72 @@
+describe Pipio::Metadata do
+  context '#service' do
+    it "returns the service" do
+      metadata = Pipio::Metadata.new(service: 'aim')
+      expect(metadata.service).to eq('aim')
+    end
+  end
+
+  context '#my_screen_name' do
+    it "returns my normalized screen name" do
+      metadata = Pipio::Metadata.new(my_screen_name: 'JIM BOB')
+      expect(metadata.my_screen_name).to eq('jimbob')
+    end
+  end
+
+  context '#their_screen_name' do
+    it "returns their screen name" do
+      metadata = Pipio::Metadata.new(their_screen_name: 'lady anne')
+      expect(metadata.their_screen_name).to eq('lady anne')
+    end
+  end
+
+  context '#start_time' do
+    it 'returns the start time' do
+      time = Time.now
+      metadata = Pipio::Metadata.new(start_time: time)
+
+      expect(metadata.start_time).to eq(time)
+    end
+  end
+
+  context '#start_month' do
+    it 'returns the start month' do
+      start_time = Time.now
+      metadata = Pipio::Metadata.new(start_time: start_time)
+      expect(metadata.start_month).to eq(start_time.mon)
+    end
+  end
+
+  context '#start_year' do
+    it 'returns the start year' do
+      start_time = Time.now
+      metadata = Pipio::Metadata.new(start_time: start_time)
+      expect(metadata.start_year).to eq(start_time.year)
+    end
+  end
+
+  context '#start_mday' do
+    it 'returns the start mday' do
+      start_time = Time.now
+      metadata = Pipio::Metadata.new(start_time: start_time)
+      expect(metadata.start_mday).to eq(start_time.mday)
+    end
+  end
+
+  context '#valid?' do
+    it 'is true when all attributes are provided' do
+      metadata = Pipio::Metadata.new(my_screen_name: '',
+        their_screen_name: '',
+        start_time: '',
+        service: 'aim'
+      )
+      expect(metadata).to be_valid
+    end
+
+    [:my_screen_name, :their_screen_name, :start_time, :service].each do |attribute|
+      it "is false when #{attribute} cannot be detected" do
+        expect(Pipio::Metadata.new(attribute => nil)).not_to be_valid
+      end
+    end
+  end
+end