instapaper 1.0.0.pre3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b394bf891476b148b96540e672a0802158338390
-  data.tar.gz: b397e12efbfe0eeb28e579d66fea4ccc0b4ad549
+  metadata.gz: 9d5a373c9cb9c47ef7fcadc1b9608974f9710756
+  data.tar.gz: d3f197b58e0cd8a74f69bf6644333d0071a76220
 SHA512:
-  metadata.gz: 08564a692be926e773019744589923d8359ce098701d172fd8f77a69604c11f2920a673a3e920f363839a2264704118ca23fe16fff41b3c1ac3047c942ec62e0
-  data.tar.gz: e67be46762dbf22c8d0e3b492aaf8e02abc45d7683cfd7d11d795c975dffe5b1d627044180520b7f90ff1592c1c9092c5611041240c705d7c2669ab6bbecf182
+  metadata.gz: c1cb814139e10f430465001d096a71e48c4b94f5da15f5ea960c80647c4a67e6946d8bd219b4a7c0acd01a5fff0462a9467fe628c49b90694f6e13710a47d8ce
+  data.tar.gz: 716df4e63310adf3a2dba476cfd75e66d31ed42483cd9441fdb59beb583af65527138d927f123b2f7a31f43fca4a9991c98ba70133dfe9fd42af6cca5abe2f45

data/README.md

@@ -1,7 +1,14 @@
-# Instapaper [![Build Status](https://secure.travis-ci.org/stve/instapaper.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/stve/instapaper.png?travis)][gemnasium]
+# Instapaper
 
