jastix-scribd_fu 1.2.3.3

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

@@ -0,0 +1,191 @@
+h1. Scribd_fu
+
+A Ruby on Rails plugin that streamlines interaction with the Scribd service
+(scribd.com), and even works Attachment_fu or Paperclip!
+
+
+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 huge documents
+right inline with your web UI, no downloading, no necessary programs on the
+client side (except for Flash) to view your data. It's pretty damned cool.
+
+
+h2. Requirements
+
+Scribd_fu requires the rscribd gem for talking to scribd, and either the wicked
+awesome Attachment_fu plugin or the equally awesome Paperclip plugin.
+
+
+h2. How to Install & Use
+
+Scribd_fu depends on rscribd, so installing it as a gem should also pull in
+rscribd. First, add Scribd_fu to your list of gems in
+<tt>config/environment.rb</tt>:
+
+<pre>config.gem 'mdarby-scribd_fu', :lib => 'scribd_fu'</pre>
+
+Note that this will only work if you have http://gems.github.com in your list of
+gem sources:
+
+<pre>$ gem source -a http://gems.github.com</pre>
+
+Then run:
+
+<pre>$ sudo rake gems:install</pre>
+
+To install it and the rscribd gem. If you don't add github as a gem source, you
+can add the <tt>:source</tt> option to the <tt>config.gem</tt> call; however,
+this means you will have to separately require the rscribd gem, since using
+<tt>:source</tt> will not search for the rscribd gem in your regular sources.
+
+Then, install either Paperclip or Attachment_fu.
+
+h3. Attachment_fu
+
+If you want to install Attachment_fu, you should probably use the git
+repository on github:
+
+<pre>$ script/plugin install git://github.com/technoweenie/attachment_fu.git</pre>
+
+h3. Paperclip
+
+If you'd rather use Paperclip (the most important advantage, with respect to
+Scribd_fu, will be being able to have more than one document-related column in a
+single model), you should probably require it as a gem dependency rather than
+using it in plugin form. In Rails 2.1 or greater:
+
+<pre>config.gem 'paperclip'</pre>
+
+Then run:
+
+<pre>$ rake gems:install</pre>
+
+To install it.
+
+
+h2. How to Use
+
+h3. Shared steps
+
+* Sign up for Scribd (it's totally free) at
+  http://www.scribd.com/publisher/signup_api.
+* Run <tt>script/generate scribd_config</tt> and fill out the new
+  config/scribd.yml file with your Scribd login credentials.
+
+h3. Attachment_fu
+
+Enter the below line into any attachment_fu-using model whose attachment you'd like to
+Scribdify:
+
+<pre>acts_as_scribd_document</pre>
+
+Add the following fields into a new migration for the target model (and run the
+migration!):
+
+<pre>t.integer :scribd_id
+t.string  :scribd_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. No muss, no fuss. Files are uploaded to
+scribd when the model is saved. If the file fails to upload to scribd, the model
+save will fail.
+
+Scribd_fu also provides the <tt>validates_as_scribd_document</tt> validation,
+which verifies that the document's information is being saved correctly (i.e.,
+that the <tt>content_type</tt>, <tt>scribd_id</tt>, and
+<tt>scribd_access_key</tt> are present) and that the attachment is scribdable to
+begin with (that is to say, that the content type of the file is a scribdable
+content type).
+
+Note that Scribd_fu will only upload the file to Scribd. Scribd then has to
+convert it to their iPaper format. Usually this is a pretty fast operation, but
+if you want to be safe or have a contingency plan in case someone tries to
+access the document and it isn't converted yet, the set of methods
+<tt>conversion_complete?</tt>, <tt>conversion_successful?</tt>, and
+<tt>conversion_error?</tt> can be used to determine the current conversion
+status of the document. Also note that if you try to display a file that hasn't
+been converted to scribd yet, the iPaper viewer will actually say that it is
+still converting complete with a spinner, so these methods will often not be
+necessary.
+
+To view a Scribd document, just throw the below code into your view (where
+<tt>@document</tt> is an object of your Scribd/Attachment_fu model):
+<pre><%= display_scribd(@document) %></pre>
+That's it!
+
+h3. Paperclip
+
+For each attachment that you want to be scribdable, mark it using the
+<tt>has_scribdable_attachment</tt> method. For example, if I had the line:
+
+<pre>has_attached_file :document</pre>
+
+And I wanted the <tt>document</tt> attachment to be scribdable, I would add:
+
+<pre>has_scribdable_attachment :document</pre>
+
+In addition, you have to add two columns for each scribdable attachment. These
+are <tt>_scribd_id</tt> and <tt>_scribd_access_key</tt>, both prefixed by the
+attachment name.  For the above example, we would have the following migration
+statements:
+
+<pre>t.integer :document_scribd_id
+t.string  :document_scribd_access_key</pre>
+
+Scribdable attachments can also be validated using the
+<tt>validates_attachment_scribdability</tt> validation:
+
+<pre>validates_attachment_scribdability :document</pre>
+
+This validation checks that the content type, scribd id, and access key are all
+available, and it verifies that the content type is a scribdable content type.
+
+As mentioned in the Attachment_fu section, Scribd_fu will only upload the file
+to Scribd. Scribd then has to do the actual conversion to iPaper. For tracking
+the status of this conversion, you have three methods, each of which take the
+attachment whose status you want:
+
+* <tt>conversion_complete?</tt> -- e.g.,
+  <tt>model.conversion_complete?(:document)</tt>
+* <tt>conversion_successful?</tt> -- e.g.,
+  <tt>model.conversion_successful?(:document)</tt>
+* <tt>conversion_error?</tt> -- e.g.,
+  <tt>model.conversion_error?(:document)</tt>
+
+Also note that if you try to display a file that hasn't been converted to scribd
+yet, the iPaper viewer will actually say that it is still converting with a
+spinner, so these methods will often not be necessary.
+
+To view a Scribd document, just throw the below code into your view (where
+<tt>@model</tt> is an object of your Scribd/Paperclip model, and
+<tt>document</tt> is the name of the scribdable attachment):
+
+<pre><%= display_scribd(@model, :document) %></pre>
+
+That's it!
+
+
+h2. Access
+
+You can set the default access on all documents by setting the 'access' key in
+the scribd.yml file to either 'private' or 'public'.
+
+You can also override the default access level and control access on a
+per-document basis by setting the 'is_public' attribute to either true or false.
+If this column is not defined, the default option in the scribd.yml will be
+used.
+
+Please note that setting the access level only works before the document is
+initially uploaded to Scribd.
+
+
+h2. About the Author
+
+My name is Matt Darby. I’m a 29 year old professional Web Developer and IT Manager. I am the IT Manager and Lead Web Developer at Dynamix Engineering and recently earned a Master’s Degree in Computer Science from Franklin University in Columbus, OH.
+
+Feel free to check out my "blog":http://blgo.matt-darby.com or to "recommend me":http://workingwithrails.com

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the Scribd_fu plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the Scribd_fu plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Scribd_fu'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/scribd_config/scribd_config_generator.rb

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

