campfire_export 0.0.1 → 0.0.2

data/README.md

@@ -2,7 +2,7 @@
 
 ## Quick Start ##
 
-    $ gem install campfire_export
+    $ sudo gem install campfire_export
     $ campfire_export
 
 ## Intro ##
@@ -18,7 +18,7 @@ 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.
+repo and a [Ruby gem](http://docs.rubygems.org/read/chapter/1).
 
 ## Features ##
 
@@ -29,11 +29,13 @@ repo.
 
 ## Installing ##
 
-Ruby 1.8.7 or later is required.
+[Ruby 1.8.7](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.
 
-To install:
+Once you are set up, to install, run the following:
 
-    $ gem install campfire_export
+    $ sudo gem install campfire_export
 
 ## Configuring ##
 
@@ -44,7 +46,7 @@ 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
+    subdomain:  myco
 
     # Your Campfire API token (see "My Info" on your Campfire site).
     api_token:  abababababababababababababababababababab
@@ -82,6 +84,17 @@ 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)
+
 As mentioned above, some of the work on this was done by other people. The
 Gist I forked had contributions from:
 
@@ -89,11 +102,6 @@ Gist I forked had contributions from:
 * [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/campfire_export.gemspec

@@ -8,11 +8,13 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Marc Hedlund"]
   s.email       = ["marc@precipice.org"]
+  s.license     = "Apache 2.0"
   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.required_ruby_version = '>= 1.8.7'
   
   s.add_development_dependency "bundler",  "~> 1.0.15"
   s.add_development_dependency "tzinfo",   "~> 0.3.29"

data/lib/campfire_export/version.rb

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

data/lib/campfire_export.rb

@@ -51,10 +51,14 @@ module CampfireExport
     def zero_pad(number)
       "%02d" % number
     end
-
+    
+    def account_dir
+      "campfire/#{CampfireExport::Account.subdomain}"
+    end
+    
     # Requires that room and date be defined in the calling object.
     def export_dir
-      "campfire/#{CampfireExport::Account.subdomain}/#{room.name}/" +
+      "#{account_dir}/#{room.name}/" +
         "#{date.year}/#{zero_pad(date.mon)}/#{zero_pad(date.day)}"
     end
 
@@ -64,20 +68,15 @@ module CampfireExport
       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}).")
+          "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.")
+        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
+          file.write content
         end
       end
     end
@@ -86,7 +85,7 @@ module CampfireExport
       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")
+          "file should have been exported but did not make it to disk")
       end
       unless File.size(full_path) == expected_size
         raise CampfireExport::Exception.new(full_path, 
@@ -95,16 +94,21 @@ module CampfireExport
       end
     end
     
-    def log(level, message)
+    def log(level, message, exception=nil)
       case level
       when :error
-        puts "*** Error: #{message}"
+        short_error = ["*** Error: #{message}", exception].compact.join(": ")
+        $stderr.puts short_error
         open("campfire/export_errors.txt", 'a') do |log|
-          log.write "#{message}\n"
+          log.write short_error
+          unless exception.nil?
+            log.write %Q{\n\t#{exception.backtrace.join("\n\t")}}
+          end
+          log.write "\n"
         end
       else
         print message
-        STDOUT.flush
+        $stdout.flush
       end
     end
   end
@@ -139,14 +143,23 @@ module CampfireExport
       CampfireExport::Account.subdomain = subdomain
       CampfireExport::Account.api_token = api_token
       CampfireExport::Account.base_url  = "https://#{subdomain}.campfirenow.com"
+      
+      # Make the base directory immediately so we can start logging errors.
+      FileUtils.mkdir_p account_dir
+      
       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)
+      begin
+        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)
+      rescue => e
+        log(:error, "couldn't find timezone setting (using GMT instead)", e)
+        find_tzinfo("Etc/GMT")
+      end
     end
     
     def export(start_date=nil, end_date=nil)
@@ -156,8 +169,8 @@ module CampfireExport
           room = CampfireExport::Room.new(room_xml)
           room.export(start_date, end_date)
         end
-      rescue CampfireExport::Exception => e
-        log(:error, "room list download failed: #{e}")
+      rescue => e
+        log(:error, "room list download failed", e)
       end
     end
   end
@@ -173,10 +186,14 @@ module CampfireExport
       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)
-      
+      begin
+        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)
+      rescue => e
+        log(:error, "couldn't get last update in #{room} (defaulting to today)", e)
+        @last_update = Time.now
+      end
     end
 
     def export(start_date=nil, end_date=nil)
@@ -198,7 +215,7 @@ module CampfireExport
 
   class Transcript
     include CampfireExport::IO
-    attr_accessor :room, :date, :messages
+    attr_accessor :room, :date, :xml, :messages
     
     def initialize(room, date)
       @room     = room
@@ -212,55 +229,72 @@ module CampfireExport
     def export
       begin
         log(:info, "#{export_dir} ... ")
-        transcript_xml = Nokogiri::XML get("#{transcript_path}.xml").body
-        
-        @messages = transcript_xml.css('message').map do |message|
+        @xml = Nokogiri::XML get("#{transcript_path}.xml").body      
+      rescue CampfireExport::Exception => e
+        log(:error, "transcript export for #{export_dir} failed", e)
+      else
+        @messages = 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
+          begin
+            FileUtils.mkdir_p export_dir
+          rescue => e
+            log(:error, "Unable to create #{export_dir}", e)
+          else
+            export_xml
+            export_plaintext
+            export_html
+            export_uploads
+          end
         else
           log(:info, "no messages\n")
-        end
-      rescue CampfireExport::Exception => e
-        log(:error, "transcript export for #{export_dir} failed: #{e}")
+        end      
       end
     end
-      
+    
+    def export_xml
+      begin
+        export_file(xml, 'transcript.xml')
+        verify_export('transcript.xml', xml.to_s.length)
+      rescue => e
+        log(:error, "XML transcript export for #{export_dir} failed", e)
+      end
+    end
+
     def export_plaintext
       begin
+        date_header = date.strftime('%A, %B %e, %Y').squeeze(" ")
         plaintext = "#{CampfireExport::Account.subdomain.upcase} CAMPFIRE\n"
-        plaintext << "#{room.name}: " +
-          "#{date.strftime('%A, %B %e, %Y').gsub('  ', ' ')}\n\n"
+        plaintext << "#{room.name}: #{date_header}\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}")
+      rescue => 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 
+
+        # Make the upload links in the transcript clickable from the exported 
+        # directory layout.
+        transcript_html.gsub!(%Q{href="/room/#{room.id}/uploads/},
+                              %Q{href="uploads/})
+        # Likewise, make the image thumbnails embeddable from the exported
         # directory layout.
-        transcript_html.gsub!(%Q{<a href="/room/#{room.id}/uploads/},
-                              %Q{<a href="uploads/})
+        transcript_html.gsub!(%Q{src="/room/#{room.id}/thumb/},
+                              %Q{src="thumbs/})
+        
         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}")
+      rescue => e
+        log(:error, "HTML transcript export for #{export_dir} failed", e)
       end
     end
 
@@ -269,10 +303,9 @@ module CampfireExport
         if message.is_upload?
           begin
             message.upload.export
-          rescue CampfireExport::Exception => e
+          rescue => e
             path = "#{message.upload.export_dir}/#{message.upload.filename}"
-            log(:error, "Upload export for #{path} failed: " +
-              "#{e.backtrace.join("\n")}")
+            log(:error, "Upload export for #{path} failed", e)
           end
         end
       end
@@ -296,24 +329,19 @@ module CampfireExport
 
       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
+        @user = username(message.css('user-id').text)
       end
       
-      begin
-        @upload = CampfireExport::Upload.new(self) if is_upload?
-      rescue e
-        log(:error, "Got an exception while making an upload: #{e}")
-      end
+      @upload = CampfireExport::Upload.new(self) if is_upload?
     end
 
     def username(user_id)
       @@usernames          ||= {}
       @@usernames[user_id] ||= begin
         doc = Nokogiri::XML get("/users/#{user_id}.xml").body
+      rescue
+        "[unknown user]"
+      else
         doc.css('name').text
       end
     end
@@ -373,7 +401,7 @@ module CampfireExport
   
   class Upload
     include CampfireExport::IO
-    attr_accessor :message, :room, :date, :id, :filename, :content, :byte_size
+    attr_accessor :message, :room, :date, :id, :filename, :content_type, :byte_size
     
     def initialize(message)
       @message = message
@@ -386,10 +414,19 @@ module CampfireExport
       @deleted
     end
     
+    def is_image?
+      content_type.start_with?("image/")
+    end
+    
     def upload_dir
       "uploads/#{id}"
     end
     
+    # Image thumbnails are used to inline image uploads in HTML transcripts.
+    def thumb_dir
+      "thumbs/#{id}"
+    end
+    
     def export
       begin
         log(:info, "    #{message.body} ... ")
@@ -401,21 +438,12 @@ module CampfireExport
         # Get the upload itself and export it.
         @id = upload.css('id').text
         @byte_size = upload.css('byte-size').text.to_i
+        @content_type = upload.css('content-type').text
         @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)
+        export_content(upload_dir)
+        export_content(thumb_dir, path_component="thumb/#{id}", verify=false) if is_image?
+                
         log(:info, "ok\n")
       rescue CampfireExport::Exception => e
         if e.code == 404
@@ -423,13 +451,27 @@ module CampfireExport
           @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
+    
+    def export_content(content_dir, path_component=nil, verify=true)
+      # If the export directory name is different than the URL path component,
+      # the caller can define the path_component separately.
+      path_component ||= content_dir
+      
+      # 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.
+      content_path = "/room/#{room.id}/#{path_component}/#{CGI.escape(filename)}"        
+      content = get(content_path).body
+      FileUtils.mkdir_p(File.join(export_dir, content_dir))
+      export_file(content, "#{content_dir}/#{filename}", 'wb')
+      verify_export("#{content_dir}/#{filename}", byte_size) if verify
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: campfire_export
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Marc Hedlund
@@ -102,8 +102,8 @@ files:
 - lib/campfire_export/timezone.rb
 - lib/campfire_export/version.rb
 homepage: https://github.com/precipice/campfire_export
-licenses: []
-
+licenses: 
+- Apache 2.0
 post_install_message: 
 rdoc_options: []
 
@@ -114,10 +114,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 57
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: