RubyGems - htmlcsstoimage-api - Versions diffs - 0.1.3 → 0.3.0 - Mend

htmlcsstoimage-api 0.1.3 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (37) hide show

checksums.yaml +4 -4
data/.github/workflows/ruby.yml +1 -3
data/.ruby-version +1 -1
data/Gemfile.lock +42 -35
data/README.md +183 -11
data/htmlcsstoimage.gemspec +4 -2
data/lib/htmlcsstoimage/client.rb +36 -0
data/lib/htmlcsstoimage/images.rb +173 -0
data/lib/htmlcsstoimage/signed_urls.rb +130 -0
data/lib/htmlcsstoimage/templates.rb +99 -0
data/lib/htmlcsstoimage/version.rb +2 -1
data/lib/htmlcsstoimage.rb +8 -151
metadata +24 -30
data/cassettes/HTMLCSSToImage/_create_image/accepts_additional_params.yml +0 -66
data/cassettes/HTMLCSSToImage/_create_image/creates_an_image.yml +0 -64
data/cassettes/HTMLCSSToImage/_create_template/creates_a_new_template.yml +0 -62
data/cassettes/HTMLCSSToImage/_delete_image/deletes_an_image.yml +0 -60
data/cassettes/HTMLCSSToImage/_templates/retrieves_templates.yml +0 -110
data/cassettes/HTMLCSSToImage/_url_to_image/accepts_additional_params.yml +0 -64
data/cassettes/HTMLCSSToImage/_url_to_image/creates_an_image_from_a_url.yml +0 -64
data/docs/HTMLCSSToImage/ApiResponse.html +0 -124
data/docs/HTMLCSSToImage.html +0 -1340
data/docs/_config.yml +0 -1
data/docs/_index.html +0 -122
data/docs/class_list.html +0 -51
data/docs/css/common.css +0 -1
data/docs/css/full_list.css +0 -58
data/docs/css/style.css +0 -496
data/docs/file.README.html +0 -187
data/docs/file_list.html +0 -56
data/docs/frames.html +0 -17
data/docs/index.html +0 -187
data/docs/js/app.js +0 -314
data/docs/js/full_list.js +0 -216
data/docs/js/jquery.js +0 -4
data/docs/method_list.html +0 -107
data/docs/top-level-namespace.html +0 -110

data/docs/HTMLCSSToImage.html DELETED Viewed

