pocket-ruby 0.0.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 53335fc2e8cc2960c4ad80eee2311f1dd97d177d
-  data.tar.gz: a0fa4e91812d0422654fa325405228302fe8c362
+SHA256:
+  metadata.gz: 94c29a4044db768b6c30927048ce55ac9ee329a66008cab931c2888c7976ad47
+  data.tar.gz: a1b61bc70be32418276c523ce08ebf88d1110762f07ce397aacb89aca40e758c
 SHA512:
-  metadata.gz: 5e27da6ac0fc40eecf1624157e6c994667699c8c5b1de0d8bafa31c4fa93a3af46eca355dc43596b61b932475614f53cbc5f9f6149f800e8c3d4fcd88887030d
-  data.tar.gz: b8b9631b728ffa086d0516a9435297772f57f26294e77ffb5308817da3c5a0021ea1d2345f196ade04fdf8667f270a26d4a44ffff7b1daa7bc4fddfb994dcaec
+  metadata.gz: 24755f21d67f9f4408d24615712002b7380a18ac959a6947cd2983a01278c0c58334a1e914742902768b32aaec76f9c37436ee19e0a5d60c93015d15c4727bcc
+  data.tar.gz: d21a10db04f4bb92cda2cbf9e9014019724bf850aabe784d2b7234d301dc2200c2e0d600bec44112118b7fd1ebb5fa0e77e8cfc2fdfa3a298901ab01066adb04

data/.github/workflows/changelog-checker.yml

@@ -0,0 +1,19 @@
+name: changelog-checker
+on:
+  pull_request:
+    types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
+    branches:
+      - master
+jobs:
+  build:
+    name: Check Actions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Changelog check
+        uses: Zomzog/changelog-checker@v1.2.0
+        with:
+          fileName: CHANGELOG.md
+          checksNotification: Simple
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/tests.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.6
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -11,7 +11,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-Gemfile.lock
 # YARD artifacts
 .yardoc
 _yardoc

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## [Unreleased]
+
+## [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))
+- Fix Pocket::Client::Retrieve#retrieve params default ([#21](https://github.com/turadg/pocket-ruby/pull/21))
+
+## [0.0.9] - 2021-04-01
+
+- Actually remove unused Hashie dependency ([#35](https://github.com/turadg/pocket-ruby/pull/35))
+
+## [0.0.8] - 2021-03-31
+
+- Fix Ruby warnings ([#32](https://github.com/turadg/pocket-ruby/pull/32))
+- Remove unused Hashie dependency ([#31](https://github.com/turadg/pocket-ruby/pull/31))
+
+## [0.0.7] - 2021-03-29
+
+- Relax `faraday_middleware` version constraint ([#25](https://github.com/turadg/pocket-ruby/pull/25))

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    pocket-ruby (0.2.0)
+      faraday (>= 0.7)
+      faraday_middleware
+      multi_json (~> 1.0, >= 1.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.4.2)
+    docile (1.3.5)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.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)
+      rack
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      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)
+    standard (1.0.4)
+      rubocop (= 1.11.0)
+      rubocop-performance (= 1.10.1)
+    test-unit (3.4.0)
+      power_assert
+    tilt (1.4.1)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  multi_xml
+  pocket-ruby!
+  rake
+  simplecov
+  sinatra (~> 1.3.3)
+  standard
+  test-unit
+
+BUNDLED WITH
+   2.2.8

data/README.md

@@ -19,13 +19,3 @@ Just clone the repo here and refer to the demo-server.rb file for examples on ho
 Pocket-Ruby can be installed via the gem, ```gem install pocket-ruby```
 
 Or via bundler, ```gem 'pocket-ruby'```
-
-# For v0.0.5 and earlier
-
-Using v0.0.5 and earlier may result in a ```require``` error. To fix this you may either update to a newer version of the gem or uninstall with ```gem uninstall pocket-ruby``` and try again using the method below:
-
-Install via the gem, ```gem install pocket-ruby -v 0.0.5```
-
-Or via bundler, ```gem 'pocket-ruby', '0.0.5', :require => 'pocket'```
-
-Be sure to require the gem in your code with ```require 'pocket'``` not ```require 'pocket-ruby'```

data/Rakefile

@@ -1,27 +1,31 @@
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
+require "standard/rake"
 
-task :default => :spec
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: [:test, :standard]
 
 namespace :doc do
-  begin
-    require 'yard'
-  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
+  require "yard"
+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/demo-server.rb

@@ -1,16 +1,16 @@
 require "sinatra"
 
-require "./lib/pocket.rb"
+require "./lib/pocket-ruby"
 
 enable :sessions
 
 CALLBACK_URL = "http://localhost:4567/oauth/callback"
 
 Pocket.configure do |config|
-  config.consumer_key = '10188-3565cd04d1464e6d0e64b67f'
+  config.consumer_key = "10188-3565cd04d1464e6d0e64b67f"
 end
 
-get '/reset' do
+get "/reset" do
   puts "GET /reset"
   session.clear
 end
@@ -31,8 +31,8 @@ end
 
 get "/oauth/connect" do
   puts "OAUTH CONNECT"
-  session[:code] = Pocket.get_code(:redirect_uri => CALLBACK_URL)
-  new_url = Pocket.authorize_url(:code => session[:code], :redirect_uri => CALLBACK_URL)
+  session[:code] = Pocket.get_code(redirect_uri: CALLBACK_URL)
+  new_url = Pocket.authorize_url(code: session[:code], redirect_uri: CALLBACK_URL)
   puts "new_url: #{new_url}"
   puts "session: #{session}"
   redirect new_url
@@ -42,26 +42,26 @@ get "/oauth/callback" do
   puts "OAUTH CALLBACK"
   puts "request.url: #{request.url}"
   puts "request.body: #{request.body.read}"
-  result = Pocket.get_result(session[:code], :redirect_uri => CALLBACK_URL)
-  session[:access_token] = result['access_token']
-  puts result['access_token']
-  puts result['username']	
+  result = Pocket.get_result(session[:code], redirect_uri: CALLBACK_URL)
+  session[:access_token] = result["access_token"]
+  puts result["access_token"]
+  puts result["username"]
   # Alternative method to get the access token directly
-  #session[:access_token] = Pocket.get_access_token(session[:code])
+  # session[:access_token] = Pocket.get_access_token(session[:code])
   puts session[:access_token]
   puts "session: #{session}"
   redirect "/"
 end
 
-get '/add' do
-  client = Pocket.client(:access_token => session[:access_token])
-  info = client.add :url => 'http://getpocket.com'
+get "/add" do
+  client = Pocket.client(access_token: session[:access_token])
+  info = client.add url: "http://getpocket.com"
   "<pre>#{info}</pre>"
 end
 
 get "/retrieve" do
-  client = Pocket.client(:access_token => session[:access_token])
-  info = client.retrieve(:detailType => :complete, :count => 1)
+  client = Pocket.client(access_token: session[:access_token])
+  info = client.retrieve(detailType: :complete, count: 1)
 
   # html = "<h1>#{user.username}'s recent photos</h1>"
   # for media_item in client.user_recent_media

data/lib/faraday/pocket_oauth.rb

@@ -1,4 +1,4 @@
-require 'faraday'
+require "faraday"
 
 # @private
 module FaradayMiddleware
@@ -6,16 +6,16 @@ module FaradayMiddleware
   class PocketOAuth < Faraday::Middleware
     def call(env)
       env[:body] = {} if env[:body].nil?
-      env[:body] = env[:body].merge(:consumer_key => @consumer_key)
+      env[:body] = env[:body].merge(consumer_key: @consumer_key)
 
       if @access_token
-        env[:body] = env[:body].merge(:access_token => @access_token)
+        env[:body] = env[:body].merge(access_token: @access_token)
       end
 
       @app.call env
     end
 
-    def initialize(app, consumer_key, access_token=nil)
+    def initialize(app, consumer_key, access_token = nil)
       @app = app
       @consumer_key = consumer_key
       @access_token = access_token

data/lib/faraday/raise_pocket_error.rb

@@ -1,5 +1,4 @@
 module Faraday
-
   #   HTTP Status X-Error-Code  X-Error
   # 400 138 Missing consumer key.
   # 403 152 Invalid consumer key.
@@ -9,24 +8,24 @@ module Faraday
   # 403 158 User rejected code.
   # 403 159 Already used code.
   # 50X 199 Pocket server issue.
-  # 
+  #
   # @see http://getpocket.com/developer/docs/authentication
   class Response::RaisePocketError < Response::Middleware
-    ClientErrorStatuses = 400...600
+    CLIENT_ERROR_STATUSES = 400...600
 
     def on_complete(env)
       case env[:status]
       when 404
         raise Faraday::Error::ResourceNotFound, response_values(env)
       when 400...403
-        raise Pocket::Error, env[:response_headers]['X-Error']
-      when ClientErrorStatuses
+        raise Pocket::Error, env[:response_headers]["X-Error"]
+      when CLIENT_ERROR_STATUSES
         raise Faraday::Error::ClientError, response_values(env)
       end
     end
 
     def response_values(env)
-      {:status => env[:status], :headers => env[:response_headers], :body => env[:body]}
+      {status: env[:status], headers: env[:response_headers], body: env[:body]}
     end
   end
 end

data/lib/pocket-ruby.rb

@@ -1,7 +1,9 @@
-require File.expand_path('../pocket/error', __FILE__)
-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/error", __FILE__)
+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__)
 
 module Pocket
   extend Configuration
@@ -9,7 +11,7 @@ module Pocket
   # Alias for Pocket::Client.new
   #
   # @return [Pocket::Client]
-  def self.client(options={})
+  def self.client(options = {})
     Pocket::Client.new(options)
   end
 
@@ -20,7 +22,7 @@ module Pocket
   end
 
   # Delegate to Pocket::Client
-  def self.respond_to?(method)
-    return client.respond_to?(method) || super
+  def self.respond_to_missing?(method)
+    client.respond_to?(method) || super
   end
 end

data/lib/pocket/api.rb

@@ -1,14 +1,14 @@
-require File.expand_path('../connection', __FILE__)
-require File.expand_path('../oauth', __FILE__)
+require File.expand_path("../connection", __FILE__)
+require File.expand_path("../oauth", __FILE__)
 
 module Pocket
   # @private
   class API
     # @private
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
     # Creates a new API
-    def initialize(options={})
+    def initialize(options = {})
       options = Pocket.options.merge(options)
       Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])

data/lib/pocket/article.rb

@@ -0,0 +1,119 @@
+require "json"
+
+module Pocket
+  class Article
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def self.from_json(json_string)
+      new(JSON.parse(json_string))
+    end
+
+    def item_id
+      Integer(response.fetch("item_id"))
+    end
+
+    def given_url
+      response.fetch("given_url")
+    end
+
+    def resolved_url
+      response.fetch("resolved_url")
+    end
+
+    def given_title
+      response.fetch("given_title")
+    end
+
+    def resolved_title
+      response.fetch("resolved_title")
+    end
+
+    def favorite?
+      Integer(response.fetch("favorite")) == 1
+    end
+
+    def status
+      Integer(response.fetch("status"))
+    end
+
+    def excerpt
+      response.fetch("excerpt")
+    end
+
+    def article?
+      Integer(response.fetch("is_article")) == 1
+    end
+
+    def has_image?
+      Integer(response.fetch("has_image")) == 1
+    end
+
+    def image?
+      Integer(response.fetch("has_image")) == 2
+    end
+
+    def has_video?
+      Integer(response.fetch("has_video")) == 1
+    end
+
+    def video?
+      Integer(response.fetch("has_video")) == 2
+    end
+
+    def word_count
+      Integer(response.fetch("word_count"))
+    end
+
+    def resolved_id
+      Integer(response.fetch("resolved_id"))
+    end
+
+    def thumbnail
+      response.fetch("top_image_url", "")
+    end
+
+    def time_added
+      return nil unless response["time_added"]
+      Time.at(Integer(response["time_added"])).utc
+    end
+
+    def time_updated
+      return nil unless response["time_updated"]
+      Time.at(Integer(response["time_updated"])).utc
+    end
+
+    def time_read
+      return nil unless response["time_read"]
+      Time.at(Integer(response["time_read"])).utc
+    end
+
+    def favorited?
+      Integer(response["time_favorited"]) > 0
+    end
+
+    def time_favorited
+      return nil unless response["time_favorited"]
+      Time.at(Integer(response["time_favorited"])).utc
+    end
+
+    def read?
+      Integer(response["time_read"]) > 0
+    end
+
+    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
+  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

@@ -4,7 +4,7 @@ module Pocket
   # @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__)].each{|f| require f}
+    Dir[File.expand_path("../client/*.rb", __FILE__)].sort.each { |f| require f }
 
     include Pocket::Client::Add
     include Pocket::Client::Modify

data/lib/pocket/client/retrieve.rb

@@ -3,7 +3,7 @@ module Pocket
     # http://getpocket.com/developer/docs/v3/retrieve
     module Retrieve
       # required params: consumer_key, access_token
-      def retrieve params=[]
+      def retrieve params = {}
         response = connection.post("/v3/get", params)
         response.body
       end

data/lib/pocket/configuration.rb

@@ -1,5 +1,5 @@
-require 'faraday'
-require File.expand_path('../version', __FILE__)
+require "faraday"
+require File.expand_path("../version", __FILE__)
 
 module Pocket
   # Defines constants and methods related to configuration
@@ -20,7 +20,8 @@ module Pocket
     #
     # @note Not all methods support the XML format.
     VALID_FORMATS = [
-      :json].freeze
+      :json
+    ].freeze
 
     # The adapter that will be used to connect if none is set
     #
@@ -39,7 +40,7 @@ module Pocket
     # The endpoint that will be used to connect if none is set
     #
     # @note There is no reason to use any other endpoint at this time
-    DEFAULT_ENDPOINT = 'https://getpocket.com/v3/'.freeze
+    DEFAULT_ENDPOINT = "https://getpocket.com/v3/".freeze
 
     # The response format appended to the path and sent in the 'Accept' header if none is set
     #
@@ -53,7 +54,7 @@ module Pocket
     DEFAULT_USER_AGENT = "Pocket Ruby Gem #{Pocket::VERSION}".freeze
 
     # @private
-    attr_accessor *VALID_OPTIONS_KEYS
+    attr_accessor(*VALID_OPTIONS_KEYS)
 
     # When this module is extended, set all configuration options to their default values
     def self.extended(base)
@@ -74,14 +75,14 @@ module Pocket
 
     # Reset all configuration options to defaults
     def reset
-      self.adapter        = DEFAULT_ADAPTER
-      self.consumer_key   = DEFAULT_CONSUMER_KEY
-      self.access_token   = DEFAULT_ACCESS_TOKEN
-      self.endpoint       = DEFAULT_ENDPOINT
-      self.redirect_uri   = DEFAULT_REDIRECT_URI
-      self.format         = DEFAULT_FORMAT
-      self.user_agent     = DEFAULT_USER_AGENT
-      self.proxy          = DEFAULT_PROXY
+      self.adapter = DEFAULT_ADAPTER
+      self.consumer_key = DEFAULT_CONSUMER_KEY
+      self.access_token = DEFAULT_ACCESS_TOKEN
+      self.endpoint = DEFAULT_ENDPOINT
+      self.redirect_uri = DEFAULT_REDIRECT_URI
+      self.format = DEFAULT_FORMAT
+      self.user_agent = DEFAULT_USER_AGENT
+      self.proxy = DEFAULT_PROXY
     end
   end
 end

data/lib/pocket/connection.rb

@@ -1,17 +1,17 @@
-require 'faraday_middleware'
-Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+require "faraday_middleware"
+Dir[File.expand_path("../../faraday/*.rb", __FILE__)].sort.each { |f| require f }
 
 module Pocket
   # @private
   module Connection
     private
 
-    def connection(raw=false)
+    def connection(raw = false)
       options = {
-        :headers => {'User-Agent' => user_agent},
-        :proxy => proxy,
-        :ssl => {:verify => false},
-        :url => endpoint,
+        headers: {"User-Agent" => user_agent},
+        proxy: proxy,
+        ssl: {verify: false},
+        url: endpoint
       }
 
       Faraday::Connection.new(options) do |conn|
@@ -20,7 +20,7 @@ module Pocket
 
         conn.request :json
 
-        conn.response :json, :content_type => /\bjson$/
+        conn.response :json, content_type: /\bjson$/
 
         conn.adapter Faraday.default_adapter
       end

data/lib/pocket/oauth.rb

@@ -2,7 +2,7 @@ module Pocket
   # Defines HTTP request methods
   module OAuth
     # Return URL for OAuth authorization
-    def authorize_url(options={})
+    def authorize_url(options = {})
       params = access_token_params.merge(options)
       params.delete(:consumer_key) # shouldn't be exposed publically
       # Pocket renames `code` to `request_token` for some reason in this call
@@ -11,34 +11,34 @@ module Pocket
     end
 
     # Return a Pocket code
-    def get_code(options={})
+    def get_code(options = {})
       params = access_token_params.merge(options)
-      response = connection.post 'oauth/request', params
+      response = connection.post "oauth/request", params
       results = Hash[URI.decode_www_form(response.body)]
-      code = results['code']
+      results["code"]
     end
 
     # Return an access token from authorization
-    def get_access_token(code, options={})
-      params = access_token_params.merge(:code => code).merge(options)
-      response = connection.post 'oauth/authorize', params
+    def get_access_token(code, options = {})
+      params = access_token_params.merge(code: code).merge(options)
+      response = connection.post "oauth/authorize", params
       results = Hash[URI.decode_www_form(response.body)]
-      access_token = results['access_token']
+      results["access_token"]
     end
 
     # Return result from authorization
-    def get_result(code, options={})
-      params = access_token_params.merge(:code => code).merge(options)
-      response = connection.post 'oauth/authorize', params
-      results = Hash[URI.decode_www_form(response.body)]
+    def get_result(code, options = {})
+      params = access_token_params.merge(code: code).merge(options)
+      response = connection.post "oauth/authorize", params
+      Hash[URI.decode_www_form(response.body)]
     end
 
     private
 
     def access_token_params
       {
-        :consumer_key => consumer_key,
-        :redirect_uri => redirect_uri
+        consumer_key: consumer_key,
+        redirect_uri: redirect_uri
       }
     end
   end

data/lib/pocket/version.rb

@@ -1,3 +1,3 @@
 module Pocket
-  VERSION = '0.0.6'
+  VERSION = "0.2.0"
 end

data/pocket-ruby.gemspec

@@ -1,25 +1,27 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/pocket/version', __FILE__)
+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('multi_xml')
-  s.add_runtime_dependency('faraday', ['>= 0.7'])
-  s.add_runtime_dependency('faraday_middleware', '~> 0.9')
-  s.add_runtime_dependency('multi_json', '>= 1.0.3', '~> 1.0')
-  s.add_runtime_dependency('hashie',  '>= 0.4.0')
-  s.authors = ["Turadg Aleahmad","Jason Ng PT"]
-  s.description = %q{A Ruby wrapper for the Pocket API v3 (Add, Modify and Retrieve)}
-  s.email = ['turadg@aleahmad.net',"me@jasonngpt.com"]
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.add_development_dependency("sinatra", "~> 1.3.3")
+  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_runtime_dependency("faraday_middleware")
+  s.add_runtime_dependency("multi_json", ">= 1.0.3", "~> 1.0")
+  s.authors = ["Turadg Aleahmad", "Jason Ng PT", "Andy Waite"]
+  s.description = "A Ruby wrapper for the Pocket API v3 (Add, Modify and Retrieve)"
+  s.email = ["turadg@aleahmad.net", "me@jasonngpt.com"]
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.files = `git ls-files`.split("\n")
-  s.homepage = 'https://github.com/turadg/pocket-ruby'
-  s.name = 'pocket-ruby'
+  s.homepage = "https://github.com/turadg/pocket-ruby"
+  s.name = "pocket-ruby"
   s.platform = Gem::Platform::RUBY
-  s.require_paths = ['lib']
-  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
   s.rubyforge_project = s.name
-  s.summary = %q{Ruby wrapper for the Pocket API v3}
+  s.summary = "Ruby wrapper for the Pocket API v3"
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.version = Pocket::VERSION
 end

data/test/fixtures/retreive.json

@@ -0,0 +1,60 @@
+{
+    "item_id": "229279689",
+    "resolved_id": "229279689",
+    "given_url": "http://www.grantland.com/blog/the-triangle/post/_/id/38347/ryder-cup-preview?given",
+    "given_title": "The Massive Ryder Cup Preview - The Triangle Blog - Grantland",
+    "favorite": "0",
+    "status": "0",
+    "resolved_title": "The Massive Ryder Cup Preview",
+    "resolved_url": "http://www.grantland.com/blog/the-triangle/post/_/id/38347/ryder-cup-preview?resolved",
+    "excerpt": "The list of things I love about the Ryder Cup is so long that it could fill a (tedious) novel, and golf fans can probably guess most of them.",
+    "is_article": "1",
+    "has_video": "1",
+    "has_image": "1",
+    "word_count": "3197",
+    "top_image_url": "https://example.com/image.png",
+    "time_added": "1617412992",
+    "time_updated": "1617412993",
+    "time_read": "1617412994",
+    "time_favorited": "1617412995",
+    "images": {
+        "1": {
+            "item_id": "229279689",
+            "image_id": "1",
+            "src": "http://a.espncdn.com/combiner/i?img=/photo/2012/0927/grant_g_ryder_cr_640.jpg&w=640&h=360",
+            "width": "0",
+            "height": "0",
+            "credit": "Jamie Squire/Getty Images",
+            "caption": ""
+        }
+    },
+    "videos": {
+        "1": {
+            "item_id": "229279689",
+            "video_id": "1",
+            "src": "http://www.youtube.com/v/Er34PbFkVGk?version=3&hl=en_US&rel=0",
+            "width": "420",
+            "height": "315",
+            "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"
+        }
+     }
+}

data/test/pocket/article_test.rb

@@ -0,0 +1,155 @@
+require "test_helper"
+
+module Pocket
+  class VersionTest < Test::Unit::TestCase
+    test "from_json" do
+      json_string = File.read("test/fixtures/retreive.json")
+      article = Pocket::Article.from_json(json_string)
+      assert_equal 229279689, article.item_id
+    end
+
+    test "item_id" do
+      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
+    end
+
+    test "resolved_url" do
+      assert_equal "http://www.grantland.com/blog/the-triangle/post/_/id/38347/ryder-cup-preview?resolved", article.resolved_url
+    end
+
+    test "given_title" do
+      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
+    end
+
+    test "favorite? is false is field is '0'" do
+      assert_equal false, article.favorite?
+    end
+
+    test "status" do
+      assert_equal 0, article.status
+    end
+
+    test "excerpt" do
+      assert_include article.excerpt, "list of things"
+    end
+
+    test "article?" do
+      assert article.article?
+    end
+
+    test "has_image?" do
+      assert article.has_image?
+    end
+
+    test "image?" do
+      refute article.image?
+    end
+
+    test "has_video?" do
+      assert article.has_video?
+    end
+
+    test "video?" do
+      refute article.video?
+    end
+
+    test "word_count" do
+      assert_equal 3197, article.word_count
+    end
+
+    test "resolved_id" do
+      assert_equal 229279689, article.resolved_id
+    end
+
+    test "thumbnail" do
+      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
+    end
+
+    test "time_added is nil if field not present" do
+      parsed_response.delete("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
+    end
+
+    test "time_updated is nil if field not present" do
+      parsed_response.delete("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
+    end
+
+    test "time_read is nil if field is not present" do
+      parsed_response.delete("time_read")
+      assert_nil article.time_read
+    end
+
+    test "favorited?" do
+      assert article.favorited?
+    end
+
+    test "time_favorited" do
+      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
+    end
+
+    test "read?" do
+      assert article.read?
+    end
+
+    test "read_url" do
+      assert_equal "https://getpocket.com/read/229279689", article.read_url
+    end
+
+    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
+
+    private
+
+    def article
+      @article ||= Pocket::Article.new(parsed_response)
+    end
+
+    def parsed_response
+      @parsed_response ||= JSON.parse(File.read("test/fixtures/retreive.json"))
+    end
+  end
+end

data/test/pocket/version_test.rb

@@ -0,0 +1,9 @@
+require "test_helper"
+
+module Pocket
+  class VersionTest < Test::Unit::TestCase
+    def test_specifies_a_version
+      assert Pocket::VERSION
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start do
+  enable_coverage :branch
+end
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "pocket-ruby"
+
+require "test-unit"

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: pocket-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Turadg Aleahmad
 - Jason Ng PT
-autorequire: 
+- Andy Waite
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -40,67 +41,109 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
-    - - "~>"
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
-    - - "~>"
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.3
 description: A Ruby wrapper for the Pocket API v3 (Add, Modify and Retrieve)
 email:
 - turadg@aleahmad.net
@@ -109,9 +152,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/changelog-checker.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
@@ -120,6 +167,8 @@ files:
 - lib/faraday/raise_pocket_error.rb
 - 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
@@ -130,10 +179,14 @@ files:
 - lib/pocket/oauth.rb
 - lib/pocket/version.rb
 - pocket-ruby.gemspec
+- test/fixtures/retreive.json
+- test/pocket/article_test.rb
+- test/pocket/version_test.rb
+- test/test_helper.rb
 homepage: https://github.com/turadg/pocket-ruby
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,9 +201,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: pocket-ruby
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Pocket API v3
-test_files: []
+test_files:
+- test/fixtures/retreive.json
+- test/pocket/article_test.rb
+- test/pocket/version_test.rb
+- test/test_helper.rb