capsule_crm 1.2.0 → 1.3.0

data/spec/lib/capsule_crm/track_spec.rb

@@ -7,19 +7,5 @@ describe CapsuleCRM::Track do
     it { should validate_numericality_of(:id) }
   end
 
-  describe '.all' do
-    before do
-      stub_request(:get, /\/api\/tracks$/).
-        to_return(body: File.read('spec/support/tracks.json'))
-    end
-
-    subject { CapsuleCRM::Track.all }
-
-    it { expect(subject).to be_a(Array) }
-    it { expect(subject.length).to eql(2) }
-    it { expect(subject.first).to be_a(CapsuleCRM::Track) }
-    it { expect(subject.first.description).to eql('Sales follow up') }
-    it { expect(subject.first.capture_rule).to eql('OPPORTUNITY') }
-    it { expect(subject.first.id).to eql(1) }
-  end
+  it_behaves_like 'listable', '/tracks', 'tracks', 2
 end

data/spec/lib/capsule_crm/user_spec.rb

@@ -3,18 +3,5 @@ require 'spec_helper'
 describe CapsuleCRM::User do
   before { configure }
 
-  describe '.all' do
-    before do
-      stub_request(:get, /\/api\/users$/).
-        to_return(body: File.read('spec/support/all_users.json'))
-    end
-
-    subject { CapsuleCRM::User.all }
-
-    it { should be_a(Array) }
-
-    it { subject.length.should eql(2) }
-
-    it { subject.all? { |item| item.is_a?(CapsuleCRM::User) }.should be_true }
-  end
+  it_behaves_like 'listable', '/users', 'users', 2
 end

data/spec/support/custom_field_definitions.json

@@ -0,0 +1,19 @@
+{
+  "customFieldDefinitions": {
+    "customFieldDefinition": [
+      {
+        "id": "1",
+        "tag": "Staff",
+        "label": "NI Number",
+        "type": "Text",
+        "options": "^[A-CEGHJ-PR-TW-Z]{1}[A-CEGHJ-NPR-TW-Z]{1}[0-9]{6}[A-DFM]{0,1}$"
+      },
+      {
+        "id": "1",
+        "label": "Lead Source",
+        "type": "List",
+        "options": "website;newsletter"
+      }
+    ]
+  }
+}

data/spec/support/helpers.rb

@@ -1,8 +1,9 @@
 module Helpers
   def configure
     CapsuleCRM.configure do |c|
-      c.api_token = '1234'
-      c.subdomain = 'company'
+      c.api_token       = '1234'
+      c.subdomain       = 'company'
+      c.perform_logging = false
     end
   end
 end

data/spec/support/no_cases.json

@@ -0,0 +1,5 @@
+{
+  "kases": {
+    "@size": "0"
+  }
+}

data/spec/support/no_countries.json

@@ -0,0 +1,5 @@
+{
+  "countries": {
+    "@size": "0"
+  }
+}

data/spec/support/no_currencies.json

@@ -0,0 +1,5 @@
+{
+  "currencies": {
+    "@size": "0"
+  }
+}

data/spec/support/no_milestones.json

@@ -0,0 +1,5 @@
+{
+  "milestones": {
+    "@size": "0"
+  }
+}

data/spec/support/no_opportunities.json

@@ -0,0 +1,5 @@
+{
+  "opportunities": {
+    "@size": "0"
+  }
+}

data/spec/support/no_tasks.json

@@ -0,0 +1,5 @@
+{
+  "tasks": {
+    "@size": "0"
+  }
+}

data/spec/support/no_tracks.json

@@ -0,0 +1,5 @@
+{
+  "tracks": {
+    "@size": "0"
+  }
+}

data/spec/support/no_users.json

@@ -0,0 +1,5 @@
+{
+  "users": {
+    "@size": "0"
+  }
+}

data/spec/support/shared_examples/deletable.rb