@@ -1,1340 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: HTMLCSSToImage
-    &mdash; Documentation by YARD 0.9.25
-</title>
-  <link rel="stylesheet" href="css/style.css" type="text/css" />
-  <link rel="stylesheet" href="css/common.css" type="text/css" />
-<script type="text/javascript">
-  pathId = "HTMLCSSToImage";
-  relpath = '';
-</script>
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="_index.html">Index (H)</a> &raquo;
-    <span class="title">HTMLCSSToImage</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Class: HTMLCSSToImage
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">Object</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">HTMLCSSToImage</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-      <dt>Includes:</dt>
-      <dd>HTTParty</dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/htmlcsstoimage.rb<span class="defines">,<br />
-  lib/htmlcsstoimage/version.rb</span>
-</dd>
-  </dl>
-</div>
-<h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="HTMLCSSToImage/ApiResponse.html" title="HTMLCSSToImage::ApiResponse (class)">ApiResponse</a></span>
-</p>
-    <h2>
-      Constant Summary
-      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
-    </h2>
-    <dl class="constants">
-        <dt id="SIGNED_URL_TEMPLATE-constant" class="">SIGNED_URL_TEMPLATE =
-        </dt>
-        <dd><pre class="code"><span class='const'>Addressable</span><span class='op'>::</span><span class='const'>Template</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://hcti.io/v1/image/{template_id}/{signed_token}{/format*}{?query*}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre></dd>
-        <dt id="VERSION-constant" class="">VERSION =
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
-    </dl>
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#create_image-instance_method" title="#create_image (instance method)">#<strong>create_image</strong>(html, params = {})  &#x21d2; HTMLCSSToImage::ApiResponse </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Converts HTML/CSS to an image with the API.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#create_image_from_template-instance_method" title="#create_image_from_template (instance method)">#<strong>create_image_from_template</strong>(template_id, template_values = {}, params = {})  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Creates a signed URL for generating an image from a template This URL contains the template_values in it.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#create_template-instance_method" title="#create_template (instance method)">#<strong>create_template</strong>(html, params = {})  &#x21d2; HTMLCSSToImage::ApiResponse </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Creates an image template.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#delete_image-instance_method" title="#delete_image (instance method)">#<strong>delete_image</strong>(image_id)  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Deletes an image.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(user_id: ENV[&quot;HCTI_USER_ID&quot;], api_key: ENV[&quot;HCTI_API_KEY&quot;])  &#x21d2; HTMLCSSToImage </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>
-<p>Creates an instance of HTMLCSSToImage with API credentials.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#templates-instance_method" title="#templates (instance method)">#<strong>templates</strong>(params = {})  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Retrieves all available templates.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#url_to_image-instance_method" title="#url_to_image (instance method)">#<strong>url_to_image</strong>(url, params = {})  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Generate a screenshot of a URL.</p>
-</div></span>
-</li>
-    </ul>
-  <div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <h3 class="signature first" id="initialize-instance_method">
-    #<strong>initialize</strong>(user_id: ENV[&quot;HCTI_USER_ID&quot;], api_key: ENV[&quot;HCTI_API_KEY&quot;])  &#x21d2; <tt><span class='object_link'><a href="" title="HTMLCSSToImage (class)">HTMLCSSToImage</a></span></tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Creates an instance of HTMLCSSToImage with API credentials.</p>
-<pre class="code ruby"><code class="ruby">If credentials are not provided, will try to use environment variables.
-`HCTI_USER_ID` and `HCTI_API_KEY`.
-</code></pre>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>user_id</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>ENV[&quot;HCTI_USER_ID&quot;]</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>the user_id for the account.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>api_key</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>ENV[&quot;HCTI_API_KEY&quot;]</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>the api_key for the account.</p>
-</div>
-    </li>
-</ul>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><a href="https://htmlcsstoimage.com/dashboard" target="_parent" title="https://htmlcsstoimage.com/dashboard">https://htmlcsstoimage.com/dashboard</a></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-36
-37
-38</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 36</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>user_id:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HCTI_USER_ID</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>api_key:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HCTI_API_KEY</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
-  <span class='ivar'>@auth</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>username:</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='label'>password:</span> <span class='id identifier rubyid_api_key'>api_key</span> <span class='rbrace'>}</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="create_image-instance_method">
-    #<strong>create_image</strong>(html, params = {})  &#x21d2; <tt><span class='object_link'><a href="HTMLCSSToImage/ApiResponse.html" title="HTMLCSSToImage::ApiResponse (class)">HTMLCSSToImage::ApiResponse</a></span></tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Converts HTML/CSS to an image with the API</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>html</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>This is the HTML you want to render. You can send an HTML snippet (`&lt;div&gt;Your content&lt;/div&gt;`) or an entire webpage.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>params</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>a customizable set of options</p>
-</div>
-    </li>
-</ul>
-    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
-    <ul class="option">
-        <li>
-          <span class="name">:css</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>The CSS for your image.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:google_fonts</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>[Google fonts](<a href="https://docs.htmlcsstoimage.com/guides/using-google-fonts">docs.htmlcsstoimage.com/guides/using-google-fonts</a>/) to be loaded. Example: `Roboto`. Multiple fonts can be loaded like this: `Roboto|Open Sans`</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:selector</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>A CSS selector for an element on the webpage. We&#39;ll crop the image to this specific element. For example: `section#complete-toolkit.container-lg`</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:ms_delay</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>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.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:device_scale</span>
-          <span class="type">(<tt>Double</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>This adjusts the pixel ratio for the screenshot. Minimum: `1`, Maximum: `3`.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:render_when_ready</span>
-          <span class="type">(<tt>Boolean</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Set to true to control when the image is generated. Call `ScreenshotReady()` from JavaScript to generate the image. [Learn more](<a href="https://docs.htmlcsstoimage.com/guides/render-when-ready">docs.htmlcsstoimage.com/guides/render-when-ready</a>/).</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:viewport_width</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Set the width of Chrome&#39;s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:viewport_height</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Set the height of Chrome&#39;s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.</p>
-</div>
-        </li>
-    </ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="HTMLCSSToImage/ApiResponse.html" title="HTMLCSSToImage::ApiResponse (class)">HTMLCSSToImage::ApiResponse</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>image URL available at `.url`.</p>
-</div>
-    </li>
-</ul>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><a href="https://docs.htmlcsstoimage.com/getting-started/using-the-api" target="_parent" title="https://docs.htmlcsstoimage.com/getting-started/using-the-api">https://docs.htmlcsstoimage.com/getting-started/using-the-api</a></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-56
-57
-58
-59
-60
-61</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 56</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_create_image'>create_image</span><span class='lparen'>(</span><span class='id identifier rubyid_html'>html</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>html:</span> <span class='id identifier rubyid_html'>html</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
-  <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>basic_auth:</span> <span class='ivar'>@auth</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span> <span class='label'>includeId:</span> <span class='kw'>true</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
-  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v1/image</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="create_image_from_template-instance_method">
-    #<strong>create_image_from_template</strong>(template_id, template_values = {}, params = {})  &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>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.</p>
-<p>Does not make any network requests.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>template_id</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The ID for the template</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>template_values</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>A hash containing the values to replace in the template</p>
-</div>
-    </li>
-</ul>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><a href="https://docs.htmlcsstoimage.com/getting-started/using-the-api" target="_parent" title="https://docs.htmlcsstoimage.com/getting-started/using-the-api">https://docs.htmlcsstoimage.com/getting-started/using-the-api</a></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-86
-87
-88
-89
-90
-91
-92
-93
-94
-95
-96
-97
-98
-99
-100
-101</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 86</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_create_image_from_template'>create_image_from_template</span><span class='lparen'>(</span><span class='id identifier rubyid_template_id'>template_id</span><span class='comma'>,</span> <span class='id identifier rubyid_template_values'>template_values</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_template'>template</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#SIGNED_URL_TEMPLATE-constant" title="HTMLCSSToImage::SIGNED_URL_TEMPLATE (constant)">SIGNED_URL_TEMPLATE</a></span></span><span class='period'>.</span><span class='id identifier rubyid_partial_expand'>partial_expand</span><span class='lparen'>(</span><span class='lbrace'>{</span>
-    <span class='label'>template_id:</span> <span class='id identifier rubyid_template_id'>template_id</span><span class='comma'>,</span>
-    <span class='label'>query:</span> <span class='id identifier rubyid_template_values'>template_values</span>
-  <span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'>Addressable</span><span class='op'>::</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_template'>template</span><span class='period'>.</span><span class='id identifier rubyid_generate'>generate</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_query'>query</span>
-  <span class='id identifier rubyid_digest'>digest</span> <span class='op'>=</span> <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>Digest</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sha256</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_signed_token'>signed_token</span> <span class='op'>=</span> <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>HMAC</span><span class='period'>.</span><span class='id identifier rubyid_hexdigest'>hexdigest</span><span class='lparen'>(</span><span class='id identifier rubyid_digest'>digest</span><span class='comma'>,</span> <span class='ivar'>@auth</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>CGI</span><span class='period'>.</span><span class='id identifier rubyid_unescape'>unescape</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='id identifier rubyid_template'>template</span><span class='period'>.</span><span class='id identifier rubyid_expand'>expand</span><span class='lparen'>(</span><span class='lbrace'>{</span>
-    <span class='label'>signed_token:</span> <span class='id identifier rubyid_signed_token'>signed_token</span>
-  <span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
-  <span class='const'><span class='object_link'><a href="HTMLCSSToImage/ApiResponse.html" title="HTMLCSSToImage::ApiResponse (class)">ApiResponse</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="HTMLCSSToImage#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="create_template-instance_method">
-    #<strong>create_template</strong>(html, params = {})  &#x21d2; <tt><span class='object_link'><a href="HTMLCSSToImage/ApiResponse.html" title="HTMLCSSToImage::ApiResponse (class)">HTMLCSSToImage::ApiResponse</a></span></tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Creates an image template</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>html</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>This is the HTML you want to render. You can send an HTML snippet (`&lt;div&gt;Your content&lt;/div&gt;`) or an entire webpage.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>params</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>a customizable set of options</p>
-</div>
-    </li>
-</ul>
-    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
-    <ul class="option">
-        <li>
-          <span class="name">:name</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>A short name to identify your template max length 64</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:description</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Description to elaborate on the use of your template max length 1024</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:css</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>The CSS for your image.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:google_fonts</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>[Google fonts](<a href="https://docs.htmlcsstoimage.com/guides/using-google-fonts">docs.htmlcsstoimage.com/guides/using-google-fonts</a>/) to be loaded. Example: `Roboto`. Multiple fonts can be loaded like this: `Roboto|Open Sans`</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:selector</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>A CSS selector for an element on the webpage. We&#39;ll crop the image to this specific element. For example: `section#complete-toolkit.container-lg`</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:ms_delay</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>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.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:device_scale</span>
-          <span class="type">(<tt>Double</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>This adjusts the pixel ratio for the screenshot. Minimum: `1`, Maximum: `3`.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:render_when_ready</span>
-          <span class="type">(<tt>Boolean</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Set to true to control when the image is generated. Call `ScreenshotReady()` from JavaScript to generate the image. [Learn more](<a href="https://docs.htmlcsstoimage.com/guides/render-when-ready">docs.htmlcsstoimage.com/guides/render-when-ready</a>/).</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:viewport_width</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Set the width of Chrome&#39;s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:viewport_height</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Set the height of Chrome&#39;s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.</p>
-</div>
-        </li>
-    </ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="HTMLCSSToImage/ApiResponse.html" title="HTMLCSSToImage::ApiResponse (class)">HTMLCSSToImage::ApiResponse</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>image URL available at `.url`.</p>
-</div>
-    </li>
-</ul>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><a href="https://docs.htmlcsstoimage.com/getting-started/templates/" target="_parent" title="https://docs.htmlcsstoimage.com/getting-started/templates/">https://docs.htmlcsstoimage.com/getting-started/templates/</a></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-147
-148
-149
-150
-151
-152</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 147</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_create_template'>create_template</span><span class='lparen'>(</span><span class='id identifier rubyid_html'>html</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>html:</span> <span class='id identifier rubyid_html'>html</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
-  <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>basic_auth:</span> <span class='ivar'>@auth</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span> <span class='rbrace'>}</span>
-  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v1/template</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="delete_image-instance_method">
-    #<strong>delete_image</strong>(image_id)  &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Deletes an image</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>image_id</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The ID for the image you would like to delete</p>
-</div>
-    </li>
-</ul>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><a href="https://docs.htmlcsstoimage.com/getting-started/using-the-api" target="_parent" title="https://docs.htmlcsstoimage.com/getting-started/using-the-api">https://docs.htmlcsstoimage.com/getting-started/using-the-api</a></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-68
-69
-70
-71
-72
-73
-74</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 68</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_delete_image'>delete_image</span><span class='lparen'>(</span><span class='id identifier rubyid_image_id'>image_id</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v1/image/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_image_id'>image_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>basic_auth:</span> <span class='ivar'>@auth</span><span class='rparen'>)</span>
-  <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
-  <span class='id identifier rubyid_response'>response</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="templates-instance_method">
-    #<strong>templates</strong>(params = {})  &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Retrieves all available templates</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><a href="https://docs.htmlcsstoimage.com/getting-started/templates/" target="_parent" title="https://docs.htmlcsstoimage.com/getting-started/templates/">https://docs.htmlcsstoimage.com/getting-started/templates/</a></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-124
-125
-126
-127</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 124</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_templates'>templates</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>basic_auth:</span> <span class='ivar'>@auth</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v1/template</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="url_to_image-instance_method">
-    #<strong>url_to_image</strong>(url, params = {})  &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Generate a screenshot of a URL</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>url</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The fully qualified URL to a public webpage. Such as <a href="https://htmlcsstoimage.com">htmlcsstoimage.com</a>.</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>params</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>a customizable set of options</p>
-</div>
-    </li>
-</ul>
-    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
-    <ul class="option">
-        <li>
-          <span class="name">:selector</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>A CSS selector for an element on the webpage. We&#39;ll crop the image to this specific element. For example: `section#complete-toolkit.container-lg`</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:ms_delay</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>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.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:device_scale</span>
-          <span class="type">(<tt>Double</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>This adjusts the pixel ratio for the screenshot. Minimum: `1`, Maximum: `3`.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:render_when_ready</span>
-          <span class="type">(<tt>Boolean</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Set to true to control when the image is generated. Call `ScreenshotReady()` from JavaScript to generate the image. [Learn more](<a href="https://docs.htmlcsstoimage.com/guides/render-when-ready">docs.htmlcsstoimage.com/guides/render-when-ready</a>/).</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:viewport_width</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Set the width of Chrome&#39;s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:viewport_height</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Set the height of Chrome&#39;s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.</p>
-</div>
-        </li>
-    </ul>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><a href="https://docs.htmlcsstoimage.com/getting-started/url-to-image/" target="_parent" title="https://docs.htmlcsstoimage.com/getting-started/url-to-image/">https://docs.htmlcsstoimage.com/getting-started/url-to-image/</a></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-114
-115
-116
-117
-118
-119</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/htmlcsstoimage.rb', line 114</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_url_to_image'>url_to_image</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
-  <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>basic_auth:</span> <span class='ivar'>@auth</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span> <span class='label'>includeId:</span> <span class='kw'>true</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
-  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v1/image</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Fri Aug  7 13:04:07 2020 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.25 (ruby-2.6.5).
-</div>
-    </div>
-  </body>
-</html>