rscribd 1.0.4 → 1.1.0

data/.gitignore

@@ -1,5 +1,4 @@
 doc
-*.gemspec
 pkg
 .idea
 .DS_Store

data/History.txt

@@ -1,3 +1,11 @@
+=== 1.1.0 / 2010-3-16
+
+* Switched from Hoe to Jeweler.
+* Added support for docs.browse and docs.featured.
+* Added support for docs.getStats call to fetch document read count.
+* Fixed bug where access parameter wasn't sent in docs.changeSettings call.
+* Fixed Windows binary file upload issue.
+
 === 1.0.4 / 2009-7-24
 
 * Offset and limit parameters can now be used when fetching user documents.

data/README.txt

@@ -1,6 +1,6 @@
 = rscribd
 
-* 1.0.3 (July 13, 2009)
+* 1.1.0 (March 16, 2010)
 
 == DESCRIPTION:
 
@@ -25,7 +25,7 @@ storage system to store your documents in accessible manner. Scribd's ad system
 will help you monetize your documents easily.
 
 First, you'll need to get a Scribd API account. Visit
-http://www.scribd.com/publisher/api to apply for a platform account.
+http://www.scribd.com/developers/api to apply for a platform account.
 
 On the Platform site you will be given an API key and secret. The API object
 will need these to authenticate you:

data/Rakefile

@@ -14,6 +14,7 @@ begin
     gemspec.add_dependency 'mime-types'
     gemspec.add_development_dependency "rspec"
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.1.0

data/lib/scribddoc.rb

@@ -26,7 +26,7 @@ module Scribd
   # Aside from these two attributes, you can set other attributes that affect
   # how the file is displayed on Scribd. See the API documentation online for a
   # list of attributes, at
-  # http://www.scribd.com/publisher/api?method_name=docs.search (consult the
+  # http://www.scribd.com/developers/api?method_name=docs.search (consult the
   # "Result explanation" section).
   #
   # These attributes can be accessed or changed directly
@@ -121,7 +121,7 @@ module Scribd
           fields[:url] = @attributes[:file]
           response = API.instance.send_request 'docs.uploadFromUrl', fields
         elsif uri.kind_of? URI::Generic or uri.nil? then
-          file_obj = is_file_object ? file : File.open(file, 'r')
+          file_obj = is_file_object ? file : File.open(file, 'rb')
           fields[:file] = file_obj
           response = API.instance.send_request 'docs.upload', fields
           file_obj.close unless is_file_object
@@ -177,7 +177,7 @@ module Scribd
     # their content. You must at a minimum supply a +query+ option, with a
     # string that will become the full-text search query. For a list of other
     # supported options, please see the online API documentation at
-    # http://www.scribd.com/publisher/api?method_name=docs.search
+    # http://www.scribd.com/developers/api?method_name=docs.search
     #
     # The scope can be any value given for the +scope+ parameter in the above
     # website, or <tt>:first</tt> to return the first result only (not an array
@@ -195,7 +195,7 @@ module Scribd
     #
     # Passing in simply a numerical ID loads the document with that ID. You can
     # pass additional options as defined at
-    # httphttp://www.scribd.com/publisher/api?method_name=docs.getSettings
+    # httphttp://www.scribd.com/developers/api?method_name=docs.getSettings
     #
     #  Scribd::Document.find(108196)
     #
@@ -222,11 +222,58 @@ module Scribd
         return scope == :first ? documents.first : documents
       end
     end
-    
+
+    # === Featured docs
+    #
+    # This method is called with a scope and a hash of options. For a list of
+    # supported options, please see the online API documentation at
+    # http://www.scribd.com/developers/api?method_name=docs.featured
+    #
+    # The scope can be either <tt>:first</tt> to return the first result only (not an array
+    # of results) or <tt>:all</tt> to return an array. Include a +scope+ option
+    # to control the parameter described in the API documentation.
+    #
+    #  Scribd::Document.featured(:all, :scope => 'hot', :limit => 10)
+    #
+    # Documents returned from this method will have their +owner+ attributes set
+    # to nil.
+
+    def self.featured(scope, options = {})
+      response = API.instance.send_request('docs.featured', options)
+      documents = []
+      response.elements['/rsp/result_set'].elements.each do |doc|
+        documents << Document.new(:xml => doc)
+      end
+      scope == :first ? documents.first : documents
+    end
+
+    # === Browse docs
+    #
+    # This method is called with a scope and a hash of options. For a list of
+    # supported options, please see the online API documentation at
+    # http://www.scribd.com/developers/api?method_name=docs.browse
+    #
+    # The scope can be either <tt>:first</tt> to return the first result only (not an array
+    # of results) or <tt>:all</tt> to return an array.
+    #
+    #  Scribd::Document.browse(:all, :sort => 'views', :category_id => 1, :limit => 10)
+    #
+    # Documents returned from this method will have their +owner+ attributes set
+    # to nil.
+
+    def self.browse(scope, options = {})
+      response = API.instance.send_request('docs.browse', options)
+      documents = []
+      response.elements['/rsp/result_set'].elements.each do |doc|
+        documents << Document.new(:xml => doc)
+      end
+      scope == :first ? documents.first : documents
+    end
+
     class << self
       alias_method :upload, :create
     end
