pocket-ruby 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23523be975e32aab67f1eb9eae5bd8a9a23032e7b9e32dd16c7ebd54829dcfd5
-  data.tar.gz: f340f0180bffcee80c64321392205ad43439434a12171b670baab1b7c30eb56f
+  metadata.gz: 4d7b6ddfe9a36ea0ec8e2f9cf289882025e83f1a864edc99df3bc1deaf2aef0e
+  data.tar.gz: 7b7e5197505e43aaf60d59187a0c453ace474e317aa135b197d4ec1883c159bc
 SHA512:
-  metadata.gz: 9c639bdd2f2637e55642da60be20d03e3e8e4ea7bc87b2da4ebf5951d8f99d7717e3d7608e3ec66c79a1e7b0bdf49f4c673a95590ffa34bd54baf4f0b5293b8a
-  data.tar.gz: 03f454e5471e90266dce757748b7a3fefad8adcfefd954bae3e2bd52f687dc922c7d0d7911ef02e85b94344f733803b6aea2c5dbfb50dfe45c2a0f8679ed81e0
+  metadata.gz: 1e39623af247edd6aaf4e7d6a3ea932ec81b770cf9807b63991af63b764be306934e3a50bbdfb3ff8dfda555e8ccc5e14d8fb97edefb118749e2fe02818a0239
+  data.tar.gz: ac0a9a2fba76645632bc045f785ac21ed1cf4687a8a873320ab73debce00a95d79415986e9a267855e34662afd4aacf6f9614648cd7ceb2b7e608efea6c71067

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [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))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pocket-ruby (0.2.1)
+    pocket-ruby (0.3.0)
       faraday (>= 0.7)
       faraday_middleware
       multi_json (~> 1.0, >= 1.0.3)

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,24 @@ 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:
+  * `domain_metadata`
+  * `amp_url`
+  * `listen_duration_estimate`
+  * `time_to_read`
+  * `sort_id`
+  * `lang` ([ISO_639-1](https://en.wikipedia.org/wiki/ISO_639-1)?)
+* 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.

data/lib/pocket-ruby.rb

@@ -4,6 +4,7 @@ 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__)
 
 module Pocket
   extend Configuration

data/lib/pocket/article.rb

@@ -41,6 +41,7 @@ module Pocket
     end
 
     def excerpt
+      return nil unless response["excerpt"]
       response.fetch("excerpt")
     end
 
@@ -65,6 +66,7 @@ module Pocket
     end
 
     def word_count
+      return nil unless response["word_count"]
       Integer(response.fetch("word_count"))
     end
 
@@ -117,5 +119,30 @@ module Pocket
     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/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/version.rb

@@ -1,3 +1,3 @@
 module Pocket
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

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",
@@ -56,5 +57,10 @@
            "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

@@ -40,6 +40,11 @@ module Pocket
       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?
     end
@@ -64,6 +69,11 @@ module Pocket
       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
     end
@@ -152,6 +162,44 @@ module Pocket
       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
+
+      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 article

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pocket-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Turadg Aleahmad
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-10 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -175,6 +175,7 @@ files:
 - lib/pocket/client/retrieve.rb
 - lib/pocket/configuration.rb
 - lib/pocket/connection.rb
+- lib/pocket/domain_metadata.rb
 - lib/pocket/error.rb
 - lib/pocket/oauth.rb
 - lib/pocket/version.rb