-[travis]: http://travis-ci.org/stve/instapaper
+[![Gem Version](http://img.shields.io/gem/v/instapaper.svg)][gem]
+[![Build Status](http://img.shields.io/travis/stve/instapaper.svg)][travis]
+[![Dependency Status](http://img.shields.io/gemnasium/stve/instapaper.svg)][gemnasium]
+[![Code Climate](http://img.shields.io/codeclimate/github/stve/instapaper.svg)][codeclimate]
+
+[gem]: https://rubygems.org/gems/instapaper
+[travis]: https://travis-ci.org/stve/instapaper
 [gemnasium]: https://gemnasium.com/stve/instapaper
+[codeclimate]: https://codeclimate.com/github/stve/instapaper
 
 
 Instapaper is a ruby wrapper for interacting with [Instapaper's Full API](https://www.instapaper.com/api/full).  Note that access to the Full API is restricted to Instapaper subscribers only.

data/instapaper.gemspec

@@ -4,7 +4,7 @@ require 'instapaper/version'
 
 Gem::Specification.new do |spec|
   spec.add_dependency 'addressable', '~> 2.3'
-  spec.add_dependency 'http', '~> 1.0'
+  spec.add_dependency 'http', '~> 2'
   spec.add_dependency 'multi_json', '~> 1'
   spec.add_dependency 'simple_oauth', '~> 0.3'
   spec.add_dependency 'virtus', '~> 1'

data/lib/instapaper/api/oauth.rb

@@ -9,7 +9,7 @@ module Instapaper
       def access_token(username, password)
         response = perform_post_with_unparsed_response('/api/1.1/oauth/access_token', x_auth_username: username, x_auth_password: password, x_auth_mode: 'client_auth')
         parsed_response = QLineParser.parse(response)
-        fail Instapaper::Error::OAuthError, parsed_response['error'] if parsed_response.key?('error')
+        raise Instapaper::Error::OAuthError, parsed_response['error'] if parsed_response.key?('error')
         Instapaper::Credentials.new(parsed_response)
       end
     end

data/lib/instapaper/error.rb

@@ -4,14 +4,32 @@ module Instapaper
     # @return [Integer]
     attr_reader :code
 
+    ClientError = Class.new(self)
+    ServerError = Class.new(self)
     ServiceUnavailableError = Class.new(self)
     BookmarkError = Class.new(self)
     FolderError = Class.new(self)
     HighlightError = Class.new(self)
     OAuthError = Class.new(self)
 
-    ERRORS = {
-      401  => 'Unauthorized',
+    CLIENT_ERRORS = {
+      400 => 'Bad Request',
+      401 => 'Unauthorized',
+      402 => 'Payment Required',
+      403 => 'Forbidden',
+      404 => 'Not Found',
+      405 => 'Method Not Allowed',
+    }
+
+    SERVER_ERRORS = {
+      500 => 'Internal Server Error',
+      501 => 'Not Implemented',
+      502 => 'Bad Gateway',
+      503 => 'Service Unavailable',
+      504 => 'Gateway Timeout',
+    }
+
+    SERVICE_ERRORS = {
       1040 => 'Rate-limit exceeded',
       1041 => 'Premium account required',
       1042 => 'Application is suspended',
@@ -43,29 +61,47 @@ module Instapaper
     }
 
     CODES = [
-      ERRORS,
+      CLIENT_ERRORS,
+      SERVER_ERRORS,
+      SERVICE_ERRORS,
       BOOKMARK_ERRORS,
       FOLDER_ERRORS,
       HIGHLIGHT_ERRORS,
     ].collect(&:keys).flatten
 
+    HTTP_ERRORS = CLIENT_ERRORS.merge(SERVER_ERRORS)
+
     # Create a new error from an HTTP response
     #
     # @param response [HTTP::Response]
     # @return [Instapaper::Error]
     def self.from_response(code, path)
-      if ERRORS.keys.include?(code)
-        new(ERRORS[code], code)
+      if (HTTP_ERRORS.keys + SERVICE_ERRORS.keys).include?(code)
+        from_response_code(code)
       else
         case path
         when /highlights/ then HighlightError.new(HIGHLIGHT_ERRORS[code], code)
         when /bookmarks/ then BookmarkError.new(BOOKMARK_ERRORS[code], code)
         when /folders/ then FolderError.new(FOLDER_ERRORS[code], code)
-        else new('Unknown Error Code', code)
+        else new('Unknown Error', code)
         end
       end
     end
 
+    # Create a new error from an HTTP response code
+    #
+    # @param code [Integer]
+    # @return [Instapaper::Error]
+    def self.from_response_code(code)
+      if CLIENT_ERRORS.keys.include?(code)
+        ClientError.new(CLIENT_ERRORS[code], code)
+      elsif SERVER_ERRORS.keys.include?(code)
+        ServerError.new(SERVER_ERRORS[code], code)
+      elsif SERVICE_ERRORS.keys.include?(code)
+        new(SERVICE_ERRORS[code], code)
+      end
+    end
+
     # Initializes a new Error object
     #
     # @param message [Exception, String]

data/lib/instapaper/http/request.rb

@@ -1,10 +1,7 @@
 require 'addressable/uri'
 require 'http'
-require 'json'
-require 'net/https'
-require 'openssl'
-require 'instapaper/error'
 require 'instapaper/http/headers'
+require 'instapaper/http/response'
 
 module Instapaper
   module HTTP
@@ -27,61 +24,17 @@ module Instapaper
 
       # @return [Array, Hash]
       def perform
-        perform_request
+        raw = @options.delete(:raw)
+        response = Instapaper::HTTP::Response.new(perform_request, path, raw)
+        response.valid? && response.body
       end
 
       private
 
       def perform_request
-        raw = @options.delete(:raw)
         @headers = Instapaper::HTTP::Headers.new(@client, @request_method, @uri, @options).request_headers
         options_key = @request_method == :get ? :params : :form
-        response = ::HTTP.headers(@headers).public_send(@request_method, @uri.to_s, options_key => @options)
-        fail_if_error(response, raw)
-        raw ? response.to_s : parsed_response(response)
-      end
-
-      def fail_if_error(response, raw)
-        fail_if_error_unparseable_response(response) unless raw
-        fail_if_error_in_body(parsed_response(response))
-        fail_if_error_response_code(response)
-      end
-
-      def fail_if_error_response_code(response)
-        return if response.status == 200
-
-        if Instapaper::Error::CODES.include?(response.status.code)
-          fail Instapaper::Error.from_response(response.status.code, @path)
-        else
-          fail Instapaper::Error::ServiceUnavailableError
-        end
-      end
-
-      def fail_if_error_unparseable_response(response)
-        response.parse(:json)
-      rescue JSON::ParserError
-        raise Instapaper::Error::ServiceUnavailableError
-      end
-
-      def fail_if_error_in_body(response)
-        error = error(response)
-        fail(error) if error
-      end
-
-      def error(response)
-        return unless response.is_a?(Array)
-        return unless response.size > 0
-        return unless response.first['type'] == 'error'
-
-        Instapaper::Error.from_response(response.first['error_code'], @path)
-      end
-
-      def parsed_response(response)
-        @parsed_response ||= begin
-          response.parse(:json)
-        rescue
-          response.body
-        end
+        ::HTTP.headers(@headers).public_send(@request_method, @uri.to_s, options_key => @options)
       end
     end
   end

data/lib/instapaper/http/response.rb

@@ -0,0 +1,63 @@
+require 'json'
+require 'instapaper/error'
+
+module Instapaper
+  module HTTP
+    class Response
+      attr_reader :response, :raw_format, :path
+      def initialize(response, path, raw_format = false)
+        @response = response
+        @path = path
+        @raw_format = raw_format
+      end
+
+      def body
+        raw_format ? response.to_s : parsed
+      end
+
+      def valid?
+        !error?
+      end
+
+      def error?
+        fail_if_body_unparseable unless raw_format
+        fail_if_body_contains_error
+        fail_if_http_error
+      end
+
+      private
+
+      def parsed
+        @parsed_response ||= begin
+          response.parse(:json)
+        rescue
+          response.body
+        end
+      end
+
+      def fail_if_http_error
+        return if response.status.ok?
+
+        if Instapaper::Error::CODES.include?(response.status.code) # rubocop:disable Style/GuardClause
+          raise Instapaper::Error.from_response(response.status.code, path)
+        else
+          raise Instapaper::Error, 'Unknown Error'
+        end
+      end
+
+      def fail_if_body_unparseable
+        response.parse(:json)
+      rescue JSON::ParserError
+        raise Instapaper::Error::ServiceUnavailableError
+      end
+
+      def fail_if_body_contains_error
+        return unless parsed.is_a?(Array)
+        return if parsed.empty?
+        return unless parsed.first['type'] == 'error'
+
+        raise Instapaper::Error.from_response(parsed.first['error_code'], @path)
+      end
+    end
+  end
+end

data/lib/instapaper/http/utils.rb

@@ -60,6 +60,11 @@ module Instapaper
         if response.key?('hash')
           response['instapaper_hash'] = response.delete('hash')
         end
+        if response.key?('bookmarks')
+          response['bookmarks'] = response['bookmarks'].collect do |bookmark|
+            coerce_hash(bookmark)
+          end
+        end
         response
       end
     end

data/lib/instapaper/version.rb

@@ -1,3 +1,3 @@
 module Instapaper
-  VERSION = '1.0.0.pre3'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instapaper
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre3
+  version: 1.0.0
 platform: ruby
 authors:
 - Steve Agalloco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,7 @@ files:
 - lib/instapaper/http/headers.rb
 - lib/instapaper/http/qline_parser.rb
 - lib/instapaper/http/request.rb
+- lib/instapaper/http/response.rb
 - lib/instapaper/http/utils.rb
 - lib/instapaper/user.rb
 - lib/instapaper/version.rb
@@ -138,14 +139,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Ruby Instapaper Client
 test_files: []
-has_rdoc: