crowdkit 0.1.0

data/spec/crowdkit/client/workers_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Crowdkit::Client::Workers do
+  context "flag" do
+    let!(:request_stub) { stub_put("/workers/1/flag").to_return(status: 204) }
+    before { client.workers(worker_id: 1).flag(reason: 'Because') }
+
+    it "requests" do
+      expect(request_stub).to have_been_requested
+    end
+
+    it "response" do
+      expect(client.last_response.status).to eq(204)
+    end
+
+    it "blows up without reason" do
+      expect { client.workers(worker_id: 1).flag }.to raise_error Crowdkit::ValidationError
+    end
+  end
+
+  context "deflag" do
+    let!(:request_stub) { stub_put("/workers/2/deflag").to_return(status: 204) }
+    before { client.workers(worker_id: 2).deflag }
+
+    it "requests" do
+      expect(request_stub).to have_been_requested
+    end
+
+    it "response" do
+      expect(client.last_response.status).to eq(204)
+    end
+  end
+end

data/spec/crowdkit/client/worksets_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Crowdkit::Client::Worksets do
+  context "show" do
+    let!(:request_stub) { stub_get("/worksets/1").to_return(fixture_response("worksets/show.json")) }
+
+    context "requests" do
+      it "gets made" do
+        client.worksets.get(1)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "has find alias" do
+        client.worksets.find(1)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "blows up without id" do
+        expect { client.worksets.get }.to raise_error Crowdkit::ValidationError
+      end
+    end
+
+    context "response" do
+      it "parses" do
+        expect(client.worksets.get(1).id).to eq(1)
+      end
+    end
+  end
+
+  context "list" do
+    let!(:request_stub) { stub_get("/jobs/1/worksets").to_return(fixture_response("worksets/index.json")) }
+
+    context "requests" do
+      it "gets made" do
+        client.worksets(job_id: 1).list
+        expect(request_stub).to have_been_requested
+      end
+
+      it "has all alias" do
+        client.worksets.all(job_id: 1)
+        expect(request_stub).to have_been_requested
+      end
+
+      it "blows up without job_id" do
+        expect { client.worksets.list }.to raise_error Crowdkit::ValidationError
+      end
+    end
+
+    context "response" do
+      it "parses" do
+        expect(client.worksets(job_id: 1).list.length).to eq(2)
+      end
+    end
+  end
+
+
+  context "statuses" do
+    shared_examples_for "statuses" do
+      it "requests" do
+        expect(request_stub).to have_been_requested
+      end
+
+      it "response" do
+        expect(client.last_response.status).to eq(204)
+      end
+    end
+
+    context "flag" do
+      it_behaves_like "statuses" do
+        let!(:request_stub) { stub_put("/worksets/1/flag").to_return(status: 204) }
+        before { client.worksets(workset_id: 1).flag(reason: 'Because') }
+      end
+    end
+
+    context "deflag" do
+      it_behaves_like "statuses" do
+        let!(:request_stub) { stub_put("/worksets/1/deflag").to_return(status: 204) }
+        before { client.worksets(workset_id: 1).deflag(reason: 'Because') }
+      end
+    end
+
+    context "reject" do
+      it_behaves_like "statuses" do
+        let!(:request_stub) { stub_put("/worksets/1/reject").to_return(status: 204) }
+        before { client.worksets(workset_id: 1).reject(reason: 'Too bad!') }
+      end
+    end
+
+    context "approve" do
+      it_behaves_like "statuses" do
+        let!(:request_stub) { stub_put("/worksets/1/approve").to_return(status: 204) }
+        before { client.worksets(workset_id: 1).approve(reason: 'Cool!') }
+      end
+    end
+  end
+
+  context "bonus" do
+    let!(:request_stub) { stub_put("/worksets/1/bonus").to_return(status: 204) }
+    before { client.worksets(workset_id: 1).bonus(amount: 10) }
+
+    it "requests" do
+      expect(request_stub).to have_been_requested
+    end
+
+    it "response" do
+      expect(client.last_response.status).to eq(204)
+    end
+
+    it "blows up without amount" do
+      expect { client.worksets(workset_id: 1).bonus }.to raise_error Crowdkit::ValidationError
+    end
+  end
+end

data/spec/crowdkit/client_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'open-uri'
+describe Crowdkit::Client do
+  context 'root' do
+    let!(:request_stub) { stub_get("").to_return(fixture_response("root.json")) }
+
+    it "requests the resource" do
+      client.root
+      expect(request_stub).to have_been_requested
+    end
+
+    it "provides links" do
+      expect(client.root.rels.size).to eq(2)
+    end
+  end
+
+  context "pagination" do
+    let!(:first_page) { stub_get("/jobs").to_return(fixture_response("jobs/search.json", 200, { Link: '<https://api.crowdflower.com/v2/jobs?page=2>; rel="last", <https://api.crowdflower.com/v2/jobs?page=2>; rel="next"'})) }
+    let!(:last_page) { stub_get("/jobs?page=2").to_return(fixture_response("jobs/search.json", 200, { Link: '<https://api.crowdflower.com/v2/jobs>; rel="first", <https://api.crowdflower.com/v2/jobs>; rel="prev"'}))}
+
+    it "auto paginates with a block" do
+      client.config.auto_paginate = true
+      total_jobs = 0
+      client.jobs.list { |job| total_jobs += 1 }
+      expect(total_jobs).to eq(10)
+      expect(first_page).to have_been_requested
+      expect(last_page).to have_been_requested
+    end
+
+    it "auto paginates without a block" do
+      client.config.auto_paginate = true
+      expect(client.jobs.list.to_a.length).to eq(10)
+    end
+
+    it "auto paginates with options" do
+      expect(client.config.auto_paginate).to be_falsey
+      expect(client.jobs.list(auto_pagination: true).to_a.length).to eq(10)
+      expect(client.auto_pagination).to be_falsey
+    end
+
+    it "next page" do
+      expect(client.jobs.list.next_page.length).to eq(5)
+      expect(last_page).to have_been_requested
+    end
+
+    it "prev page" do
+      client.jobs.list.next_page.prev_page
+      expect(first_page).to have_been_requested.twice
+    end
+
+    it "missing page" do
+      expect(client.jobs.list.first_page).to be_falsey
+    end
+  end
+end

data/spec/crowdkit_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+describe Crowdkit do
+  context "configuration" do
+    context "defaults" do
+      specify "connection_options" do
+        expect(Crowdkit.config.connection_options).to include({
+          headers: {
+            accept: "application/json",
+            user_agent: "Crowdkit Ruby Gem #{Crowdkit::VERSION}"
+          }
+        })
+      end
+    end
+
+    context "stack" do
+      specify "default" do
+        expect(Crowdkit.config.stack.handlers.first).to eq(Faraday::Request::TokenAuthentication)
+      end
+
+      context "overrides" do
+        before(:each) do
+          Crowdkit.reset!
+        end
+
+        it "modifies existing stack" do
+          Crowdkit.configure do |c|
+            c.stack.insert_before(Faraday::Request::TokenAuthentication, Crowdkit)
+          end
+          expect(Crowdkit.config.stack.handlers.first).to eq Crowdkit
+        end
+
+        it "overrides stack" do
+          Crowdkit.configure do |c|
+            c.stack do |builder|
+              builder.use Crowdkit
+            end
+          end
+          expect(Crowdkit.config.stack.handlers.first).to eq Crowdkit
+        end
+
+        it "use custom adapter" do
+          Crowdkit.configure(adapter: :typhoeus)
+          expect(Crowdkit.config.stack.handlers.last).to eq Faraday::Adapter::Typhoeus
+        end
+      end
+    end
+
+    context "non defaults" do
+      shared_examples "overrides" do
+        specify "user_agent" do
+          expect(client.config.user_agent).to eq("Foo")
+        end
+
+        specify "nested connection_options" do
+          expect(client.config.connection_options).to include({
+            headers: {
+              accept: "application/json",
+              user_agent: "Foo"
+            }
+          })
+        end
+
+        specify "logging" do
+          expect(client.config.stack.handlers.first).to eq(Faraday::Response::Logger)
+        end
+      end
+
+      context "global" do
+        let(:client) do
+          Crowdkit
+        end
+
+        before(:each) do
+          Crowdkit.reset!
+          Crowdkit.configure(debug: true, user_agent: "Foo")
+        end
+      end
+
+      context "block" do
+        let(:client) do
+          Crowdkit.new do |c|
+            c.debug = true
+            c.user_agent = "Foo"
+          end
+        end
+
+        it_behaves_like "overrides"
+      end
+
+      context "opts" do
+        let(:client) do
+          Crowdkit.new({debug: true, user_agent: "Foo"})
+        end
+
+        it_behaves_like "overrides"
+      end
+
+      context "env" do
+        around(:each) do |example|
+          Crowdkit.reset!
+          ENV["CROWDKIT_USER_AGENT"] = "Foo"
+          ENV["CROWDKIT_DEBUG"] = "true"
+          example.run
+          ENV["CROWDKIT_USER_AGENT"] = nil
+          ENV["CROWDKIT_DEBUG"] = nil
+        end
+
+        let(:client) do
+          Crowdkit
+        end
+
+        it_behaves_like "overrides"
+      end
+    end
+  end
+
+  context "client proxy" do
+    context "unconfigured" do
+      specify "exception" do
+        expect { Crowdkit.do_get("/foo") }.to raise_error Crowdkit::Unauthorized
+      end
+    end
+  end
+
+  context "rate limits" do
+    let!(:soft_request_stub) { stub_get(/jobs\/soft/).to_return(body: 'rate limit exceeded', status: 429) }
+    let!(:hard_request_stub) { stub_get(/jobs\/hard/).to_return(body: 'rate limit exceeded', status: 403) }
+
+    it "retries once on hard" do
+      expect { client.jobs.get("hard") }.to raise_error(Crowdkit::Forbidden)
+    end
+
+    it "raises error on soft" do
+      expect { client.jobs.get("soft") }.to raise_error(Crowdkit::TooManyRequests)
+      expect(soft_request_stub).to have_been_requested.times(2)
+    end
+  end
+end

