readability_parser 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmUzMWU5ZjU2YTlmZTM3YmIxZWE3ODk2MjE2MjEwMGMyMjg5OGZiYw==
+  data.tar.gz: !binary |-
+    YTM1ODI2YTgwMWY2ZGNiNjA0OTZiMDAyZjJhYTdiZTk1NThlYWU2Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NWI0ZjQzYmY0NmQ0ZmZhNjkzMjNhY2Y3ZDJkMGVlYTVlNzRhNjI2OGMyYjA0
+    YzA0ODM2OTY4MmE1NDkwMDRhMGQ1MWYwNDIzNGZjZTBkMWNjNjI1YjczNzc0
+    ZTM5MmE2MDYzM2RhYWQ5YmMzMjE4MmRkNDVkMWFjZWMxOGNiN2M=
+  data.tar.gz: !binary |-
+    NjE3MDViNDA2MDZhMDU0Y2U0ZDE4MDg1ZDhjYTIwMzIyNzM4MzI5ZjczYTFk
+    Nzk2ZjY2MzFmMTI0ODVlOWQxOTM4ZmM0MWZmYTAzYjc1NDMzNDg5NTg4NTFh
+    NTAyMzNlN2MzOWQ0NmQzZTA0ODY4ZjUxMmY3NDQyYzY1ZTA2YTM=

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+vendor/bundle
+.ruby-version
+.rbenv-vars
+spec/reports
+Gemfile.lock
+log/*
+.yardoc
+doc/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'yard'
+
+gemspec

data/README.md

@@ -0,0 +1,90 @@
+# Readability Parser
+A tiny ruby wrapper for Readability's content parser api
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'readability_parser'
+
+And then execute:
+
+    bundle install
+
+## Configuration
+Single token usage:
+```ruby
+ReadabilityParser.api_token = READABILITY_API_TOKEN
+```
+
+or set multiple options with a block:
+```ruby
+ReadabilityParser.configure do |readability|
+  readability.api_token = READABILITY_API_TOKEN,
+  readability.format = :json
+end
+```
+
+
+Make sure to set `READABILITY_API_TOKEN` in your environement variables. You can get an API key by contacting Readability's team directly, more information on their [api documentation page](https://www.readability.com/developers/api).
+
+Multiple tokens or multithreaded usage:
+```ruby
+client = ReadabilityParser::Client.new(
+  :api_token => READABILITY_API_TOKEN
+)
+```
+
+## Usage
+
+### Parse
+Parse a webpage and return its main content
+```ruby
+article = ReadabilityParser.parse("http://www.paulgraham.com/really.html")
+=> #<ReadabilityParser::Article domain="www.paulgraham.com", next_page_id=nil, url="http://www.paulgraham.com/really.html", short_url="http://rdd.me/vki6sx0x", author=nil, excerpt="Want to start a startup? Get funded by Y Combinator . October 2009 (This essay is derived from a talk at the 2009 Startup School.) I wasn't sure what to talk about at Startup School, so I decided to...", direction="ltr", word_count=4982, total_pages=0, content="<div><td width="455"><img src="http://ep.yimg.com/ca/I/paulgraham_2135_250213" width="243" border="0" hspace="0" vspace="0" alt="What Startups Are Really Like"> ...", date_published=nil, dek=nil, lead_image_url=nil, title="What Startups Are Really Like", rendered_pages=1>
+
+article.domain
+article.author
+article.url
+article.short_url
+article.title
+article.total_pages
+article.word_count
+article.content
+article.date_published
+article.next_page_id
+article.rendered_pages
+```
+### Format
+You may specify the response format to `:json` or `:xml`, default to `:json`. Either way, the response will be parsed and returned as a `ReadabilityParser::Article` object.
+
+## TODO
+- Complete test suite
+
+## Contributing
+
+1. Fork it
+2. [Create a topic branch](http://learn.github.com/p/branching.html)
+3. Add specs for your unimplemented modifications
+4. Run `bundle exec rspec`. If specs pass, return to step 3.
+5. Implement your modifications
+6. Run `bundle exec rspec`. If specs fail, return to step 5.
+7. Commit your changes and push
+8. [Submit a pull request](http://help.github.com/send-pull-requests/)
+
+## Inspiration
+Design inspired from [twitter](https://github.com/sferik/twitter) and [octokit](https://github.com/pengwynn/octokit) api wrappers.
+
+## Author
+[Philippe Dionne](http://www.phildionne.com)
+
+## Copyright
+Copyright (c) 2013 Philippe Dionne
+
+## License
+MIT License
+
+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 @@
+require "bundler/gem_tasks"

data/lib/readability_parser.rb

@@ -0,0 +1,24 @@
+require 'readability_parser/configuration'
+require 'readability_parser/client'
+
+module ReadabilityParser
+  extend Configuration
+  class << self
+    # Alias for ReadabilityParser::Client.new
+    #
+    # @return [ReadabilityParser::Client]
+    def new(options={})
+      ReadabilityParser::Client.new(options)
+    end
+
+    # Delegate to ReadabilityParser::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
+  end
+end # ReadabilityParser

data/lib/readability_parser/api/content.rb

@@ -0,0 +1,21 @@
+module ReadabilityParser
+  module API
+    module Content
+
+      # Parse a webpage and return its main content
+      # Returns a ReadabilityParser::Article object
+      #
+      # Optionally pass the ID of an article as `id => "id"` in `options` to return the content for a specific DOM node
+      # You can also pass a `max_pages` integer to set the maximum number of pages to parse and combine. Default is 25.
+      #
+      # @param url [String] The URL of an article to return the content for
+      # @return [ReadabilityParser::Article]
+      def parse(url, options={})
+        params = {:url => url}
+        response = get('', params.merge(options))
+
+        ReadabilityParser::Article.new(response)
+      end
+    end # Content
+  end # API
+end

data/lib/readability_parser/article.rb

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

data/lib/readability_parser/client.rb

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

data/lib/readability_parser/configuration.rb

@@ -0,0 +1,37 @@
+require 'readability_parser/version'
+
+module ReadabilityParser
+  module Configuration
+    VALID_CONNECTION_KEYS = [:api_endpoint, :user_agent].freeze
+    VALID_OPTIONS_KEYS = [:api_token, :format].freeze
+    VALID_CONFIG_KEYS = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_API_ENDPOINT = "https://readability.com/api/content/v1/parser"
+    DEFAULT_USER_AGENT = "ReadabilityParser Ruby Gem #{ReadabilityParser::VERSION}".freeze
+    DEFAULT_API_TOKEN = nil
+    DEFAULT_FORMAT = :json
+
+    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
+      self.format       = DEFAULT_FORMAT
+    end
+  end # Configuration
+end

data/lib/readability_parser/connection.rb

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

data/lib/readability_parser/error.rb

@@ -0,0 +1,47 @@
+module ReadabilityParser
+  class Error < StandardError
+
+    class ClientError < Error
+
+      def initialize(error=nil)
+        parsed_error = parse_error(error)
+        http_error = error.response[:status].to_i
+
+        if ERROR_MAP.has_key?(http_error)
+          raise ERROR_MAP[http_error].new(parsed_error[:messages])
+        else
+          super
+        end
+      end
+
+      def parse_error(error)
+        JSON.parse(error.response[:body], :symbolize_names => true)
+      end
+    end # ClientError
+
+    class ConfigurationError < ReadabilityParser::Error; end
+
+    # Raised when ReadabilityParser returns a 400 HTTP status code
+    class BadRequest < ReadabilityParser::Error; end
+
+    # Raised when ReadabilityParser returns a 401 HTTP status code
+    class UnauthorizedRequest < ReadabilityParser::Error; end
+
+    # Raised when ReadabilityParser returns a 403 HTTP status code
+    class Forbidden < ReadabilityParser::Error; end
+
+    # Raised when ReadabilityParser returns a 404 HTTP status code
+    class NotFound < ReadabilityParser::Error; end
+
+    # Raised when ReadabilityParser returns a 500 HTTP status code
+    class InternalServerError < ReadabilityParser::Error; end
+
+    ERROR_MAP = {
+      400 => ReadabilityParser::Error::BadRequest,
+      401 => ReadabilityParser::Error::UnauthorizedRequest,
+      403 => ReadabilityParser::Error::Forbidden,
+      404 => ReadabilityParser::Error::NotFound,
+      500 => ReadabilityParser::Error::InternalServerError
+    }
+  end # Error
+end

data/lib/readability_parser/request.rb

@@ -0,0 +1,45 @@
+require 'readability_parser/error'
+
+module ReadabilityParser
+  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={})
+
+      raise ReadabilityParser::Error::ConfigurationError.new("Please configure ReadabilityParser.api_token first") if api_token.nil?
+
+      params.merge!({
+        :token => api_token,
+        :format => format
+      })
+
+      connection_options = {}
+
+      begin
+        response = connection(connection_options).send(method) do |request|
+          request.url(path, params)
+        end
+      rescue Faraday::Error::ClientError => error
+        raise ReadabilityParser::Error::ClientError.new(error)
+      end
+
+      # When using xml format the response is wrapped in a <response> node
+      if response.body['response']
+        # TODO: When using xml format, the response.body hash values are all strings.
+        # Maybe convert values to proper type?
+        response.body['response']
+      else
+        response.body
+      end
+    end
+  end # Request
+end

data/lib/readability_parser/version.rb

@@ -0,0 +1,3 @@
+module ReadabilityParser
+  VERSION = "0.0.1"
+end

data/readability_parser.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'readability_parser/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "readability_parser"
+  gem.version       = ReadabilityParser::VERSION
+  gem.authors       = ["Philippe Dionne"]
+  gem.email         = ["dionne.phil@gmail.com"]
+  gem.description   = %q{A tiny ruby wrapper for Readability's content parser api}
+  gem.summary       = %q{Interact with the article parsing featureset of Readability. This means grabbing an article's content based on a URL.}
+  gem.homepage      = "https://github.com/phildionne/readability_parser"
+  gem.licenses      = []
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "faraday", "~> 0.8.4"
+  gem.add_dependency "faraday_middleware", "~> 0.9.0"
+  gem.add_dependency "hashie", "~> 1.2.0"
+  gem.add_dependency "multi_xml", "~> 0.5.2"
+
+  gem.add_development_dependency "rspec"
+end

data/spec/helper.rb

@@ -0,0 +1,2 @@
+require 'readability'
+require 'rspec'

data/spec/readability/api/content_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe Readability::API::Content do
+
+  before do
+    @client = Readability::Client.new(:api_token => '12345678910')
+  end
+
+  after do
+    Readability.reset
+  end
+
+  describe ".parse" do
+    it "fetches the content of a given uri" do
+      pending
+    end
+
+    it "returns a Readability::Article" do
+      pending
+    end
+  end
+
+end

data/spec/readability/article_spec.rb

@@ -0,0 +1,5 @@
+require 'helper'
+
+describe Readability::Article do
+  pending
+end

data/spec/readability/client_spec.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+describe Readability::Client do
+
+  after do
+    Readability.reset
+  end
+
+  context "when creating a client" do
+    describe "with no options" do
+      it "should assign client with default values" do
+        pending
+      end
+    end
+
+    describe "with options" do
+
+      it "should accept configuration options" do
+        pending
+      end
+
+      it "should assign the client with overiden default values" do
+        pending
+      end
+    end
+  end
+
+  context "when using a client" do
+    pending
+  end
+
+end

data/spec/readability/configuration_spec.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+describe Readability::Configuration do
+
+  after do
+    Readability.reset
+  end
+
+  Readability::Configuration::VALID_CONFIG_KEYS.each do |key|
+    describe ":#{key}" do
+      it "should return the default value" do
+        Readability.send(key).should be(Readability::Configuration.const_get("DEFAULT_#{key.upcase}"))
+      end
+    end
+  end
+
+end

data/spec/readability/connection_spec.rb

@@ -0,0 +1,5 @@
+require 'helper'
+
+describe Readability::Connection do
+  pending
+end

data/spec/readability/error_spec.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe Readability::Error do
+  describe Readability::Error::ClientError do
+    pending
+  end
+end

data/spec/readability/request_spec.rb

@@ -0,0 +1,5 @@
+require 'helper'
+
+describe Readability::Request do
+  pending
+end

data/spec/readability_spec.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+describe Readability do
+
+  after do
+    Readability.reset
+  end
+
+  describe ".new" do
+    it "is a Readability::Client" do
+      (Readability.new).should be_a_kind_of(Readability::Client)
+    end
+  end
+
+  describe ".method_missing?" do
+    pending
+  end
+
+  describe ".respond_to?" do
+    pending
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: readability_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Philippe Dionne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  name: faraday
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  name: faraday_middleware
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  name: hashie
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  name: multi_xml
+- !ruby/object:Gem::Dependency
+  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'
+  name: rspec
+description: A tiny ruby wrapper for Readability's content parser api
+email:
+- dionne.phil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- README.md
+- Rakefile
+- lib/readability_parser.rb
+- lib/readability_parser/api/content.rb
+- lib/readability_parser/article.rb
+- lib/readability_parser/client.rb
+- lib/readability_parser/configuration.rb
+- lib/readability_parser/connection.rb
+- lib/readability_parser/error.rb
+- lib/readability_parser/request.rb
+- lib/readability_parser/version.rb
+- readability_parser.gemspec
+- spec/helper.rb
+- spec/readability/api/content_spec.rb
+- spec/readability/article_spec.rb
+- spec/readability/client_spec.rb
+- spec/readability/configuration_spec.rb
+- spec/readability/connection_spec.rb
+- spec/readability/error_spec.rb
+- spec/readability/request_spec.rb
+- spec/readability_spec.rb
+homepage: https://github.com/phildionne/readability_parser
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Interact with the article parsing featureset of Readability. This means grabbing
+  an article's content based on a URL.
+test_files:
+- spec/helper.rb
+- spec/readability/api/content_spec.rb
+- spec/readability/article_spec.rb
+- spec/readability/client_spec.rb
+- spec/readability/configuration_spec.rb
+- spec/readability/connection_spec.rb
+- spec/readability/error_spec.rb
+- spec/readability/request_spec.rb
+- spec/readability_spec.rb
+has_rdoc: