Rename everything from Upload to UploadOld

Author: JohnDoneth

README.md

@@ -1,192 +1,2 @@
-<h1 align="center">upload</h1>
-
-<div align="center">
-
-![Build](https://github.com/rzane/upload/workflows/Build/badge.svg)
-![Version](https://img.shields.io/hexpm/v/upload)
-![Coverage](https://img.shields.io/coveralls/github/rzane/upload)
-![License](https://img.shields.io/hexpm/l/upload)
-
-</div>
-
-An opinionated file uploader for Elixir projects.
-
-Upload offers the following features:
-
-- Minimal API
-- Reasonable defaults
-- Ecto integration
-- Multiple storage adapters
-
-## Installation
-
-The package can be installed by adding `upload` to your list of dependencies in `mix.exs`:
-
-```elixir
-def deps do
-  [
-    {:upload, "~> 0.3.0"}
-  ]
-end
-```
-
-## Usage
-
-Upload a file:
-
-```elixir
-{:ok, upload} = Upload.cast_path("/path/to/file.txt")
-```
-
-Transfer the upload to storage:
-
-```elixir
-{:ok, upload} = Upload.transfer(upload)
-```
-
-Get the URL for the upload:
-
-```elixir
-url = Upload.get_url(upload)
-```
-
-Get a signed URL for the upload:
-
-```elixir
-{:ok, signed_url} = Upload.get_signed_url(upload)
-```
-
-### Ecto Integration
-
-Add a column to store a logo:
-
-```elixir
-def change do
-  alter table(:companies) do
-    add :logo, :string
-  end
-end
-```
-
-Add a field to your schema:
-
-```elixir
-schema "companies" do
-  field :logo, :string
-end
-```
-
-Cast the upload in your changeset:
-
-```elixir
-def changeset(company, attrs \\ %{}) do
-  company
-  |> cast(attrs, [])
-  |> Upload.Ecto.cast_upload(:logo, prefix: ["logos"])
-end
-```
-
-Upload in the controller:
-
-```elixir
-def create(conn, %{"logo" => logo}) do
-  changeset = Company.changeset(%Company{}, %{"logo" => logo})
-
-  case Repo.insert(changeset) do
-    {:ok, company} ->
-      # Insert succeeded. Now, you can get the URL:
-      Upload.get_url(company.logo)
-
-    {:error, changeset} ->
-      # You know the drill.
-  end
-end
-```
-
-### Serving static files
-
-In order to serve the files, you'll need to setup `Plug.Static`.
-
-If you're using Phoenix, you can add this line to `endpoint.ex`:
-
-```elixir
-plug Plug.Static, at: "/", from: :your_app, gzip: false, only: ~w(uploads)
-```
-
-## Configuration
-
-For now, there are four adapters:
-
-- `Upload.Adapters.Local` - Save files to your local filesystem.
-- `Upload.Adapters.S3` - Save files to Amazon S3.
-- `Upload.Adapters.Fake` - Don't actually save the files at all.
-- `Upload.Adapters.Test` - Keep uploaded files in state, so that you can assert.
-
-### `Upload.Adapters.Local`
-
-Out of the box, `Upload` is ready to go with some sane defaults (for development, at least).
-
-Here are the default values:
-
-```elixir
-config :upload, Upload,
-  adapter: Upload.Adapters.Local
-
-config :upload, Upload.Adapters.Local,
-  storage_path: "priv/static/uploads",
-  public_path: "/uploads"
-```
-
-### `Upload.Adapters.S3`
-
-To use the AWS adapter, you'll to install [ExAws](https://github.com/ex-aws/ex_aws).
-
-Then, you'll need to following configuration:
-
-```elixir
-config :upload, Upload, adapter: Upload.Adapters.S3
-config :upload, Upload.Adapters.S3, bucket: "your_bucket_name"
-```
-
-### `Upload.Adapters.Test`
-
-To use this adapter, you'll need to the following configuration:
-
-```elixir
-config :upload, Upload, adapter: Upload.Adapters.Test
-```
-
-In your tests, you can make assertions:
-
-```elixir
-test "files are uploaded" do
-  assert {:ok, _} = start_supervised(Upload.Adapters.Test)
-  assert {:ok, upload} = Upload.cast_path("/path/to/file.txt")
-  assert {:ok, upload} = Upload.transfer(upload)
-  assert map_size(Upload.Adapters.Test.get_uploads()) == 1
-end
-```
-
-### `Upload.Adapters.Fake`
-
-This adapter does pretty much nothing. It makes absolutely no attempt to persist uploads. This can be useful in unit tests where you want to completely bypass uploading.
-
-To use this adapter, you'll need the following configuration:
-
-```elixir
-config :upload, Upload, adapter: Upload.Adapters.Fake
-```
-
-## Contributing
-
-First, install the dependencies:
-
-    $ mix deps.get
-
-The tests depend on a "fake" Amazon S3 running locally. If you have Docker installed, you can run:
-
-    $ bin/fake-s3
-
-Then, you can run the test suite:
-
-    $ mix test
+Version locked version of the Upload library renamed to UploadOld so we can use
+the new and old versions of the library at the same time.

config/config.exs

@@ -2,8 +2,8 @@
 # and its dependencies with the aid of the Mix.Config module.
 use Mix.Config
 
-config :upload, Upload, adapter: Upload.Adapters.Test
-config :upload, Upload.Adapters.S3, bucket: "my_bucket_name"
+config :upload, UploadOld, adapter: UploadOld.Adapters.Test
+config :upload, UploadOld.Adapters.S3, bucket: "my_bucket_name"
 
 # Configuration For AWS
 config :ex_aws,

lib/upload.ex

@@ -1,18 +1,18 @@
-defmodule Upload do
+defmodule UploadOld do
   @moduledoc """
   An opinionated file uploader.
   """
 
   @enforce_keys [:key, :path, :filename]
   defstruct [:key, :path, :filename, status: :pending]
 
-  @type t :: %Upload{
+  @type t :: %UploadOld{
           key: String.t(),
           filename: String.t(),
           path: String.t()
         }
 
-  @type transferred :: %Upload{
+  @type transferred :: %UploadOld{
           key: String.t(),
           filename: String.t(),
           path: String.t(),
@@ -26,7 +26,7 @@ defmodule Upload do
   Get the adapter from config.
   """
   def adapter do
-    Upload.Config.get(__MODULE__, :adapter, Upload.Adapters.Local)
+    UploadOld.Config.get(__MODULE__, :adapter, UploadOld.Adapters.Local)
   end
 
   @doc """
@@ -35,21 +35,21 @@ defmodule Upload do
 
   ### Local
 
-      iex> Upload.get_url("123456.png")
-      "/uploads/123456.png"
+      iex> UploadOld.get_url("123456.png")
+      "/UploadOlds/123456.png"
 
   ### S3
 
-      iex> Upload.get_url("123456.png")
+      iex> UploadOld.get_url("123456.png")
       "https://my_bucket_name.s3.amazonaws.com/123456.png"
 
   ### Fake / Test
 
-      iex> Upload.get_url("123456.png")
+      iex> UploadOld.get_url("123456.png")
       "123456.png"
 
   """
-  @spec get_url(Upload.t() | String.t()) :: String.t()
+  @spec get_url(UploadOld.t() | String.t()) :: String.t()
   def get_url(%__MODULE__{key: key}), do: get_url(key)
   def get_url(key) when is_binary(key), do: adapter().get_url(key)
 
@@ -59,14 +59,14 @@ defmodule Upload do
 
   ### Examples
 
-      iex> Upload.get_signed_url("123456.png")
+      iex> UploadOld.get_signed_url("123456.png")
       {:ok, "http://yoururl.com/123456.png?X-Amz-Expires=3600..."}
 
-      iex> Upload.get_signed_url("123456.png", expires_in: 4200)
+      iex> UploadOld.get_signed_url("123456.png", expires_in: 4200)
       {:ok, "http://yoururl.com/123456.png?X-Amz-Expires=4200..."}
 
   """
-  @spec get_signed_url(Upload.t() | String.t(), Keyword.t()) ::
+  @spec get_signed_url(UploadOld.t() | String.t(), Keyword.t()) ::
           {:ok, String.t()} | {:error, String.t()}
   def get_signed_url(upload, opts \\ [])
   def get_signed_url(%__MODULE__{key: key}, opts), do: get_signed_url(key, opts)
@@ -75,7 +75,7 @@ defmodule Upload do
   @doc """
   Transfer the file to where it will be stored.
   """
-  @spec transfer(Upload.t()) :: {:ok, Upload.transferred()} | {:error, String.t()}
+  @spec transfer(UploadOld.t()) :: {:ok, UploadOld.transferred()} | {:error, String.t()}
   def transfer(%__MODULE__{} = upload), do: adapter().transfer(upload)
 
   @doc """
@@ -89,16 +89,16 @@ defmodule Upload do
 
   ## Examples
 
-      iex> Upload.cast(%Plug.Upload{path: "/path/to/foo.png", filename: "foo.png"})
-      {:ok, %Upload{path: "/path/to/foo.png", filename: "foo.png", key: "123456.png"}}
+      iex> UploadOld.cast(%Plug.Upload{path: "/path/to/foo.png", filename: "foo.png"})
+      {:ok, %UploadOld{path: "/path/to/foo.png", filename: "foo.png", key: "123456.png"}}
 
-      iex> Upload.cast(100)
+      iex> UploadOld.cast(100)
       :error
 
   """
-  @spec cast(uploadable, list) :: {:ok, Upload.t()} | :error
+  @spec cast(uploadable, list) :: {:ok, UploadOld.t()} | :error
   def cast(uploadable, opts \\ [])
-  def cast(%Upload{} = upload, _opts), do: {:ok, upload}
+  def cast(%UploadOld{} = upload, _opts), do: {:ok, upload}
 
   def cast(%Plug.Upload{filename: filename, path: path}, opts) do
     do_cast(filename, path, opts)
@@ -124,7 +124,7 @@ defmodule Upload do
   """
   @spec cast_path(uploadable_path, list) :: {:ok, Upload.t()} | :error
   def cast_path(path, opts \\ [])
-  def cast_path(%Upload{} = upload, _opts), do: {:ok, upload}
+  def cast_path(%UploadOld{} = upload, _opts), do: {:ok, upload}
 
   def cast_path(path, opts) when is_binary(path) do
     path
@@ -184,22 +184,22 @@ defmodule Upload do
 
   ## Examples
 
-      iex> Upload.get_extension("foo.png")
+      iex> UploadOld.get_extension("foo.png")
       ".png"
 
-      iex> Upload.get_extension("foo.PNG")
+      iex> UploadOld.get_extension("foo.PNG")
       ".png"
 
-      iex> Upload.get_extension("foo")
+      iex> UploadOld.get_extension("foo")
       ""
 
-      iex> {:ok, upload} = Upload.cast_path("/path/to/foo.png")
-      ...> Upload.get_extension(upload)
+      iex> {:ok, upload} = UploadOld.cast_path("/path/to/foo.png")
+      ...> UploadOld.get_extension(upload)
       ".png"
 
   """
-  @spec get_extension(String.t() | Upload.t()) :: String.t()
-  def get_extension(%Upload{filename: filename}) do
+  @spec get_extension(String.t() | UploadOld.t()) :: String.t()
+  def get_extension(%UploadOld{filename: filename}) do
     get_extension(filename)
   end