eclaircir 0.0.3

data/spec/eclaircir/client_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe Eclaircir::Client do
+  subject do
+    described_class.new(api_key)
+  end
+
+  let(:api_key) do
+    'xxx'
+  end
+
+  describe '#models' do
+    before do
+      stub_request(:get, 'https://api.clarifai.com/v2/models')
+        .with(headers: {
+          'Content-Type' => 'application/json',
+          'Authorization' => 'Key xxx',
+        })
+    end
+
+    it 'uses the right authorization header' do
+      expect do
+        subject.models
+      end.not_to raise_error
+    end
+  end
+
+  describe '#predict_outputs' do
+    before do
+      stub_request(:post, 'https://api.clarifai.com/v2/models/blah/outputs')
+        .with(
+          headers: {
+            'Content-Type' => 'application/json',
+            'Authorization' => 'Key xxx',
+          },
+          body: {
+            'inputs' => [
+              {
+                'data' => {
+                  'image' => {
+                    'url' => 'http://example.com/lol.jpg'
+                  },
+                  'concepts' => []
+                }
+              }
+            ]
+          }.to_json)
+        .to_return(status: status, body: body)
+    end
+
+    let(:predicted_outputs) do
+      subject.predict_outputs(model, input)
+    end
+
+    let(:model) do
+      build(:model, id: 'blah')
+    end
+
+    let(:input) do
+      Eclaircir::Input.new(
+        data: Eclaircir::Data.new(
+          image: Eclaircir::Media.new(
+            url: 'http://example.com/lol.jpg')))
+    end
+
+    context 'when the status code is 2xx' do
+      let(:status) do
+        201
+      end
+
+      let(:body) do
+        load_fixture('predict_outputs/success.json')
+      end
+
+      before do
+        allow(Eclaircir::Response)
+          .to receive(:parse)
+          .with(JSON.parse(body))
+          .and_return(fake_response)
+
+        allow(Eclaircir::Client::StatusValidator)
+          .to receive(:new)
+          .with(fake_response)
+          .and_return(status_validator)
+      end
+
+      let(:fake_response) do
+        instance_double(Eclaircir::Response)
+      end
+
+      let(:status_validator) do
+        instance_double(Eclaircir::Client::StatusValidator,
+          validate!: true)
+      end
+
+      it 'returns a parsed response' do
+        expect(predicted_outputs).to be fake_response
+      end
+
+      it 'delegates the response to the status validator' do
+        expect(status_validator).to receive(:validate!)
+
+        predicted_outputs
+      end
+    end
+
+    context 'when the status code is not 2xx' do
+      let(:status) do
+        400
+      end
+
+      let(:body) do
+        load_fixture('predict_outputs/invalid_request.json')
+      end
+
+      it 'raises a Eclaircir::APIError with the status message' do
+        expect do
+          predicted_outputs
+        end.to raise_error(Eclaircir::APIError, /Invalid request/)
+      end
+    end
+  end
+end

data/spec/eclaircir/configuration_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Eclaircir::Configuration do
+  subject do
+    described_class.new(params)
+  end
+
+  let(:params) do
+    {
+      env: env,
+      api_key: api_key,
+    }
+  end
+
+  let(:env) do
+    {}
+  end
+
+  let(:api_key) do
+    'xyzzy'
+  end
+
+  describe '#api_key' do
+    context 'when the api_key is provided explicitely' do
+      it 'returns provided api_key' do
+        expect(subject.api_key).to eq 'xyzzy'
+      end
+    end
+
+    context 'when the api_key is not provided explicitely' do
+      let(:api_key) do
+        nil
+      end
+
+      context 'when the CLARIFIER_API_KEY env var is provided' do
+        let(:env) do
+          {
+            'CLARIFIER_API_KEY' => 'xxx'
+          }
+        end
+
+        it 'returns the CLARIFIER_API_KEY env var value' do
+          expect(subject.api_key).to eq 'xxx'
+        end
+      end
+
+      context 'when the CLARIFIER_API_KEY env var is not provided' do
+        its(:api_key) { is_expected.to be_nil }
+      end
+    end
+  end
+
+  describe '#api_key=' do
+    it 'changes the api_key' do
+      expect { subject.api_key = 'yoloswag' }.to change { subject.api_key }
+    end
+
+    it 'sets the right value' do
+      subject.api_key = 'yoloswag'
+
+      expect(subject.api_key).to eq 'yoloswag'
+    end
+  end
+end

data/spec/eclaircir_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Eclaircir do
+  describe '.configuration' do
+    it 'returns a new configuration' do
+      expect(described_class.configuration).to be_a Eclaircir::Configuration
+    end
+  end
+
+  describe '.configure' do
+    before do
+      allow(described_class)
+        .to receive(:configuration)
+        .and_return(fake_configuration)
+    end
+
+    let(:fake_configuration) do
+      instance_double(Eclaircir::Configuration)
+    end
+
+    it 'yields the configuration' do
+      expect do |b|
+        described_class.configure(&b)
+      end.to yield_with_args(fake_configuration)
+    end
+  end
+
+  describe '.new_client' do
+    before do
+      allow(described_class)
+        .to receive(:configuration)
+        .and_return(fake_configuration)
+    end
+
+    let(:fake_configuration) do
+      instance_double(Eclaircir::Configuration,
+        api_key: 'xxx')
+    end
+
+    before do
+      expect(Eclaircir::Client)
+        .to receive(:new)
+        .with('xxx')
+        .and_return(fake_client)
+    end
+
+    let(:fake_client) do
+      instance_double(Eclaircir::Client)
+    end
+
+    it 'builds and returns the client correctly' do
+      expect(described_class.new_client).to be fake_client
+    end
+  end
+end

data/spec/etc/fixtures/predict_outputs/invalid_request.json

@@ -0,0 +1,7 @@
+{
+  "status": {
+    "code": 11102,
+    "description": "Invalid request",
+    "details": "Malformed or invalid request"
+  }
+}

data/spec/etc/fixtures/predict_outputs/success.json

@@ -0,0 +1,58 @@
+{
+  "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": null,
+        "output_info": {
+          "message": "Show output_info with: GET /models/{model_id}/output_info",
+          "type": "concept"
+        },
+        "model_version": {
+          "id": "aa9ca48295b37401f8af92ad1af0d91d",
+          "created_at": "2016-07-13T01:19:12Z",
+          "status": {
+            "code": 21100,
+            "description": "Model trained successfully"
+          }
+        }
+      },
+      "input": {
+        "id": "ea68cac87c304b28a8046557062f34a0",
+        "data": {
+          "image": {
+            "url": "https://samples.clarifai.com/metro-north.jpg"
+          }
+        }
+      },
+      "data": {
+        "concepts": [
+          {
+            "id": "ai_HLmqFqBf",
+            "name": "train",
+            "app_id": null,
+            "value": 0.9989112
+          },
+          {
+            "id": "ai_fvlBqXZR",
+            "name": "railway",
+            "app_id": null,
+            "value": 0.9975532
+          }
+        ]
+      }
+    }
+  ]
+}

data/spec/factories/concept.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :concept, class: Eclaircir::Concept do
+    id { Faker::Base.regexify(%r/ai_[A-z0-9]{8}/) }
+    name { Faker::Food.ingredient }
+    value { rand(0.4..1.0).round(7) }
+    initialize_with { Eclaircir::Concept.new(attributes) }
+  end
+end

data/spec/factories/data.rb

@@ -0,0 +1,13 @@
+FactoryBot.define do
+  factory :data, class: Eclaircir::Data do
+    trait :image do
+      image { build(:media) }
+    end
+
+    trait :with_concepts do
+      concepts { build_list(:concept, 3) }
+    end
+
+    initialize_with { Eclaircir::Data.new(attributes) }
+  end
+end

data/spec/factories/input.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :input, class: Eclaircir::Input do
+    id { Faker::Base.regexify(%r/[a-f0-9]{32}/) }
+    data { build(:data, :image) }
+    initialize_with { Eclaircir::Input.new(attributes) }
+  end
+end

