pipio 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a27a6c6a854887062351e5a362482a44990ce35e
+  data.tar.gz: 455730fbf37e619f747cfe89d0612fb42ee85999
+SHA512:
+  metadata.gz: 0192a3e9a130603f28698edc216007c30321a921c4b66a6a3cea5368a02262f0be2037802408b5a7576552c1d625e246da06447f4f5ac37ccd735695b18c86c0
+  data.tar.gz: 532da7ab24471befe059573f39d99dd65b214de408783215f0e3e73272088550d03d531834b882a4af14349b7904c1c3e50ce371947ae3bf562f61cf96acb07b

data/.gitignore

@@ -0,0 +1,27 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+tags
+
+## PROJECT::SPECIFIC
+.bundle
+.rvmrc
+spec/output-dir
+spec/nonexistent_output_dir
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-r spec_helper

data/.simplecov

@@ -0,0 +1,5 @@
+if ENV["COVERAGE"]
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end

data/.travis.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 2.1.2
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+branches:
+  only:
+    - master
+notifications:
+  email:
+    - false

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Gabriel Berke-Williams
+
+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/NEWS.md

@@ -0,0 +1,10 @@
+## 0.0.1 (unreleased)
+
+Extract Pidgin2Adium, commit hash 96c443fd244b3d2d57564bf17c68d3ec1bcb48ff, into
+this library, Pipio. There are also other commits in this release that are not in
+Pidgin2Adium as of that commit:
+
+* Expose `Chat#my_screen_name`
+* Rename `Chat#lines` to `Chat#messages`
+* Expose `Chat#service`
+* Join the lines of `Chat#to_s` with "\n" instead of nothing

data/README.md

