pocket-ruby 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820f73644ee1f21cea8033e70e5c3c038b6dc061cb9e05b36c3ede86421763e1
-  data.tar.gz: 30744f3d1257e1d7fcee9cda79abf518f4277d996c8716720ec6cc1bbbce59f8
+  metadata.gz: 4d5d9cc7d714e363b5d185ab6c83f9c60c7650dca3bb80942d490342c1b296f1
+  data.tar.gz: 895f07cc0c151ab089fbd02a41776894ce94a4a87f5e35e2f3597f3321d531ab
 SHA512:
-  metadata.gz: acb0b74a3bd7df194b1ed532dc7f54a1eb860d5632f1854aab803c905c9f8c4c7d3fe23b42553507b82165776a892d93ac38f98874cc5c811cbb81dfcd34b76c
-  data.tar.gz: e2526ed17125c7c51be1d8baaaa1d30e610858c0968b03348e875aeec75a9384cc566b65b0ca5c02ab85aff5e0288f3fc8d02ce4b364a99e98a820a11debe830
+  metadata.gz: 17946cffbd9fdab7faac7e635e2611f0715525f5ad17aa731e0c03c2449bb5f8c1f7bea9d59803bfa81369b55df271cd580106a7aad04ad5cee7d52c0b657e08
+  data.tar.gz: 5fcd4d7e3bede834b735ec8efe4e3a024576f358c599f2028e325acf1bd3dc986b1bb60ea42a4c72a886c872c6ff13571fbed792d60326ff28c5495334cae121

data/.yardopts

@@ -1,9 +1,6 @@
 --no-private
 --protected
---tag format:"Supported formats"
---tag authenticated:"Requires Authentication"
---tag rate_limited:"Rate Limited"
 --markup markdown
+--output-dir doc/yard
 -
-HISTORY.mkd
-LICENSE.mkd
+LICENSE.md

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 ## [Unreleased]
 
