pdf_links_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 264e2db0471dc175e0f036a4a6b6ac8d4c1cfbde048ca5c68c25627157d55a58
+  data.tar.gz: 590bb293d281298ba78bfc68fb19af7619086036a6f0ef577516b141bafcc835
+SHA512:
+  metadata.gz: 3c0cb19ffa322a61f780efdbf3c53bfb9e208fcde5088659bf43719ca3c1eeadd39a83155913ddc8df057c2f33f963308980c8c866452e1e72829ee6658b24c0
+  data.tar.gz: 56397078ac6a86ed07bbbef086c315fd7f713e013e7e5f9918ca0561e56b351abeb82e390e7285a3c77c7c8cb2a26234ea6601b5ebf4a07584ee4bd219f27718

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.ruby-gemset

@@ -0,0 +1 @@
+pdf_links_checker

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.0

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.2.0.rc.2

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pdf_links_checker.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "pdf-reader", "~> 2.4"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andy Wendt
+
+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,40 @@
+# PdfLinksChecker
+
+[![Build Status](https://travis-ci.org/AndyWendt/pdf_links_checker.svg?branch=master)](https://travis-ci.org/AndyWendt/pdf_links_checker)
+
+TODO: describe
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdf_links_checker'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pdf_links_checker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pdf_links_checker.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pdf_links_checker"
+
+# 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/exe/pdf_links_checker

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pdf_links_checker"
+require "pdf_links_checker/pdf_document"
+require "pdf-reader"
+require "net/http"
+
+file_name = ARGV[0]
+file_path = "#{Dir.pwd}/#{file_name}"
+
+path = File.expand_path(file_path)
+doc = PDF::Reader.new(path)
+
+links = PdfLinksChecker::PdfDocument.new(doc).links
+
+puts "Working links: #{links.valid_count} of #{links.total_count}"
+links.invalid.each { |invalid_link| puts invalid_link }

data/lib/pdf_links_checker.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "pdf_links_checker/version"
+
+module PdfLinksChecker
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/pdf_links_checker/annotations.rb

@@ -0,0 +1,27 @@
+module PdfLinksChecker
+  class Annotations
+    def initialize(pdf_doc)
+      @objects = pdf_doc.objects
+    end
+
+    def find(references)
+      lookup_all(references)
+    end
+
+    def lookup_all(refs)
+      refs = *refs
+      refs.map { |ref| lookup(ref) }
+    end
+
+    def lookup(ref)
+      object = objects[ref]
+      return object unless object.is_a?(Array)
+
+      lookup_all(object)
+    end
+
+    private
+
+    attr_reader :objects
+  end
+end

data/lib/pdf_links_checker/links.rb

@@ -0,0 +1,24 @@
+require "pdf_links_checker/url"
+
+module PdfLinksChecker
+  class Links
+    attr_reader :invalid
+
+    def initialize(links_array)
+      @urls= links_array.map { |link| URL.new(link) }
+      @invalid = @urls.select { |url| url.invalid? }
+    end
+
+    def total_count
+      urls.count
+    end
+
+    def valid_count
+      total_count - invalid.count
+    end
+
+    private
+
+    attr_reader :urls
+  end
+end

data/lib/pdf_links_checker/page.rb

@@ -0,0 +1,25 @@
+module PdfLinksChecker
+  class Page
+    def initialize(pdf_page, annotations)
+      @pdf_page = pdf_page
+      @annotations = annotations
+    end
+
+    def links
+      find_links
+    end
+
+    private
+
+    def find_links
+      references = (pdf_page.attributes[:Annots] || [])
+      annotations.find(references).flatten.select{ |object| link?(object) }
+    end
+
+    def link?(object)
+      object[:Type] == :Annot && [:Link].include?(object[:Subtype])
+    end
+
+    attr_reader :pdf_page, :annotations
+  end
+end

data/lib/pdf_links_checker/pdf_document.rb

@@ -0,0 +1,25 @@
+require "pdf_links_checker/annotations"
+require "pdf_links_checker/links"
+require "pdf_links_checker/page"
+
+module PdfLinksChecker
+  class PdfDocument
+    def initialize(pdf_doc)
+      @pdf_doc = pdf_doc
+    end
+
+    def links
+      pages
+        .reduce([]) { |links, page| links.concat(page.links) }
+        .then { |links| Links.new(links) }
+    end
+
+    private
+
+    def pages
+      pdf_doc.pages.map { |page| Page.new(page, Annotations.new(pdf_doc)) }
+    end
+
+    attr_reader :pdf_doc
+  end
+end

data/lib/pdf_links_checker/url.rb

@@ -0,0 +1,27 @@
+class URL
+  def initialize(pdf_link)
+    @pdf_link = pdf_link
+  end
+
+  def invalid?
+    uri = to_s
+    url = URI.parse(uri)
+    req = Net::HTTP.new(url.host, url.port)
+    req.use_ssl = true if uri.include?("https")
+
+    begin
+      res = req.request_head(url.path)
+      true if res.code == "404"
+    rescue StandardError => e
+      true
+    end
+  end
+
+  def to_s
+    pdf_link[:A][:URI]
+  end
+
+  private
+
+  attr_reader :pdf_link
+end

data/lib/pdf_links_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PdfLinksChecker
+  VERSION = "0.1.0"
+end

data/pdf_links_checker.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/pdf_links_checker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pdf_links_checker"
+  spec.version       = PdfLinksChecker::VERSION
+  spec.authors       = ["Andy Wendt"]
+  spec.email         = ["andy@awendt.com"]
+
+  spec.summary       = "A utility to check links in a PDF"
+  spec.description   = "Ensures links in PDFs are accessible"
+  spec.homepage      = "https://github.com/AndyWendt/pdf_links_checker"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/AndyWendt/pdf_links_checker"
+  spec.metadata["changelog_uri"] = "https://github.com/AndyWendt/pdf_links_checker"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: pdf_links_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Wendt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-10 00:00:00.000000000 Z
+dependencies: []
+description: Ensures links in PDFs are accessible
+email:
+- andy@awendt.com
+executables:
+- pdf_links_checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/pdf_links_checker
+- lib/pdf_links_checker.rb
+- lib/pdf_links_checker/annotations.rb
+- lib/pdf_links_checker/links.rb
+- lib/pdf_links_checker/page.rb
+- lib/pdf_links_checker/pdf_document.rb
+- lib/pdf_links_checker/url.rb
+- lib/pdf_links_checker/version.rb
+- pdf_links_checker.gemspec
+homepage: https://github.com/AndyWendt/pdf_links_checker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AndyWendt/pdf_links_checker
+  source_code_uri: https://github.com/AndyWendt/pdf_links_checker
+  changelog_uri: https://github.com/AndyWendt/pdf_links_checker
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A utility to check links in a PDF
+test_files: []