data/spec/fixtures/account.json

@@ -0,0 +1,7 @@
+{
+    "id": 1,
+    "email": "test@test.com",
+    "name": "Test",
+    "account_balance": 100,
+    "unused_allocated_funds": 0
+}

data/spec/fixtures/jobs/copy.json

@@ -0,0 +1,79 @@
+{
+  "id":12,
+  "created_at":"2014-06-12T23:24:05Z",
+  "updated_at":"2014-06-12T23:24:05Z",
+  "state":"unordered",
+  "tags":[],
+  "title":"Some really awesome job that is so very very cool",
+  "stats":{
+    "units_count":0,
+    "new_units_count":0,
+    "judgments_count":0,
+    "needed_judgments_count":0,
+    "golds_count":0,
+    "cost":0.0,
+    "allocated_funds":0.0
+  },
+  "user":{
+    "id":1,
+    "name":"cf_internal user",
+    "account_balance":0.0,
+    "allocated_funds":0.0,
+    "email":"cf_internal@crowdflower.com"
+  },
+  "_links":{
+    "self":{
+      "href":"https://api.crowdflower.dev/v2/jobs/12"
+    },
+    "units":{
+      "href":"https://api.crowdflower.dev/v2/jobs/12/units/{unit_id}",
+      "templated":true
+    },
+    "judgments":{
+      "href":"https://api.crowdflower.dev/v2/jobs/12/judgments/{judgment_id}",
+      "templated":true
+    }
+  },
+  "definition":{
+    "cml":"<p>I don't have any data this is a survey</p>\n<cml:checkboxes label=\"How cool is this?\" class=\"\" validates=\"required\">\n    <cml:checkbox label=\"Category A\"/>\n    <cml:checkbox label=\"Category B\"/>\n    <cml:checkbox label=\"Category C\"/>\n  </cml:checkboxes>",
+    "instructions":"Well you've got to do this awesome shit, and then later do that cool stuff"
+  },
+  "contributor_settings":{
+    "assignment_ttl_in_minutes":30,
+    "excluded_countries":[],
+    "included_countries":[],
+    "channels":[]
+  },
+  "quality_settings":{
+    "test_questions_per_assignment":0,
+    "reject_at":70,
+    "after_gold":10,
+    "variable_judgments_mode":"none"
+  },
+  "job_settings":{
+    "judgments_per_unit":3,
+    "units_per_assignment":5,
+    "pages_per_assignment":1,
+    "language":"en",
+    "explicit_content":false,
+    "payment_cents":5,
+    "public_data":false
+  },
+  "api_settings":{
+    "auto_order":false
+  },
+  "report_settings":{
+    "include_unfinished":true
+  },
+  "current_status":{
+    "id":"3d05fc4a1501dcebfb836434d8fc5cce",
+    "percent_complete":0,
+    "state":"queued",
+    "name":"Unit Copy",
+    "_links":{
+      "self":{
+        "href":"https://api.crowdflower.com/v2/statuses/3d05fc4a1501dcebfb836434d8fc5cce"
+      }
+    }
+  }
+}

data/spec/fixtures/jobs/job.json

@@ -0,0 +1 @@
+{"id":1,"created_at":"2014-02-07T16:43:29Z","updated_at":"2014-02-07T16:45:00Z","state":"unordered","tags":[],"title":"Some really awesome job that is so very very cool","stats":{"units_count":1,"new_units_count":1,"judgments_count":0,"needed_judgments_count":0,"golds_count":0},"user":{"id":1,"name":"cf_internal user","email":"cf_internal@crowdflower.com"},"_links":{"self":{"href":"https://api.crowdflower.dev/v2/jobs/1"},"units":{"href":"https://api.crowdflower.dev/v2/jobs/1/units/{unit_id}","templated":true},"judgments":{"href":"https://api.crowdflower.dev/v2/jobs/1/judgments/{judgment_id}","templated":true}},"definition":{"cml":"<p>I don't have any data this is a survey</p>\n<cml:checkboxes label=\"How cool is this?\" class=\"\" validates=\"required\">\n <cml:checkbox label=\"Category A\"/>\n <cml:checkbox label=\"Category B\"/>\n <cml:checkbox label=\"Category C\"/>\n </cml:checkboxes>","instructions":"Well you've got to do this awesome shit, and then later do that cool stuff"},"contributor_settings":{"assignment_ttl_in_minutes":30,"excluded_countries":[],"included_countries":[],"channels":[]},"quality_settings":{"test_questions_per_assignment":0,"reject_at":70,"after_gold":10,"variable_judgments_mode":"none"},"job_settings":{"judgments_per_unit":3,"units_per_assignment":5,"pages_per_assignment":1,"language":"en","explicit_content":false,"payment_cents":5,"public_data":false},"api_settings":{"auto_order":false},"report_settings":{"include_unfinished":true}}

data/spec/fixtures/jobs/order.json

@@ -0,0 +1,53 @@
+{
+  "created_at":"2014-06-13T22:14:11Z",
+  "units_count":5,
+  "amount":10.0,
+  "id":1822,
+  "job":{
+    "id":9408,
+    "created_at":"2014-06-13T22:14:11Z",
+    "updated_at":"2014-06-13T22:14:11Z",
+    "state":"running",
+    "project_number":"PN001",
+    "tags":[],
+    "alias":"foo1",
+    "title":"Fantastic Job",
+    "stats":{
+      "units_count":5,
+      "new_units_count":5,
+      "judgments_count":0,
+      "needed_judgments_count":0,
+      "golds_count":0,
+      "cost":0.0,
+      "allocated_funds":0.0
+    },
+    "_links":{
+      "self":{
+        "href":"https://api.crowdflower.test/v2/jobs/9408"
+      }
+    }
+  },
+  "user":{
+    "id":18548,
+    "name":"Willy Beetus",
+    "account_balance":10.0,
+    "allocated_funds":10.0,
+    "email":"person1@crowdflower.com"
+  },
+  "current_status":{
+    "id":"9e61a51bad819441e3d5fcfc6045b555",
+    "percent_complete":0,
+    "state":"queued",
+    "name":"Unit Ordering",
+    "_links":{
+      "self":{
+        "href":"https://api.crowdflower.com/v2/statuses/9e61a51bad819441e3d5fcfc6045b555"
+      }
+    }
+  },
+  "_links":{
+    "self":{
+      "href":"https://api.crowdflower.test/v2/orders/1822"
+    }
+  }
+}