readmill 0.0.1 → 0.1.0

data/spec/readmill/client/closing_remarks_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Readmill::Client::ClosingRemarks do
+  let (:client) { Readmill::Client.new }
+
+  describe '.closing_remark' do
+    let (:results) { client.closing_remark(9088) }
+
+    it 'should request a closing_remark from readmill' do
+      results
+      assert_requested :get, readmill_url('closing_remarks/9088')
+    end
+
+    it 'should return a closing_remark' do
+      expect(results).to respond_to(:closing_remark)
+    end
+  end
+
+end

data/spec/readmill/client/comments_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Readmill::Client::Comments do
+  let (:client) { Readmill::Client.new }
+
+  describe '.comments' do
+    let (:results) { client.comments(829035) }
+
+    it 'should request all comments from readmill' do
+      results
+      assert_requested :get, readmill_url('highlights/829035/comments')
+    end
+
+    it 'should return an array of comments' do
+      expect(results).to be_a(Array)
+      expect(results.first).to respond_to(:comment)
+    end
+  end
+
+  describe '.comment' do
+    let (:results) { client.comment(112631) }
+
+    it 'should request a comment from readmill' do
+      results
+      assert_requested :get, readmill_url('comments/112631')
+    end
+
+    it 'should return a comment' do
+      expect(results).to respond_to(:comment)
+    end
+  end
+
+end

data/spec/readmill/client/highlights_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Readmill::Client::Highlights do
+  let (:client) { Readmill::Client.new }
+
+  describe '.highlights' do
+    let (:results) { client.highlights }
+
+    it 'should request all highlights from readmill' do
+      results
+      assert_requested :get, readmill_url('highlights')
+    end
+
+    it 'should return an array of highlights' do
+      expect(results).to be_a(Array)
+      expect(results.first).to respond_to(:highlight)
+    end
+
+    context 'with a reading_id' do
+      it 'should request all highlights for the reading' do
+        client.highlights(reading_id: 439319)
+        assert_requested :get, readmill_url('readings/439319/highlights')
+      end
+    end
+
+    context 'with a user_id' do
+      it 'should request all highlights for the user' do
+        client.highlights(user_id: 35202)
+        assert_requested :get, readmill_url('users/35202/highlights')
+      end
+    end
+
+    context 'with a reading_id and a user_id' do
+      it 'should raise an argument error' do
+        expect { client.highlights(reading_id: 1, user_id: 1) }.to(
+          raise_error(ArgumentError, /either reading_id or user_id, but not both/)
+        )
+      end
+    end
+  end
+
+  describe '.highlight' do
+    let (:results) { client.highlight(827438) }
+
+    it 'should request a highlight from readmill' do
+      results
+      assert_requested :get, readmill_url('highlights/827438')
+    end
+
+    it 'should return a highlight' do
+      expect(results).to respond_to(:highlight)
+    end
+
+    context 'with comments true' do
+      let (:results) { client.highlight(829035, comments: true) }
+
+      it 'should return comments for the highlight from readmill' do
+        results
+        assert_requested :get, readmill_url('highlights/829035/comments')
+      end
+
+      it 'should return an array of comments' do
+        expect(results).to be_a(Array)
+        expect(results.first).to respond_to(:comment)
+      end
+    end
+  end
+
+end

data/spec/readmill/client/locations_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Readmill::Client::Locations do
+  let (:client) { Readmill::Client.new }
+
+  describe '.locations' do
+    let! (:results) { client.locations(443173) }
+
+    it 'should request all locations from readmill' do
+      assert_requested :get, readmill_url('readings/443173/locations')
+    end
+
+    it 'should return an array of locations' do
+      expect(results).to be_a(Array)
+      expect(results.first).to respond_to(:location)
+    end
+  end
+
+end

data/spec/readmill/client/periods_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Readmill::Client::Periods do
+  let (:client) { Readmill::Client.new }
+
+  describe '.periods' do
+    let! (:results) { client.periods(443173) }
+
+    it 'should request all periods from readmill' do
+      assert_requested :get, readmill_url('readings/443173/periods')
+    end
+
+    it 'should return an array of periods' do
+      expect(results).to be_a(Array)
+      expect(results.first).to respond_to(:period)
+    end
+  end
+
+end

data/spec/readmill/client/readings_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Readmill::Client::Readings do
+  let (:client) { Readmill::Client.new }
+
+  describe '.readings' do
+    let (:results) { client.readings }
+
+    it 'should request all readings from readmill' do
+      results
+      assert_requested :get, readmill_url('readings')
+    end
+
+    it 'should return an array of readings' do
+      expect(results).to be_a(Array)
+      expect(results.first).to respond_to(:reading)
+    end
+
+    context 'with a book_id' do
+      let (:results) { client.readings(book_id: 269082) }
+
+      it 'should request all readings for the book' do
+        results
+        assert_requested :get, readmill_url('books/269082/readings')
+      end
+
+      it 'should return an array of readings' do
+        expect(results).to be_a(Array)
+        expect(results.first).to respond_to(:reading)
+      end
+    end
+
+    context 'with a user_id' do
+      let (:results) { client.readings(user_id: 45146) }
+
+      it 'should request all readings for the user' do
+        results
+        assert_requested :get, readmill_url('users/45146/readings')
+      end
+
+      it 'should return an array of readings' do
+        expect(results).to be_a(Array)
+        expect(results.first).to respond_to(:reading)
+      end
+    end
+
+    context 'with a book_id and a user_id' do
+      it 'should raise an argument error' do
+        expect { client.readings(book_id: 1, user_id: 1) }.to(
+          raise_error(ArgumentError, /either book_id or user_id, but not both/)
+        )
+      end
+    end
+  end
+
+  describe '.reading' do
+    let (:results) { client.reading(443173) }
+
+    it 'should request a reading from readmill' do
+      results
+      assert_requested :get, readmill_url('readings/443173')
+    end
+
+    it 'should return a reading' do
+      expect(results).to respond_to(:reading)
+    end
+
+    context 'with periods true' do
+      let (:results) { client.reading(443173, periods: true) }
+
+      it 'should request periods for the reading from readmill' do
+        results
+        assert_requested :get, readmill_url('readings/443173/periods')
+      end
+
+      it 'should return an array of periods' do
+        expect(results).to be_a(Array)
+        expect(results.first).to respond_to(:period)
+      end
+    end
+
+    context 'with locations true' do
+      let (:results) { client.reading(443173, locations: true) }
+
+      it 'should request locations for the reading from readmill' do
+        results
+        assert_requested :get, readmill_url('readings/443173/locations')
+      end
+
+      it 'should return an array of locations' do
+        expect(results).to be_a(Array)
+        expect(results.first).to respond_to(:location)
+      end
+    end
+
+    context 'with highlights true' do
+      let (:results) { client.reading(234482, highlights: true) }
+
+      it 'should request highlights for the reading from readmill' do
+        results
+        assert_requested :get, readmill_url('readings/234482/highlights')
+      end
+
+      it 'should return an array of highlights' do
+        expect(results).to be_a(Array)
+        expect(results.first).to respond_to(:highlight)
+      end
+    end
+
+    [
+      { periods: true, locations: true, highlights: false },
+      { periods: true, locations: false, highlights: true },
+      { periods: false, locations: true, highlights: true }
+    ].each do |opts|
+      context "with periods #{opts[:periods]}, locations #{opts[:locations]}, and highlights #{opts[:highlights]}" do
+        it 'should raise an argument error' do
+          expect { client.reading(443173, periods: opts[:periods],
+                                          locations: opts[:locations],
+                                          highlights: opts[:highlights]) }.to(
+            raise_error(ArgumentError, /You can only set one of periods, locations, and highlights/)
+          )
+        end
+      end
+    end
+  end
+
+end