data/generators/scribd_config/templates/scribd.yml

@@ -0,0 +1,9 @@
+#Scribd Account Info
+
+scribd:
+ key: 
+ secret: 
+ user: 
+ password: 
+ access:
+#storage: s3 # Uncomment if Attachment_fu is using Amazon S3 for storage

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/attachment_fu/methods.rb

@@ -0,0 +1,164 @@
+require 'fileutils'
+
+module ScribdFu
+  module AttachmentFu
+    module ClassMethods
+      # Adds validations to the current model to check that its attachment is
+      # scribdable.
+      def validates_as_scribd_document
+        validates_presence_of :scribd_id, :scribd_access_key, :content_type
+        validate :scribdable?
+      end
+    end
+
+    module InstanceMethods
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Checks whether the attachment is scribdable. This boils down to a check
+      # to ensure that the contents of the attachment are of a content type that
+      # scribd can understand.
+      def scribdable?
+        ScribdFu::CONTENT_TYPES.include?(content_type)
+      end
+
+      def scribd_id=(id)
+        write_attribute :scribd_id, id.to_s.strip
+      end
+
+      def scribd_access_key=(key)
+        write_attribute :scribd_access_key, key.to_s.strip
+      end
+
+      # Destroys the scribd document for this record. This is called
+      # +before_destroy+, as set up by ScribdFu::ClassMethods#extended.
+      #
+      # Also available as destroy_scribd_document, which makes more sense in
+      # terms of pluralization for external calls.
+      def destroy_scribd_documents
+        unless scribd_document.nil?
+          if scribd_document.destroy
+            logger.info "[Scribd_fu] #{Time.now.rfc2822}: Removing Object #{id} successful"
+          else
+            logger.info "[Scribd_fu] #{Time.now.rfc2822}: Removing Object #{id} failed!"
+          end
+        end
+      end
+      alias_method :destroy_scribd_document, :destroy_scribd_documents
+
+      # Uploads the attachment to scribd for processing.. This is called
+      # +before_validation+, as set up by ScribdFu::ClassMethods#extended.
+      def upload_to_scribd
+        if scribdable? and self.scribd_id.blank?
+          with_file_path do |file_path|
+            if resource = scribd_login.upload(:file => "#{file_path}",
+                                              :access => access_level)
+              logger.info "[Scribd_fu] #{Time.now.rfc2822}: Object #{id} successfully uploaded for conversion to iPaper."
+
+              self.scribd_id         = resource.doc_id
+              self.scribd_access_key = resource.access_key
+
+              save
+            else
+              logger.info "[Scribd_fu] #{Time.now.rfc2822}: Object #{id} upload failed!"
+            end
+          end
+        end
+      end
+
+      # Returns a URL for a thumbnail for this model's attachment.
+      #
+      # If Scribd does not provide a thumbnail URL, then Attachment_fu's
+      # thumbnail is fallen back on by returning the value of
+      # <tt>public_filename(:thumb)</tt>.
+      #
+      # Sample use in a view:
+      #  <%= image_tag(@attachment .thumbnail_url, :alt => @attachment.name) %>
+      def thumbnail_url
+        (scribd_document && scribd_document.thumbnail_url) or
+          public_filename(:thumb)
+      end
+
+      # Returns the actual image data of a thumbnail for this model's
+      # attachment.
+      #
+      # If Scribd does not have a thumbnail for this file, then Attachment_fu's
+      # thumbnanil is fallen back on by returning the file at
+      # <tt>full_filename(:thumb)</tt>.
+      #
+      # Sample use in a controller:
+      #  render :inline => @attachment.thumbnail_file,
+      #         :content_type => 'image/jpeg'
+      def thumbnail_file
+        path = (scribd_document && scribd_document.thumbnail_url) ||
+                  full_filename(:thumb)
+
+        open(path).read
+      rescue Errno::ENOENT
+        nil
+      end
+
+      # Yields the correct path to the file, either the local filename or the
+      # S3 URL.
+      #
+      # This method creates a temporary file of the correct filename if
+      # necessary, so as to be able to give scribd the right filename. The file
+      # is destroyed when the passed block ends.
+      def with_file_path(&block) # :yields: full_file_path
+        # TODO We can probably do this using respond_to?
+        if scribd_config['storage'].eql?('s3')
+           yield s3_url
+        elsif save_attachment? # file hasn't been saved, use the temp file
+          temp_rename = File.join(Dir.tmpdir, filename)
+          File.copy(temp_path, temp_rename)
+
+          yield temp_rename
+        else
+          yield full_filename
+        end
+      ensure
+        temp_rename && File.unlink(temp_rename) # always delete this
+      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.
+      #
+      # Note that this method still returns false if the model does not refer to a
+      # valid document.  scribd_attributes_valid? should be used to determine the
+      # validity of the document.
+      def conversion_complete?
+        scribd_document && scribd_document.conversion_status != 'PROCESSING'
+      end
+
+      # Responds true if the document has been converted.
+      #
+      # Note that this method still returns false if the model does not refer to a
+      # valid document.  scribd_attributes_valid? should be used to determine the
+      # validity of the document.
+      def conversion_successful?
+        scribd_document && scribd_document.conversion_status =~ /^DISPLAYABLE|DONE$/
+      end
+
+      # Responds true if there was a conversion error while converting
+      # to iPaper.
+      #
+      # Note that this method still returns false if the model does not refer to a
+      # valid document.  scribd_attributes_valid? should be used to determine the
+      # validity of the document.
+      def conversion_error?
+        scribd_document && scribd_document.conversion_status == 'ERROR'
+      end
+
+      # Responds the Scribd::Document associated with this model, or nil if it
+      # does not exist.
+      def scribd_document
+        @scribd_document ||= scribd_login.find_document(scribd_id)
+      rescue Scribd::ResponseError # at minimum, the document was not found
+        nil
+      end
+    end
+  end
+end
+

