datarobot-ai_api 0.0.3

data/test/datarobot/ai_api/test_ai.rb

@@ -0,0 +1,133 @@
+require 'test_helper'
+require_relative "test_page.rb"
+require_relative "test_refreshable.rb"
+
+describe "Datarobot::AiApi::AI" do
+  before do
+    @key = "testingKey"
+  end
+
+  it "is sane" do
+    Datarobot::AiApi::AI.new
+    # if we make it to here, nothing has exploded
+    assert true
+  end
+
+  describe "when authorized" do
+    before do
+      Datarobot::AiApi.configure!(api_key: @key)
+      @klass = Datarobot::AiApi::AI
+      @id = '5d322e625c142b15dff826fc'
+    end
+
+    it_behaves_like "a paginated resource"
+    it_behaves_like "a refreshable resource"
+
+    it "can list AIs", vcr: true do
+      ais = Datarobot::AiApi::AI.all
+      assert ais.is_a? Datarobot::AiApi::Page
+      assert_equal ais.length, 15
+      assert_includes(ais.map(&:name), "Bird classifier")
+    end
+
+    it "can find AIs", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d322e625c142b15dff826fc')
+      assert ai.is_a? Datarobot::AiApi::AI
+      assert_equal ai.name, "Bird classifier"
+    end
+
+    it "handles when the AI ID is nil" do
+      assert_raises Datarobot::AiApi::NotFoundError do
+        ai = Datarobot::AiApi::AI.find(nil)
+      end
+    end
+
+    it "can create AIs", vcr: true do
+      ai = Datarobot::AiApi::AI.create(name: 'a testing AI')
+      assert ai.is_a? Datarobot::AiApi::AI
+      assert_equal ai.name, "a testing AI"
+    end
+
+    it "can delete AIs", vcr: true do
+      ai = Datarobot::AiApi::AI.delete('5d5c72af42eabf0c8b66f2eb')
+      assert_nil ai
+    end
+
+    it "can get AI outputs", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d322e625c142b15dff826fc')
+      outputs = ai.outputs
+      assert outputs.is_a? Datarobot::AiApi::Page
+      assert_includes outputs.map(&:name), "class"
+    end
+
+    it "can get AI datasets", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d322e625c142b15dff826fc')
+      datasets = ai.datasets
+      assert datasets.length == ai.dataset_count
+      assert datasets.is_a? Datarobot::AiApi::Page
+      assert_includes datasets.map(&:name), "image_birds_multiclass_6x100.csv"
+    end
+
+    it "can add datasets to AIs", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d322e625c142b15dff826fc')
+      was_added = ai.add_dataset('5d5d914e42eabf0f1166f29f')
+      assert was_added
+    end
+
+    it "can add learning sessions to AIs", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d322e625c142b15dff826fc')
+      was_added = ai.add_learning_session('5d41de29d8c81f0587732a4f')
+      assert was_added
+    end
+
+    it "404s if there is no matching output", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d4205d6d8c81f05fe732a42')
+      data = {'date': '2019-08-26', 'league_id': '1845', 'league': 'German Bundesliga', 'team1': 'Werder Bremen', 'team2': 'Hamburg SV', 'spi1': '64.54', 'spi2': '43.91'}
+
+      assert_raises Datarobot::AiApi::NotFoundError do
+        predictions = ai.predict('not_a_valid_target', data)
+      end
+    end
+
+    it "can predict things", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d4205d6d8c81f05fe732a42')
+      data = {'date': '2019-08-26', 'league_id': '1845', 'league': 'German Bundesliga', 'team1': 'Werder Bremen', 'team2': 'Hamburg SV', 'spi1': '64.54', 'spi2': '43.91'}
+      predictions = ai.predict('score1', data)
+      assert predictions.is_a? Datarobot::AiApi::Page
+
+      prediction = predictions.first
+
+      assert prediction.is_a? Datarobot::AiApi::Prediction
+      assert_equal prediction.prediction, 3.7707404629 
+    end
+
+    it "can be trained", vcr: true do
+      ai = Datarobot::AiApi::AI.create(name: 'test AI')
+      ai.train('score1', './test/data/test.csv')
+    end
+  end
+
+  describe "when not authorized" do
+    before do
+      Datarobot::AiApi.configure!(api_key: '')
+    end
+
+    it "can not list AIs", vcr: true do
+      assert_raises Datarobot::AiApi::UnauthorizedError do 
+        Datarobot::AiApi::AI.all
+      end
+    end
+
+    it "can not find AIs", vcr: true do
+      assert_raises Datarobot::AiApi::UnauthorizedError do 
+        Datarobot::AiApi::AI.find('5d322e625c142b15dff826fc')
+      end
+    end
+
+    it "can not create AIs", vcr: true do
+      assert_raises Datarobot::AiApi::UnauthorizedError do 
+        Datarobot::AiApi::AI.create(name: 'a testing AI')
+      end
+    end
+  end
+end

data/test/datarobot/ai_api/test_dataset.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+require_relative "test_page.rb"
+require_relative "test_refreshable.rb"
+
+describe "Datarobot::AiApi::Dataset" do
+  before do
+    @key = "testingKey"
+  end
+
+  it "is sane" do
+    Datarobot::AiApi::AI.new
+    # if we make it to here, nothing has exploded
+    assert true
+  end
+
+  describe "when authorized" do
+    before do
+      Datarobot::AiApi.configure!(api_key: @key)
+      @klass = Datarobot::AiApi::Dataset
+      @id = "5d4b20f37741a3052f171759"
+    end
+
+    it_behaves_like "a paginated resource"
+    it_behaves_like "a refreshable resource"
+
+    it "can list datasets", vcr: true do
+      datasets = Datarobot::AiApi::Dataset.all
+      assert datasets.is_a? Datarobot::AiApi::Page
+      assert_equal datasets.length, 38
+      assert_includes(datasets.map(&:name), "chords_part0000.csv")
+    end
+
+    it "can find datasets", vcr: true do
+      dataset = Datarobot::AiApi::Dataset.find('5d4b20f37741a3052f171759')
+      assert dataset.is_a? Datarobot::AiApi::Dataset
+      assert_equal dataset.name, "chords_part0000.csv"
+    end
+    
+    it "handles when the dataset ID is nil" do
+      assert_raises Datarobot::AiApi::NotFoundError do
+        ai = Datarobot::AiApi::Dataset.find(nil)
+      end
+    end
+
+    it "can delete datasets", vcr: true do
+      dataset = Datarobot::AiApi::Dataset.delete('5d41f1bbd8c81f05c9732a25')
+      assert_nil dataset
+    end
+
+    it "can import a dataset from a file", vcr: true do
+      dataset = Datarobot::AiApi::Dataset.create_from_file('./test/data/delete-me.csv')
+      assert dataset.is_a? Datarobot::AiApi::Dataset
+      assert_equal dataset.name, "delete-me.csv"
+      assert dataset.id
+    end
+
+    it "can import a dataset from a url", vcr: true do
+      dataset = Datarobot::AiApi::Dataset.create_from_url('https://projects.fivethirtyeight.com/congress-model-2018/house_national_forecast.csv')
+      assert dataset.is_a? Datarobot::AiApi::Dataset
+      assert_equal dataset.name, "house_national_forecast.csv"
+      assert dataset.id
+    end
+  end
+end

