mercury_web_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e898796910ce856c75c95b28281b76d7abc9f5b
+  data.tar.gz: 3f374381395d596cea22a88fcce6253cc57433f8
+SHA512:
+  metadata.gz: e3fedbc7241d6302552b95aaf477d9de803f042f5e8ab8f041a1d8fd2585908f306f0eba156e167bab219ce0ee3ef06174ea6f79a648533ec86fa4ac5ce7eeea
+  data.tar.gz: f966a98563f9f18ac204ebb669e4f515c77ac4c776adf81e6c9af94b24a92881f0fb2aaedb1a6a026b2fb6ab9faf716e1e3d2e58fdb88c73da152eb656d07c19

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle
+.projections.json
+.ruby-gemset
+.ruby-version
+Gemfile.lock
+doc/
+pkg/
+rdoc/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.1
+  - 2.2
+
+matrix:
+  fast_finish: true
+
+before_install:
+  - gem update bundler
+
+script:
+  - bundle exec rake
+  - bundle exec danger

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Mercury Web Parser Changelog
+
+## 0.1.0
+
+* Initial release

data/Dangerfile

@@ -0,0 +1 @@
+commit_lint.check

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org/'
+
+gemspec
+
+gem 'pry'
+
+group :test do
+  gem 'rake'
+end

data/LICENSE

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) 2016
+
+- Jim Fiorato
+
+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.
+0

data/README.md

