campfire_export 0.1.0 → 0.1.1

data/Rakefile

@@ -1,2 +1,6 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+rspec = RSpec::Core::RakeTask.new
+rspec.rspec_opts = '-f Fuubar --color'

data/bin/campfire_export

@@ -53,5 +53,14 @@ ensure_config_for(config, 'subdomain',
 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'))
+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

@@ -17,6 +17,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.8.7'
   
   s.add_development_dependency "bundler",  "~> 1.0.15"
+  s.add_development_dependency "fuubar",   "~> 0.0.5"
+  s.add_development_dependency "rspec",    "~> 2.6.0"
   s.add_development_dependency "tzinfo",   "~> 0.3.29"
   s.add_development_dependency "httparty", "~> 0.7.8"
   s.add_development_dependency "nokogiri", "~> 1.4.5"

data/lib/campfire_export/timezone.rb

@@ -162,7 +162,7 @@ module CampfireExport
     MAPPING.freeze
     
     def find_tzinfo(name)
-      TZInfo::TimezoneProxy.new(MAPPING[name] || name)
+      TZInfo::Timezone.get(MAPPING[name] || name)
     end
   end
 end

data/lib/campfire_export/version.rb

@@ -1,3 +1,3 @@
 module CampfireExport
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/campfire_export.rb

@@ -51,14 +51,10 @@ 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
-      "#{account_dir}/#{room.name}/" +
+      "campfire/#{Account.subdomain}/#{room.name}/" +
         "#{date.year}/#{zero_pad(date.mon)}/#{zero_pad(date.day)}"
     end
 
@@ -66,6 +62,7 @@ module CampfireExport
     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; " +
@@ -133,45 +130,28 @@ module CampfireExport
     @subdomain = ""
     @api_token = ""
     @base_url  = ""
-    @timezone  = ""
+    @timezone  = nil
     
     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"
-      
-      # Make the base directory immediately so we can start logging errors.
-      FileUtils.mkdir_p account_dir
-      
-      CampfireExport::Account.timezone  = parse_timezone
+      Account.subdomain = subdomain
+      Account.api_token = api_token
+      Account.base_url  = "https://#{subdomain}.campfirenow.com"
     end
-    
-    def parse_timezone
-      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
+
+    def find_timezone
+      settings = Nokogiri::HTML get('/account/settings').body
+      selected_zone = settings.css('select[id="account_time_zone_id"] ' +
+                                   '> option[selected="selected"]')
+      Account.timezone = 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 => e
-        log(:error, "room list download failed", e)
-      end
+
+    def rooms
+      doc = Nokogiri::XML get('/rooms.xml').body
+      doc.css('room').map {|room_xml| Room.new(room_xml) }
     end
   end
 
@@ -180,30 +160,21 @@ module CampfireExport
     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)
