crowdkit 0.1.0

data/lib/crowdkit/version.rb

@@ -0,0 +1,3 @@
+module Crowdkit
+  VERSION = File.read(File.expand_path(File.dirname(__FILE__) + "/../../VERSION")).strip
+end

data/spec/crowdkit/client/account_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Crowdkit::Client::Account do
+  context "show" do
+    let!(:request_stub) { stub_get("/account").to_return(fixture_response("account.json")) }
+
+    it "send request" do
+      client.account.get
+      expect(request_stub).to have_been_requested
+    end
+
+    it "parse response" do
+      account = client.account.get
+      expect(account.id).to eq(1)
+      expect(account.data[:email]).to eq('test@test.com')
+      expect(account.data[:name]).to eq('Test')
+    end
+  end
+end

data/spec/crowdkit/client/jobs_spec.rb

@@ -0,0 +1,275 @@
+require 'spec_helper'
+
+describe Crowdkit::Client::Jobs do
+  context "jobs" do
+    context "search" do
+      let!(:request_stub) { stub_get(/jobs/).to_return(fixture_response("jobs/search.json")) }
+
+      context "requests" do
+        it "should be made" do
+          client.jobs.search
+          expect(request_stub).to have_been_requested
+        end
+
+        it "sets search parameter" do
+          client.jobs.search("Rad")
+          expect(a_request(:get, /jobs/).with(query: {"query" => "Rad"})).to have_been_made
+        end
+
+        it "passes along other parameters" do
+          client.jobs.search(page: 2, state: :finished)
+          expect(a_request(:get, /jobs/).with(query: {"page" => "2", "state" => "finished"})).to have_been_made
+        end
+
+        it "has list alias" do
+          client.jobs.list
+          expect(request_stub).to have_been_requested
+        end
+
+        it "has all alias" do
+          client.jobs.all
+          expect(request_stub).to have_been_requested
+        end
+      end
+
+      context "responses" do
+        it "parses the data" do
+          expect(client.jobs.search.length).to eq(5)
+        end
+
+        it "executes a block" do
+          i = 0
+          client.jobs.all {|job| i += 1 }
+          expect(i).to eq(5)
+        end
+      end
+    end
+
+    context "get" do
+      let!(:request_stub) { stub_get("/jobs/1").to_return(fixture_response("jobs/job.json")) }
+
+      context "request" do
+        it "should be made" do
+          client.jobs.get(1)
+          expect(request_stub).to have_been_requested
+        end
+
+        it "accepts job parameter" do
+          client.jobs(1).get
+          expect(request_stub).to have_been_requested
+        end
+
+        it "blows up without id" do
+          expect { client.jobs.get }.to raise_error Crowdkit::ValidationError
+        end
+
+        it "has find alias" do
+          client.jobs.find(1)
+          expect(request_stub).to have_been_requested
+        end
+      end
+
+      context "response" do
+        it "parses" do
+          expect(client.jobs.get(1).id).to eq(1)
+        end
+
+        it "forwards to data" do
+          expect(client.jobs.get(1).title).to eq("Some really awesome job that is so very very cool")
+        end
+      end
+    end
+
+    context "copy" do
+      let!(:request_stub) { stub_post(/11\/copy/).to_return(fixture_response("jobs/copy.json", 202)) }
+
+      context "request" do
+        it "should be made" do
+          client.jobs(11).copy
+          expect(request_stub).to have_been_requested
+        end
+
+        it "passes parameters" do
+          client.jobs(11).copy(all_units: true)
+          expect(a_request(:post, /copy/).with(query: {"all_units" => "true"})).to have_been_made
+        end
+
+        it "blows up without id" do
+          expect { client.jobs.copy }.to raise_error Crowdkit::ValidationError
+        end
+      end
+
+      context "response" do
+        it "parses" do
+          expect(client.jobs.copy(11).id).to eq(12)
+        end
+
+        it "is a 202" do
+          client.jobs(11).copy(all_units: true)
+          expect(client.last_response.status).to eq(202)
+        end
+
+        it "provides current status" do
+          status = stub_get("/statuses/3d05fc4a1501dcebfb836434d8fc5cce").to_return(fixture_response("statuses/status.json"))
+          response = client.jobs(11).copy(all_units: true)
+          response.current_status
+          response.current_status
+          expect(status).to have_been_requested.twice
+        end
+      end
+    end
+
+    context "order" do
+      let!(:request_stub) { stub_post(/11\/order/).to_return(fixture_response("jobs/order.json", 202)) }
+
+      context "request" do
+        it "should be made" do
+          client.jobs(11).order
+          expect(request_stub).to have_been_requested
+        end
+
+        it "passes parameters" do
+          client.jobs(11).order(units_count: 10)
+          expect(a_request(:post, /order/).with(query: {"units_count" => "10"})).to have_been_made
+        end
+
+        it "blows up without id" do
+          expect { client.jobs.order }.to raise_error Crowdkit::ValidationError
+        end
+      end
+
+      context "response" do
+        it "parses" do
+          expect(client.jobs.order(11).id).to eq(1822)
+        end
+
+        it "is a 202" do
+          client.jobs.order(units_count: 10, job_id: 11)
+          expect(client.last_response.status).to eq(202)
+        end
+
+        it "provides current status" do
+          status = stub_get("/statuses/9e61a51bad819441e3d5fcfc6045b555").to_return(fixture_response("statuses/status.json"))
+          response = client.jobs(11).order
+          response.current_status
+          response.current_status
+          expect(status).to have_been_requested.twice
+        end
+      end
+    end
+
+    context "create" do
+      let!(:request_stub) { stub_post("/jobs").to_return(fixture_response("jobs/job.json", 201)) }
+
+      context "request" do
+        it "should be made" do
+          client.jobs.create(title: "My amazing job")
+          expect(request_stub).to have_been_requested
+        end
+
+        it "passes title in the body" do
+          client.jobs.create(title: "My amazing job")
+          expect(a_request(:post, /jobs/).with(body: {title: "My amazing job"}.to_json)).to have_been_made
+        end
+
+        it "blows up without title" do
+          expect { client.jobs.create }.to raise_error Crowdkit::ValidationError
+        end
+      end
+
+      context "response" do
+        it "parses" do
+          expect(client.jobs.create(title: "My amazing job").id).to eq(1)
+        end
+
+        it "is a 201" do
+          client.jobs.create(title: "My amazing job")
+          expect(client.last_response.status).to eq(201)
+        end
+      end
+    end
+
+    describe "statuses" do
+      let!(:request_stub) { stub_get("/jobs/11/statuses").to_return(fixture_response("statuses/index.json")) }
+
+      describe "request" do
+        it "should be made" do
+          client.jobs(11).statuses
+          expect(request_stub).to have_been_requested
+        end
+
+        it "blows up without id" do
+          expect { client.jobs.statuses }.to raise_error Crowdkit::ValidationError
+        end
+      end
+
+      describe "response" do
+        it "parses" do
+          expect(client.jobs(11).statuses.length).to eq(2)
+        end
+      end
+    end
+
+    describe "judgments" do
+      let(:get_judgments) { client.jobs(11).judgments(per_page: 3) }
+      let!(:request_stub) { stub_get("/jobs/11/judgments?per_page=3").to_return(fixture_response("judgments/index.json")) }
+
+      describe "request" do
+        it "should be made" do
+          get_judgments
+          expect(request_stub).to have_been_requested
+        end
+
+        it "passes parameters" do
+          get_judgments
+          expect(a_request(:get, /judgments/).with(query: {"per_page" => 3.to_s})).to have_been_made
+        end
+
+        it "blows up without id" do
+          expect { client.jobs.judgments }.to raise_error Crowdkit::ValidationError
+        end
+      end
+
+      describe "response" do
+        it "parses" do
+          expect(get_judgments.length).to eq(3)
+        end
+      end
+    end
+
+    context "namespaces" do
+      describe "units" do
+        it "provides association" do
+          expect(client.jobs.units.class).to eq(Crowdkit::Client::Units)
+        end
+
+        it "passes along job_id" do
+          expect(client.jobs(1).units.stored_params).to eq({job_id: 1})
+        end
+      end
+    end
+
+    describe "upload" do
+      let(:file) { fixture('upload.csv') }
+      let!(:request_stub) { stub_put('/jobs/1/upload').to_return(fixture_response('jobs/job.json', 201)) }
+
+      describe "request" do
+        it "should be made" do
+          client.jobs(1).upload(file)
+          expect(request_stub).to have_been_requested
+        end
+
+        it "blows up without id" do
+          expect { client.jobs.upload(file) }.to raise_error Crowdkit::ValidationError
+        end
+      end
+
+      context "response" do
+        it "parses" do
+          expect(client.jobs(1).upload(file).id).to eq(1)
+          expect(client.last_response.status).to eq(201)
+        end
+      end
+    end
+  end
+end

data/spec/crowdkit/client/judgments_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Crowdkit::Client::Judgments do
+  context "show" do
+    let(:judgment_id) { 6634 }
+    let!(:request_stub) { stub_get("/judgments/#{judgment_id}").to_return(fixture_response("judgments/show.json")) }
+
+    context "requests" do
+      it "gets made" do
+        client.judgments.get(judgment_id)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "has find alias" do
+        client.judgments.find(judgment_id)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "blows up without id" do
+        expect { client.judgments.get }.to raise_error(Crowdkit::ValidationError)
+      end
+    end
+
+    context "response" do
+      it "parses" do
+        expect(client.judgments.get(judgment_id).id).to eq(judgment_id)
+      end
+    end
+  end
+end

data/spec/crowdkit/client/statuses_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Crowdkit::Client::Statuses do
+  context "show" do
+    let(:status_id) { "4be60d841550b13d72acfb3aa0412596" }
+    let!(:request_stub) { stub_get("/statuses/#{status_id}").to_return(fixture_response("statuses/status.json")) }
+
+    context "requests" do
+      it "gets made" do
+        client.statuses.get(status_id)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "has find alias" do
+        client.statuses.find(status_id)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "blows up without id" do
+        expect { client.statuses.get }.to raise_error Crowdkit::ValidationError
+      end
+    end
+
+    context "response" do
+      it "parses" do
+        expect(client.statuses.get(status_id).id).to eq(status_id)
+      end
+    end
+  end
+end

data/spec/crowdkit/client/units_spec.rb

@@ -0,0 +1,266 @@
+require 'spec_helper'
+
+describe Crowdkit::Client::Units do
+  context "show" do
+    let(:unit_id) { 47979 }
+    let!(:request_stub) { stub_get("/units/#{unit_id}").to_return(fixture_response("units/show.json")) }
+
+    context "requests" do
+      it "gets made" do
+        client.units.get(unit_id)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "has find alias" do
+        client.units.find(unit_id)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "blows up without id" do
+        expect { client.units.get }.to raise_error Crowdkit::ValidationError
+      end
+    end
+
+    context "response" do
+      it "parses" do
+        expect(client.units.get(unit_id).id).to eq(unit_id)
+      end
+
+      specify "hypermedia" do
+        expect(client.units.get(unit_id).rels.to_hash).to eq({
+          self_url: "https://api.crowdflower.dev/v2/units/47979",
+          judgments_url: "https://api.crowdflower.dev/v2/units/47979/judgments"
+        })
+      end
+    end
+  end
+
+  describe "list" do
+    let!(:request_stub) { stub_get("/jobs/10/units").to_return(fixture_response("units/index.json")) }
+
+    context "requests" do
+      it "gets made" do
+        client.units(job_id: 10).list
+        expect(request_stub).to have_been_requested
+      end
+
+      it "has all alias" do
+        client.units.all(job_id: 10)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "blows up without job_id" do
+        expect { client.units.list }.to raise_error Crowdkit::ValidationError
+      end
+    end
+
+    context "response" do
+      it "parses" do
+        expect(client.units(job_id: 10).list.length).to eq(50)
+      end
+    end
+  end
+
+  context "create" do
+    let(:data) { Hash(data: {test: true}) }
+    let(:create_unit) { client.units(job_id: 10).create(data.dup) }
+    let!(:request_stub) { stub_post("/jobs/10/units").to_return(fixture_response("units/show.json", 201)) }
+
+    context "request" do
+      it "should be made" do
+        create_unit
+        expect(request_stub).to have_been_requested
+      end
+
+      it "passes data in the body" do
+        create_unit
+        expect(a_request(:post, /jobs/).with(body: data.to_json)).to have_been_made
+      end
+
+      it "blows up without job_id" do
+        expect { client.units.create }.to raise_error Crowdkit::ValidationError
+      end
+
+      it "support array of units data" do
+        units_data = [{test_1: true}, {test_2: true}]
+        client.units(job_id: 10).create(units_data)
+        expect(a_request(:post, /jobs\/10\/units/).with(body: units_data.to_json)).to have_been_made
+      end
+    end
+
+    context "response" do
+      it "parses" do
+        expect(create_unit.id).to eq(47979)
+      end
+
+      it "is a 201" do
+        create_unit
+        expect(client.last_response.status).to eq(201)
+      end
+    end
+  end
+
+  context "copy" do
+    let(:unit_id) { 47979 }
+    let(:destination_job_id) { 11 }
+    let(:copy_unit) { client.units(unit_id).copy(destination_job_id: destination_job_id) }
+    let!(:request_stub) do
+      url = "/units/#{unit_id}/copy?destination_job_id=#{destination_job_id}"
+      stub_post(url).to_return(fixture_response("units/copy.json", 201))
+    end
+
+    context "request" do
+      it "should be made" do
+        copy_unit
+        expect(request_stub).to have_been_requested
+      end
+
+      it "passes parameters" do
+        copy_unit
+        expect(a_request(:post, /copy/).with(query: {"destination_job_id" => destination_job_id.to_s})).to have_been_made
+      end
+
+      it "blows up without id" do
+        expect { client.units(unit_id).copy }.to raise_error Crowdkit::ValidationError
+      end
+    end
+
+    context "response" do
+      it "parses" do
+        expect(copy_unit.data[:job][:id]).to eq(destination_job_id)
+      end
+
+      it "is a 201" do
+        copy_unit
+        expect(client.last_response.status).to eq(201)
+      end
+    end
+  end
+
+  context "delete" do
+    let!(:request_stub) { stub_delete("/units/1").to_return(body: '', status: 204) }
+    before(:each) { client.units(1).delete }
+
+    it "request should be made" do
+      expect(request_stub).to have_been_requested
+    end
+
+    it "response status is 204" do
+      expect(client.last_response.status).to eq(204)
+    end
+  end
+
+  context "pause" do
+    let!(:request_stub) { stub_put("/units/1/pause").to_return(body: '', status: 204) }
+    before(:each) { client.units(1).pause }
+
+    it "request should be made" do
+      expect(request_stub).to have_been_requested
+    end
+
+    it "response status is 204" do
+      expect(client.last_response.status).to eq(204)
+    end
+  end
+
+  context "resume" do
+    let!(:request_stub) { stub_put("/units/1/resume").to_return(body: '', status: 204) }
+    before(:each) { client.units(1).resume }
+
+    it "request should be made" do
+      expect(request_stub).to have_been_requested
+    end
+
+    it "response status is 204" do
+      expect(client.last_response.status).to eq(204)
+    end
+  end
+
+  describe "judgments" do
+    let(:get_judgments) { client.units(1).judgments(per_page: 3) }
+    let!(:request_stub) { stub_get("/units/1/judgments?per_page=3").to_return(fixture_response("judgments/index.json")) }
+
+    describe "request" do
+      it "should be made" do
+        get_judgments
+        expect(request_stub).to have_been_requested
+      end
+
+      it "passes parameters" do
+        get_judgments
+        expect(a_request(:get, /judgments/).with(query: {"per_page" => 3.to_s})).to have_been_made
+      end
+
+      it "blows up without id" do
+        expect { client.units.judgments }.to raise_error Crowdkit::ValidationError
+      end
+    end
+
+    describe "response" do
+      it "parses" do
+        expect(get_judgments.length).to eq(3)
+      end
+    end
+  end
+
+  describe "poll" do
+    let!(:request_stub) do
+      stub_get("/jobs/10/units/queue").to_return(fixture_response("units/poll/normal.json"))
+    end
+
+    describe "request" do
+      it "should be made" do
+        client.units(job_id: 10).poll
+        expect(request_stub).to have_been_requested
+      end
+
+      it "should handle 304" do
+        remove_request_stub(request_stub)
+        stub_get("/jobs/10/units/queue").to_return({status: 304})
+        result = client.jobs(10).units.poll
+        expect(result.any?).to be_falsey
+      end
+
+      it "passes parameters" do
+        stub_get("/jobs/10/units/queue?delete=true&limit=10").to_return({status: 304})
+        client.units(job_id: 10).poll(delete: true, limit: 10)
+        expect(a_request(:get, /queue/).with(query: {"delete" => "true", "limit" => "10"})).to have_been_made
+      end
+
+      it "blows up without job_id" do
+        expect { client.units.poll }.to raise_error Crowdkit::ValidationError
+      end
+
+      describe "delete" do
+        let!(:request_delete_stub) { stub_delete(/queue/).to_return({status: 204}) }
+        it "should delete all units" do
+          client.units(job_id: 10).poll.delete
+          expect(request_delete_stub).to have_been_requested
+        end
+
+        it "should delete units in block" do
+          client.units(job_id: 10).poll.each do |unit|
+            unit.delete if unit.id == 47979
+          end
+          expect(request_delete_stub).to have_been_requested
+        end
+
+        it 'should delete single unit' do
+          unit = client.units(job_id: 10).poll.first
+          unit.delete
+          expect(request_delete_stub).to have_been_requested
+        end
+      end
+    end
+
+    describe "response" do
+      it "parses" do
+        poll = client.units(job_id: 10).poll
+        expect(poll.length).to eq(30)
+        expect(poll.map(&:id).length).to eq(30)
+        expect(poll.first.id).to eq(47979)
+        expect(poll.last.id).to eq(48008)
+      end
+    end
+  end
+end