pdf_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 641f9978e0a51ba3e4453c7f4b793df7963760f86b367b94e50ac7ae9418aaa6
+  data.tar.gz: 7201cdfbbaeea72b9009ee59df7f8b4c103b3b4f6f9ff6e4e25677a047440e07
+SHA512:
+  metadata.gz: 98261b8ce7aa2a6431c29681c9db10ddc0c3fc9264d6e6c21f40dff4ce3a0cca106d2f42c405acf5e2df785ec5cf3642ce90a9aa8b98ed2b7cc44cb492c2fac3
+  data.tar.gz: cc64f066896705b75beec9f51301ba0b4d013be5ae90ffd1ed73471cef0f5cfc5de79e525ff0db3349933aa1f5d5d4e79c5a5e65bc9dadb08a325d4c9fd3c512

data/.gitignore

@@ -0,0 +1,59 @@
+*.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
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## 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
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+sudo: false
+language: ruby
+rvm:
+  - 2.5.3
+script:
+  - bundle exec rspec
+before_install: gem install bundler -v 2.0.2
+branches:
+  only:
+    - master

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    pdf_tools (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.17)
+  pdf_tools!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  simplecov
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Ilia K
+
+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,54 @@
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d402008317c8f6cc6715/test_coverage)](https://codeclimate.com/github/ldrner/pdf_tools/test_coverage)
+
+# PdfTools
+
+Ruby wrapper for the PDF Tools command-line utils.
+[https://www.pdf-tools.com/](https://www.pdf-tools.com/)
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdf_tools'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pdf_tools
+
+## Usage
+
+Native support for next tools are available:
+* 3-Heights™ PDF Merge Split
+* 3-Heights™ Image to PDF Converter
+
+```ruby
+  PdfTools::Tool::ImageToPdf.new do |tool|
+    tool.lk "license key"
+    tool.f
+    tool << "input.tif"
+    tool << "output.pdf"
+  end
+```
+
+```ruby
+  PdfTools::Tool::MergeSplit.new do |tool|
+    tool.lk "license key"
+    tool.m
+    tool << "in1.pdf"
+    tool.ot "Bookmark"
+    tool << "in2.pdf"
+    tool << "out.pdf"
+  end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ldrner/pdf_tools.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pdf_tools"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pdf_tools.rb

@@ -0,0 +1,7 @@
+require 'pdf_tools/version'
+
+module PdfTools
+  class Error < StandardError; end
+end
+
+require 'pdf_tools/tool'

data/lib/pdf_tools/shell.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module PdfTools
+  # Send commands to the shell
+  class Shell
+    def run(command, **options)
+      stdout, stderr, status = execute(command)
+
+      if status != 0
+        raise PdfTools::Error, "Command `#{command.join(' ')}` failed!\n  Error: #{stderr}"
+      end
+
+      $stderr.print(stderr) unless options[:stderr] == false
+
+      [stdout, stderr, status]
+    end
+
+    def execute(command)
+      stdout, stderr, status =
+        Open3.popen3(*command) do |stdin, stdout, stderr, wait_thr|
+          [stdin, stdout, stderr].each(&:binmode)
+          stdout_reader = Thread.new { stdout.read }
+          stderr_reader = Thread.new { stderr.read }
+
+          [stdout_reader.value, stderr_reader.value, wait_thr.value]
+        end
+
+      [stdout, stderr, status.exitstatus]
+    rescue Errno::ENOENT, IOError
+      ['', "executable not found: \"#{command.first}\"", 127]
+    end
+  end
+end

data/lib/pdf_tools/tool.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require 'pdf_tools/shell'
+
+module PdfTools
+  # Abstract class that wraps command-line tools.
+  #
+  # @example
+  #   PdfTools::Tool::ImageToPdf.new do |tool|
+  #     tool.lk "license key"
+  #     tool.f
+  #     tool << "input.tif"
+  #     tool << "output.pdf"
+  #   end
+  class Tool
+    KEY_VALUE_OPTIONS = %w[i]
+
+    # Execute the command.
+    #
+    # @example
+    #   version = PdfTools::Tool::ImageToPdf.new { |b| b.version }
+    #   puts version
+    #
+    # @return [PdfTools::Tool, String] If no block is given, returns an
+    #   instance of the tool, if block is given, returns the command output.
+    def self.new(*args)
+      instance = super(*args)
+
+      if block_given?
+        yield instance
+        instance.call
+      else
+        instance
+      end
+    end
+
+    attr_reader :name, :args
+
+    def initialize(name)
+      @name  = name
+      @args  = []
+    end
+
+    # Build and execute the command.
+    #
+    # @example
+    #   img2pdf = PdfTools::Tool::ImageToPdf.new
+    #   img2pdf.d(150)
+    #   img2pdf << "input.tif"
+    #   img2pdf << "output.pdf"
+    #   img2pdf.call # executes `img2pdf -d 150 input.tif output.pdf`
+    #
+    # @example
+    #   img2pdf = PdfTools::Tool::ImageToPdf.new
+    #
+    #   img2pdf.call do |stdout, stderr, status|
+    #     # ...
+    #   end
+    #
+    # @yield [Array] yields stdout, stderr, exit status (optional)
+    #
+    # @return [String] the output of the command
+    def call(*args)
+      options = args[-1].is_a?(Hash) ? args.pop : {}
+
+      options[:stderr] = false if block_given?
+
+      shell = PdfTools::Shell.new
+      stdout, stderr, status = shell.run(command, options)
+      yield stdout, stderr, status if block_given?
+
+      stdout.chomp("\n")
+    end
+
+    # The built command as array.
+    #
+    # @return [Array<String>]
+    #
+    # @example
+    #   img2pdf = PdfTools::Tool::ImageToPdf.new
+    #   img2pdf.d(150)
+    #   img2pdf << "input.tif"
+    #   img2pdf << "output.pdf"
+    #   img2pdf.command #=> ["img2pdf", "-d", "150", "input.tif", "output.pdf"]
+    def command
+      [*name, *args]
+    end
+
+    # Append raw options.
+    #
+    # @return [self]
+    def <<(arg)
+      args << arg.to_s
+      self
+    end
+
+    # Merge a list of raw options.
+    #
+    # @return [self]
+    def merge!(add_args)
+      add_args.each { |arg| self << arg }
+      self
+    end
+
+    # Define option methods with key=value args.
+    # For Ex. Set Document Information  -i <key=value>
+    #
+    # @example
+    #   tool = PdfTools::Tool::ImageToPdf.new
+    #   tool.i(:title => "My Title", :author => "My Name")
+    #   tool << 'image.jpg'
+    #   tool << 'output.pdf'
+    KEY_VALUE_OPTIONS.each do |option|
+      define_method(option.gsub('-', '_')) do |hash = {}|
+        hash.flat_map { |k, v| ["-#{option}", [k.capitalize, "\"#{v}\""].join('=')] }
+            .each { |el| self << el }
+        self
+      end
+    end
+
+    # Any missing method will be transformed into a CLI option
+    #
+    # @example
+    #   licmgr = PdfTools::Tool.new("licmgr")
+    #   licmgr.<< "info"
+    #   licmgr << "your license key"
+    #   licmgr.command #=> ["licmgr", "info", "your license key"]
+    def method_missing(name, *args)
+      option = "-#{name.to_s.tr('_', '-')}"
+      self << option
+      self.merge!(args)
+      self
+    end
+
+    def self.available_options
+      tool = new
+      tool << '-version'
+
+      help_page = tool.call(stderr: false)
+      available_options = help_page.scan(/^\s+-[a-z\-]+/).map(&:strip)
+      available_options.map { |o| o[1..-1].tr('-', '_') }
+    end
+  end
+end
+
+require 'pdf_tools/tool/image_to_pdf'
+require 'pdf_tools/tool/merge_split'

data/lib/pdf_tools/tool/image_to_pdf.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PdfTools
+  class Tool
+    # Wrapper for 3-Heights(TM) Image to PDF Converter Shell
+    # @see https://www.pdf-tools.com/public/downloads/manuals/Image2PdfShell.pdf
+    #
+    # Return Codes
+    # 0 Success
+    # 1 Input File could not be opened or invalid parameters
+    # 2 The PDF Output File could not be written
+    # 3 Option error
+    # 4 OCR error
+    # 5 Decode errors
+    # 10 License error
+    # none Information (stdout) "Done."
+    class ImageToPdf < PdfTools::Tool
+      TOOL_NAME = 'img2pdf'
+
+      def initialize(*args)
+        super(TOOL_NAME, *args)
+      end
+    end
+  end
+end

data/lib/pdf_tools/tool/merge_split.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module PdfTools
+  class Tool
+    # Wrapper for 3-Heights(TM) Split and merge PDF documents Shell
+    # @see https://www.pdf-tools.com/public/downloads/manuals/PdfSplitMergeShell.pd
+    #
+    # Return Codes
+    # 0 Success.
+    # 1 Couldn't open input file.
+    # 2 PDF output file could not be created.
+    # 3 Error with given options, e.g. too many parameters.
+    # 4 Generic processing error.
+    # 10 License error, e.g. invalid license key
+    class MergeSplit < PdfTools::Tool
+      TOOL_NAME = 'pdfsplmrg'
+
+      def initialize(*args)
+        super(TOOL_NAME, *args)
+      end
+    end
+  end
+end

data/lib/pdf_tools/version.rb

@@ -0,0 +1,3 @@
+module PdfTools
+  VERSION = '0.1.0'
+end

data/pdf_tools.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pdf_tools/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pdf_tools'
+  spec.version       = PdfTools::VERSION
+  spec.authors       = ['Ilya K.']
+  spec.email         = ['ldrner@gmail.com']
+
+  spec.summary       = 'Ruby wrapper for the PDF Tools command-line utils'
+  spec.description   = 'Ruby wrapper for the PDF Tools command-line utils. https://www.pdf-tools.com/'
+  spec.homepage      = 'https://github.com/ldrner/pdf_tools'
+  spec.license       = 'MIT'
+
+  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  # spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.3'
+
+  spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: pdf_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ilya K.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '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: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Ruby wrapper for the PDF Tools command-line utils. https://www.pdf-tools.com/
+email:
+- ldrner@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pdf_tools.rb
+- lib/pdf_tools/shell.rb
+- lib/pdf_tools/tool.rb
+- lib/pdf_tools/tool/image_to_pdf.rb
+- lib/pdf_tools/tool/merge_split.rb
+- lib/pdf_tools/version.rb
+- pdf_tools.gemspec
+homepage: https://github.com/ldrner/pdf_tools
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ldrner/pdf_tools
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the PDF Tools command-line utils
+test_files: []