fulcrum 0.1.2

data/spec/lib/photo_spec.rb

@@ -0,0 +1,94 @@
+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
+
+    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)
+        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 => 200, :body => '{"photo":{}}')
+        r = Fulcrum::Photo.delete(photo_id)
+        Fulcrum::Photo.response.status.should eq(200)
+        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
+
+    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
+
+    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)
+        p.keys.should include(:error)
+        p[:error][:status].should eq(404)
+      end
+    end
+
+    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)
+        p = Fulcrum::Photo.delete(photo_id)
+        p.keys.should include(:error)
+        p[:error][:status].should eq(404)
+      end
+    end
+  end
+end

data/spec/lib/record_spec.rb

@@ -0,0 +1,120 @@
+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
+
+    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 => 200, :body => '{"record":{}}')
+        r = Fulcrum::Record.delete(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
+  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
+
+    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
+
+    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)
+        r = Fulcrum::Record.delete(record_id)
+        r.keys.should include(:error)
+        r[:error][:status].should eq(404)
+      end
+    end
+  end
+end

data/spec/lib/validators/choice_list_validator_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Fulcrum::ChoiceListValidator do
+  
+  describe '#validates!' do
+    it 'should not be valid without a choice_list hash' do
+      data = {}
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should_not be_valid
+    end
+    
+    it 'should not be valid if choice_list is not a hash' do
+      data = { 'choice_list' => nil }
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should_not be_valid
+    end
+    
+    it 'should not be valid without an empty choice_list hash' do
+      data = { 'choice_list' => {}}
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should_not be_valid
+    end
+    
+    it 'should not be valid without a name' do
+      data = { 'choice_list' => { 'name' => '' } }
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['choice_list']['name'].should_not be_blank
+    end
+    
+    it 'should not be valid without any choices' do
+      data = { 'choice_list' => { 'name' => 'foobar' } }
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['choice_list']['choices'].should_not be_blank
+    end
+    
+    it 'should not be valid with a non array choices element' do
+      data = { 'choice_list' => { 'name' => 'foobar', 'choices'=> {} } }
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['choice_list']['choices'].should_not be_blank
+    end
+
+    it 'should not be valid with an empty choices array' do
+      data = { 'choice_list' => { 'name' => 'foobar', 'choices'=> [] } }
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['choice_list']['choices'].should_not be_blank
+    end
+
+    it 'should not be valid with an empty choice' do
+      data = { 'choice_list' => { 'name' => 'foobar', 'choices'=> [{}] } }
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['choices']['choice'].should_not be_blank
+    end
+    
+    it 'should not be valid with a choice that does not have label' do
+      data = { 'choice_list' => { 'name' => 'foobar', 'choices'=> [{ 'foo' => 'bar' }] } }
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['choice']['label'].should_not be_blank
+    end
+    
+    it 'should be valid' do
+      data = { 'choice_list' => { 'name' => 'foobar', 'choices'=> [{ 'label' => 'foo' }] } }
+      validator = Fulcrum::ChoiceListValidator.new(data)
+      validator.should be_valid
+      validator.errors.should be_empty
+    end
+  end
+end

data/spec/lib/validators/classification_set_validator_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Fulcrum::ClassificationSetValidator do
+  
+  describe '#validates!' do
+    it 'should not be valid without a classification_set hash' do
+      data = {}
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+    end
+    
+    it 'should not be valid if classification_set is not a hash' do
+      data = { 'classification_set' => nil }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+    end
+    
+    it 'should not be valid without an empty classification_set hash' do
+      data = { 'classification_set' => {}}
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+    end
+    
+    it 'should not be valid without a name' do
+      data = { 'classification_set' => { 'name' => '' } }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['classification_set']['name'].should_not be_blank
+    end
+    
+    it 'should not be valid without any items' do
+      data = { 'classification_set' => { 'name' => 'foobar' } }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['classification_set']['items'].should_not be_blank
+    end
+    
+    it 'should not be valid with a non array items element' do
+      data = { 'classification_set' => { 'name' => 'foobar', 'items'=> {} } }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['classification_set']['items'].should_not be_blank
+    end
+    
+    it 'should not be valid with an empty items array' do
+      data = { 'classification_set' => { 'name' => 'foobar', 'items'=> [] } }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['classification_set']['items'].should_not be_blank
+    end
+    
+    it 'should not be valid with an empty item' do
+      data = { 'classification_set' => { 'name' => 'foobar', 'items'=> [{}] } }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['items']['item'].should_not be_blank
+    end
+    
+    it 'should not be valid with a item that does not have label' do
+      data = { 'classification_set' => { 'name' => 'foobar', 'items'=> [{ 'foo' => 'bar' }] } }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['item']['label'].should_not be_blank
+    end
+    
+    it 'should be valid with a good classification set item' do
+      data = { 'classification_set' => { 'name' => 'foobar', 'items'=> [{ 'label' => 'foo' }] } }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should be_valid
+      validator.errors.should be_empty
+    end
+    
+    # child classifications
+    it 'should not be valid if an item has an empty child classifications' do
+      data = { 'classification_set' => { 'name' => 'foobar', 'items'=> [{ 'label' => 'bar', 'child_classifications' => [] }] } }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['child_classification']['item'].should_not be_blank
+    end
+    
+    it 'should be valid with good child classifications' do
+      data = { 'classification_set' => { 'name' => 'foobar', 'items'=> [{ 'label' => 'bar', 'child_classifications' => [{ 'label' => 'foo'}] }] } }
+      validator = Fulcrum::ClassificationSetValidator.new(data)
+      validator.should be_valid
+      validator.errors.should be_empty
+    end
+  end
+end

data/spec/lib/validators/form_validator_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Fulcrum::FormValidator do
+end

data/spec/lib/validators/record_validator_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Fulcrum::RecordValidator do
+  describe '#validates!' do
+    it 'should not be valid without a record hash' do
+      data = {}
+      validator = Fulcrum::RecordValidator.new(data)
+      validator.should_not be_valid
+    end
+    
+    it 'should not be valid if record is not a hash' do
+      data = { 'record' => nil }
+      validator = Fulcrum::RecordValidator.new(data)
+      validator.should_not be_valid
+    end
+    
+    it 'should not be valid without a form_id' do
+      data = { 'record' => { 'form_id' => '' } }
+      validator = Fulcrum::RecordValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['record']['form_id'].should_not be_blank
+    end
+    
+    it 'should not be valid if form_values is not a hash' do
+      data = { 'record' => { 'form_id' => 'foobar', 'form_values' => nil } }
+      validator = Fulcrum::RecordValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['record']['form_values'].should_not be_blank
+    end
+
+    it 'should not be valid if form_values is empty' do
+      data = { 'record' => { 'form_id' => 'foobar', 'form_values' => {} } }
+      validator = Fulcrum::RecordValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['record']['form_values'].should_not be_blank
+    end
+    
+    it 'should not be valid with invalid coordinates' do
+      data = { 'record' => { 'form_id' => 'foobar', 'form_values' => { 'foo' => 'bar'}, 'latitude' => '0', 'longitude' => '0' } }
+      validator = Fulcrum::RecordValidator.new(data)
+      validator.should_not be_valid
+      validator.errors['record']['coordinates'].should_not be_blank
+    end
+    
+    it 'should be valid' do
+      data = { 'record' => { 'form_id' => 'foobar', 'form_values' => { 'foo' => 'bar'}, 'latitude' => '1.0', 'longitude' => '1.0' } }
+      validator = Fulcrum::RecordValidator.new(data)
+      validator.should be_valid
+      validator.errors.should be_empty
+    end
+  end
+end
+  

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+require 'webmock/rspec'
+require 'fulcrum'
+require 'debugger'
+

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: fulcrum
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Chris Hall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70332002261400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70332002261400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70332002260640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70332002260640
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70332002260060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70332002260060
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: &70332002259620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70332002259620
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70332002259100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70332002259100
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70332002258540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70332002258540
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70332002258000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70332002258000
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70332002257480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70332002257480
+description: Fulcrum API Gem
+email:
+- chris@spatialnetworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fulcrum.gemspec
+- lib/fulcrum.rb
+- lib/fulcrum/api.rb
+- lib/fulcrum/choice_list.rb
+- lib/fulcrum/classification_set.rb
+- lib/fulcrum/form.rb
+- lib/fulcrum/member.rb
+- lib/fulcrum/photo.rb
+- lib/fulcrum/record.rb
+- lib/fulcrum/validators/base_validator.rb
+- lib/fulcrum/validators/choice_list_validator.rb
+- lib/fulcrum/validators/classification_set_validator.rb
+- lib/fulcrum/validators/form_validator.rb
+- lib/fulcrum/validators/record_validator.rb
+- lib/fulcrum/version.rb
+- spec/data/form_data.json
+- spec/data/test.jpg
+- spec/lib/api_spec.rb
+- spec/lib/choice_list_spec.rb
+- spec/lib/classification_set_spec.rb
+- spec/lib/form_spec.rb
+- spec/lib/member_spec.rb
+- spec/lib/photo_spec.rb
+- spec/lib/record_spec.rb
+- spec/lib/validators/choice_list_validator_spec.rb
+- spec/lib/validators/classification_set_validator_spec.rb
+- spec/lib/validators/form_validator_spec.rb
+- spec/lib/validators/record_validator_spec.rb
+- spec/spec_helper.rb
+homepage: http://docs.fulcrumapp.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Fulcrum API Gem
+test_files:
+- spec/data/form_data.json
+- spec/data/test.jpg
+- spec/lib/api_spec.rb
+- spec/lib/choice_list_spec.rb
+- spec/lib/classification_set_spec.rb
+- spec/lib/form_spec.rb
+- spec/lib/member_spec.rb
+- spec/lib/photo_spec.rb
+- spec/lib/record_spec.rb
+- spec/lib/validators/choice_list_validator_spec.rb
+- spec/lib/validators/classification_set_validator_spec.rb
+- spec/lib/validators/form_validator_spec.rb
+- spec/lib/validators/record_validator_spec.rb
+- spec/spec_helper.rb