mdarby-scribd_fu 2.0 → 2.0.1

data/README.textile

@@ -0,0 +1,64 @@
+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 mdarby-scribd_fu --source 'http://gems.github.com'</pre>
+
+h3. Add ScribdFu to your environment.rb
+
+<pre>config.gem 'mdarby-scribd_fu', :lib => 'scribd_fu', :source => 'http://gems.github.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_config@ 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. 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/lib/scribd_fu.rb

@@ -12,6 +12,7 @@ module ScribdFu
     'application/vnd.ms-excel',
     'application/postscript',
     'text/plain',
+    'text/rtf',
     'application/rtf',
     'application/vnd.oasis.opendocument.text',
     'application/vnd.oasis.opendocument.presentation',

data/lib/scribd_fu/attachment_fu.rb

@@ -0,0 +1,36 @@
+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.
+      #
+      # 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
+        (ipaper_document && ipaper_document.thumbnail_url) || public_filename(:thumb)
+      end
+
+      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
+      end
+    end
+  
+  end
+end

data/lib/scribd_fu/paperclip.rb

@@ -0,0 +1,62 @@
+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 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
+        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
+        if attached_file.url =~ /^https{0,1}:\/\/s3.amazonaws.com$/
+          attached_file.url
+        else
+          attached_file.path
+        end
+      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

@@ -1,18 +1,30 @@
 Gem::Specification.new do |s|
   s.name     = "scribd_fu"
-  s.version  = "2.0"
-  s.date     = "2009-03-29"
+  s.version  = "2.0.1"
+  s.date     = "2009-03-30"
   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.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
+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,274 @@
+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!(:scribdable? => true)
+          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
+
+        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"}
+          @attachment.stub!(:file_path => "/path/to/somewhere")
+        end
+
+        describe "and is scribdable?" do
+          before do
+            @attachment.stub!(:scribdable? => true)
+          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.should == "        <script type=\"text/javascript\" src=\"http://www.scribd.com/javascripts/view.js\"></script>\n        <div id=\"embedded_flash\"></div>\n        <script type=\"text/javascript\">\n          var scribd_doc = scribd.Document.getDoc(doc_id, 'access_key');\n          \n          scribd_doc.write(\"embedded_flash\");\n        </script>\n"
+  end
+  
+  it "should allow custom Javascript params" do
+    options = {:height => 100, :width => 100}
+    @document.display_ipaper(options).should == "        <script type=\"text/javascript\" src=\"http://www.scribd.com/javascripts/view.js\"></script>\n        <div id=\"embedded_flash\"></div>\n        <script type=\"text/javascript\">\n          var scribd_doc = scribd.Document.getDoc(doc_id, 'access_key');\n          scribd_doc.addParam('width', '100');\nscribd_doc.addParam('height', '100');\n          scribd_doc.write(\"embedded_flash\");\n        </script>\n"
+  end
+  
+  it "should allow not allow crazy custom Javascript params" do
+    options = {:some_dumb_setting => 100, :width => 100}
+    @document.display_ipaper(options).should == "        <script type=\"text/javascript\" src=\"http://www.scribd.com/javascripts/view.js\"></script>\n        <div id=\"embedded_flash\"></div>\n        <script type=\"text/javascript\">\n          var scribd_doc = scribd.Document.getDoc(doc_id, 'access_key');\n          scribd_doc.addParam('width', '100');\n          scribd_doc.write(\"embedded_flash\");\n        </script>\n"
+  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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mdarby-scribd_fu
 version: !ruby/object:Gem::Version 
-  version: "2.0"
+  version: 2.0.1
 platform: ruby
 authors: 
 - Matt Darby
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-29 00:00:00 -07:00
+date: 2009-03-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,20 +31,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- init.rb
-- install.rb
-- uninstall.rb
 - MIT-LICENSE
-- Rakefile
-- README
+- 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
-- 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
+- spec/database.yml
+- spec/scribd_fu.yml
+- spec/scribd_fu_spec.rb
+- spec/spec_helper.rb
 has_rdoc: false
 homepage: http://github.com/mdarby/scribd_fu/tree/master
 post_install_message: