# 🗄️ FileStore

![Build](https://img.shields.io/travis/rzane/file_store/master?style=flat-square)
![Coverage](https://img.shields.io/coveralls/github/rzane/file_store/master?style=flat-square)
![Issues](https://img.shields.io/github/issues/rzane/file_store?style=flat-square)
![License](https://img.shields.io/hexpm/l/file_store?style=flat-square)
![Version](https://img.shields.io/hexpm/v/file_store?style=flat-square)

FileStore allows you to read, write, upload, download, and interact with files, regardless of where they are stored.

It includes adapters for the following storage backends:

  * [Disk](https://hexdocs.pm/file_store/FileStore.Adapters.Disk.html)
  * [S3](https://hexdocs.pm/file_store/FileStore.Adapters.S3.html)
  * [Memory](https://hexdocs.pm/file_store/FileStore.Adapters.Memory.html)
  * [Null](https://hexdocs.pm/file_store/FileStore.Adapters.Null.html)

> [__View the documentation__](https://hexdocs.pm/file_store)

## Installation

The package can be installed by adding `file_store` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [{:file_store, "~> 0.1.0"}]
end
```

## Usage

Configure a new store:

```elixir
iex> store = FileStore.new(
...>   adapter: FileStore.Adapters.Disk,
...>   storage_path: "/path/to/store/files",
...>   base_url: "http://example.com/files/"
...> )
%FileStore{...}
```

Write a file to the store:

```elixir
iex> FileStore.write(store, "foo", "hello world")
:ok
```

Read a file from the store:

```elixir
iex> FileStore.read(store, "foo")
{:ok, "hello world"}
```

Get information about a file in the store:

```elixir
iex> FileStore.stat("foo")
{:ok, %FileStore.Stat{key: "foo", ...}}
```

Upload a file to the store:

```elixir
iex> FileStore.upload(store, "/path/to/upload.txt", "bar")
:ok
```

Download a file in the store to disk:

```elixir
iex> FileStore.download(store, "bar", "/path/to/download.txt")
:ok
```

Get a URL for the file:

```elixir
iex> FileStore.get_public_url(store, "bar")
"http://example.com/files/bar"
```

Get a signed URL for the file:

```elixir
iex> FileStore.get_signed_url(store, "bar")
{:ok, "http://..."}
```

## Creating a store

You can also create a dedicated store in your application.

```elixir
defmodule MyApp.Storage do
  use FileStore.Config, otp_app: :my_app
end
```

You'll need to provide configuration for this module:

```elixir
config :my_app, MyApp.Storage,
  adapter: FileStore.Adapters.Null
```

Now, you can interact with your store more conveniently:

```elixir
iex> MyApp.Storage.write("foo", "hello world")
:ok

iex> MyApp.Storage.read("foo")
{:ok, "hello world"}
```