rscribd 1.1.0 → 1.2.0

data/spec/security_spec.rb

@@ -0,0 +1,118 @@
+describe Scribd::Security do
+  before :each do
+    @document = Scribd::Document.new(:xml => REXML::Document.new('<result><doc_id>123</doc_id></result>').root)
+    @ident_list = REXML::Document.new(<<-EOF
+      <?xml version="1.0" encoding="UTF-8"?>
+      <rsp stat="ok">
+        <resultset list="true">
+          <result>
+            <user_identifier>leila83</user_identifier>
+          </result>
+          <result>
+            <user_identifier>spikyhairdude</user_identifier>
+          </result>
+        </resultset>
+      </rsp>
+      EOF
+    ).root
+    @doc_list = REXML::Document.new(<<-EOF
+      <?xml version="1.0" encoding="UTF-8"?>
+      <rsp stat="ok">
+        <resultset list="true">
+          <result>
+            <doc_id>244565</doc_id>
+            <title>&lt;![CDATA[Ruby on Java]]&gt;</title>
+            <description>&lt;![CDATA[Ruby On Java, Barcamp, Washington DC]]&gt;</description>
+            <access_key>key-t3q5qujoj525yun8gf7</access_key>
+            <conversion_status>DONE</conversion_status>
+            <page_count>10</page_count>
+          </result>
+          <result>
+            <doc_id>244567</doc_id>
+            <title>&lt;![CDATA[Ruby on Java Part II]]&gt;</title>
+            <description>&lt;![CDATA[Ruby On Java Part II, Barcamp, Washington DC]]&gt;</description>
+            <access_key>key-2b3udhalycthsm91d1ps</access_key>
+            <conversion_status>DONE</conversion_status>
+            <page_count>12</page_count>
+          </result>
+        </resultset>
+      </rsp>
+    EOF
+    ).root
+  end
+  
+  describe :grant_access do
+    it "should call set_access" do
+      Scribd::Security.should_receive(:set_access).once.with('foo', true, @document)
+      Scribd::Security.grant_access('foo', @document)
+    end
+  end
+  
+  describe :revoke_access do
+    it "should call set_access" do
+      Scribd::Security.should_receive(:set_access).once.with('foo', false, @document)
+      Scribd::Security.revoke_access('foo', @document)
+    end
+  end
+  
+  describe :set_access do
+    it "should make an API call to security.setAccess (nil document, access_allowed = 1)" do
+      Scribd::API.instance.should_receive(:send_request).once.with('security.setAccess', :user_identifier => 'foo', :allowed => 1)
+      Scribd::Security.set_access 'foo', true
+    end
+    
+    it "should set the doc_id when given a Scribd::Document" do
+      Scribd::API.instance.should_receive(:send_request).once.with('security.setAccess', :user_identifier => 'foo', :allowed => 1, :doc_id => '123')
+      Scribd::Security.set_access 'foo', true, @document
+    end
+    
+    it "should set the doc_id when given a number" do
+      Scribd::API.instance.should_receive(:send_request).once.with('security.setAccess', :user_identifier => 'foo', :allowed => 1, :doc_id => 123)
+      Scribd::Security.set_access 'foo', true, 123
+    end
+    
+    it "should raise ArgumentError when given anything else" do
+      lambda { Scribd::Security.set_access 'foo', true, Object.new }.should raise_error(ArgumentError)
+    end
+    
+    it "should set allowed to 0 when given false" do
+      Scribd::API.instance.should_receive(:send_request).once.with('security.setAccess', :user_identifier => 'foo', :allowed => 0)
+      Scribd::Security.set_access 'foo', false
+    end
+  end
+  
+  describe :document_access_list do
+    it "should make an API call to security.getDocumentAccessList with the document ID" do
+      Scribd::API.instance.should_receive(:send_request).once.with('security.getDocumentAccessList', :doc_id => '123').and_return(@ident_list)
+      Scribd::Security.document_access_list(@document)
+    end
+    
+    it "should accept ID numbers" do
+      Scribd::API.instance.should_receive(:send_request).once.with('security.getDocumentAccessList', :doc_id => 123).and_return(@ident_list)
+      Scribd::Security.document_access_list(123)
+    end
+    
+    it "should return an array of identifiers" do
+      Scribd::API.instance.stub!(:send_request).and_return(@ident_list)
+      idents = Scribd::Security.document_access_list(@document)
+      idents.should == %w( leila83 spikyhairdude )
+    end
+  end
+  
+  describe :user_access_list do
+    it "should make an API call to security.getUserAccessList with the document ID" do
+      Scribd::API.instance.should_receive(:send_request).once.with('security.getUserAccessList', :user_identifier => '123').and_return(@doc_list)
+      Scribd::Security.user_access_list('123')
+    end
+    
+    it "should return an array of documents" do
+      Scribd::API.instance.stub!(:send_request).and_return(@doc_list)
+      docs = Scribd::Security.user_access_list('123')
+      docs.should be_kind_of(Array)
+      docs.size.should eql(2)
+      docs.each do |doc|
+        doc.should be_kind_of(Scribd::Document)
+      end
+    end
+  end
+end