data/test/datarobot/ai_api/test_learning_session.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+require_relative 'test_page.rb'
+require_relative "test_refreshable.rb"
+
+describe "Datarobot::AiApi::LearningSession" do
+  before do
+    @key = "testingKey"
+  end
+
+  it "is sane" do
+    Datarobot::AiApi::LearningSession.new
+    # if we make it to here, nothing has exploded
+    assert true
+  end
+
+  describe "when authorized" do
+    before do
+      Datarobot::AiApi.configure!(api_key: @key)
+      @klass = Datarobot::AiApi::LearningSession
+      @id = '5d41e055d8c81f0587732a93'
+    end
+
+    it_behaves_like "a paginated resource"
+    it_behaves_like "a refreshable resource"
+
+    it "can list learning sessions", vcr: true do
+      sessions = Datarobot::AiApi::LearningSession.all
+      assert sessions.is_a? Datarobot::AiApi::Page
+      assert_equal sessions.length, 19
+    end
+
+    it "can find learning sessions", vcr: true do
+      session = Datarobot::AiApi::LearningSession.find('5d322f2c5c142b15d2f826e7')
+      assert session.is_a? Datarobot::AiApi::LearningSession
+      assert_equal session.name, "Learning class"
+    end
+
+    it "handles when the learning session ID is nil" do
+      assert_raises Datarobot::AiApi::NotFoundError do
+        ai = Datarobot::AiApi::LearningSession.find(nil)
+      end
+    end
+
+    it "can create learning sessions", vcr: true do
+      session = Datarobot::AiApi::LearningSession.create(dataset_id: '5d656bb042eabf201366f2d7', target: 'score1')
+      assert session.is_a? Datarobot::AiApi::LearningSession
+    end
+
+    it "can delete learning sessions", vcr: true do
+      session = Datarobot::AiApi::LearningSession.delete('5d322f2c5c142b15d2f826e7')
+      assert_nil session
+    end
+
+    it "can get learning session deployment data", vcr: true do
+      session = Datarobot::AiApi::LearningSession.find('5d41e055d8c81f0587732a93')
+      deployment = session.deployment
+      assert deployment
+      assert deployment.is_a? Datarobot::AiApi::Deployment
+      assert_equal deployment.target, 'score1'
+    end
+
+    it "can get learning session features", vcr: true do
+      session = Datarobot::AiApi::LearningSession.find('5d41e055d8c81f0587732a93')
+      features = session.features
+      assert features
+      assert features.is_a? Array
+      assert_equal features.length, 12
+    end
+
+    it "can get learning session evaluation data", vcr: true do
+      session = Datarobot::AiApi::LearningSession.find('5d76980cf2ff5200587ce3da')
+      evaluation = session.evaluation
+      assert evaluation
+      assert_equal evaluation.summary, "Because 6.6% of the variability in the values of score1 are explained, fit accuracy for the current top performing model is ranked as weak."
+    end
+  end
+end

data/test/datarobot/ai_api/test_output.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+describe "Datarobot::AiApi::Output" do
+  before do
+    @key = "testingKey"
+  end
+
+  it "is sane" do
+    Datarobot::AiApi::Output.new
+    # if we make it to here, nothing has exploded
+    assert true
+  end
+
+  describe "when authorized" do
+    before do
+      Datarobot::AiApi.configure!(api_key: @key)
+    end
+
+    it "can list outputs", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d5c6f7c42eabf0cb166f2c6')
+      outputs = ai.outputs
+      assert outputs.is_a? Datarobot::AiApi::Page
+      assert_equal outputs.length, 1
+      assert_includes(outputs.map(&:name), "test")
+    end
+
+    it "can create outputs", vcr: true do
+      output = Datarobot::AiApi::Output.create(ai_id: '5d5c6f7c42eabf0cb166f2c6', output_name: 'test', learning_session_id: '5d420b75d8c81f05e0732a3d')
+      assert output.is_a? Datarobot::AiApi::Output
+      assert_equal output.name, "test"
+    end
+
+    it "can find named outputs", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d5c6f7c42eabf0cb166f2c6')
+      output = ai.find_output('test')
+      assert output.is_a? Datarobot::AiApi::Output
+      assert_equal output.name, "test"
+    end
+
+    it "can get features of an output", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d5c6f7c42eabf0cb166f2c6')
+      output = ai.find_output('test')
+      features = output.features
+      assert_includes features, {"type"=>"Categorical", "name"=>"league"}
+    end
+
+    it "can get the evaluation of an output", vcr: true do
+      ai = Datarobot::AiApi::AI.find('5d76962ab153720056bb5783')
+      output = ai.find_output('score1 output')
+      evaluation = output.evaluation
+      assert_equal evaluation.summary, "Because 6.6% of the variability in the values of score1 are explained, fit accuracy for the current top performing model is ranked as weak."
+    end
+  end
+end

data/test/datarobot/ai_api/test_page.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+shared_examples_for 'a paginated resource' do
+  describe "#next_page" do
+    it "can go to the next page", vcr: true do
+      raise "Set @klass in a before block to use pagination tests" unless @klass
+      page = @klass.all(limit: 1, offset: 0)
+      next_page = page.next_page
+      assert next_page.is_a? Datarobot::AiApi::Page
+      assert_equal next_page.items.length, 1
+      assert_equal next_page.size, 1
+    end
+    it "returns the same page if there is no next page", vcr: true do
+      # puts self.inspect
+      raise "Set @klass in a before block to use pagination tests" unless @klass
+      page = @klass.all(limit: 100, offset: 0)
+      assert_nil page.links["next"]
+
+      next_page = page.next_page
+      assert_equal page, next_page
+    end
+  end
+  describe "#previous_page" do
+    it "can go to the previous page", vcr: true do
+      raise "Set @klass in a before block to use pagination tests" unless @klass
+      page_0 = @klass.all(limit: 1, offset: 0)
+      assert_equal page_0.items.length, 1
+      assert_equal page_0.size, 1
+
+      page_1 = page_0.next_page
+      page_2 = page_1.next_page
+
+      assert page_0.is_a? Datarobot::AiApi::Page
+      assert page_1.is_a? Datarobot::AiApi::Page
+      assert page_2.is_a? Datarobot::AiApi::Page
+
+      assert_equal page_1.map(&:id), page_2.previous_page.map(&:id)
+    end
+
+    it "returns the same page if there is no previous page", vcr: true do
+      raise "Set @klass in a before block to use pagination tests" unless @klass
+      page = @klass.all(limit: 1, offset: 0)
+
+      assert_nil page.links['previous']
+
+      prev_page = page.previous_page
+      assert_equal page.map(&:id), prev_page.map(&:id)
+    end
+  end
+end

data/test/datarobot/ai_api/test_refreshable.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+shared_examples_for 'a refreshable resource' do
+  describe "#refresh" do
+    it "can refresh to a new object", vcr: true do
+      raise "Set @klass in a before block to use refreshing tests" unless @klass
+      raise "Set @id in a before block to use refreshing tests" unless @id
+      object = @klass.find(@id)
+      assert object 
+      new_object = object.refresh
+      assert_equal object.id, new_object.id
+      assert object.inspect != new_object.inspect
+    end
+  end
+  describe "#refresh!" do
+    it "can refresh its values", vcr: true do
+      raise "Set @klass in a before block to use refreshing tests" unless @klass
+      raise "Set @id in a before block to use refreshing tests" unless @id
+      object = @klass.find(@id)
+      assert object 
+      object_dump = object.inspect
+      object.refresh!
+      assert object_dump != object.inspect
+    end
+  end
+  describe "#find" do
+    it "should accept a block", vcr: true do
+      raise "Set @klass in a before block to use refreshing tests" unless @klass
+      raise "Set @id in a before block to use refreshing tests" unless @id
+
+      class SpecialSpecificTestError < StandardError; end
+      assert_raises(SpecialSpecificTestError) do
+        @klass.find(@id) do
+          raise SpecialSpecificTestError
+        end
+      end
+    end
+  end
+end

data/test/datarobot/ai_api/test_task.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+require_relative "test_refreshable.rb"
+
+describe "Datarobot::AiApi::Task" do
+  before do
+    @key = "testingKey"
+  end
+
+  it "is sane" do
+    Datarobot::AiApi::Task.new
+    # if we make it to here, nothing has exploded
+    assert true
+  end
+
+  describe "when authorized" do
+    before do
+      Datarobot::AiApi.configure!(api_key: @key)
+      @klass = Datarobot::AiApi::Task
+      @id = '5d0efc9e-b77e-40e4-bd7e-1d162b53155c'
+    end
+
+    it_behaves_like "a refreshable resource"
+
+    it "check the status of a task", vcr: true do
+      task = Datarobot::AiApi::Task.find('5d0efc9e-b77e-40e4-bd7e-1d162b53155c')
+      assert task.is_a? Datarobot::AiApi::Task
+      assert_equal task.status, "COMPLETED"
+    end
+
+    it "can stop a task", vcr: true do
+      task = Datarobot::AiApi::Task.stop('5d0efc9e-b77e-40e4-bd7e-1d162b53155c')
+      assert_nil task
+    end
+
+    it "handles when Task ID is nil" do
+      assert_raises Datarobot::AiApi::NotFoundError do
+        task = Datarobot::AiApi::Task.find(nil)
+      end
+    end
+
+    it "can wait until completed", vcr: true do
+      resp_data = Datarobot::AiApi.upload_to_endpoint('/aiapi/datasets/fileImports', './test/data/test.csv')
+      task = Datarobot::AiApi::Task.new(resp_data)
+
+      dataset = task.wait_until_complete
+
+      task = Datarobot::AiApi::Task.find(task.id)
+      assert task.status == "COMPLETED"
+      assert dataset.is_a? Datarobot::AiApi::Dataset
+    end
+  end
+end
+