data/spec/readmill/client/users_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Readmill::Client::Users do
+  let (:client) { Readmill::Client.new }
+
+  describe '.user' do
+    let (:results) { client.user(1) }
+
+    it 'should request a user from readmill' do
+      results
+      assert_requested :get, readmill_url('users/1')
+    end
+
+    it 'should return a user' do
+      expect(results).to respond_to(:user)
+    end
+
+    context 'with followers true' do
+      let (:results) { client.user(1, followers: true) }
+
+      it 'should request all followers for a user' do
+        results
+        assert_requested :get, readmill_url('users/1/followers')
+      end
+
+      it 'should return an array of users' do
+        expect(results).to be_a(Array)
+        expect(results.first).to respond_to(:user)
+      end
+    end
+
+    context 'with followings true' do
+      let (:results) { client.user(1, followings: true) }
+
+      it 'should request all followings for a user' do
+        results
+        assert_requested :get, readmill_url('users/1/followings')
+      end
+
+      it 'should return an array of users' do
+        expect(results).to be_a(Array)
+        expect(results.first).to respond_to(:user)
+      end
+    end
+
+    context 'with followers true and followings true' do
+      let (:results) { client.user(1, followers: true, followings: true) }
+
+      it 'should raise an argument error' do
+        expect { results }.to(
+          raise_error(ArgumentError, /followers or followings, but not both/)
+        )
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: readmill
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Thorp
@@ -108,6 +108,13 @@ files:
 - readmill.gemspec
 - lib/faraday/response/raise_readmill_error.rb
 - lib/readmill/client/books.rb
+- lib/readmill/client/closing_remarks.rb
+- lib/readmill/client/comments.rb
+- lib/readmill/client/highlights.rb
+- lib/readmill/client/locations.rb
+- lib/readmill/client/periods.rb
+- lib/readmill/client/readings.rb
+- lib/readmill/client/users.rb
 - lib/readmill/client.rb
 - lib/readmill/configuration.rb
 - lib/readmill/error.rb
@@ -116,10 +123,60 @@ files:
 - lib/readmill.rb
 - spec/cassettes/readmill/client/books_book/should_request_a_book_from_readmill.yml
 - spec/cassettes/readmill/client/books_book/should_return_a_book.yml
+- spec/cassettes/readmill/client/books_book/with_closing_remarks_true_should_request_readers_for_a_book_from_readmill.yml
+- spec/cassettes/readmill/client/books_book/with_closing_remarks_true_should_return_an_array_of_users.yml
+- spec/cassettes/readmill/client/books_book/with_readers_true_should_request_readers_for_a_book_from_readmill.yml
+- spec/cassettes/readmill/client/books_book/with_readers_true_should_return_an_array_of_users.yml
 - spec/cassettes/readmill/client/books_books/should_request_all_books_from_readmill.yml
 - spec/cassettes/readmill/client/books_books/should_return_an_array_of_books.yml
+- spec/cassettes/readmill/client/closing_remarks_closing_remark/should_request_a_closing_remark_from_readmill.yml
+- spec/cassettes/readmill/client/closing_remarks_closing_remark/should_return_a_closing_remark.yml
+- spec/cassettes/readmill/client/comments_comment/should_request_a_comment_from_readmill.yml
+- spec/cassettes/readmill/client/comments_comment/should_return_a_comment.yml
+- spec/cassettes/readmill/client/comments_comments/should_request_all_comments_from_readmill.yml
+- spec/cassettes/readmill/client/comments_comments/should_return_an_array_of_comments.yml
+- spec/cassettes/readmill/client/highlights_highlight/should_request_a_highlight_from_readmill.yml
+- spec/cassettes/readmill/client/highlights_highlight/should_return_a_highlight.yml
+- spec/cassettes/readmill/client/highlights_highlight/with_comments_true_should_return_an_array_of_comments.yml
+- spec/cassettes/readmill/client/highlights_highlight/with_comments_true_should_return_comments_for_the_highlight_from_readmill.yml
+- spec/cassettes/readmill/client/highlights_highlights/should_request_all_highlights_from_readmill.yml
+- spec/cassettes/readmill/client/highlights_highlights/should_return_an_array_of_highlights.yml
+- spec/cassettes/readmill/client/highlights_highlights/with_a_reading_id_should_request_all_highlights_for_the_reading.yml
+- spec/cassettes/readmill/client/highlights_highlights/with_a_user_id_should_request_all_highlights_for_the_user.yml
+- spec/cassettes/readmill/client/locations_locations/should_request_all_locations_from_readmill.yml
+- spec/cassettes/readmill/client/locations_locations/should_return_an_array_of_locations.yml
+- spec/cassettes/readmill/client/periods_periods/should_request_all_periods_from_readmill.yml
+- spec/cassettes/readmill/client/periods_periods/should_return_an_array_of_periods.yml
+- spec/cassettes/readmill/client/readings_reading/should_request_a_reading_from_readmill.yml
+- spec/cassettes/readmill/client/readings_reading/should_return_a_reading.yml
+- spec/cassettes/readmill/client/readings_reading/with_highlights_true_should_request_highlights_for_the_reading_from_readmill.yml
+- spec/cassettes/readmill/client/readings_reading/with_highlights_true_should_return_an_array_of_highlights.yml
+- spec/cassettes/readmill/client/readings_reading/with_locations_true_should_request_locations_for_the_reading_from_readmill.yml
+- spec/cassettes/readmill/client/readings_reading/with_locations_true_should_return_an_array_of_locations.yml
+- spec/cassettes/readmill/client/readings_reading/with_periods_true_and_locations_true_should_raise_an_argument_error.yml
+- spec/cassettes/readmill/client/readings_reading/with_periods_true_should_request_periods_for_the_reading_from_readmill.yml
+- spec/cassettes/readmill/client/readings_reading/with_periods_true_should_return_an_array_of_periods.yml
+- spec/cassettes/readmill/client/readings_readings/should_request_all_readings_from_readmill.yml
+- spec/cassettes/readmill/client/readings_readings/should_return_an_array_of_readings.yml
+- spec/cassettes/readmill/client/readings_readings/with_a_book_id_should_request_all_readings_for_the_book.yml
+- spec/cassettes/readmill/client/readings_readings/with_a_book_id_should_return_an_array_of_readings.yml
+- spec/cassettes/readmill/client/readings_readings/with_a_user_id_should_request_all_readings_for_the_user.yml
+- spec/cassettes/readmill/client/readings_readings/with_a_user_id_should_return_an_array_of_readings.yml
+- spec/cassettes/readmill/client/users_user/should_request_a_user_from_readmill.yml
+- spec/cassettes/readmill/client/users_user/should_return_a_user.yml
+- spec/cassettes/readmill/client/users_user/with_followers_true_should_request_all_followers_for_a_user.yml
+- spec/cassettes/readmill/client/users_user/with_followers_true_should_return_an_array_of_users.yml
+- spec/cassettes/readmill/client/users_user/with_followings_true_should_request_all_followings_for_a_user.yml
+- spec/cassettes/readmill/client/users_user/with_followings_true_should_return_an_array_of_users.yml
 - spec/faraday/response/raise_readmill_error_spec.rb
 - spec/readmill/client/books_spec.rb
+- spec/readmill/client/closing_remarks_spec.rb
+- spec/readmill/client/comments_spec.rb
+- spec/readmill/client/highlights_spec.rb
+- spec/readmill/client/locations_spec.rb
+- spec/readmill/client/periods_spec.rb
+- spec/readmill/client/readings_spec.rb
+- spec/readmill/client/users_spec.rb
 - spec/readmill/client_spec.rb
 - spec/readmill/configuration_spec.rb
 - spec/readmill/request_spec.rb
@@ -150,10 +207,60 @@ summary: Simple wrapper for the Readmill API.
 test_files:
 - spec/cassettes/readmill/client/books_book/should_request_a_book_from_readmill.yml
 - spec/cassettes/readmill/client/books_book/should_return_a_book.yml
+- spec/cassettes/readmill/client/books_book/with_closing_remarks_true_should_request_readers_for_a_book_from_readmill.yml
+- spec/cassettes/readmill/client/books_book/with_closing_remarks_true_should_return_an_array_of_users.yml
+- spec/cassettes/readmill/client/books_book/with_readers_true_should_request_readers_for_a_book_from_readmill.yml
+- spec/cassettes/readmill/client/books_book/with_readers_true_should_return_an_array_of_users.yml
 - spec/cassettes/readmill/client/books_books/should_request_all_books_from_readmill.yml
 - spec/cassettes/readmill/client/books_books/should_return_an_array_of_books.yml
