pocket-ruby 0.0.3

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+.rake_tasks~
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*
+.idea/*

data/.rspec

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

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--protected
+--tag format:"Supported formats"
+--tag authenticated:"Requires Authentication"
+--tag rate_limited:"Rate Limited"
+--markup markdown
+-
+HISTORY.mkd
+LICENSE.mkd

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Geknowm, Inc.
+Portions Copyright (c) 2011 Instagram (Burbn, Inc.)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+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
+  end
+end

data/demo-server.rb

@@ -0,0 +1,71 @@
+require "sinatra"
+
+require "./lib/pocket.rb"
+
+enable :sessions
+
+CALLBACK_URL = "http://localhost:4567/oauth/callback"
+
+Pocket.configure do |config|
+  config.consumer_key = <http://getpocket.com/developer/apps/>
+end
+
+get '/reset' do
+  puts "GET /reset"
+  session.clear
+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>
+    '
+  else
+    '<a href="/oauth/connect">Connect with Pocket</a>'
+  end
+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}"
+  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
+  redirect "/"
+end
+
+get '/add' do
+  client = Pocket.client(:access_token => session[:access_token])
+  info = client.add :url => 'http://geknowm.com'
+  "<pre>#{info}</pre>"
+end
+
+get "/retrieve" do
+  client = Pocket.client(:access_token => session[:access_token])
+  info = client.retrieve :detailType => :complete
+
+  # html = "<h1>#{user.username}'s recent photos</h1>"
+  # for media_item in client.user_recent_media
+  #   html << "<img src='#{media_item.images.thumbnail.url}'>"
+  # end
+  # html
+  "<pre>#{info}</pre>"
+end

data/lib/faraday/pocket_oauth.rb

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

data/lib/faraday/raise_pocket_error.rb

@@ -0,0 +1,32 @@
+module Faraday
+
+  #   HTTP Status X-Error-Code  X-Error
+  # 400 138 Missing consumer key.
+  # 403 152 Invalid consumer key.
+  # 400 181 Invalid redirect uri.
+  # 400 182 Missing code.
+  # 400 185 Code not found.
+  # 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
+
+    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 Faraday::Error::ClientError, response_values(env)
+      end
+    end
+
+    def response_values(env)
+      {:status => env.status, :headers => env.response_headers, :body => env.body}
+    end
+  end
+end

data/lib/pocket.rb

@@ -0,0 +1,26 @@
+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__)
+
+module Pocket
+  extend Configuration
+
+  # Alias for Pocket::Client.new
+  #
+  # @return [Pocket::Client]
+  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?(method)
+    return client.respond_to?(method) || super
+  end
+end

data/lib/pocket/api.rb

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

data/lib/pocket/client.rb

@@ -0,0 +1,13 @@
+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__)].each{|f| require f}
+
+    include Pocket::Client::Add
+    include Pocket::Client::Modify
+    include Pocket::Client::Retrieve
+  end
+end

data/lib/pocket/client/add.rb

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,12 @@
+module Pocket
+  class Client
+    # 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)
+        response.body
+      end
+    end
+  end
+end

data/lib/pocket/client/retrieve.rb

@@ -0,0 +1,12 @@
+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

data/lib/pocket/configuration.rb

@@ -0,0 +1,85 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module Pocket
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Pocket::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :consumer_key,
+      :access_token,
+      :endpoint,
+      :format,
+      :user_agent,
+      :proxy
+    ].freeze
+
+    # An array of valid request/response formats
+    #
+    # @note Not all methods support the XML format.
+    VALID_FORMATS = [
+      :json].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application ID
+    DEFAULT_CONSUMER_KEY = nil
+
+    # By default, don't set an application redirect uri
+    DEFAULT_REDIRECT_URI = nil
+
+    # By default, don't set a user access token
+    DEFAULT_ACCESS_TOKEN = nil
+
+    # 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
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Pocket Ruby Gem #{Pocket::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # 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.format         = DEFAULT_FORMAT
+      self.user_agent     = DEFAULT_USER_AGENT
+      self.proxy          = DEFAULT_PROXY
+    end
+  end
+end

data/lib/pocket/connection.rb

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

data/lib/pocket/error.rb

@@ -0,0 +1,19 @@
+module Pocket
+  # Custom error class for rescuing from all Pocket errors
+  class Error < StandardError; end
+
+  # Raised when Pocket returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Pocket returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Pocket returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Pocket returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
+end

data/lib/pocket/oauth.rb

@@ -0,0 +1,38 @@
+module Pocket
+  # Defines HTTP request methods
+  module OAuth
+    # Return URL for OAuth authorization
+    def authorize_url(options={})
+      params = access_token_params.merge(options)
+      # Pocket renames `code` to `request_token` for some reason in this call
+      params[:request_token] = params[:code]
+      connection.build_url("/auth/authorize", params).to_s
+    end
+
+    # Return a Pocket code
+    def get_code(options={})
+      params = access_token_params.merge(options)
+      response = connection.post 'oauth/request', params
+      results = Hash[URI.decode_www_form(response.body)]
+      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']
+    end
+
+    private
+
+    def access_token_params
+      {
+        :consumer_key => consumer_key
+      }
+    end
+  end
+end

data/lib/pocket/version.rb

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

data/pocket-ruby.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+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_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.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.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.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Pocket::VERSION.dup
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: pocket-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Turadg Aleahmad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-10 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
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.11
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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'
+  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::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
+email:
+- turadg@aleahmad.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- LICENSE.md
+- Rakefile
+- demo-server.rb
+- lib/faraday/pocket_oauth.rb
+- lib/faraday/raise_pocket_error.rb
+- lib/pocket.rb
+- lib/pocket/api.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/error.rb
+- lib/pocket/oauth.rb
+- lib/pocket/version.rb
+- pocket-ruby.gemspec
+homepage: https://github.com/Geknowm/pocket-ruby
+licenses: []
+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: []