pocket-ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d7b6ddfe9a36ea0ec8e2f9cf289882025e83f1a864edc99df3bc1deaf2aef0e
-  data.tar.gz: 7b7e5197505e43aaf60d59187a0c453ace474e317aa135b197d4ec1883c159bc
+  metadata.gz: f83cad90dd723c6fca321e9c1851141faac117ecf3e34dba0880c93494485f15
+  data.tar.gz: 1458858158eb2ddfbe63bb732bbe07af2d15aeab6fe93f4bd015ab74641fa5b4
 SHA512:
-  metadata.gz: 1e39623af247edd6aaf4e7d6a3ea932ec81b770cf9807b63991af63b764be306934e3a50bbdfb3ff8dfda555e8ccc5e14d8fb97edefb118749e2fe02818a0239
-  data.tar.gz: ac0a9a2fba76645632bc045f785ac21ed1cf4687a8a873320ab73debce00a95d79415986e9a267855e34662afd4aacf6f9614648cd7ceb2b7e608efea6c71067
+  metadata.gz: 7e1b0318db4819e83719397f4cd3c67f2aa66a62d9e0305f93ab782fe5537d1130c0a6298b360e486554826086f9bda48a49c76ddd63923b9f9fdf9960010ba1
+  data.tar.gz: 355774840e30cd2841360c15725c019afdd2ad284ca1de05f028339369a9761ba83162f17a9c510b2696be5bebf253fae6a682e1e11f851e0e23dd9e3742b2c8

data/CHANGELOG.md

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

data/Gemfile.lock

@@ -1,15 +1,19 @@
 PATH
   remote: .
   specs:
-    pocket-ruby (0.3.0)
-      faraday (>= 0.7)
+    pocket-ruby (0.4.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-net_http (~> 1.0)
@@ -18,6 +22,7 @@ GEM
     faraday-net_http (1.0.1)
     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)
@@ -25,6 +30,7 @@ GEM
     parser (3.0.0.0)
       ast (~> 2.4.1)
     power_assert (2.0.0)
+    public_suffix (4.0.6)
     rack (1.6.13)
     rack-protection (1.5.5)
       rack
@@ -65,6 +71,10 @@ GEM
       power_assert
     tilt (1.4.1)
     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)
 
 PLATFORMS
   x86_64-darwin-19
@@ -78,6 +88,7 @@ DEPENDENCIES
   sinatra (~> 1.3.3)
   standard
   test-unit
+  webmock
 
 BUNDLED WITH
    2.2.8

data/README.md

@@ -29,11 +29,14 @@ Below are some aspects of the Pocket API that aren't covered in the official doc
 * 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`
+  * `domain_metadata`
+  * `is_index`
+  * `lang` ([ISO_639-1](https://en.wikipedia.org/wiki/ISO_639-1)?)
   * `listen_duration_estimate`
-  * `time_to_read`
   * `sort_id`
-  * `lang` ([ISO_639-1](https://en.wikipedia.org/wiki/ISO_639-1)?)
+  * `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/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

@@ -15,15 +15,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?
@@ -46,6 +46,7 @@ module Pocket
     end
 
     def article?
+      return false unless response["is_article"]
       Integer(response.fetch("is_article")) == 1
     end
 

data/lib/pocket/client.rb

@@ -1,13 +1,25 @@
 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
   end
 end

data/lib/pocket/version.rb

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

data/pocket-ruby.gemspec

@@ -7,7 +7,8 @@ Gem::Specification.new do |s|
   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_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/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,148 +13,163 @@ 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
+      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
+      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
+      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
+      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
 
     test "tags" do
-      assert_equal ["my-tag-1", "my-tag-2"], article.tags
+      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
+      assert_equal [], @article.tags
     end
 
     test "authors" do
-      result = article.authors
+      result = @article.authors
       assert_equal 1, result.size
       assert_equal "Stephen King", result.first.name
       assert_equal 62344201, result.first.id
@@ -159,53 +178,49 @@ module Pocket
 
     test "authors returns an empty array if there are no tags" do
       parsed_response.delete("authors")
-      assert_equal [], article.authors
+      assert_equal [], @article.authors
     end
 
     test "time_to_read" do
-      assert_equal 14, article.time_to_read
+      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
+      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
+      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
+      assert_nil @article.time_to_read_category
 
       parsed_response["time_to_read"] = 0
-      assert_nil article.time_to_read_category
+      assert_nil @article.time_to_read_category
 
       parsed_response["time_to_read"] = 25
-      assert_equal "very_long", article.time_to_read_category
+      assert_equal "very_long", @article.time_to_read_category
 
       parsed_response["time_to_read"] = 15
-      assert_equal "long", article.time_to_read_category
+      assert_equal "long", @article.time_to_read_category
 
       parsed_response["time_to_read"] = 8
-      assert_equal "medium", article.time_to_read_category
+      assert_equal "medium", @article.time_to_read_category
 
       parsed_response["time_to_read"] = 3
-      assert_equal "quick", article.time_to_read_category
+      assert_equal "quick", @article.time_to_read_category
     end
 
     test "domain_metadata" do
-      assert_equal "The Verge", article.domain_metadata.name
+      assert_equal "The Verge", @article.domain_metadata.name
     end
 
     private
 
-    def article
-      @article ||= Pocket::Article.new(parsed_response)
-    end
-
     def parsed_response
       @parsed_response ||= JSON.parse(File.read("test/fixtures/retreive.json"))
     end

data/test/pocket/client_test.rb

@@ -0,0 +1,23 @@
+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: {
+          "Accept" => "*/*",
+          "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+          "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
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pocket-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Turadg Aleahmad
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -96,20 +96,34 @@ 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: 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
@@ -170,9 +184,6 @@ files:
 - 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
@@ -182,6 +193,7 @@ files:
 - 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
@@ -209,5 +221,6 @@ 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