eastmedia-cinder 0.2.1 → 0.4.0

data/History.txt

@@ -2,24 +2,32 @@
 
 * Initial release. Provides support for single-day exporting.
 
-=== 0.2.0 / 2008-06-16
+=== 0.2.0 / 2008-06-17
 
 * Minor release. Provides support for multi-day exporting to a specified directory. 
 
-=== 0.2.1 / 2008-06-16
+=== 0.2.1 / 2008-06-17
 
 * Bug fix. Removed explicit require of hpricot by cinder.  Default retrieve_transcript to today.
 
-=== 0.2.2 / 2008-06-16
+=== 0.2.2 / 2008-06-17
 
 * Tiny release. Provides support for retrieving all transcripts in a single room.
 * Bug fix. Fixed logic problem that was excluding the current date when calling retrieve_transcripts_since.
 
-=== 0.3.0 / 2008-06-16
+=== 0.3.0 / 2008-06-17
 
 * Minor release. Provides support form single, multi, and all-day exporting to a specific directory across all rooms in a Campfire account
 * Bug fix. Replaces spaces in room names with underscores during file save.
 
-=== 0.3.1 / 2008-06-16
+=== 0.3.1 / 2008-06-17
 
 * Tiny release. Provides the date column in the CSV file in universal date format mm/dd/yyyy.
+
+=== 0.4.0 / 2008-06-17
+
+* Minor release. Provides colored output to the screen as transcripts are retrieved.
+
+=== 0.4.1 / 2008-06-18
+
+* Tiny release. Provides a user agent alias of "Mac FireFox" to Campfire when scraping.

data/Manifest.txt

@@ -6,3 +6,5 @@ Rakefile
 cinder.gemspec
 lib/cinder.rb
 lib/cinder/campfire.rb
+spec/cinder/campfire_spec.rb
+spec/spec_helper.rb

data/README.txt

@@ -12,7 +12,8 @@ Cinder is a Ruby library for exporting transcripts from Campfire into CSV files.
  
 * Ruby >= 1.8.6
 * Mechanize gem
- 
+* Colored gem
+
 == INSTALL:
 
   $ gem sources -a http://gems.github.com/ (you only need to do this once)

data/lib/cinder.rb

