url_report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a8edb12294dbeabe0916c87fb7e8714e739af34404d494f5668095638e10c9e
+  data.tar.gz: 5a83e0851ae33356eee5ee94c576a1adf088d517623d90a7615b05439ad7b013
+SHA512:
+  metadata.gz: 55f3a8ed70da40b44894ab1a06872bc1d9737c14678c7cb76aef27adbb5ba1d31a27e05f25e0371eee2a256bf33d5a1fb0641c0bebb3b9638ea17b6560d0629a
+  data.tar.gz: '09408039fd6d90a02550a6d65b64d0bb2ffe3f6e859f5028cf0afdc9855b52d04bbd3dbb732bbdf85056c4573d257b3e18a49befe5a39a0c157a609a6e8780d6'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in url_report.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 sudo-self
+
+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,39 @@
+# UrlReport
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/url_report`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'url_report'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install url_report
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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]/url_report.
+
+## 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,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 "url_report"
+
+# 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/bin/url_report

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# bin/url_report
+
+require "url_report"
+
+# Get URL from command line argument or prompt the user
+url = ARGV[0]
+
+if url.nil? || url.strip.empty?
+  print "Enter the website URL to scrape: "
+  url = gets.strip
+end
+
+# Exit if still empty
+if url.nil? || url.strip.empty?
+  puts "❌ No URL entered, exiting."
+  exit 1
+end
+
+# Call the gem method and handle errors
+begin
+  file = UrlReport.generate(url)
+  puts "✅ Ruby Report saved to #{file}"
+rescue UrlReport::Error => e
+  puts "❌ #{e.message}"
+rescue StandardError => e
+  puts "❌ Unexpected error: #{e.message}"
+end
+

data/lib/url_report/version.rb

@@ -0,0 +1,3 @@
+module UrlReport
+  VERSION = "0.1.0"
+end

data/lib/url_report.rb

@@ -0,0 +1,96 @@
+# lib/url_report.rb
+
+require "httparty"
+require "nokogiri"
+require "prawn"
+require "date"
+require "open-uri"
+require "uri"
+
+module UrlReport
+  class Error < StandardError; end
+
+  # Main method to generate a PDF report from a URL
+  def self.generate(url)
+    raise Error, "No URL provided" if url.nil? || url.strip.empty?
+
+    # -----------------------------
+    # 1. Fetch the website
+    # -----------------------------
+    response = HTTParty.get(url)
+    raise Error, "Failed to fetch page: #{response.code}" if response.code != 200
+
+    # -----------------------------
+    # 2. Parse HTML with Nokogiri
+    # -----------------------------
+    doc = Nokogiri::HTML(response.body)
+
+    # Headings
+    headings = doc.css('h1,h2').map(&:text).map(&:strip).reject(&:empty?)
+
+    # Links
+    links = doc.css("a").map { |a| [a.text.strip, a['href']] }
+    links.reject! { |text, href| text.empty? || href.nil? }
+    links = links.first(10)
+
+    # Images
+    images = doc.css('img').map { |img| img['src'] }.reject(&:nil?).first(5)
+    images.map! { |src| URI.join(url, src).to_s rescue src }
+
+    # -----------------------------
+    # 3. Generate PDF with Prawn
+    # -----------------------------
+    timestamp = Time.now.strftime("%Y-%m-%d_%H-%M-%S")
+    filename = "ruby_report_#{timestamp}.pdf"
+
+    Prawn::Document.generate(filename) do
+      text "Ruby Report", size: 20, style: :bold, align: :center
+      move_down 20
+      text "Source: #{url}", size: 10, align: :right
+      text "Date: #{Date.today}", size: 10, align: :right
+      move_down 20
+
+      # Headings
+      unless headings.empty?
+        text "Headings Found:", style: :bold
+        headings.each_with_index do |h, i|
+          safe_text = h.encode('Windows-1252', invalid: :replace, undef: :replace, replace: '?')
+          text "#{i+1}. #{safe_text}", size: 12
+        end
+        move_down 15
+      end
+
+      # Links
+      unless links.empty?
+        text "Links Found:", style: :bold
+        links.each_with_index do |(text, href), i|
+          safe_text = text.encode('Windows-1252', invalid: :replace, undef: :replace, replace: '?')
+          text "#{i+1}. #{safe_text}", size: 12, leading: 2
+          text "<link href='#{href}'>#{href}</link>", inline_format: true, size: 9, color: "0000FF"
+          move_down 10
+        end
+        move_down 15
+      end
+
+      # Images
+      unless images.empty?
+        text "Images Found:", style: :bold
+        images.each_with_index do |img_url, i|
+          text "#{i+1}. #{img_url}", size: 10, color: "0000AA"
+          begin
+            open(img_url) { |f| image f, fit: [400, 300] }
+          rescue
+            text "(Failed to load image)", size: 9, color: "FF0000"
+          end
+          move_down 5
+        end
+        move_down 15
+      end
+
+      text "Ruby Report powered by (HTTParty + Nokogiri + Prawn)",
+           size: 9, align: :center, style: :italic
+    end
+
+    filename
+  end
+end

data/url_report.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "url_report/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "url_report"
+  spec.version       = UrlReport::VERSION
+  spec.authors       = ["sudo-self"]
+  spec.email         = ["jroper719@gmail.com"]
+
+  spec.summary       = "Generate a PDF report of headings, links, and images from a URL"
+  spec.description   = "UrlReport fetches a webpage, extracts headings, links, and images, and generates a PDF report."
+  spec.homepage      = "https://github.com/yourusername/url_report"
+  spec.license       = "MIT"
+
+  # Metadata for RubyGems
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "http://mygemserver.com"  # remove this line
+    spec.metadata["homepage_uri"]    = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"]   = "#{spec.homepage}/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  # Files to include in the gem
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  # Executable
+  spec.bindir      = "bin"
+  spec.executables = ["url_report"]
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "httparty"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "prawn"
+
+  # Development dependencies
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: url_report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sudo-self
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !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: nokogiri
+  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: prawn
+  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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: UrlReport fetches a webpage, extracts headings, links, and images, and
+  generates a PDF report.
+email:
+- jroper719@gmail.com
+executables:
+- url_report
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/url_report
+- lib/url_report.rb
+- lib/url_report/version.rb
+- url_report.gemspec
+homepage: https://github.com/yourusername/url_report
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yourusername/url_report
+  source_code_uri: https://github.com/yourusername/url_report
+  changelog_uri: https://github.com/yourusername/url_report/CHANGELOG.md
+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: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Generate a PDF report of headings, links, and images from a URL
+test_files: []