textract 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 052757f993bc3c87948e1d650ea837a48fef8c73
+  data.tar.gz: a52c485fb6af0fcafcc1e9f743c617223e181fc9
+SHA512:
+  metadata.gz: 39c8b5162e22ca62fa182791324ae2e828712cde3d0e5a131212d4af105a40bbfe07ca6808b337900e4bc3bd492e1b210f8e0d0653035ab8f7c56d7b4e226172
+  data.tar.gz: 74c00abd7a1d54dd0e8bf1153aceb9b98751b070c2ced92b8257d79a7836a292ee7ba646a984e1d3aaae0b35d20c874821d6fdaf37f33ac3c019e253f77c77de

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in textract.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,77 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Adam Pash
+
+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/README.md

@@ -0,0 +1,31 @@
+# Textract
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'textract'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install textract
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/textract/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/textract.rb

@@ -0,0 +1,81 @@
+require "textract/version"
+require 'httparty'
+require 'nokogiri'
+require 'opengraph_parser'
+require 'reverse_markdown'
+require 'readability'
+
+module Textract
+  # attr_accessor :client
+
+  def self.get_text(url, selectors=nil)
+    @client = Client.new(url, selectors)
+  end
+
+  def self.get_og_tags(html)
+    OpenGraph.new(html)
+  end
+
+  def self.get_text_from_description(html, description, selectors)
+    doc = Nokogiri::HTML html
+    if selectors.nil?
+      article = doc.search('article')
+    else
+      article = doc.search(selectors)
+    end
+    if article.count == 1
+      article_el = article[0]
+    elsif !description.nil? and article.count == 0
+      els = [1,2,3]
+      i = 1
+      until els.count < 2
+        search_text = description.split(" ")[0..i].join(" ")
+        puts search_text
+        els = doc.search "[text()*='#{search_text}']"
+        i += 1
+      end
+      if els.count == 1
+        el = els[0]
+        article_el = el.parent
+      else
+        # do something else if multiple or no matches
+      end
+    else
+      article_el = doc
+    end
+    article = Readability::Document.new(article_el.to_s,
+                                        tags: %w[div span p a img ul ol li blockquote table tr td h1 h2 h3 h4 h5 b em i strong],
+                                        attributes: %w[src href],
+                                        remove_empty_nodes: true,
+                                       ).content
+    markdown = ReverseMarkdown.convert article, unknown_tags: :bypass
+    # TODO change to drop once article is supported by reversemarkdown
+    markdown
+  end
+
+  def self.get_page_title(html)
+    Nokogiri::HTML(html).search('title').text
+  end
+
+  class Client
+    attr_reader :html
+    attr_reader :url
+    attr_reader :tags
+    attr_reader :title
+    attr_reader :text
+
+    def initialize(url, selectors)
+      @url = url
+      @html = HTTParty.get url
+      @tags = Textract.get_og_tags(@html)
+      if @tags.nil? or @tags.description.nil?
+        # use readability method
+        @text = Textract.get_text_from_description(@html, nil, selectors)
+        @title = Textract.get_page_title(@html)
+      else
+        @text = Textract.get_text_from_description(@html, @tags.description, selectors)
+        @title = @tags.title
+      end
+    end
+  end
+end

data/lib/textract/version.rb

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

data/spec/lib/textract_spec.rb

@@ -0,0 +1,33 @@
+require_relative '../../lib/textract'
+describe Textract do
+  it "initializes with the get_text method" do
+    url = "http://www.tedcruz.org/about/"
+    textract = Textract.get_text(url)
+    expect(textract).to be_a_kind_of Textract::Client
+  end
+
+  it "returns article text based on article tag" do
+    url = "http://gawker.com/1694508525"
+    textract = Textract.get_text(url)
+    expect(textract.text[0..5]).to eq "Import"
+  end
+
+  it "returns article text based on opengraph description" do
+    url = "http://www.tedcruz.org/record/our-standard-the-constitution/"
+    textract = Textract.get_text(url)
+    expect(textract.text[0..5]).to eq "Ted Cr"
+  end
+
+  it "can find a twitter profile given a selector" do
+    url = "https://twitter.com/lifehacker"
+    textract = Textract.get_text(url, 'p.ProfileHeaderCard-bio.u-dir')
+    expect(textract.text.strip).to eq "Don't live to geek; geek to live."
+    expect(textract.title).to eq "Lifehacker (@lifehacker) | Twitter"
+  end
+
+  it "gets the page title from the title tag" do
+    html = "<html><head><title>Stuff</title></head><body><h1>FOO!</h1></body></html>"
+    expect(Textract.get_page_title(html)).to eq "Stuff"
+  end
+
+end

data/textract.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'textract/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "textract"
+  spec.version       = Textract::VERSION
+  spec.authors       = ["Adam Pash"]
+  spec.email         = ["adam.pash@gmail.com"]
+  spec.summary       = %q{Extracts article text from a URL}
+  spec.description   = %q{Extracts article text from a URL}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "opengraph_parser"
+  spec.add_dependency "httparty"
+  spec.add_dependency "reverse_markdown"
+  spec.add_dependency "ruby-readability"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: textract
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Pash
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opengraph_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reverse_markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-readability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: guard-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'
+description: Extracts article text from a URL
+email:
+- adam.pash@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/textract.rb
+- lib/textract/version.rb
+- spec/lib/textract_spec.rb
+- textract.gemspec
+homepage: ''
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Extracts article text from a URL
+test_files:
+- spec/lib/textract_spec.rb