readmill 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f35c2ae9772b9f8842eb4df1bcee5bd376c30638
-  data.tar.gz: aed7f792b72a72241fc10a8fd8c46c08bcb10512
+  metadata.gz: 55c086e83317810f068f131e638c71755df3078e
+  data.tar.gz: ccbea744db0d118d0583043f10431f2d43ceac97
 SHA512:
-  metadata.gz: d1f11152644b7e4632f7c8739d5c06b2dcbf6af1a156c7e83c012f353ab92ff914f4c6e9340454ace05c88bdfc7355e50b1144fc88512d552c819d4834aba59e
-  data.tar.gz: 7fa1db95bb331efceaff34b92c2688995ac17d9ac009789418b60724b393e61299c06aeebb3f7529e45b907699f337a13594cc2868ec5554ee01e85424af8aad
+  metadata.gz: be1e06390ff1343a8b003e3fc3a3e75476e807fdb17264c148c1bab41bb7c3fa126e6a7ac34391806e191a4d6ffced624b6741369b285813fc20a531fa832402
+  data.tar.gz: 5454a0d403da7b5dfe47cb378ea43f5653a3aee31563ba54d72f038762b6e3e56a57896bf64c8a4e952a0e338953528579991938a8f99ecf98a189f93006dcf3

data/lib/readmill/client.rb

@@ -1,6 +1,13 @@
 require 'readmill/request'
 require 'readmill/configuration'
 require 'readmill/client/books'
+require 'readmill/client/closing_remarks'
+require 'readmill/client/comments'
+require 'readmill/client/highlights'
+require 'readmill/client/locations'
+require 'readmill/client/periods'
+require 'readmill/client/readings'
+require 'readmill/client/users'
 
 module Readmill
 
@@ -35,6 +42,13 @@ module Readmill
 
     include Readmill::Request
     include Readmill::Client::Books
+    include Readmill::Client::ClosingRemarks
+    include Readmill::Client::Comments
+    include Readmill::Client::Highlights
+    include Readmill::Client::Locations
+    include Readmill::Client::Periods
+    include Readmill::Client::Readings
+    include Readmill::Client::Users
 
   end
 

data/lib/readmill/client/books.rb

@@ -22,10 +22,23 @@ module Readmill
       # opts  - A Hash of options used to modify the results. All of the values
       #         of this Hash will be forwarded to the API as parameters
       #         (default: {}).
+      #         :readers  - Boolean whether or not to get readers of a book
+      #                     (default: false).
       #
       # Returns a Hashie::Mash.
       def book(id, opts={})
-        get("books/#{id}", opts)
+        if opts[:closing_remarks] && opts[:readers]
+          raise ArgumentError,
+            'You can pass either closing_remarks or readers, but not both.'
+        end
+
+        if opts.delete(:closing_remarks)
+          get("books/#{id}/closing_remarks", opts).items
+        elsif opts.delete(:readers)
+          get("books/#{id}/readers", opts).items
+        else
+          get("books/#{id}", opts)
+        end
       end
 
     end

data/lib/readmill/client/closing_remarks.rb

@@ -0,0 +1,22 @@
+module Readmill
+  class Client
+
+    # Public: This module will bring all of the methods from the closing_remark
+    # section of the API.
+    module ClosingRemarks
+
+      # Public: Get a specific closing_remark from readmill.
+      #
+      # id    - The id of a closing_remark to get from readmill.
+      # opts  - A Hash of options used to modify the results. All of the values
+      #         of this Hash will be forwarded to the API as parameters
+      #         (default: {}).
+      #
+      # Returns a Hashie::Mash.
+      def closing_remark(id, opts={})
+        get("closing_remarks/#{id}", opts)
+      end
+
+    end
+  end
+end

data/lib/readmill/client/comments.rb

@@ -0,0 +1,34 @@
+module Readmill
+  class Client
+
+    # Public: This module will bring all of the methods from the comment
+    # section of the API.
+    module Comments
+
+      # Public: Get all comments from readmill.
+      #
+      # highlight_id  - An id of a highlight to get comments for.
+      # opts          - A Hash of options used to modify the results. All of the
+      #                 values of this Hash will be forwarded to the API as
+      #                 parameters (default: {}).
+      #
+      # Returns an Array.
+      def comments(highlight_id, opts={})
+        get("highlights/#{highlight_id}/comments", opts).items
+      end
+
+      # Public: Get a specific comment from readmill.
+      #
+      # id    - The id of a comment to get from readmill.
+      # opts  - A Hash of options used to modify the results. All of the values
+      #         of this Hash will be forwarded to the API as parameters
+      #         (default: {}).
+      #
+      # Returns a Hashie::Mash.
+      def comment(id, opts={})
+        get("comments/#{id}", opts)
+      end
+
+    end
+  end
+end

