scribd_fu 2.0.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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/README.textile

@@ -0,0 +1,68 @@
+h1. Scribd_fu
+
+A Ruby on Rails plugin that streamlines interaction with Scribd.com's iPaper service, and works along side of either Attachment_fu or Paperclip
+
+h1. Big Changes! v2.0 OMGZ!
+
+Please make sure to read below if you're using an older version of ScribdFu. Pretty much everything has changed. Don't fret, it's now easier and cleaner. ScribdFu has been taken out into the backyard and given a thorough scrubbing. It's now lean, mean, fully tested, and works beautifully with Attachment_fu, Paperclip, and Amazon's S3 service.
+
+h2. What it does
+
+Scribd_fu hides out in the shadows like a document converting ninja, just waiting to process your data into a convenient Flash format (like YouTube) with the help of the black majick of Scribd.com. Imagine embedding documents inline with your web UI — no downloading, no required programs on the client side (except for Flash) to view your data. It's pretty damned cool, and free to boot!
+
+h2. Requirements
+
+Scribd_fu requires the rscribd gem via @sudo gem install rscribd@ (along with either the Attachment_fu plugin or the Paperclip gem)
+
+h2. How to Install
+
+h3. ScribdFu requires a base plugin
+
+ScribdFu is awesome, but it needs help from either "Attachment_fu":http://github.com/technoweenie/attachment_fu/tree/master or "Paperclip":http://github.com/thoughtbot/paperclip/tree/master
+
+h3. Install ScribdFu
+
+<pre>sudo gem install scribd_fu --source 'http://gemcutter.com'</pre>
+
+h3. Add ScribdFu to your environment.rb
+
+<pre>config.gem 'scribd_fu', :source => 'http://gemcutter.com'</pre>
+
+h2. How to Use
+
+* Sign up for "Scribd.com's API access":http://www.scribd.com/developers/signup_api (it's totally free)
+
+* Run @./script/generate scribd_fu@ and fill out @config/scribd_fu.yml@ file with your Scribd account info.
+
+* If you're using AttachmentFu, add @has_ipaper_and_uses 'AttachmentFu'@ to your model that uses ScribdFu
+
+* If you're using Paperclip, add @has_ipaper_and_uses 'Paperclip'@ to your model that uses ScribdFu
+
+* Add the following fields into a new migration for the target model:
+
+<pre>
+  t.integer :ipaper_id
+  t.string  :ipaper_access_key
+</pre>
+
+Scribd_fu will use these to track Scribd-related information.
+
+Now, when you upload a file to that model, Scribd_fu will automatically handle the Scribd side of things for you. Files are uploaded to Scribd after the model is saved. No muss, no fuss. Scribd's conversion of your document is usally quite fast, but if you want a contingency plan, the @conversion_processing?@, @conversion_complete?@, @conversion_successful?@, and @conversion_error?@ instance methods can be used to determine the conversion status of the document.
+
+h2. Viewing the iPaper Document
+
+Just add @<%= document.display_ipaper %>@ into your view (where @document@ is an object of your ScribdFu model). That's it!
+
+h2. Access
+
+You can set the access level on all documents by setting the @access@ key in the scribd_fu.yml file to either 'private' or 'public'. ScribdFu assumes that you'd like to keep your documents private.
+
+h2. Help
+
+Add a ticket to "ScribdFu's Lighthouse Account":http://mdarby.lighthouseapp.com/projects/28697-scribdfu/overview
+
+h2. About the Author
+
+My name is "Matt Darby.":http://blog.matt-darby.com I’m an IT Manager and pro-web-dev at for "Dynamix Engineering":http://dynamix-ltd.com and hold a Master’s Degree in Computer Science from "Franklin University":http://www.franklin.edu in sunny "Columbus, OH.":http://en.wikipedia.org/wiki/Columbus,_Ohio
+
+Feel free to check out my "blog":http://blog.matt-darby.com or "recommend me":http://www.workingwithrails.com/person/10908-matt-darby

data/generators/scribd_fu/scribd_fu_generator.rb

