eclaircir 0.0.3

data/lib/eclaircir/error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Eclaircir
+  class Error < StandardError
+  end
+
+  class APIError < Error
+  end
+
+  class InvalidAuthTokenError < APIError
+  end
+
+  class ApiKeyNotFoundError < APIError
+  end
+
+  class BadRequestFormatError < APIError
+  end
+
+  class InvalidRequestError < APIError
+  end
+
+  class DuplicateURLError < APIError
+  end
+
+  class ImageDecodingError < APIError
+  end
+end

data/lib/eclaircir/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Eclaircir
+  VERSION = "0.0.3"
+end

data/lib/eclaircir.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require 'httparty'
+require 'virtus'
+require 'active_support/core_ext/hash/compact'
+
+module Eclaircir
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def new_client
+      Client.new(configuration.api_key)
+    end
+  end
+end
+
+require_relative 'eclaircir/version'
+require_relative 'eclaircir/constants'
+require_relative 'eclaircir/error'
+require_relative 'eclaircir/configuration'
+
+require_relative 'eclaircir/api_models'
+
+require_relative 'eclaircir/client'

data/spec/eclaircir/api_models/concept_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Eclaircir::Concept do
+  subject do
+    described_class.new(params)
+  end
+
+  let(:params) do
+    {
+      'id' => 'ai_HLmqFqBf',
+      'name' => 'train',
+      'app_id' => 'blah',
+      'value' => 0.9989112,
+    }
+  end
+
+  its(:id) { is_expected.to eq 'ai_HLmqFqBf' }
+  its(:name) { is_expected.to eq 'train' }
+  its(:app_id) { is_expected.to eq 'blah' }
+  its(:value) { is_expected.to eq 0.9989112 }
+
+  describe '#to_api_hash' do
+    it 'returns the right hash' do
+      expect(subject.to_api_hash).to eq({
+        id: 'ai_HLmqFqBf',
+        name: 'train',
+        app_id: 'blah',
+        value: 0.9989112,
+      })
+    end
+  end
+end

data/spec/eclaircir/api_models/data_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Eclaircir::Data do
+  subject do
+    described_class.new(params)
+  end
+
+  let(:params) do
+    {
+      'concepts' => concepts,
+      'image' => image,
+    }
+  end
+
+  let(:concepts) do
+    [
+      {
+        'id' => 'ai_HLmqFqBf',
+        'name' => 'train',
+        'app_id' => nil,
+        'value' => 0.9989112
+      },
+      {
+        'id' => 'ai_fvlBqXZR',
+        'name' => 'railway',
+        'app_id' => nil,
+        'value' => 0.9975532
+      }
+    ]
+  end
+
+  let(:image) do
+    {
+      'url' => 'https://samples.clarifai.com/metro-north.jpg',
+    }
+  end
+
+  its(:image) { is_expected.to be_a Eclaircir::Media }
+  its(:concepts) { is_expected.to all(be_a(Eclaircir::Concept)) }
+
+  describe '#to_api_hash' do
+    it 'returns the right hash' do
+      expect(subject.to_api_hash).to eq({
+        concepts: [
+          {
+            id: 'ai_HLmqFqBf',
+            name: 'train',
+            app_id: nil,
+            value: 0.9989112
+          },
+          {
+            id: 'ai_fvlBqXZR',
+            name: 'railway',
+            app_id: nil,
+            value: 0.9975532
+          }
+        ],
+        image: {
+          url: 'https://samples.clarifai.com/metro-north.jpg'
+        }
+      })
+    end
+
+    context 'when the image is not provided' do
+      let(:image) do
+        nil
+      end
+
+      it 'returns the right hash' do
+        expect(subject.to_api_hash).to eq({
+          concepts: [
+            {
+              id: "ai_HLmqFqBf",
+              name: "train",
+              app_id: nil,
+              value: 0.9989112
+            },
+            {
+              id: "ai_fvlBqXZR",
+              name: "railway",
+              app_id: nil,
+              value: 0.9975532
+            }
+          ]
+        })
+      end
+    end
+
+    context 'when the concepts are not provided' do
+      let(:concepts) do
+        nil
+      end
+
+      it 'returns the right hash' do
+        expect(subject.to_api_hash).to eq({
+          concepts: [],
+          image: {
+            url: 'https://samples.clarifai.com/metro-north.jpg'
+          }
+        })
+      end
+    end
+  end
+end

