Cloudsight Elixir

Simple Elixir wrapper for the Cloudsight Api.

Installation

If available in Hex, the package can be installed by adding cloudsight_elixir to your list of dependencies in mix.exs:

def deps do
  [
    {:cloudsight_elixir, "~> 0.3.0"}
  ]
end

Examples

First create a client with your API Key from Cloudsight.

Image API

# Create client with your api key
iex()> client = CloudsightElixir.Client.new("your_api_key")
%CloudsightElixir.Client{api_key: "your_api_key", endpoint: "https://api.cloudsight.ai"}

# Send an image to Cloudsight for identification
iex()> {:ok, resp} = CloudsightElixir.send_image(%{image: "./path/to/my/file.png", locale: "en"}, client)
{:ok,
 %{
   body: %{
     "status" => "not completed",
     "token": "dx23sdGD9YULEKy53BG",
     "url": "https://api.cloudsight.ai/uploads/image_request/image/10378/file.png"
   },
   status_code: 200
 }
}

# Or send an image that is hosted at a remote url
iex()> {:ok, resp} = CloudsightElixir.send(%{remote_image_url: "http://sample.com/husky.jpg", locale: "en"}, client)
{:ok,
 %{
   body: %{
     "status" => "not completed",
     "token": "dx23sdGD9YULEKy53BG",
     "url": "https://api.cloudsight.ai/uploads/image_request/image/10378/file.png"
   },
   status_code: 200
 }
}

# Note the token so you can retrieve it
iex()> token = resp.body["token"]
"dx23sdGD9YULEKy53BG"

# Check on the response - the image is usually identified in 5-10 seconds
iex()> {:ok, resp} = CloudsightElixir.retrieve_image(token, client)
{:ok,
 %{
   body: %{
     "name" => "Adult Siberian Husky",
     "status" => "completed",
     "token": "dx23sdGD9YULEKy53BG",
     "url": "https://api.cloudsight.ai/uploads/image_request/image/10378/file.png"
   },
   status_code: 200
 }
}

# Use CloudsightElixir.wait_for_image to poll for you until the response is ready - defaults to timing out after 20 seconds
iex()> {:ok, body} = CloudsightElixir.wait_for_image(token, client)
{:ok,
 %{
   body: %{
     "name" => "Adult Siberian Husky",
     "status" => "completed",
     "token": "dx23sdGD9YULEKy53BG",
     "url": "https://api.cloudsight.ai/uploads/image_request/image/10378/file.png"
   },
   status_code: 200
 }
}

# Requests with errors will still return with :ok but give a non 200 status_code and have an error in the body
{:ok, resp} = CloudsightElixir.send_image(%{remote_image_url: "http://sample.com/husky.jpg"}, client)
{:ok, %{body: %{"error" => %{"locale" => ["can't be blank"]}}, status_code: 422}}

# A timeout will return a tuple starting with :error
iex()> {:ok, body} = CloudsightElixir.wait_for_image(token, client)
{:error, :timeout}

Video API

You can also identify videos. The CloudSight API will split videos into scenes and return them as children to the parent response.

iex()> {:ok, resp} = CloudsightElixir.send_video(%{video"./path/to/my/file.mp4", locale: "en"}, client)
{:ok,
 %{
   body: %{
     "children" => [],
     "split_video" => true,
     "status" => "not completed",
     "token" => "p22Y62r4fcs1un9A",
     "url" => "https://assets.cloudsight.ai/uploads/video_request/p22Y62DPYxA/small.mp4"
   },
   status_code: 200
 }
}

# Retrieve or wait for the video in the same way as you do for images

token = resp.body["token"]

iex()> CloudsightElixir.wait_for_video(token, client)
{:ok,
 %{
   body: %{
     "children" => [
       %{
         "name" => "red and yellow Lego toy",
         "shot" => ["0.0333", "5.0"],
         "status" => "completed",
         "token" => "Qn6JrsdzIQNN5B-pp5UuyQ"
       }
     ],
     "split_video" => true,
     "status" => "completed",
     "token" => "p22Y62r4fcs1un9A",
     "url" => "https://assets.cloudsight.ai/uploads/video_request/p22Y62DPYxA/small.mp4"
   },
   status_code: 200
 }
}

OAuth1

We do support OAuth1 authentication as well as demonstrated below:

iex()> client = CloudsightElixir.OAuth1Client.new(%{consumer_key: "your_api_key", consumer_secret: "your_secret"})
  credentials: %OAuther.Credentials{
    consumer_key: "your_api_key",
    consumer_secret: "your_secret",
    method: :hmac_sha1,
    token: nil,
    token_secret: nil
  },
  endpoint: "https://api.cloudsight.ai"
}

iex()> {:ok, resp} = CloudsightElixir.send_image(%{image: "./path/to/my/file.png", locale: "en"}, client)
etc...