rscribd 0.1.2 → 1.0.1

data/History.txt

@@ -1,3 +1,19 @@
+=== 1.0.1 / 2009-3-4
+
+* Fixed a bug that would cause some API parameters to not be sent when uploading
+  a document.
+
+=== 1.0.0 / 2008-11-26
+
+* First release version.
+* Comprehensive RSpec of all code.
+* read_attributes method now works correctly.
+* Uploading a document as a not-yet-created user no longer uploads it into the
+  default API account.
+* Finding documents owned by a not-yet-created user now returns nil.
+* Symbol#to_proc definedd for RScribd use in non-Rails projects.
+* Minor code style improvements.
+
 === 0.1.2 / 2008-11-26
 
 * Happy Thanksgiving!

data/README.txt

@@ -1,6 +1,6 @@
 = rscribd
 
-* 0.1.2 (Nov 26, 2008)
+* 1.0.1 (Mar 4, 2009)
 
 == DESCRIPTION:
 

data/Rakefile

@@ -1,18 +1,28 @@
-# -*- ruby -*-
-
 require 'rubygems'
 require 'hoe'
+require 'spec/rake/spectask'
 
-Hoe.new('rscribd', '0.1.2') do |p|
+Hoe.new('rscribd', '1.0.1') do |p|
   p.rubyforge_name = 'rscribd'
-  p.author = 'Jared Friedman'
+  p.author = 'Jared Friedman, Tim Morgan'
   p.email = 'api@scribd.com'
   p.summary = 'Ruby client library for the Scribd API'
-  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.description = p.paragraphs_of('README.txt', 3).join("\n\n")
   p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.extra_deps << [ 'mime-types', '>0.0.0' ]
   p.remote_rdoc_dir = ''
 end
 
-# vim: syntax=Ruby
+desc "Verify gem specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.spec_opts = [ '-cfs' ]
+end
+
+namespace :github do
+  desc "Prepare for GitHub gem packaging"
+  task :prepare do
+    `rake debug_gem > rscribd.gemspec`
+  end
+end

data/lib/rscribd.rb

@@ -3,6 +3,12 @@
 module Scribd # :nodoc:
 end
 
+class Symbol
+  def to_proc
+    Proc.new { |*args| args.shift.__send__(self, *args) }
+  end unless method_defined?(:to_proc)
+end
+
 class Hash #:nodoc:
    # Taken from Rails, with appreciation to DHH
    def stringify_keys

data/lib/scribddoc.rb

@@ -99,16 +99,16 @@ module Scribd
       end
       
       # Make a request form
-      fields = Hash.new
+      fields = @attributes.dup
       if @attributes[:file] then
+        fields.delete :file
         ext = @attributes[:file].split('.').last unless @attributes[:file].index('.').nil?
-        fields[:doc_type] = @attributes[:type]
+        fields[:doc_type] = fields.delete(:type)
         fields[:doc_type] ||= ext
         fields[:doc_type].downcase! if fields[:doc_type]
-        fields[:rev_id] = @attributes[:doc_id]
-        fields[:access] = @attributes[:access]
+        fields[:rev_id] = fields.delete(:doc_id)
       end
-      fields[:session_key] = @attributes[:owner].session_key if @attributes[:owner]
+      fields[:session_key] = fields.delete(:owner).session_key if fields[:owner]
       response = nil
       
       if @attributes[:file] then
@@ -166,7 +166,7 @@ module Scribd
       raise ArgumentError, "options must be a hash" unless options.kind_of? Hash
       
       docs_by_user = docs.inject(Hash.new { |hash, key| hash[key] = Array.new }) { |hash, doc| hash[doc.owner] << doc; hash }
-      docs_by_user.each { |user, doc_list| API.instance.send_request 'docs.changeSettings', options.merge(:doc_ids => doc_list.collect { |doc| doc.id }.join(','), :session_key => user.session_key) }
+      docs_by_user.each { |user, doc_list| API.instance.send_request 'docs.changeSettings', options.merge(:doc_ids => doc_list.collect(&:id).join(','), :session_key => user.session_key) }
     end
     
     # === Finding by query
@@ -221,10 +221,8 @@ module Scribd
       end
     end
     
-    # Synonym for create.
-    
-    def self.upload(options={})
-      create options
+    class << self
+      alias_method :upload, :create
     end
     
     # Returns the conversion status of this document. When a document is

data/lib/scribdresource.rb

@@ -93,10 +93,10 @@ module Scribd
     # ignored.
     
     def read_attributes(attributes)
-      raise ArgumentError, "Attributes must be listed in an Enumeration" unless attributes.kind_of? Enumeration
+      raise ArgumentError, "Attributes must be listed in an Enumeration" unless attributes.kind_of?(Enumerable)
       raise ArgumentError, "All attributes must respond to to_sym" unless attributes.all? { |a| a.respond_to? :to_sym }
       keys = attributes.map(&:to_sym)
-      values = @attributes.values_at keys
+      values = @attributes.values_at(*keys)
       keys.zip(values).to_hsh
     end
     

data/lib/scribduser.rb

@@ -85,6 +85,7 @@ module Scribd
     # Scribd::Document.find.
     
     def find_documents(options)
+      return nil unless @attributes[:session_key]
       Document.find options.merge(:scope => 'user', :session_key => @attributes[:session_key])
     end
     
@@ -92,6 +93,7 @@ module Scribd
     # belong to this user.
     
     def find_document(document_id)
+      return nil unless @attributes[:session_key]
       response = API.instance.send_request('docs.getSettings', { :doc_id => document_id, :session_key => @attributes[:session_key] })
       Document.new :xml => response.elements['/rsp'], :owner => self
     end
@@ -107,13 +109,12 @@ module Scribd
     # Scribd::Document.save method.
     
     def upload(options)
-     Document.create options.merge(:owner => self)
+      raise NotReadyError, "User hasn't been created yet" unless created?
+      Document.create options.merge(:owner => self)
     end
     
-    # Synonym for create.
-    
-    def self.signup(options={})
-      create options
+    class << self
+      alias_method :signup, :create
     end
     
     # Logs into Scribd using the given username and password. This user will be

data/sample/01_upload.rb

@@ -4,44 +4,18 @@ require 'rubygems'
 require 'rscribd'
 
 # Use your API key / secret here
-api_key = ''
-api_secret = ''
+api_key = '4lj2rs4duuv4013y2qbw3'
+api_secret = 'sec-twkc39qf22dmplhy3j4flvzet'
  
 # Create a scribd object
 Scribd::API.instance.key = api_key
 Scribd::API.instance.secret = api_secret
-#Scribd::API.instance.debug = true
+Scribd::API.instance.debug = true
 
 begin
-  Scribd::User.login 'LOGIN', 'PASSWORD'
-  # Upload the document from a file
-  print "Uploading a document ... "
-
-  doc = Scribd::Document.upload(:file => 'test.txt')
-  puts "Done doc_id=#{doc.id}, doc_access_key=#{doc.access_key}"
-
-  # Poll API until conversion is complete
-  while (doc.conversion_status == 'PROCESSING')
-    puts "Document conversion is processing"
-    sleep(2) # Very important to sleep to prevent a runaway loop that will get your app blocked
-  end
-  puts "Document conversion is complete"
-
-  # Edit various options of the document
-  # Note you can also edit options before your doc is done converting
-  doc.title = 'This is a test doc!'
-  doc.description = "I'm testing out the Scribd API!"
-  doc.access = 'private'
-  doc.language = 'en'
-  doc.license = 'c'
-  doc.tags = 'test,api'
-  doc.show_ads = true
+  Scribd::User.login 'riscfuture2', 'felicia'
+  doc = Scribd::Document.new :file => 'sample/test.txt', :flooza => 'booza'
   doc.save
-
-  # Delete the uploaded document
-  print "Deleting a document ... "
-  doc.destroy
-  puts "Done doc_id=#{doc.id}"
 rescue Scribd::ResponseError => e
   puts "failed code=#{e.code} error='#{e.message}'"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: rscribd
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 1.0.1
 platform: ruby
 authors: 
-- Jared Friedman
+- Jared Friedman, Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-11-26 00:00:00 -08:00
+date: 2009-03-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,9 +30,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 1.9.0
     version: 
-description: "== DESCRIPTION:  This gem provides a simple and powerful library for the Scribd API, allowing you to write Ruby applications or Ruby on Rails websites that upload, convert, display, search, and control documents in many formats. For more information on the Scribd platform, visit http://www.scribd.com/publisher  == FEATURES:  * Upload your documents to Scribd's servers and access them using the gem * Upload local files or from remote web sites * Search, tag, and organize documents * Associate documents with your users' accounts"
+description: This gem provides a simple and powerful library for the Scribd API, allowing you to write Ruby applications or Ruby on Rails websites that upload, convert, display, search, and control documents in many formats. For more information on the Scribd platform, visit http://www.scribd.com/publisher
 email: api@scribd.com
 executables: []