htmlcsstoimage-api 0.1.0 → 0.1.1

data/lib/htmlcsstoimage.rb

@@ -28,7 +28,7 @@ class HTMLCSSToImage
   #   If credentials are not provided, will try to use environment variables.
   #   `HCTI_USER_ID` and `HCTI_API_KEY`.
   #
-  # @see {https://htmlcsstoimage.com/dashboard}
+  # @see https://htmlcsstoimage.com/dashboard
   #
   # @param user_id [String] the user_id for the account.
   # @param api_key [String] the api_key for the account.
@@ -39,7 +39,7 @@ class HTMLCSSToImage
 
   # Converts HTML/CSS to an image with the API
   #
-  # @see {https://docs.htmlcsstoimage.com/getting-started/using-the-api}
+  # @see https://docs.htmlcsstoimage.com/getting-started/using-the-api
   #
   # @param html [String] This is the HTML you want to render. You can send an HTML snippet (`<div>Your content</div>`) or an entire webpage.
   #
@@ -62,7 +62,7 @@ class HTMLCSSToImage
 
   # Deletes an image
   #
-  # @see {https://docs.htmlcsstoimage.com/getting-started/using-the-api}
+  # @see https://docs.htmlcsstoimage.com/getting-started/using-the-api
   #
   # @param image_id [String] The ID for the image you would like to delete
   def delete_image(image_id)
@@ -73,14 +73,13 @@ class HTMLCSSToImage
     response
   end
 
-
   # Creates a signed URL for generating an image from a template
   # This URL contains the template_values in it. It is signed with HMAC so that it cannot be changed
   # by anyone without the API Key.
   #
   # Does not make any network requests.
   #
-  # @see {https://docs.htmlcsstoimage.com/getting-started/using-the-api}
+  # @see https://docs.htmlcsstoimage.com/getting-started/using-the-api
   #
   # @param template_id [String] The ID for the template
   # @param template_values [Hash] A hash containing the values to replace in the template
@@ -101,6 +100,17 @@ class HTMLCSSToImage
     ApiResponse.new(url: url)
   end
 
+  # Generate a screenshot of a URL
+  #
+  # @see https://docs.htmlcsstoimage.com/getting-started/url-to-image/
+  #
+  # @param url [String] The fully qualified URL to a public webpage. Such as https://htmlcsstoimage.com.
+  # @option params [String] :selector A CSS selector for an element on the webpage. We'll crop the image to this specific element. For example: `section#complete-toolkit.container-lg`
+  # @option params [Integer] :ms_delay The number of milliseconds the API should delay before generating the image. This is useful when waiting for JavaScript. We recommend starting with `500`. Large values slow down the initial render time.
+  # @option params [Double] :device_scale This adjusts the pixel ratio for the screenshot. Minimum: `1`, Maximum: `3`.
+  # @option params [Boolean] :render_when_ready Set to true to control when the image is generated. Call `ScreenshotReady()` from JavaScript to generate the image. [Learn more](https://docs.htmlcsstoimage.com/guides/render-when-ready/).
+  # @option params [Integer] :viewport_width Set the width of Chrome's viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.
+  # @option params [Integer] :viewport_height Set the height of Chrome's viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.
   def url_to_image(url, params = {})
     body = { url: url }.merge(params).to_json
     options = { basic_auth: @auth, body: body, query: { includeId: true } }
@@ -108,8 +118,36 @@ class HTMLCSSToImage
     self.class.post("/v1/image", options)
   end
 
+  # Retrieves all available templates
+  #
+  # @see https://docs.htmlcsstoimage.com/getting-started/templates/
   def templates(params = {})
     options = params.merge({ basic_auth: @auth })
     self.class.get("/v1/template", options)
   end
+
+  # Creates an image template
+  #
+  # @see https://docs.htmlcsstoimage.com/getting-started/templates/
+  #
+  # @param html [String] This is the HTML you want to render. You can send an HTML snippet (`<div>Your content</div>`) or an entire webpage.
+  #
+  # @option params [String] :name A short name to identify your template max length 64
+  # @option params [String] :description Description to elaborate on the use of your template max length 1024
+  # @option params [String] :css The CSS for your image.
+  # @option params [String] :google_fonts [Google fonts](https://docs.htmlcsstoimage.com/guides/using-google-fonts/) to be loaded. Example: `Roboto`. Multiple fonts can be loaded like this: `Roboto|Open Sans`
+  # @option params [String] :selector A CSS selector for an element on the webpage. We'll crop the image to this specific element. For example: `section#complete-toolkit.container-lg`
+  # @option params [Integer] :ms_delay The number of milliseconds the API should delay before generating the image. This is useful when waiting for JavaScript. We recommend starting with `500`. Large values slow down the initial render time.
+  # @option params [Double] :device_scale This adjusts the pixel ratio for the screenshot. Minimum: `1`, Maximum: `3`.
+  # @option params [Boolean] :render_when_ready Set to true to control when the image is generated. Call `ScreenshotReady()` from JavaScript to generate the image. [Learn more](https://docs.htmlcsstoimage.com/guides/render-when-ready/).
+  # @option params [Integer] :viewport_width Set the width of Chrome's viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.
+  # @option params [Integer] :viewport_height Set the height of Chrome's viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.
+  #
+  # @return [HTMLCSSToImage::ApiResponse] image URL available at `.url`.
+  def create_template(html, params = {})
+    body = { html: html }.merge(params).to_json
+    options = { basic_auth: @auth, body: body }
+
+    self.class.post("/v1/template", options)
+  end
 end

data/lib/htmlcsstoimage/version.rb

@@ -1,3 +1,3 @@
 class HTMLCSSToImage
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: htmlcsstoimage-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mike Coutermarsh
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -123,16 +123,19 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate images using HTML/CSS and Ruby.
+description: 'Ruby client for the HTML/CSS to Image API. Generate a png, jpg or webp
+  images with Ruby. Renders exactly like Google Chrome. '
 email:
 - support@htmlcsstoimage.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".yard-gh-pages.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -143,10 +146,28 @@ files:
 - bin/setup
 - cassettes/HTMLCSSToImage/_create_image/accepts_additional_params.yml
 - cassettes/HTMLCSSToImage/_create_image/creates_an_image.yml
+- cassettes/HTMLCSSToImage/_create_template/creates_a_new_template.yml
 - cassettes/HTMLCSSToImage/_delete_image/deletes_an_image.yml
 - cassettes/HTMLCSSToImage/_templates/retrieves_templates.yml
 - cassettes/HTMLCSSToImage/_url_to_image/accepts_additional_params.yml
 - cassettes/HTMLCSSToImage/_url_to_image/creates_an_image_from_a_url.yml
+- docs/HTMLCSSToImage.html
+- docs/HTMLCSSToImage/ApiResponse.html
+- docs/_config.yml
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
 - htmlcsstoimage.gemspec
 - lib/htmlcsstoimage.rb
 - lib/htmlcsstoimage/version.rb
@@ -172,5 +193,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Ruby wrapper for the HTML/CSS to Image API.
+summary: Ruby client for the HTML/CSS to Image API.
 test_files: []