data/spec/factories/media.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :media, class: Eclaircir::Media do
+    url { Faker::Internet.url }
+    initialize_with { Eclaircir::Media.new(attributes) }
+  end
+end

data/spec/factories/model.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :model, class: Eclaircir::Model do
+    id { Faker::Base.regexify(%r/[a-f0-9]{32}/) }
+    name { Faker::Food.ingredient }
+    created_at { DateTime.now }
+    app_id nil
+    initialize_with { Eclaircir::Model.new(attributes) }
+  end
+end

data/spec/factories/response.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :response, class: Eclaircir::Response do
+    status { build(:status) }
+    outputs { build_list(:output, 1) }
+    initialize_with { Eclaircir::Response.new(attributes) }
+  end
+end

data/spec/factories/status.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :status, class: Eclaircir::Status do
+    code { rand(10_000..20_000) }
+    description { Faker::Lorem.sentence }
+    initialize_with { Eclaircir::Status.new(attributes) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'dotenv'
+Dotenv.load
+
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter ENV['GEM_HOME'] if ENV.fetch('GEM_HOME', '').include?('bundle')
+  add_filter 'spec/support'
+  add_filter '.bundle'
+  add_group 'Library', 'lib'
+  add_group 'Specs', 'spec'
+end
+
+require 'eclaircir'
+require 'pp'
+require 'byebug'
+require 'rspec'
+require 'rspec/its'
+require 'webmock/rspec'
+require 'factory_bot'
+require 'faker'
+
+Dir["./spec/factories/**/*.rb"].sort.each do |factory|
+  require factory
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.include FactoryBot::Syntax::Methods
+end
+
+def load_fixture(fixture_path)
+  complete_path = File.join(
+    File.dirname(__FILE__),
+    'etc',
+    'fixtures',
+    fixture_path)
+
+  File.read(complete_path)
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: eclaircir
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Karim Bogtob
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby Clarifai API wrapper that aims to be complete, tested and covered
+email: kabogtob@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/test.rb
+- eclaircir.gemspec
+- lib/eclaircir.rb
+- lib/eclaircir/api_models.rb
+- lib/eclaircir/api_models/attributes.rb
+- lib/eclaircir/api_models/attributes/nullable_date_time.rb
+- lib/eclaircir/api_models/base_model.rb
+- lib/eclaircir/api_models/concept.rb
+- lib/eclaircir/api_models/data.rb
+- lib/eclaircir/api_models/input.rb
+- lib/eclaircir/api_models/media.rb
+- lib/eclaircir/api_models/model.rb
+- lib/eclaircir/api_models/output.rb
+- lib/eclaircir/api_models/response.rb
+- lib/eclaircir/api_models/status.rb
+- lib/eclaircir/client.rb
+- lib/eclaircir/client/status_validator.rb
+- lib/eclaircir/configuration.rb
+- lib/eclaircir/constants.rb
+- lib/eclaircir/error.rb
+- lib/eclaircir/version.rb
+- spec/eclaircir/api_models/concept_spec.rb
+- spec/eclaircir/api_models/data_spec.rb
+- spec/eclaircir/api_models/input_spec.rb
+- spec/eclaircir/api_models/media_spec.rb
+- spec/eclaircir/api_models/model_spec.rb
+- spec/eclaircir/api_models/output_spec.rb
+- spec/eclaircir/api_models/response_spec.rb
+- spec/eclaircir/api_models/status_spec.rb
+- spec/eclaircir/client/status_validator_spec.rb
+- spec/eclaircir/client_spec.rb
+- spec/eclaircir/configuration_spec.rb
+- spec/eclaircir_spec.rb
+- spec/etc/fixtures/predict_outputs/invalid_request.json
+- spec/etc/fixtures/predict_outputs/success.json
+- spec/factories/concept.rb
+- spec/factories/data.rb
+- spec/factories/input.rb
+- spec/factories/media.rb
+- spec/factories/model.rb
+- spec/factories/response.rb
+- spec/factories/status.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kbogtob/eclaircir
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.3
+signing_key: 
+specification_version: 4
+summary: Clarifai APIv2 Client
+test_files: []