data/spec/eclaircir/api_models/input_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Eclaircir::Input do
+  subject do
+    described_class.new(params)
+  end
+
+  let(:params) do
+    {
+      'id' => 'ea68cac87c304b28a8046557062f34a0',
+      'data' => {
+        'image' => {
+        'url' => "https://samples.clarifai.com/metro-north.jpg",
+        },
+      },
+    }
+  end
+
+  its(:id) { is_expected.to eq 'ea68cac87c304b28a8046557062f34a0' }
+  its(:data) { is_expected.to be_a Eclaircir::Data }
+
+  describe '#to_api_hash' do
+    it 'returns the right hash' do
+      expect(subject.to_api_hash).to eq({
+        id: 'ea68cac87c304b28a8046557062f34a0',
+        data: {
+          image: {
+            url: 'https://samples.clarifai.com/metro-north.jpg'
+          },
+          concepts: []
+        }
+      })
+    end
+  end
+
+  describe '.from_url' do
+    before do
+      allow(described_class)
+        .to receive(:new)
+        .with(data: fake_data)
+        .and_return(fake_image)
+
+      allow(Eclaircir::Data)
+        .to receive(:new)
+        .with(image: fake_media)
+        .and_return(fake_data)
+
+      allow(Eclaircir::Media)
+        .to receive(:new)
+        .with(url: 'http://example.com/lol.jpg')
+        .and_return(fake_media)
+    end
+
+    let(:fake_image) do
+      instance_double(described_class)
+    end
+
+    let(:fake_data) do
+      instance_double(Eclaircir::Data)
+    end
+
+    let(:fake_media) do
+      instance_double(Eclaircir::Media)
+    end
+
+    it 'builds and returns an image with the right url' do
+      expect(described_class.from_url('http://example.com/lol.jpg')).to be fake_image
+    end
+  end
+end

data/spec/eclaircir/api_models/media_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Eclaircir::Media do
+  subject do
+    described_class.new(params)
+  end
+
+  let(:params) do
+    {
+      'url' => 'https://samples.clarifai.com/metro-north.jpg',
+    }
+  end
+
+  its(:url) { is_expected.to eq 'https://samples.clarifai.com/metro-north.jpg' }
+end