data/spec/user_spec.rb

@@ -92,6 +92,67 @@ describe Scribd::User do
       end
     end
     
+    describe "#collections" do
+      before :each do
+        @user = Scribd::User.new(:xml => REXML::Document.new("<rsp stat='ok'><user_id type='integer'>225</user_id><username>sancho</username><name>Sancho Sample</name><session_key>some key</session_key></rsp>").root)
+        @response = <<-EOF
+          <?xml version="1.0" encoding="UTF-8"?>
+          <rsp stat="ok">
+            <resultset list="true">
+              <result>
+                <collection_id>61</collection_id>
+                <collection_name>My Collection</collection_name>
+                <doc_count>5</doc_count>
+              </result>
+              <result>
+                <collection_id>62</collection_id>
+                <collection_name>My Other Collection</collection_name>
+                <doc_count>1</doc_count>
+              </result>
+            </resultset>
+          </rsp>
+        EOF
+      end
+      
+      it "should raise NotReadyError for new users" do
+        user = Scribd::User.new
+        lambda { user.collections }.should raise_error(Scribd::NotReadyError)
+      end
+      
+      it "should call the docs.getCollections API method" do
+        Scribd::API.instance.should_receive(:send_request).once.with('docs.getCollections', :session_key => 'some key').and_return(REXML::Document.new(@response))
+        @user.collections
+      end
+      
+      it "should pass options to the API method" do
+        Scribd::API.instance.should_receive(:send_request).once.with('docs.getCollections', :session_key => 'some key', :other => 'option').and_return(REXML::Document.new(@response))
+        @user.collections(:other => 'option')
+      end
+      
+      it "should return an array of collections" do
+        Scribd::API.instance.should_receive(:send_request).once.with('docs.getCollections', an_instance_of(Hash)).and_return(REXML::Document.new(@response))
+        list = @user.collections
+        list.should be_kind_of(Array)
+        list.size.should eql(2)
+        
+        list.first.should be_kind_of(Scribd::Collection)
+        list.first.collection_id.should eql('61')
+        list.first.collection_name.should eql('My Collection')
+        list.first.doc_count.should eql('5')
+        
+        list.last.should be_kind_of(Scribd::Collection)
+        list.last.collection_id.should eql('62')
+        list.last.collection_name.should eql('My Other Collection')
+        list.last.doc_count.should eql('1')
+      end
+      
+      it "should set each collection's owner" do
+        Scribd::API.instance.should_receive(:send_request).once.with('docs.getCollections', an_instance_of(Hash)).and_return(REXML::Document.new(@response))
+        list = @user.collections
+        list.each { |coll| coll.owner.should eql(@user) }
+      end
+    end
+    
     describe "find_documents method" do
       it "should call Document.find with an appropriate scope and session key" do
         Scribd::Document.should_receive(:find).once.with(hash_including(:scope => 'user', :session_key => 'some key'))
@@ -167,6 +228,33 @@ describe Scribd::User do
     end
   end
   
+  describe "#auto_sign_in_url" do
+    before :each do
+      @response = REXML::Document.new('<rsp><url><![CDATA[hello]]></url></rsp>').root
+    end
+    
+    subject { Scribd::User.new(:xml => REXML::Document.new("<rsp stat='ok'><user_id type='integer'>225</user_id><username>sancho</username><name>Sancho Sample</name><session_key>some key</session_key></rsp>").root) }
+    
+    it "should raise NotReadyError if the user isn't saved" do
+      lambda { Scribd::User.new.auto_sign_in_url }.should raise_error(Scribd::NotReadyError)
+    end
+    
+    it "should call the API method user.getAutoSignInUrl" do
+      Scribd::API.instance.should_receive(:send_request).once.with('user.getAutoSignInUrl', :session_key => 'some key', :next_url => 'foobar').and_return(@response)
+      subject.auto_sign_in_url('foobar')
+    end
+    
+    it "should set next_url to a blank string by default" do
+      Scribd::API.instance.should_receive(:send_request).once.with('user.getAutoSignInUrl', :session_key => 'some key', :next_url => '').and_return(@response)
+      subject.auto_sign_in_url
+    end
+    
+    it "should return the URL returned by the API" do
+      Scribd::API.instance.stub!(:send_request).and_return(@response)
+      subject.auto_sign_in_url.should eql('hello')
+    end
+  end
+  
   describe ".username" do
     before :each do
       @xml = REXML::Document.new("<rsp stat='ok'><username>sancho</username><name>Sancho Sample</name></rsp>")

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Tim Morgan
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 -07:00
+date: 2010-05-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,18 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 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: []
@@ -50,28 +62,36 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README
 files: 
 - .gitignore
 - History.txt
-- README.txt
+- README
 - Rakefile
 - VERSION
 - lib/rscribd.rb
-- lib/scribdapi.rb
-- lib/scribddoc.rb
-- lib/scribderrors.rb
-- lib/scribdmultiparthack.rb
-- lib/scribdresource.rb
-- lib/scribduser.rb
+- lib/scribd/api.rb
+- lib/scribd/category.rb
+- lib/scribd/collection.rb
+- lib/scribd/document.rb
+- lib/scribd/errors.rb
+- lib/scribd/resource.rb
+- lib/scribd/security.rb
+- lib/scribd/user.rb
+- lib/support/extensions.rb
+- lib/support/multipart_hack.rb
+- rscribd.gemspec
 - sample/01_upload.rb
 - sample/02_user.rb
 - sample/test.txt
 - spec/api_spec.rb
+- spec/category_spec.rb
+- spec/collection_spec.rb
 - spec/document_spec.rb
 - spec/error_spec.rb
 - spec/resource_spec.rb
 - spec/rscribd_spec.rb
+- spec/security_spec.rb
 - spec/user_spec.rb
 has_rdoc: true
 homepage: http://www.scribd.com/developers
@@ -98,15 +118,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: rscribd
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby client library for the Scribd API
 test_files: 
 - spec/api_spec.rb
+- spec/category_spec.rb
+- spec/collection_spec.rb
 - spec/document_spec.rb
 - spec/error_spec.rb
 - spec/resource_spec.rb
 - spec/rscribd_spec.rb
+- spec/security_spec.rb
 - spec/user_spec.rb

data/lib/scribduser.rb