@@ -8,6 +8,6 @@ Dir[File.join(File.dirname(__FILE__), 'cinder/**/*.rb')].sort.each { |lib| requi
 
 
 module Cinder
-  VERSION = '0.3.1'
+  VERSION = '0.4.1'
   class Error < StandardError; end
 end

data/lib/cinder/campfire.rb

@@ -6,9 +6,18 @@ module Cinder
   #   campfire = Cinder::Campfire.new 'mysubdomain', :ssl => true
   #   campfire.login 'myemail@example.com', 'mypassword'
   #   campfire.set_room 'Room Name'
+  #   campfire.set_directory 'dir/path'
   #   campfire.retrieve_transcript date
+  #   campfire.retrieve_transcripts_since date
+  #   campfire.retrieve_transcripts_between start_date, end_date
+  #   campfire.retrieve_all_transcripts
+  #   campfire.retrieve_transcripts_from_all_rooms date
+  #   campfire.retrieve_transcripts_from_all_rooms_since date
+  #   campfire.retrieve_transcripts_from_all_rooms_between start_date, end_date
+  #   campfire.retrieve_all_transcripts_from_all_rooms
+  #   campfire.logout
   class Campfire
-    attr_reader :subdomain, :uri, :room, :directory
+    attr_reader :subdomain, :uri, :room, :directory, :agent
     
     # Create a new connection to a campfire account with the given +subdomain+.
     # There's an +:ssl+ option to use SSL for the connection.
@@ -21,17 +30,23 @@ module Cinder
       @room = nil
       @directory = "."
       @agent = WWW::Mechanize.new
+      @agent.user_agent_alias = "Mac FireFox"
       @logged_in = false
     end
 
     # Log in to campfire using your +email+ and +password+
     def login(email, password)
-      unless @agent.post("#{@uri.to_s}/login", "email_address" => email, "password" => password).uri == @uri
-        raise Error, "Campfire login failed"
-      end
-      @lobby = @agent.page
-      @rooms = get_rooms(@lobby)
-      @logged_in = true
+       unless login_with_email_and_password(email, password).uri == @uri
+         raise Error, "Campfire login failed"
+       end
+       @lobby = agent.page
+       @rooms = get_rooms(@lobby)
+       @logged_in = true
+    end
+
+    # Post a login request to the Campfire servers with the provided +email_address+ and +password+
+    def login_with_email_and_password(email_address, password)
+      agent.post("#{@uri.to_s}/login", "email_address" => email_address, "password" => password)
     end
 
     # Returns true if currently logged in
@@ -41,7 +56,7 @@ module Cinder
 
     # Logs out of the campfire account
     def logout 
-      if @agent.get("#{@uri}/logout").uri == URI.parse("#{@uri.to_s}/login")
+      if @agent.get("#{@uri.to_s}/logout").uri == URI.parse("#{@uri.to_s}/login")
         @logged_in = false
       end
     end
@@ -63,35 +78,28 @@ module Cinder
     # Retrieve the transcript for the current room and +date+, passed in as a Time object, and store it locally as a csv file in the preselected directory, or the current location if no directory was set
     def retrieve_transcript(date = Time.now)
       transcript_uri = URI.parse("#{@room[:uri].to_s}/transcript/#{date.strftime("%Y/%m/%d")}")
-      transcript_page = @agent.get(transcript_uri.to_s)
-      transcript = transcript_page.parser
+      transcript = get_transcript(transcript_uri)
       write_transcript(transcript, "#{@directory}/#{@room[:name].gsub(" ", "_")}_#{date.strftime("%m_%d_%Y")}", date)
+      puts "Transcript retrieved from room '#{@room[:name]}' for #{date.strftime("%m/%d/%Y")}".green
     rescue WWW::Mechanize::ResponseCodeError
+      puts "No transcript found in room '#{@room[:name]}' for #{date.strftime("%m/%d/%Y")}".red
     end
 
     # Retrieve all of the transcripts for the current room
     def retrieve_all_transcripts
-      list_page = @agent.get("#{@uri}/files+transcripts?room_id=#{@room[:uri].to_s.split("/").last}")
-      while list_page.links.detect { |link| link.text == "Older" }
-        list_page.links.detect { |link| link.text == "Older" }.click
-        list_page = @agent.page
-      end
-      links = list_page.links
-      links.pop
-      earliest = links.pop.uri.to_s.split("/")
-      day = earliest.pop
-      month = earliest.pop
-      year = earliest.pop
-      retrieve_transcripts_since Time.mktime(year.to_i, month.to_i, day.to_i)
+      puts "Retrieving all transcripts from '#{@room[:name]}'. This could take some time.".yellow
+      retrieve_transcripts_since find_start_date(@room)
     end
 
     # Retrieve the transcripts for the current room from the +date+ passed in as a Time object, up until and including the current date
     def retrieve_transcripts_since(date)
+      puts "Retrieving transcripts from '#{@room[:name]}' since #{date.strftime("%m/%d/%Y")}.".blue
       retrieve_transcripts_between(date, Time.now)
     end
     
     # Retrieve the transcripts for the current room created between the +start_date+ and +end_date+ passed in as a Time objects
     def retrieve_transcripts_between(start_date, end_date)
+      puts "Retrieving transcripts from '#{@room[:name]}' between #{start_date.strftime("%m/%d/%Y")} and #{end_date.strftime("%m/%d/%Y")}.".blue
       while start_date <= end_date
         retrieve_transcript(start_date)
         start_date = start_date + 24*60*60
@@ -110,11 +118,13 @@ module Cinder
 
     # Retrieve the transcripts from all rooms in this Campfire account created since the +date+ passed in as a Time object
     def retrieve_transcripts_from_all_rooms_since(date)
+      puts "Retrieving transcripts from all rooms in #{@uri.to_s} since #{date.strftime("%m/%d/%Y")}.".yellow
       retrieve_transcripts_from_all_rooms_between date, Time.now
     end
 
     # Retrieve the transcripts from all rooms in this Campfire account created between the +start_date+ and the +end_date+ passed in as a Time objects
     def retrieve_transcripts_from_all_rooms_between(start_date, end_date)
+      puts "Retrieving transcripts from all rooms in #{@uri.to_s} between #{start_date.strftime("%m/%d/%Y")} and #{end_date.strftime("%m/%d/%Y")}.".yellow
       preset_room = @room
       @rooms.each do |room|
         @room = room
@@ -125,6 +135,7 @@ module Cinder
 
     # Retrieve all of the transcripts created in all of the rooms in this Campfire account
     def retrieve_all_transcripts_from_all_rooms
+      puts "Retrieving all transcripts from #{@uri.to_s}. This could take some time.".yellow 
       preset_room = @room
       @rooms.each do |room|
         @room = room
@@ -144,6 +155,27 @@ module Cinder
     def find_room_by_name(room_name)
       @rooms.collect { |room| room if room[:name] == room_name }.reject { |room| room.nil? }.first
     end
+
+    # Retrieve the hpricot document representing the Campfire transcript at the provided +uri+
+    def get_transcript(uri)
+      @agent.get(uri.to_s).parser
+    end
+
+    # Find the first date that transcripts exist for the provided +room+
+    def find_start_date(room)
+      list_page = @agent.get("#{@uri}/files+transcripts?room_id=#{room[:uri].to_s.split("/").last}")
+      while list_page.links.detect { |link| link.text == "Older" }
+        list_page.links.detect { |link| link.text == "Older" }.click
+        list_page = @agent.page
+      end
+      links = list_page.links
+      links.pop
+      earliest = links.pop.uri.to_s.split("/")
+      day = earliest.pop
+      month = earliest.pop
+      year = earliest.pop
+      Time.mktime(year.to_i, month.to_i, day.to_i)
+    end
     
     # Parse the provided +transcript+ hpricot document and write the contents to the .csv file +file_name+
     def write_transcript(transcript, file_name, date)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eastmedia-cinder
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Mike Bueti