@@ -0,0 +1,88 @@
+# pipio [![Build Status](https://secure.travis-ci.org/gabebw/pipio.png)](http://travis-ci.org/gabebw/pipio) [![Code Climate](https://codeclimate.com/github/gabebw/pipio.png)](https://codeclimate.com/github/gabebw/pipio)
+
+Pipio parses [Pidgin](http://pidgin.im/) (formerly gaim) logs. It can output
+them in Adium format by calling `to_s` on a `Pipio::Chat` object or any of the
+message objects in `Pipio::Chat#messages`.
+
+## For the impatient
+
+To deal with meta-information about the chat itself:
+
+    path_to_chat_log = File.expand_path('~/path/to/chat_log.html') # or .txt
+    chat = Pipio.parse(path_to_chat_log, "Gabe B-W,Gabe,Other Alias")
+    if chat
+      puts "Screen name of the person you chatted with: #{chat.their_screen_name}"
+      puts "Time the chat started: #{chat.start_time_xmlschema}"
+      puts "Chat contents, in adium format:"
+      puts chat.to_s
+    else
+      puts "Oh no! Could not parse! Please open an issue."
+      puts path_to_chat_log
+      exit 1
+    end
+
+Or, to deal with individual messages in a chat:
+
+    chat = Pipio.parse("/path/to/log/file.html", "gabe,gbw,gabeb-w")
+    chat.each do |message|
+      puts "Screen name of person who sent this message: #{message.sender_screen_name}"
+      puts "Alias of person who sent this message: #{message.sender_alias}"
+      puts "Time message was sent: #{message.time}"
+
+      if message.respond_to?(:body)
+        puts "Message body: #{message.body}"
+        if message.respond_to?(:event)
+          puts "Event type: #{message.event_type}"
+        end
+      elsif message.respond_to?(:status)
+        puts "Status: #{message.status}"
+      end
+
+      puts "Message in Adium format: #{message}"
+    end
+
+## The fine print
+
+This library needs access to aliases to work correctly, which may require a bit
+of explanation. Adium and Pidgin allow you to set aliases for buddies as well as
+for yourself, so that you show up in chats as (for example) `Me` instead of as
+`best_screen_name_ever_018845`.
+
+However, Pidgin then uses aliases in the log file instead of the actual screen
+name, which complicates things. To parse properly, this gem needs to know which
+aliases belong to you so it can map them to the correct screen name. If it
+encounters an alias that you did not list,  it assumes that it belongs to the
+person to whom you are chatting. Note that aliases are lower-cased and space is
+removed, so providing `Gabe B-W, GBW` is the same as providing `gabeb-w,gbw`.
+
+You do not need to provide your screenname in the alias list.
+
+## INSTALL
+
+    gem install pipio
+
+## Testing
+
+To get a coverage report, run `rake` with the `COVERAGE` environment variable
+set:
+
+    COVERAGE=1 rake
+
+## THANKS
+
+With thanks to Li Ma, whose [blog post](http://li-ma.blogspot.com/2008/10/pidgin-log-file-to-adium-log-converter.html)
+helped tremendously.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009-2014 Gabe Berke-Williams. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :coverage do
+  system "COVERAGE=1 rake ; open coverage/index.html"
+end
+
+task default: :spec

data/lib/pipio.rb

@@ -0,0 +1,34 @@
+require 'time'
+
+require 'pipio/version'
+require 'pipio/chat'
+require 'pipio/tag_balancer'
+require 'pipio/time_parser'
+require 'pipio/metadata'
+require 'pipio/metadata_parser'
+require 'pipio/alias_registry'
+require 'pipio/file_reader'
+require 'pipio/parsers/null_parser'
+require 'pipio/parsers/basic_parser'
+require 'pipio/parsers/text_log_parser'
+require 'pipio/parsers/html_log_parser'
+require 'pipio/parser_factory'
+require 'pipio/messages/message'
+require 'pipio/messages/xml_message'
+require 'pipio/messages/auto_reply_message'
+require 'pipio/messages/event'
+require 'pipio/messages/status_message'
+require 'pipio/message_creators/event_message_creator'
+require 'pipio/message_creators/status_message_creator'
+require 'pipio/message_creators/auto_or_xml_message_creator'
+require 'pipio/cleaners/html_cleaner'
+require 'pipio/cleaners/text_cleaner'
+
+module Pipio
+  # Parses the log at the given path into a Chat.
+  def self.parse(logfile_path, my_aliases)
+    full_path = File.expand_path(logfile_path)
+    factory = ParserFactory.new(full_path, my_aliases)
+    factory.parser.parse
+  end
+end

data/lib/pipio/alias_registry.rb

@@ -0,0 +1,26 @@
+module Pipio
+  # Map aliases ("Gabe B-W") to screen names ("cool_dragon_88").
+  class AliasRegistry
+    def initialize(default)
+      @items = Hash.new(normalize(default))
+    end
+
+    def []=(alias_name, screen_name)
+      @items[alias_name] = normalize(screen_name)
+    end
+
+    def [](alias_name)
+      @items[without_action(alias_name)]
+    end
+
+    private
+
+    def normalize(screen_name)
+      screen_name.gsub(' ', '').downcase
+    end
+
+    def without_action(alias_name)
+      alias_name.sub(/^\*{3}/, '')
+    end
+  end
+end

data/lib/pipio/chat.rb

@@ -0,0 +1,39 @@
+module Pipio
+  # The container object for each Message in a chat. It includes the Enumerable
+  # module, so each/map/reject etc all work and will iterate over the Messages.
+  class Chat
+    include Enumerable
+
+    def initialize(messages, metadata)
+      @messages = messages
+      @metadata = metadata
+    end
+
+    attr_reader :messages
+
+    def start_time_xmlschema
+      @metadata.start_time.xmlschema
+    end
+
+    def my_screen_name
+      @metadata.my_screen_name
+    end
+
+    def their_screen_name
+      @metadata.their_screen_name
+    end
+
+    def service
+      @metadata.service
+    end
+
+    def to_s
+      map(&:to_s).join("\n")
+    end
+
+    # Iterate over each Message.
+    def each(&block)
+      @messages.each(&block)
+    end
+  end
+end

data/lib/pipio/cleaners/html_cleaner.rb

@@ -0,0 +1,95 @@
+module Pipio
+  module Cleaners
+    class HtmlCleaner
+      # Returns a cleaned string.
+      # Removes the following tags from _text_:
+      # * html
+      # * body
+      # * font
+      # * a with no innertext, e.g. <a href="blah"></a>
+      # And removes the following style declarations:
+      # * color: #000000 (just turns text black)
+      # * font-family
+      # * font-size
+      # * background
+      # * em (really it's changed to <span style="font-style: italic;">)
+      # Since each <span> has only one style declaration, spans with these
+      # declarations are removed (but the text inside them is preserved).
+      def self.clean(text)
+        # Sometimes this is in there. I don't know why.
+        text.gsub!(%r{&lt;/FONT HSPACE='\d'>}, '')
+        # We can remove <font> safely since Pidgin and Adium both show bold
+        # using <span style="font-weight: bold;"> except Pidgin uses single
+        # quotes while Adium uses double quotes.
+        text.gsub!(/<\/?(?:html|body|font)(?: .+?)?>/, '') # very important!
+
+        text.tr!("\r", '')
+        # Remove empty lines
+        text.gsub!("\n\n", "\n")
+
+        # Remove newlines that end the file, since they screw up the
+        # newline -> <br/> conversion
+        text.gsub!(/\n\Z/, '')
+
+        # Replace newlines with "<br/>" unless they end a chat line.
+        # This must go after we remove <font> tags.
+        text.gsub!(/\n(?!#{HtmlLogParser::TIMESTAMP_REGEX})/, '<br/>')
+
+        # These empty links are sometimes appended to every line in a chat,
+        # for some weird reason. Remove them.
+        text.gsub!(%r{<a href=['"].+?['"]>\s*?</a>}, '')
+
+        # Replace single quotes inside tags with double quotes so we can
+        # easily change single quotes to entities.
+        # For spans, removes a space after the final declaration if it exists.
+        text.gsub!(/<span style='([^']+?;) ?'>/, '<span style="\1">')
+        text.gsub!(/([a-z]+=)'(.+?)'/, '\1"\2"')
+        text.gsub!("'", '&apos;')
+
+        # This actually does match stuff, but doesn't group it correctly. :(
+        # text.gsub!(%r{<span style="((?:.+?;)+)">(.*?)</span>}) do |s|
+        text.gsub!(%r{<span style="(.+?)">(.*?)</span>}) do |s|
+          # Remove empty spans.
+          next if $2 == ''
+
+          # style = style declaration
+          # innertext = text inside <span>
+          style, innertext = $1, $2
+
+          styleparts = style.split(/; ?/)
+          styleparts.map! do |p|
+            if p[0,5] == 'color'
+              if p.include?('color: #000000')
+                next
+              elsif p =~ /(color: #[0-9a-fA-F]{6})(>.*)?/
+                # Regarding the bit with the ">", sometimes this happens:
+                # <span style="color: #000000>today;">today was busy</span>
+                # Then p = "color: #000000>today"
+                # Or it can end in ">;", with no text before the semicolon.
+                # So keep the color but remove the ">" and anything following it.
+                next($1)
+              end
+            else
+              # don't remove font-weight
+              case p
+              when /^font-family/ then next
+              when /^font-size/ then next
+              when /^background/ then next
+              end
+            end
+          end.compact!
+          unless styleparts.empty?
+            style = styleparts.join('; ')
+            innertext = "<span style=\"#{style};\">#{innertext}</span>"
+          end
+          innertext
+        end
+        # Pidgin uses <em>, Adium uses <span>
+        if text.gsub!('<em>', '<span style="font-style: italic;">')
+          text.gsub!('</em>', '</span>')
+        end
+        text
+      end
+    end
+  end
+end

data/lib/pipio/cleaners/text_cleaner.rb

@@ -0,0 +1,15 @@
+module Pipio
+  module Cleaners
+    class TextCleaner
+      def self.clean(line)
+        # Escape entities since this will be in XML
+        line.gsub("\r", '').
+          gsub('&', '&').
+          gsub('<', '&lt;').
+          gsub('>', '&gt;').
+          gsub('"', '&quot;').
+          gsub("'", '&apos;')
+      end
+    end
+  end
+end

data/lib/pipio/file_reader.rb

@@ -0,0 +1,29 @@
+module Pipio
+  class FileReader
+    def initialize(path_to_file, cleaner)
+      @path_to_file = path_to_file
+      @first_line = ''
+      @other_lines = []
+      @cleaner = cleaner
+    end
+
+    attr_reader :first_line, :other_lines
+
+    def read
+      if File.exist?(@path_to_file)
+        open(@path_to_file) do |file|
+          @first_line = file.readline.strip
+          @other_lines = file.readlines.map(&:strip)
+        end
+
+        clean_other_lines
+      end
+    end
+
+    private
+
+    def clean_other_lines
+      @other_lines.map! { |line| @cleaner.clean(line) }.reject!(&:empty?)
+    end
+  end
+end