mdarby-scribd_fu 1.1

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,69 @@
+h1. Scribd_fu
+
+A Ruby on Rails plugin that streamlines interaction with the Scribd service (scribd.com), and even works with Attachment_fu!
+
+
+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 imbedding huge documents right inline with your web UI, no downloading, no necessary programs on the client side to view your data. It’s pretty damned cool.
+
+
+h2. Requirements
+
+Scribd_fu requires the wicked awesome Attachment_fu plugin. You probably already have it installed.
+You also need the rscribd gem (sudo gem install rscribd will do the trick)
+
+
+h2. How to Install & Use
+
+# Install the rscribd gem
+<pre>gem install rscribd</pre>
+# Install the scribd_fu gem
+<pre>sudo gem install mdarby-scribd_fu</pre>
+# Add this line to your config/environment.rb file
+<pre>config.gem 'mdarby-scribd_fu', :lib => 'scribd_fu'</pre>
+# Enter the below line into any attachment_fu-using model that you’d like to Scribdify
+<pre>acts_as_scribd_document</pre>
+# Add the following fields into a new migration for the target model (and update your schema!):
+<pre>
+t.integer :scribd_id
+t.string :scribd_access_key
+t.boolean :is_public
+</pre>
+# Sign up for Scribd (it’s totally free)
+# Copy the vendor/plugins/scribd.yml.example file to config/scribd.yml and fill out with your Scribd login credentials
+# Now, when you upload a file that is convertible in the Scribd system, Scribd_fu will automatically handle the CRUD for you. No muss, no fuss.
+
+
+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. Displaying
+
+To view a Scribd document, just throw the below code into your view (where @document is an object of your Scribd/Attachment_fu model):
+<pre><%= display_scribd(@document) %></pre>
+
+That’s it!
+
+
+h2. Notes
+
+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
+conversion_complete?, conversion_successful?, and conversion_error? can be used
+to determine the current conversion status of the document.
+
+
+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 act_as_scribd_document plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the act_as_scribd_document plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActAsScribdDocument'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

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

data/install.rb

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

data/lib/scribd_fu.rb

@@ -0,0 +1,179 @@
+module Scribd_fu
+
+  def self.included(base)
+    base.extend ActsAsScribdObject
+  end
+
+  module ActsAsScribdObject
+    def acts_as_scribd_document(options = {})
+      class_eval <<-END
+        include Scribd_fu::InstanceMethods
+      END
+    end
+  end
+
+  module ClassMethods
+    def self.extended(base)
+      base.class_inheritable_accessor :scribd_options
+      base.before_destroy :destroy_scribd_document
+      base.after_save :upload_to_scribd
+    end
+
+    def validates_as_scribd_document
+      validates_presence_of :scribd_id, :scribd_access_id, :content_type
+      validate              :scribd_attributes_valid?
+    end
+  end
+
+  module InstanceMethods
+    @@content_types = ['application/pdf', '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', 'vnd.oasis.opendocument.presentation',
+                        'application/vnd.sun.xml.writer', 'application/vnd.sun.xml.impress', 
+												'application/vnd.oasis.opendocument.spreadsheet', 'application/vnd.sun.xml.calc']
+
+    mattr_reader :content_types
+
+    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
+
+          # Ensure we can connect to the Service
+          Scribd::API.instance.key    = @@scribd_config[:scribd]['key'].to_s.strip
+          Scribd::API.instance.secret = @@scribd_config[:scribd]['secret'].to_s.strip
+
+          @@scribd_login = Scribd::User.login @@scribd_config[:scribd]['user'].to_s.strip, @@scribd_config[:scribd]['password'].to_s.strip
+        end
+      rescue
+        raise "config/scribd.yml file not found, or your credentials are incorrect."
+      end
+    end
+
+    def scribd_attributes_valid?
+      [:scribd_id, :scribd_access_id].each do |attr_name|
+        enum = scribd_options[attr_name]
+        errors.add attr_name, ActiveRecord::Errors.default_error_messages[:inclusion] unless enum.nil? || enum.include?(send(attr_name))
+      end
+    end
+
+    def scribdable?
+      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
+
+    def destroy_scribd_document
+      if scribd_document
+        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
+
+    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[:scribd]['access']
+      end
+      
+      scribd_access
+    end
+    
+    def final_path      
+      if scribd_config[:scribd]['storage'].eql?('s3')
+        file_path = s3_url
+      else
+        file_path = full_filename
+      end
+    
+      file_path
+    end
+    
+    def upload_to_scribd
+      if scribdable? and self.scribd_id.blank?
+        
+        if resource = scribd_login.upload(:file => "#{final_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
+
+    # Sample of use in a view:
+    # image_tag(@attachment).thumbnail_url, :alt => @attachment.name)
+    def thumbnail_url
+      scribd_document ? scribd_document.thumbnail_url : nil
+    end
+
+    # Sample of use in a controller:
+    # render :inline => @attachment.thumbnail_file, :content_type => 'image/jpeg'
+    def thumbnail_file
+      scribd_document ? open(scribd_document.thumbnail_url).read : nil
+    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

data/lib/scribd_fu_helper.rb

@@ -0,0 +1,14 @@
+module Scribd_fu_Helper
+  
+  def display_scribd(object, alt_text = '')
+    <<-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(#{object.scribd_id}, '#{object.scribd_access_key}');
+        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, Scribd_fu)
+ActionView::Base.send(:include, Scribd_fu_Helper)
+
+RAILS_DEFAULT_LOGGER.debug "** [Scribd_fu] loaded"

data/scribd.yml.example

@@ -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/scribd_fu.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name     = "scribd_fu"
+  s.version  = "1.1"
+  s.date     = "2008-12-14"
+  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", "lib/scribd_fu.rb", "lib/scribd_fu_helper.rb", "MIT-LICENSE", "rails/init.rb", "Rakefile", "README.textile", "scribd.yml.example", "scribd_fu.gemspec", "uninstall.rb"]
+end

data/uninstall.rb

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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: mdarby-scribd_fu
+version: !ruby/object:Gem::Version 
+  version: "1.1"
+platform: ruby
+authors: 
+- Matt Darby
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-14 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+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
+- lib/scribd_fu.rb
+- lib/scribd_fu_helper.rb
+- MIT-LICENSE
+- rails/init.rb
+- Rakefile
+- README.textile
+- scribd.yml.example
+- scribd_fu.gemspec
+- uninstall.rb
+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: []
+