goodreads 0.2.1 → 0.2.2

data/spec/client_spec.rb

@@ -2,181 +2,295 @@ require 'spec_helper'
 require 'oauth'
 
 describe 'Client' do
-  before :each do
-    Goodreads.reset_configuration
-    @client = Goodreads::Client.new(:api_key => 'SECRET_KEY')
-  end
-  
-  it 'raises error on invalid config parameter' do
-    proc { Goodreads::Client.new(nil) }.
-      should raise_error ArgumentError, "Options hash required."
-      
-    proc { Goodreads::Client.new('foo') }.
-      should raise_error ArgumentError, "Options hash required."
-  end
+  let(:client)  { Goodreads::Client.new(:api_key => 'SECRET_KEY') }
+  before(:each) { Goodreads.reset_configuration }
 
-  it 'returns a book by isbn' do
-    stub_with_key_get('/book/isbn', {:isbn => '0307463745'}, 'book.xml')
-    
-    proc { @book = @client.book_by_isbn('0307463745') }.should_not raise_error
-    @book.respond_to?(:id).should == true
-    @book.respond_to?(:title).should == true
-  end
-  
-  it 'returns a book by goodreads id' do
-    stub_with_key_get('/book/show', {:id => '6732019'}, 'book.xml')
-    proc { @client.book('6732019') }.should_not raise_error
+  describe '#new' do
+    it 'requires an argument' do
+      expect { Goodreads::Client.new(nil) }.
+        to raise_error ArgumentError, "Options hash required."
+    end
+
+    it 'requires a hash argument' do
+      expect { Goodreads::Client.new('foo') }.
+        to raise_error ArgumentError, "Options hash required."
+    end
   end
-  
-  it 'returns a book by title' do
-    stub_with_key_get('/book/title', {:title => 'Rework'}, 'book.xml')
-    proc { @client.book_by_title('Rework') }.should_not raise_error
+
+  describe '#book_by_isbn' do
+    before { stub_with_key_get('/book/isbn', {:isbn => '0307463745'}, 'book.xml') }
+
+    it 'returns a book by isbn' do
+      book = client.book_by_isbn('0307463745')
+
+      book.should respond_to :id
+      book.should respond_to :title
+    end
+
+    context 'when book does not exist' do
+      before do
+        stub_request(:get, "http://www.goodreads.com/book/isbn?format=xml&isbn=123456789&key=SECRET_KEY").
+          to_return(:status => 404, :body => "", :headers => {}) 
+      end
+
+      it 'raises Goodreads::NotFound' do
+        expect { client.book_by_isbn('123456789') }.to raise_error Goodreads::NotFound
+      end
+    end
   end
-  
-  it 'raises Goodreads::NotFound if book was not found' do
-    stub_request(:get, "http://www.goodreads.com/book/isbn?format=xml&isbn=123456789&key=SECRET_KEY").
-      to_return(:status => 404, :body => "", :headers => {})
-         
-    proc { @client.book_by_isbn('123456789') }.should raise_error Goodreads::NotFound
+
+  describe '#search_books' do
+    before { stub_with_key_get('/search/index', {:q => 'Rework'}, 'search_books_by_name.xml') }
+
+    it 'returns book search results' do
+      result = client.search_books('Rework')
+
+      result.should be_a Hashie::Mash
+      result.should respond_to :query
+      result.should respond_to :total_results
+      result.should respond_to :results
+      result.results.should respond_to :work
+      result.query.should eq 'Rework'
+      result.results.work.size.should eq 3
+      result.results.work.first.id.should eq 6928276
+    end
   end
-  
-  it 'returns recent reviews' do
-    stub_with_key_get('/review/recent_reviews', {}, 'recent_reviews.xml')
-    
-    proc { @reviews = @client.recent_reviews }.should_not raise_error
-    @reviews.should be_an_instance_of Array
-    @reviews.size.should_not == 0
-    @reviews.each do |r|
-      r.respond_to?(:id).should == true
+
+  describe '#book' do
+    before { stub_with_key_get('/book/show', {:id => '6732019'}, 'book.xml') }
+
+    it 'returns a book by goodreads id' do
+      expect { client.book('6732019') }.not_to raise_error
     end
   end
-  
-  it 'returns only full reviewes' do
-    stub_with_key_get('/review/recent_reviews', {}, 'recent_reviews.xml')
-    
-    proc { @reviews = @client.recent_reviews(:skip_cropped => true) }.should_not raise_error
-    @reviews.should be_an_instance_of Array
-    @reviews.size.should_not == 0
-    @reviews.each do |r|
-      r.respond_to?(:id).should == true
+
+  describe '#book_by_title' do
+    before { stub_with_key_get('/book/title', {:title => 'Rework'}, 'book.xml') }
+
+    it 'returns a book by title' do
+      expect { client.book_by_title('Rework') }.not_to raise_error
     end
   end
+
+  describe '#recent_reviews' do
+    before { stub_with_key_get('/review/recent_reviews', {}, 'recent_reviews.xml') }
+
+    it 'returns recent reviews' do
+      reviews = client.recent_reviews
+
+      reviews.should be_an Array
+      reviews.should_not be_empty
+      reviews.first.should respond_to :id
+    end
+
+    context 'with :skip_cropped => true' do
+      before { stub_with_key_get('/review/recent_reviews', {}, 'recent_reviews.xml') }
   
-  it 'returns review details' do
-    stub_with_key_get('/review/show', {:id => '166204831'}, 'review.xml')
-    
-    proc { @review = @client.review('166204831') }.should_not raise_error
-    @review.should be_an_instance_of Hashie::Mash
-    @review.respond_to?(:id).should == true
-    @review.id.should == '166204831'
+      it 'returns only full reviews' do
+        reviews = client.recent_reviews(:skip_cropped => true)
+        reviews.should be_an Array
+        reviews.should_not be_empty
+      end
+    end
   end
-  
-  it 'raises Goodreads::NotFound if review was not found' do
-    stub_request(:get, "http://www.goodreads.com/review/show?format=xml&id=12345&key=SECRET_KEY").
-      to_return(:status => 404, :body => "", :headers => {})
 
-    proc { @client.review('12345') }.should raise_error Goodreads::NotFound
-  end
-  
-  it 'returns author details' do
-    stub_with_key_get('/author/show', {:id => '18541'}, 'author.xml')
-    
-    proc { @author = @client.author('18541') }.should_not raise_error
-    @author.should be_an_instance_of Hashie::Mash
-    @author.respond_to?(:id).should == true
-    @author.id.should == '18541'
-    @author.name.should == "Tim O'Reilly"
+  describe '#review' do
+    before { stub_with_key_get('/review/show', {:id => '166204831'}, 'review.xml') }
+
+    it 'returns review details' do
+      review = client.review('166204831')
+
+      review.should be_a Hashie::Mash
+      review.id.should eq '166204831'
+    end
+
+    context 'when review does not exist' do
+      before do
+        stub_request(:get, "http://www.goodreads.com/review/show?format=xml&id=12345&key=SECRET_KEY").
+          to_return(:status => 404, :body => "", :headers => {})
+      end
+
+      it 'raises Goodreads::NotFound' do
+        expect { client.review('12345') }.to raise_error Goodreads::NotFound
+      end
+    end
   end
-  
-  it 'raises Goodreads::NotFound if author was not found' do
-    stub_request(:get, "http://www.goodreads.com/author/show?format=xml&id=12345&key=SECRET_KEY").
-      to_return(:status => 404, :body => "", :headers => {})
-    
-    proc { @client.author('12345') }.should raise_error Goodreads::NotFound
+
+  describe '#author' do
+    before { stub_with_key_get('/author/show', {:id => '18541'}, 'author.xml') }
+
+    it 'returns author details' do
+      author = client.author('18541')
+
+      author.should be_a Hashie::Mash
+      author.id.should eq '18541'
+      author.name.should eq "Tim O'Reilly"
+      author.link.should eq 'http://www.goodreads.com/author/show/18541.Tim_O_Reilly'
+      author.fans_count.should eq 109
+      author.image_url.should eq 'http://photo.goodreads.com/authors/1199698411p5/18541.jpg'
+      author.small_image_url.should eq 'http://photo.goodreads.com/authors/1199698411p2/18541.jpg'
+      author.about.should eq '' 
+      author.influences.should eq ''
+      author.works_count.should eq '34'
+      author.gender.should eq 'male'
+      author.hometown.should eq 'Cork'
+      author.born_at.should eq '1954/06/06'
+      author.died_at.should be_nil
+    end
+
+    context 'when author does not exist' do
+      before do
+        stub_request(:get, "http://www.goodreads.com/author/show?format=xml&id=12345&key=SECRET_KEY").
+          to_return(:status => 404, :body => "", :headers => {})
+      end
+
+      it 'raises Goodreads::NotFound' do
+        expect { client.author('12345') }.to raise_error Goodreads::NotFound
+      end
+    end
   end
