Dhalang 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ccf622bf03fb6c32a8ee8a4ab020017d3fc058ac
+  data.tar.gz: 91f7d4409f8500bc5fa8a8e6012bddfbbbf0ea6f
+SHA512:
+  metadata.gz: e65ca807af24f423c9dac5c853a13204f0bab8dcfd93aaea269499d6837167b675f24a6a5c5429086747407ff8b9ddee59299dfcf11d1a1274d267c4d43cc30f
+  data.tar.gz: a6c1b92715bf262445f9a8031897a817af37371b3dd5399571c53e3e0f5cedad1e327ae0a242608b66fa83dd8842114f2a588dc1cb73837495d6dc54cce444c5

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.idea/*
+
+# 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

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+ - 2.2
+addons:
+  chrome: stable
+install:
+ - bundle install
+ - npm install
+script: bundle exec rake spec

data/Dhalang.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "Dhalang/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "Dhalang"
+  spec.version       = Dhalang::VERSION
+  spec.authors       = ["Niels Steensma"]
+  spec.email         = ["nielssteensma@yahoo.nl"]
+
+  spec.summary       = "Ruby wrapper for Puppeteer. Generate PDF's from HTML and URLs!"
+  spec.homepage      = "https://github.com/NielsSteensma/Dhalang"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pdf-reader", "~> 2.2"
+end

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 Dhalang.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 NielsS
+
+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,42 @@
+# Dhalang [![Build Status](https://travis-ci.com/NielsSteensma/Dhalang.svg?token=XZgKAByw2KZjcrsCh8gW&branch=master)](https://travis-ci.com/NielsSteensma/Dhalang)
+
+> Dhalang is a Ruby wrapper for Google's Puppeteer.
+
+
+## Features
+* Generate PDFs from pages
+* Generate PDFs from html ( external images/stylesheets supported )  
+  
+More will come.
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'dhalang'
+
+And then execute:
+
+    $ bundle update
+
+Install puppeteer in your application's root directory:
+
+    $ npm install puppeteer
+
+<sub>NodeJS v7.6.0 or greater is required</sub>
+## Usage
+__Get a PDF of a website url__  
+`Dhalang::PDF.get_from_url("https://www.google.com")`  
+It is important to pass the complete url, leaving out https://, http:// or www. will result in an error.
+  
+__Get a PDF of a HTML string__  
+`Dhalang::PDF.get_from_html("<html><head></head><body><h1>examplestring</h1></body></html>")`  
+
+Both methods return a string containing the PDF in binary.   
+  
+To return the PDF from a Rails controller you can do the following:  
+```
+def example_controller_method  
+    binary_pdf = Dhalang::PDF.get_from_url("https://www.google.com")  
+    send_data(binary_pdf, filename: 'pdfofgoogle.pdf', type: 'application/pdf')  
+end
+```

data/Rakefile

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

data/lib/Dhalang.rb

@@ -0,0 +1,3 @@
+module Dhalang
+  require 'PDF'
+end

data/lib/Dhalang/version.rb

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

data/lib/PDF.rb

@@ -0,0 +1,65 @@
+require "Dhalang/version"
+require 'uri'
+require 'tempfile'
+
+module Dhalang
+  class PDF
+    PDF_GENERATOR_JS_PATH = File.expand_path('../js/pdfgenerator.js', __FILE__)
+    PROJECT_PATH = Dir.pwd + '/node_modules/'
+
+    def self.get_from_url(url)
+      validate_url(url)
+      temporary_pdf_save_file = create_temporary_pdf_file
+      begin
+        visit_page_with_puppeteer(url, temporary_pdf_save_file.path)
+        binary_pdf_content = get_file_content_as_binary_string(temporary_pdf_save_file)
+      ensure
+        temporary_pdf_save_file.close unless temporary_pdf_save_file.closed?
+        temporary_pdf_save_file.unlink
+      end
+      return binary_pdf_content
+    end
+
+    def self.get_from_html(html)
+      html_file = create_temporary_html_file(html)
+      temporary_pdf_save_file = create_temporary_pdf_file
+      begin
+        visit_page_with_puppeteer("file://" + html_file.path, temporary_pdf_save_file.path)
+        binary_pdf_content = get_file_content_as_binary_string(temporary_pdf_save_file)
+      ensure
+        temporary_pdf_save_file.close unless temporary_pdf_save_file.closed?
+        html_file.close unless html_file.closed?
+        temporary_pdf_save_file.unlink
+        html_file.unlink
+      end
+      return binary_pdf_content
+    end
+
+    private
+    def self.validate_url(url)
+      if (url !~ URI::DEFAULT_PARSER.regexp[:ABS_URI])
+        raise URI::InvalidURIError, 'The given url was invalid, use format http://www.example.com'
+      end
+    end
+
+    def self.create_temporary_pdf_file
+      Tempfile.new("pdf")
+    end
+
+    ## Creates a temp .html file which can be browsed to by puppeteer for creating a pdf
+    def self.create_temporary_html_file(content)
+      html_file = Tempfile.new(['page', '.html'])
+      html_file.write(content)
+      html_file.rewind
+      return html_file
+    end
+
+    def self.visit_page_with_puppeteer(page_to_visit, path_to_save_pdf_to)
+      system("node #{PDF_GENERATOR_JS_PATH} #{page_to_visit} #{Shellwords.escape(path_to_save_pdf_to)} #{Shellwords.escape(PROJECT_PATH)}")
+    end
+
+    def self.get_file_content_as_binary_string(file)
+      IO.binread(file.path)
+    end
+  end
+end

data/lib/js/pdfgenerator.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const createPdf = async() => {
+    module.paths.push(process.argv[4]);
+    const puppeteer = require('puppeteer');
+    let browser;
+    try {
+        browser = await puppeteer.launch({args: ['--no-sandbox', '--disable-setuid-sandbox']});
+        const page = await browser.newPage();
+        await page.goto(process.argv[2], {timeout: 10000, waitUntil: 'networkidle2'});
+        await page.waitFor(250);
+        await page.pdf({
+            path: process.argv[3],
+            format: 'A4',
+            margin: { top: 36, right: 36, bottom: 20, left: 36 },
+            printBackground: true
+        });
+    } catch (err) {
+        console.log(err.message);
+    } finally {
+        if (browser) {
+            browser.close();
+        }
+        process.exit();
+    }
+};
+createPdf();

data/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "dhalang",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NielsSteensma/Dhalang.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/NielsSteensma/Dhalang/issues"
+  },
+  "homepage": "https://github.com/NielsSteensma/Dhalang#readme",
+  "devDependencies": {
+    "puppeteer": "^1.11.0"
+  }
+}

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: Dhalang
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Niels Steensma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: 
+email:
+- nielssteensma@yahoo.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Dhalang.gemspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/Dhalang.rb
+- lib/Dhalang/version.rb
+- lib/PDF.rb
+- lib/js/pdfgenerator.js
+- package.json
+homepage: https://github.com/NielsSteensma/Dhalang
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Puppeteer. Generate PDF's from HTML and URLs!
+test_files: []