fulcrum 0.1.6 → 0.2.0

data/spec/lib/layer_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+include Support::ResourceExamples
+
+describe Fulcrum::Layer do
+  include_context 'with client'
+  include_context 'with resource'
+
+  let(:resource) { client.layers }
+
+  include_examples 'list resource'
+  include_examples 'find resource'
+end

data/spec/lib/membership_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+include Support::ResourceExamples
+
+describe Fulcrum::Membership do
+  include_context 'with client'
+  include_context 'with resource'
+
+  let(:resource) { client.memberships }
+
+  include_examples 'list resource'
+end

data/spec/lib/photo_spec.rb

@@ -1,95 +1,16 @@
 require 'spec_helper'
 
-describe Fulcrum::Photo do
-
-  before(:all) do
-    Fulcrum::Api.configure do |config|
-      config.uri = 'http://foo.bar/api/v2'
-      config.key = 'foobar'
-    end
-  end
-
-  describe 'successful requests' do
-    context '#retrieve' do
-      it 'should retrieve the specified photo' do
-        photo_id = 'abc'
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/photos/#{photo_id}.jpg").to_return(:status => 200)
-        Fulcrum::Photo.find('abc', format: 'jpg')
-        Fulcrum::Photo.response.status.should eq(200)
-      end
-    end
-
-    context '#create' do
-      it 'should create a new photo and return status 201' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/photos.json").to_return(:status => 201)
-        pic = File.join(File.dirname(__FILE__), '..', 'data', 'test.jpg')
-        Fulcrum::Photo.create(pic, 'image/*', 'abc', '')
-        Fulcrum::Photo.response.status.should eq(201)
-      end
-    end
+include Support::ResourceExamples
 
-    context '#thumbnail' do
-      it 'should retrieve the photo thumbnail and return status 200' do
-        photo_id = 'abc'
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/photos/#{photo_id}/thumbnail.jpg").to_return(:status => 200)
-        r = Fulcrum::Photo.thumbnail(photo_id, format: 'jpg')
-        Fulcrum::Photo.response.status.should eq(200)
-      end
-    end
-
-    context '#delete' do
-      it 'should delete the photo and return status 200' do
-        photo_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/photos/#{photo_id}.json").to_return(:status => 204, :body => '{"photo":{}}')
-        r = Fulcrum::Photo.delete(photo_id)
-        Fulcrum::Photo.response.status.should eq(204)
-        r = JSON.parse(r)
-        r.keys.should include('photo')
-        r['photo'].should be_a(Hash)
-      end
-    end
-  end
-
-  describe 'unsuccessful requests' do
-    context '#retrieve' do
-      it 'should receive 404' do
-        photo_id = 'abc'
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/photos/#{photo_id}.jpg").to_return(:status => 404)
-        p = Fulcrum::Photo.find(photo_id, format: 'jpg')
-        p.keys.should include(:error)
-        p[:error][:status].should eq(404)
-      end
-    end
+describe Fulcrum::Photo do
+  let(:test_file) { './spec/data/test.jpg' }
 
-    context '#create' do
-      it 'should receive a 422 response' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/photos.json").to_return(:status => 422)
-        pic = File.join(File.dirname(__FILE__), '..', 'data', 'test.jpg')
-        p = Fulcrum::Photo.create(pic, 'image/*', 'abc', '')
-        p.keys.should include(:error)
-        p[:error][:status].should eq(422)
-      end
-    end
+  include_context 'with client'
+  include_context 'with media resource'
 
-    context '#thumbnail' do
-      it 'should receive a 422 response' do
-        photo_id = 'abc'
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/photos/#{photo_id}/thumbnail.jpg").to_return(:status => 404)
-        p = Fulcrum::Photo.thumbnail(photo_id, format: 'jpg')
-        p.keys.should include(:error)
-        p[:error][:status].should eq(404)
-      end
-    end
+  let(:resource) { client.photos }
 
-    context '#delete' do
-      it 'should receive a 404 response' do
-        photo_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/photos/#{photo_id}.json").to_return(:status => 404, :body => { :message => "error message"})
-        p = Fulcrum::Photo.delete(photo_id)
-        p.keys.should include(:error)
-        p[:error][:status].should eq(404)
-        p[:error][:message].should eq({ :message => "error message" })
-      end
-    end
-  end
+  include_examples 'list resource'
+  include_examples 'find resource'
+  include_examples 'create resource'
 end

data/spec/lib/project_spec.rb

@@ -1,29 +1,13 @@
 require 'spec_helper'
 
-describe Fulcrum::Project do
+include Support::ResourceExamples
 
-  before(:all) do
-    Fulcrum::Api.configure do |config|
-      config.uri = 'http://foo.bar/api/v2'
-      config.key = 'foobar'
-    end
-  end
+describe Fulcrum::Project do
+  include_context 'with client'
+  include_context 'with resource'
 
-  describe 'successful requests' do
-    context '#all' do
-      it 'should retrieve all projects' do
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/projects.json").to_return(:status => 200, :body => '{"current_page":1,"total_pages":1,"total_count":1,"per_page":50,"projects":[]}')
-        projects = Fulcrum::Project.all
-        Fulcrum::Project.response.status.should eq(200)
-        projects = JSON.parse(projects)
-        projects.keys.should include('current_page')
-        projects.keys.should include('total_pages')
-        projects.keys.should include('total_count')
-        projects.keys.should include('per_page')
-        projects.keys.should include('projects')
-        projects['projects'].should be_a(Array)
-      end
-    end
-  end
+  let(:resource) { client.projects }
 
+  include_examples 'list resource'
+  include_examples 'find resource'
 end

data/spec/lib/record_spec.rb

@@ -1,121 +1,16 @@
 require 'spec_helper'
 
-describe Fulcrum::Record do
-
-  before(:all) do
-    Fulcrum::Api.configure do |config|
-      config.uri = 'http://foo.bar/api/v2'
-      config.key = 'foobar'
-    end
-  end
-
-  describe 'successful requests' do
-    context '#all' do
-      it 'should retrieve all records' do
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/records.json").to_return(:status => 200, :body => '{"current_page":1,"total_pages":1,"total_count":1,"per_page":50,"records":[]}')
-        records = Fulcrum::Record.all
-        Fulcrum::Record.response.status.should eq(200)
-        records = JSON.parse(records)
-        records.keys.should include('current_page')
-        records.keys.should include('total_pages')
-        records.keys.should include('total_count')
-        records.keys.should include('per_page')
-        records.keys.should include('records')
-        records['records'].should be_a(Array)
-      end
-    end
-
-    context '#retrieve' do
-      it 'should retrieve the specified record' do
-        record_id = 'abc'
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/records/#{record_id}.json").to_return(:status => 200, :body => '{"record":{}}')
-        r = Fulcrum::Record.find('abc')
-        Fulcrum::Record.response.status.should eq(200)
-        r = JSON.parse(r)
-        r.keys.should include('record')
-        r['record'].should be_a(Hash)
-      end
-    end
-
-    context '#create' do
-      it 'should create a new record and return status 201' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/records.json").to_return(:status => 201, :body => '{"record":{}}')
-        Fulcrum::RecordValidator.any_instance.stub(:validate!).and_return(true)
-        r = Fulcrum::Record.create({})
-        Fulcrum::Record.response.status.should eq(201)
-        r = JSON.parse(r)
-        r.keys.should include('record')
-        r['record'].should be_a(Hash)
-      end
-    end
+include Support::ResourceExamples
 
-    context '#update' do
-      it 'should update the record and return status 200' do
-        record_id = 'abc'
-        stub_request(:put, "#{Fulcrum::Api.configuration.uri}/records/#{record_id}.json").to_return(:status => 200, :body => '{"record":{}}')
-        Fulcrum::RecordValidator.any_instance.stub(:validate!).and_return(true)
-        r = Fulcrum::Record.update(record_id, {})
-        Fulcrum::Record.response.status.should eq(200)
-        r = JSON.parse(r)
-        r.keys.should include('record')
-        r['record'].should be_a(Hash)
-      end
-    end
-
-    context '#delete' do
-      it 'should delete the record and return status 200' do
-        record_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/records/#{record_id}.json").to_return(:status => 204, :body => '{"record":{}}')
-        r = Fulcrum::Record.delete(record_id)
-        Fulcrum::Record.response.status.should eq(204)
-        r = JSON.parse(r)
-        r.keys.should include('record')
-        r['record'].should be_a(Hash)
-      end
-    end
-  end
-
-  describe 'unsuccessful requests' do
-    context '#retrieve' do
-      it 'should receive 404' do
-        record_id = 'abc'
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/records/#{record_id}.json").to_return(:status => 404)
-        r = Fulcrum::Record.find(record_id)
-        r.keys.should include(:error)
-        r[:error][:status].should eq(404)
-      end
-    end
-
-    context '#create' do
-      it 'should receive a 422 response' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/records.json").to_return(:status => 422)
-        Fulcrum::RecordValidator.any_instance.stub(:validate!).and_return(true)
-        r = Fulcrum::Record.create({})
-        r.keys.should include(:error)
-        r[:error][:status].should eq(422)
-      end
-    end
+describe Fulcrum::Record do
+  include_context 'with client'
+  include_context 'with resource'
 
-    context '#update' do
-      it 'should receive a 422 response' do
-        record_id = 'abc'
-        stub_request(:put, "#{Fulcrum::Api.configuration.uri}/records/#{record_id}.json").to_return(:status => 422)
-        Fulcrum::RecordValidator.any_instance.stub(:validate!).and_return(true)
-        r = Fulcrum::Record.update(record_id, {})
-        r.keys.should include(:error)
-        r[:error][:status].should eq(422)
-      end
-    end
+  let(:resource) { client.records }
 
-    context '#delete' do
-      it 'should receive a 404 response' do
-        record_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/records/#{record_id}.json").to_return(:status => 404, :body => { :message => "error message"})
-        r = Fulcrum::Record.delete(record_id)
-        r.keys.should include(:error)
-        r[:error][:status].should eq(404)
-        r[:error][:message].should eq({ :message => "error message" })
-      end
-    end
-  end
+  include_examples 'list resource'
+  include_examples 'find resource'
+  include_examples 'create resource'
+  include_examples 'update resource'
+  include_examples 'delete resource'
 end

data/spec/lib/signature_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+include Support::ResourceExamples
+
+describe Fulcrum::Signature do
+  let(:test_file) { './spec/data/test.png' }
+
+  include_context 'with client'
+  include_context 'with media resource'
+
+  let(:resource) { client.signatures }
+
+  include_examples 'list resource'
+  include_examples 'find resource'
+  include_examples 'create resource'
+end

data/spec/lib/video_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+include Support::ResourceExamples
+
+describe Fulcrum::Video do
+  let(:test_file) { './spec/data/test.mp4' }
+
+  include_context 'with client'
+  include_context 'with media resource'
+
+  let(:resource) { client.videos }
+
+  include_examples 'list resource'
+  include_examples 'find resource'
+  include_examples 'create resource'
+end

data/spec/resource_examples.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+include Support::ClientHelper
+
+module Support
+  module ResourceExamples
+    shared_context 'with resource' do
+      let(:resource_object) { {} }
+      let(:create_parameters) { [ resource_object ] }
+    end
+
+    shared_context 'with media resource' do
+      let(:resource_object) { { id: SecureRandom.uuid } }
+      let(:create_parameters) { [ File.open(test_file), nil, { access_key: resource_id } ] }
+    end
+
+    shared_context 'with resource parameters' do
+      let(:resource_id) do
+        'abc'
+      end
+
+      let(:resource_name) do
+        resource.resource_name
+      end
+
+      let(:resources_name) do
+        resource.resources_name
+      end
+
+      let(:collection_url) do
+        "#{client.url}/#{resource.collection}?per_page=#{resource.default_list_params[:per_page]}"
+      end
+
+      let(:member_url) do
+        "#{client.url}/#{resource.member(resource_id)}"
+      end
+
+      let(:show_response) do
+        data = {}
+        data[resource_name] = resource_object
+        data.as_json
+      end
+    end
+
+    shared_examples 'list resource' do
+      include_context 'with client'
+      include_context 'with resource parameters'
+
+      let(:pagination) do
+        { current_page: 1,
+          total_pages: 1,
+          total_count: 1,
+          per_page: 50 }
+      end
+
+      let(:list_response) do
+        data = pagination
+        data[resource.resources_name.to_sym] = []
+        data.as_json
+      end
+
+      it 'should list all resources' do
+        stub_request(:get, collection_url)
+          .to_return(status: 200, body: list_response)
+
+        page = resource.all
+
+        client.response.status.should eq(200)
+
+        page.should respond_to(:current_page)
+        page.should respond_to(:total_pages)
+        page.should respond_to(:total_count)
+        page.should respond_to(:per_page)
+
+        page.objects.should be_a(Array)
+      end
+    end
+
+    shared_examples 'find resource' do
+      include_context 'with client'
+      include_context 'with resource parameters'
+
+      it 'should find a resource' do
+        stub_request(:get, member_url)
+          .to_return(status: 200, body: show_response)
+
+        object = resource.find(resource_id)
+
+        client.response.status.should eq(200)
+
+        object.should be_a(Hash)
+      end
+    end
+
+    shared_examples 'create resource' do
+      include_context 'with client'
+      include_context 'with resource parameters'
+
+      let(:create_url) do
+        "#{client.url}/#{resource.create_action}"
+      end
+
+      it 'should create a new resource' do
+        stub_request(:post, create_url)
+          .to_return(status: 201, body: show_response)
+
+        object = resource.create(*create_parameters)
+
+        client.response.status.should eq(201)
+
+        object.should be_a(Hash)
+      end
+    end
+
+    shared_examples 'update resource' do
+      include_context 'with client'
+      include_context 'with resource parameters'
+
+      it 'should update a resource' do
+        stub_request(:put, member_url)
+          .to_return(status: 200, body: show_response)
+
+        object = resource.update(resource_id, resource_object)
+
+        client.response.status.should eq(200)
+
+        object.should be_a(Hash)
+      end
+    end
+
+    shared_examples 'delete resource' do
+      include_context 'with client'
+      include_context 'with resource parameters'
+
+      it 'should delete a resource' do
+        stub_request(:delete, member_url)
+          .to_return(status: 204, body: show_response)
+
+        object = resource.delete(resource_id)
+
+        client.response.status.should eq(204)
+
+        object.should be_a(Hash)
+      end
+    end
+  end
+end