data/spec/eclaircir/api_models/model_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe Eclaircir::Model do
+  subject do
+    described_class.new(params)
+  end
+
+  let(:params) do
+    {
+      'id' => 'aaa03c23b3724a16a56b629203edc62c',
+      'name' => 'general-v1.3',
+      'created_at' => '2016-03-09T17:11:39Z',
+      'app_id' => 'blah',
+      'output_info' => output_info,
+      'model_version' => model_version
+    }
+  end
+
+  let(:output_info) do
+    {
+      'message' => 'Show output_info with: GET /models/{model_id}/output_info',
+      'type' => 'concept'
+    }
+  end
+
+  let(:model_version) do
+    {
+      'id' => 'aa9ca48295b37401f8af92ad1af0d91d',
+      'created_at' => '2016-07-13T01:19:12Z',
+      'status' => {
+        'code' => 21100,
+        'description' => 'Model trained successfully',
+      }
+    }
+  end
+
+  its(:id) { is_expected.to eq 'aaa03c23b3724a16a56b629203edc62c' }
+  its(:name) { is_expected.to eq 'general-v1.3' }
+  its(:created_at) { is_expected.to eq DateTime.new(2016, 3, 9, 17, 11, 39) }
+  its(:app_id) { is_expected.to eq 'blah' }
+  its(:output_info) { is_expected.to eq output_info }
+  its(:model_version) { is_expected.to eq model_version }
+
+  describe '#predict_outputs' do
+    before do
+      allow(Eclaircir)
+        .to receive(:new_client)
+        .and_return(fake_client)
+    end
+
+    let(:fake_client) do
+      instance_double(Eclaircir::Client)
+    end
+
+    context 'when using an url' do
+      before do
+        allow(Eclaircir::Input)
+          .to receive(:from_url)
+          .with('http://example.com/lol.jpg')
+          .and_return(fake_input)
+      end
+
+      let(:fake_input) do
+        instance_double(Eclaircir::Input)
+      end
+
+      let(:predicted_outputs) do
+        instance_double(Eclaircir::Response)
+      end
+
+      it 'asks the client correctly' do
+        expect(fake_client)
+          .to receive(:predict_outputs)
+          .with(subject, fake_input)
+          .and_return(predicted_outputs)
+
+        subject.predict_outputs(url: 'http://example.com/lol.jpg')
+      end
+    end
+
+    context 'when using an input directly' do
+      let(:fake_input) do
+        instance_double(Eclaircir::Input)
+      end
+
+      let(:predicted_outputs) do
+        instance_double(Eclaircir::Response)
+      end
+
+      it 'asks the client correctly' do
+        expect(fake_client)
+          .to receive(:predict_outputs)
+          .with(subject, fake_input)
+          .and_return(predicted_outputs)
+
+        subject.predict_outputs(input: fake_input)
+      end
+    end
+
+    context 'when using no parameter' do
+      it 'raises an ArgumentError' do
+        expect do
+          subject.predict_outputs
+        end.to raise_error(ArgumentError,
+          /one of the following keyword arguments should be provided \[url, input\]/)
+      end
+    end
+  end
+end

data/spec/eclaircir/api_models/output_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Eclaircir::Output do
+  subject do
+    described_class.new(params)
+  end
+
+  let(:params) do
+    {
+      'id' => 'ea68cac87c304b28a8046557062f34a0',
+      'status' => {
+        'code' => 10000,
+        'description' => 'Ok',
+      },
+      'created_at' => '2016-11-22T16:50:25Z',
+      'model' => {
+        'name' => 'general-v1.3',
+        'id' => 'aaa03c23b3724a16a56b629203edc62c',
+        'created_at' => '2016-03-09T17:11:39Z',
+        'app_id' => nil,
+        'output_info' => {},
+        'model_version' => {}
+      },
+      'input' => {
+        'id' => 'ea68cac87c304b28a8046557062f34a0',
+        'data' => {
+          'image' => {}
+        }
+      },
+      'data' => {
+        'concepts' => []
+      }
+    }
+  end
+
+  its(:id) { is_expected.to eq 'ea68cac87c304b28a8046557062f34a0' }
+  its(:status) { is_expected.to be_a Eclaircir::Status }
+  its(:created_at) { is_expected.to eq DateTime.new(2016, 11, 22, 16, 50, 25) }
+  its(:model) { is_expected.to be_a Eclaircir::Model }
+  its(:input) { is_expected.to be_a Eclaircir::Input }
+  its(:data) { is_expected.to be_a Eclaircir::Data }
+end

data/spec/eclaircir/api_models/response_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Eclaircir::Response do
+  subject do
+    described_class.new(params)
+  end
+
+  let(:params) do
+    {
+      'status' => {
+        'code' => 10000,
+        'description' => 'Ok',
+      },
+      'outputs' => [
+        {
+          'id' => 'ea68cac87c304b28a8046557062f34a0',
+          'status' => {
+            'code' => 10000,
+            'description' => 'Ok',
+          },
+          'created_at' => '2016-11-22T16:50:25Z',
+          'model' => {
+            'name' => 'general-v1.3',
+            'id' => 'aaa03c23b3724a16a56b629203edc62c',
+            'created_at' => '2016-03-09T17:11:39Z',
+            'app_id' => nil,
+            'output_info' => {},
+            'model_version' => {}
+          },
+          'input' => {
+            'id' => 'ea68cac87c304b28a8046557062f34a0',
+            'data' => {
+              'image' => {}
+            }
+          },
+          'data' => {
+            'concepts' => []
+          }
+        }
+      ]
+    }
+  end
+
+  its(:status) { is_expected.to be_a Eclaircir::Status }
+  its(:outputs) { is_expected.to all(be_a(Eclaircir::Output)) }
+
+  describe '.parse' do
+    before do
+      allow(described_class)
+        .to receive(:new)
+        .with(params)
+        .and_return(fake_response)
+    end
+
+    let(:fake_response) do
+      instance_double(described_class)
+    end
+
+    it 'returns the built response' do
+      expect(described_class.parse(params)).to be fake_response
+    end
+  end
+end

