capsule_crm 1.2.0 → 1.3.0

data/spec/lib/capsule_crm/person_spec.rb

@@ -6,6 +6,36 @@ describe CapsuleCRM::Person do
 
   it_should_behave_like 'contactable'
 
+  it_behaves_like 'persistable', 'https://sample.capsulecrm.com/api/person/34', 34 do
+    let(:attributes) { Fabricate.attributes_for(:person) }
+  end
+
+  it_behaves_like 'deletable'
+
+  it_behaves_like 'listable', '/party', 'parties', 2
+
+  it_behaves_like 'findable', '/api/party/12', 12, 'person' do
+    let(:attributes) do
+      {
+        first_name: 'Eric', last_name: 'Schmidt', job_title: 'Chairman',
+        about: 'A comment here'
+      }
+    end
+
+    it 'should get the email address' do
+      expect(subject.emails.first.email_address).
+        to eql('e.schmidt@google.com')
+    end
+
+    it 'should get the phone number' do
+      expect(subject.phones.first.phone_number).to eql('+1 888 555555')
+    end
+
+    it 'should get the website' do
+      expect(subject.websites.first.web_address).to eql('www.google.com')
+    end
+  end
+
   before do
     stub_request(:get, /\/api\/users$/).
       to_return(body: File.read('spec/support/all_users.json'))
@@ -64,276 +94,48 @@ describe CapsuleCRM::Person do
 
   describe '._for_organization' do
     context 'when there are many people for the organization' do
-      pending
-    end
-
-    context 'when there is 1 person for the organization' do
       before do
-        stub_request(:get, /\/api\/party\/1\/people$/).
-          to_return(body: File.read('spec/support/single_user.json'))
+        stub_request(:get, /.*/).
+          to_return(body: File.read('spec/support/all_people.json'))
       end
       subject { CapsuleCRM::Person._for_organization(1) }
 
-      it { should be_a(Array) }
-    end
-
-    context 'when there are no people for the organization' do
-      pending
-    end
-  end
-
-  describe '.all' do
-    before do
-      stub_request(:get, /\/api\/party$/).
-        to_return(body: File.read('spec/support/all_parties.json'))
-    end
-
-    subject { CapsuleCRM::Person.all }
-
-    it { should be_a(Array) }
-
-    it { subject.length.should eql(2) }
-
-    it 'should only contain people' do
-      subject.all? { |item| item.is_a?(CapsuleCRM::Person) }.should be_true
-    end
-  end
-
-  describe '.find' do
-    before do
-      stub_request(:get, /.*/).
-        to_return(body: File.read('spec/support/person.json'))
-    end
-
-    subject { CapsuleCRM::Person.find(1) }
-
-    it { should be_a(CapsuleCRM::Person) }
-
-    it { subject.first_name.should eql('Eric') }
-
-    it { subject.last_name.should eql('Schmidt') }
-  end
-
-  describe '#attributes=' do
-    let(:person) { CapsuleCRM::Person.new }
-
-    before do
-      person.attributes= { firstName: 'Matt', lastName: 'Beedle' }
-    end
-
-    it { person.first_name.should eql('Matt') }
-
-    it { person.last_name.should eql('Beedle') }
-  end
-
-  describe '.create' do
-    context 'when the person is valid' do
-      before do
-        stub_request(:post, /.*/).to_return(headers: {
-          'Location' => 'https://sample.capsulecrm.com/api/party/100'
-        })
+      it 'should be an array' do
+        expect(subject).to be_a(Array)
       end
 
-      subject { CapsuleCRM::Person.create(first_name: 'Eric') }
-
-      it { should be_a(CapsuleCRM::Person) }
-
-      it { subject.id.should eql(100) }
-    end
-
-    context 'when the person is not valid' do
-      subject { CapsuleCRM::Person.create }
-
-      it { subject.errors.should_not be_blank }
-    end
-  end
-
-  describe '.create!' do
-    context 'when the person is valid' do
-      before do
-        stub_request(:post, /.*/).to_return(headers: {
-          'Location' => 'https://sample.capsulecrm.com/api/party/101'
-        })
-      end
-
-      subject { CapsuleCRM::Person.create(first_name: 'Eric') }
-
-      it { should be_a(CapsuleCRM::Person) }
-
-      it { should be_persisted }
-
-      it { subject.id.should eql(101) }
-    end
-
-    context 'when the person is not valid' do
-      it do
-        expect { CapsuleCRM::Person.create! }.
-          to raise_error(CapsuleCRM::Errors::RecordInvalid)
-      end
-    end
-  end
-
-  describe '#update_attributes' do
-    context 'when the person is valid' do
-      before do
-        stub_request(:put, /.*/).to_return(status: 200)
+      it 'should contain 2 items' do
+        expect(subject.length).to eql(2)
       end
-
-      let(:person) { CapsuleCRM::Person.new(id: 1) }
-
-      before { person.update_attributes first_name: 'James' }
-
-      it { person.first_name.should eql('James') }
-
-      it { person.id.should eql(1) }
-    end
-
-    context 'when the person is not valid' do
-      let(:person) { CapsuleCRM::Person.new(id: 1) }
-
-      before { person.update_attributes }
-
-      it { person.should_not be_valid }
-
-      it { person.errors.should_not be_blank }
     end
-  end
-
-  describe '#update_attributes!' do
 
-    let(:person) { CapsuleCRM::Person.new(id: 1) }
-
-    context 'when the person is valid' do
+    context 'when there is 1 person for the organization' do
       before do
-        stub_request(:put, /.*/).to_return(status: 200)
+        stub_request(:get, /\/api\/party\/1\/people$/).
+          to_return(body: File.read('spec/support/single_person.json'))
       end
+      subject { CapsuleCRM::Person._for_organization(1) }
 
-      before { person.update_attributes first_name: 'James' }
-
-      it { person.first_name.should eql('James') }
-
-      it { person.id.should eql(1) }
-    end
-
-    context 'when the person is not valid' do
-      it do
-        expect { person.update_attributes! }.
-          to raise_error(CapsuleCRM::Errors::RecordInvalid)
-      end
+      it { should be_a(Array) }
     end
-  end
 
-  describe '#save' do
-    context 'when the person is a new record' do
+    context 'when there are no people for the organization' do
       before do
-        stub_request(:post, /.*/).to_return(headers: {
-          'Location' => 'https://sample.capsulecrm.com/api/party/100'
-        }, status: 200)
-      end
-
-      let(:person) { CapsuleCRM::Person.new(first_name: 'Eric') }
-
-      before { person.save }
-
-      it { person.first_name.should eql('Eric') }
-
-      it { person.should be_persisted }
-    end
-  end
-
-  describe '#save!' do
-    context 'when the person is a new record' do
-      context 'when the person is valid' do
-        before do
-          stub_request(:post, /.*/).to_return(headers: {
-            'Location' => 'https://sample.capsulecrm.com/api/party/100',
-          }, status: 200)
-        end
-
-        let(:person) { CapsuleCRM::Person.new(first_name: 'Eric') }
-
-        before { person.save! }
-
-        it { person.should be_persisted }
+        stub_request(:get, /.*/).
+          to_return(body: File.read('spec/support/no_parties.json'))
       end
+      subject { CapsuleCRM::Person._for_organization(1) }
 
-      context 'when the person is not valid' do
-        let(:person) { CapsuleCRM::Person.new }
-
-        it do
-          expect { person.save! }.
-            to raise_error(CapsuleCRM::Errors::RecordInvalid)
-        end
+      it 'should be an array' do
+        expect(subject).to be_a(Array)
       end
-    end
-
-    context 'when the person is not a new record' do
-      context 'when the person is not valid' do
 
-        let(:person) { CapsuleCRM::Person.new(id: 1) }
-
-        it do
-          expect { person.save! }.
-            to raise_exception(CapsuleCRM::Errors::RecordInvalid)
-        end
+      it 'should be empty' do
+        expect(subject).to be_empty
       end
     end
   end
 
