gaspar-pdf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61dc07bbed984fb395fe3e6de603f862906c853a
+  data.tar.gz: b1130b45efc157db8a9c0ccc6a6f768d71b6e159
+SHA512:
+  metadata.gz: 1aa7157bf22ca40cb902fa894a17ac329e52d002b6387fe9fa0850537ab205b4063ad3e6e77a919e1d4e10461c8dc02eabdee733811a4e4481930be54a6fd989
+  data.tar.gz: b4aeb3d4ade931275b57d2924ae1639257634d98460bdfffe85c34a3e7b921d9e4dd7d18fb0f61cd8d17f0540de13875bb097ae582566ce2c49a53459ffee998

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    gaspar-pdf (0.0.1)
+      pdf-reader
+      spoon
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.0.2)
+    afm (0.2.2)
+    diff-lcs (1.2.5)
+    ffi (1.9.14)
+    hashery (2.1.2)
+    mini_portile2 (2.1.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pdf-reader (1.4.0)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    pkg-config (1.1.7)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    ruby-rc4 (0.1.5)
+    spoon (0.0.4)
+      ffi
+    ttfunk (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  gaspar-pdf!
+  nokogiri
+  rake
+  rspec
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2016 5rabbits
+
+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. I
+N 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,49 @@
+# Gaspar PDF
+
+Parses PDF tables into HTML / Json / Xml / CSV files without losing data. This gem uses  [pdf-table-extract](https://github.com/ashima/pdf-table-extract).
+
+![Hay PDF, Hay Tabla](https://cloud.githubusercontent.com/assets/445798/17439517/82155610-5af6-11e6-9a3e-cfb0a019b1a1.jpg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gaspar-pdf'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gaspar-pdf
+
+## Usage
+
+You need to install [pdf-table-extract](https://github.com/5rabbits/pdf-table-extract/releases) on your system to use this gem.
+
+```ruby
+require 'gaspar'
+
+# Parse document.pdf to document.html
+# This requires that the pdf-table-extract command is present in your PATH.
+
+Gaspar.parse('document.pdf', 'document.html', {
+  page: 1, format: 'table_html'
+})
+
+# Available options:
+# page - page to parse
+# format -  the type of output: [cells_csv,cells_json,cells_xml,table_csv,table_html,table_chtml,table_list]
+
+```
+
+Inspired by [Kristin](https://github.com/ricn/kristin)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/gaspar-pdf.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gaspar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gaspar-pdf'
+  spec.version       = Gaspar::VERSION
+  spec.authors       = ['5rabbits', 'Abraham Barrera']
+  spec.email         = ['abarrerac@gmail.com']
+  spec.description   = 'Parses PDF tables into HTML, JSON, XML and more.'
+  spec.summary       = 'Parses PDF tables into HTML, JSON, XML and more.'
+  spec.homepage      = 'https://github.com/5rabbits/gaspar-pdf'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  
+  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 'spoon'
+  spec.add_dependency 'pdf-reader'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'nokogiri'
+  spec.add_development_dependency 'rspec'
+end

data/lib/gaspar/version.rb

@@ -0,0 +1,3 @@
+module Gaspar
+  VERSION = '0.0.1'
+end

data/lib/gaspar.rb

@@ -0,0 +1,119 @@
+require 'gaspar/version'
+require 'open-uri'
+require 'net/http'
+require 'spoon'
+
+# Gaspar Gem
+module Gaspar
+  # Parser
+  # This class parses a PDF into a machine-readable format
+  class Parser
+    def initialize(source, target, options = {})
+      @source = source
+      @target = target
+      @options = options
+    end
+
+    def parse
+      unless command_available?
+        io_error 'Can\'t find pdf-table-extract executable in PATH'
+      end
+
+      src = determine_source(@source)
+      opts = process_options(src).split(' ')
+      args = [extract_command, opts].flatten
+
+      pid = Spoon.spawnp(*args)
+      Process.waitpid(pid)
+
+      io_error("Could not parse #{src}") unless $?.exitstatus.zero?
+    end
+
+    private
+
+    def io_error(error_message)
+      raise IOError, error_message
+    end
+
+    def process_options(source)
+      opts = []
+      opts.push("-i #{source}") if source
+      opts.push("-o #{@target}") if @target
+      opts.push("-p #{@options[:page]}") if @options[:page]
+      opts.push("-t #{@options[:format]}") if @options[:format]
+
+      opts.join(' ')
+    end
+
+    def command_available?
+      extract_command
+    end
+
+    def extract_command
+      'pdf-table-extract' if which('pdf-table-extract')
+    end
+
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable? exe
+        end
+      end
+      nil
+    end
+
+    def random_source_name
+      rand(16**16).to_s(16)
+    end
+
+    def download_file(source)
+      tmp_file = "/tmp/#{random_source_name}.pdf"
+      File.open(tmp_file, 'wb') do |saved_file|
+        open(URI.encode(source), 'rb') do |read_file|
+          saved_file.write(read_file.read)
+        end
+      end
+
+      tmp_file
+    end
+
+    def determine_source(source)
+      is_file = File.exist?(source) && !File.directory?(source)
+      is_http = URI(source).scheme == 'http'
+      is_https = URI(source).scheme == 'https'
+
+      unless is_file || is_http || is_https
+        raise IOError, "Source (#{source}) is neither a file nor an URL."
+      end
+
+      is_file ? source : download_file(source)
+    end
+  end
+
+  # Read infor from PDF file usin pdf-reader
+  class Reader
+    def initialize(source)
+      @reader = PDF::Reader.new(source)
+    end
+
+    def metadata
+      @reader.metadata
+    end
+
+    def info
+      @reader.info
+    end
+
+    def page_count
+      @reader.page_count
+    end
+  end
+
+  # options[:type]
+  # {cells_csv,cells_json,cells_xml,table_csv,table_html,table_chtml,table_list}
+  def self.parse(source, target, options = {})
+    Parser.new(source, target, options).parse
+  end
+end

data/spec/gaspar_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Gaspar do
+  before(:all) do
+    @table_pdf = file_path("table.pdf")
+    @target_path = "#{Dir::tmpdir}"
+    @table_html = @target_path + "/output.html"
+  end
+
+
+  describe '#parse' do
+    describe 'with wrong params' do
+      it 'should raise error if source file does not exists' do
+        c = Gaspar::Parser.new('unknown.pdf', 'unknown.html')
+        expect { c.parse }.to raise_error(IOError)
+      end
+
+      it 'should raise error if source is not file nor url' do
+        c = Gaspar::Parser.new('http://  /.pdf', 'unknown.html')
+        expect { c.parse }.to raise_error(URI::InvalidURIError)
+      end
+    end
+
+    describe 'with write params' do
+      it "should be possible to specify one page" do
+        Gaspar::Parser.new(@table_pdf, @table_html, {
+          page: 2, format: 'table_html'
+        }).parse
+
+        doc = Nokogiri::HTML(File.open(@table_html))
+        expect(doc.search('//comment()').text).not_to be_empty
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'gaspar'
+require 'nokogiri'
+require 'tmpdir'
+
+def file_path(*paths)
+  File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', *paths))
+end
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: gaspar-pdf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- 5rabbits
+- Abraham Barrera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spoon
+  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: pdf-reader
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: nokogiri
+  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'
+description: Parses PDF tables into HTML, JSON, XML and more.
+email:
+- abarrerac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- gaspar-pdf.gemspec
+- lib/gaspar.rb
+- lib/gaspar/version.rb
+- spec/fixtures/table.pdf
+- spec/gaspar_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/5rabbits/gaspar-pdf
+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: Parses PDF tables into HTML, JSON, XML and more.
+test_files:
+- spec/fixtures/table.pdf
+- spec/gaspar_spec.rb
+- spec/spec_helper.rb