-
-      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
+      @id         = room_xml.css('id').text
+      @name       = room_xml.css('name').text
+      created_utc = DateTime.parse(room_xml.css('created-at').text)
+      @created_at = Account.timezone.utc_to_local(created_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.
+      find_last_update
       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 = Transcript.new(self, date)
         transcript.export
 
         # Ensure that we stay well below the 37signals API limits.
@@ -211,6 +182,20 @@ module CampfireExport
         date = date.next
       end
     end
+    
+    private
+      def find_last_update
+        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 = Account.timezone.utc_to_local(update_utc)
+        rescue Exception => e
+          log(:error, 
+              "couldn't get last update in #{room} (defaulting to today)", 
+              e)
+          @last_update = Time.now
+        end
+      end
   end
 
   class Transcript
@@ -242,7 +227,7 @@ module CampfireExport
           log(:info, "exporting transcripts\n")
           begin
             FileUtils.mkdir_p export_dir
-          rescue => e
+          rescue Exception => e
             log(:error, "Unable to create #{export_dir}", e)
           else
             export_xml
@@ -260,7 +245,7 @@ module CampfireExport
       begin
         export_file(xml, 'transcript.xml')
         verify_export('transcript.xml', xml.to_s.length)
-      rescue => e
+      rescue Exception => e
         log(:error, "XML transcript export for #{export_dir} failed", e)
       end
     end
@@ -273,7 +258,7 @@ module CampfireExport
         messages.each {|message| plaintext << message.to_s }
         export_file(plaintext, 'transcript.txt')
         verify_export('transcript.txt', plaintext.length)
-      rescue => e
+      rescue Exception => e
         log(:error, "Plaintext transcript export for #{export_dir} failed", e)
       end
     end
@@ -293,7 +278,7 @@ module CampfireExport
         
         export_file(transcript_html, 'transcript.html')
         verify_export('transcript.html', transcript_html.length)
-      rescue => e
+      rescue Exception => e
         log(:error, "HTML transcript export for #{export_dir} failed", e)
       end
     end
@@ -303,7 +288,7 @@ module CampfireExport
         if message.is_upload?
           begin
             message.upload.export
-          rescue => e
+          rescue Exception => e
             path = "#{message.upload.export_dir}/#{message.upload.filename}"
             log(:error, "Upload export for #{path} failed", e)
           end
@@ -339,7 +324,7 @@ module CampfireExport
       @@usernames          ||= {}
       @@usernames[user_id] ||= begin
         doc = Nokogiri::XML get("/users/#{user_id}.xml").body
-      rescue
+      rescue Exception => e
         "[unknown user]"
       else
         # Take the first name and last initial, if there is more than one name.

data/spec/campfire_export/account_spec.rb

@@ -0,0 +1,76 @@
+require 'campfire_export'
+require 'tzinfo'
+
+module CampfireExport
+  describe Account do
+    before(:each) do
+      @subdomain = "test-subdomain"
+      @api_token = "test-apikey"
+      @account   = Account.new(@subdomain, @api_token)
+      
+      @good_timezone = '<select id="account_time_zone_id">' +
+          '<option selected="selected" value="America/Los_Angeles">' +
+          '</option></select>'
+      @bad_timezone  = @good_timezone.gsub('America/Los_Angeles', 
+                                           'No Such Timezone')
+      @timezone_html = stub("timezone HTML block")
+      @timezone_html.stub(:body).and_return(@good_timezone)
+    end
+      
+    context "when it is created" do
+      it "sets up the account config variables" do
+        Account.subdomain.should equal(@subdomain)
+        Account.api_token.should equal(@api_token)
+        Account.base_url.should == "https://#{@subdomain}.campfirenow.com"
+      end
+    end
+    
+    context "when timezone is loaded" do
+      it "determines the user's timezone" do
+        @account.should_receive(:get).with("/account/settings"
+          ).and_return(@timezone_html)
+        @account.find_timezone
+        Account.timezone.to_s.should == "America - Los Angeles"        
+      end
+      
+      it "raises an error if it gets a bad time zone identifier" do
+        @timezone_html.stub(:body).and_return(@bad_timezone)
+        @account.stub(:get).with("/account/settings"
+          ).and_return(@timezone_html)
+        expect {
+          @account.find_timezone
+        }.to raise_error(TZInfo::InvalidTimezoneIdentifier)
+      end
+      
+      it "raises an error if it can't get the account settings at all" do
+        @account.stub(:get).with("/account/settings"
+          ).and_raise(CampfireExport::Exception.new("/account/settings", 
+            "Not Found", 404))
+        expect {
+          @account.find_timezone
+        }.to raise_error(CampfireExport::Exception)
+      end
+    end
+        
+    context "when rooms are requested" do
+      it "returns an array of rooms" do
+        room_xml = "<rooms><room>1</room><room>2</room><room>3</room></rooms>"
+        room_doc = mock("room doc")
+        room_doc.should_receive(:body).and_return(room_xml)
+        @account.should_receive(:get).with('/rooms.xml').and_return(room_doc)
+        room = mock("room")
+        Room.should_receive(:new).exactly(3).times.and_return(room)
+        @account.rooms.should have(3).items
+      end
+
+      it "raises an error if it can't get the room list" do
+        @account.stub(:get).with('/rooms.xml'
+          ).and_raise(CampfireExport::Exception.new('/rooms.xml', 
+            "Not Found", 404))
+        expect {
+          @account.rooms
+        }.to raise_error(CampfireExport::Exception)
+      end
+    end
+  end
+end

data/spec/campfire_export/room_spec.rb

@@ -0,0 +1,29 @@
+require 'campfire_export'
+require 'campfire_export/timezone'
+
+require 'nokogiri'
+
+module CampfireExport  
+  describe Room do
+    include TimeZone
+    
+    before :each do
+      @room_xml = Nokogiri::XML "<room><name>Test Room</name><id>666</id>" +
+        "<created-at>2009-11-17T19:41:38Z</created-at></room>"
+      Account.timezone = find_tzinfo("America/Los_Angeles")
+    end
+    
+    context "when it is created" do
+      it "sets up basic properties" do
+        room = Room.new(@room_xml)
+        room.name.should == "Test Room"
+        room.id.should   == "666"
+        room.created_at.should == DateTime.parse("2009-11-17T11:41:38Z")
+      end
+    end
+    
+    context "when it finds the last update" do
+      it "loads the last update from the most recent message"
+    end
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: campfire_export
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Marc Hedlund
@@ -15,17 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-09 00:00:00 Z
+date: 2011-08-04 00:00:00 -04:00
+default_executable: 
 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
@@ -34,53 +32,75 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: tzinfo
+  name: fuubar
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 41
+        segments: 
+        - 0
+        - 0
+        - 5
+        version: 0.0.5
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
         segments: 
         - 0
         - 3
         - 29
         version: 0.3.29
   type: :development
-  version_requirements: *id002
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: httparty
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
         segments: 
         - 0
         - 7
         - 8
         version: 0.7.8
   type: :development
-  version_requirements: *id003
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: nokogiri
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
         - 1
         - 4
         - 5
         version: 1.4.5
   type: :development
-  version_requirements: *id004
+  version_requirements: *id006
 description: Export transcripts and uploaded files from your 37signals' Campfire account.
 email: 
 - marc@precipice.org
@@ -101,6 +121,9 @@ files:
 - lib/campfire_export.rb
 - lib/campfire_export/timezone.rb
 - lib/campfire_export/version.rb
+- spec/campfire_export/account_spec.rb
+- spec/campfire_export/room_spec.rb
+has_rdoc: true
 homepage: https://github.com/precipice/campfire_export
 licenses: 
 - Apache 2.0
@@ -110,31 +133,28 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 57
       segments: 
       - 1
       - 8
       - 7
       version: 1.8.7
 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
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Export transcripts and uploaded files from your 37signals' Campfire account.
-test_files: []
-
+test_files: 
+- spec/campfire_export/account_spec.rb
+- spec/campfire_export/room_spec.rb