data/spec/eclaircir/api_models/status_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Eclaircir::Status do
+  subject do
+    described_class.new(params)
+  end
+
+  let(:params) do
+    {
+      'code' => code,
+      'description' => 'Ok',
+    }
+  end
+
+  let(:code) do
+    10_000
+  end
+
+  its(:code) { is_expected.to eq 10_000 }
+  its(:description) { is_expected.to eq 'Ok' }
+
+  describe '#success?' do
+    context 'when the code is Status::SUCCESS' do
+      its(:success?) { is_expected.to be true }
+    end
+
+    context 'when the code is not Status::SUCCESS' do
+      let(:code) do
+        10_020
+      end
+
+      its(:success?) { is_expected.to be false }
+    end
+  end
+
+  describe '#validate!' do
+    context 'when the code is Status::SUCCESS' do
+      it 'returns true' do
+        expect(subject.validate!).to be true
+      end
+    end
+
+    context 'when the code has a specific error' do
+      let(:code) do
+        30_300
+      end
+
+      it 'raises the specific error with the description' do
+        expect do
+          subject.validate!
+        end.to raise_error(Eclaircir::ImageDecodingError, /Ok/)
+      end
+    end
+
+    context 'when the code is not managed' do
+      let(:code) do
+        99_999
+      end
+
+      it 'raises an APIError' do
+        expect do
+          subject.validate!
+        end.to raise_error(Eclaircir::APIError, /Ok/)
+      end
+    end
+  end
+end

data/spec/eclaircir/client/status_validator_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Eclaircir::Client::StatusValidator do
+  subject do
+    described_class.new(response)
+  end
+
+  let(:response) do
+    instance_double(Eclaircir::Response,
+      status: main_status,
+      outputs: [output])
+  end
+
+  let(:main_status) do
+    instance_double(Eclaircir::Status,
+      success?: main_status_success)
+  end
+
+  let(:main_status_success) do
+    true
+  end
+
+  let(:output) do
+    instance_double(Eclaircir::Output,
+      status: output_status)
+  end
+
+  let(:output_status) do
+    instance_double(Eclaircir::Status)
+  end
+
+  describe '#validate!' do
+    context 'when the main status is successful' do
+      it 'returns true' do
+        expect(subject.validate!).to be true
+      end
+    end
+
+    context 'when the main status is not successful' do
+      let(:main_status_success) do
+        false
+      end
+
+      context 'when an output status is failed' do
+        before do
+          allow(output_status)
+            .to receive(:validate!)
+            .and_raise(Eclaircir::APIError, 'output status error')
+        end
+
+        it 'raises the output status validation error' do
+          expect do
+            subject.validate!
+          end.to raise_error(Eclaircir::APIError, /output status error/)
+        end
+      end
+
+      context 'when all output status validate' do
+        before do
+          allow(output_status)
+            .to receive(:validate!)
+            .and_return(true)
+
+          allow(main_status)
+            .to receive(:validate!)
+            .and_raise(Eclaircir::APIError, 'main status error')
+        end
+
+        it 'raises the main status validation error' do
+          expect do
+            subject.validate!
+          end.to raise_error(Eclaircir::APIError, /main status error/)
+        end
+      end
+    end
+  end
+end