@@ -0,0 +1,7 @@
+class ScribdFuGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file 'scribd_fu.yml', 'config/scribd_fu.yml', :collision => :skip
+    end
+  end
+end

data/generators/scribd_fu/templates/scribd_fu.yml

@@ -0,0 +1,7 @@
+#Scribd Account Info
+
+key: 
+secret: 
+user: 
+password: 
+access: 

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "scribd_fu")

data/lib/scribd_fu.rb

@@ -0,0 +1,255 @@
+module ScribdFu
+
+  ConfigPath = "#{RAILS_ROOT}/config/scribd_fu.yml".freeze
+
+  # A list of content types supported by iPaper.
+  ContentTypes = [
+    'application/pdf',
+    'application/msword',
+    'application/mspowerpoint',
+    'application/vnd.ms-powerpoint',
+    'application/excel',
+    'application/vnd.ms-excel',
+    'application/postscript',
+    'text/plain',
+    'text/rtf',
+    'application/rtf',
+    'application/vnd.oasis.opendocument.text',
+    'application/vnd.oasis.opendocument.presentation',
+    'application/vnd.oasis.opendocument.spreadsheet',
+    'application/vnd.sun.xml.writer',
+    'application/vnd.sun.xml.impress',
+    'application/vnd.sun.xml.calc',
+    'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+    'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
+    'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+    'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
+    'application/vnd.openxmlformats-officedocument.presentationml.template',
+    'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+    'application/vnd.openxmlformats-officedocument.wordprocessingml.template'
+  ]
+
+  # RegExp that matches AWS S3 URLs
+  S3 = /^https?:\/\/s3.amazonaws.com/
+
+  # Available parameters for the JS API
+  # http://www.scribd.com/publisher/api/api?method_name=Javascript+API
+  Available_JS_Params = [ :height, :width, :page, :my_user_id, :search_query,
+                          :jsapi_version, :disable_related_docs, :mode, :auto_size ]
+
+  class ScribdFuError < StandardError #:nodoc:
+  end
+
+  class ScribdFuUploadError < ScribdFuError #:nodoc:
+  end
+
+
+  class << self
+
+    def included(base) #:nodoc:
+      base.extend ClassMethods
+    end
+
+    # Login, store, and return a handle to the Scribd user account
+    def scribd_user
+      begin
+        # Ensure we can login to Scribd, and get a handle on the account
+        Scribd::API.instance.key    = config[:key]
+        Scribd::API.instance.secret = config[:secret]
+        @scribd_user = Scribd::User.login(config[:user], config[:password])
+      rescue
+        raise ScribdFuError, "Your Scribd credentials are incorrect"
+      end
+    end
+
+    # Upload a file to Scribd
+    def upload(obj, file_path)
+      begin
+        res = scribd_user.upload(:file => escape(file_path), :access => access_level)
+        obj.update_attributes({:ipaper_id => res.doc_id, :ipaper_access_key => res.access_key})
+      rescue
+        raise ScribdFuUploadError, "Sorry, but #{obj.class} ##{obj.id} could not be uploaded to Scribd"
+      end
+    end
+
+    # Delete an iPaper document
+    def destroy(document)
+      document.destroy
+    end
+
+    # Read, store, and return the ScribdFu config file's contents
+    def config
+      raise ScribdFuError, "#{ConfigPath} does not exist" unless File.file?(ConfigPath)
+
+      # Load the config file and strip any whitespace from the values
+      @config ||= YAML.load_file(ConfigPath).each_pair{|k,v| {k=>v.to_s.strip}}.symbolize_keys!
+    end
+
+    # Get the preferred access level for iPaper documents
+    def access_level
+      config[:access] || 'private'
+    end
+
+    # Load, store, and return the associated iPaper document
+    def load_ipaper_document(id)
+      # Yes, catch-all rescues are bad, but the end rescue
+      # should return nil, so laziness FTW.
+      scribd_user.find_document(id) rescue nil
+    end
+
+    # Replace spaces with '%20' (needed by Paperclip models).
+    def escape(str)
+      str.gsub(' ', '%20')
+    end
+
+  end
+
+  module ClassMethods
+
+    # Load and inject ScribdFu goodies
+    def has_ipaper_and_uses(str)
+      check_environment
+      load_base_plugin(str)
+
+      include InstanceMethods
+
+      after_save :upload_to_scribd # This *MUST* be an after_save
+      before_destroy :destroy_ipaper_document
+    end
+
+    private
+
+      # Configure ScribdFu for this particular environment
+      def check_environment
+        load_rscribd
+        check_config
+        check_fields
+      end
+
+      def check_config
+        ScribdFu::config
+      end
+
+      # Load the rscribd gem
+      def load_rscribd
+        begin
+          require 'rscribd'
+        rescue LoadError
+          raise ScribdFuError, 'Please install the rscribd gem'
+        end
+      end
+
+      # Load Attachment_Fu specific methods and files
+      def load_attachment_fu
+        require 'scribd_fu/attachment_fu'
+        include ScribdFu::AttachmentFu::InstanceMethods
+      end
+
+      # Load Paperclip specific methods and files
+      def load_paperclip
+        require 'scribd_fu/paperclip'
+        include ScribdFu::Paperclip::InstanceMethods
+      end
+
+      # Ensure ScribdFu-centric attributes exist
+      def check_fields
+        fields = %w{ipaper_id ipaper_access_key}.inject([]){|stack, f| stack << "#{name}##{f}" unless column_names.include?(f); stack}
+        raise ScribdFuError, "These fields are missing: #{fields.to_sentence}" if fields.size > 0
+      end
+
+      # Load either AttachmentFu or Paperclip-specific methods
+      def load_base_plugin(str)
+        if str == 'AttachmentFu'
+          load_attachment_fu
+        elsif str == 'Paperclip'
+          load_paperclip
+        else
+          raise ScribdFuError, "Sorry, only Attachment_fu and Paperclip are supported."
+        end
+      end
+
+  end
+
+  module InstanceMethods
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    # Upload the associated file to Scribd for iPaper conversion
+    # This is called +after_save+ and cannot be called earlier,
+    # so don't get any ideas.
+    def upload_to_scribd
+      ScribdFu::upload(self, file_path) if scribdable?
+    end
+
+    # Checks whether the associated file is convertable to iPaper
+    def scribdable?
+      ContentTypes.include?(get_content_type) && ipaper_id.blank?
+    end
+
+    # Responds true if the conversion is converting
+    def conversion_processing?
+      !(conversion_complete? || conversion_successful? || conversion_error?)
+    end
+
+    # Responds true if the conversion is complete -- note that this gives no
+    # indication as to whether the conversion had an error or was succesful,
+    # just that the conversion completed.
+    def conversion_complete?
+      ipaper_document && ipaper_document.conversion_status != 'PROCESSING'
+    end
+
+    # Responds true if the document has been converted.
+    def conversion_successful?
+      ipaper_document && ipaper_document.conversion_status =~ /^DISPLAYABLE|DONE$/
+    end
+
+    # Responds true if there was a conversion error while converting to iPaper.
+    def conversion_error?
+      ipaper_document && ipaper_document.conversion_status == 'ERROR'
+    end
+
+    # Responds the Scribd::Document associated with this model, or nil if it does not exist.
+    def ipaper_document
+      @document ||= ScribdFu::load_ipaper_document(ipaper_id)
+    end
+
+    # Destroys the scribd document for this record. This is called +before_destroy+
+    def destroy_ipaper_document
+      ScribdFu::destroy(ipaper_document) if ipaper_document
+    end
+
+    # Display the iPaper document in a view
+    def display_ipaper(options = {})
+      <<-END
+        <script type="text/javascript" src="http://www.scribd.com/javascripts/view.js"></script>
+        <div id="embedded_flash">#{options.delete(:alt)}</div>
+        <script type="text/javascript">
+          var scribd_doc = scribd.Document.getDoc(#{ipaper_id}, '#{ipaper_access_key}');
+          #{js_params(options)}
+          scribd_doc.write("embedded_flash");
+        </script>
+      END
+    end
+
+
+    private
+
+      # Check and collect any Javascript params that might have been passed in
+      def js_params(options)
+        opt = []
+
+        options.each_pair do |k, v|
+          opt << "scribd_doc.addParam('#{k}', '#{v}');" if Available_JS_Params.include?(k)
+        end
+
+        opt.compact.join("\n")
+      end
+
+  end
+
+end
+
+# Let's do this.
+ActiveRecord::Base.send(:include, ScribdFu) if Object.const_defined?("ActiveRecord")

data/lib/scribd_fu/attachment_fu.rb

@@ -0,0 +1,30 @@
+module ScribdFu
+  module AttachmentFu
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Returns a URL for a thumbnail for this model's attachment.
+      def thumbnail_url
+        (ipaper_document && ipaper_document.thumbnail_url) || public_filename(:thumb)
+      end
+
+      # Returns the content type for this model's attachment.
+      def get_content_type
+        self.content_type
+      end
+
+      # Yields the correct path to the file, either the local filename or the S3 URL.
+      def file_path
+        public_filename =~ ScribdFu::S3 ? public_filename : "#{RAILS_ROOT}/public#{public_filename}"
+      end
+    end
+
+  end
+end

data/lib/scribd_fu/paperclip.rb

@@ -0,0 +1,51 @@
+module ScribdFu
+  module Paperclip
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Find the content type of the associated file
+      def get_content_type
+        self.send("#{prefix}_content_type")
+      end
+
+      # Returns a URL for a thumbnail for the attached file object.
+      def thumbnail_url
+        begin
+          (ipaper_document && ipaper_document.thumbnail_url) || attached_file.url(:thumb)
+        rescue
+          raise ScribdFu::ScribdFuError, "The thumbnail doesn't exist."
+        end
+      end
+
+      # Returns the full filename for the given attribute. If the file is
+      # stored on S3, this is a full S3 URI, while it is a full path to the
+      # local file if the file is stored locally.
+      def file_path
+        attached_file.url =~ ScribdFu::S3 ? attached_file.url : attached_file.path
+      end
+
+
+      private
+
+        # Figure out what Paperclip is calling the attached file object
+        # ie. has_attached_file :attachment => "attachment"
+        def prefix
+          @prefix ||= self.class.column_names.detect{|c| c.ends_with?("_file_name")}.gsub("_file_name", '')
+        end
+
+        # Return the attached file object
+        def attached_file
+          @file ||= self.send(prefix)
+        end
+
+    end
+  end
+
+end

data/scribd_fu.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name     = "scribd_fu"
+  s.version  = "2.0.4"
+  s.date     = "2009-04-12"
+  s.summary  = "Quick and easy interactions with Scribd's iPaper service"
+  s.email    = "matt@matt-darby.com"
+  s.homepage = "http://github.com/mdarby/scribd_fu/tree/master"
+  s.description = "A Rails plugin that streamlines interactions with the Scribd service"
+  s.has_rdoc = false
+  s.authors  = ["Matt Darby"]
+  s.files    = [
+    'MIT-LICENSE',
+    'README.textile',
+    'generators/scribd_fu',
+    'generators/scribd_fu/scribd_fu_generator.rb',
+    'generators/scribd_fu/templates',
+    'generators/scribd_fu/templates/scribd_fu.yml',
+    'init.rb',
+    'lib/scribd_fu',
+    'lib/scribd_fu/attachment_fu.rb',
+    'lib/scribd_fu/paperclip.rb',
+    'lib/scribd_fu.rb',
+    'scribd_fu.gemspec',
+    'spec/database.yml',
+    'spec/scribd_fu.yml',
+    'spec/scribd_fu_spec.rb',
+    'spec/spec_helper.rb'
+  ]
+  s.add_dependency 'rscribd'
+end

data/spec/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/spec/scribd_fu.yml

@@ -0,0 +1,7 @@
+#Scribd Account Info
+
+key: 'key'
+secret: 'secret'
+user: 'user'
+password: 'password'
+access: 'access'

data/spec/scribd_fu_spec.rb

@@ -0,0 +1,308 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe "ScribdFu" do
+
+  describe "with incorrect Scribd credentials" do
+    before do
+      Scribd::User.stub!(:login).and_raise(Scribd::ResponseError)
+    end
+
+    it "should throw an error" do
+      lambda { ScribdFu::scribd_user }.should raise_error(ScribdFu::ScribdFuError)
+    end
+  end
+
+  describe "that is missing a config file" do
+    before do
+      File.should_receive(:file?).with("#{RAILS_ROOT}/config/scribd_fu.yml").and_return(false)
+    end
+
+    it "should raise an error" do
+      lambda { ScribdFu::config }.should raise_error(ScribdFu::ScribdFuError)
+    end
+
+  end
+
+end
+
+describe "An AttachmentFu model" do
+  before do
+    rebuild_model
+  end
+
+  describe "that is configured for ScribdFu" do
+    before do
+      config = YAML.load_file("spec/scribd_fu.yml")
+      File.stub!(:file?).with(ScribdFu::ConfigPath).and_return(true)
+      YAML.stub!(:load_file).and_return(config)
+
+      Document.class_eval do
+        has_ipaper_and_uses 'AttachmentFu'
+      end
+
+      @document = Document.new
+    end
+
+    describe "with correct credentials" do
+      before do
+        @scribd_user = mock("scribd_user")
+        Scribd::User.stub!(:login).and_return(@scribd_user)
+      end
+
+      describe "that was just created" do
+        before do
+          @document.attributes = {:ipaper_id => nil, :ipaper_access_key => nil, :content_type => "application/pdf"}
+          @document.stub!(:public_filename => "/path/to/somewhere")
+        end
+
+        describe "and is scribdable?" do
+          before do
+            @document.stub!(:update_attributes)
+          end
+
+          describe "and has spaces in the filename" do
+            it "should sanitize the file path" do
+              res = mock('response', :doc_id => 1, :access_key => "ASDF")
+              @scribd_user.should_receive(:upload).with(:file => "some%20filename%20with%20spaces", :access => 'access').and_return(res)
+              ScribdFu::upload(@document, "some filename with spaces")
+            end
+            
+          end
+
+          describe "and uploading to Scribd succeeded" do
+            before do
+              @scribd_response = mock('scribd_response', :doc_id => "doc_id", :access_key => "access_key")
+              @scribd_user.should_receive(:upload).and_return(@scribd_response)
+            end
+
+            it "should update the Scribd-centric attributes" do
+              @document.should_receive(:update_attributes).with({:ipaper_id => 'doc_id', :ipaper_access_key => 'access_key'})
+              @document.save
+            end
+
+          end
+
+          describe "and uploading to Scribd failed" do
+            before do
+              @scribd_user.stub!(:upload).and_raise(StandardError)
+            end
+
+            it "should throw an error" do
+              lambda { ScribdFu::upload(@document, 'private') }.should raise_error(ScribdFu::ScribdFuUploadError)
+            end
+
+          end
+
+        end
+
+        describe "and is not scribdable?" do
+          before do
+            @document.stub!(:scribdable? => false)
+          end
+
+          it "should not upload to Scribd" do
+            ScribdFu.should_not_receive(:upload)
+            @document.save
+          end
+
+          it "should not error out when deleted" do
+            lambda {@document.destroy}.should_not raise_error(ScribdFu::ScribdFuError)
+          end
+
+        end
+
+      end
+
+      describe "that was just updated" do
+        before do
+          @document.stub!(:ipaper_id => 'doc_id')
+        end
+
+        it "should not reupload to Scribd" do
+          @scribd_user.should_not_receive(:upload)
+          @document.save
+        end
+
+      end
+
+      describe "that is about to be destroyed" do
+        before do
+          @ipaper_document = mock("ipaper_document")
+          ScribdFu.stub!(:load_ipaper_document).and_return(@ipaper_document)
+        end
+
+        it "should destroy the ipaper document" do
+          ScribdFu.should_receive(:destroy).with(@ipaper_document)
+          @document.destroy
+        end
+
+      end
+
+    end
+
+  end
+
+end
+
+describe "A Paperclip model" do
+  before do
+    rebuild_model
+  end
+
+  describe "that is configured for ScribdFu" do
+    before do
+      config = YAML.load_file("spec/scribd_fu.yml")
+      File.stub!(:file?).with(ScribdFu::ConfigPath).and_return(true)
+      YAML.stub!(:load_file).and_return(config)
+
+      Attachment.class_eval do
+        has_ipaper_and_uses 'Paperclip'
+      end
+
+      @attached_file = mock("attached_file", :url => "http://test.com/path/to/somewhere", :path => "/path/to/somewhere")
+
+      @attachment = Attachment.new
+      @attachment.stub!(:prefix).and_return("attachment")
+      @attachment.stub!(:attached_file).and_return(@attached_file)
+    end
+
+    describe "with correct credentials" do
+      before do
+        @scribd_user = mock("scribd_user")
+        Scribd::User.stub!(:login).and_return(@scribd_user)
+      end
+
+      describe "that was just created" do
+        before do
+          @attachment.attributes = {:ipaper_id => nil, :ipaper_access_key => nil, :attachment_content_type => "application/pdf"}
+        end
+
+        describe "and is scribdable?" do
+          before do
+            @attachment.stub!(:scribdable? => true)
+          end
+
+          describe "and has spaces in the filename" do
+            before do
+              @attached_file.stub!(:path => "/path/to/somewhere with spaces.pdf")
+              @attachment.stub!(:update_attributes)
+            end
+            
+            it "should sanitize the file path" do
+              res = mock('response', :doc_id => 1, :access_key => "ASDF")
+              @scribd_user.should_receive(:upload).with(:file => "/path/to/somewhere%20with%20spaces.pdf", :access => 'access').and_return(res)
+              ScribdFu::upload(@attachment, "/path/to/somewhere with spaces.pdf")
+            end
+            
+          end
+
+          describe "and uploading to Scribd succeeded" do
+            before do
+              @scribd_response = mock('scribd_response', :doc_id => "doc_id", :access_key => "access_key")
+              @scribd_user.should_receive(:upload).and_return(@scribd_response)
+            end
+
+            it "should update the Scribd-centric attributes" do
+              @attachment.should_receive(:update_attributes).with({:ipaper_id => 'doc_id', :ipaper_access_key => 'access_key'})
+              @attachment.save
+            end
+
+          end
+
+          describe "and uploading to Scribd failed" do
+            before do
+              @scribd_user.stub!(:upload).and_raise(StandardError)
+            end
+
+            it "should throw an error" do
+              lambda { ScribdFu::upload(@attachment, 'private') }.should raise_error(ScribdFu::ScribdFuUploadError)
+            end
+
+          end
+
+        end
+
+        describe "and is not scribdable?" do
+          before do
+            @attachment.stub!(:scribdable? => false)
+          end
+
+          it "should not upload to Scribd" do
+            ScribdFu.should_not_receive(:upload)
+            @attachment.save
+          end
+
+        end
+
+      end
+
+      describe "that was just updated" do
+        before do
+          @attachment.stub!(:ipaper_id => 'doc_id')
+        end
+
+        it "should not reupload to Scribd" do
+          @scribd_user.should_not_receive(:upload)
+          @attachment.save
+        end
+
+      end
+
+      describe "that is about to be destroyed" do
+        before do
+          @ipaper_document = mock("ipaper_document")
+          ScribdFu.stub!(:load_ipaper_document).and_return(@ipaper_document)
+        end
+
+        it "should destroy the ipaper document" do
+          ScribdFu.should_receive(:destroy).with(@ipaper_document)
+          @attachment.destroy
+        end
+
+      end
+
+    end
+
+  end
+
+end
+
+describe "Viewing an iPaper document" do
+  before do
+    rebuild_model
+    
+    config = YAML.load_file("spec/scribd_fu.yml")
+    File.stub!(:file?).with(ScribdFu::ConfigPath).and_return(true)
+    YAML.stub!(:load_file).and_return(config)
+    
+    Document.class_eval do
+      has_ipaper_and_uses 'AttachmentFu'
+    end
+    
+    @document = Document.new
+    @document.attributes = {:ipaper_id => 'doc_id', :ipaper_access_key => 'access_key'}
+  end
+  
+  it "should return this HTML by default" do
+    @document.display_ipaper.gsub(/\s{2,}/, "").should == "<script type=\"text/javascript\" src=\"http://www.scribd.com/javascripts/view.js\"></script><div id=\"embedded_flash\"></div><script type=\"text/javascript\">var scribd_doc = scribd.Document.getDoc(doc_id, 'access_key');scribd_doc.write(\"embedded_flash\");</script>\n"
+  end
+  
+  it "should allow custom alt text" do
+    @document.display_ipaper(:alt => "something").should =~ /.*<div id="embedded_flash">something<\/div>.*/
+  end
+  
+  it "should allow custom Javascript params" do
+    options = {:height => 100, :width => 100}
+    
+    @document.display_ipaper(options).should =~ /.*scribd_doc\.addParam\('height', '100'\);.*/
+    @document.display_ipaper(options).should =~ /.*scribd_doc\.addParam\('width', '100'\);.*/
+  end
+  
+  it "should allow not allow crazy custom Javascript params" do
+    options = {:some_dumb_setting => 100, :width => 100}
+    
+    @document.display_ipaper(options).should =~ /.*scribd_doc\.addParam\('width', '100'\);.*/
+    @document.display_ipaper(options).should_not =~ /.*scribd_doc\.addParam\('some_dumb_setting', '100'\);.*/
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'active_record'
+require 'rscribd'
+
+ROOT       = File.join(File.dirname(__FILE__), '..')
+RAILS_ROOT = ROOT
+
+$LOAD_PATH << File.join(ROOT, 'lib')
+$LOAD_PATH << File.join(ROOT, 'lib', 'scribd_fu')
+
+require File.join(ROOT, 'lib', 'scribd_fu.rb')
+
+ENV['RAILS_ENV'] ||= 'test'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection(config[ENV['RAILS_ENV'] || 'test'])
+
+def rebuild_model options = {}
+  ActiveRecord::Base.connection.create_table :documents, :force => true do |table|
+    table.column :ipaper_id, :string
+    table.column :ipaper_access_key, :string
+    table.column :content_type, :string
+  end
+  
+  ActiveRecord::Base.connection.create_table :attachments, :force => true do |table|
+    table.column :ipaper_id, :string
+    table.column :ipaper_access_key, :string
+    table.column :attachment_content_type, :string
+  end
+
+  Object.send(:remove_const, "Document") rescue nil
+  Object.const_set("Document", Class.new(ActiveRecord::Base))
+  
+  Object.send(:remove_const, "Attachment") rescue nil
+  Object.const_set("Attachment", Class.new(ActiveRecord::Base))  
+end
+
+Spec::Runner.configure do |config|
+end
+
+
+# EOF

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: scribd_fu
+version: !ruby/object:Gem::Version 
+  version: 2.0.4
+platform: ruby
+authors: 
+- Matt Darby
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rscribd
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A Rails plugin that streamlines interactions with the Scribd service
+email: matt@matt-darby.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.textile
+- generators/scribd_fu/scribd_fu_generator.rb
+- generators/scribd_fu/templates/scribd_fu.yml
+- init.rb
+- lib/scribd_fu/attachment_fu.rb
+- lib/scribd_fu/paperclip.rb
+- lib/scribd_fu.rb
+- scribd_fu.gemspec
+- spec/database.yml
+- spec/scribd_fu.yml
+- spec/scribd_fu_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mdarby/scribd_fu/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Quick and easy interactions with Scribd's iPaper service
+test_files: []
+