+- spec/cassettes/readmill/client/closing_remarks_closing_remark/should_request_a_closing_remark_from_readmill.yml
+- spec/cassettes/readmill/client/closing_remarks_closing_remark/should_return_a_closing_remark.yml
+- spec/cassettes/readmill/client/comments_comment/should_request_a_comment_from_readmill.yml
+- spec/cassettes/readmill/client/comments_comment/should_return_a_comment.yml
+- spec/cassettes/readmill/client/comments_comments/should_request_all_comments_from_readmill.yml
+- spec/cassettes/readmill/client/comments_comments/should_return_an_array_of_comments.yml
+- spec/cassettes/readmill/client/highlights_highlight/should_request_a_highlight_from_readmill.yml
+- spec/cassettes/readmill/client/highlights_highlight/should_return_a_highlight.yml
+- spec/cassettes/readmill/client/highlights_highlight/with_comments_true_should_return_an_array_of_comments.yml
+- spec/cassettes/readmill/client/highlights_highlight/with_comments_true_should_return_comments_for_the_highlight_from_readmill.yml
+- spec/cassettes/readmill/client/highlights_highlights/should_request_all_highlights_from_readmill.yml
+- spec/cassettes/readmill/client/highlights_highlights/should_return_an_array_of_highlights.yml
+- spec/cassettes/readmill/client/highlights_highlights/with_a_reading_id_should_request_all_highlights_for_the_reading.yml
+- spec/cassettes/readmill/client/highlights_highlights/with_a_user_id_should_request_all_highlights_for_the_user.yml
+- spec/cassettes/readmill/client/locations_locations/should_request_all_locations_from_readmill.yml
+- spec/cassettes/readmill/client/locations_locations/should_return_an_array_of_locations.yml
+- spec/cassettes/readmill/client/periods_periods/should_request_all_periods_from_readmill.yml
+- spec/cassettes/readmill/client/periods_periods/should_return_an_array_of_periods.yml
+- spec/cassettes/readmill/client/readings_reading/should_request_a_reading_from_readmill.yml
+- spec/cassettes/readmill/client/readings_reading/should_return_a_reading.yml
+- spec/cassettes/readmill/client/readings_reading/with_highlights_true_should_request_highlights_for_the_reading_from_readmill.yml
+- spec/cassettes/readmill/client/readings_reading/with_highlights_true_should_return_an_array_of_highlights.yml
+- spec/cassettes/readmill/client/readings_reading/with_locations_true_should_request_locations_for_the_reading_from_readmill.yml
+- spec/cassettes/readmill/client/readings_reading/with_locations_true_should_return_an_array_of_locations.yml
+- spec/cassettes/readmill/client/readings_reading/with_periods_true_and_locations_true_should_raise_an_argument_error.yml
+- spec/cassettes/readmill/client/readings_reading/with_periods_true_should_request_periods_for_the_reading_from_readmill.yml
+- spec/cassettes/readmill/client/readings_reading/with_periods_true_should_return_an_array_of_periods.yml
+- spec/cassettes/readmill/client/readings_readings/should_request_all_readings_from_readmill.yml
+- spec/cassettes/readmill/client/readings_readings/should_return_an_array_of_readings.yml
+- spec/cassettes/readmill/client/readings_readings/with_a_book_id_should_request_all_readings_for_the_book.yml
+- spec/cassettes/readmill/client/readings_readings/with_a_book_id_should_return_an_array_of_readings.yml
+- spec/cassettes/readmill/client/readings_readings/with_a_user_id_should_request_all_readings_for_the_user.yml
+- spec/cassettes/readmill/client/readings_readings/with_a_user_id_should_return_an_array_of_readings.yml
+- spec/cassettes/readmill/client/users_user/should_request_a_user_from_readmill.yml
+- spec/cassettes/readmill/client/users_user/should_return_a_user.yml
+- spec/cassettes/readmill/client/users_user/with_followers_true_should_request_all_followers_for_a_user.yml
+- spec/cassettes/readmill/client/users_user/with_followers_true_should_return_an_array_of_users.yml
+- spec/cassettes/readmill/client/users_user/with_followings_true_should_request_all_followings_for_a_user.yml
+- spec/cassettes/readmill/client/users_user/with_followings_true_should_return_an_array_of_users.yml
 - spec/faraday/response/raise_readmill_error_spec.rb
 - spec/readmill/client/books_spec.rb
+- spec/readmill/client/closing_remarks_spec.rb
+- spec/readmill/client/comments_spec.rb
+- spec/readmill/client/highlights_spec.rb
+- spec/readmill/client/locations_spec.rb
+- spec/readmill/client/periods_spec.rb
+- spec/readmill/client/readings_spec.rb
+- spec/readmill/client/users_spec.rb
 - spec/readmill/client_spec.rb
 - spec/readmill/configuration_spec.rb
 - spec/readmill/request_spec.rb