pocket-ruby 0.0.3 → 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 557b74f314ae6f79c561a58668abda58bd81a29a2f761179665937add4c44981
+  data.tar.gz: a9d7663dfefca438432ca578fac028a88e5e2e718dd1ce76f5b4a15c75a748b1
+SHA512:
+  metadata.gz: a9f4da13bca1a90085ce1292e44663a277fe78d1892053fea3c596694150d67aedf1d437d9305a8e435c3cd6a43a0f65beb771f4880f574352f3eb82ff5381bf
+  data.tar.gz: '0866d752ee21a843f6c91c0f46241baaf68ebcb4be49cf02b2591eb245a2342395a4520486fd2275efe3213c292c230599d96eed1e78271b3a6992079d522ba4'

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

@@ -1,13 +1,18 @@
 *.gem
 *.rbc
-.DS_Store
 .bundle
-.rvmrc
-.yardoc
-.rake_tasks~
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
 Gemfile.lock
-coverage/*
-doc/*
-log/*
-pkg/*
-.idea/*
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [Unreleased]
+
+## [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/README.md

@@ -0,0 +1,21 @@
+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) 
+
+# Usage
+
+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
+	cd pocket-ruby
+	bundle install
+	ruby demo-server.rb
+```
+
+Pocket-Ruby can be installed via the gem, ```gem install pocket-ruby```
+
+Or via bundler, ```gem 'pocket-ruby'```

data/Rakefile

@@ -1,10 +1,14 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(: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 => :spec
+task :default => :test
 
 namespace :doc do
   begin

data/demo-server.rb

@@ -1,13 +1,13 @@
 require "sinatra"
 
-require "./lib/pocket.rb"
+require "./lib/pocket-ruby.rb"
 
 enable :sessions
 
 CALLBACK_URL = "http://localhost:4567/oauth/callback"
 
 Pocket.configure do |config|
-  config.consumer_key = <http://getpocket.com/developer/apps/>
+  config.consumer_key = '10188-3565cd04d1464e6d0e64b67f'
 end
 
 get '/reset' do
@@ -18,11 +18,11 @@ end
 get "/" do
   puts "GET /"
   puts "session: #{session}"
-  
+
   if session[:access_token]
     '
-<a href="/add?url=http://geknowm.com">Add Geknowm</a>
-<a href="/retrieve">Retrieve items</a>
+<a href="/add?url=http://getpocket.com">Add Pocket Homepage</a>
+<a href="/retrieve">Retrieve single item</a>
     '
   else
     '<a href="/oauth/connect">Connect with Pocket</a>'
@@ -31,36 +31,37 @@ end
 
 get "/oauth/connect" do
   puts "OAUTH CONNECT"
-  puts "session: #{session}"
   session[:code] = Pocket.get_code(:redirect_uri => CALLBACK_URL)
-  puts "code in connect session: #{session[:code]}"
   new_url = Pocket.authorize_url(:code => session[:code], :redirect_uri => CALLBACK_URL)
   puts "new_url: #{new_url}"
+  puts "session: #{session}"
   redirect new_url
 end
 
 get "/oauth/callback" do
   puts "OAUTH CALLBACK"
-  puts "session: #{session}"
   puts "request.url: #{request.url}"
   puts "request.body: #{request.body.read}"
-  puts "code in callback session: #{session[:code]}"
-  puts "code in callback session: #{session[:code]}"
-  session[:code] = session[:code] if session[:code] == "ef0a7115-e3f2-a253-1147-a16a32"
-  access_token = Pocket.get_access_token(session[:code], :redirect_uri => CALLBACK_URL)
-  session[:access_token] = access_token
+  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])
+  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://geknowm.com'
+  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
+  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/raise_pocket_error.rb

@@ -26,7 +26,7 @@ module Faraday
     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.rb → pocket-ruby.rb}

@@ -23,4 +23,4 @@ module Pocket
   def self.respond_to?(method)
     return client.respond_to?(method) || super
   end
-end
+end

data/lib/pocket/api.rb

@@ -5,7 +5,7 @@ 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={})

data/lib/pocket/client/modify.rb

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

data/lib/pocket/configuration.rb

@@ -10,6 +10,7 @@ module Pocket
       :consumer_key,
       :access_token,
       :endpoint,
+      :redirect_uri,
       :format,
       :user_agent,
       :proxy
@@ -52,7 +53,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)
@@ -77,9 +78,10 @@ module Pocket
       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
+end

data/lib/pocket/oauth.rb

@@ -4,8 +4,9 @@ module Pocket
     # Return URL for OAuth authorization
     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
-      params[:request_token] = params[:code]
+      params[:request_token] ||= params.delete(:code)
       connection.build_url("/auth/authorize", params).to_s
     end
 
@@ -14,24 +15,30 @@ module Pocket
       params = access_token_params.merge(options)
       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(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
+      Hash[URI.decode_www_form(response.body)]
     end
 
     private
 
     def access_token_params
       {
-        :consumer_key => consumer_key
+        :consumer_key => consumer_key,
+        :redirect_uri => redirect_uri
       }
     end
   end

data/lib/pocket/version.rb

@@ -1,3 +1,3 @@
 module Pocket
-  VERSION = '0.0.3'.freeze unless defined?(::Pocket::VERSION)
+  VERSION = '0.0.8'
 end

data/pocket-ruby.gemspec

@@ -2,28 +2,26 @@
 require File.expand_path('../lib/pocket/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.add_development_dependency('rspec', '~> 2.4')
-  s.add_development_dependency('webmock', '~> 1.6')
-  s.add_development_dependency('bluecloth', '~> 2.0.11')
   s.add_development_dependency('sinatra', '~> 1.3.3')
-  s.add_development_dependency('pry', '~> 0.9.10')
   s.add_development_dependency('multi_xml')
-  s.add_runtime_dependency('faraday', ['>= 0.7', '< 0.9'])
-  s.add_runtime_dependency('faraday_middleware', '~> 0.8')
+  s.add_development_dependency('rake')
+  s.add_development_dependency("test-unit")
+  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.add_runtime_dependency('hashie',  '>= 0.4.0')
-  s.authors = ["Turadg Aleahmad"]
-  s.description = %q{A Ruby wrapper for the Pocket REST and Search APIs}
-  s.email = ['turadg@aleahmad.net']
+  s.authors = ["Turadg Aleahmad","Jason Ng PT", "Andy Waite"]
+  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.files = `git ls-files`.split("\n")
-  s.homepage = 'https://github.com/Geknowm/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.rubyforge_project = s.name
-  s.summary = %q{Ruby wrapper for the Pocket API}
+  s.summary = %q{Ruby wrapper for the Pocket API v3}
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.version = Pocket::VERSION.dup
+  s.version = Pocket::VERSION
 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,6 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "pocket-ruby"
+
+require "test-unit"

metadata

@@ -1,205 +1,156 @@
 --- !ruby/object:Gem::Specification
 name: pocket-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.8
 platform: ruby
 authors:
 - Turadg Aleahmad
-autorequire: 
+- Jason Ng PT
+- Andy Waite
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: bluecloth
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.11
+        version: 1.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.11
+        version: 1.3.3
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: multi_xml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.10
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.10
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_xml
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
-description: A Ruby wrapper for the Pocket REST and Search APIs
+description: A Ruby wrapper for the Pocket API v3 (Add, Modify and Retrieve)
 email:
 - turadg@aleahmad.net
+- me@jasonngpt.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .yardopts
+- ".github/workflows/changelog-checker.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
+- README.md
 - Rakefile
 - demo-server.rb
 - lib/faraday/pocket_oauth.rb
 - lib/faraday/raise_pocket_error.rb
-- lib/pocket.rb
+- lib/pocket-ruby.rb
 - lib/pocket/api.rb
 - lib/pocket/client.rb
 - lib/pocket/client/add.rb
@@ -211,28 +162,30 @@ files:
 - lib/pocket/oauth.rb
 - lib/pocket/version.rb
 - pocket-ruby.gemspec
-homepage: https://github.com/Geknowm/pocket-ruby
+- test/pocket/version_test.rb
+- test/test_helper.rb
+homepage: https://github.com/turadg/pocket-ruby
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: pocket-ruby
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
-summary: Ruby wrapper for the Pocket API
-test_files: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the Pocket API v3
+test_files:
+- test/pocket/version_test.rb
+- test/test_helper.rb

data/.rspec

@@ -1,3 +0,0 @@
---color
---format=nested
---backtrace