-    
+
     # Returns the conversion status of this document. When a document is
     # uploaded it must be converted before it can be used. The conversion is
     # non-blocking; you can query this method to determine whether the document
@@ -234,7 +281,7 @@ module Scribd
     #
     # The conversion status is returned as a string. For a full list of
     # conversion statuses, see the online API documentation at
-    # http://www.scribd.com/publisher/api?method_name=docs.getConversionStatus
+    # http://www.scribd.com/developers/api?method_name=docs.getConversionStatus
     #
     # Unlike other properties of a document, this is retrieved from the server
     # every time it's queried.
@@ -277,7 +324,7 @@ module Scribd
     
     # Retrieves a document's download URL. You can provide a format for the
     # download. Valid formats are listed at
-    # http://www.scribd.com/publisher/api?method_name=docs.getDownloadUrl
+    # http://www.scribd.com/developers/api?method_name=docs.getDownloadUrl
     #
     # If you do not provide a format, the link will be for the document's
     # original format.

data/lib/scribduser.rb

@@ -18,7 +18,7 @@ module Scribd
   #  user = Scribd::API.instance.user
   #
   # For information on a user's attributes, please consult the online API
-  # documentation at http://www.scribd.com/publisher/api?method_name=user.login
+  # documentation at http://www.scribd.com/developers/api?method_name=user.login
   #
   # You can create a new account with the signup (a.k.a. create) method:
   #
@@ -71,7 +71,7 @@ module Scribd
     # Scribd::Document instances returned through this method have more
     # attributes than those returned by the Scribd::Document.find method. The
     # additional attributes are documented online at
-    # http://www.scribd.com/publisher/api?method_name=docs.getSettings
+    # http://www.scribd.com/developers/api?method_name=docs.getSettings
     
     def documents(options = {})
       response = API.instance.send_request('docs.getList', options.merge(:session_key => @attributes[:session_key]))

data/spec/document_spec.rb

@@ -442,9 +442,45 @@ describe Scribd::Document do
       end
     end
   end
-  
+
+  describe ".featured" do
+    before :each do
+      @xml = REXML::Document.new("<rsp stat='ok'><result_set><result><access_key>abc123</access_key></result><result><access_key>abc321</access_key></result></result_set></rsp>")
+    end
+
+    it "should set the scope field according the options" do
+      Scribd::API.instance.should_receive(:send_request).with('docs.featured', hash_including(:scope => 'hot')).and_return(@xml)
+      Scribd::Document.featured(:all, :scope => 'hot', :limit => 10)
+    end
+
+    it "should return first result if :first is provided" do
+      Scribd::API.instance.should_receive(:send_request).with('docs.featured', {}).and_return(@xml)
+      docs = Scribd::Document.featured(:first)
+      docs.should be_kind_of(Scribd::Document)
+      docs.access_key.should eql('abc123')
+    end
+  end
+
+  describe ".browse" do
+    before :each do
+      @xml = REXML::Document.new("<rsp stat='ok'><result_set><result><access_key>abc123</access_key></result><result><access_key>abc321</access_key></result></result_set></rsp>")
+    end
+
+    it "should not pass the scope parameter in the options" do
+      Scribd::API.instance.should_receive(:send_request).with('docs.browse', hash_including(:sort => 'views', :category_id => 1, :limit => 10)).and_return(@xml)
+      Scribd::Document.browse(:all, :sort => 'views', :category_id => 1, :limit => 10)
+    end
+
+    it "should return first result if :first is provided" do
+      Scribd::API.instance.should_receive(:send_request).with('docs.browse', {}).and_return(@xml)
+      docs = Scribd::Document.browse(:first)
+      docs.should be_kind_of(Scribd::Document)
+      docs.access_key.should eql('abc123')
+    end
+  end
+
   it "should have an upload synonym for the create method"
-  
+
   describe ".conversion_status" do
     before :each do
       @document = Scribd::Document.new(:xml => REXML::Document.new("<doc_id type='integer'>123</doc_id>"))

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rscribd
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Tim Morgan
@@ -11,29 +16,33 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-02 00:00:00 -08:00
+date: 2010-03-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mime-types
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 description: The official Ruby gem for the Scribd API. Scribd is a document-sharing website allowing people to upload and view documents online.
 email: api@scribd.com
 executables: []
@@ -45,7 +54,6 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - History.txt
-- Manifest.txt
 - README.txt
 - Rakefile
 - VERSION
@@ -78,18 +86,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby client library for the Scribd API

data/Manifest.txt

@@ -1,14 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-lib/scribdapi.rb
-lib/scribddoc.rb
-lib/scribderrors.rb
-lib/scribdmultiparthack.rb
-lib/scribdresource.rb
-lib/rscribd.rb
-lib/scribduser.rb
-sample/01_upload.rb
-sample/02_user.rb
-sample/test.txt