-  
-  it 'returns user details' do
-    stub_with_key_get('/user/show', {:id => '878044'}, 'user.xml')
-    
-    proc { @user = @client.user('878044') }.should_not raise_error
-    @user.should be_an_instance_of Hashie::Mash
-    @user.respond_to?(:id).should == true
-    @user.id.should == '878044'
-    @user.name.should == 'Jan'
-    @user.user_name.should == 'janmt'
+
+  describe '#author_by_name' do
+    before do
+      stub_with_key_get('/api/author_url', {:id => 'Orson Scott Card'}, 'author_by_name.xml')
+    end
+
+    it 'returns author details' do
+      author = client.author_by_name('Orson Scott Card')
+
+      author.should be_a Hashie::Mash
+      author.id.should eq   '589'
+      author.name.should eq 'Orson Scott Card'
+      author.link.should eq 'http://www.goodreads.com/author/show/589.Orson_Scott_Card?utm_medium=api&utm_source=author_link'
+    end
   end
-  
-  it 'raiser Goodreads::NotFound if user was not found' do
-    stub_request(:get, "http://www.goodreads.com/user/show?format=xml&id=12345&key=SECRET_KEY").
-      to_return(:status => 404, :body => "", :headers => {})
-    
-    proc { @client.user('12345') }.should raise_error Goodreads::NotFound
+
+  describe '#user' do
+    before { stub_with_key_get('/user/show', {:id => '878044'}, 'user.xml') }
+
+    it 'returns user details' do
+      user = client.user('878044')
+
+      user.should be_a Hashie::Mash
+      user.id.should eq '878044'
+      user.name.should eq 'Jan'
+      user.user_name.should eq 'janmt'
+    end
+
+    context 'when user does not exist' do
+      before do
+        stub_request(:get, "http://www.goodreads.com/user/show?format=xml&id=12345&key=SECRET_KEY").
+          to_return(:status => 404, :body => "", :headers => {})
+      end
+
+      it 'raises Goodreads::NotFound' do
+        expect { client.user('12345') }.to raise_error Goodreads::NotFound
+      end
+    end
   end
-  
-  it 'returns book search results' do
-    stub_with_key_get('/search/index', {:q => 'Rework'}, 'search_books_by_name.xml')
-    
-    proc { @search = @client.search_books('Rework') }.should_not raise_error
-    @search.should be_an_instance_of Hashie::Mash
-    @search.respond_to?(:query).should == true
-    @search.respond_to?(:total_results).should == true
-    @search.respond_to?(:results).should == true
-    @search.results.respond_to?(:work).should == true
-    @search.query.should == 'Rework'
-    @search.results.work.size.should == 3
-    @search.results.work.first.id.should == 6928276
+
+  describe '#friends' do
+    before { client.stub(:oauth_request).and_return(Hash.from_xml(fixture('friends.xml'))['GoodreadsResponse']) }
+
+    it 'returns friend details' do
+      friends = client.friends('878044')
+
+      friends.should be_an_instance_of Hashie::Mash
+      friends.should respond_to :user
+      friends.user.size.should eq friends.end.to_i
+      friends.user.first.should respond_to :name
+    end
   end
 