@@ -0,0 +1,76 @@
+# Mercury Web Parser
+
+A simple Ruby wrapper for the [Mercury Web Parser API][mercury-url]
+
+[![Build Status][travis-badge]][travis] [![Code Climate][code-climate-badge]][code-climate]
+
+[travis-badge]: https://travis-ci.org/theoldreader/mercury_web_parser.png
+[travis]: http://travis-ci.org/theoldreader/mercury_web_parser
+[code-climate-badge]: https://codeclimate.com/github/theoldreader/mercury_web_parser.png
+[code-climate]: https://codeclimate.com/github/theoldreader/mercury_web_parser
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'mercury_web_parser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mercury_web_parser
+
+## Configuration
+You must first obtain an API token from the fine folks at [Mercury][mercury-url]
+in order to make requests to their Web Parser API.
+
+Single token usage
+
+    MercuryWebParser.api_token = API_TOKEN
+
+or set multiple options with a block:
+```ruby
+MercuryWebParser.configure do |parser|
+  parser.api_token = API_TOKEN
+end
+```
+
+
+Multiple tokens or multithreaded usage:
+
+```ruby
+client = MercuryWebParser::Client.new(api_token: API_TOKEN)
+```
+
+## Usage
+
+### Parse
+
+Parse a webpage and return its main content:
+
+```ruby
+article = MercuryWebParser.parse("http://sethgodin.typepad.com/seths_blog/2016/11/all-we-have-is-each-other.html")
+=> #<MercuryWebParser::Article title="Seth's Blog", author=nil, date_published=nil, dek=nil, lead_image_url="http://www.sethgodin.com/sg/images/og.jpg", content="<div id=\"alpha-inner\" class=\"pkg\"> <div class=\"module-typelist module\">...", next_page_url="http://sethgodin.typepad.com/seths_blog/2016/11/choose-better.html", url="http://sethgodin.typepad.com/seths_blog/2016/11/all-we-have-is-each-other.html", domain="sethgodin.typepad.com", excerpt="", word_count=462, direction="ltr", total_pages=4, pages_rendered=4>
+
+article.title
+article.content
+article.author
+article.date_published
+article.lead_image_url
+article.dek
+article.next_page_url
+article.url
+article.domain
+article.excerpt
+article.word_count
+article.direction
+article.total_pages
+article.rendered_pages
+```
+
+## Inspiration
+Clone of [readability_parser](https://github.com/phildionne/readability_parser) gem
+
+[mercury-url]: https://mercury.postlight.com/web-parser/

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+task default: [:spec, :rubocop]

data/fixtures/vcr_cassettes/connection_errors.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://mercury.postlight.com/parser?url=http%3A%2F%2Fwww.google.com
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - MercuryWebParser Ruby Gem 0.1.0
+      X-api-key:
+      - '1234'
+  response:
+    status:
+      code: 401
+      message: 
+    headers:
+      content-length:
+      - '26'
+      content-type:
+      - application/json
+      date:
+      - Wed, 30 Nov 2016 03:43:36 GMT
+      via:
+      - 1.1 051be6c213d69e313cabc1e7eee2a118.cloudfront.net (CloudFront)
+      x-amz-cf-id:
+      - isOCPBGabdbNiXorBpblYgzAa4_BAsbjxzSKCt5SUpdajbSOeCP7rA==
+      x-amzn-errortype:
+      - UnauthorizedException
+      x-amzn-requestid:
+      - 2c7f96be-b6af-11e6-a859-2d8d278efab2
+      x-cache:
+      - Error from cloudfront
+      age:
+      - '0'
+      connection:
+      - close
+      server:
+      - BitBalloon
+    body:
+      encoding: UTF-8
+      string: '{"message":"Unauthorized"}'
+    http_version: 
+  recorded_at: Wed, 30 Nov 2016 03:43:36 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/parser_errors.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://mercury.postlight.com/parser?url=http%3A%2F%2Fabc.go.com%2Frobots.txt
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - MercuryWebParser Ruby Gem 0.1.0
+      X-api-key:
+      - PvKK11D5fKtwj06eD0AevxAdUAWB1Ra3jTaeIgXE
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      access-control-allow-origin:
+      - "*"
+      content-length:
+      - '4'
+      content-type:
+      - application/json
+      date:
+      - Wed, 30 Nov 2016 03:47:28 GMT
+      via:
+      - 1.1 ea768b6198c0f73b6fb05e3625d27a5d.cloudfront.net (CloudFront)
+      x-amz-cf-id:
+      - 78gk1qd8sMcETNy4f0guFwWjvT4RZmMn0LqJPCgY3T7ED-jT1V5LCA==
+      x-amzn-requestid:
+      - b6e3e74a-b6af-11e6-8ccf-b3e2989761ed
+      x-amzn-trace-id:
+      - Root=1-583e4bd0-8c4ee867e61287c843a16623
+      x-cache:
+      - Miss from cloudfront
+      age:
+      - '0'
+      connection:
+      - close
+      server:
+      - BitBalloon
+    body:
+      encoding: UTF-8
+      string: 'null'
+    http_version: 
+  recorded_at: Wed, 30 Nov 2016 03:47:28 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/successful.yml

@@ -0,0 +1,109 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://mercury.postlight.com/parser?url=https%3A%2F%2Fmedium.com%2F%40readability%2Fthe-readability-bookmarking-service-will-shut-down-on-september-30-2016-1641cc18e02b
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - MercuryWebParser Ruby Gem 0.1.0
+      X-api-key:
+      - PvKK11D5fKtwj06eD0AevxAdUAWB1Ra3jTaeIgXE
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      access-control-allow-origin:
+      - "*"
+      content-length:
+      - '2706'
+      content-type:
+      - application/json
+      date:
+      - Wed, 30 Nov 2016 02:59:26 GMT
+      via:
+      - 1.1 631585eaa766d0d1b2a196fb1d81ea69.cloudfront.net (CloudFront)
+      x-amz-cf-id:
+      - yYv44_ZYseF8o8aqui50IgjeckqlcMizRdVqMZXCdX1vnrGH_1Q9iw==
+      x-amzn-requestid:
+      - 008b8373-b6a9-11e6-aff9-a322a87b8369
+      x-amzn-trace-id:
+      - Root=1-583e408d-aec2ea51a4d78b1f7da07c83
+      x-cache:
+      - Miss from cloudfront
+      age:
+      - '1'
+      connection:
+      - close
+      server:
+      - BitBalloon
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ0aXRsZSI6IlRoZSBSZWFkYWJpbGl0eSBib29rbWFya2luZyBzZXJ2aWNl
+        IHdpbGwgc2h1dCBkb3duIG9uIFNlcHRlbWJlciAzMCwgMjAxNi4iLCJjb250
+        ZW50IjoiPGRpdj48ZGl2IGNsYXNzPVwic2VjdGlvbi1jb250ZW50XCI+PGRp
+        diBjbGFzcz1cInNlY3Rpb24taW5uZXIgc2VjdGlvbkxheW91dC0taW5zZXRD
+        b2x1bW5cIj48cCBpZD1cIjI5YmFcIiBjbGFzcz1cImdyYWYgZ3JhZi0tcCBn
+        cmFmLWFmdGVyLS1oM1wiPkFmdGVyIG1vcmUgdGhhbiBmaXZlIHllYXJzIG9m
+        IG9wZXJhdGlvbiwgdGhlIFJlYWRhYmlsaXR5IGFydGljbGUgYm9va21hcmtp
+        bmcvcmVhZC1pdC1sYXRlciBzZXJ2aWNlIHdpbGwgYmUgc2h1dHRpbmcgZG93
+        biBhZnRlciA8c3Ryb25nIGNsYXNzPVwibWFya3VwLS1zdHJvbmcgbWFya3Vw
+        LS1wLXN0cm9uZ1wiPlNlcHRlbWJlciAzMCwgMjAxNjwvc3Ryb25nPi48L3A+
+        PHAgaWQ9XCJiMWQ1XCIgY2xhc3M9XCJncmFmIGdyYWYtLXAgZ3JhZi1hZnRl
+        ci0tcFwiPklmIHlvdSYjeDIwMTk7ZCBsaWtlIHRvIHNhdmUgeW91ciBib29r
+        bWFya3MsIHBsZWFzZSBmb2xsb3cgdGhlc2UgZGlyZWN0aW9ucyBiZWZvcmUg
+        PHN0cm9uZyBjbGFzcz1cIm1hcmt1cC0tc3Ryb25nIG1hcmt1cC0tcC1zdHJv
+        bmdcIj5TZXB0ZW1iZXIgMzAsIDIwMTY8L3N0cm9uZz4uIFlvdSBjYW4gZXhw
+        b3J0IHlvdXIgYm9va21hcmtzIGJ5IHZpc2l0aW5nIHlvdXIgVG9vbHMgcGFn
+        ZSwgc2Nyb2xsaW5nIGRvd24gdG8gdGhlIERhdGEgRXhwb3J0IHNlY3Rpb24s
+        IGFuZCBjbGlja2luZyB0aGUgRXhwb3J0IFlvdXIgRGF0YSBidXR0b24uIFlv
+        dSYjeDIwMTk7bGwgcmVjZWl2ZSBhbiBlbWFpbCBzb29uIGFmdGVyIHRoYXQg
+        Y29udGFpbnMgeW91ciBib29rbWFya3MuIFNpbWlsYXIgc2VydmljZXMgbGlr
+        ZSBJbnN0YXBhcGVyIHdpbGwgYWxsb3cgeW91IHRvIGltcG9ydCB5b3VyIGJv
+        b2ttYXJrcyBpbnRvIHRoZWlyIHNlcnZpY2UuPC9wPjxwIGlkPVwiNGMxY1wi
+        IGNsYXNzPVwiZ3JhZiBncmFmLS1wIGdyYWYtYWZ0ZXItLXBcIj48c3Ryb25n
+        IGNsYXNzPVwibWFya3VwLS1zdHJvbmcgbWFya3VwLS1wLXN0cm9uZ1wiPjxl
+        bSBjbGFzcz1cIm1hcmt1cC0tZW0gbWFya3VwLS1wLWVtXCI+V2hhdCBpZiBJ
+        IHVzZSB0aGUgUmVhZGFiaWxpdHkgUGFyc2VyIEFQST88L2VtPjwvc3Ryb25n
+        PjwvcD48cCBpZD1cIjYwOGVcIiBjbGFzcz1cImdyYWYgZ3JhZi0tcCBncmFm
+        LWFmdGVyLS1wXCI+VGhlIFJlYWRhYmlsaXR5IFBhcnNlciBBUEkgZm9yIGRl
+        dmVsb3BlcnMgd2lsbCBzaHV0IGRvd24gPHN0cm9uZyBjbGFzcz1cIm1hcmt1
+        cC0tc3Ryb25nIG1hcmt1cC0tcC1zdHJvbmdcIj5EZWNlbWJlciAxMCwgMjAx
+        Njwvc3Ryb25nPi4gSG93ZXZlciwgd2UmI3gyMDE5O3ZlIGdvdCBhIGdyZWF0
+        IGFsdGVybmF0aXZlIGZvciB5b3U6IHRoZSA8YSBocmVmPVwiaHR0cHM6Ly9t
+        ZXJjdXJ5LnBvc3RsaWdodC5jb20vXCIgY2xhc3M9XCJtYXJrdXAtLWFuY2hv
+        ciBtYXJrdXAtLXAtYW5jaG9yXCI+PHN0cm9uZyBjbGFzcz1cIm1hcmt1cC0t
+        c3Ryb25nIG1hcmt1cC0tcC1zdHJvbmdcIj5NZXJjdXJ5IFRvb2xraXQ8L3N0
+        cm9uZz48L2E+LjwvcD48cCBpZD1cIjFkZWJcIiBjbGFzcz1cImdyYWYgZ3Jh
+        Zi0tcCBncmFmLWFmdGVyLS1wXCI+U2luY2UgaXQgbGF1bmNoZWQgYXMgYSBz
+        aW1wbGUgYm9va21hcmtsZXQgaW4gMjAwOSwgdGhlIFJlYWRhYmlsaXR5IHBy
+        b2plY3QmI3gyMDE5O3MgaW1wYWN0IG9uIHJlYWRpbmcgb24gdGhlIHdlYiBh
+        bmQgYmV5b25kIGlzIHVuZGVuaWFibGUuIFdlIGFwcHJlY2lhdGUgeW91ciBs
+        b3lhbHR5IGFuZCBzdXBwb3J0IGZvciB0aGUgcGxhdGZvcm0gb3ZlciB0aGUg
+        eWVhcnMuPC9wPjxwIGlkPVwiZDBiNlwiIGNsYXNzPVwiZ3JhZiBncmFmLS1w
+        IGdyYWYtYWZ0ZXItLXBcIj5XZSB3ZWxjb21lIHlvdXIgcXVlc3Rpb25zIGF0
+        IDxhIGhyZWY9XCJtYWlsdG86Y29udGFjdCUyQnJpbEByZWFkYWJpbGl0eS5j
+        b21cIiBjbGFzcz1cIm1hcmt1cC0tYW5jaG9yIG1hcmt1cC0tcC1hbmNob3Jc
+        Ij5jb250YWN0K3JpbEByZWFkYWJpbGl0eS5jb208L2E+LjwvcD48cCBpZD1c
+        ImMwMjRcIiBjbGFzcz1cImdyYWYgZ3JhZi0tcCBncmFmLWFmdGVyLS1wIGdy
+        YWYtLWxhc3RcIj48ZW0gY2xhc3M9XCJtYXJrdXAtLWVtIG1hcmt1cC0tcC1l
+        bVwiPlRoZSBSZWFkYWJpbGl0eSBUZWFtPC9lbT48L3A+PC9kaXY+PC9kaXY+
+        PC9kaXY+IiwiYXV0aG9yIjoiUmVhZGFiaWxpdHkiLCJkYXRlX3B1Ymxpc2hl
+        ZCI6IjIwMTYtMDktMDJUMTg6NDM6NTkuODY0WiIsImxlYWRfaW1hZ2VfdXJs
+        IjpudWxsLCJkZWsiOm51bGwsIm5leHRfcGFnZV91cmwiOm51bGwsInVybCI6
+        Imh0dHBzOi8vbWVkaXVtLmNvbS9AcmVhZGFiaWxpdHkvdGhlLXJlYWRhYmls
+        aXR5LWJvb2ttYXJraW5nLXNlcnZpY2Utd2lsbC1zaHV0LWRvd24tb24tc2Vw
+        dGVtYmVyLTMwLTIwMTYtMTY0MWNjMThlMDJiIiwiZG9tYWluIjoibWVkaXVt
+        LmNvbSIsImV4Y2VycHQiOiJBZnRlciBtb3JlIHRoYW4gZml2ZSB5ZWFycyBv
+        ZiBvcGVyYXRpb24sIHRoZSBSZWFkYWJpbGl0eSBhcnRpY2xlIGJvb2ttYXJr
+        aW5nL3JlYWQtaXQtbGF0ZXIgc2VydmljZSB3aWxsIGJlIHNodXR0aW5nIGRv
+        d24gYWZ0ZXIgU2VwdGVtYmVyIDMw4oCmIiwid29yZF9jb3VudCI6MTUxLCJk
+        aXJlY3Rpb24iOiJsdHIiLCJ0b3RhbF9wYWdlcyI6MSwicmVuZGVyZWRfcGFn
+        ZXMiOjF9
+    http_version: 
+  recorded_at: Wed, 30 Nov 2016 02:59:26 GMT
+recorded_with: VCR 3.0.3

data/lib/mercury_web_parser.rb

@@ -0,0 +1,29 @@
+require 'mercury_web_parser/configuration'
+require 'mercury_web_parser/client'
+
+module MercuryWebParser
+  extend Configuration
+
+  class << self
+    # Alias for MercuryWebParser::Client.new
+    #
+    # @return [MercuryWebParser::Client]
+    def new(options = {})
+      MercuryWebParser::Client.new(options)
+    end
+
+    # Delegate to MercuryWebParser::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      Configuration::VALID_CONFIG_KEYS.include?(method_name) || super
+    end
+  end
+end # MercuryWebParser

data/lib/mercury_web_parser/api/content.rb

@@ -0,0 +1,16 @@
+module MercuryWebParser
+  module API
+    module Content
+      # Parse a webpage and return its main content
+      # Returns a MercuryWebParser::Article object
+      #
+      # @param url [String] The URL of an article to return the content for
+      # @return [MercuryWebParser::Article]
+      def parse(url)
+        response = get('', url: url)
+
+        MercuryWebParser::Article.new(response)
+      end
+    end # Content
+  end # API
+end

data/lib/mercury_web_parser/article.rb

@@ -0,0 +1,12 @@
+require 'ostruct'
+
+module MercuryWebParser
+  class Article < OpenStruct
+    # Returns a MercuryWebParser::Article object
+    #
+    # @return [MercuryWebParser::Article]
+    def initialize(article)
+      super
+    end
+  end # Article
+end

data/lib/mercury_web_parser/client.rb

@@ -0,0 +1,21 @@
+require 'mercury_web_parser/connection'
+require 'mercury_web_parser/request'
+require 'mercury_web_parser/api/content'
+require 'mercury_web_parser/article'
+
+module MercuryWebParser
+  class Client
+    attr_accessor(*Configuration::VALID_CONFIG_KEYS)
+
+    def initialize(options = {})
+      options = MercuryWebParser.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include MercuryWebParser::Connection
+    include MercuryWebParser::Request
+    include MercuryWebParser::API::Content
+  end # Client
+end

data/lib/mercury_web_parser/configuration.rb

@@ -0,0 +1,37 @@
+require 'mercury_web_parser/version'
+
+module MercuryWebParser
+  module Configuration
+    VALID_CONNECTION_KEYS = [:api_endpoint, :user_agent].freeze
+    VALID_OPTIONS_KEYS    = [:api_token].freeze
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_API_ENDPOINT  = 'https://mercury.postlight.com/parser'.freeze
+    DEFAULT_USER_AGENT    = "MercuryWebParser Ruby Gem #{MercuryWebParser::VERSION}".freeze # rubocop:disable Metrics/LineLength
+    DEFAULT_API_TOKEN     = nil
+
+    attr_accessor(*VALID_CONFIG_KEYS)
+
+    def self.extended(base)
+      base.reset!
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[* VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten]
+    end
+
+    def reset!
+      self.api_endpoint = DEFAULT_API_ENDPOINT
+      self.user_agent   = DEFAULT_USER_AGENT
+
+      self.api_token    = DEFAULT_API_TOKEN
+
+      true
+    end
+  end # Configuration
+end

data/lib/mercury_web_parser/connection.rb

@@ -0,0 +1,42 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module MercuryWebParser
+  module Connection
+    # Instantiate a Faraday::Connection
+    # @private
+    private
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection(options = {})
+      options = {
+        url: MercuryWebParser.api_endpoint
+      }.merge(options)
+
+      get_connection(options)
+    end
+
+    def get_connection(options)
+      conn = Faraday.new(options) do |c|
+        # encode request params as "www-form-urlencoded"
+        c.use Faraday::Request::UrlEncoded
+
+        c.use FaradayMiddleware::FollowRedirects, limit: 3
+
+        # raise exceptions on 40x, 50x responses
+        c.use Faraday::Response::RaiseError
+
+        c.response :json, content_type: /\bjson$/
+
+        c.adapter Faraday.default_adapter
+      end
+
+      conn.headers[:user_agent] = MercuryWebParser.user_agent
+      conn.headers[:"x-api-key"] = MercuryWebParser.api_token
+
+      conn
+    end
+  end # Connection
+end

data/lib/mercury_web_parser/error.rb

@@ -0,0 +1,51 @@
+module MercuryWebParser
+  class Error < StandardError
+    # Raised when Mercury returns a 4xx or 500 HTTP status code
+    class ClientError < Error
+      # Creates a new error from an HTTP environement
+      #
+      # @param response [Hash]
+      # @return [MercuryWebParser::Error::ClientError]
+      def initialize(error = nil)
+        http_error = error.response[:status].to_i
+
+        if ERROR_MAP.key?(http_error)
+          raise ERROR_MAP[http_error], error.response[:body]['message']
+        end
+
+        super
+      end
+    end # ClientError
+
+    class ConfigurationError < MercuryWebParser::Error; end
+
+    # Raised when there's an error in Faraday
+    class RequestError < MercuryWebParser::Error; end
+
+    # Raised when MercuryWebParser returns a 400 HTTP status code
+    class BadRequest < MercuryWebParser::Error; end
+
+    # Raised when the response from the parser is null
+    class NotParseable < MercuryWebParser::Error; end
+
+    # Raised when MercuryWebParser returns a 401 HTTP status code
+    class UnauthorizedRequest < MercuryWebParser::Error; end
+
+    # Raised when MercuryWebParser returns a 403 HTTP status code
+    class Forbidden < MercuryWebParser::Error; end
+
+    # Raised when MercuryWebParser returns a 404 HTTP status code
+    class NotFound < MercuryWebParser::Error; end
+
+    # Raised when MercuryWebParser returns a 500 HTTP status code
+    class InternalServerError < MercuryWebParser::Error; end
+
+    ERROR_MAP = {
+      400 => MercuryWebParser::Error::BadRequest,
+      401 => MercuryWebParser::Error::UnauthorizedRequest,
+      403 => MercuryWebParser::Error::Forbidden,
+      404 => MercuryWebParser::Error::NotFound,
+      500 => MercuryWebParser::Error::InternalServerError
+    }.freeze
+  end # Error
+end

data/lib/mercury_web_parser/request.rb

@@ -0,0 +1,37 @@
+require 'mercury_web_parser/error'
+
+module MercuryWebParser
+  module Request
+    # Performs a HTTP Get request
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    private
+
+    # Returns a Faraday::Response object
+    #
+    # @return [Faraday::Response]
+    def request(method, path, params = {})
+      if api_token.nil?
+        raise MercuryWebParser::Error::ConfigurationError,
+              'Please configure MercuryWebParser.api_token first'
+      end
+
+      make_request(method, path, params)
+    end
+
+    def make_request(method, path, params)
+      response = connection.send(method) do |request|
+        request.url(path, params)
+      end
+      response.body
+    rescue Faraday::ParsingError
+      raise MercuryWebParser::Error::NotParseable, 'Unparseable response'
+    rescue Faraday::Error::ClientError => error
+      raise MercuryWebParser::Error::ClientError, error
+    rescue => error
+      raise MercuryWebParser::Error::RequestError, error
+    end
+  end # Request
+end

data/lib/mercury_web_parser/version.rb

@@ -0,0 +1,3 @@
+module MercuryWebParser
+  VERSION = '0.1.0'.freeze
+end

data/mercury_web_parser.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mercury_web_parser/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name           = 'mercury_web_parser'
+  s.version        = MercuryWebParser::VERSION
+  s.summary        = 'A simple Ruby wrapper for the Mercury Web Parser API'
+  s.authors        = ['Jim Fiorato']
+  s.email          = 'mercury_web_parser@theoldreader.com'
+  s.homepage       = 'http://github.com/theoldreader/mercury-web-parser'
+  s.license        = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.add_dependency 'faraday',            '>= 0.9'
+  s.add_dependency 'faraday_middleware', '>= 0.9'
+
+  s.add_development_dependency 'danger'
+  s.add_development_dependency 'danger-commit_lint'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'vcr'
+end

data/spec/mercury_web_parser/client_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe MercuryWebParser::Client do
+  after do
+    MercuryWebParser.reset!
+  end
+
+  context 'with module configuration' do
+    before do
+      MercuryWebParser.configure do |config|
+        MercuryWebParser::Configuration::VALID_CONFIG_KEYS.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    it 'inherits the module configuration' do
+      MercuryWebParser::Configuration::VALID_CONFIG_KEYS.each do |key|
+        expect(MercuryWebParser.method(:"#{key}")).to be_a_kind_of(Method)
+        expect(MercuryWebParser.send(:"#{key}")).to eq(key)
+      end
+    end
+  end
+
+  context 'with class configuration' do
+    before do
+      @configuration = {
+        api_token: '1234'
+      }
+    end
+
+    it 'overrides the module configuration after initialization' do
+      MercuryWebParser.configure do |config|
+        @configuration.each do |key, value|
+          config.send("#{key}=", value)
+        end
+      end
+
+      MercuryWebParser::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        expect(MercuryWebParser.send(:"#{key}")).to eq(@configuration[key])
+      end
+    end
+  end
+
+  describe '#connection' do
+    it 'looks like Faraday connection' do
+      expect(subject.send(:connection)).to respond_to(:run_request)
+    end
+  end
+
+  describe '#request' do
+    before do
+      MercuryWebParser.api_token = '1234'
+    end
+
+    it 'successfully parses a page' do
+      VCR.use_cassette('successful') do
+        url = 'https://medium.com/@readability/the-readability-bookmarking-service-will-shut-down-on-september-30-2016-1641cc18e02b'
+        article = MercuryWebParser.parse(url)
+        expect(article.title).to match(/The Readability bookmarking service/)
+        expect(article.content).to match(/receive an email/)
+        expect(article.author).to eq('Readability')
+        expect(article.date_published).to eq('2016-09-02T18:43:59.864Z')
+        expect(article.lead_image_url).to be_nil
+        expect(article.dek).to be_nil
+        expect(article.next_page_url).to be_nil
+        expect(article.url).to eq(url)
+        expect(article.domain).to eq('medium.com')
+        expect(article.excerpt).to match(/more than five years/)
+        expect(article.word_count).to eq(151)
+        expect(article.direction).to eq('ltr')
+        expect(article.total_pages).to eq(1)
+        expect(article.rendered_pages).to eq(1)
+      end
+    end
+
+    it 'catches Faraday connection errors' do
+      VCR.use_cassette('connection_errors') do
+        expect { MercuryWebParser.parse('http://www.google.com') }.to(
+          raise_error(MercuryWebParser::Error::UnauthorizedRequest)
+        )
+      end
+    end
+
+    it 'catches Mercury Web Parser API errors' do
+      VCR.use_cassette('parser_errors') do
+        expect { MercuryWebParser.parse('http://abc.go.com/robots.txt') }.to(
+          raise_error(MercuryWebParser::Error::NotParseable)
+        )
+      end
+    end
+  end
+end

data/spec/mercury_web_parser_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe MercuryWebParser do
+  after do
+    MercuryWebParser.reset!
+  end
+
+  describe '#new' do
+    it 'is a MercuryWebParser::Client' do
+      expect(MercuryWebParser.new).to be_a_kind_of(MercuryWebParser::Client)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/mercury_web_parser')
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'fixtures/vcr_cassettes'
+  config.hook_into :faraday
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: mercury_web_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Fiorato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: danger
+  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: danger-commit_lint
+  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: rspec
+  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: rubocop
+  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: vcr
+  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'
+description: 
+email: mercury_web_parser@theoldreader.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Dangerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fixtures/vcr_cassettes/connection_errors.yml
+- fixtures/vcr_cassettes/parser_errors.yml
+- fixtures/vcr_cassettes/successful.yml
+- lib/mercury_web_parser.rb
+- lib/mercury_web_parser/api/content.rb
+- lib/mercury_web_parser/article.rb
+- lib/mercury_web_parser/client.rb
+- lib/mercury_web_parser/configuration.rb
+- lib/mercury_web_parser/connection.rb
+- lib/mercury_web_parser/error.rb
+- lib/mercury_web_parser/request.rb
+- lib/mercury_web_parser/version.rb
+- mercury_web_parser.gemspec
+- spec/mercury_web_parser/client_spec.rb
+- spec/mercury_web_parser_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/theoldreader/mercury-web-parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A simple Ruby wrapper for the Mercury Web Parser API
+test_files:
+- spec/mercury_web_parser/client_spec.rb
+- spec/mercury_web_parser_spec.rb
+- spec/spec_helper.rb