README.md

Imbo Connector

Allows interfacing with an Imbo installation using Elixir.

Installation

Add imbo_connector to your list of dependencies in mix.exs:

def deps do
  [
    {:imbo_connector, "~> 2.1.0"}
  ]
end

Next, add the following config to your config/config.exs:

config :imbo_connector,
  public_key: "PUBLIC_KEY",
  user: "USER",
  private_key: "PRIVATE_KEY",
  imbo_url: "LINK_TO_IMBO_INSTALL_ROOT"

Usage

ImboConnector.get_uploads
# => {:ok, %{images => [%{}]}

ImboConnector.upload("/path/to/image.jpg")
# => {:ok, %{}}

ImboConnector.delete("image_id")
# => {:ok, %{"imageIdentifier" => "image_id"}}

ImboConnector.construct_image_url("imageIdentifier")
# => "https://IMBO_INSTALLATION_URL/users/USER/images/IMAGE_IDENTIFIER?accessToken=ACCESS_TOKEN"

Examples

Uploading an image from a HTML form inn Phoenix:

defmodule MyApp.Util do

  def upload_imbo_image(file) do
    path = file.path

    with {:ok, body} <- ImboConnector.upload(path) do
      id = body["imageIdentifier"]

      ImboConnector.construct_image_url("id")
    end
  end
end

Configuring a custom type for using with Ecto.cast in for example a Phoenix project.

defmodule MyApp.Types.ImboImage do
  @behaviour Ecto.Type

  def type, do: String

  def cast(%Plug.Upload{} = file) do
    with image_url <- MyApp.Util.upload_imbo_image(file) do
      {:ok, image_url}
    end
  end

  def dump(x), do: {:ok, x}

  def load(x), do: Ecto.Type.load(:string, x)
end