duraflame 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2011 Brian Lopez - http://github.com/brianmario
+
+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,35 @@
+# Duraflame
+
+A command line tool that converts Campfire transcripts to an IRC log format. Allows you to run [pisg](http://pisg.sourceforge.net/) (Perl IRC Statistics Generator) on your Campfire conversations.
+
+## Installation
+
+`gem install duraflame`
+
+## Usage
+
+```
+duraflame [arguments]
+  -c, --company=COMPANY            As in http://{company}.campfirenow.com
+  -t, --token=TOKEN                Authentication token
+  -r, --room=ROOM                  Room ID
+  -o, --output-dir=DIRECTORY       Directory where log files will be written
+  -s, --start-date=DATE            Start date, defaults to today
+  -e, --end-date=DATE              End date, defaults to today
+```
+
+All arguments are required except for start and end dates, which default to today's date.
+
+For example:
+
+`duraflame -c your_company -t your_auth_token96be2812d5367c97f2c87e545 -r 1234 -o campfire_logs --start-date 2012-05-25`
+
+This command will download transcripts from May 25, 2012 through today.
+
+Then run pisg:
+
+`pisg -ch 'Room 1' -d campfire_logs -f irssi`
+
+## Todo
+* Improve performance (fetch transcripts concurrently, operate on streams)
+* Fetch transcripts for multiple rooms

data/Rakefile

@@ -0,0 +1,124 @@
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/duraflame

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'optparse/date'
+require 'duraflame'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: duraflame [options]"
+
+  opts.on("-c", "--company=COMPANY", "As in http://{company}.campfirenow.com") do |company|
+    options[:company] = company
+  end
+
+  opts.on("-t", "--token=TOKEN", "Authentication token") do |token|
+    options[:token] = token
+  end
+
+  opts.on("-r","--room=ROOM", "Room ID") do |room|
+    options[:room] = room
+  end
+
+  opts.on("-o", "--output-dir=DIRECTORY", "Directory where log files will be written") do |dir|
+    options[:output_dir] = dir
+  end
+
+  opts.on("-s", "--start-date=DATE", Date, "Start date, defaults to today") do |start_date|
+    options[:start_date] = start_date
+  end
+
+  opts.on("-e", "--end-date=DATE", Date, "End date, defaults to today") do |end_date|
+    options[:end_date] = end_date
+  end
+end.parse!
+
+begin
+  Duraflame.execute(options)
+rescue Interrupt
+  abort
+end

data/duraflame.gemspec

@@ -0,0 +1,45 @@
+Gem::Specification.new do |s|
+  s.name              = 'duraflame'
+  s.version           = '0.1.0'
+  s.date              = '2012-05-29'
+
+  s.summary     = "A command line tool that converts Campfire transcripts to an IRC log format"
+  s.description = "Generate pisg (Perl IRC Statistics Generator) stats on Campfire conversations"
+
+  s.authors  = ["Alex Kahn"]
+  s.email    = 'alexanderkahn@gmail.com'
+  s.homepage = 'http://github.com/akahn/duraflame'
+
+  s.require_paths = %w[lib]
+
+  s.executables = ["duraflame"]
+
+  s.extra_rdoc_files = %w[README.md MIT-LICENSE]
+
+  s.add_dependency('httpclient', '~>2.2')
+  s.add_dependency('yajl-ruby', '~>1.1')
+
+  # = MANIFEST =
+  s.files = %w[
+    MIT-LICENSE
+    README.md
+    Rakefile
+    bin/duraflame
+    duraflame.gemspec
+    lib/duraflame.rb
+    lib/duraflame/client.rb
+    lib/duraflame/message.rb
+    lib/duraflame/processor.rb
+    lib/duraflame/transcript.rb
+    lib/duraflame/translator.rb
+    lib/duraflame/user_lookup.rb
+    spec/fixtures/transcript.json
+    spec/fixtures/user1.json
+    spec/fixtures/user2.json
+    spec/helper.rb
+    spec/integration_spec.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^spec\/.*_spec\.rb/ }
+end

data/lib/duraflame/client.rb

@@ -0,0 +1,20 @@
+require 'httpclient'
+require 'yajl'
+
+module Duraflame
+  # Wraps HTTPClient with knowledge of hostname and authentication
+  class Client
+    def initialize(company, token)
+      @http_client = HTTPClient.new
+      @http_client.set_auth(nil, token, nil)
+      @uri = URI.parse("https://#{company}.campfirenow.com")
+    end
+
+    def get(path)
+      uri = @uri.dup
+      uri.path = path
+      body = @http_client.get_content(uri)
+      Yajl::Parser.parse(body)
+    end
+  end
+end

data/lib/duraflame/message.rb

@@ -0,0 +1,40 @@
+module Duraflame
+  # Converts a timestamp, user_id and possible body into irssi log format
+  class Message
+    def initialize(timestamp, user_id, body)
+      @timestamp = timestamp
+      @user_id = user_id
+      @body = body
+    end
+
+    private
+
+    def name
+      Duraflame.user_names[@user_id]
+    end
+
+    def time
+      Time.parse(@timestamp).strftime('%R')
+    end
+
+    attr_reader :body
+  end
+
+  class TextMessage < Message
+    def to_s
+      [time, "< #{name}>", body].join(' ')
+    end
+  end
+
+  class EnterMessage < Message
+    def to_s
+      [time, '-!-' , name, '[hostname] has joined #campfire'].join(' ')
+    end
+  end
+
+  class KickMessage < Message
+    def to_s
+      [time, '-!-' , name, '[hostname] has left #campfire'].join(' ')
+    end
+  end
+end

data/lib/duraflame/processor.rb

@@ -0,0 +1,25 @@
+require 'duraflame/message'
+require 'duraflame/transcript'
+
+module Duraflame
+  class Processor
+    def initialize(room, date_range, output_directory, http_client)
+      @room = room
+      @date_range = date_range
+      @output_directory = output_directory
+      @http_client = http_client
+    end
+
+    def execute
+      @date_range.each do |date|
+        File.open(@output_directory + "/#{date}-#{@room}.log", 'w') do |file|
+          puts "Writing to #{file.path}"
+
+          Transcript.new(@room, date, @http_client).each_message do |message|
+            file.puts message.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/duraflame/transcript.rb

@@ -0,0 +1,26 @@
+module Duraflame
+  class Transcript
+    def initialize(room, date, http_client)
+      @room = room
+      @date = date
+      @http_client = http_client
+    end
+
+    def each_message
+      @http_client.get(url)['messages'].each do |message|
+        if Duraflame.const_defined?(message['type']) # e.g. TextMessage
+          message_class = Duraflame.const_get(message['type'])
+          args = message.values_at('created_at', 'user_id', 'body')
+          yield message_class.new(*args)
+        end
+      end
+    end
+
+    private
+
+    def url
+      "/room/%s/transcript/%s/%s/%s.json" %
+        [@room, @date.year, @date.month, @date.day]
+    end
+  end
+end

data/lib/duraflame/translator.rb

@@ -0,0 +1,36 @@
+module Duraflame
+  module Translator
+    extend self
+
+    def text_message(message)
+      date, user, body = message.values_at('created_at', 'user_id', 'body')
+      time = date.split(' ')[1].split(':')[0..1].join(':')
+      "#{time} <#{user}> #{body}"
+    end
+
+    def enter_message(message)
+      time = message['created_at'].split(' ')[1].split(':')[0..1].join(':')
+      "#{time} <#{message['user_id']}> has joined"
+    end
+
+    def kick_message(message)
+      time = message['created_at'].split(' ')[1].split(':')[0..1].join(':')
+      "#{time} <#{message['user_id']}> has left"
+    end
+
+    def upload_message(*)
+    end
+
+    def sound_message(*)
+    end
+
+    def tweet_message(*)
+    end
+
+    def paste_message(*)
+    end
+
+    def timestamp_message(*)
+    end
+  end
+end

data/lib/duraflame/user_lookup.rb

@@ -0,0 +1,14 @@
+module Duraflame
+  class UserLookup
+    def initialize(http_client)
+      @users = {}
+      @http_client = http_client
+    end
+
+    def [](id)
+      @users[id] ||= begin
+        @http_client.get("/users/#{id}.json")['user']['name']
+      end
+    end
+  end
+end

data/lib/duraflame.rb

@@ -0,0 +1,30 @@
+require 'duraflame/processor'
+require 'duraflame/user_lookup'
+require 'duraflame/client'
+
+module Duraflame
+  VERSION = '0.1.0'
+
+  extend self
+
+  def execute(options)
+    %w[company token output_dir room].each do |option|
+      if !options.has_key?(option.to_sym)
+        abort "Error: Missing option --#{option}. See duraflame --help."
+      end
+      instance_variable_set('@' + option, options[option.to_sym])
+    end
+
+    start_date = options.fetch(:start_date, Date.today)
+    end_date = options.fetch(:end_date, Date.today)
+    Processor.new(@room, start_date..end_date, @output_dir, http_client).execute
+  end
+
+  def http_client
+    @http_client ||= Client.new(@company, @token)
+  end
+
+  def user_names
+    @user_lookup ||= UserLookup.new(http_client)
+  end
+end

data/spec/fixtures/transcript.json

@@ -0,0 +1,33 @@
+{ "messages" : [ { "body" : null,
+        "created_at" : "2012/05/25 04:04:19 +0000",
+        "id" : 577169389,
+        "room_id" : 1,
+        "starred" : false,
+        "type" : "EnterMessage",
+        "user_id" : 1
+      },
+      { "body" : "ok, deploying to production",
+        "created_at" : "2012/05/25 05:01:23 +0000",
+        "id" : 577557437,
+        "room_id" : 1,
+        "starred" : false,
+        "type" : "TextMessage",
+        "user_id" : 2
+      },
+      { "body" : null,
+        "created_at" : "2012/05/25 06:20:29 +0000",
+        "id" : 577214413,
+        "room_id" : 1,
+        "starred" : false,
+        "type" : "KickMessage",
+        "user_id" : 1
+      },
+      { "body" : null,
+        "created_at" : "2012/05/25 07:10:00 +0000",
+        "id" : 577173940,
+        "room_id" : 1,
+        "starred" : false,
+        "type" : "TimestampMessage",
+        "user_id" : null
+      }
+    ] }

data/spec/fixtures/user1.json

@@ -0,0 +1 @@
+{"user":{"type":"Member","created_at":"2010/06/14 14:25:24 +0000","admin":true,"id":1,"email_address":"sisko@ds9.starfleet","name":"Benjamin Sisko"}}

data/spec/fixtures/user2.json

@@ -0,0 +1 @@
+{"user":{"type":"Member","created_at":"2012/05/20 12:00:00 +0000","admin":true,"id":2,"email_address":"obrien@ds9.starfleet","name":"Miles O'Brien"}}

data/spec/helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'webmock'
+require 'webmock/rspec'
+require_relative '../lib/duraflame'
+
+include WebMock::API

data/spec/integration_spec.rb

@@ -0,0 +1,38 @@
+require_relative 'helper'
+
+describe 'Duraflame under integration' do
+  before(:all) do
+    dir = File.dirname(__FILE__)
+    stub_request(:any, /transcript/).to_return(:body => File.open(dir + '/fixtures/transcript.json'))
+    stub_request(:any, /users\/1/).to_return(:body => File.open(dir + '/fixtures/user1.json'))
+    stub_request(:any, /users\/2/).to_return(:body => File.open(dir + '/fixtures/user2.json'))
+
+    options = {
+      :company => 'paperlesspost',
+      :token => 'aoeu',
+      :room => 4321,
+      :output_dir => Dir.tmpdir,
+      :start_date => Date.parse('2012-01-01'),
+      :end_date => Date.parse('2012-01-01')
+    }
+    Duraflame.execute(options)
+
+    @log = File.readlines(Dir.tmpdir + "/2012-01-01-#{options[:room]}.log")
+  end
+
+  it 'should output three lines' do
+    @log.length.should == 3
+  end
+
+  it 'should contain Sisko joining' do
+    @log[0].should include('0:04 -!- Benjamin Sisko [hostname] has joined')
+  end
+
+  it "should contain O'Brien's message joining" do
+    @log[1].should include("1:01 < Miles O'Brien> ok")
+  end
+
+  it 'should contain Sisko leaving' do
+    @log[2].should include('02:20 -!- Benjamin Sisko [hostname] has left')
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: duraflame
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Kahn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &2154226300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154226300
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &2154225820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154225820
+description: Generate pisg (Perl IRC Statistics Generator) stats on Campfire conversations
+email: alexanderkahn@gmail.com
+executables:
+- duraflame
+extensions: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/duraflame
+- duraflame.gemspec
+- lib/duraflame.rb
+- lib/duraflame/client.rb
+- lib/duraflame/message.rb
+- lib/duraflame/processor.rb
+- lib/duraflame/transcript.rb
+- lib/duraflame/translator.rb
+- lib/duraflame/user_lookup.rb
+- spec/fixtures/transcript.json
+- spec/fixtures/user1.json
+- spec/fixtures/user2.json
+- spec/helper.rb
+- spec/integration_spec.rb
+homepage: http://github.com/akahn/duraflame
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A command line tool that converts Campfire transcripts to an IRC log format
+test_files:
+- spec/integration_spec.rb
+has_rdoc: