stackbuilders-campfire_export 0.4.0

data/lib/campfire_export/upload.rb

@@ -0,0 +1,78 @@
+module CampfireExport
+  class Upload
+    include CampfireExport::IO
+    attr_accessor :message, :room, :date, :id, :filename, :content_type, :byte_size, :full_url
+
+    def initialize(message)
+      @message = message
+      @room = message.room
+      @date = message.date
+      @deleted = false
+    end
+
+    def deleted?
+      @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} ... ")
+
+        # Get the upload object corresponding to this message.
+        upload_path = "/room/#{room.id}/messages/#{message.id}/upload.xml"
+        upload = Nokogiri::XML get(upload_path).body
+
+        # Get the upload itself and export it.
+        @id = upload.xpath('/upload/id').text
+        @byte_size = upload.xpath('/upload/byte-size').text.to_i
+        @content_type = upload.xpath('/upload/content-type').text
+        @filename = upload.xpath('/upload/name').text
+        @full_url = upload.xpath('/upload/full-url').text
+
+        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
+          # If the upload 404s, that should mean it was subsequently deleted.
+          @deleted = true
+          log(:info, "deleted\n")
+        else
+          raise e
+        end
+      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

data/lib/campfire_export/version.rb

@@ -0,0 +1,3 @@
+module CampfireExport
+  VERSION = "0.4.0"
+end

data/lib/campfire_export.rb

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby
+
+# Portions copyright 2011 Marc Hedlund <marc@precipice.org>.
+# Adapted from https://gist.github.com/821553 and ancestors.
+
+# 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.rb -- 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.
+
+require 'rubygems'
+
+require 'cgi'
+require 'fileutils'
+require 'httparty'
+require 'nokogiri'
+require 'retryable'
+require 'time'
+require 'yaml'
+
+module CampfireExport
+  module IO
+    MAX_RETRIES = 5
+
+    def api_url(path)
+      "#{CampfireExport::Account.base_url}#{path}"
+    end
+
+    def get(path, params = {})
+      url = api_url(path)
+
+      response = Retryable.retryable(:tries => MAX_RETRIES) do |retries, exception|
+        if retries > 0
+          msg = "Attempt ##{retries} to fetch #{path} failed, " +
+                "#{MAX_RETRIES - retries} attempts remaining"
+          log :error, msg, exception
+        end
+
+        HTTParty.get(url, :query => params, :basic_auth =>
+          {:username => CampfireExport::Account.api_token, :password => 'X'})
+      end
+
+      if response.code >= 400
+        raise CampfireExport::Exception.new(url, response.message, response.code)
+      end
+      response
+    end
+
+    def zero_pad(number)
+      "%02d" % number
+    end
+
+    # Requires that room and date be defined in the calling object.
+    def export_dir
+      "campfire/#{Account.subdomain}/#{room.name}/" +
+        "#{date.year}/#{zero_pad(date.mon)}/#{zero_pad(date.day)}"
+    end
+
+    # Requires that room_name and date be defined in the calling object.
+    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; " +
+          "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")
+      else
+        open("#{export_dir}/#{filename}", mode) do |file|
+          file.write content
+        end
+      end
+    end
+
+    def verify_export(filename, expected_size)
+      full_path = "#{export_dir}/#{filename}"
+      unless File.exists?(full_path)
+        raise CampfireExport::Exception.new(full_path,
+          "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,
+          "exported file exists but is not the right size " +
+          "(expected: #{expected_size}, actual: #{File.size(full_path)})")
+      end
+    end
+
+    def log(level, message, exception=nil)
+      case level
+      when :error
+        short_error = ["*** Error: #{message}", exception].compact.join(": ")
+        $stderr.puts short_error
+        open("campfire/export_errors.txt", 'a') do |log|
+          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
+      end
+    end
+  end
+
+end
+
+require 'campfire_export/timezone'
+
+require 'campfire_export/account'
+require 'campfire_export/exception'
+require 'campfire_export/message'
+require 'campfire_export/room'
+require 'campfire_export/transcript'
+require 'campfire_export/upload'
+require 'campfire_export/version'

data/spec/campfire_export/account_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+module CampfireExport
+  describe Account do
+    before(:each) do
+      @subdomain = "test-subdomain"
+      @api_token = "test-apikey"
+      @account   = Account.new(@subdomain, @api_token)
+
+      @good_timezone = '<?xml version="1.0" encoding="UTF-8"?>' +
+					   '<account>' +
+					   '  <time-zone>America/Los_Angeles</time-zone>' +
+					   '  <owner-id type="integer">99999</owner-id>' +
+					   '  <created-at type="datetime">2010-01-31T18:30:18Z</created-at>' +
+					   '  <storage type="integer">9999999</storage>' +
+					   '  <plan>basic</plan>' +
+					   '  <updated-at type="datetime">2010-01-31T18:31:55Z</updated-at>' +
+					   '  <subdomain>example</subdomain>' +
+					   '  <name>Example</name>' +
+					   '  <id type="integer">999999</id>' +
+					   '</account>'
+
+      @bad_timezone  = @good_timezone.gsub('America/Los_Angeles',
+                                           'No Such Timezone')
+      @account_xml = stub("Account XML")
+      @account_xml.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.xml"
+          ).and_return(@account_xml)
+        @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
+        @account_xml.stub(:body).and_return(@bad_timezone)
+        @account.stub(:get).with("/account.xml"
+          ).and_return(@account_xml)
+        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.xml"
+          ).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/message_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module CampfireExport
+  describe Message do
+    include TimeZone
+
+    before :each do
+      @messages = Nokogiri::XML  <<XML
+<messages>
+  <message>
+    <created-at type="datetime">2012-05-11T17:45:00Z</created-at>
+    <id type="integer">111</id>
+    <room-id type="integer">222</room-id>
+    <user-id type="integer" nil="true"/>
+    <body nil="true"/>
+    <type>TimestampMessage</type>
+  </message>
+  <message>
+    <created-at type="datetime">2012-05-11T17:47:20Z</created-at>
+    <id type="integer">333</id>
+    <room-id type="integer">222</room-id>
+    <user-id type="integer">555</user-id>
+    <body>This is a tweet</body>
+    <type>TweetMessage</type>
+    <tweet>
+      <id>20100487385931234</id>
+      <message>This is a tweet</message>
+      <author_username>twitter_user</author_username>
+      <author_avatar_url>avatar.jpg</author_avatar_url>
+    </tweet>
+  </message>
+  <message>
+    <created-at type="datetime">2012-05-11T17:47:23Z</created-at>
+    <id type="integer">666</id>
+    <room-id type="integer">222</room-id>
+    <user-id type="integer">555</user-id>
+    <body>Regular message</body>
+    <type>TextMessage</type>
+  </message>
+</messages>
+XML
+      Account.timezone = find_tzinfo("America/Los_Angeles")
+    end
+
+    context "when it is created" do
+      it "sets up basic properties" do
+        message = Message.new(@messages.xpath('/messages/message[3]')[0], nil, nil)
+        message.body.should == "Regular message"
+        message.id.should   == "666"
+        message.timestamp.should == "10:47 AM"
+      end
+
+      it "handles tweets correctly" do
+        message = Message.new(@messages.xpath('/messages/message[2]'), nil, nil)
+        message.body.should == "This is a tweet"
+        message.id.should   == "333"
+      end
+    end
+  end
+end

data/spec/campfire_export/room_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module CampfireExport
+  describe Room do
+    include TimeZone
+
+    before :each do
+      doc = Nokogiri::XML "<room><name>Test Room</name><id>666</id>" +
+        "<created-at>2009-11-17T19:41:38Z</created-at></room>"
+      @room_xml = doc.xpath('/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

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+
+require 'campfire_export'
+require 'tzinfo'

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: stackbuilders-campfire_export
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Marc Hedlund
+- Justin Leitgeb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+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.
+email:
+- marc@precipice.org
+- justin@stackbuilders.com
+executables:
+- campfire_export
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/campfire_export
+- campfire_export.gemspec
+- lib/campfire_export.rb
+- lib/campfire_export/account.rb
+- lib/campfire_export/exception.rb
+- lib/campfire_export/message.rb
+- lib/campfire_export/room.rb
+- lib/campfire_export/timezone.rb
+- lib/campfire_export/transcript.rb
+- lib/campfire_export/upload.rb
+- lib/campfire_export/version.rb
+- spec/campfire_export/account_spec.rb
+- spec/campfire_export/message_spec.rb
+- spec/campfire_export/room_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/stackbuilders/campfire_export
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: campfire_export
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Export transcripts and uploaded files from your 37signals' Campfire account.
+test_files:
+- spec/campfire_export/account_spec.rb
+- spec/campfire_export/message_spec.rb
+- spec/campfire_export/room_spec.rb
+- spec/spec_helper.rb