+## [0.5.0] - 2021-05-15
+
+- Use Sinatra 2. ([#92](https://github.com/turadg/pocket-ruby/pull/92))
+- Add `Pocket::Image` class. ([#90](https://github.com/turadg/pocket-ruby/pull/90))
+- Fix demo server. ([#93](https://github.com/turadg/pocket-ruby/pull/33))
+- Fix docs generation. ([#89](https://github.com/turadg/pocket-ruby/pull/89))
+- Add `unfavorite` operation. ([#87](https://github.com/turadg/pocket-ruby/pull/87))
+- Add `favorite` operation. ([#86](https://github.com/turadg/pocket-ruby/pull/86))
+
+## [0.4.0] - 2021-04-18
+
+- Fix Faraday error handling. ([#81](https://github.com/turadg/pocket-ruby/pull/81))
+- Don't assume `is_article` is present ([#78](https://github.com/turadg/pocket-ruby/pull/78)).
+- Handle article with missing `resolved_url` or `resolved_title` ([#77](https://github.com/turadg/pocket-ruby/pull/77))
+- Remove unnecessary use of `method_missing`. ([#71](https://github.com/turadg/pocket-ruby/pull/71))
+- Simplify internal structure for `Client` class and modules.
+
+## [0.3.0] - 2021-04-11
+
+- Hand article with missing `excerpt`. ([#63](https://github.com/turadg/pocket-ruby/pull/63))
+- Add support for `domain_metadata` in Article response. ([#57](https://github.com/turadg/pocket-ruby/pull/57))
+- Add `time_to_read` field to `Pocket::Article`.
+- Return nil for `word_count` if not present ([#48](https://github.com/turadg/pocket-ruby/pull/48))
+
+## [0.2.1] - 2021-04-10
+
+- Return nil if `time_read` or `time_favorited` is '0' in the API response. Otherwise, this may be interpreted the Unix epoch (1970-01-01). ([#46](https://github.com/turadg/pocket-ruby/pull/46))
+
+## [0.2.0] - 2021-04-03
+
+- Add support for authors and tags in `Pocket::Article` ([#44](https://github.com/turadg/pocket-ruby/pull/44))
+
 ## [0.1.0] - 2021-04-03
 
 - Add `Pocket::Article` for parsing an article response ([#39](https://github.com/turadg/pocket-ruby/pull/39))

data/Gemfile.lock

@@ -1,37 +1,49 @@
 PATH
   remote: .
   specs:
-    pocket-ruby (0.1.0)
-      faraday (>= 0.7)
+    pocket-ruby (0.5.0)
+      faraday (>= 1.0)
       faraday_middleware
       multi_json (~> 1.0, >= 1.0.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    crack (0.4.5)
+      rexml
     docile (1.3.5)
-    faraday (1.3.0)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
+    hashdiff (1.0.1)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
     power_assert (2.0.0)
-    rack (1.6.13)
-    rack-protection (1.5.5)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rack-protection (2.1.0)
       rack
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rubocop (1.11.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -54,20 +66,27 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
-    sinatra (1.3.6)
-      rack (~> 1.4)
-      rack-protection (~> 1.3)
-      tilt (~> 1.3, >= 1.3.3)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
     standard (1.0.4)
       rubocop (= 1.11.0)
       rubocop-performance (= 1.10.1)
     test-unit (3.4.0)
       power_assert
-    tilt (1.4.1)
+    tilt (2.0.10)
     unicode-display_width (2.0.0)
+    webmock (3.12.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.26)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES
@@ -75,9 +94,11 @@ DEPENDENCIES
   pocket-ruby!
   rake
   simplecov
-  sinatra (~> 1.3.3)
+  sinatra (~> 2)
   standard
   test-unit
+  webmock
+  yard
 
 BUNDLED WITH
    2.2.8

data/README.md

@@ -3,11 +3,11 @@ pocket-ruby
 
 [![Code Climate](https://codeclimate.com/github/turadg/pocket-ruby.png)](https://codeclimate.com/github/turadg/pocket-ruby) [![Gem Version](https://badge.fury.io/rb/pocket-ruby.png)](http://badge.fury.io/rb/pocket-ruby)
 
-Ruby API for v3 of the [Pocket API](http://getpocket.com/developer/docs/overview) (formerly Read It Later) 
+Ruby API for v3 of the [Pocket API](http://getpocket.com/developer/docs/overview) (formerly Read It Later)
 
 # Usage
 
-Just clone the repo here and refer to the demo-server.rb file for examples on how to interact with the Pocket API. 
+Just clone the repo here and refer to the demo-server.rb file for examples on how to interact with the Pocket API.
 
 ```sh
 	git clone
@@ -16,6 +16,27 @@ Just clone the repo here and refer to the demo-server.rb file for examples on ho
 	ruby demo-server.rb
 ```
 
+*Note:* Changes to the `demo-server.rb` will require a restart to take effect (or you can use [rerun](https://github.com/alexch/rerun)).
+
 Pocket-Ruby can be installed via the gem, ```gem install pocket-ruby```
 
 Or via bundler, ```gem 'pocket-ruby'```
+
+## Pocket API Notes
+
+Below are some aspects of the Pocket API that aren't covered in the official documentation, or that have been observed:
+
+* For very long articles, the maximum reported `word_count` is 65535, even if the article is longer.
+* If a `count` isn't specified, the `Retreive` call will return maximum of 5000 items.
+* The API response may contain a number of undocumented fields, including:
+  * `amp_url`
+  * `domain_metadata`
+  * `is_index`
+  * `lang` ([ISO_639-1](https://en.wikipedia.org/wiki/ISO_639-1)?)
+  * `listen_duration_estimate`
+  * `sort_id`
+  * `time_to_read`
+  * `top_image_url`
+* Every integer value is returned as a string, *except* for `time_to_read`, `listen_duration_estimate` and `sort_id`.
+* The `time_to_read` is in minutes, but `listen_duration_estimate` is in seconds.
+* If an article's `status` is `"2"` ('should be deleted') then most fields will not be present.

data/Rakefile

@@ -10,22 +10,11 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: [:test, :standard]
+task default: [:test, :standard, :yard]
 
-namespace :doc do
+begin
   require "yard"
+  YARD::Rake::YardocTask.new
 rescue LoadError
   # ignore
-else
-  YARD::Rake::YardocTask.new do |task|
-    task.files = ["HISTORY.mkd", "LICENSE.mkd", "lib/**/*.rb"]
-    task.options = [
-      "--protected",
-      "--output-dir", "doc/yard",
-      "--tag", "format:Supported formats",
-      "--tag", "authenticated:Requires Authentication",
-      "--tag", "rate_limited:Rate Limited",
-      "--markup", "markdown"
-    ]
-  end
 end

data/lib/faraday/raise_pocket_error.rb

@@ -16,11 +16,11 @@ module Faraday
     def on_complete(env)
       case env[:status]
       when 404
-        raise Faraday::Error::ResourceNotFound, response_values(env)
-      when 400...403
+        raise Faraday::ResourceNotFound, response_values(env)
+      when 400..403
         raise Pocket::Error, env[:response_headers]["X-Error"]
       when CLIENT_ERROR_STATUSES
-        raise Faraday::Error::ClientError, response_values(env)
+        raise Faraday::ClientError, response_values(env)
       end
     end
 

data/lib/pocket-ruby.rb

@@ -3,9 +3,14 @@ require File.expand_path("../pocket/configuration", __FILE__)
 require File.expand_path("../pocket/api", __FILE__)
 require File.expand_path("../pocket/client", __FILE__)
 require File.expand_path("../pocket/article", __FILE__)
+require File.expand_path("../pocket/author", __FILE__)
+require File.expand_path("../pocket/domain_metadata", __FILE__)
+require File.expand_path("../pocket/image", __FILE__)
 
 module Pocket
   extend Configuration
+  extend Connection
+  extend OAuth
 
   # Alias for Pocket::Client.new
   #
@@ -13,15 +18,4 @@ module Pocket
   def self.client(options = {})
     Pocket::Client.new(options)
   end
-
-  # Delegate to Pocket::Client
-  def self.method_missing(method, *args, &block)
-    return super unless client.respond_to?(method)
-    client.send(method, *args, &block)
-  end
-
-  # Delegate to Pocket::Client
-  def self.respond_to_missing?(method)
-    client.respond_to?(method) || super
-  end
 end

data/lib/pocket/article.rb

@@ -21,7 +21,7 @@ module Pocket
     end
 
     def resolved_url
-      response.fetch("resolved_url")
+      response.fetch("resolved_url", nil)
     end
 
     def given_title
@@ -29,7 +29,7 @@ module Pocket
     end
 
     def resolved_title
-      response.fetch("resolved_title")
+      response.fetch("resolved_title", nil)
     end
 
     def favorite?
@@ -41,10 +41,12 @@ module Pocket
     end
 
     def excerpt
+      return nil unless response["excerpt"]
       response.fetch("excerpt")
     end
 
     def article?
+      return false unless response["is_article"]
       Integer(response.fetch("is_article")) == 1
     end
 
@@ -65,6 +67,7 @@ module Pocket
     end
 
     def word_count
+      return nil unless response["word_count"]
       Integer(response.fetch("word_count"))
     end
 
@@ -88,6 +91,7 @@ module Pocket
 
     def time_read
       return nil unless response["time_read"]
+      return nil if response["time_read"] == "0"
       Time.at(Integer(response["time_read"])).utc
     end
 
@@ -97,6 +101,7 @@ module Pocket
 
     def time_favorited
       return nil unless response["time_favorited"]
+      return nil if response["time_favorited"] == "0"
       Time.at(Integer(response["time_favorited"])).utc
     end
 
@@ -107,5 +112,38 @@ module Pocket
     def read_url
       "https://getpocket.com/read/#{item_id}"
     end
+
+    def tags
+      Hash(response["tags"]).values.map { |tag| tag["tag"] }
+    end
+
+    def authors
+      Hash(response["authors"]).values.map { |value| Pocket::Author.new(value) }
+    end
+
+    def domain_metadata
+      return nil unless response["domain_metadata"]
+      Pocket::DomainMetadata.new(response["domain_metadata"])
+    end
+
+    def time_to_read
+      return nil unless response["time_to_read"]
+      return nil if response["time_to_read"] == 0
+      response.fetch("time_to_read")
+    end
+
+    def time_to_read_category
+      return nil if time_to_read.nil?
+
+      if time_to_read >= 21
+        "very_long"
+      elsif time_to_read >= 11
+        "long"
+      elsif time_to_read >= 6
+        "medium"
+      else
+        "quick"
+      end
+    end
   end
 end

data/lib/pocket/author.rb

@@ -0,0 +1,23 @@
+module Pocket
+  class Author
+    def initialize(response)
+      @response = response
+    end
+
+    def id
+      Integer(response.fetch("author_id"))
+    end
+
+    def name
+      response.fetch("name")
+    end
+
+    def url
+      response.fetch("url")
+    end
+
+    private
+
+    attr_reader :response
+  end
+end

data/lib/pocket/client.rb

@@ -1,13 +1,33 @@
 module Pocket
   # Wrapper for the Pocket REST API
-  #
-  # @note All methods have been separated into modules and follow the same grouping used in {TODO:doc_URL the Pocket API Documentation}.
-  # @see TODO:doc_url
   class Client < API
-    Dir[File.expand_path("../client/*.rb", __FILE__)].sort.each { |f| require f }
+    # http://getpocket.com/developer/docs/v3/add
+    # required params: url, consumer_key, access_token
+    def add params
+      response = connection.post("/v3/add", params)
+      response.body
+    end
 
-    include Pocket::Client::Add
-    include Pocket::Client::Modify
-    include Pocket::Client::Retrieve
+    # http://getpocket.com/developer/docs/v3/modify
+    # required params: actions, consumer_key, access_token
+    def modify actions
+      response = connection.post("/v3/send", {actions: actions})
+      response.body
+    end
+
+    # http://getpocket.com/developer/docs/v3/retrieve
+    # required params: consumer_key, access_token
+    def retrieve params = {}
+      response = connection.post("/v3/get", params)
+      response.body
+    end
+
+    def favorite(item_id)
+      modify([action: "favorite", item_id: item_id])
+    end
+
+    def unfavorite(item_id)
+      modify([action: "unfavorite", item_id: item_id])
+    end
   end
 end

data/lib/pocket/domain_metadata.rb

@@ -0,0 +1,23 @@
+module Pocket
+  class DomainMetadata
+    def initialize(response)
+      @response = response
+    end
+
+    def name
+      response.fetch("name")
+    end
+
+    def logo
+      response.fetch("logo")
+    end
+
+    def greyscale_logo
+      response.fetch("greyscale_logo")
+    end
+
+    private
+
+    attr_reader :response
+  end
+end

data/lib/pocket/image.rb

@@ -0,0 +1,21 @@
+module Pocket
+  class Image
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def src
+      response.fetch("src")
+    end
+
+    def caption
+      response.fetch("caption")
+    end
+
+    def image_id
+      Integer(response.fetch("image_id"))
+    end
+  end
+end

data/lib/pocket/version.rb

@@ -1,3 +1,3 @@
 module Pocket
-  VERSION = "0.1.0"
+  VERSION = "0.5.0"
 end

data/pocket-ruby.gemspec

@@ -1,13 +1,15 @@
 require File.expand_path("../lib/pocket/version", __FILE__)
 
 Gem::Specification.new do |s|
-  s.add_development_dependency("sinatra", "~> 1.3.3")
+  s.add_development_dependency("sinatra", "~> 2")
   s.add_development_dependency("multi_xml")
   s.add_development_dependency("rake")
   s.add_development_dependency("standard")
   s.add_development_dependency("test-unit")
   s.add_development_dependency("simplecov")
-  s.add_runtime_dependency("faraday", [">= 0.7"])
+  s.add_development_dependency("webmock")
+  s.add_development_dependency("yard")
+  s.add_runtime_dependency("faraday", ">= 1.0")
   s.add_runtime_dependency("faraday_middleware")
   s.add_runtime_dependency("multi_json", ">= 1.0.3", "~> 1.0")
   s.authors = ["Turadg Aleahmad", "Jason Ng PT", "Andy Waite"]

data/test/fixtures/retreive.json

@@ -17,6 +17,7 @@
     "time_updated": "1617412993",
     "time_read": "1617412994",
     "time_favorited": "1617412995",
+    "time_to_read": 14,
     "images": {
         "1": {
             "item_id": "229279689",
@@ -38,5 +39,28 @@
             "type": "1",
             "vid": "Er34PbFkVGk"
         }
+    },
+    "tags":{
+        "bookmark":{
+           "item_id":"229279689",
+           "tag":"my-tag-1"
+        },
+        "gtd":{
+           "item_id":"229279689",
+           "tag":"my-tag-2"
+        }
+     },
+     "authors":{
+        "62344201":{
+           "item_id":"229279689",
+           "author_id":"62344201",
+           "name":"Stephen King",
+           "url":"https://example.com/author"
+        }
+     },
+     "domain_metadata":{
+        "name": "The Verge",
+        "logo": "https://logo.clearbit.com/theverge.com?size=800",
+        "greyscale_logo": "https://logo.clearbit.com/theverge.com?size=800&greyscale=true"
     }
 }

data/test/pocket/article_test.rb

@@ -1,7 +1,11 @@
 require "test_helper"
 
 module Pocket
-  class VersionTest < Test::Unit::TestCase
+  class ArticleTest < Test::Unit::TestCase
+    setup do
+      @article = Pocket::Article.new(parsed_response)
+    end
+
     test "from_json" do
       json_string = File.read("test/fixtures/retreive.json")
       article = Pocket::Article.from_json(json_string)
@@ -9,123 +13,214 @@ module Pocket
     end
 
     test "item_id" do
-      assert_equal 229279689, article.item_id
+      assert_equal 229279689, @article.item_id
     end
 
     test "given_url" do
-      assert_equal "http://www.grantland.com/blog/the-triangle/post/_/id/38347/ryder-cup-preview?given", article.given_url
+      assert_equal "http://www.grantland.com/blog/the-triangle/post/_/id/38347/ryder-cup-preview?given", @article.given_url
     end
 
     test "resolved_url" do
-      assert_equal "http://www.grantland.com/blog/the-triangle/post/_/id/38347/ryder-cup-preview?resolved", article.resolved_url
+      assert_equal "http://www.grantland.com/blog/the-triangle/post/_/id/38347/ryder-cup-preview?resolved", @article.resolved_url
+    end
+
+    test "resolved_url is nil is field not present" do
+      parsed_response.delete("resolved_url")
+      assert_nil @article.resolved_url
     end
 
     test "given_title" do
-      assert_equal "The Massive Ryder Cup Preview - The Triangle Blog - Grantland", article.given_title
+      assert_equal "The Massive Ryder Cup Preview - The Triangle Blog - Grantland", @article.given_title
     end
 
     test "resolved_title" do
-      assert_equal "The Massive Ryder Cup Preview", article.resolved_title
+      assert_equal "The Massive Ryder Cup Preview", @article.resolved_title
+    end
+
+    test "resolved_title is nil is field not present" do
+      parsed_response.delete("resolved_title")
+      assert_nil @article.resolved_title
     end
 
     test "favorite? is false is field is '0'" do
-      assert_equal false, article.favorite?
+      assert_equal false, @article.favorite?
     end
 
     test "status" do
-      assert_equal 0, article.status
+      assert_equal 0, @article.status
     end
 
     test "excerpt" do
-      assert_include article.excerpt, "list of things"
+      assert_include @article.excerpt, "list of things"
+    end
+
+    test "excerpt is nil if field not present" do
+      parsed_response.delete("excerpt")
+      assert_nil @article.excerpt
     end
 
     test "article?" do
-      assert article.article?
+      assert @article.article?
+    end
+
+    test "article? returns false if `is_article` field not present" do
+      parsed_response.delete("is_article")
+      refute @article.article?
     end
 
     test "has_image?" do
-      assert article.has_image?
+      assert @article.has_image?
     end
 
     test "image?" do
-      refute article.image?
+      refute @article.image?
     end
 
     test "has_video?" do
-      assert article.has_video?
+      assert @article.has_video?
     end
 
     test "video?" do
-      refute article.video?
+      refute @article.video?
     end
 
     test "word_count" do
-      assert_equal 3197, article.word_count
+      assert_equal 3197, @article.word_count
+    end
+
+    test "word_count is nil is field not present" do
+      parsed_response.delete("word_count")
+      assert_nil @article.word_count
     end
 
     test "resolved_id" do
-      assert_equal 229279689, article.resolved_id
+      assert_equal 229279689, @article.resolved_id
     end
 
     test "thumbnail" do
-      assert_equal "https://example.com/image.png", article.thumbnail
+      assert_equal "https://example.com/image.png", @article.thumbnail
     end
 
     test "time_added" do
-      assert_equal Time.utc(2021, 4, 3, 1, 23, 12), article.time_added
+      assert_equal Time.utc(2021, 4, 3, 1, 23, 12), @article.time_added
     end
 
     test "time_added is nil if field not present" do
       parsed_response.delete("time_added")
-      assert_nil article.time_added
+      assert_nil @article.time_added
     end
 
     test "time_updated" do
-      assert_equal Time.utc(2021, 4, 3, 1, 23, 13), article.time_updated
+      assert_equal Time.utc(2021, 4, 3, 1, 23, 13), @article.time_updated
     end
 
     test "time_updated is nil if field not present" do
       parsed_response.delete("time_updated")
-      assert_nil article.time_updated
+      assert_nil @article.time_updated
     end
 
     test "time_read" do
-      assert_equal Time.utc(2021, 4, 3, 1, 23, 14), article.time_read
+      assert_equal Time.utc(2021, 4, 3, 1, 23, 14), @article.time_read
     end
 
     test "time_read is nil if field is not present" do
       parsed_response.delete("time_read")
-      assert_nil article.time_read
+      assert_nil @article.time_read
+    end
+
+    test "time_read is nil if field is zero" do
+      parsed_response["time_read"] = "0"
+      assert_nil @article.time_read
     end
 
     test "favorited?" do
-      assert article.favorited?
+      assert @article.favorited?
     end
 
     test "time_favorited" do
-      assert_equal Time.utc(2021, 4, 3, 1, 23, 15), article.time_favorited
+      assert_equal Time.utc(2021, 4, 3, 1, 23, 15), @article.time_favorited
     end
 
     test "time_favorited is nil if field not present" do
       parsed_response.delete("time_favorited")
-      assert_nil article.time_favorited
+      assert_nil @article.time_favorited
+    end
+
+    test "time_favorited is nil if field is zero" do
+      parsed_response["time_favorited"] = "0"
+      assert_nil @article.time_favorited
     end
 
     test "read?" do
-      assert article.read?
+      assert @article.read?
     end
 
     test "read_url" do
-      assert_equal "https://getpocket.com/read/229279689", article.read_url
+      assert_equal "https://getpocket.com/read/229279689", @article.read_url
     end
 
-    private
+    test "tags" do
+      assert_equal ["my-tag-1", "my-tag-2"], @article.tags
+    end
+
+    test "tags returns an empty array if there are no tags" do
+      parsed_response.delete("tags")
+      assert_equal [], @article.tags
+    end
+
+    test "authors" do
+      result = @article.authors
+      assert_equal 1, result.size
+      assert_equal "Stephen King", result.first.name
+      assert_equal 62344201, result.first.id
+      assert_equal "https://example.com/author", result.first.url
+    end
+
+    test "authors returns an empty array if there are no tags" do
+      parsed_response.delete("authors")
+      assert_equal [], @article.authors
+    end
+
+    test "time_to_read" do
+      assert_equal 14, @article.time_to_read
+    end
+
+    test "time_to_read returns nil if field not present" do
+      parsed_response.delete("time_to_read")
+      assert_nil @article.time_to_read
+    end
+
+    test "time_to_read returns nil if value is 0" do
+      parsed_response["time_to_read"] = 0
+      assert_nil @article.time_to_read
+    end
+
+    test "time_to_read_category" do
+      parsed_response.delete("time_to_read")
+      assert_nil @article.time_to_read_category
+
+      parsed_response["time_to_read"] = 0
+      assert_nil @article.time_to_read_category
+
+      parsed_response["time_to_read"] = 25
+      assert_equal "very_long", @article.time_to_read_category
+
+      parsed_response["time_to_read"] = 15
+      assert_equal "long", @article.time_to_read_category
 
-    def article
-      @article ||= Pocket::Article.new(parsed_response)
+      parsed_response["time_to_read"] = 8
+      assert_equal "medium", @article.time_to_read_category
+
+      parsed_response["time_to_read"] = 3
+      assert_equal "quick", @article.time_to_read_category
+    end
+
+    test "domain_metadata" do
+      assert_equal "The Verge", @article.domain_metadata.name
     end
 
+    private
+
     def parsed_response
       @parsed_response ||= JSON.parse(File.read("test/fixtures/retreive.json"))
     end

data/test/pocket/client_test.rb

@@ -0,0 +1,59 @@
+require "test_helper"
+require "webmock/test_unit"
+
+class ClientTest < Test::Unit::TestCase
+  test "retrieve" do
+    stub_request(:post, "https://getpocket.com/v3/get")
+      .with(
+        body: "{\"detailType\":\"complete\",\"count\":1,\"consumer_key\":null,\"access_token\":\"access_token\"}",
+        headers: {
+          "Content-Type" => "application/json",
+          "User-Agent" => "Pocket Ruby Gem #{Pocket::VERSION}"
+        }
+      )
+      .to_return(status: 200, body: "body response", headers: {})
+    client = Pocket.client(access_token: "access_token")
+
+    result = client.retrieve(detailType: :complete, count: 1)
+
+    assert_equal "body response", result
+  end
+
+  test "favorite" do
+    success_response = '{"action_results":[true],"status":1}'
+
+    stub_request(:post, "https://getpocket.com/v3/send")
+      .with(
+        body: "{\"actions\":[{\"action\":\"favorite\",\"item_id\":\"123456\"}],\"consumer_key\":null,\"access_token\":\"access_token\"}",
+        headers: {
+          "Content-Type" => "application/json",
+          "User-Agent" => "Pocket Ruby Gem #{Pocket::VERSION}"
+        }
+      )
+      .to_return(status: 200, body: success_response, headers: {})
+    client = Pocket.client(access_token: "access_token")
+
+    result = client.favorite("123456")
+
+    assert_equal success_response, result
+  end
+
+  test "unfavorite" do
+    success_response = '{"action_results":[true],"status":1}'
+
+    stub_request(:post, "https://getpocket.com/v3/send")
+      .with(
+        body: "{\"actions\":[{\"action\":\"unfavorite\",\"item_id\":\"123456\"}],\"consumer_key\":null,\"access_token\":\"access_token\"}",
+        headers: {
+          "Content-Type" => "application/json",
+          "User-Agent" => "Pocket Ruby Gem #{Pocket::VERSION}"
+        }
+      )
+      .to_return(status: 200, body: success_response, headers: {})
+    client = Pocket.client(access_token: "access_token")
+
+    result = client.unfavorite("123456")
+
+    assert_equal success_response, result
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pocket-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Turadg Aleahmad
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-03 00:00:00.000000000 Z
+date: 2021-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
@@ -96,20 +96,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -128,22 +156,22 @@ dependencies:
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: A Ruby wrapper for the Pocket API v3 (Add, Modify and Retrieve)
 email:
 - turadg@aleahmad.net
@@ -168,18 +196,19 @@ files:
 - lib/pocket-ruby.rb
 - lib/pocket/api.rb
 - lib/pocket/article.rb
+- lib/pocket/author.rb
 - lib/pocket/client.rb
-- lib/pocket/client/add.rb
-- lib/pocket/client/modify.rb
-- lib/pocket/client/retrieve.rb
 - lib/pocket/configuration.rb
 - lib/pocket/connection.rb
+- lib/pocket/domain_metadata.rb
 - lib/pocket/error.rb
+- lib/pocket/image.rb
 - lib/pocket/oauth.rb
 - lib/pocket/version.rb
 - pocket-ruby.gemspec
 - test/fixtures/retreive.json
 - test/pocket/article_test.rb
+- test/pocket/client_test.rb
 - test/pocket/version_test.rb
 - test/test_helper.rb
 homepage: https://github.com/turadg/pocket-ruby
@@ -200,12 +229,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Pocket API v3
 test_files:
 - test/fixtures/retreive.json
 - test/pocket/article_test.rb
+- test/pocket/client_test.rb
 - test/pocket/version_test.rb
 - test/test_helper.rb

data/lib/pocket/client/add.rb

@@ -1,12 +0,0 @@
-module Pocket
-  class Client
-    # http://getpocket.com/developer/docs/v3/add
-    module Add
-      # required params: url, consumer_key, access_token
-      def add params
-        response = connection.post("/v3/add", params)
-        response.body
-      end
-    end
-  end
-end

data/lib/pocket/client/modify.rb

@@ -1,12 +0,0 @@
-module Pocket
-  class Client
-    # http://getpocket.com/developer/docs/v3/modify
-    module Modify
-      # required params: actions, consumer_key, access_token
-      def modify actions
-        response = connection.post("/v3/send", {actions: actions})
-        response.body
-      end
-    end
-  end
-end

data/lib/pocket/client/retrieve.rb

@@ -1,12 +0,0 @@
-module Pocket
-  class Client
-    # http://getpocket.com/developer/docs/v3/retrieve
-    module Retrieve
-      # required params: consumer_key, access_token
-      def retrieve params = {}
-        response = connection.post("/v3/get", params)
-        response.body
-      end
-    end
-  end
-end