data/lib/readmill/client/highlights.rb

@@ -0,0 +1,52 @@
+module Readmill
+  class Client
+
+    # Public: This module will bring all of the methods from the highlight
+    # section of the API.
+    module Highlights
+
+      # Public: Get all highlights from readmill.
+      #
+      # opts  - A Hash of options used to modify the results. All of the values
+      #         of this Hash will be forwarded to the API as parameters
+      #         (default: {}).
+      #         :reading_id - Limit the highlights to a specific reading.
+      #         :user_id - Limit the highlights to a specific user.
+      #
+      # Returns an Array.
+      def highlights(opts={})
+        if !opts[:user_id].nil? && !opts[:reading_id].nil?
+          raise ArgumentError,
+            'You can pass either reading_id or user_id, but not both.'
+        end
+
+        if !opts[:user_id].nil?
+          url = "users/#{opts.delete(:user_id)}/highlights"
+        elsif !opts[:reading_id].nil?
+          url = "readings/#{opts.delete(:reading_id)}/highlights"
+        else
+          url = 'highlights'
+        end
+
+        get(url, opts).items
+      end
+
+      # Public: Get a specific highlight from readmill.
+      #
+      # id    - The id of a highlight to get from readmill.
+      # opts  - A Hash of options used to modify the results. All of the values
+      #         of this Hash will be forwarded to the API as parameters
+      #         (default: {}).
+      #
+      # Returns a Hashie::Mash.
+      def highlight(id, opts={})
+        if opts.delete(:comments)
+          get("highlights/#{id}/comments", opts).items
+        else
+          get("highlights/#{id}", opts)
+        end
+      end
+
+    end
+  end
+end

data/lib/readmill/client/locations.rb

@@ -0,0 +1,22 @@
+module Readmill
+  class Client
+
+    # Public: This module will bring all of the methods from the location
+    # section of the API.
+    module Locations
+
+      # Public: Get locations for a reading from readmill.
+      #
+      # reading_id  - An id of the reading to get locations for.
+      # opts        - A Hash of options used to modify the results. All of the
+      #               values of this Hash will be forwarded to the API as
+      #               parameters (default: {}).
+      #
+      # Returns an Array.
+      def locations(reading_id, opts={})
+        get("readings/#{reading_id}/locations", opts).items
+      end
+
+    end
+  end
+end

data/lib/readmill/client/periods.rb

@@ -0,0 +1,22 @@
+module Readmill
+  class Client
+
+    # Public: This module will bring all of the methods from the period section
+    # of the API.
+    module Periods
+
+      # Public: Get periods for a reading from readmill.
+      #
+      # reading_id  - An id of the reading to get periods for.
+      # opts        - A Hash of options used to modify the results. All of the
+      #               values of this Hash will be forwarded to the API as
+      #               parameters (default: {}).
+      #
+      # Returns an Array.
+      def periods(reading_id, opts={})
+        get("readings/#{reading_id}/periods", opts).items
+      end
+
+    end
+  end
+end

data/lib/readmill/client/readings.rb

@@ -0,0 +1,77 @@
+module Readmill
+  class Client
+
+    # Public: This module will bring all of the methods from the reading section
+    # of the API.
+    module Readings
+
+      # Public: Get all readings from readmill.
+      #
+      # opts  - A Hash of options used to modify the results. All of the values
+      #         of this Hash will be forwarded to the API as parameters
+      #         (default: {}).
+      #         :book_id - Limit the readings to a specific book.
+      #         :user_id - Limit the readings to a specific user.
+      #
+      # Returns an Array.
+      def readings(opts={})
+        if !opts[:user_id].nil? && !opts[:book_id].nil?
+          raise ArgumentError,
+            'You can pass either book_id or user_id, but not both.'
+        end
+
+        if !opts[:user_id].nil?
+          url = "users/#{opts.delete(:user_id)}/readings"
+        elsif !opts[:book_id].nil?
+          url = "books/#{opts.delete(:book_id)}/readings"
+        else
+          url = 'readings'
+        end
+
+        get(url, opts).items
+      end
+
+      # Public: Get a specific reading from readmill.
+      #
+      # id    - The id of a reading to get from readmill.
+      # opts  - A Hash of options used to modify the results. All of the values
+      #         of this Hash will be forwarded to the API as parameters
+      #         (default: {}).
+      #         :periods    - Boolean whether to get the periods or not
+      #                       (default: false).
+      #         :locations  - Boolean whether to get the locations or not
+      #                       (default: false).
+      #
+      # Returns a Hashie::Mash.
+      def reading(id, opts={})
+        ensure_valid_reading_options(opts)
+
+        if opts.delete(:periods)
+          get("readings/#{id}/periods", opts).items
+        elsif opts.delete(:locations)
+          get("readings/#{id}/locations", opts).items
+        elsif opts.delete(:highlights)
+          get("readings/#{id}/highlights", opts).items
+        else
+          get("readings/#{id}", opts)
+        end
+      end
+
+
+    protected
+
+      # Internal: This method will raise an error if any two of periods,
+      # locations, or highlights is true.
+      #
+      # Raises ArgumentError.
+      # Returns nothing.
+      def ensure_valid_reading_options(opts)
+        if opts.values_at(:periods, :locations, :highlights).grep(true).size > 1
+          raise ArgumentError,
+            'You can only set one of periods, locations, and highlights.'
+        end
+      end
+
+    end
+  end
+end

data/lib/readmill/client/users.rb

@@ -0,0 +1,33 @@
+module Readmill
+  class Client
+
+    # Public: This module will bring all of the methods from the user
+    # section of the API.
+    module Users
+
+      # Public: Get a specific user from readmill.
+      #
+      # id    - The id of a user to get from readmill.
+      # opts  - A Hash of options used to modify the results. All of the values
+      #         of this Hash will be forwarded to the API as parameters
+      #         (default: {}).
+      #
+      # Returns a Hashie::Mash.
+      def user(id, opts={})
+        if opts[:followers] && opts[:followings]
+          raise ArgumentError,
+            'You can pass either followers or followings, but not both.'
+        end
+
+        if opts.delete(:followers)
+          get("users/#{id}/followers", opts).items
+        elsif opts.delete(:followings)
+          get("users/#{id}/followings", opts).items
+        else
+          get("users/#{id}", opts)
+        end
+      end
+
+    end
+  end
+end

data/lib/readmill/version.rb

@@ -1,6 +1,6 @@
 module Readmill
 
   # Public: The version of the Readmill gem.
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.0'.freeze
 
 end

data/spec/cassettes/readmill/client/books_book/should_request_a_book_from_readmill.yml

@@ -25,7 +25,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Mon, 16 Dec 2013 02:33:14 GMT
+      - Mon, 16 Dec 2013 04:19:50 GMT
       Etag:
       - '"d6b8fcef7531c80136b0539e78042926"'
       Server:
@@ -35,9 +35,9 @@ http_interactions:
       X-Rack-Cache:
       - miss
       X-Request-Id:
-      - 1c23d7b8a812a1e03f6da245ca4a35f3
+      - e37c882f979146cf8efdce621165ad51
       X-Runtime:
-      - '0.104400'
+      - '0.035662'
       X-Ua-Compatible:
       - IE=Edge,chrome=1
       Content-Length:
@@ -68,5 +68,5 @@ http_interactions:
         Lessons to Accelerate Your Startup can get your entrepreneurial endeavor headed
         in the right direction.","published_at":"2010-10-19","language":"en","permalink":"do-more-faster-techstars-lessons-to-accelerate-your-startup","permalink_url":"https://readmill.com/books/do-more-faster-techstars-lessons-to-accelerate-your-startup","cover_url":"https://d26cmntuippvfl.cloudfront.net/?action=shrink-w&format=png&origin=https%253A%252F%252Freadmill-assets.s3.amazonaws.com%252Fcovers%252F4c22fed8ffc2f4a651ab3dd994eb452403e12cf4-original.png&width=120","cover_metadata":{"original_width":300,"original_height":452},"assets":{"items":[{"asset":{"vendor":"","uri":"http://www.feedbooks.com/item/217887/do-more-faster-techstars-lessons-to-accelerate-your-startup","acquisition_type":"store"}}]},"readings_count":98,"recommended_readings_count":0,"active_and_finished_readings_count":24,"average_duration":214,"featured":false,"price_segment":null},"status":200}'
     http_version: 
-  recorded_at: Mon, 16 Dec 2013 02:33:13 GMT
+  recorded_at: Mon, 16 Dec 2013 04:19:49 GMT
 recorded_with: VCR 2.8.0

data/spec/cassettes/readmill/client/books_book/should_return_a_book.yml

@@ -25,7 +25,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Mon, 16 Dec 2013 03:37:29 GMT
+      - Mon, 16 Dec 2013 04:19:51 GMT
       Etag:
       - '"d6b8fcef7531c80136b0539e78042926"'
       Server:
@@ -35,9 +35,9 @@ http_interactions:
       X-Rack-Cache:
       - miss
       X-Request-Id:
-      - 78fe3796424215c04a878304b69a2453
+      - 4c16ab75295336aa6f7c82bf37c26afd
       X-Runtime:
-      - '0.096865'
+      - '0.034174'
       X-Ua-Compatible:
       - IE=Edge,chrome=1
       Content-Length:
@@ -68,5 +68,5 @@ http_interactions:
         Lessons to Accelerate Your Startup can get your entrepreneurial endeavor headed
         in the right direction.","published_at":"2010-10-19","language":"en","permalink":"do-more-faster-techstars-lessons-to-accelerate-your-startup","permalink_url":"https://readmill.com/books/do-more-faster-techstars-lessons-to-accelerate-your-startup","cover_url":"https://d26cmntuippvfl.cloudfront.net/?action=shrink-w&format=png&origin=https%253A%252F%252Freadmill-assets.s3.amazonaws.com%252Fcovers%252F4c22fed8ffc2f4a651ab3dd994eb452403e12cf4-original.png&width=120","cover_metadata":{"original_width":300,"original_height":452},"assets":{"items":[{"asset":{"vendor":"","uri":"http://www.feedbooks.com/item/217887/do-more-faster-techstars-lessons-to-accelerate-your-startup","acquisition_type":"store"}}]},"readings_count":98,"recommended_readings_count":0,"active_and_finished_readings_count":24,"average_duration":214,"featured":false,"price_segment":null},"status":200}'
     http_version: 
-  recorded_at: Mon, 16 Dec 2013 03:37:28 GMT
+  recorded_at: Mon, 16 Dec 2013 04:19:50 GMT
 recorded_with: VCR 2.8.0

data/spec/cassettes/readmill/client/books_book/with_closing_remarks_true_should_request_readers_for_a_book_from_readmill.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.readmill.com/v2/books/1/closing_remarks
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Authorization:
+      - Client READMILL_CLIENT_ID
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - must-revalidate, private, max-age=0
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Mon, 16 Dec 2013 17:35:26 GMT
+      Etag:
+      - '"75b35c30658029e3e3c23f6022060dfd"'
+      Server:
+      - nginx/1.0.12
+      Status:
+      - 200 OK
+      X-Rack-Cache:
+      - miss
+      X-Request-Id:
+      - dcd8e7f5b33f0211b5edf653976e6b3b
+      X-Runtime:
+      - '0.101613'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Content-Length:
+      - '1393'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"pagination":{"next":null},"items":[{"closing_remark":{"id":9088,"content":"A
+        must read for anyone building (or planning to build) a startup.","reading":{"id":318374},"user":{"id":34764,"username":"sagmor","firstname":"Seba","fullname":"Seba
+        Gamboa","avatar_url":"https://d26cmntuippvfl.cloudfront.net/?action=crop&format=png&height=50&origin=https%253A%252F%252Freadmill-assets.s3.amazonaws.com%252Favatars%252F7392433d1d87b8a102089db66b9a63deca58a231-original.png&width=50","followers_count":0,"followings_count":4,"permalink_url":"https://readmill.com/sagmor"},"recommended":false,"comments_count":0,"likes_count":0,"created_at":"2013-10-17T13:18:25Z"}},{"closing_remark":{"id":5,"content":"Very
+        hands on and an easy read. Some of the stories had useful tips that I''ll
+        go back to, but also a fair share of clich\u00e9s. Fun if your starting something
+        yourself.","reading":{"id":45},"user":{"id":5,"username":"david","firstname":"David","fullname":"David
+        Kjelkerud","avatar_url":"https://d26cmntuippvfl.cloudfront.net/?action=crop&format=png&height=50&origin=https%253A%252F%252Freadmill-assets.s3.amazonaws.com%252Favatars%252F4312d134c34ca088d956790a37d696353f6f8e72-original.png&width=50","followers_count":356,"followings_count":296,"permalink_url":"https://readmill.com/david"},"recommended":false,"comments_count":0,"likes_count":0,"created_at":"2012-10-18T16:29:31Z"}}],"status":200}'
+    http_version: 
+  recorded_at: Mon, 16 Dec 2013 17:35:26 GMT
+recorded_with: VCR 2.8.0