@@ -1,145 +0,0 @@
-module Scribd
-  
-  # A user of the Scribd website. API programs can use this class to log in as a
-  # Scribd user, create new user accounts, and get information about the current
-  # user.
-  #
-  # An API program begins by logging into Scribd:
-  #
-  #  user = Scribd::User.login 'login', 'pass'
-  #
-  # You can now access information about this user through direct method calls:
-  #
-  #  user.name #=> 'Real Name'
-  #
-  # If, at any time, you would like to retrieve the Scribd::User instance for
-  # the currently logged-in user, simply call:
-  #
-  #  user = Scribd::API.instance.user
-  #
-  # For information on a user's attributes, please consult the online API
-  # 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:
-  #
-  #  user = Scribd::User.signup :username => 'testuser', :password => 'testpassword', :email => your@email.com
-  
-  class User < Resource
-    
-    # Creates a new, unsaved user with the given attributes. You can eventually
-    # use this record to create a new Scribd account.
-    
-    def initialize(options={})
-      super
-      if options[:xml] then
-        load_attributes(options[:xml])
-        @saved = true
-        @created = true
-      else
-        @attributes = options
-      end
-    end
-    
-    # For new, unsaved records, creates a new Scribd user with the provided
-    # attributes, then logs in as that user. Currently modification of existing
-    # Scribd users is not supported. Throws a ResponseError if a remote error
-    # occurs.
-    
-    def save
-      if not created? then
-        response = API.instance.send_request('user.signup', @attributes)
-        xml = response.get_elements('/rsp')[0]
-        load_attributes(xml)
-        API.instance.user = self
-      else
-        raise NotImplementedError, "Cannot update a user once that user's been saved"
-      end
-    end
-    
-    # Returns a list of documents owned by this user. By default, the size of the returned
-    # list is capped at 1000. Use the :limit and :offset parameters to page through this
-    # user's documents, however :limit cannot be greater than 1000. This list is _not_
-    # backed by the server, so if you add or remove items from it, it will not
-    # make those changes server-side. This also has some tricky consequences
-    # when modifying a list of documents while iterating over it:
-    #
-    #  docs = user.documents
-    #  docs.each(&:destroy)
-    #  docs #=> Still populated, because it hasn't been updated
-    #  docs = user.documents #=> Now it's empty
-    #
-    # 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/developers/api?method_name=docs.getSettings
-    
-    def documents(options = {})
-      response = API.instance.send_request('docs.getList', options.merge(:session_key => @attributes[:session_key]))
-      documents = Array.new
-      response.elements['/rsp/resultset'].elements.each do |doc|
-        documents << Document.new(:xml => doc, :owner => self)
-      end
-      return documents
-    end
-    
-    # Finds documents owned by this user matching a given query. The parameters
-    # provided to this method are identical to those provided to
-    # 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
-    
-    # Loads a Scribd::Document by ID. You can only load such documents if they 
-    # 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
-    
-    # Uploads a document to a user's document list. This method takes the
-    # following options:
-    #
-    # +file+:: The location of a file on disk or the URL to a file on the Web
-    # +type+:: The file's type (e.g., "txt" or "ppt"). Optional if the file has
-    #          an extension (like "file.txt").
-    #
-    # There are other options you can specify. For more information, see the
-    # Scribd::Document.save method.
-    
-    def upload(options)
-      raise NotReadyError, "User hasn't been created yet" unless created?
-      Document.create options.merge(:owner => self)
-    end
-    
-    class << self
-      alias_method :signup, :create
-    end
-    
-    # Logs into Scribd using the given username and password. This user will be
-    # used for all subsequent Scribd API calls. You must log in before you can
-    # use protected API functions. Returns the Scribd::User instance for the
-    # logged in user.
-    
-    def self.login(username, password)
-      response = API.instance.send_request('user.login', { :username => username, :password => password })
-      xml = response.get_elements('/rsp')[0]
-      user = User.new(:xml => xml)
-      API.instance.user = user
-      return user
-    end
-    
-    # Returns the +user_id+ attribute.
-    
-    def id
-      self.user_id
-    end
-    
-    def to_s #:nodoc:
-      @attributes[:username]
-    end
-  end
-end