pdf_links_checker 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 244603c961f81cca8061c369527ea98836af422cc46045cae57ce420cc3d49c5
-  data.tar.gz: a8a5158995e37b40d9d0180a43a9a8196f93b30a927ae5c9fba22b726778ee59
+  metadata.gz: ce8e50b31b32e8b7fc0a62dc7b3b3fc8818e54e1e86aef62394f303338e9be03
+  data.tar.gz: ceb5be089c2c35581b6f32106212be5abb19893ab7ac08416b9ac66953320136
 SHA512:
-  metadata.gz: 94501c39b1043b98acfd2a65ceb23fe5d6438c1f889e0f6b90624cb2eb1df23b23203489871a1665e5787686210793835b2489c23b5d87ca513442c05f9b4266
-  data.tar.gz: f8587232058d13e9c9101c65549da9cc4323f4eafb45791c27d1bdc03f1f26344a3a53d8925022682f0fd6a50366fe4842369fcfbf9ae0d0c762f21480fe4cad
+  metadata.gz: ff2ff91b47790616b9dea5e2c2af1731ce7a146055bba6c44330583b0fb0c5b61136dae8ec454ec492f870d2a8217b486fb54609a24bcc1b3cc7b805756d509c
+  data.tar.gz: cb911c257a974dbcf383e1f68542a280b70ff7467739354035e2d1b6c5713a54d09d4183197a3ce7f946191d94caf49e6924fc9869c34a4e1c5fd2cc045349ad

data/README.md

@@ -1,28 +1,27 @@
-# PdfLinksChecker
+# PDF Links Checker
 
 [![Build Status](https://travis-ci.org/AndyWendt/pdf_links_checker.svg?branch=master)](https://travis-ci.org/AndyWendt/pdf_links_checker)
 
-TODO: describe
+A utility to ensure that links in PDFs are reachable
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install pdf_links_checker
 
-```ruby
-gem 'pdf_links_checker'
-```
+## Usage
 
-And then execute:
+Commandline: 
 
-    $ bundle install
+    $ pdf_links_checker path/to/file.pdf`
+    Working links: 1 of 2
+    https://not-a-chance-that-this-is-a-working-link.com/
 
-Or install it yourself as:
+Code: 
 
-    $ gem install pdf_links_checker
-
-## Usage
+    file_name = "foo.pdf"
+    file_path = "#{Dir.pwd}/#{file_name}"
+    links = PdfLinksChecker::PdfDocument.from(file_path).links
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -32,7 +31,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pdf_links_checker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/andywendt/pdf_links_checker.
 
 
 ## License

data/Rakefile

@@ -9,8 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]
+task default: %i[test]

data/exe/pdf_links_checker

@@ -3,16 +3,9 @@
 
 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
-
+links = PdfLinksChecker::PdfDocument.from(file_path).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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "pdf_links_checker/version"
+require "pdf_links_checker/pdf_document"
 
 module PdfLinksChecker
   class Error < StandardError; end

data/lib/pdf_links_checker/pdf_document.rb

@@ -1,9 +1,17 @@
 require "pdf_links_checker/annotations"
 require "pdf_links_checker/links"
 require "pdf_links_checker/page"
+require "pdf-reader"
 
 module PdfLinksChecker
   class PdfDocument
+    def self.from(file_path)
+      path = File.expand_path(file_path)
+      doc = PDF::Reader.new(path)
+
+      self.new(doc)
+    end
+
     def initialize(pdf_doc)
       @pdf_doc = pdf_doc
     end

data/lib/pdf_links_checker/url.rb

@@ -1,5 +1,6 @@
 require "pdf_links_checker/invalid_link"
 require "uri"
+require "net/http"
 
 module PdfLinksChecker
   class URL

data/lib/pdf_links_checker/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf_links_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andy Wendt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies: []
 description: Ensures links in PDFs are accessible
 email: