sequencescape-client-api 0.3.5

data/spec/sequencescape-api/contracts/model-b-instance.txt

@@ -0,0 +1,38 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "model_b": {
+    "actions": {
+      "read": "http://localhost:3000/UUID"
+    },
+
+    "uuid": "UUID",
+
+    "model_a": {
+      "actions": {
+        "read": "http://localhost:3000/BELONGS_TO_UUID"
+      }
+    },
+    "model_by_simple_name": {
+      "actions": {
+        "read": "http://localhost:3000/BELONGS_TO_UUID"
+      }
+    },
+    "model_by_full_name": {
+      "actions": {
+        "read": "http://localhost:3000/BELONGS_TO_UUID"
+      }
+    },
+    "model_with_early_data": {
+      "actions": {
+        "read": "http://localhost:3000/BELONGS_TO_UUID"
+      },
+      "name": "early data from JSON",
+      "group": {
+        "data": "early group data from JSON"
+      }
+    }
+  }
+}
+

data/spec/sequencescape-api/contracts/model-c-instance-created.txt

@@ -0,0 +1,17 @@
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+  "model_c": {
+    "actions": {
+      "read": "http://localhost:3000/UUID",
+      "update": "http://localhost:3000/UUID"
+    },
+
+    "uuid": "UUID",
+    "changes_during_update": "set during create",
+    "remains_same_during_update": "and this was too"
+  }
+}
+
+

data/spec/sequencescape-api/contracts/model-c-instance-updated.txt

@@ -0,0 +1,17 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "model_c": {
+    "actions": {
+      "read": "http://localhost:3000/UUID",
+      "update": "http://localhost:3000/UUID"
+    },
+
+    "uuid": "UUID",
+    "changes_during_update": "changed",
+    "remains_same_during_update": "stays the same",
+    "write_only": "has been set"
+  }
+}
+

data/spec/sequencescape-api/contracts/model-c-instance.txt

@@ -0,0 +1,28 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "model_c": {
+    "actions": {
+      "read": "http://localhost:3000/UUID",
+      "update": "http://localhost:3000/UUID"
+    },
+
+    "uuid": "UUID",
+    "changes_during_update": "from JSON",
+    "remains_same_during_update": "from JSON",
+
+    "model_bs": [
+      {
+
+      },
+      {
+
+      },
+      {
+
+      }
+    ]
+  }
+}
+

data/spec/sequencescape-api/contracts/model-c-invalid-attribute.txt

@@ -0,0 +1,8 @@
+HTTP/1.1 422 Unprocessible Entity
+Content-Type: application/json
+
+{
+  "content": {
+    "attribute_validated_at_server": [ "cannot be set" ]
+  }
+}

data/spec/sequencescape-api/contracts/resource-not-found.txt

@@ -0,0 +1,6 @@
+HTTP/1.1 404 Not Found
+Content-Type: application/json
+
+{
+  "general": [ "resource could not be found" ]
+}

data/spec/sequencescape-api/contracts/results-page-1.txt

@@ -0,0 +1,17 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "actions": {
+    "first": "http://localhost:3000/pages/1",
+    "next": "http://localhost:3000/pages/2",
+    "last": "http://localhost:3000/pages/3",
+    "read": "http://localhost:3000/pages/1"
+  },
+  "size": 3,
+  "model_as": [
+    {
+
+    }
+  ]
+}

data/spec/sequencescape-api/contracts/results-page-2.txt

@@ -0,0 +1,18 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "actions": {
+    "first": "http://localhost:3000/pages/1",
+    "previous": "http://localhost:3000/pages/1",
+    "next": "http://localhost:3000/pages/3",
+    "last": "http://localhost:3000/pages/3",
+    "read": "http://localhost:3000/pages/2"
+  },
+  "size": 3,
+  "model_as": [
+    {
+
+    }
+  ]
+}

data/spec/sequencescape-api/contracts/results-page-3.txt

@@ -0,0 +1,17 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "actions": {
+    "first": "http://localhost:3000/pages/1",
+    "previous": "http://localhost:3000/pages/2",
+    "last": "http://localhost:3000/pages/3",
+    "read": "http://localhost:3000/pages/3"
+  },
+  "size": 3,
+  "model_as": [
+    {
+
+    }
+  ]
+}

data/spec/sequencescape-api/contracts/retrieve-belongs-to-association.txt

@@ -0,0 +1,3 @@
+GET /BELONGS_TO_UUID HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-model.txt

@@ -0,0 +1,4 @@
+GET /UUID HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie
+

data/spec/sequencescape-api/contracts/retrieve-results-page-1.txt

@@ -0,0 +1,3 @@
+GET /pages/1 HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-results-page-2.txt

@@ -0,0 +1,3 @@
+GET /pages/2 HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-results-page-3.txt

@@ -0,0 +1,3 @@
+GET /pages/3 HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-root-with-an-authorised-client.txt

@@ -0,0 +1,5 @@
+GET / HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie
+X-Sequencescape-Client-Id: authorised!
+

data/spec/sequencescape-api/contracts/retrieve-root-with-an-unauthorised-client.txt

@@ -0,0 +1,4 @@
+GET / HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie
+

data/spec/sequencescape-api/contracts/retrieve-unauthorised-model-a-list.txt

@@ -0,0 +1,4 @@
+GET /model_a HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie
+

data/spec/sequencescape-api/contracts/retrieve-unauthorised-model-b-list.txt

@@ -0,0 +1,4 @@
+GET /model_b HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie
+

data/spec/sequencescape-api/contracts/retrieve-unauthorised-model-c-list.txt

@@ -0,0 +1,4 @@
+GET /model_c HTTP/1.1
+Accept: application/json
+Cookie: WTSISignOn=single-sign-on-cookie
+

data/spec/sequencescape-api/contracts/root-response-for-authorised-client.txt

@@ -0,0 +1,20 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "revision": 2,
+
+  "model_c": {
+    "actions": {
+      "read": "http://localhost:3000/model_c/read",
+      "create": "http://localhost:3000/model_c/create",
+      "update": "http://localhost:3000/model_c/update",
+      "foo": "http://localhost:3000/model_c/bar"
+    }
+  },
+  "model_d": {
+    "actions": {
+      "read": "http://localhost:3000/model_d"
+    }
+  }
+}

data/spec/sequencescape-api/contracts/root-response-for-unauthorised-client.txt

@@ -0,0 +1,28 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "revision": 2,
+
+  "model_a": {
+    "actions": {
+      "read": "http://localhost:3000/model_a"
+    }
+  },
+  "model_b": {
+    "actions": {
+      "read": "http://localhost:3000/model_b"
+    }
+  },
+  "model_c": {
+    "actions": {
+      "read": "http://localhost:3000/model_c",
+      "create": "http://localhost:3000/model_c/create"
+    }
+  },
+  "pages": {
+    "actions": {
+      "read": "http://localhost:3000/pages/1"
+    }
+  }
+}

data/spec/sequencescape-api/contracts/unauthorised-model-a-list.txt

@@ -0,0 +1,15 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "actions": {
+    "read": "http://localhost:3000/model_a/1",
+    "first": "http://localhost:3000/model_a/1",
+    "next": "http://localhost:3000/model_a/2",
+    "last": "http://localhost:3000/model_a/3"
+  },
+  "size": 0,
+  "model_a": [
+
+  ]
+}

data/spec/sequencescape-api/contracts/unauthorised-model-b-list.txt

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "actions": {
+    "read": "http://localhost:3000/model_b/1",
+    "first": "http://localhost:3000/model_b/1",
+    "last": "http://localhost:3000/model_b/1"
+  },
+  "size": 0,
+  "model_b": [
+
+  ]
+}

data/spec/sequencescape-api/contracts/unauthorised-model-c-list.txt

@@ -0,0 +1,15 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "actions": {
+    "read": "http://localhost:3000/model_c/1",
+    "first": "http://localhost:3000/model_c/1",
+    "next": "http://localhost:3000/model_c/2",
+    "last": "http://localhost:3000/model_c/3"
+  },
+  "size": 0,
+  "model_c": [
+
+  ]
+}

data/spec/sequencescape-api/contracts/update-invalid-resource.txt

@@ -0,0 +1,10 @@
+PUT /UUID HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Cookie: WTSISignOn=single-sign-on-cookie
+
+{
+  "model_c": {
+    "attribute_validated_at_server": "please error"
+  }
+}

data/spec/sequencescape-api/contracts/update-model-c.txt

@@ -0,0 +1,11 @@
+PUT /UUID HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Cookie: WTSISignOn=single-sign-on-cookie
+
+{
+  "model_c": {
+    "changes_during_update": "sent from client",
+    "write_only": "has been set"
+  }
+}

data/spec/sequencescape-api/finding_methods_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'Finding a resource instance' do
+  is_working_as_an_unauthorised_client
+
+  subject { api.model_c.find('UUID') }
+
+  context 'when it is not found' do
+    stub_request_from('retrieve-model') { response('resource-not-found') }
+
+    it 'raises an exception' do
+      lambda { subject }.should raise_error(Sequencescape::Api::ResourceNotFound)
+    end
+  end
+
+  context 'when it is found' do
+    stub_request_from('retrieve-model') { response('model-c-instance') }
+
+    its(:changes_during_update)      { should == 'from JSON' }
+    its(:remains_same_during_update) { should == 'from JSON' }
+  end
+end
+
+describe 'Finding resource instances' do
+  is_working_as_an_unauthorised_client
+
+  stub_request_and_response('results-page-1')
+  stub_request_and_response('results-page-2')
+  stub_request_and_response('results-page-3')
+
+  subject { api.page.all }
+
+  it_behaves_like 'a paged result'
+end

data/spec/sequencescape-api/modifications_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+shared_examples_for 'errors on both client and server' do |action, request_contract|
+  context 'may be invalid on the client side' do
+    it 'raises an error' do
+      lambda do
+        target.__send__(action, :attribute_validated_at_client => 'please error')
+      end.should raise_error(Sequencescape::Api::ResourceInvalid)
+    end
+
+    it 'includes the error on the field' do
+      begin
+        target.__send__(action, :attribute_validated_at_client => 'please error')
+      rescue Sequencescape::Api::ResourceInvalid => exception
+        exception.resource.errors[:attribute_validated_at_client].should == [ 'cannot be set' ]
+      end
+    end
+  end
+
+  context 'may be invalid on the server side' do
+    stub_request_from(request_contract) { response('model-c-invalid-attribute') }
+
+    it 'raises an error' do
+      lambda do
+        target.__send__(action, :attribute_validated_at_server => 'please error')
+      end.should raise_error(Sequencescape::Api::ResourceInvalid)
+    end
+
+    it 'includes the error on the field' do
+      begin
+        target.__send__(action, :attribute_validated_at_server => 'please error')
+      rescue Sequencescape::Api::ResourceInvalid => exception
+        exception.resource.errors[:attribute_validated_at_server].should == [ 'cannot be set' ]
+      end
+    end
+  end
+end
+
+describe 'Creating a resource' do
+  is_working_as_an_unauthorised_client
+
+  let(:target) { api.model_c }
+
+  context do
+    it_behaves_like 'errors on both client and server', :create!, 'create-invalid-resource'
+  end
+
+  context do
+    stub_request_from('create-model-c') { response('model-c-instance-created') }
+
+    subject do
+      target.create!(:changes_during_update => 'sent from client', :remains_same_during_update => 'from JSON')
+    end
+
+    its(:changes_during_update)      { should == 'set during create' }
+    its(:remains_same_during_update) { should == 'and this was too' }
+  end
+
+  context 'with its associations' do
+    context 'belongs_to' do
+      it 'takes an object and converts it to UUID'
+    end
+    context 'has_many disposition: :inline' do
+      stub_request_from('create-model-c-has-many-inline') { response('model-c-instance-created') }
+
+      it 'takes an array of objects and converts them to UUID'
+      it 'assumes an array of strings are UUIDs' do
+        target.create!(:model_bs => ['model-b-uuids'])
+      end
+      it 'raises if not given an enumerable'
+    end
+
+    context 'has_many disposition: :inline nested' do
+      stub_request_from('create-model-c-has-many-inline-nested') { response('model-c-instance-created') }
+
+      it 'takes an array of objects and converts them to UUID'
+      it 'assumes an array of strings are UUIDs' do
+        target.create!(:model_bs => [{ "test_attribute" => "test_value" }])
+      end
+      it 'raises if not given an enumerable'
+    end
+
+    context 'has_many' do
+      stub_request_from('create-model-c-has-many') { response('model-c-instance-created') }
+
+      it 'takes an array of objects and converts them to UUID'
+      it 'assumes an array of strings are UUIDs' do
+        target.create!(:model_as => ['model-a-uuids'])
+      end
+      it 'raises if not given an enumerable'
+    end
+  end
+
+  context 'through an association' do
+    context 'has_many' do
+      it 'ensures that the instance becomes part of the association'
+    end
+  end
+end
+
+describe 'Updating a resource' do
+  is_working_as_an_unauthorised_client
+
+  stub_request_from('retrieve-model') { response('model-c-instance') }
+  let(:target) { api.model_c.find('UUID') }
+
+  context do
+    it_behaves_like 'errors on both client and server', :update_attributes!, 'update-invalid-resource'
+  end
+
+  shared_examples_for 'it is updating a resource' do
+    subject { target }
+
+    its(:changes_during_update)      { should == 'changed' }
+    its(:remains_same_during_update) { should == 'stays the same' }
+  end
+
+  context '#update_attributes!' do
+    stub_request_from('update-model-c') { response('model-c-instance-updated') }
+
+    before(:each) do
+      subject.update_attributes!(
+        :changes_during_update => 'sent from client',
+        :remains_same_during_update => 'from JSON',
+        :write_only => 'has been set'
+      )
+    end
+
+    it_behaves_like 'it is updating a resource'
+  end
+
+  context '#save!' do
+    stub_request_from('update-model-c') { response('model-c-instance-updated') }
+
+    before(:each) do
+      subject.changes_during_update      = 'sent from client'
+      subject.remains_same_during_update = 'from JSON'
+      subject.write_only                 = 'has been set'
+      subject.save!
+    end
+
+    it_behaves_like 'it is updating a resource'
+  end
+
+  context 'specifically its associations' do
+    context 'belongs_to' do
+      it 'takes an object and converts it to UUID'
+    end
+    context 'has_many' do
+      it 'takes an array of objects and converts them to UUID'
+      it 'assumes an array of strings are UUIDs'
+      it 'raises if not given an enumerable'
+    end
+  end
+end
+
+describe 'Updating a resource through an association' do
+  is_working_as_an_unauthorised_client
+
+  context 'belongs_to' do
+    it 'handles individual attribute changes'
+    it 'handles update_attributes!'
+  end
+
+  context 'has_many' do
+    it 'handles individual attribute changes'
+  end
+end
+