campfire_export 0.0.1

data/.gitignore

@@ -0,0 +1,44 @@
+# Ruby
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+pkg/*
+
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Emacs
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+.elc
+auto-save-list
+tramp
+
+# OSX
+.DS_Store
+Icon?
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# project-specific
+campfire

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,160 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+(50%) or more of the outstanding shares, or (iii) beneficial ownership of such
+entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative
+Works shall not include works that remain separable from, or merely link (or
+bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, including
+but not limited to communication on electronic mailing lists, source code
+control systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated
+in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import,
+and otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily infringed by
+their Contribution(s) alone or by combination of their Contribution(s) with
+the Work to which such Contribution(s) was submitted. If You institute patent
+litigation against any entity (including a cross-claim or counterclaim in a
+lawsuit) alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent
+licenses granted to You under this License for that Work shall terminate as of
+the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+
+You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of
+the following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License. You may add Your own copyright statement to Your
+modifications and may provide additional or different license terms and
+conditions for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in this
+License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein
+shall supersede or modify the terms of any separate license agreement you may
+have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the Work
+and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability
+to use the Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all other
+commercial damages or losses), even if such Contributor has been advised of
+the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work
+or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.

data/README.md

@@ -0,0 +1,99 @@
+# campfire_export #
+
+## Quick Start ##
+
+    $ gem install campfire_export
+    $ campfire_export
+
+## Intro ##
+
+I had an old, defunct [Campfire](http://campfirenow.com/) account with five
+years' worth of transcripts in it, some of them hilarious, others just 
+memorable. Unfortunately, Campfire doesn't currently have an export function;
+instead it provides pages of individual transcripts. I wanted a script to
+export everything from all five years, using the Campfire API.
+
+I found a [Gist](https://gist.github.com) that looked pretty good:
+
+* [https://gist.github.com/821553](https://gist.github.com/821553)
+
+but it wasn't quite right. So this is my modification, converted to a GitHub
+repo.
+
+## Features ##
+
+* Saves HTML, XML, and plaintext versions of chat transcripts.
+* Exports uploaded files to a day-specific subdirectory for easy access.
+* Reports and logs export errors so you know what you're missing.
+* Obsessively confirms that everything was exported correctly.
+
+## Installing ##
+
+Ruby 1.8.7 or later is required.
+
+To install:
+
+    $ gem install campfire_export
+
+## Configuring ##
+
+There are a number of configuration variables required to run the export. The
+export script will prompt you for these; just run it and away you go. If you
+want to run the script repeatedly or want to control the start and end date of
+the export, you can create a `.campfire_export.yaml` file in your home
+directory using this template:
+
+    # Your Campfire subdomain (for 'https://myco.campfirenow.com', use 'myco').
+    subdomain:  example
+
+    # Your Campfire API token (see "My Info" on your Campfire site).
+    api_token:  abababababababababababababababababababab
+
+    # OPTIONAL: Export start date - the first transcript you want exported.
+    # Uncomment to set. Defaults to the date each room was created.
+    #start_date: 2010/1/1
+
+    # OPTIONAL: Export end date - the last transcript you want exported.
+    # Uncomment to set. Defaults to the date of the last comment in each room.
+    #end_date:   2010/12/31
+
+The `start_date` and `end_date` variables are inclusive (that is, if your
+end date is Dec 31, 2010, a transcript for that date will be downloaded), and
+both are optional. If they are omitted, export will run from the date each
+Campfire room was created, until the date of the last message in that room.
+
+## Exporting ##
+
+Just run `campfire_export` and your transcripts will be exported into a
+`campfire` directory in the current directory, with subdirectories for each
+site/room/year/month/day. In those directories, any uploaded files will be
+saved with their original filenames, in a directory named for the upload ID
+(since transcripts often have the same filename uploaded multiple times, e.g.
+`Picture 1.png`). (Note that rooms and uploaded files may have odd filenames
+-- for instance, spaces in the file/directory names.) Errors that happen
+trying to export will be logged to `campfire/export_errors.txt`.
+
+The Gist I forked had a plaintext transcript export, which I've kept in as
+`transcript.txt` in each directory. However, the original XML and HTML are now
+also saved as `transcript.xml` and `transcript.html`, which could be useful.
+
+Days which have no messages posted will be ignored, so the resulting directory
+structure will be sparse (no messages == no directory).
+
+## Credit ##
+
+As mentioned above, some of the work on this was done by other people. The
+Gist I forked had contributions from:
+
+* [Pat Allan](https://github.com/freelancing-god)
+* [Bruno Mattarollo](https://github.com/bruno)
+* [bf4](https://github.com/bf4)
+
+Also, thanks much for all the help, comments and contributions:
+
+* [Jeffrey Hardy](https://github.com/packagethief)
+* [Brad Greenlee](https://github.com/bgreenlee)
+
+Thanks, all!
+
+- Marc Hedlund, marc@precipice.org

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/campfire_export

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+# Copyright 2011 Marc Hedlund <marc@precipice.org>
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# campfire_export -- export Campfire transcripts and uploaded files.
+#
+# Since Campfire (www.campfirenow.com) doesn't provide an export feature,
+# this script implements one via the Campfire API.
+#
+# See https://github.com/precipice/campfire_export/blob/master/README.md
+# for more information on using this script.
+
+lib = File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'campfire_export'
+
+def config_date(config, date_key)
+  date_str = config.fetch(date_key, nil)
+  date_str.nil? ? nil : Date.parse(date_str)
+end
+
+def ensure_config_for(config, key, prompt)
+  value = config.fetch(key, "")
+  while value == ""
+    print "#{prompt}: "
+    value = gets.chomp
+  end
+  config[key] = value
+end
+
+config = {}
+config_file = File.join(ENV['HOME'], '.campfire_export.yaml')
+
+if File.exists?(config_file) and File.readable?(config_file)
+  config = YAML.load_file(config_file)  
+end
+
+ensure_config_for(config, 'subdomain', 
+  "Your Campfire subdomain (for 'https://myco.campfirenow.com', use 'myco')")
+ensure_config_for(config, 'api_token',
+  "Your Campfire API token (see 'My Info' on your Campfire site)")
+
+account = CampfireExport::Account.new(config['subdomain'], config['api_token'])
+account.export(config_date(config, 'start_date'), config_date(config, 'end_date'))

data/campfire_export.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "campfire_export/version"
+
+Gem::Specification.new do |s|
+  s.name        = "campfire_export"
+  s.version     = CampfireExport::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Marc Hedlund"]
+  s.email       = ["marc@precipice.org"]
+  s.homepage    = "https://github.com/precipice/campfire_export"
+  s.summary     = %q{Export transcripts and uploaded files from your 37signals' Campfire account.}
+  s.description = s.summary
+
+  s.rubyforge_project = "campfire_export"
+  
+  s.add_development_dependency "bundler",  "~> 1.0.15"
+  s.add_development_dependency "tzinfo",   "~> 0.3.29"
+  s.add_development_dependency "httparty", "~> 0.7.8"
+  s.add_development_dependency "nokogiri", "~> 1.4.5"
+
+  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"]
+end

data/lib/campfire_export/timezone.rb

@@ -0,0 +1,168 @@
+# Ruby on Rails is released under the MIT license.
+
+require 'rubygems'
+
+require 'tzinfo'
+
+module CampfireExport
+  # This is a total cut & paste from:
+  # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/values/time_zone.rb
+  # I'm copying it here to avoid bugs in the current active_support gem, to
+  # avoid having a dependency on active_support that might freak out Rails
+  # users, and to avoid fighting with RubyGems about threads and deprecation. 
+  # See for background:
+  # https://github.com/rails/rails/pull/1215
+  # http://stackoverflow.com/questions/5176782/uninitialized-constant-activesupportdependenciesmutex-nameerror
+  module TimeZone
+    # Keys are Rails TimeZone names, values are TZInfo identifiers
+    MAPPING = {
+      "International Date Line West" => "Pacific/Midway",
+      "Midway Island"                => "Pacific/Midway",
+      "Samoa"                        => "Pacific/Pago_Pago",
+      "Hawaii"                       => "Pacific/Honolulu",
+      "Alaska"                       => "America/Juneau",
+      "Pacific Time (US & Canada)"   => "America/Los_Angeles",
+      "Tijuana"                      => "America/Tijuana",
+      "Mountain Time (US & Canada)"  => "America/Denver",
+      "Arizona"                      => "America/Phoenix",
+      "Chihuahua"                    => "America/Chihuahua",
+      "Mazatlan"                     => "America/Mazatlan",
+      "Central Time (US & Canada)"   => "America/Chicago",
+      "Saskatchewan"                 => "America/Regina",
+      "Guadalajara"                  => "America/Mexico_City",
+      "Mexico City"                  => "America/Mexico_City",
+      "Monterrey"                    => "America/Monterrey",
+      "Central America"              => "America/Guatemala",
+      "Eastern Time (US & Canada)"   => "America/New_York",
+      "Indiana (East)"               => "America/Indiana/Indianapolis",
+      "Bogota"                       => "America/Bogota",
+      "Lima"                         => "America/Lima",
+      "Quito"                        => "America/Lima",
+      "Atlantic Time (Canada)"       => "America/Halifax",
+      "Caracas"                      => "America/Caracas",
+      "La Paz"                       => "America/La_Paz",
+      "Santiago"                     => "America/Santiago",
+      "Newfoundland"                 => "America/St_Johns",
+      "Brasilia"                     => "America/Sao_Paulo",
+      "Buenos Aires"                 => "America/Argentina/Buenos_Aires",
+      "Georgetown"                   => "America/Guyana",
+      "Greenland"                    => "America/Godthab",
+      "Mid-Atlantic"                 => "Atlantic/South_Georgia",
+      "Azores"                       => "Atlantic/Azores",
+      "Cape Verde Is."               => "Atlantic/Cape_Verde",
+      "Dublin"                       => "Europe/Dublin",
+      "Edinburgh"                    => "Europe/London",
+      "Lisbon"                       => "Europe/Lisbon",
+      "London"                       => "Europe/London",
+      "Casablanca"                   => "Africa/Casablanca",
+      "Monrovia"                     => "Africa/Monrovia",
+      "UTC"                          => "Etc/UTC",
+      "Belgrade"                     => "Europe/Belgrade",
+      "Bratislava"                   => "Europe/Bratislava",
+      "Budapest"                     => "Europe/Budapest",
+      "Ljubljana"                    => "Europe/Ljubljana",
+      "Prague"                       => "Europe/Prague",
+      "Sarajevo"                     => "Europe/Sarajevo",
+      "Skopje"                       => "Europe/Skopje",
+      "Warsaw"                       => "Europe/Warsaw",
+      "Zagreb"                       => "Europe/Zagreb",
+      "Brussels"                     => "Europe/Brussels",
+      "Copenhagen"                   => "Europe/Copenhagen",
+      "Madrid"                       => "Europe/Madrid",
+      "Paris"                        => "Europe/Paris",
+      "Amsterdam"                    => "Europe/Amsterdam",
+      "Berlin"                       => "Europe/Berlin",
+      "Bern"                         => "Europe/Berlin",
+      "Rome"                         => "Europe/Rome",
+      "Stockholm"                    => "Europe/Stockholm",
+      "Vienna"                       => "Europe/Vienna",
+      "West Central Africa"          => "Africa/Algiers",
+      "Bucharest"                    => "Europe/Bucharest",
+      "Cairo"                        => "Africa/Cairo",
+      "Helsinki"                     => "Europe/Helsinki",
+      "Kyiv"                         => "Europe/Kiev",
+      "Riga"                         => "Europe/Riga",
+      "Sofia"                        => "Europe/Sofia",
+      "Tallinn"                      => "Europe/Tallinn",
+      "Vilnius"                      => "Europe/Vilnius",
+      "Athens"                       => "Europe/Athens",
+      "Istanbul"                     => "Europe/Istanbul",
+      "Minsk"                        => "Europe/Minsk",
+      "Jerusalem"                    => "Asia/Jerusalem",
+      "Harare"                       => "Africa/Harare",
+      "Pretoria"                     => "Africa/Johannesburg",
+      "Moscow"                       => "Europe/Moscow",
+      "St. Petersburg"               => "Europe/Moscow",
+      "Volgograd"                    => "Europe/Moscow",
+      "Kuwait"                       => "Asia/Kuwait",
+      "Riyadh"                       => "Asia/Riyadh",
+      "Nairobi"                      => "Africa/Nairobi",
+      "Baghdad"                      => "Asia/Baghdad",
+      "Tehran"                       => "Asia/Tehran",
+      "Abu Dhabi"                    => "Asia/Muscat",
+      "Muscat"                       => "Asia/Muscat",
+      "Baku"                         => "Asia/Baku",
+      "Tbilisi"                      => "Asia/Tbilisi",
+      "Yerevan"                      => "Asia/Yerevan",
+      "Kabul"                        => "Asia/Kabul",
+      "Ekaterinburg"                 => "Asia/Yekaterinburg",
+      "Islamabad"                    => "Asia/Karachi",
+      "Karachi"                      => "Asia/Karachi",
+      "Tashkent"                     => "Asia/Tashkent",
+      "Chennai"                      => "Asia/Kolkata",
+      "Kolkata"                      => "Asia/Kolkata",
+      "Mumbai"                       => "Asia/Kolkata",
+      "New Delhi"                    => "Asia/Kolkata",
+      "Kathmandu"                    => "Asia/Kathmandu",
+      "Astana"                       => "Asia/Dhaka",
+      "Dhaka"                        => "Asia/Dhaka",
+      "Sri Jayawardenepura"          => "Asia/Colombo",
+      "Almaty"                       => "Asia/Almaty",
+      "Novosibirsk"                  => "Asia/Novosibirsk",
+      "Rangoon"                      => "Asia/Rangoon",
+      "Bangkok"                      => "Asia/Bangkok",
+      "Hanoi"                        => "Asia/Bangkok",
+      "Jakarta"                      => "Asia/Jakarta",
+      "Krasnoyarsk"                  => "Asia/Krasnoyarsk",
+      "Beijing"                      => "Asia/Shanghai",
+      "Chongqing"                    => "Asia/Chongqing",
+      "Hong Kong"                    => "Asia/Hong_Kong",
+      "Urumqi"                       => "Asia/Urumqi",
+      "Kuala Lumpur"                 => "Asia/Kuala_Lumpur",
+      "Singapore"                    => "Asia/Singapore",
+      "Taipei"                       => "Asia/Taipei",
+      "Perth"                        => "Australia/Perth",
+      "Irkutsk"                      => "Asia/Irkutsk",
+      "Ulaan Bataar"                 => "Asia/Ulaanbaatar",
+      "Seoul"                        => "Asia/Seoul",
+      "Osaka"                        => "Asia/Tokyo",
+      "Sapporo"                      => "Asia/Tokyo",
+      "Tokyo"                        => "Asia/Tokyo",
+      "Yakutsk"                      => "Asia/Yakutsk",
+      "Darwin"                       => "Australia/Darwin",
+      "Adelaide"                     => "Australia/Adelaide",
+      "Canberra"                     => "Australia/Melbourne",
+      "Melbourne"                    => "Australia/Melbourne",
+      "Sydney"                       => "Australia/Sydney",
+      "Brisbane"                     => "Australia/Brisbane",
+      "Hobart"                       => "Australia/Hobart",
+      "Vladivostok"                  => "Asia/Vladivostok",
+      "Guam"                         => "Pacific/Guam",
+      "Port Moresby"                 => "Pacific/Port_Moresby",
+      "Magadan"                      => "Asia/Magadan",
+      "Solomon Is."                  => "Asia/Magadan",
+      "New Caledonia"                => "Pacific/Noumea",
+      "Fiji"                         => "Pacific/Fiji",
+      "Kamchatka"                    => "Asia/Kamchatka",
+      "Marshall Is."                 => "Pacific/Majuro",
+      "Auckland"                     => "Pacific/Auckland",
+      "Wellington"                   => "Pacific/Auckland",
+      "Nuku'alofa"                   => "Pacific/Tongatapu"
+    }.each { |name, zone| name.freeze; zone.freeze }
+    MAPPING.freeze
+    
+    def find_tzinfo(name)
+      TZInfo::TimezoneProxy.new(MAPPING[name] || name)
+    end
+  end
+end

data/lib/campfire_export/version.rb

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

data/lib/campfire_export.rb

@@ -0,0 +1,435 @@
+#!/usr/bin/env ruby
+
+# Portions copyright 2011 Marc Hedlund <marc@precipice.org>.
+# Adapted from https://gist.github.com/821553 and ancestors.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# campfire_export.rb -- export Campfire transcripts and uploaded files.
+#
+# Since Campfire (www.campfirenow.com) doesn't provide an export feature,
+# this script implements one via the Campfire API.
+
+require 'rubygems'
+
+require 'campfire_export/timezone'
+
+require 'cgi'
+require 'fileutils'
+require 'httparty'
+require 'nokogiri'
+require 'time'
+require 'yaml'
+
+module CampfireExport
+  module IO
+    def api_url(path)
+      "#{CampfireExport::Account.base_url}#{path}"
+    end
+
+    def get(path, params = {})
+      url = api_url(path)
+      response = HTTParty.get(url, :query => params, :basic_auth => 
+        {:username => CampfireExport::Account.api_token, :password => 'X'})
+
+      if response.code >= 400
+        raise CampfireExport::Exception.new(url, response.message, response.code)
+      end
+      response
+    end
+    
+    def zero_pad(number)
+      "%02d" % number
+    end
+
+    # Requires that room and date be defined in the calling object.
+    def export_dir
+      "campfire/#{CampfireExport::Account.subdomain}/#{room.name}/" +
+        "#{date.year}/#{zero_pad(date.mon)}/#{zero_pad(date.day)}"
+    end
+
+    # Requires that room_name and date be defined in the calling object.    
+    def export_file(content, filename, mode='w')
+      # Check to make sure we're writing into the target directory tree.
+      true_path = File.expand_path(File.join(export_dir, filename))
+      unless true_path.start_with?(File.expand_path(export_dir))
+        raise CampfireExport::Exception.new("#{export_dir}/#{filename}",
+          "can't export file to a directory higher than target directory " +
+          "(expected: #{File.expand_path(export_dir)}, actual: #{true_path}).")
+      end
+      
+      if File.exists?("#{export_dir}/#{filename}")
+        log(:error, "#{export_dir}/#{filename} failed: file already exists.")
+      else
+        open("#{export_dir}/#{filename}", mode) do |file|
+          begin
+            file.write content
+          rescue => e
+            log(:error, "#{export_dir}/#{filename} failed: " +
+              "#{e.backtrace.join("\n")}")
+          end
+        end
+      end
+    end
+    
+    def verify_export(filename, expected_size)
+      full_path = "#{export_dir}/#{filename}"
+      unless File.exists?(full_path)
+        raise CampfireExport::Exception.new(full_path, 
+          "file should have been exported but does not exist")
+      end
+      unless File.size(full_path) == expected_size
+        raise CampfireExport::Exception.new(full_path, 
+          "exported file exists but is not the right size " +
+          "(expected: #{expected_size}, actual: #{File.size(full_path)})")
+      end
+    end
+    
+    def log(level, message)
+      case level
+      when :error
+        puts "*** Error: #{message}"
+        open("campfire/export_errors.txt", 'a') do |log|
+          log.write "#{message}\n"
+        end
+      else
+        print message
+        STDOUT.flush
+      end
+    end
+  end
+  
+  class Exception < StandardError
+    attr_accessor :resource, :message, :code
+    def initialize(resource, message, code=nil)
+      @resource = resource
+      @message = message
+      @code = code
+    end
+
+    def to_s
+      "<#{resource}>: #{message}" + (code ? " (#{code})" : "")
+    end
+  end
+
+  class Account
+    include CampfireExport::IO
+    include CampfireExport::TimeZone
+    
+    @subdomain = ""
+    @api_token = ""
+    @base_url  = ""
+    @timezone  = ""
+    
+    class << self
+      attr_accessor :subdomain, :api_token, :base_url, :timezone
+    end
+    
+    def initialize(subdomain, api_token)
+      CampfireExport::Account.subdomain = subdomain
+      CampfireExport::Account.api_token = api_token
+      CampfireExport::Account.base_url  = "https://#{subdomain}.campfirenow.com"
+      CampfireExport::Account.timezone  = parse_timezone
+    end
+    
+    def parse_timezone
+      settings_html = Nokogiri::HTML get('/account/settings').body
+      selected_zone = settings_html.css('select[id="account_time_zone_id"] ' +
+                                        '> option[selected="selected"]')
+      find_tzinfo(selected_zone.attribute("value").text)
+    end
+    
+    def export(start_date=nil, end_date=nil)
+      begin
+        doc = Nokogiri::XML get('/rooms.xml').body
+        doc.css('room').each do |room_xml|
+          room = CampfireExport::Room.new(room_xml)
+          room.export(start_date, end_date)
+        end
+      rescue CampfireExport::Exception => e
+        log(:error, "room list download failed: #{e}")
+      end
+    end
+  end
+
+  class Room
+    include CampfireExport::IO
+    attr_accessor :id, :name, :created_at, :last_update
+    
+    def initialize(room_xml)
+      @id          = room_xml.css('id').text
+      @name        = room_xml.css('name').text
+
+      created_utc  = DateTime.parse(room_xml.css('created-at').text)
+      @created_at  = CampfireExport::Account.timezone.utc_to_local(created_utc)
+
+      last_message = Nokogiri::XML get("/room/#{id}/recent.xml?limit=1").body
+      update_utc   = DateTime.parse(last_message.css('created-at').text)
+      @last_update = CampfireExport::Account.timezone.utc_to_local(update_utc)
+      
+    end
+
+    def export(start_date=nil, end_date=nil)
+      # Figure out how to do the least amount of work while still conforming
+      # to the requester's boundary dates.
+      start_date.nil? ? date = created_at      : date = [start_date, created_at].max
+      end_date.nil?   ? end_date = last_update : end_date = [end_date, last_update].min
+      
+      while date <= end_date
+        transcript = CampfireExport::Transcript.new(self, date)
+        transcript.export
+
+        # Ensure that we stay well below the 37signals API limits.
+        sleep(1.0/10.0)
+        date = date.next
+      end
+    end
+  end
+
+  class Transcript
+    include CampfireExport::IO
+    attr_accessor :room, :date, :messages
+    
+    def initialize(room, date)
+      @room     = room
+      @date     = date
+    end
+    
+    def transcript_path
+      "/room/#{room.id}/transcript/#{date.year}/#{date.mon}/#{date.mday}"
+    end
+    
+    def export
+      begin
+        log(:info, "#{export_dir} ... ")
+        transcript_xml = Nokogiri::XML get("#{transcript_path}.xml").body
+        
+        @messages = transcript_xml.css('message').map do |message|
+          CampfireExport::Message.new(message, room, date)
+        end
+        
+        # Only export transcripts that contain at least one message.
+        if messages.length > 0
+          log(:info, "exporting transcripts\n")
+          FileUtils.mkdir_p export_dir
+
+          export_file(transcript_xml, 'transcript.xml')
+          verify_export('transcript.xml', transcript_xml.to_s.length)
+          
+          export_plaintext
+          export_html
+          export_uploads
+        else
+          log(:info, "no messages\n")
+        end
+      rescue CampfireExport::Exception => e
+        log(:error, "transcript export for #{export_dir} failed: #{e}")
+      end
+    end
+      
+    def export_plaintext
+      begin
+        plaintext = "#{CampfireExport::Account.subdomain.upcase} CAMPFIRE\n"
+        plaintext << "#{room.name}: " +
+          "#{date.strftime('%A, %B %e, %Y').gsub('  ', ' ')}\n\n"
+        messages.each {|message| plaintext << message.to_s }
+        export_file(plaintext, 'transcript.txt')
+        verify_export('transcript.txt', plaintext.length)
+      rescue CampfireExport::Exception => e
+        log(:error, "Plaintext transcript export for #{export_dir} failed: #{e}")
+      end
+    end
+        
+    def export_html
+      begin
+        transcript_html = get(transcript_path)
+        # Make the upload links in the transcript clickable for the exported 
+        # directory layout.
+        transcript_html.gsub!(%Q{<a href="/room/#{room.id}/uploads/},
+                              %Q{<a href="uploads/})
+        export_file(transcript_html, 'transcript.html')
+        verify_export('transcript.html', transcript_html.length)
+      rescue CampfireExport::Exception => e
+        log(:error, "HTML transcript export for #{export_dir} failed: #{e}")
+      end
+    end
+
+    def export_uploads
+      messages.each do |message|
+        if message.is_upload?
+          begin
+            message.upload.export
+          rescue CampfireExport::Exception => e
+            path = "#{message.upload.export_dir}/#{message.upload.filename}"
+            log(:error, "Upload export for #{path} failed: " +
+              "#{e.backtrace.join("\n")}")
+          end
+        end
+      end
+    end    
+  end
+  
+  class Message
+    include CampfireExport::IO
+    attr_accessor :id, :room, :body, :type, :user, :date, :timestamp, :upload
+
+    def initialize(message, room, date)
+      @id = message.css('id').text
+      @room = room
+      @date = date
+      @body = message.css('body').text
+      @type = message.css('type').text
+
+      time = Time.parse message.css('created-at').text
+      localtime = CampfireExport::Account.timezone.utc_to_local(time)
+      @timestamp = localtime.strftime '%I:%M %p'
+
+      no_user = ['TimestampMessage', 'SystemMessage', 'AdvertisementMessage']
+      unless no_user.include?(@type)
+        begin
+          @user = username(message.css('user-id').text)
+        rescue CampfireExport::Exception
+          @user = "[unknown user]"
+        end
+      end
+      
+      begin
+        @upload = CampfireExport::Upload.new(self) if is_upload?
+      rescue e
+        log(:error, "Got an exception while making an upload: #{e}")
+      end
+    end
+
+    def username(user_id)
+      @@usernames          ||= {}
+      @@usernames[user_id] ||= begin
+        doc = Nokogiri::XML get("/users/#{user_id}.xml").body
+        doc.css('name').text
+      end
+    end
+
+    def is_upload?
+      @type == 'UploadMessage'
+    end
+
+    def indent(string, count)
+      (' ' * count) + string.gsub(/(\n+)/) { $1 + (' ' * count) }
+    end
+
+    def to_s
+      case type
+      when 'EnterMessage'
+        "[#{user} has entered the room]\n"
+      when 'KickMessage', 'LeaveMessage'
+        "[#{user} has left the room]\n"
+      when 'TextMessage'
+        "[#{user}:] #{body}\n"
+      when 'UploadMessage'
+        "[#{user} uploaded:] #{body}\n"
+      when 'PasteMessage'
+        "[#{user} pasted:]\n#{indent(body, 2)}\n"
+      when 'TopicChangeMessage'
+        "[#{user} changed the topic to: #{body}]\n"
+      when 'ConferenceCreatedMessage'
+        "[#{user} created conference: #{body}]\n"
+      when 'AllowGuestsMessage'
+        "[#{user} opened the room to guests]\n"
+      when 'DisallowGuestsMessage'
+        "[#{user} closed the room to guests]\n"
+      when 'LockMessage'
+        "[#{user} locked the room]\n"
+      when 'UnlockMessage'
+        "[#{user} unlocked the room]\n"
+      when 'IdleMessage'
+        "[#{user} became idle]\n"
+      when 'UnidleMessage'
+        "[#{user} became active]\n"
+      when 'TweetMessage'
+        "[#{user} tweeted:] #{body}\n"
+      when 'SoundMessage'
+        "[#{user} played a sound:] #{body}\n"
+      when 'TimestampMessage'
+        "--- #{timestamp} ---\n"
+      when 'SystemMessage'
+        ""
+      when 'AdvertisementMessage'
+        ""
+      else
+        log(:error, "unknown message type: #{type} - '#{body}'")
+        ""
+      end
+    end
+  end
+  
+  class Upload
+    include CampfireExport::IO
+    attr_accessor :message, :room, :date, :id, :filename, :content, :byte_size
+    
+    def initialize(message)
+      @message = message
+      @room = message.room
+      @date = message.date
+      @deleted = false
+    end
+    
+    def deleted?
+      @deleted
+    end
+    
+    def upload_dir
+      "uploads/#{id}"
+    end
+    
+    def export
+      begin
+        log(:info, "    #{message.body} ... ")
+
+        # Get the upload object corresponding to this message.
+        upload_path = "/room/#{room.id}/messages/#{message.id}/upload.xml"
+        upload = Nokogiri::XML get(upload_path).body
+        
+        # Get the upload itself and export it.
+        @id = upload.css('id').text
+        @byte_size = upload.css('byte-size').text.to_i
+        @filename = upload.css('name').text
+        escaped_name = CGI.escape(filename)
+
+        content_path = "/room/#{room.id}/uploads/#{id}/#{escaped_name}"        
+        @content = get(content_path).body
+      
+        # Write uploads to a subdirectory, using the upload ID as a directory
+        # name to avoid overwriting multiple uploads of the same file within
+        # the same day (for instance, if 'Picture 1.png' is uploaded twice
+        # in a day, this will preserve both copies). This path pattern also
+        # matches the tail of the upload path in the HTML transcript, making
+        # it easier to make downloads functional from the HTML transcripts.
+        FileUtils.mkdir_p "#{export_dir}/#{upload_dir}"
+        export_file(content, "#{upload_dir}/#{filename}", 'wb')
+        verify_export("#{upload_dir}/#{filename}", byte_size)
+        log(:info, "ok\n")
+      rescue CampfireExport::Exception => e
+        if e.code == 404
+          # If the upload 404s, that should mean it was subsequently deleted.
+          @deleted = true
+          log(:info, "deleted\n")
+        else
+          log(:error, "Got an upload error: #{e.backtrace.join("\n")}")
+          raise e
+        end
+      rescue => e
+        log(:error, "export of #{export_dir}/#{upload_dir}/#{filename} failed:\n" +
+          "#{e}:\n#{e.backtrace.join("\n")}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: campfire_export
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Marc Hedlund
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 0
+        - 15
+        version: 1.0.15
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 0
+        - 3
+        - 29
+        version: 0.3.29
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 7
+        - 8
+        version: 0.7.8
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 4
+        - 5
+        version: 1.4.5
+  type: :development
+  version_requirements: *id004
+description: Export transcripts and uploaded files from your 37signals' Campfire account.
+email: 
+- marc@precipice.org
+executables: 
+- campfire_export
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/campfire_export
+- campfire_export.gemspec
+- lib/campfire_export.rb
+- lib/campfire_export/timezone.rb
+- lib/campfire_export/version.rb
+homepage: https://github.com/precipice/campfire_export
+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: campfire_export
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Export transcripts and uploaded files from your 37signals' Campfire account.
+test_files: []
+