stackbuilders-campfire_export 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 189d237398fa8a8627af4aa60e4b904175053125
+  data.tar.gz: 015646fd1de14d6bb230143653347da65b564ae0
+SHA512:
+  metadata.gz: f7e312835ff6b746db2cd8a156d9eb229cd1b0476b436fae5f0ddcedddaebd4ae60c124320822a9eee7cf4d76c0f6a09bb27ac6f4a736672a6db7415bdada31a
+  data.tar.gz: a43541ddc5e78f6daa9485d014eaac8f8f0bd38043902fc60245ea98758178eebe43c9cf16bd9d4b235ddbc49d39c66666167e292a9941a7168897b496c0e25b

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/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2

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,114 @@
+[![Build Status](https://travis-ci.org/stackbuilders/campfire_export.png)](https://travis-ci.org/stackbuilders/campfire_export)
+
+# campfire_export #
+
+## Quick Start ##
+
+    $ sudo gem install stackbuilders-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 and a [Ruby gem](http://docs.rubygems.org/read/chapter/1).
+
+## 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.9.3](http://www.ruby-lang.org/en/downloads/) or later is required.
+[RubyGems](https://rubygems.org/pages/download) is also required -- I'd
+recommend having the latest version of RubyGems installed before starting.
+
+Once you are set up, to install, run the following:
+
+    $ sudo 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:  myco
+
+    # 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 ##
+
+First, thanks a ton to [Jeffrey Hardy](https://github.com/packagethief) from
+37signals, who helped me track down some bugs in my code as well as some
+confusion in what I was getting back from Campfire. His patient and determined
+help made it possible to get this working. Thanks, Jeff!
+
+Also, thanks much for all the help, comments and contributions:
+
+* [Brad Greenlee](https://github.com/bgreenlee)
+* [Andre Arko](https://github.com/indirect)
+* [Brian Donovan](https://github.com/eventualbuddha)
+* [Andrew Wong](https://github.com/andrewwong1221)
+* [Junya Ogura](https://github.com/juno)
+* [Chase Lee](https://github.com/chaselee)
+* [Alex Hofsteede](https://github.com/alex-hofsteede)
+* [Justin Leitgeb](https://github.com/jsl)
+
+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)
+
+Thanks, all!
+
+- Marc Hedlund, marc@precipice.org

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/campfire_export

@@ -0,0 +1,66 @@
+#!/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)")
+
+begin
+  account = CampfireExport::Account.new(config['subdomain'],
+                                        config['api_token'])
+  account.find_timezone
+  account.rooms.each do |room|
+    room.export(config_date(config, 'start_date'),
+                config_date(config, 'end_date'))
+  end
+rescue => e
+  puts "Unable to export account: #{e}"
+end

data/campfire_export.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "campfire_export/version"
+
+Gem::Specification.new do |s|
+  s.name        = "stackbuilders-campfire_export"
+  s.version     = CampfireExport::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Marc Hedlund", "Justin Leitgeb"]
+  s.email       = ["marc@precipice.org", "justin@stackbuilders.com"]
+  s.license     = "Apache 2.0"
+  s.homepage    = "https://github.com/stackbuilders/campfire_export"
+  s.summary     = "Export transcripts and uploaded files from your 37signals' Campfire account."
+
+  s.description = %{Exports content from all rooms in a
+    37signals Campfire account. Creates a directory containing transcripts
+    and content uploaded to each one of your rooms. Can be configured to
+    recognize start and end date of content export.}
+
+  s.rubyforge_project = "campfire_export"
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_development_dependency "bundler",  "~> 1"
+  s.add_development_dependency "rake", "~> 10"
+  s.add_development_dependency "rspec",    "~> 2.6"
+
+  s.add_dependency "tzinfo",   "~> 1.2"
+  s.add_dependency "httparty", "~> 0.13"
+  s.add_dependency "nokogiri", "~> 1.6"
+  s.add_dependency "retryable", "~> 2.0"
+
+  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