data/lib/paperclip/methods.rb

@@ -0,0 +1,232 @@
+require 'fileutils'
+
+module ScribdFu
+  module Paperclip
+    module ClassMethods
+      # Adds validations to the current model to check that the attachment at
+      # +attribute+ is scribdable. If +attribute+ is nil, then all attachments
+      # that have been marked as scribdable are validated.
+      #
+      # Note that all calls to has_scribdable_attachment should be made before
+      # calling validates_attachment_scribdability with a nil parameter;
+      # otherwise, only those that have been created already will be validated.
+      def validates_attachment_scribdability(attribute = nil)
+        attributes = attribute.nil? ? scribd_attributes : [attribute]
+
+        attributes.each do |attribute|
+          validates_presence_of "#{attribute}_scribd_id",
+                                "#{attribute}_scribd_access_key",
+                                "#{attribute}_content_type"
+          validates_attachment_content_type attribute,
+            :content_type => ScribdFu::CONTENT_TYPES
+        end
+      end
+
+      # Adds the given +attribute+ to the list of attributes that are uploaded
+      # to scribd.
+      #
+      # Note that a scribd attribute should not be added if it is not a
+      # Paperclip attachment attribute.
+      def add_scribd_attribute(attribute)
+        write_inheritable_attribute :scribd_attributes, [] if scribd_attributes.nil?
+
+        scribd_attributes << attribute
+
+        setup_scribd_attribute(attribute)
+      end
+
+      def scribd_attributes
+        read_inheritable_attribute :scribd_attributes
+      end
+
+      private
+        # Sets up methods needed for the given +attribute+ to be scribdable.
+        def setup_scribd_attribute(attribute)
+          define_method("#{attribute}_scribd_id=") do |id|
+            write_attribute "#{attribute}_scribd_id", id.to_s.strip
+          end
+
+          define_method("#{attribute}_scribd_access_key=") do |key|
+            write_attribute "#{attribute}_scribd_access_key", key.to_s.strip
+          end
+        end
+    end
+
+    module InstanceMethods
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Checks whether the given attribute is scribdable. This boils down to a
+      # check to ensure that the contents of the attribute are of a content type
+      # that scribd can understand.
+      def scribdable?(attribute)
+        ScribdFu::CONTENT_TYPES.include?(self["#{attribute}_content_type"])
+      end
+
+      # Destroys all scribd documents for this record. This is called
+      # +before_destroy+, as set up by ScribdFu::ClassMethods#extended.
+      def destroy_scribd_documents
+        self.class.scribd_attributes.each do |attribute|
+          document = scribd_document_for(self["#{attribute}_scribd_id"])
+
+          unless document.nil?
+            if document.destroy
+              logger.info "[Scribd_fu] #{Time.now.rfc2822}: Removing Object #{id}##{attribute} successful"
+            else
+              logger.info "[Scribd_fu] #{Time.now.rfc2822}: Removing Object #{id}##{attribute} failed!"
+            end
+          end
+        end
+      end
+
+      # Uploads all scribdable attributes to scribd for processing. This is
+      # called +before_validation+, as set up by
+      # ScribdFu::ClassMethods#extended.
+      def upload_to_scribd
+        self.class.scribd_attributes.each do |attribute|
+          scribd_id = self["#{attribute}_scribd_id"]
+
+          if scribdable?(attribute) and scribd_id.blank?
+            with_file_path_for(attribute) do |filename|
+              if resource = scribd_login.upload(:file   => filename,
+                                                :access => access_level)
+                self.send("#{attribute}_scribd_id=",         resource.doc_id)
+                self.send("#{attribute}_scribd_access_key=", resource.access_key)
+
+                logger.info "[Scribd_fu] #{Time.now.rfc2822}: Object " +
+                            "#{id}##{attribute} successfully uploaded " +
+                            "for conversion to iPaper."
+              else
+                logger.info "[Scribd_fu] #{Time.now.rfc2822}: Object " +
+                            "#{id}##{attribute} upload failed!"
+
+                false # cancel the save
+              end
+            end
+          end
+        end
+      end
+
+      # Returns a URL for a thumbnail for the specified +attribute+ attachment.
+      #
+      # If Scribd does not provide a thumbnail URL, then Paperclip's thumbnail
+      # is fallen back on by returning the value of
+      # <tt>attribute.url(:thumb)</tt>.
+      #
+      # Sample use in a view:
+      #  <%= image_tag(@attachment.thumbnail_url, :alt => @attachment.name) %>
+      def thumbnail_url(attribute)
+        doc = scribd_document_for(attribute)
+
+        (doc && doc.thumbnail_url) or self.send(attribute).url(:thumb)
+      end
+
+      # Returns the actual image data of a thumbnail for the specified
+      # +attribute+ attachment.
+      #
+      # If Scribd does not have a thumbnail for this file, then
+      # Paperclip's thumbnanil is fallen back on by returning the file from
+      # <tt>attribute.to_file(:thumb)</tt>.
+      #
+      # Sample use in a controller:
+      #  render :inline => @attachment.thumbnail_file,
+      #         :content_type => 'image/jpeg'
+      def thumbnail_file(attribute)
+        doc = scribd_document_for(attribute)
+
+        if doc && doc.thumbnail_url
+          open(doc.thumbnail_url).read
+        else
+          send(attribute).to_file(:thumb).open { |f| f.read }
+        end
+      rescue Errno::ENOENT, NoMethodError # file not found or nil thumb file
+        nil
+      end
+
+      # Responds true if the conversion is complete for the given +attribute+ --
+      # note that this gives no indication as to whether the conversion had an
+      # error or was succesful, just that the conversion completed. See
+      # <tt>conversion_successful?</tt> for that information.
+      #
+      # Note also that this method still returns false if the model does not
+      # refer to a valid document.  scribd_attributes_valid? should be used to
+      # determine the validity of the document.
+      def conversion_complete?(attribute)
+        doc = scribd_document_for(attribute)
+
+        doc && doc.conversion_status != 'PROCESSING'
+      end
+
+      # Responds true if the document for the given +attribute+ has been
+      # converted successfully. This *will* respond false if the conversion has
+      # failed.
+      #
+      # Note that this method still returns false if the model does not refer to a
+      # valid document. <tt>scribd_attributes_valid?</tt> should be used to
+      # determine the validity of the document.
+      def conversion_successful?(attribute)
+        doc = scribd_document_for(attribute)
+
+        doc && doc.conversion_status =~ /^DISPLAYABLE|DONE$/
+      end
+
+      # Responds true if there was a conversion error while converting the given
+      # +attribute+ to iPaper.
+      #
+      # Note that this method still returns false if the model does not refer to a
+      # valid document. <tt>scribd_attributes_valid?</tt> should be used to
+      # determine the validity of the document.
+      def conversion_error?(attribute)
+        doc = scribd_document_for(attribute)
+
+        doc && doc.conversion_status == 'ERROR'
+      end
+
+      # Responds the Scribd::Document associated with the given +attribute+, or
+      # nil if it does not exist.
+      def scribd_document_for(attribute)
+        scribd_documents[attribute] ||= scribd_login.find_document(self["#{attribute}_scribd_id"])
+      rescue Scribd::ResponseError # at minimum, the document was not found
+        nil
+      end
+
+      private
+        def scribd_documents
+          @scribd_documents ||= HashWithIndifferentAccess.new
+        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 full_filename_for(attribute)
+          filename = attachment_for(attribute).path
+        end
+
+        # Yields the correct path to the file for the attachment in
+        # +attribute+, either the local filename or the S3 URL.
+        #
+        # This method creates a temporary file of the correct filename  for the
+        # attachment in +attribute+ if necessary, so as to be able to give
+        # scribd the right filename. The file is destroyed when the passed block
+        # ends.
+        def with_file_path_for(attribute, &block) # :yields: full_file_path
+          attachment = attachment_for(attribute)
+
+          if attachment.respond_to?(:s3)
+             yield attachment.url
+          elsif File.exists?(attachment.path)
+            yield attachment.path
+          else # file hasn't been saved, use a tempfile
+            temp_rename = File.join(Dir.tmpdir, attachment.original_filename)
+            File.copy(attachment.to_file.path, temp_rename)
+
+            yield temp_rename
+          end
+        ensure
+          temp_rename && File.unlink(temp_rename) # always delete this
+        end
+    end
+  end
+end
+

data/lib/scribd_fu.rb

@@ -0,0 +1,108 @@
+require 'attachment_fu/methods'
+require 'paperclip/methods'
+
+module ScribdFu
+  # A list of content types supported by scribd.
+  CONTENT_TYPES = ['application/pdf', 'image/jpeg', 'image/pjpeg',
+                   'image/gif', 'image/png', 'image/x-png', 'image/jpg',
+                   'application/msword', 'application/mspowerpoint',
+                   'application/vnd.ms-powerpoint', 'application/excel',
+                   'application/vnd.ms-excel', 'application/postscript',
+                   'text/plain', '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',
+    # OOXML, AKA `the MIME types from hell'. Seriously, these are long enough to
+    # start their own dictionary...
+    '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']
+
+  def self.included(base)
+    base.extend ActsAsScribdDocument
+  end
+
+  module ActsAsScribdDocument
+    # Synonym for <tt>has_scribdable_attachment(nil)</tt>.
+    def acts_as_scribd_document
+      has_scribdable_attachment
+    end
+
+    # Marks the given +attribute+ as a scribdable document file. If +attribute+
+    # is nil, assumes this is an Attachment_fu model and deals with the setup
+    # accordingly; otherwise, assumes a +paperclip+ model and sets up scribding
+    # related to the particular given attribute.
+    def has_scribdable_attachment(attribute = nil)
+      class_eval do
+        include ScribdFu::InstanceMethods
+
+        if attribute.nil?
+          include ScribdFu::AttachmentFu::InstanceMethods
+        else
+          include ScribdFu::Paperclip::InstanceMethods # ignored if already done
+
+          add_scribd_attribute attribute # class method added by above include
+        end
+      end
+    end
+  end
+
+  module InstanceMethods
+    # Sets up Scribd configuration info when this module is included.
+    def self.included(base)
+      base.extend ClassMethods
+
+      mattr_reader :scribd_config, :scribd_login
+
+      begin
+        require 'rscribd'
+      rescue LoadError
+        raise RequiredLibraryNotFoundError.new('rscribd could not be loaded')
+      end
+
+      begin
+        unless @@scribd_login
+          @@scribd_config = YAML.load_file("#{RAILS_ROOT}/config/scribd.yml").symbolize_keys
+          @@scribd_config = @@scribd_config[:scribd]
+
+          # Ensure we can connect to the Service
+          Scribd::API.instance.key    = @@scribd_config['key'].to_s.strip
+          Scribd::API.instance.secret = @@scribd_config['secret'].to_s.strip
+
+          @@scribd_login = Scribd::User.login @@scribd_config['user'].to_s.strip, @@scribd_config['password'].to_s.strip
+        end
+      rescue
+        raise "config/scribd.yml file not found, or your credentials are incorrect."
+      end
+    end
+
+    def access_level
+      if self.respond_to?(:is_public) && self.is_public != nil
+        scribd_access = self.is_public ? 'public' : 'private'
+      else
+        scribd_access = scribd_config['access']
+      end
+
+      scribd_access
+    end
+  end
+
+  module ClassMethods
+    # Sets up the scribd_options accessor, a before_destroy hook to ensure the
+    # deletion of associated Scribd documents, and an after_save hook to upload
+    # to scribd.
+    def self.extended(base)
+      base.class_inheritable_accessor :scribd_options
+
+      base.before_destroy    :destroy_scribd_documents
+      base.before_validation :upload_to_scribd
+    end
+  end
+end