@@ -0,0 +1,15 @@
+shared_examples 'deletable' do
+  subject { described_class.new(id: Random.rand(1..10)) }
+  before do
+    stub_request(:delete, /.*/).to_return(status: 200)
+    subject.destroy
+  end
+
+  it 'should not be persisted' do
+    expect(subject.persisted?).to eql(false)
+  end
+
+  it 'should not have ID' do
+    expect(subject.id).to be_blank
+  end
+end

data/spec/support/shared_examples/find_all.rb

@@ -0,0 +1,34 @@
+shared_examples 'listable' do |path, file_name, item_count|
+  before do
+    stub_request(:get, /\/api#{path}$/).to_return(body: response)
+  end
+  subject { described_class.all }
+
+  context "when there are some #{described_class.to_s.demodulize.downcase.pluralize}" do
+    let(:response) { File.read("spec/support/all_#{file_name}.json") }
+
+    it 'should be an array' do
+      expect(subject).to be_a(Array)
+    end
+
+    it "should contain #{item_count} items" do
+      expect(subject.length).to eql(item_count)
+    end
+
+    it "should only contain #{described_class} objects" do
+      expect(subject.all? { |item| item.is_a?(described_class) }).to eql(true)
+    end
+  end
+
+  context "when there are no #{described_class.to_s.demodulize.downcase.pluralize}" do
+    let(:response) { File.read("spec/support/no_#{file_name}.json") }
+
+    it 'should be an array' do
+      expect(subject).to be_a(Array)
+    end
+
+    it "should contain 0 items" do
+      expect(subject.length).to eql(0)
+    end
+  end
+end

data/spec/support/shared_examples/find_one.rb

@@ -0,0 +1,23 @@
+shared_examples 'findable' do |path, id, file_name|
+  let(:response) { File.read("spec/support/#{file_name}.json") }
+  let(:url) { "https://1234:@company.capsulecrm.com#{path}" }
+  before do
+    stub_request(:get, url).to_return(body: response)
+  end
+
+  subject { described_class.find(id) }
+
+  it "should be a #{described_class}" do
+    expect(subject).to be_a(described_class)
+  end
+
+  it 'should populate the attributes from the response' do
+    attributes.each do |key, value|
+      expect(subject.send(key)).to eql(value)
+    end
+  end
+
+  it "should return an instance of #{described_class}" do
+    expect(subject).to be_a(described_class)
+  end
+end

data/spec/support/shared_examples/persistable.rb

@@ -0,0 +1,318 @@
+shared_examples 'persistable' do |location, id|
+  describe '.create' do
+    subject { described_class.create attributes }
+    before do
+      stub_request(:post, /.*/).to_return(headers: { 'Location' => location })
+    end
+
+    it "should return an instance of the #{described_class}" do
+      expect(subject).to be_a(described_class)
+    end
+
+    it 'should be persisted' do
+      expect(subject).to be_persisted
+    end
+
+    it 'should populate the ID from the response' do
+      expect(subject.id).to eql(id)
+    end
+
+    if described_class.attributes.map(&:name).include?(:track_id)
+      context "when the #{described_class} has a track" do
+        let(:track) { CapsuleCRM::Track.new(id: Random.rand(1..10)) }
+        subject do
+          described_class.create attributes.merge(track: track)
+        end
+
+        it "should return an instance of #{described_class}" do
+          expect(subject).to be_a(described_class)
+        end
+
+        it 'should append the track ID on to the request path' do
+          expect(WebMock).to have_requested(
+            :post,
+            "https://1234:@company.capsulecrm.com#{subject.build_create_path}"
+          )
+        end
+      end
+    end
+
+    context "when the #{described_class} is not valid" do
+      subject { described_class.create }
+
+      it 'should have errors' do
+        expect(subject.errors).not_to be_blank
+      end
+    end
+  end
+
+  describe '.create!' do
+    context "when the #{described_class} is valid" do
+      subject { described_class.create! attributes }
+      before do
+        stub_request(:post, /.*/).to_return(headers: { 'Location' => location })
+      end
+
+      it "should be a #{described_class}" do
+        expect(subject).to be_a(described_class)
+      end
+
+      it 'should be persisted' do
+        expect(subject).to be_persisted
+      end
+
+      it 'should populate the ID from the response' do
+        expect(subject.id).to eql(id)
+      end
+    end
+
+    context "when the #{described_class} is not valid" do
+      subject { described_class.create! }
+
+      it 'should raise an error' do
+        expect { subject }.to raise_error(CapsuleCRM::Errors::RecordInvalid)
+      end
+    end
+  end
+
+  describe '#update_attributes' do
+    context "when the #{described_class} is valid" do
+      let(:id) { Random.rand(1..10) }
+      subject do
+        Fabricate.build(described_class.to_s.demodulize.downcase.to_sym, id: id)
+      end
+      before do
+        stub_request(:put, /.*/).to_return(status: 200)
+        subject.update_attributes
+      end
+
+      it 'should keep the ID' do
+        expect(subject.id).to eql(id)
+      end
+
+      it 'should send a PUT request' do
+        expect(WebMock).to have_requested(
+          :put,
+          "https://1234:@company.capsulecrm.com#{subject.build_update_path}"
+        )
+      end
+    end
+
+    context "when the #{described_class} is not valid" do
+      subject { described_class.new(id: Random.rand(1..10)) }
+      before { subject.update_attributes }
+
+      it 'should have errors' do
+        expect(subject.errors).not_to be_blank
+      end
+
+      it 'should not send a PUT request' do
+        expect(WebMock).not_to have_requested(
+          :put,
+          "https://1234:@company.capsulecrm.com#{subject.build_update_path}"
+        )
+      end
+    end
+  end
+
+  describe '#update_attributes!' do
+    context "when the #{described_class} is valid" do
+      subject do
+        Fabricate.build described_class.to_s.demodulize.downcase.to_sym, id: id
+      end
+      before do
+        stub_request(:put, /.*/).to_return(status: 200)
+        subject.update_attributes!
+      end
+
+      it 'should send a PUT request' do
+        expect(WebMock).to have_requested(
+          :put,
+          "https://1234:@company.capsulecrm.com#{subject.build_update_path}"
+        )
+      end
+    end
+
+    context "when the #{described_class} is not valid" do
+      subject { described_class.new(id: Random.rand(1..10)).update_attributes! }
+
+      it 'should raise an error' do
+        expect { subject }.to raise_error(CapsuleCRM::Errors::RecordInvalid)
+      end
+    end
+  end
+
+  describe '#save' do
+    context "when the #{described_class} is a new record" do
+      context "when the #{described_class} is valid" do
+        before do
+          stub_request(:post, /.*/).to_return(headers: {
+            'Location' => location
+          }, status: 200)
+        end
+        subject do
+          Fabricate.build described_class.to_s.demodulize.downcase.to_sym
+        end
+        before { subject.save }
+
+        it 'should send a POST request' do
+          expect(WebMock).to have_requested(
+            :post,
+            "https://1234:@company.capsulecrm.com#{subject.build_create_path}"
+          ).with(body: subject.to_capsule_json)
+        end
+      end
+
+      context "when the #{described_class} is not valid" do
+        subject { described_class.new }
+        before { subject.save }
+
+        it 'should not send a POST request' do
+          expect(WebMock).not_to have_requested(
+            :post,
+            "https://1234:@company.capsulecrm.com#{subject.build_create_path}"
+          )
+        end
+
+        it 'should have errors' do
+          expect(subject.errors).not_to be_blank
+        end
+      end
+    end
+
+    context "when the #{described_class} is not a new record" do
+      context "when the #{described_class} is valid" do
+        subject do
+          Fabricate.build described_class.to_s.demodulize.downcase.to_sym,
+            id: Random.rand(1..10)
+        end
+        before do
+          stub_request(:put, /.*/).to_return(status: 200)
+          subject.save
+        end
+
+        it 'should send a PUT request' do
+          expect(WebMock).to have_requested(
+            :put,
+            "https://1234:@company.capsulecrm.com#{subject.build_update_path}"
+          ).with(subject.to_capsule_json)
+        end
+      end
+
+      context "when the #{described_class} is not valid" do
+        subject { described_class.new id: Random.rand(1..10) }
+        before { subject.save }
+
+        it 'should not send a PUT request' do
+          expect(WebMock).not_to have_requested(
+            :put,
+            "https://1234:@company.capsulecrm.com#{subject.build_update_path}"
+          )
+        end
+
+        it 'should have errors' do
+          expect(subject.errors).not_to be_blank
+        end
+      end
+    end
+  end
+
+  describe '#save!' do
+    context "when the #{described_class} is a new record" do
+      context "when the #{described_class} is not valid" do
+        before do
+          stub_request(:post, /.*/).to_return(headers: {
+            'Location' => location
+          }, status: 200)
+        end
+        subject do
+          Fabricate.build described_class.to_s.demodulize.downcase.to_sym
+        end
+        before { subject.save }
+
+        it 'should send a POST request' do
+          expect(WebMock).to have_requested(
+            :post,
+            "https://1234:@company.capsulecrm.com#{subject.build_create_path}"
+          ).with(body: subject.to_capsule_json)
+        end
+
+        it 'should populate the ID from the response' do
+          expect(subject.id).to eql(id)
+        end
+      end
+
+      context "when the #{described_class} is not valid" do
+        subject { described_class.new.save! }
+
+        it 'should raise an error' do
+          expect { subject }.to raise_error(CapsuleCRM::Errors::RecordInvalid)
+        end
+      end
+    end
+
+    context "when the #{described_class} is not a new record" do
+      context "when the #{described_class} is valid" do
+        subject do
+          Fabricate.build described_class.to_s.demodulize.downcase.to_sym,
+            id: Random.rand(1..10)
+        end
+        before do
+          stub_request(:put, /.*/).to_return(status: 200)
+          subject.save!
+        end
+
+        it 'should send a PUT request' do
+          expect(WebMock).to have_requested(
+            :put,
+            "https://1234:@company.capsulecrm.com#{subject.build_update_path}"
+          ).with(body: subject.to_capsule_json)
+        end
+      end
+
+      context "when the #{described_class} is not valid" do
+        subject { described_class.new(id: Random.rand(1..10)).save! }
+
+        it 'should raise an error' do
+          expect { subject }.to raise_error(CapsuleCRM::Errors::RecordInvalid)
+        end
+      end
+    end
+  end
+
+  describe '#new_record?' do
+    context "when the #{described_class} is a new record" do
+      subject { described_class.new.new_record? }
+
+      it 'should be a new record' do
+        expect(subject).to eql(true)
+      end
+    end
+
+    context "when the #{described_class} is not a new record" do
+      subject { described_class.new(id: Random.rand(1..10)).new_record? }
+
+      it 'should not be a new record' do
+        expect(subject).to eql(false)
+      end
+    end
+  end
+
+  describe '#persisted?' do
+    context "when the #{described_class} is persisted" do
+      subject { described_class.new.persisted? }
+
+      it 'should be true' do
+        expect(subject).to eql(false)
+      end
+    end
+
+    context "when the #{described_class} is not persisted" do
+      subject { described_class.new(id: Random.rand(1..10)).persisted? }
+
+      it 'should not be persisted' do
+        expect(subject).to eql(true)
+      end
+    end
+  end
+end

data/spec/support/single_person.json

@@ -0,0 +1,16 @@
+{
+  "parties": {
+    "person": [
+      {
+        "id": "100",
+        "firstName": "Eric",
+        "lastName": "Schmidt"
+      },
+      {
+        "id": "101",
+        "firstName": "Larry ",
+        "lastName": "Page"
+      }
+    ]
+  }
+}