selectpdf 1.3.0

data/samples/html_to_pdf_headers_and_footers.rb

@@ -0,0 +1,61 @@
+require 'selectpdf'
+
+$stdout.sync = true
+
+print "This is SelectPdf-#{SelectPdf::CLIENT_VERSION}\n"
+
+url = 'https://selectpdf.com'
+local_file = 'Test.pdf'
+api_key = 'Your API key here'
+
+begin
+  client = SelectPdf::HtmlToPdfClient.new(api_key)
+
+  # set parameters - see full list at https://selectpdf.com/html-to-pdf-api/
+
+  client.margins = 0 # PDF page margins
+  client.page_breaks_enhanced_algorithm = TRUE # enhanced page break algorithm
+
+  # header properties
+  client.show_header = TRUE # display header
+  # client.header_height = 50 # header height
+  # client.header_url = url # header url
+  client.header_html = 'This is the <b>HEADER</b>!!!!' # header html
+
+  # footer properties
+  client.show_footer = TRUE # display footer
+  # client.footer_height = 60 # footer height
+  # client.footer_url = url # footer url
+  client.footer_html = 'This is the <b>FOOTER</b>!!!!' # footer html
+
+  # footer page numbers
+  client.page_numbers = TRUE # show page numbers in footer
+  client.page_numbers_template = '{page_number} / {total_pages}' # page numbers template
+  client.page_numbers_font_name = 'Verdanda' # page numbers font name
+  client.page_numbers_font_size = 12 # page numbers font size
+  client.page_numbers_alignment = SelectPdf::PageNumbersAlignment::CENTER # page numbers alignment
+
+  print "Starting conversion ...\n"
+
+  # convert url to file
+  client.convert_url_to_file(url, local_file)
+
+  # convert url to memory
+  # pdf = client.convert_url(url)
+
+  # convert html string to file
+  # client.convert_html_string_to_file('This is some <b>html</b>.', local_file)
+
+  # convert html string to memory
+  # pdf = client.convert_html_string('This is some <b>html</b>.')
+
+  print "Finished! Number of pages: #{client.number_of_pages}.\n"
+
+  # get API usage
+  usage_client = SelectPdf::UsageClient.new(api_key)
+  usage = usage_client.get_usage(FALSE)
+  print("Usage: #{usage}\n")
+  print('Conversions remained this month: ', usage['available'], "\n")
+rescue SelectPdf::ApiException => e
+  print("An error occurred: #{e}")
+end

data/samples/html_to_pdf_main.rb

@@ -0,0 +1,64 @@
+require 'selectpdf'
+
+$stdout.sync = true
+
+print "This is SelectPdf-#{SelectPdf::CLIENT_VERSION}\n"
+
+url = 'https://selectpdf.com'
+local_file = 'Test.pdf'
+api_key = 'Your API key here'
+
+begin
+  client = SelectPdf::HtmlToPdfClient.new(api_key)
+
+  # set parameters - see full list at https://selectpdf.com/html-to-pdf-api/
+
+  client.page_size = SelectPdf::PageSize::A4 # PDF page size
+  client.page_orientation = SelectPdf::PageOrientation::PORTRAIT # PDF page orientation
+  client.margins = 0 # PDF page margins
+  client.rendering_engine = SelectPdf::RenderingEngine::WEBKIT # rendering engine
+  client.conversion_delay = 1 # conversion delay
+  client.navigation_timeout = 30 # navigation timeout
+  client.page_numbers = FALSE # page numbers
+  client.page_breaks_enhanced_algorithm = TRUE # enhanced page break algorithm
+
+  # additional properties
+
+  # client.use_css_print = TRUE # enable CSS media print
+  # client.disable_javascript = TRUE # disable javascript
+  # client.disable_internal_links = TRUE # disable internal links
+  # client.disable_external_links = TRUE # disable external links
+  # client.keep_images_together = TRUE # keep images together
+  # client.scale_images = TRUE # scale images to create smaller pdfs
+  # client.single_page_pdf = TRUE # generate a single page PDF
+  # client.user_password = 'password' # secure the PDF with a password
+
+  # generate automatic bookmarks
+
+  # client.pdf_bookmarks_selectors = 'H1, H2' # create outlines (bookmarks) for the specified elements
+  # client.viewer_page_mode = SelectPdf::PageMode::USE_OUTLINES # display outlines (bookmarks) in viewer
+
+  print "Starting conversion ...\n"
+
+  # convert url to file
+  client.convert_url_to_file(url, local_file)
+
+  # convert url to memory
+  # pdf = client.convert_url(url)
+
+  # convert html string to file
+  # client.convert_html_string_to_file('This is some <b>html</b>.', local_file)
+
+  # convert html string to memory
+  # pdf = client.convert_html_string('This is some <b>html</b>.')
+
+  print "Finished! Number of pages: #{client.number_of_pages}.\n"
+
+  # get API usage
+  usage_client = SelectPdf::UsageClient.new(api_key)
+  usage = usage_client.get_usage(FALSE)
+  print("Usage: #{usage}\n")
+  print('Conversions remained this month: ', usage['available'], "\n")
+rescue SelectPdf::ApiException => e
+  print("An error occurred: #{e}")
+end

data/samples/simple_html_string_to_pdf.rb

@@ -0,0 +1,19 @@
+require 'selectpdf'
+print "This is SelectPdf-#{SelectPdf::CLIENT_VERSION}\n"
+
+html = 'This is a <b>test HTML</b>.'
+local_file = 'Test.pdf'
+api_key = 'Your API key here'
+
+begin
+  api = SelectPdf::HtmlToPdfClient.new(api_key)
+
+  api.page_size = SelectPdf::PageSize::A4
+  api.margins = 0
+  api.page_numbers = FALSE
+  api.page_breaks_enhanced_algorithm = TRUE
+
+  api.convert_html_string_to_file(html, local_file)
+rescue SelectPdf::ApiException => e
+  print("An error occurred: #{e}")
+end

data/samples/simple_url_to_pdf.rb

@@ -0,0 +1,19 @@
+require 'selectpdf'
+print "This is SelectPdf-#{SelectPdf::CLIENT_VERSION}\n"
+
+url = 'https://selectpdf.com'
+local_file = 'Test.pdf'
+api_key = 'Your API key here'
+
+begin
+  api = SelectPdf::HtmlToPdfClient.new(api_key)
+
+  api.page_size = SelectPdf::PageSize::A4
+  api.margins = 0
+  api.page_numbers = FALSE
+  api.page_breaks_enhanced_algorithm = TRUE
+
+  api.convert_url_to_file(url, local_file)
+rescue SelectPdf::ApiException => e
+  print("An error occurred: #{e}")
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: selectpdf
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- SelectPdf
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-17 00:00:00.000000000 Z
+dependencies: []
+description: |2
+                        SelectPdf Online REST API is a professional solution for managing PDF documents online.
+                        SelectPdf cloud API consists of the following:
+                        HTML to PDF REST API – SelectPdf HTML To PDF Online REST API is a professional solution that lets you create PDF from web pages and raw HTML code in your applications.
+email: support@selectpdf.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/selectpdf.rb
+- samples/html_to_pdf_headers_and_footers.rb
+- samples/html_to_pdf_main.rb
+- samples/simple_html_string_to_pdf.rb
+- samples/simple_url_to_pdf.rb
+homepage: https://selectpdf.com/html-to-pdf-api/
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: SelectPdf Online REST API client library for Ruby. Contains a powerful HTML
+  to PDF converter.
+test_files: []