-  it "should return list of books for a user's specified shelf" do
-    stub_with_key_get('/review/list/1.xml', 
-                      {:shelf => 'to-read', :v=> '2'}, 
-                      'to-read.xml')
-
-    proc { @shelf = @client.shelf('1', 'to-read') }.should_not raise_error
-    @shelf.respond_to?(:start).should == true
-    @shelf.respond_to?(:end).should == true
-    @shelf.respond_to?(:total).should == true
-    @shelf.respond_to?(:books).should == true
-    @shelf.start.should == 1
-    @shelf.end.should == 20
-    @shelf.total.should == 40
-    @shelf.books.length.should == 20
-    @shelf.books.first.id.should == '45590939'
-    @shelf.books.first.book.title.strip.should == 'The Demon-Haunted World: Science as a Candle in the Dark'
+  describe '#shelf' do
+    it "returns list of books for a user's specified shelf" do
+      stub_with_key_get('/review/list/1.xml', {:shelf => 'to-read', :v => '2'}, 'to-read.xml')
+
+      shelf = client.shelf('1', 'to-read')
+
+      shelf.should respond_to :start
+      shelf.should respond_to :end
+      shelf.should respond_to :total
+      shelf.should respond_to :books
+
+      shelf.start.should eq 1
+      shelf.end.should eq 20
+      shelf.total.should eq 40
+      shelf.books.length.should eq 20
+      shelf.books.first.id.should eq '45590939'
+      shelf.books.first.book.title.strip.should eq 'The Demon-Haunted World: Science as a Candle in the Dark'
+    end
+
+    it "paginates book lists from a user's shelf" do
+      stub_with_key_get('/review/list/1.xml', {:shelf => 'to-read', :v => '2', :page => '2'}, 'to-read-p2.xml')
+
+      shelf = client.shelf('1', 'to-read', :page => 2)
+
+      shelf.start.should eq 21
+      shelf.end.should eq 40
+      shelf.total.should eq 40
+      shelf.books.length.should eq 20
+      shelf.books.first.id.should eq '107804211'
+      shelf.books.first.book.title.should match /Your Money or Your Life/
+    end
+
+    it "returns an empty array when shelf is empty" do
+      stub_with_key_get('/review/list/1.xml', {:shelf => 'to-read', :v => '2'}, 'empty.xml')
+
+      shelf = client.shelf('1', 'to-read')
+
+      shelf.start.should eq 0
+      shelf.end.should eq 0
+      shelf.total.should eq 0
+      shelf.books.length.should eq 0
+    end
   end
 
-  it "should paginate book lists from a user's shelf" do
-    stub_with_key_get('/review/list/1.xml', 
-                      {:shelf => 'to-read', :v=> '2', :page => '2'}, 
-                      'to-read-p2.xml')
-    proc { @shelf = @client.shelf('1', 'to-read', :page => 2) }.should_not raise_error
-    @shelf.start.should == 21
-    @shelf.end.should == 40
-    @shelf.total.should == 40
-    @shelf.books.length.should == 20
-    @shelf.books.first.id.should == '107804211'
-    @shelf.books.first.book.title.should =~ /Your Money or Your Life/
+  describe '#user_id' do
+    let(:consumer) { OAuth::Consumer.new('API_KEY', 'SECRET_KEY', :site => 'http://www.goodreads.com') }
+    let(:token)    { OAuth::AccessToken.new(consumer, 'ACCESS_TOKEN', 'ACCESS_SECRET') }
+
+    before do
+      stub_request(:get, "http://www.goodreads.com/api/auth_user").
+        to_return(:status => 200, :body => fixture('oauth_response.xml'), :headers => {})
+    end
+
+    it 'returns id of the user with oauth authentication' do
+      client = Goodreads::Client.new(:api_key => 'SECRET_KEY', :oauth_token => token)
+      client.user_id.should eq '2003928'
+    end
   end
 
