rscribd 1.0.3 → 1.0.4

data/spec/error_spec.rb

@@ -0,0 +1,12 @@
+old_dir = Dir.getwd
+Dir.chdir(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rscribd'
+
+describe Scribd::ResponseError do
+  it "should set the code attribute on initialization" do
+    error = Scribd::ResponseError.new(123)
+    error.code.should eql(123)
+  end
+end
+
+Dir.chdir old_dir

data/spec/resource_spec.rb

@@ -0,0 +1,126 @@
+old_dir = Dir.getwd
+Dir.chdir(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rscribd'
+
+describe Scribd::Resource do
+  describe "initialized from attributes" do
+    before :each do
+      @resource = Scribd::Resource.new
+    end
+    
+    it "should be unsaved" do
+      @resource.should_not be_saved
+    end
+    
+    it "should be uncreated" do
+      @resource.should_not be_created
+    end
+  end
+  
+  describe ".save" do
+    it "should create a new instance and save it and return it" do
+      resource = mock('Scribd::Resource resource')
+      resource.should_receive(:save).once
+      Scribd::Resource.stub!(:new).and_return(resource)
+      Scribd::Resource.create.should eql(resource)
+    end
+  end
+  
+  it "should not implement save" do
+    lambda { Scribd::Resource.new.save }.should raise_error(NotImplementedError)
+  end
+  
+  it "should not implement find" do
+    lambda { Scribd::Resource.find(1) }.should raise_error(NotImplementedError)
+  end
+  
+  it "should not implement destroy" do
+    lambda { Scribd::Resource.new.destroy }.should raise_error(NotImplementedError)
+  end
+  
+  it "should implement saved?" do
+    resource = Scribd::Resource.new
+    resource.instance_variable_set(:@saved, true)
+    resource.should be_saved
+  end
+  
+  it "should implement created?" do
+    resource = Scribd::Resource.new
+    resource.instance_variable_set(:@created, true)
+    resource.should be_created
+  end
+  
+  describe "with attributes" do
+    before :each do
+      @resource = Scribd::Resource.new
+      @resource.instance_variable_set(:@attributes, { :access => 'private', :owner => 'me!', :warp => 9 })
+    end
+    
+    describe "read_attribute method" do
+      it "should raise ArgumentError if the attribute name cannot be converted to a symbol" do
+        attr_name = mock('attr_name')
+        lambda { @resource.read_attribute attr_name }.should raise_error(ArgumentError)
+      end
+      
+      it "should return the attribute value for valid attributes" do
+        @resource.read_attribute(:access).should eql('private')
+      end
+    end
+    
+    describe "read_attributes method" do
+      it "should raise ArgumentError if a list is not provided" do
+        lambda { @resource.read_attributes nil }.should raise_error(ArgumentError)
+      end
+      
+      it "should raise ArgumentError if any attribute name cannot be converted to a symbol" do
+        attr_name = mock('attr_name')
+        lambda { @resource.read_attributes [ attr_name, :test ] }.should raise_error(ArgumentError)
+      end
+      
+      it "should return the values of the given attribute names" do
+        @resource.read_attributes([ :access, :owner ]).should == { :access => 'private', :owner => 'me!' }
+      end
+      
+      it "should convert all keys to symbols" do
+        @resource.read_attributes([ 'access' ]).should == { :access => 'private' }
+      end
+    end
+    
+    describe "write_attributes method" do
+      it "should raise ArgumentError if a hash is not provided" do
+        lambda { @resource.write_attributes nil }.should raise_error(ArgumentError)
+      end
+      
+      it "should raise ArgumentError if any attribute name cannot be converted to a symbol" do
+        attr_name = mock('attr_name')
+        lambda { @resource.write_attributes attr_name => 1, :test => 2 }.should raise_error(ArgumentError)
+      end
+      
+      it "should set the values of the given attribute names" do
+        @resource.write_attributes(:access => 'public', :owner => 'you')
+        @resource.access.should eql('public')
+        @resource.owner.should eql('you')
+      end
+      
+      it "should convert all keys to symbols" do
+        @resource.write_attributes('access' => 'public')
+        @resource.access.should eql('public')
+      end
+      
+      it "should not call save" do
+        @resource.should_not_receive(:save)
+        @resource.write_attributes 'access' => 'public'
+      end
+    end
+    
+    it "should create getters for each attribute" do
+      lambda { @resource.warp }.should_not raise_error(NoMethodError)
+    end
+    
+    it "should create setters for each attribute" do
+      lambda { @resource.warp = 5 }.should_not raise_error(NoMethodError)
+    end
+  end
+end
+
+Dir.chdir old_dir

data/spec/rscribd_spec.rb

@@ -0,0 +1,35 @@
+old_dir = Dir.getwd
+Dir.chdir(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rscribd'
+
+describe Symbol do
+  it "should define a to_proc method" do
+    Symbol.instance_methods.map { |meth| meth.to_sym }.should include(:to_proc)
+  end
+  
+  it "... that returns a Proc" do
+    :to_s.to_proc.should be_kind_of(Proc)
+  end
+end
+
+describe Hash do
+  it "should define a stringify_keys method" do
+    Hash.instance_methods.map(&:to_sym).should include(:stringify_keys)
+  end
+  
+  it "... that converts hash keys into strings" do
+    { :a => :b, 1 => 3 }.stringify_keys.should == { 'a' => :b, '1' => 3 }
+  end
+end
+
+describe Array do
+  it "should define a to_hsh method" do
+    Array.instance_methods.map(&:to_sym).should include(:to_hsh)
+  end
+  
+  it "... that converts nested arrays into a hash" do
+    [ [ 1, 2], [3, 4] ].to_hsh.should == { 1 => 2, 3 => 4 }
+  end
+end
+
+Dir.chdir old_dir

data/spec/user_spec.rb

@@ -0,0 +1,195 @@
+old_dir = Dir.getwd
+Dir.chdir(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rscribd'
+
+describe Scribd::User do
+  describe "initialized from attributes" do
+    before :each do
+      @user = Scribd::User.new(:username => 'sancho', :name => 'Sancho Sample')
+    end
+    
+    it "should have its attributes set appropriately" do
+      @user.username.should eql('sancho')
+      @user.name.should eql('Sancho Sample')
+    end
+    
+    it "should be unsaved" do
+      @user.should_not be_saved
+    end
+    
+    it "should be uncreated" do
+      @user.should_not be_created
+    end
+  end
+  
+  describe "initialized from XML" do
+    before :each do
+      @user = Scribd::User.new(:xml => REXML::Document.new("<rsp stat='ok'><username>sancho</username><name>Sancho Sample</name></rsp>").root)
+    end
+    
+    it "should have its attributes set appropriately" do
+      @user.username.should eql('sancho')
+      @user.name.should eql('Sancho Sample')
+    end
+    
+    it "should be saved" do
+      @user.should be_saved
+    end
+    
+    it "should be created" do
+      @user.should be_created
+    end
+  end
+  
+  describe "existing user" 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)
+    end
+    
+    it "should return the user_id for the id method" do
+      @user.id.should eql(225)
+    end
+    
+    it "should return the username for the to_s method" do
+      @user.to_s.should eql(@user.username)
+    end
+    
+    it "should not be saveable" do
+      lambda { @user.save }.should raise_error(NotImplementedError)
+    end
+    
+    describe "documents method" do
+      before :each do
+        @xml = REXML::Document.new("<rsp stat='ok'><resultset><result><doc_id type='integer'>123</doc_id></result><result><doc_id type='integer'>234</doc_id></result></resultset></rsp>")
+      end
+      
+      it "should docs.getList with the session key" do
+        Scribd::API.instance.should_receive(:send_request).once.with('docs.getList', { :session_key => 'some key' }).and_return(@xml)
+        @user.documents
+      end
+
+      it "should docs.getList with an offset" do
+        Scribd::API.instance.should_receive(:send_request).once.with('docs.getList', { :session_key => 'some key', :offset => 1 }).and_return(@xml)
+        @user.documents(:offset => 1)
+      end
+
+      it "should docs.getList with a limit" do
+        Scribd::API.instance.should_receive(:send_request).once.with('docs.getList', { :session_key => 'some key', :limit => 1 }).and_return(@xml)
+        @user.documents(:limit => 1)
+      end
+      
+      it "should return an array of received documents with the owner of each set to this user" do
+        Scribd::API.instance.stub!(:send_request).and_return(@xml)
+        docs = @user.documents
+        docs.should be_kind_of(Array)
+        docs.should have(2).items
+        docs.first.id.should eql(123)
+        docs.last.id.should eql(234)
+        docs.each do |doc|
+          doc.should be_kind_of(Scribd::Document)
+          doc.owner.should eql(@user)
+        end
+      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'))
+        @user.find_documents(:query => 'hi!')
+      end
+      
+      it "should pass all options to the Document.find method" do
+        Scribd::Document.should_receive(:find).once.with(hash_including(:foo => 'bar'))
+        @user.find_documents(:foo => 'bar')
+      end
+    end
+    
+    describe "find_document method" do
+      before :each do
+        @xml = REXML::Document.new("<rsp stat='ok'><doc_id type='integer'>123</doc_id></rsp>")
+      end
+      
+      it "should call docs.getSettings with the appropriate doc_id and session key" do
+        Scribd::API.instance.should_receive(:send_request).once.with('docs.getSettings', { :doc_id => 123, :session_key => 'some key' }).and_return(@xml)
+        @user.find_document(123)
+      end
+      
+      it "should return an appropriate Document with the owner set" do
+        Scribd::API.instance.stub!(:send_request).and_return(@xml)
+        doc = @user.find_document(123)
+        doc.should be_kind_of(Scribd::Document)
+        doc.id.should eql(123)
+        doc.owner.should eql(@user)
+      end
+    end
+    
+    it "should have an upload method that calls Document.create" do
+      Scribd::Document.should_receive(:create).once.with(:file => 'test', :owner => @user)
+      @user.upload(:file => 'test')
+    end
+  end
+  
+  describe "new user" do
+    before :each do
+      @user = Scribd::User.new(:login => 'sancho', :name => 'Sancho Sample')
+      @xml = REXML::Document.new("<rsp stat='ok'><newattr>newval</newattr></rsp>")
+    end
+    
+    describe "save method" do
+      it "should call user.signup with the user's attributes" do
+        Scribd::API.instance.should_receive(:send_request).once.with('user.signup', { :login => 'sancho', :name => 'Sancho Sample' }).and_return(@xml)
+        @user.save
+      end
+      
+      it "should set any new attributes in the response" do
+        Scribd::API.instance.stub!(:send_request).and_return(@xml)
+        @user.save
+        @user.newattr.should eql('newval')
+      end
+      
+      it "should set the API user to this user" do
+        Scribd::API.instance.stub!(:send_request).and_return(@xml)
+        @user.save
+        Scribd::API.instance.user.should eql(@user)
+      end
+    end
+    
+    it "should return nil for find_documents" do
+      @user.find_documents(:query => 'test').should be_nil
+    end
+    
+    it "should return nil for find_document" do
+      @user.find_document(123).should be_nil
+    end
+    
+    it "should not allow calls to upload" do
+      lambda { @user.upload(:file => 'test') }.should raise_error(Scribd::NotReadyError)
+    end
+  end
+  
+  describe ".username" do
+    before :each do
+      @xml = REXML::Document.new("<rsp stat='ok'><username>sancho</username><name>Sancho Sample</name></rsp>")
+    end
+    
+    it "should call user.username with the username and password" do
+      Scribd::API.instance.should_receive(:send_request).once.with('user.login', { :username => 'user', :password => 'pass' }).and_return(@xml)
+      Scribd::User.login 'user', 'pass'
+    end
+    
+    it "should create a new user from the resulting XML" do
+      Scribd::API.instance.stub!(:send_request).and_return(@xml)
+      user = Scribd::User.login('user', 'pass')
+      user.username.should eql('sancho')
+      user.name.should eql('Sancho Sample')
+    end
+    
+    it "should set the API user" do
+      Scribd::API.instance.stub!(:send_request).and_return(@xml)
+      user = Scribd::User.login('user', 'pass')
+      Scribd::API.instance.user.should eql(user)
+    end
+  end
+end
+
+Dir.chdir old_dir

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification 
 name: rscribd
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
-- Jared Friedman, Tim Morgan
+- Tim Morgan
+- Jared Friedman
+- Mike Watts
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-07-13 00:00:00 -07:00
+date: 2010-02-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,58 +20,58 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rspec
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.2
+        version: "0"
     version: 
-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
+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: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
 - README.txt
-- sample/test.txt
 files: 
+- .gitignore
 - History.txt
 - Manifest.txt
 - README.txt
 - Rakefile
+- VERSION
+- lib/rscribd.rb
 - 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
+- spec/api_spec.rb
+- spec/document_spec.rb
+- spec/error_spec.rb
+- spec/resource_spec.rb
+- spec/rscribd_spec.rb
+- spec/user_spec.rb
 has_rdoc: true
-homepage: 
+homepage: http://www.scribd.com/developers
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -86,10 +88,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: rscribd
-rubygems_version: 1.3.4
+rubyforge_project: 
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Ruby client library for the Scribd API
-test_files: []
-
+test_files: 
+- spec/api_spec.rb
+- spec/document_spec.rb
+- spec/error_spec.rb
+- spec/resource_spec.rb
+- spec/rscribd_spec.rb
+- spec/user_spec.rb