stenographer 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matthew Werner
+
+MIT License
+
+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/README.md

@@ -0,0 +1,50 @@
+# Stenographer
+
+Stenographer is a gem that helps you dig through your chat history, currently limited to Adium chat logs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stenographer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stenographer
+
+## Usage
+
+To get started with stenographer, you just have to call
+
+    transcript = Transcript.new
+    transcript.read_back
+
+This will go to the default Adium log directory and read back all your chat conversations. You can also pass the constructor a specific directory to limit the conversations Transcript pulls in.
+
+To search for a specific string within your chat history, just pass your queried string:
+
+    transcript.read_back(query: 'cool')
+
+This will return every instance of 'cool' in your history. Sometimes it's handy to understand what it was you thought was so cool. Including some context helps:
+
+    transcript.read_back(query: 'cool', context: true)
+
+Some queries yield more interesting results than others:
+
+    transcript.read_back(query: 'http')
+
+## Upcoming
+
+There are quite a few more things I'd like to do with this gem. Making it easier to specify which exact conversation you're meaning to pull up is high on the list.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/swearwords.txt

@@ -0,0 +1 @@
+fuck shit asshole cunt fag fuk fck fcuk assfuck assfucker fucker motherfucker asscock asshead asslicker asslick assnigger asssucker bastard bitch bitchtits bitches bitch brotherfucker bullshit bumblefuck buttfucka fucka buttfucker buttfucka fagbag fagfucker faggit faggot faggotcock fagtard fatass fuckoff fuckstick fucktard fuckwad fuckwit dick dickfuck dickhead dickjuice dickmilk doochbag douchebag douche dickweed dyke dumbass dumass fuckboy fuckbag gayass gayfuck gaylord gaytard nigga niggers niglet paki piss prick pussy poontang poonany porchmonkey porch monkey poon queer queerbait queerhole queef renob rimjob ruski sandnigger nigger schlong shitass shitbag shitbagger shitbreath chinc carpetmuncher chink choad clit clitface clusterfuck cockass cockbite cockface skank skeet skullfuck slut slutbag splooge twatlips twat twats twatwaffle vaj vajayjay va-j-j wank wankjob wetback whore whorebag whoreface

data/lib/stenographer.rb

@@ -0,0 +1,8 @@
+require 'nokogiri'
+
+module Stenographer
+  autoload :Word,         'stenographer/word'
+  autoload :Message,      'stenographer/message'
+  autoload :Conversation, 'stenographer/conversation'
+  autoload :Transcript,   'stenographer/transcript'
+end

data/lib/stenographer/conversation.rb

@@ -0,0 +1,166 @@
+module Stenographer
+  class Conversation
+
+    attr_accessor :id, :members, :messages, :created_at
+
+    def initialize(id, noko)
+      @id       = id
+      @messages = []
+      @members  = []
+      @history  = []
+      @lines_to_print = 0
+      @created_at = nil
+
+      noko.css('message').each_with_index do |message, i|
+        name = (message.attributes['alias'] || message.attributes['sender']).value
+        @created_at ||= message.attributes['time'].value
+        body = message.children.inner_text
+
+        @members << name if !@members.include?(name)
+        @messages << Message.new(i, name, body)
+      end
+    end
+
+    # Print out a conversation
+    #
+    # Example:
+    #   >> conversation.read_back
+    #   => Jack Johnson, John Jackson @ 2012-11-05T20:48:50-08:00 Lines: 0..-1
+    #   John Jackson   It's time someone had the courage to stand up and say: I'm against those things that everybody hates.
+    #   Jack Johnson   Now, I respect my opponent. I think he's a good man. But quite frankly, I agree with everything he just said.
+    #   John Jackson   I say your three cent titanium tax goes too far.
+    #   Jack Johnson   And I say your three cent titanium tax doesn't go too far enough.
+    #
+    # Arguments:
+    #   opts: (Hash)
+    #   [query]   only return lines that match query
+    #   [context] used with query, returns surrounding lines to match
+    def read_back(opts={})
+      raise "read_back only accepts an options hash" if !opts.is_a?(Hash)
+      query = opts[:query]
+      return if query && !include?(query)
+
+      id_range = range(opts)
+      puts header(id_range)
+      messages[id_range].each do |message|
+        if query && message.include?(query)
+          message.print(highlighted: true)
+        else
+          message.print unless query && opts[:context].nil?
+        end
+      end
+      puts
+    end
+
+    def report
+      distribution = word_distribution(top: 10)
+      max_length   = distribution.keys.map(&:length).max + 2
+      max_length = 15 if max_length < 15
+      code = "%-#{max_length}s %0s"
+
+      puts "\n=> Conversation Report <" + ('=' * 21)
+      puts printf(code, 'Members: ', members.join(', '))
+      puts printf(code, 'Messages: ', messages_count)
+      puts printf(code, 'Words: ', word_count)
+      puts printf(code, 'Created at: ', created_at)
+      puts "\n=> Word Usage"
+      distribution.each_pair do |word, count|
+        puts printf(code, "#{word}:", count)
+      end
+
+      puts ('=' * 45) + "\n"
+    end
+
+    def range(opts={})
+      min_id  = 0
+      max_id  = -1
+      context = opts[:context].nil? ? 0 : 5
+
+      if opts[:query]
+        occurrences = []
+        messages.each do |m|
+          occurrences << m.id if m.include?(opts[:query])
+        end
+        
+        if occurrences.any?
+          min_id = occurrences.min - (context)
+          max_id = occurrences.max + (context)
+        else
+          min_id = -1
+          max_id = 0
+        end
+      end
+
+      min_id = 0  if min_id < 0
+      max_id = -1 if max_id > messages.length
+
+      return (opts[:min_id] || min_id)..(opts[:max_id] || max_id)
+    end
+
+    def include?(word)
+      return true if word.nil?
+
+      messages.collect{|m| m.include?(word)}.include?(true)
+    end
+
+    def header(range)
+      "\n=> #{members.join(', ')} @ #{created_at} Lines: #{range}"
+    end
+
+    def messages_count
+      messages.length
+    end
+
+    def word_count
+      messages.collect{|m| m.words.length}.inject(0, :+)
+    end
+
+    def word_distribution(opts={})
+      cache = {}
+      messages.each do |message|
+        message.explode.each do |word|
+          cache[word.text] = 0 if cache[word.text].nil?
+
+          cache[word.text] += 1
+        end
+      end
+
+      cache = cuss_words(cache) unless opts[:cuss].nil?
+      cache = top_words(opts[:top], cache)   unless opts[:top].nil?
+
+      cache
+    end
+
+    def cuss_words(cache=word_distribution)
+      cache.reject!{|key| Word::SWEARWORDS.include?(key) }
+    end
+
+    def top_words(limit=10, cache=word_distribution)
+      limit = limit == true ? (+1.0/0.0) : limit
+      
+      sorted = {}
+      cache.each_pair do |word, count|
+        sorted[count] = [] if sorted[count].nil?
+
+        sorted[count] << word
+      end
+
+      top = {}; i = 0
+      sorted.keys.sort{|x,y| y <=> x }.each do |key|
+        break if i > limit
+
+        sorted[key].each do |word|
+          top[word] = key; i += 1
+          
+          break if i > limit
+        end
+      end
+
+      return top
+    end
+
+    def to_s
+      "Conversation <members: #{members.join(', ')}, messages: #{messages.length}>"
+    end
+  end
+end