-  it "should return an empty array for empty shelves" do
-    stub_with_key_get('/review/list/1.xml', 
-                      {:shelf => 'to-read', :v=> '2'}, 
-                      'empty.xml')
-    proc { @shelf = @client.shelf('1', 'to-read') }.should_not raise_error
-    @shelf.start.should == 0
-    @shelf.end.should == 0
-    @shelf.total.should == 0
-    @shelf.books.length.should == 0
+  describe '#group' do
+    before { stub_with_key_get('/group/show', {:id => '1'}, 'group.xml') }
+
+    it "returns group details" do
+      group = client.group('1')
+    
+      group.should be_a Hashie::Mash
+      group.id.should eq '1'
+      group.title.should eq 'Goodreads Feedback'
+      group.access.should eq 'public'
+      group.location.should eq ''
+      group.category.should eq 'Business'
+      group.subcategory.should eq 'Companies'
+      group.group_users_count.should eq '10335'
+    end
   end
 
-  it "should return the user id of the user who authorized OAuth" do
-    stub_request(:get, "http://www.goodreads.com/api/auth_user").to_return(
-      :status => 200, :body => fixture('oauth_response.xml'), :headers => {})
+  describe '#group_list' do
+    before { stub_with_key_get('/group/list', {:id => '1', :sort => 'my_activity'}, 'group_list.xml') }
 
-    consumer = OAuth::Consumer.new('API_KEY', 'SECRET_KEY', :site => 'http://www.goodreads.com')
-    oauth_token = OAuth::AccessToken.new(consumer, 'ACCESS_TOKEN', 'ACCESS_SECRET')
+    it "returns groups a given user is a member of" do
+      group_list = client.group_list('1')
 
-    @client = Goodreads::Client.new(:api_key => 'SECRET_KEY', :oauth_token => oauth_token)
-    @client.user_id.should == '2003928'
+      group_list.should be_a Hashie::Mash
+      group_list.total.should eq '107'
+      group_list.group.count.should eq 50
+      group_list.group[0].id.should eq '1'
+      group_list.group[0].title.should eq 'Goodreads Feedback'
+      group_list.group[1].id.should eq '220'
+      group_list.group[2].users_count.should eq '530'
+    end
   end
 end

data/spec/fixtures/author.xml

@@ -713,4 +713,4 @@
  
       </books> 
 </author> 
-</GoodreadsResponse>
+</GoodreadsResponse>

data/spec/fixtures/author_by_name.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<GoodreadsResponse>
+  <Request>
+    <authentication>true</authentication>
+      <key><![CDATA[SECRET_KEY]]></key>
+    <method><![CDATA[api_author_link]]></method>
+  </Request>
+  
+
+		<author id="589">
+			<name><![CDATA[Orson Scott Card]]></name>
+			<link>http://www.goodreads.com/author/show/589.Orson_Scott_Card?utm_medium=api&amp;utm_source=author_link</link>
+		</author>
+	
+	
+
+</GoodreadsResponse>

data/spec/fixtures/friends.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<GoodreadsResponse>
+  <Request>
+    <authentication>true</authentication>
+      <key><![CDATA[SECRET_KEY]]></key>
+    <method><![CDATA[friend_user]]></method>
+  </Request>
+  <friends start="1" end="2" total="2">
+    <user>
+      <id>1421455</id>
+      <name>Amy Chamberlain</name>
+      <link><![CDATA[http://www.goodreads.com/user/show/1421455-amy-chamberlain]]></link>
+      <image_url><![CDATA[http://d.gr-assets.com/users/1315014486p3/1421455.jpg]]></image_url>
+      <small_image_url><![CDATA[http://d.gr-assets.com/users/1315014486p2/1421455.jpg]]></small_image_url>
+      <friends_count>29</friends_count>
+      <reviews_count>475</reviews_count>
+  			<created_at>Sun Mar 20 19:39:06 -0700 2011</created_at>
+    </user>
+    <user>
+      <id>17764795</id>
+      <name>Lisa Teran</name>
+      <link><![CDATA[http://www.goodreads.com/user/show/17764795-lisa-teran]]></link>
+      <image_url><![CDATA[http://d.gr-assets.com/users/1361688877p3/17764795.jpg]]></image_url>
+      <small_image_url><![CDATA[http://d.gr-assets.com/users/1361688877p2/17764795.jpg]]></small_image_url>
+      <friends_count>35</friends_count>
+      <reviews_count>5</reviews_count>
+  			<created_at>Sat Feb 23 22:53:57 -0800 2013</created_at>
+    </user>
+</friends>
+</GoodreadsResponse>