data/lib/scribd_fu_helper.rb

@@ -0,0 +1,58 @@
+module ScribdFuHelper
+  # 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 ]
+  
+
+  # Displays the scribd object for the attachment on the given +object+. If
+  # +alt_text_or_attribute+ is given, then it will be used as the alternate text
+  # for an Attachment_fu model, or as the attribute name for a Paperclip
+  # model. If you want to specify alternate text for a Paperclip model, use the
+  # last parameter, +alt_text_if_paperclip+.
+  #
+  # If you are using Paperclip, you _must_ specify +alt_text_or_attribute+ as
+  # the attribute on which the scribd object exists.
+  #
+  # For example, using Attachment_fu:
+  #  <%= display_scribd document %>
+  #  <%= display_scribd document, 'You need Flash to view this document' %>
+  #
+  # Using Paperclip:
+  #  <%= display_scribd user, :biography %>
+  #  <%= display_scribd user, :biography, 'You need Flash for biographies." %>
+  def display_scribd(object, alt_text_or_attribute = '', alt_text_if_paperclip = nil)
+    # Resolve the right scribd ID, access key, and alt text.
+    if object.respond_to?("scribd_id")
+      scribd_id = object.scribd_id
+      scribd_ak = object.scribd_access_key
+
+      alt_text = alt_text_or_attribute
+    else
+      scribd_id = object.send "#{alt_text_or_attribute}_scribd_id"
+      scribd_ak = object.send "#{alt_text_or_attribute}_scribd_access_key"
+
+      alt_text = alt_text_if_paperclip
+    end
+
+    begin
+      # Collect a set of addParam statements to set up JS parameters for the scribd document
+      # (only if they are valid).
+      param_includes = options[:params].collect do |param, value|
+        "scribd_doc.addParam('#{param}', '#{value}');" if AVAILABLE_JS_PARAMS.include?(param)
+      end.compact.join("\n")
+    rescue
+      # Where is 'options' coming from???
+    end
+
+    <<-END
+      <script type="text/javascript" src="http://www.scribd.com/javascripts/view.js"></script>
+      <div id="embedded_flash">#{alt_text}</div>
+      <script type="text/javascript">
+        var scribd_doc = scribd.Document.getDoc(#{scribd_id}, '#{scribd_ak}');
+        #{param_includes}
+        scribd_doc.write("embedded_flash");
+      </script>
+    END
+  end
+end

data/rails/init.rb

@@ -0,0 +1,7 @@
+require 'scribd_fu'
+require 'scribd_fu_helper'
+
+ActiveRecord::Base.send(:include, ScribdFu)
+ActionView::Base.send(:include, ScribdFuHelper)
+
+RAILS_DEFAULT_LOGGER.debug "** [Scribd_fu] loaded"

data/scribd_fu.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name     = "scribd_fu"
+  s.version  = "1.2.3.3"
+  s.date     = "2009-04-26"
+  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    = ['init.rb', 'install.rb', 'uninstall.rb', 'MIT-LICENSE', 'Rakefile',
+                'README',  'lib/scribd_fu.rb', 'lib/scribd_fu_helper.rb',
+                'lib/attachment_fu/methods.rb', 'lib/paperclip/methods.rb',
+                'rails/init.rb', 'scribd_fu.gemspec',
+                'generators/scribd_config/scribd_config_generator.rb',
+                'generators/scribd_config/templates/scribd.yml']
+  s.add_dependency 'rscribd'
+end
+

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: jastix-scribd_fu
+version: !ruby/object:Gem::Version 
+  version: 1.2.3.3
+platform: ruby
+authors: 
+- Matt Darby
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-26 00:00:00 -07: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: 
+- init.rb
+- install.rb
+- uninstall.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- lib/scribd_fu.rb
+- lib/scribd_fu_helper.rb
+- lib/attachment_fu/methods.rb
+- lib/paperclip/methods.rb
+- rails/init.rb
+- scribd_fu.gemspec
+- generators/scribd_config/scribd_config_generator.rb
+- generators/scribd_config/templates/scribd.yml
+has_rdoc: false
+homepage: http://github.com/mdarby/scribd_fu/tree/master
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Quick and easy interactions with Scribd's iPaper service
+test_files: []
+