fulcrum 0.1.6 → 0.2.0

data/lib/fulcrum/project.rb

@@ -1,13 +1,7 @@
 module Fulcrum
-  class Project < Api
-
-    class << self
-
-      def all(opts = {})
-        params = parse_opts([:page, :updated_since], opts)
-        call(:get, 'projects.json', params)
-      end
-    end
+  class Project < Resource
+    include Actions::List
+    include Actions::Find
   end
 end
 

data/lib/fulcrum/record.rb

@@ -1,38 +1,9 @@
 module Fulcrum
-  class Record < Api
-
-    class << self
-
-      def all(opts = {})
-        params = parse_opts([:page, :form_id, :project_id, :bounding_box, :updated_since], opts)
-        call(:get, 'records.json', params)
-      end
-
-      def find(id)
-        call(:get, "records/#{id}.json")
-      end
-
-      def create(record)
-        validation = RecordValidator.new(record)
-        if validation.valid?
-          call(:post, 'records.json', record)
-        else
-          { error: { validation: validation.errors } }
-        end
-      end
-
-      def update(id, record)
-        validation = RecordValidator.new(record)
-        if validation.valid?
-          call(:put, "records/#{id}.json", record)
-        else
-          { error: { validation: validation.errors } }
-        end
-      end
-
-      def delete(id)
-        call(:delete, "records/#{id}.json")
-      end
-    end
+  class Record < Resource
+    include Actions::List
+    include Actions::Find
+    include Actions::Create
+    include Actions::Update
+    include Actions::Delete
   end
 end

data/lib/fulcrum/resource.rb

@@ -0,0 +1,40 @@
+module Fulcrum
+  class Resource
+    attr_accessor :client
+
+    def initialize(client)
+      self.client = client
+    end
+
+    def resource_name
+      self.class.to_s.split('::').last.underscore
+    end
+
+    def resources_name
+      resource_name.pluralize
+    end
+
+    def call(method = :get, path = '', params = {})
+      client.call(method, path, params)
+    end
+
+    def collection(format = 'json')
+      "#{resources_name}.#{format}"
+    end
+
+    def member(id, format = 'json')
+      "#{resources_name}/#{id}.#{format}"
+    end
+
+    def member_action(id, action, format = 'json')
+      "#{resources_name}/#{id}/#{action}.#{format}"
+    end
+
+    def attributes_for_object(object)
+      attributes = {}
+      attributes[resource_name] = object
+      attributes
+    end
+  end
+end
+

data/lib/fulcrum/signature.rb

@@ -0,0 +1,15 @@
+module Fulcrum
+  class Signature < MediaResource
+    def default_content_type
+      'image/png'
+    end
+
+    def large(id, &blk)
+      download_version(id, 'large', &blk)
+    end
+
+    def thumbnail(id, &blk)
+      download_version(id, 'thumbnail', &blk)
+    end
+  end
+end

data/lib/fulcrum/version.rb

@@ -1,3 +1,3 @@
 module Fulcrum
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/fulcrum/video.rb

@@ -0,0 +1,23 @@
+module Fulcrum
+  class Video < MediaResource
+    def default_content_type
+      'video/mp4'
+    end
+
+    def create_action
+      'videos/upload'
+    end
+
+    def small(id, &blk)
+      download_version(id, 'small', &blk)
+    end
+
+    def medium(id, &blk)
+      download_version(id, 'medium', &blk)
+    end
+
+    def track(id)
+      call(:get, member_action(id, 'track'))
+    end
+  end
+end

data/spec/client_helper.rb

@@ -0,0 +1,9 @@
+module Support
+  module ClientHelper
+    shared_context "with client" do
+      let!(:client) do
+        Fulcrum::Client.new('apikey', 'http://example.com/api/v2')
+      end
+    end
+  end
+end

data/spec/lib/choice_list_spec.rb

@@ -1,121 +1,16 @@
 require 'spec_helper'
 
-describe Fulcrum::ChoiceList 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 choice_lists' do
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/choice_lists.json").to_return(:status => 200, :body => '{"current_page":1,"total_pages":1,"total_count":1,"per_page":50,"choice_lists":[]}')
-        cls = Fulcrum::ChoiceList.all
-        Fulcrum::ChoiceList.response.status.should eq(200)
-        cls = JSON.parse(cls)
-        cls.keys.should include('current_page')
-        cls.keys.should include('total_pages')
-        cls.keys.should include('total_count')
-        cls.keys.should include('per_page')
-        cls.keys.should include('choice_lists')
-        cls['choice_lists'].should be_a(Array)
-      end
-    end
-
-    context '#retrieve' do
-      it 'should retrieve the specified choice_list and return 200' do
-        cl_id = "abc"
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/choice_lists/#{cl_id}.json").to_return(:status => 200, :body => '{"choice_list":{}}')
-        c = Fulcrum::ChoiceList.find(cl_id)
-        Fulcrum::ChoiceList.response.status.should eq(200)
-        c = JSON.parse(c)
-        c.keys.should include('choice_list')
-        c['choice_list'].should be_a(Hash)
-      end
-    end
-
-    context '#create' do
-      it 'should return created choice_list with status 201' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/choice_lists.json").to_return(:status => 201, :body => '{"choice_list":{}}')
-        Fulcrum::ChoiceListValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::ChoiceList.create({})
-        Fulcrum::ChoiceList.response.status.should eq(201)
-        c = JSON.parse(c)
-        c.keys.should include('choice_list')
-        c['choice_list'].should be_a(Hash)
-      end
-    end
+include Support::ResourceExamples
 
-    context '#update' do
-      it 'should return updated choice_list with status 200' do
-        cl_id = 'abc'
-        stub_request(:put, "#{Fulcrum::Api.configuration.uri}/choice_lists/#{cl_id}.json").to_return(:status => 200, :body => '{"choice_list":{}}')
-        Fulcrum::ChoiceListValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::ChoiceList.update(cl_id, {})
-        Fulcrum::ChoiceList.response.status.should eq(200)
-        c = JSON.parse(c)
-        c.keys.should include('choice_list')
-        c['choice_list'].should be_a(Hash)
-      end
-    end
-
-    context '#delete' do
-      it 'should return deleted choice_list with status 200' do
-        cl_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/choice_lists/#{cl_id}.json").to_return(:status => 204, :body => '{"choice_list":{}}')
-        c = Fulcrum::ChoiceList.delete(cl_id)
-        Fulcrum::ChoiceList.response.status.should eq(204)
-        c = JSON.parse(c)
-        c.keys.should include('choice_list')
-        c['choice_list'].should be_a(Hash)
-      end
-    end
-  end
-
-  describe 'unsuccessful requests' do
-    context '#retrieve' do
-      it 'should receive 404' do
-        cl_id = 'abc'
-        body = { :a => 'b' }
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/choice_lists/#{cl_id}.json").to_return(:status => 404, :body => body)
-        c = Fulcrum::ChoiceList.find(cl_id)
-        c.keys.should include(:error)
-        c[:error][:status].should eq(404)
-      end
-    end
-
-    context '#create' do
-      it 'should receive a 422 response' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/choice_lists.json").to_return(:status => 422)
-        Fulcrum::ChoiceListValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::ChoiceList.create({})
-        c.keys.should include(:error)
-        c[:error][:status].should eq(422)
-      end
-    end
+describe Fulcrum::ChoiceList do
+  include_context 'with client'
+  include_context 'with resource'
 
-    context '#update' do
-      it 'should receive a 422 response' do
-        cl_id = 'abc'
-        stub_request(:put, "#{Fulcrum::Api.configuration.uri}/choice_lists/#{cl_id}.json").to_return(:status => 422)
-        Fulcrum::ChoiceListValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::ChoiceList.update(cl_id, {})
-        c.keys.should include(:error)
-        c[:error][:status].should eq(422)
-      end
-    end
+  let(:resource) { client.choice_lists }
 
-    context '#delete' do
-      it 'should receive a 404 response' do
-        cl_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/choice_lists/#{cl_id}.json").to_return(:status => 404, :body => { :message => "error message"})
-        c = Fulcrum::ChoiceList.delete(cl_id)
-        c.keys.should include(:error)
-        c[:error][:status].should eq(404)
-        c[: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/classification_set_spec.rb

@@ -1,120 +1,17 @@
 require 'spec_helper'
 
-describe Fulcrum::ClassificationSet 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 classification_sets' do
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/classification_sets.json").to_return(:status => 200, :body => '{"current_page":1,"total_pages":1,"total_count":1,"per_page":50,"classification_sets":[]}')
-        css = Fulcrum::ClassificationSet.all
-        Fulcrum::ClassificationSet.response.status.should eq(200)
-        css = JSON.parse(css)
-        css.keys.should include('current_page')
-        css.keys.should include('total_pages')
-        css.keys.should include('total_count')
-        css.keys.should include('per_page')
-        css.keys.should include('classification_sets')
-        css['classification_sets'].should be_a(Array)
-      end
-    end
-
-    context '#retrieve' do
-      it 'should retrieve the specified classification_set and return 200' do
-        cs_id = "abc"
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/classification_sets/#{cs_id}.json").to_return(:status => 200, :body => '{"classification_set":{}}')
-        c = Fulcrum::ClassificationSet.find(cs_id)
-        Fulcrum::ClassificationSet.response.status.should eq(200)
-        c = JSON.parse(c)
-        c.keys.should include('classification_set')
-        c['classification_set'].should be_a(Hash)
-      end
-    end
-
-    context '#create' do
-      it 'should return created classification_set with status 201' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/classification_sets.json").to_return(:status => 201, :body => '{"classification_set":{}}')
-        Fulcrum::ClassificationSetValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::ClassificationSet.create({})
-        Fulcrum::ClassificationSet.response.status.should eq(201)
-        c = JSON.parse(c)
-        c.keys.should include('classification_set')
-        c['classification_set'].should be_a(Hash)
-      end
-    end
-
-    context '#update' do
-      it 'should return updated classification_set with status 200' do
-        cs_id = 'abc'
-        stub_request(:put, "#{Fulcrum::Api.configuration.uri}/classification_sets/#{cs_id}.json").to_return(:status => 200, :body => '{"classification_set":{}}')
-        Fulcrum::ClassificationSetValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::ClassificationSet.update(cs_id, {})
-        Fulcrum::ClassificationSet.response.status.should eq(200)
-        c = JSON.parse(c)
-        c.keys.should include('classification_set')
-        c['classification_set'].should be_a(Hash)
-      end
-    end
+include Support::ResourceExamples
 
-    context '#delete' do
-      it 'should return deleted classification_set with status 200' do
-        cs_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/classification_sets/#{cs_id}.json").to_return(:status => 204, :body => '{"classification_set":{}}')
-        c = Fulcrum::ClassificationSet.delete(cs_id)
-        Fulcrum::ClassificationSet.response.status.should eq(204)
-        c = JSON.parse(c)
-        c.keys.should include('classification_set')
-        c['classification_set'].should be_a(Hash)
-      end
-    end
-  end
-
-  describe 'unsuccessful requests' do
-    context '#retrieve' do
-      it 'should receive 404' do
-        cs_id = 'abc'
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/classification_sets/#{cs_id}.json").to_return(:status => 404)
-        c = Fulcrum::ClassificationSet.find(cs_id)
-        c.keys.should include(:error)
-        c[:error][:status].should eq(404)
-      end
-    end
-
-    context '#create' do
-      it 'should receive a 422 response' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/classification_sets.json").to_return(:status => 422)
-        Fulcrum::ClassificationSetValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::ClassificationSet.create({})
-        c.keys.should include(:error)
-        c[:error][:status].should eq(422)
-      end
-    end
+describe Fulcrum::ClassificationSet do
+  include_context 'with client'
+  include_context 'with resource'
 
-    context '#update' do
-      it 'should receive a 422 response' do
-        cs_id = 'abc'
-        stub_request(:put, "#{Fulcrum::Api.configuration.uri}/classification_sets/#{cs_id}.json").to_return(:status => 422)
-        Fulcrum::ClassificationSetValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::ClassificationSet.update(cs_id, {})
-        c.keys.should include(:error)
-        c[:error][:status].should eq(422)
-      end
-    end
+  let(:resource) { client.classification_sets }
 
-    context '#delete' do
-      it 'should receive a 404 response' do
-        cs_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/classification_sets/#{cs_id}.json").to_return(:status => 404, :body => { :message => "error message"})
-        c = Fulcrum::ClassificationSet.delete(cs_id)
-        c.keys.should include(:error)
-        c[:error][:status].should eq(404)
-        c[: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/client_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Fulcrum::Client do
+  let(:client) { Fulcrum::Client.new }
+
+  it 'has a default url' do
+    client.url.should eq(Fulcrum::Client::DEFAULT_URL)
+  end
+end

data/spec/lib/form_spec.rb

@@ -1,117 +1,16 @@
 require 'spec_helper'
 
-describe Fulcrum::Form 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
-        records = {"current_page" => 1,"total_pages" => 1,"total_count" => 1,"per_page" => 50,"forms" => []}
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/forms.json").to_return(:status => 200, :body => records.to_json)
-        forms = Fulcrum::Form.all
-        Fulcrum::Form.response.status.should eq(200)
-        forms = JSON.parse(forms)
-        forms.should == records
-      end
-    end
-
-    context '#retrieve' do
-      it 'should retrieve the specified record and return 200' do
-        form_id = "abc"
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/forms/#{form_id}.json").to_return(:status => 200, :body => '{"form":{}}')
-        f = Fulcrum::Form.find(form_id)
-        Fulcrum::Form.response.status.should eq(200)
-        f = JSON.parse(f)
-        f.keys.should include('form')
-        f['form'].should be_a(Hash)
-      end
-    end
-
-    context '#create' do
-      it 'should return created form with status 201' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/forms.json").to_return(:status => 201, :body => '{"form":{}}')
-        Fulcrum::FormValidator.any_instance.stub(:validate!).and_return(true)
-        f = Fulcrum::Form.create({})
-        Fulcrum::Form.response.status.should eq(201)
-        f = JSON.parse(f)
-        f.keys.should include('form')
-        f['form'].should be_a(Hash)
-      end
-    end
+include Support::ResourceExamples
 
-    context '#update' do
-      it 'should return updated form with status 200' do
-        form_id = 'abc'
-        stub_request(:put, "#{Fulcrum::Api.configuration.uri}/forms/#{form_id}.json").to_return(:status => 200, :body => '{"form":{}}')
-        Fulcrum::FormValidator.any_instance.stub(:validate!).and_return(true)
-        f = Fulcrum::Form.update(form_id, {})
-        Fulcrum::Form.response.status.should eq(200)
-        f = JSON.parse(f)
-        f.keys.should include('form')
-        f['form'].should be_a(Hash)
-      end
-    end
-
-    context '#delete' do
-      it 'should return deleted form with status 200' do
-        form_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/forms/#{form_id}.json").to_return(:status => 204, :body => '{"form":{}}')
-        f = Fulcrum::Form.delete(form_id)
-        Fulcrum::Form.response.status.should eq(204)
-        f = JSON.parse(f)
-        f.keys.should include('form')
-        f['form'].should be_a(Hash)
-      end
-    end
-  end
-
-  describe 'unsuccessful requests' do
-    context '#retrieve' do
-      it 'should receive 404' do
-        form_id = 'abc'
-        stub_request(:get, "#{Fulcrum::Api.configuration.uri}/forms/#{form_id}.json").to_return(:status => 404)
-        c = Fulcrum::Form.find(form_id)
-        c.keys.should include(:error)
-        c[:error][:status].should eq(404)
-      end
-    end
-
-    context '#create' do
-      it 'should receive a 422 response' do
-        stub_request(:post, "#{Fulcrum::Api.configuration.uri}/forms.json").to_return(:status => 422)
-        Fulcrum::FormValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::Form.create({})
-        c.keys.should include(:error)
-        c[:error][:status].should eq(422)
-      end
-    end
+describe Fulcrum::Form do
+  include_context 'with client'
+  include_context 'with resource'
 
-    context '#update' do
-      it 'should receive a 422 response' do
-        form_id = 'abc'
-        stub_request(:put, "#{Fulcrum::Api.configuration.uri}/forms/#{form_id}.json").to_return(:status => 422)
-        Fulcrum::FormValidator.any_instance.stub(:validate!).and_return(true)
-        c = Fulcrum::Form.update(form_id, {})
-        c.keys.should include(:error)
-        c[:error][:status].should eq(422)
-      end
-    end
+  let(:resource) { client.forms }
 
-    context '#delete' do
-      it 'should receive a 404 response' do
-        form_id = 'abc'
-        stub_request(:delete, "#{Fulcrum::Api.configuration.uri}/forms/#{form_id}.json").to_return(:status => 404, :body => { :message => "error message"})
-        c = Fulcrum::Form.delete(form_id)
-        c.keys.should include(:error)
-        c[:error][:status].should eq(404)
-        c[: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