Mirrors/Claper
1
0
Fork 0
mirror of https://github.com/ClaperCo/Claper.git synced 2026-02-24 12:09:59 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
b438403f36a04f3830291454bbf4ffb69ae523f6
Claper/SimpleS3Upload.html
alexlionco b438403f36 Deploying to gh-pages from @ ClaperCo/Claper@8499b1be59 🚀
2022-07-28 13:05:38 +00:00

224 lines
9.6 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.28.4">
<meta name="project" content="Claper v1.0.0">
<title>SimpleS3Upload — Claper v1.0.0</title>
<link rel="stylesheet" href="dist/elixir-b6f1ed5df9b1d42a7309.css" />
<script src="dist/sidebar_items-51590e335a.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-bd1cb213813bf4825aa2.js"></script>
</head>
<body data-type="modules">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<section class="sidebar">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<a href="https://get.claper.co">
<img src="assets/logo.png" alt="Claper" class="sidebar-projectImage">
</a>
<div class="sidebar-projectDetails">
<a href="https://get.claper.co" class="sidebar-projectName" translate="no">
Claper
</a>
<strong class="sidebar-projectVersion" translate="no">
v1.0.0
</strong>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/utils/simple_s3_upload.ex#L1" title="View Source" class="view-source" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">SimpleS3Upload</span>
<small class="app-vsn" translate="no">(Claper v1.0.0)</small>
</h1>
<section id="moduledoc">
<p>Dependency-free S3 Form Upload using HTTP POST sigv4</p><p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-post-example.html">https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-post-example.html</a></p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#sign_form_upload/3" translate="no">sign_form_upload(config, bucket, opts)</a>
</div>
<div class="summary-synopsis"><p>Signs a form upload.</p></div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="functions-list">
<section class="detail" id="sign_form_upload/3">
<div class="detail-header">
<a href="#sign_form_upload/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">sign_form_upload(config, bucket, opts)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/utils/simple_s3_upload.ex#L45" class="view-source" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Signs a form upload.</p><p>The configuration is a map which must contain the following keys:</p><ul><li><code class="inline">:region</code> - The AWS region, such as &quot;us-east-1&quot;</li><li><code class="inline">:access_key_id</code> - The AWS access key id</li><li><code class="inline">:secret_access_key</code> - The AWS secret access key</li></ul><p>Returns a map of form fields to be used on the client via the JavaScript <code class="inline">FormData</code> API.</p><h2 id="sign_form_upload/3-options" class="section-heading">
<a href="#sign_form_upload/3-options" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">options</p>
</a>
Options
</h2>
<ul><li><code class="inline">:key</code> - The required key of the object to be uploaded.</li><li><code class="inline">:max_file_size</code> - The required maximum allowed file size in bytes.</li><li><code class="inline">:content_type</code> - The required MIME type of the file to be uploaded.</li><li><code class="inline">:expires_in</code> - The required expiration time in milliseconds from now
before the signed upload expires.</li></ul><h2 id="sign_form_upload/3-examples" class="section-heading">
<a href="#sign_form_upload/3-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">examples</p>
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="n">config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p" data-group-id="5211693598-1">%{</span><span class="w">
</span><span class="ss">region</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;us-east-1&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">access_key_id</span><span class="p">:</span><span class="w"> </span><span class="nc">System</span><span class="o">.</span><span class="n">fetch_env!</span><span class="p" data-group-id="5211693598-2">(</span><span class="s">&quot;AWS_ACCESS_KEY_ID&quot;</span><span class="p" data-group-id="5211693598-2">)</span><span class="p">,</span><span class="w">
</span><span class="ss">secret_access_key</span><span class="p">:</span><span class="w"> </span><span class="nc">System</span><span class="o">.</span><span class="n">fetch_env!</span><span class="p" data-group-id="5211693598-3">(</span><span class="s">&quot;AWS_SECRET_ACCESS_KEY&quot;</span><span class="p" data-group-id="5211693598-3">)</span><span class="w">
</span><span class="p" data-group-id="5211693598-1">}</span><span class="w">
</span><span class="p" data-group-id="5211693598-4">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">fields</span><span class="p" data-group-id="5211693598-4">}</span><span class="w"> </span><span class="o">=</span><span class="w">
</span><span class="nc">SimpleS3Upload</span><span class="o">.</span><span class="n">sign_form_upload</span><span class="p" data-group-id="5211693598-5">(</span><span class="n">config</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;my-bucket&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;public/my-file-name&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">content_type</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;image/png&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">max_file_size</span><span class="p">:</span><span class="w"> </span><span class="mi">10_000</span><span class="p">,</span><span class="w">
</span><span class="ss">expires_in</span><span class="p">:</span><span class="w"> </span><span class="nc">:timer</span><span class="o">.</span><span class="n">hours</span><span class="p" data-group-id="5211693598-6">(</span><span class="mi">1</span><span class="p" data-group-id="5211693598-6">)</span><span class="w">
</span><span class="p" data-group-id="5211693598-5">)</span></code></pre>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.28.4) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink