pocket-ruby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f83cad90dd723c6fca321e9c1851141faac117ecf3e34dba0880c93494485f15
-  data.tar.gz: 1458858158eb2ddfbe63bb732bbe07af2d15aeab6fe93f4bd015ab74641fa5b4
+  metadata.gz: 4d5d9cc7d714e363b5d185ab6c83f9c60c7650dca3bb80942d490342c1b296f1
+  data.tar.gz: 895f07cc0c151ab089fbd02a41776894ce94a4a87f5e35e2f3597f3321d531ab
 SHA512:
-  metadata.gz: 7e1b0318db4819e83719397f4cd3c67f2aa66a62d9e0305f93ab782fe5537d1130c0a6298b360e486554826086f9bda48a49c76ddd63923b9f9fdf9960010ba1
-  data.tar.gz: 355774840e30cd2841360c15725c019afdd2ad284ca1de05f028339369a9761ba83162f17a9c510b2696be5bebf253fae6a682e1e11f851e0e23dd9e3742b2c8
+  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,6 +1,15 @@
 ## [Unreleased]
 
-## [0.3.0] - 2021-04-18
+## [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)).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pocket-ruby (0.4.0)
+    pocket-ruby (0.5.0)
       faraday (>= 1.0)
       faraday_middleware
       multi_json (~> 1.0, >= 1.0.3)
@@ -15,29 +15,35 @@ GEM
     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)
     public_suffix (4.0.6)
-    rack (1.6.13)
-    rack-protection (1.5.5)
+    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)
@@ -60,24 +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
@@ -85,10 +94,11 @@ DEPENDENCIES
   pocket-ruby!
   rake
   simplecov
-  sinatra (~> 1.3.3)
+  sinatra (~> 2)
   standard
   test-unit
   webmock
+  yard
 
 BUNDLED WITH
    2.2.8

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/pocket-ruby.rb

@@ -5,9 +5,12 @@ 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
   #

data/lib/pocket/client.rb

@@ -21,5 +21,13 @@ module Pocket
       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/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.4.0"
+  VERSION = "0.5.0"
 end

data/pocket-ruby.gemspec

@@ -1,13 +1,14 @@
 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_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")

data/test/pocket/client_test.rb

@@ -7,8 +7,6 @@ class ClientTest < Test::Unit::TestCase
       .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}"
         }
@@ -20,4 +18,42 @@ class ClientTest < Test::Unit::TestCase
 
     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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Turadg Aleahmad
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-18 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
@@ -110,6 +110,20 @@ dependencies:
     - - ">="
       - !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
@@ -142,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
@@ -188,6 +202,7 @@ files:
 - 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
@@ -214,7 +229,7 @@ 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