eastmedia-cinder 0.2.1

data/History.txt

@@ -0,0 +1,25 @@
+=== 0.1.0 / 2008-06-16
+
+* Initial release. Provides support for single-day exporting.
+
+=== 0.2.0 / 2008-06-16
+
+* Minor release. Provides support for multi-day exporting to a specified directory. 
+
+=== 0.2.1 / 2008-06-16
+
+* Bug fix. Removed explicit require of hpricot by cinder.  Default retrieve_transcript to today.
+
+=== 0.2.2 / 2008-06-16
+
+* 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
+
+* 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
+
+* Tiny release. Provides the date column in the CSV file in universal date format mm/dd/yyyy.

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008 Matt Pelletier, Eastmedia (http://eastmedia.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+ 
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.txt
+Rakefile
+cinder.gemspec
+lib/cinder.rb
+lib/cinder/campfire.rb

data/README.txt

@@ -0,0 +1,55 @@
+= cinder - Export Campfire transcripts into CSVs
+ 
+  http://github.com/eastmedia/cinder
+ 
+* mailto:matt@eastmedia.com
+ 
+== DESCRIPTION:
+
+Cinder is a Ruby library for exporting transcripts from Campfire into CSV files.
+
+== REQUIREMENTS:
+ 
+* Ruby >= 1.8.6
+* Mechanize gem
+ 
+== INSTALL:
+
+  $ gem sources -a http://gems.github.com/ (you only need to do this once)
+  $ gem install eastmedia-cinder
+
+== SOURCE:
+
+Cinders's git repo is available on GitHub, which can be browsed at:
+
+  http://github.com/eastmedia/cinder
+
+and cloned from:
+
+  git://github.com/eastmedia/cinder.git
+
+
+From IRB or any script you write:
+  
+  require "cinder"
+
+  campfire = Cinder::Campfire.new 'mysubdomain', :ssl => true
+  campfire.login 'myemail@example.com', 'mypassword'
+  campfire.set_room 'Room Name'
+  campfire.retrieve_transcript <date>  
+  campfire.retrieve_transcripts_since <date>  
+  campfire.retrieve_transcripts_between <start_date> <end_date>
+  
+== CREDITS:
+
+Thanks to the folks behind the tinder gem.
+Initial code by Mike Bueti at Eastmedia.
+ 
+== HISTORY:
+ 
+See History.txt in this directory.
+
+== LICENSE:
+ 
+Copyright (c) 2008 Eastmedia (http://eastmedia.com)
+See MIT-LICENSE in this directory.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'hoe'
+require './lib/cinder.rb'
+
+Hoe.new('cinder', Cinder::VERSION) do |p|
+  p.summary = "Export Campfire transcripts into CSVs"
+  p.description = "Cinder is a Ruby library for exporting transcripts from Campfire into CSV files."
+  p.author = "Mike Bueti"
+  p.email = "matt@eastmedia.com"
+  p.url = 'http://github.com/eastmedia/cinder'
+  p.extra_deps << ['mechanize'] << ['colored']
+end

data/lib/cinder.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'uri'
+require 'mechanize'
+require 'csv'
+require 'colored'
+
+Dir[File.join(File.dirname(__FILE__), 'cinder/**/*.rb')].sort.each { |lib| require lib }
+
+
+module Cinder
+  VERSION = '0.3.1'
+  class Error < StandardError; end
+end

data/lib/cinder/campfire.rb

@@ -0,0 +1,182 @@
+module Cinder
+
+
+  # == Usage
+  #
+  #   campfire = Cinder::Campfire.new 'mysubdomain', :ssl => true
+  #   campfire.login 'myemail@example.com', 'mypassword'
+  #   campfire.set_room 'Room Name'
+  #   campfire.retrieve_transcript date
+  class Campfire
+    attr_reader :subdomain, :uri, :room, :directory
+    
+    # Create a new connection to a campfire account with the given +subdomain+.
+    # There's an +:ssl+ option to use SSL for the connection.
+    #
+    # campfire = Cinder::Campfire.new("my_subdomain", :ssl => true)
+    def initialize(subdomain, options = {})
+      options = { :ssl => false }.merge(options)
+      @subdomain = subdomain
+      @uri = URI.parse("#{options[:ssl] ? "https" : "http"}://#{subdomain}.campfirenow.com")
+      @room = nil
+      @directory = "."
+      @agent = WWW::Mechanize.new
+      @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
+    end
+
+    # Returns true if currently logged in
+    def logged_in?
+      @logged_in == true
+    end
+
+    # Logs out of the campfire account
+    def logout 
+      if @agent.get("#{@uri}/logout").uri == URI.parse("#{@uri.to_s}/login")
+        @logged_in = false
+      end
+    end
+
+    # Selects the room with name +room_name+ to retrieve transcripts from
+    def set_room(room_name)
+      @room = find_room_by_name(room_name)
+    end
+
+    # Set the directory where Cinder saves transcripts to +path+, 
+    def set_directory(path)
+      if File.exists? path and File.directory? path
+        @directory = path.reverse.index("/") == 0 ? path.chop : path
+      else
+        raise Error, "Invalid path name"
+      end 
+    end
+
+    # 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
+      write_transcript(transcript, "#{@directory}/#{@room[:name].gsub(" ", "_")}_#{date.strftime("%m_%d_%Y")}", date)
+    rescue WWW::Mechanize::ResponseCodeError
+    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)
+    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)
+      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)
+      while start_date <= end_date
+        retrieve_transcript(start_date)
+        start_date = start_date + 24*60*60
+      end
+    end
+
+    # Retrieve the transcripts from all rooms in this Campfire account for the +date+ passed in as a Time object
+    def retrieve_transcripts_from_all_rooms(date = Time.now)
+      preset_room = @room
+      @rooms.each do |room|
+        @room = room
+        retrieve_transcript date
+      end
+      @room = preset_room
+    end
+
+    # 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)
+      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)
+      preset_room = @room
+      @rooms.each do |room|
+        @room = room
+        retrieve_transcripts_between start_date, end_date
+      end
+      @room = preset_room
+    end
+
+    # Retrieve all of the transcripts created in all of the rooms in this Campfire account
+    def retrieve_all_transcripts_from_all_rooms
+      preset_room = @room
+      @rooms.each do |room|
+        @room = room
+        retrieve_all_transcripts
+      end
+      @room = preset_room
+    end
+
+    private
+
+    # Find all of the room names and associated urls on the provided +page+
+    def get_rooms(page)
+      page.links.collect { |link| { :name => link.to_s, :uri => link.uri } if link.uri.to_s["#{uri.to_s}/room"] }.reject { |room| room.nil? }
+    end
+
+    # Find the room name and uri hash that matches the provided +room_name+
+    def find_room_by_name(room_name)
+      @rooms.collect { |room| room if room[:name] == room_name }.reject { |room| room.nil? }.first
+    end
+    
+    # Parse the provided +transcript+ hpricot document and write the contents to the .csv file +file_name+
+    def write_transcript(transcript, file_name, date)
+      writer = CSV.open("#{file_name}.csv", 'w')
+      writer << ["Date", "Time", "User", "Message"]
+      date = date.strftime("%m/%d/%Y")
+      time = nil
+      user = nil
+      (transcript%"tbody[@id='chat']").each_child do |row|
+        if row.class == Hpricot::Elem
+          row.each_child do |cell|
+            if cell.class == Hpricot::Elem
+              if cell.classes.include? "time"
+                if cell.containers.any?
+                  time = cell.containers.first.html
+                else
+                  time = cell.html
+                end
+              elsif cell.classes.include? "person"
+                if cell.containers.any?
+                  user = cell.containers.first.html
+                else
+                  user = cell.html
+                end
+              elsif cell.classes.include? "body"
+                writer << [date, time, user, cell.containers.first.html]
+              end
+            end
+          end
+        end
+      end
+      writer.close
+    end
+
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: eastmedia-cinder
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Mike Bueti
+- Matt Pelletier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: colored
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.3
+    version: 
+description: Cinder is a Ruby library for exporting transcripts from Campfire into CSV files.
+email: matt@eastmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- MIT-LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/cinder.rb
+- lib/cinder/campfire.rb
+has_rdoc: true
+homepage: http://github.com/eastmedia/cinder
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: cinder
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Export Campfire transcripts into CSVs
+test_files: []
+