-  describe '#new_record?' do
-    context 'when the person is a new record' do
-      let(:person) { CapsuleCRM::Person.new }
-
-      subject { person.new_record? }
-
-      it { should be_true }
-    end
-
-    context 'when the person is not a new record' do
-      let(:person) { CapsuleCRM::Person.new(id: 1) }
-
-      subject { person.new_record? }
-
-      it { should be_false }
-    end
-  end
-
-  describe '#persisted?' do
-    context 'when the person is persisted' do
-      let(:person) { CapsuleCRM::Person.new(id: 1) }
-
-      subject { person.persisted? }
-
-      it { should be_true }
-    end
-
-    context 'when the person is not persisted' do
-      let(:person) { CapsuleCRM::Person.new }
-
-      subject { person.persisted? }
-
-      it { should be_false }
-    end
-  end
-
-  describe '.init_collection' do
-    subject do
-      CapsuleCRM::Person.init_collection(
-        JSON.parse(
-          File.read('spec/support/all_parties.json')
-        )['parties']['person']
-      )
-    end
-
-    it { should be_a(Array) }
-
-    it { subject.length.should eql(2) }
-
-    it do
-      subject.all? { |item| item.is_a?(CapsuleCRM::Person) }.should be_true
-    end
-  end
-
   describe '#first_name_required?' do
     let(:person) { CapsuleCRM::Person.new }
 

data/spec/lib/capsule_crm/serializer_spec.rb

@@ -10,19 +10,24 @@ class SerializableTest
   attribute :something, Date
 end
 
+class SerializableInverse
+  include Virtus
+  include CapsuleCRM::Associations
+end
+
 describe CapsuleCRM::Serializer do
   describe '#serialize' do
     let(:options) do
       {}
     end
-    let(:serializer) { described_class.new(object, options) }
+    let(:serializer) { described_class.new(options) }
     let(:object) do
       SerializableTest.new(
         id: Random.rand(1..10), name: Faker::Lorem.word,
         description: Faker::Lorem.word
       )
     end
-    subject { serializer.serialize }
+    subject { serializer.serialize(object) }
 
     context 'without an options' do
       it 'should not include the ID' do
@@ -30,6 +35,18 @@ describe CapsuleCRM::Serializer do
       end
     end
 
+    context 'when include_root is false' do
+      before do
+        options.merge!(include_root: false)
+      end
+
+      it 'should not include the root' do
+        expect(subject).to eql({
+          'name' => object.name, 'description' => object.description
+        })
+      end
+    end
+
     context 'when additional methods are supplied' do
       before do
         options.merge!(additional_methods: [:test])
@@ -65,7 +82,11 @@ describe CapsuleCRM::Serializer do
     context 'when there are belongs to associations' do
       before do
         SerializableTest.send(
-          :belongs_to, :person, class_name: CapsuleCRM::Person
+          :belongs_to, :person, class_name: 'SerializableTest'
+        )
+        SerializableTest.send(
+          :has_many, :things, class_name: 'SerializableTest',
+          source: :person
         )
         object.person = person
       end
@@ -80,7 +101,7 @@ describe CapsuleCRM::Serializer do
       context 'with a serializable key' do
         before do
           SerializableTest.send(
-            :belongs_to, :person, class_name: CapsuleCRM::Person,
+            :belongs_to, :person, class_name: 'CapsuleCRM::Person',
             serializable_key: 'monkeys'
           )
         end

data/spec/lib/capsule_crm/task_spec.rb

@@ -9,265 +9,40 @@ describe CapsuleCRM::Task do
       to_return(body: File.read('spec/support/person.json'))
   end
 
-  describe 'validations' do
-    it { should validate_numericality_of(:id) }
-    it { should validate_presence_of(:description) }
-    it { should validate_presence_of(:due_date) }
-    it { should validate_presence_of(:due_date_time) }
-  end
-
-  describe '.find' do
-    before do
-      stub_request(:get, /\/api\/task\/2$/).
-        to_return(body: File.read('spec/support/task.json'))
-    end
-
-    subject { CapsuleCRM::Task.find(2) }
-
-    it { should be_a(CapsuleCRM::Task) }
-    it { subject.due_date.should_not be_blank }
-    it { subject.category.should eql('Meeting') }
-    it { subject.description.should eql('Meet with customer') }
-    it { subject.detail.should eql('Meeting at Coffee shop') }
-    it { subject.owner.should be_a(CapsuleCRM::User) }
-    it { subject.party.should be_a(CapsuleCRM::Person) }
-  end
-
-  describe '.all' do
-    before do
-      stub_request(:get, /\/api\/tasks$/).
-        to_return(body: File.read('spec/support/all_tasks.json'))
-    end
-
-    subject { CapsuleCRM::Task.all }
-
-    it { should be_a(Array) }
-
-    it do
-      subject.all? { |item| item.is_a?(CapsuleCRM::Task) }.should be_true
-    end
-
-    it { subject.length.should eql(4) }
-
-    it { subject.first.description.should eql('Meet with customer') }
+  it_behaves_like 'persistable', 'https://sample.capsulecrm.com/api/task/91', 91 do
+    let(:attributes) { Fabricate.attributes_for(:task) }
   end
 
-  describe '.create' do
-    let(:location)  { 'https://sample.capsulecrm.com/api/task/59' }
-
-    context 'when it is valid' do
-      before do
-        stub_request(:post, /\/api\/task$/).
-          to_return(headers: { 'Location' => location })
-      end
-
-      subject { CapsuleCRM::Task.create Fabricate.attributes_for(:task) }
-
-      it { should be_a(CapsuleCRM::Task) }
-
-      it { should be_persisted }
-    end
-
-    context 'when it belongs to a party' do
-      before do
-        stub_request(:post, /\/api\/party\/#{party.id}\/task$/).
-          to_return(headers: { 'Location' => location })
-      end
-
-      let(:party) { Fabricate.build(:person, id: 1) }
-
-      subject do
-        CapsuleCRM::Task.create(
-          Fabricate.attributes_for(:task, party: party)
-        )
-      end
+  it_behaves_like 'deletable'
 
-      it { should be_a(CapsuleCRM::Task) }
+  it_behaves_like 'listable', '/tasks', 'tasks', 4
 
-      it { should be_persisted }
+  it_behaves_like 'findable', '/api/task/2', 2, 'task' do
+    let(:attributes) do
+      {
+        category: 'Meeting', description: 'Meet with customer',
+        detail: 'Meeting at Coffee shop'
+      }
     end
 
-    context 'when it belongs to a opportunity' do
-      before do
-        stub_request(:post, /\/api\/opportunity\/#{opportunity.id}\/task$/).
-          to_return(headers: { 'Location' => location })
-      end
-      let(:opportunity) { Fabricate.build(:opportunity, id: 2) }
-      let(:task_attributes) do
-        Fabricate.attributes_for(:task).merge(opportunity: opportunity)
-      end
-      subject { CapsuleCRM::Task.create task_attributes }
-
-      it { should be_a(CapsuleCRM::Task) }
-      it { should be_persisted }
+    it 'should populate the due date' do
+      expect(subject.due_date).not_to be_blank
     end
 
-    context 'when it belongs to a case' do
-      before do
-        stub_request(:post, /\/api\/kase\/#{kase.id}\/task$/).
-          to_return(headers: { 'Location' => location })
-      end
-      let(:kase) { Fabricate.build(:case, id: 5) }
-      let(:task_attributes) do
-        Fabricate.attributes_for(:task).merge(case: kase)
-      end
-      subject { CapsuleCRM::Task.create(task_attributes) }
-
-      it { should be_a(CapsuleCRM::Task) }
-      it { should be_persisted }
-    end
-
-    context 'when it is not valid' do
-      subject { CapsuleCRM::Task.create }
-
-      it { should_not be_persisted }
-    end
-  end
-
-  describe '.create!' do
-    context 'when it is valid' do
-      before do
-        location = 'https://sample.capsulecrm.com/api/task/59'
-        stub_request(:post, /\/api\/task$/).
-          to_return(headers: { 'Location' => location })
-      end
-
-      subject { CapsuleCRM::Task.create! Fabricate.attributes_for(:task) }
-
-      it { should be_a(CapsuleCRM::Task) }
-
-      it { should be_persisted }
+    it 'should populate the owner' do
+      expect(subject.owner).to be_a(CapsuleCRM::User)
     end
 
-    context 'when it is not valid' do
-      subject { CapsuleCRM::Task.create! }
-
-      it do
-        expect { subject }.to raise_error(CapsuleCRM::Errors::RecordInvalid)
-      end
+    it 'should populate the party' do
+      expect(subject.party).to be_a(CapsuleCRM::Person)
     end
   end
 
-  describe '#save' do
-    let(:task) { Fabricate.build(:task) }
-
-    context 'when it is a new record' do
-      before do
-        location = 'https://sample.capsulecrm.com/api/task/59'
-        stub_request(:post, /\/api\/task$/).
-          to_return(headers: { 'Location' => location })
-      end
-
-      subject { task.save }
-
-      it { subject.id.should eql(59) }
-
-      it { should be_persisted }
-    end
-
-    context 'when it is an existing record' do
-      before do
-        task.id = 12
-        stub_request(:put, /\/api\/task\/12$/).to_return(status: 200)
-      end
-
-      subject { task.save }
-
-      it { should be_persisted }
-    end
-
-    context 'when it is invalid' do
-      it { subject.save.should be_false }
-    end
-  end
-
-  describe '#save!' do
-    let(:task) { Fabricate.build(:task) }
-
-    context 'when it is a new record' do
-      before do
-        location = 'https://sample.capsulecrm.com/api/task/59'
-        stub_request(:post, /\/api\/task$/).
-          to_return(headers: { 'Location' => location })
-      end
-
-      subject { task.save! }
-
-      it { subject.id.should eql(59) }
-
-      it { should be_persisted }
-    end
-
-    context 'when it is an existing record' do
-      before do
-        task.id = 12
-        stub_request(:put, /\/api\/task\/12$/).to_return(status: 200)
-      end
-
-      subject { task.save! }
-
-      it { should be_persisted }
-    end
-
-    context 'when it is invalid' do
-      it do
-        expect { subject.save! }.
-          to raise_error(CapsuleCRM::Errors::RecordInvalid)
-      end
-    end
-  end
-
-  describe '#update_attributes' do
-    context 'when it is valid' do
-      let(:task) { Fabricate.build(:task, id: 1) }
-
-      subject { task.update_attributes description: Faker::Lorem.sentence }
-
-      before { stub_request(:put, /\/api\/task\/1$/).to_return(status: 200) }
-
-      it { should be_persisted }
-    end
-
-    context 'when it is not valid' do
-      let(:task) { CapsuleCRM::Task.new(id: 1) }
-
-      subject { task.update_attributes }
-
-      it { should be_false }
-    end
-  end
-
-  describe '#update_attributes!' do
-    context 'when it is valid' do
-      let(:task) { Fabricate.build(:task, id: 1) }
-
-      subject { task.update_attributes! description: Faker::Lorem.sentence }
-
-      before { stub_request(:put, /\/api\/task\/1$/).to_return(status: 200) }
-
-      it { should be_persisted }
-    end
-
-    context 'when it is not valid' do
-      let(:task) { CapsuleCRM::Task.new(id: 1) }
-
-      subject { task.update_attributes! }
-
-      it do
-        expect { subject }.to raise_error(CapsuleCRM::Errors::RecordInvalid)
-      end
-    end
-  end
-
-  describe '#destroy' do
-    subject { Fabricate.build(:task, id: 1) }
-
-    before do
-      stub_request(:delete, /\/api\/task\/1$/).to_return(status: 200)
-      subject.destroy
-    end
-
-    it { should_not be_persisted }
+  describe 'validations' do
+    it { should validate_numericality_of(:id) }
+    it { should validate_presence_of(:description) }
+    it { should validate_presence_of(:due_date) }
+    it { should validate_presence_of(:due_date_time) }
   end
 
   # Not really sure what to test here. CapsuleCRM API doesn't actually tell you
@@ -301,7 +76,6 @@ describe CapsuleCRM::Task do
 
   describe '.categories' do
     subject { CapsuleCRM::Task.categories }
-
     before do
       stub_request(:get, /\/api\/task\/categories$/).
         to_return(body: File.read('spec/support/task_categories.json'))
@@ -318,14 +92,11 @@ describe CapsuleCRM::Task do
     subject { task.to_capsule_json }
 
     it { expect(subject.keys).to include('task') }
-
     it { expect(subject['task']['description']).to eql(task.description) }
-
     it { expect(subject['task']['dueDate']).to eql(task.due_date.to_s) }
 
     context 'when it has an owner' do
       let(:owner) { CapsuleCRM::User.new(username: 'matt.beedle') }
-
       before { task.owner = owner }
 
       it { expect(subject['task']['owner']).to eql(task.owner.username) }