data/lib/stenographer/message.rb

@@ -0,0 +1,32 @@
+module Stenographer
+  class Message
+
+    attr_accessor :id, :name, :body, :words
+
+    def initialize(id, name, body)
+      @id   = id
+      @name = name
+      @body = body
+      @words = Word.split_message(self)
+    end
+
+    def include?(query=nil)
+      return true if query.nil?
+
+      body.include?(query)
+    end
+
+    def explode
+      Word.split_message(self)
+    end
+
+    def print(opts={})
+      code = opts[:highlighted] ? ">> %-17s %0s" : "%-20s %0s"
+      puts printf(code, name, body)
+    end
+
+    def to_s
+      "Message <name: #{name}, body: #{body}>"
+    end
+  end
+end

data/lib/stenographer/transcript.rb

@@ -0,0 +1,31 @@
+module Stenographer
+  class Transcript
+    
+    attr_accessor :conversations
+
+    def initialize(dir=nil)
+      dir ||= "/Users/#{`whoami`.strip}/Library/Application\ Support/Adium\ 2.0/Users/default/Logs/**/*.xml"
+      @conversations = []
+      
+      Dir.glob(dir).each_with_index do |file, i|
+        doc = Nokogiri.XML(File.open(File.expand_path(file), 'rb'))
+        conversation = Conversation.new(i, doc)
+        next unless conversation.messages.any?
+
+        @conversations << conversation
+      end
+    end
+
+    def read_back(opts={})
+      conversations.each do |conversation|
+        conversation.read_back(opts)
+      end
+
+      self
+    end
+
+    def to_s
+      "Transcript <conversations: #{conversations.length}>"
+    end
+  end
+end

data/lib/stenographer/version.rb

@@ -0,0 +1,3 @@
+module Stenographer
+  VERSION = "0.1.0"
+end

data/lib/stenographer/word.rb

@@ -0,0 +1,20 @@
+module Stenographer
+  class Word
+
+    SWEARWORDS = File.read('./config/swearwords.txt').split(' ')
+
+    attr_accessor :text
+
+    def initialize(text)
+      @text = text
+    end
+
+    def self.split_message(message)
+      words = message.body.split(" ")
+      words = words.map(&:strip)
+
+      words.collect{|text| new(text)}
+    end
+
+  end
+end

data/stenographer.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stenographer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "stenographer"
+  gem.version       = Stenographer::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Matthew Werner"]
+  gem.email         = ["mttwrnr@gmail.com"]
+  gem.description   = %q{Remember what you've said}
+  gem.summary       = %q{Stenographer is a gem that helps you dig through your chat history}
+  gem.homepage      = "https://github.com/mwerner/stenographer"
+  gem.license       = 'MIT'
+
+  gem.add_runtime_dependency 'nokogiri'
+
+  gem.required_rubygems_version = ">= 1.3.6"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: stenographer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Werner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70360847748040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70360847748040
+description: Remember what you've said
+email:
+- mttwrnr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/swearwords.txt
+- lib/stenographer.rb
+- lib/stenographer/conversation.rb
+- lib/stenographer/message.rb
+- lib/stenographer/transcript.rb
+- lib/stenographer/version.rb
+- lib/stenographer/word.rb
+- stenographer.gemspec
+homepage: https://github.com/mwerner/stenographer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Stenographer is a gem that helps you dig through your chat history
+test_files: []