agilecrm-wrapper 1.0.0

data/lib/agilecrm-wrapper/error.rb

@@ -0,0 +1,75 @@
+module AgileCRMWrapper
+  class Error < StandardError
+    attr_reader :response
+
+    class << self
+      def from_response(response, message = '')
+        new(response, message)
+      end
+
+      def errors
+        @errors ||= {
+          400 => AgileCRMWrapper::BadRequest,
+          401 => AgileCRMWrapper::Unauthorized,
+          404 => AgileCRMWrapper::NotFound,
+          405 => AgileCRMWrapper::MethodNotAllowed,
+          415 => AgileCRMWrapper::MediaTypeMismatch,
+          500 => AgileCRMWrapper::InternalServerError
+        }
+      end
+    end
+
+    def initialize(response, message = '')
+      super(message)
+      @response = response
+    end
+  end
+
+  # Raised when Twitter returns a 4xx HTTP status code
+  class ClientError < Error; end
+
+  # Raised when AgileCRMWrapper returns a 400 HTTP status code
+  class BadRequest < ClientError
+    def initialize(response, message = 'The request was formatted incorrectly')
+      super(response, message)
+    end
+  end
+
+  # Raised when AgileCRMWrapper returns a 401 HTTP status code
+  class Unauthorized < ClientError
+    def initialize(response, message = 'Invalid API Key')
+      super(response, message)
+    end
+  end
+
+  # Raised when AgileCRMWrapper returns a 404 HTTP status code
+  class NotFound < ClientError
+    def initialize(response, message = 'Resource not found')
+      super(response, message)
+    end
+  end
+
+  # Raised when AgileCRMWrapper returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError
+    def initialize(response, message = 'Invalid method type')
+      super(response, message)
+    end
+  end
+
+  # Raised when AgileCRMWrapper returns a 415 HTTP status code
+  class MediaTypeMismatch < ClientError
+    def initialize(response, message = 'Unsupported Media type')
+      super(response, message)
+    end
+  end
+
+  # Raised when AgileCRMWrapper returns a 5xx HTTP status code
+  class ServerError < Error; end
+
+  # Raised when AgileCRMWrapper returns a 500 HTTP status code
+  class InternalServerError < ServerError
+    def initialize(response, message = 'Server error')
+      super(response, message)
+    end
+  end
+end

data/lib/agilecrm-wrapper/note.rb

@@ -0,0 +1,31 @@
+require 'agilecrm-wrapper/error'
+require 'hashie'
+
+module AgileCRMWrapper
+  class Note < Hashie::Mash
+    class << self
+      def create(*contacts, subject: '', description: '')
+        contacts = contacts.flatten.uniq.map(&:to_s)
+        payload = {
+          'subject' => subject,
+          'description' => description,
+          'contact_ids' => contacts
+        }
+        response = AgileCRMWrapper.connection.post('notes', payload)
+        new(response.body)
+      end
+
+      def add_by_email(email: '', subject: '', description: '')
+        payload = {
+          'subject' => subject,
+          'description' => description
+        }
+        query = "email=#{email}&note=#{payload.to_json}"
+        AgileCRMWrapper.connection.post(
+          'contacts/email/note/add', query,
+          'content-type' => 'application/x-www-form-urlencoded'
+        )
+      end
+    end
+  end
+end

data/lib/agilecrm-wrapper/response/raise_error.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'agilecrm-wrapper/error'
+
+module AgileCRMWrapper
+  module Response
+    class RaiseError < Faraday::Response::Middleware
+      private
+
+      def on_complete(response)
+        status_code = response.status.to_i
+        klass = AgileCRMWrapper::Error.errors[status_code]
+        return unless klass
+        fail(klass.from_response(response))
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware(
+  agilecrm_error: AgileCRMWrapper::Response::RaiseError
+)

data/lib/agilecrm-wrapper/version.rb

@@ -0,0 +1,3 @@
+module AgileCRMWrapper
+  VERSION = '1.0.0'
+end

data/spec/agilecrm-wrapper/agilecrm_wrapper_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe AgileCRMWrapper do
+  let(:domain) { 'mydomain' }
+  let(:api_key) { 'xxx' }
+  let(:email) { 'email@example.com' }
+
+  describe 'configuration' do
+    before(:each) do
+      AgileCRMWrapper.configure do |config|
+        config.domain = domain
+        config.api_key = api_key
+        config.email = email
+      end
+    end
+
+    after :each do
+      AgileCRMWrapper.reset
+    end
+
+    describe '.configure' do
+      it 'has a custom configuration' do
+        expect(AgileCRMWrapper.configuration.domain).to match domain
+        expect(AgileCRMWrapper.configuration.api_key).to match api_key
+        expect(AgileCRMWrapper.configuration.email).to match email
+      end
+
+      its(:endpoint) { should eq 'https://mydomain.agilecrm.com/dev/api' }
+    end
+
+    describe '.reset' do
+      before(:each) do
+        AgileCRMWrapper.configure do |config|
+          config.email = email
+        end
+      end
+
+      it 'resets the configuration' do
+        AgileCRMWrapper.reset
+        config = AgileCRMWrapper.configuration
+        expect(config.email).to eq ''
+      end
+    end
+  end
+end

data/spec/agilecrm-wrapper/contact_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe AgileCRMWrapper::Contact do
+  let(:contact) { AgileCRMWrapper::Contact.find(123) }
+
+  describe '.all' do
+    subject { AgileCRMWrapper::Contact.all }
+
+    it 'should return an array of Contacts' do
+      expect(subject.map(&:class).uniq).to eq([AgileCRMWrapper::Contact])
+    end
+  end
+
+  describe '.find' do
+    let(:id) { 123 }
+    subject { AgileCRMWrapper::Contact.find(id) }
+
+    context 'given an existing contact ID' do
+      it { should be_kind_of(AgileCRMWrapper::Contact) }
+
+      its(:id) { should eq id }
+    end
+
+    context 'given an unknown contact ID' do
+      let(:id) { 0 }
+      it { expect { is_expected.to raise_error(AgileCRMWrapper::NotFound) } }
+    end
+  end
+
+  describe '.delete' do
+    context 'given a single ID' do
+      subject { AgileCRMWrapper::Contact.delete(123) }
+
+      its(:status) { should eq 204 }
+    end
+  end
+
+  describe '.search_by_email' do
+    let(:email) { 'anitadrink@example.com' }
+    subject { AgileCRMWrapper::Contact.search_by_email(email) }
+
+    context 'given an existing email' do
+      it 'should return a contact with the corresponding email' do
+        expect(subject.get_property('email')).to eq email
+      end
+    end
+
+    context 'given an non-existing email' do
+      let(:email) { 'idontexist@example.com' }
+
+      it 'should return an empty array' do
+        expect(subject).to eq nil
+      end
+    end
+  end
+
+  describe '.create' do
+    subject do
+      AgileCRMWrapper::Contact.create(
+        tags: %w(sales, rspec), first_name: 'Anita',
+        last_name: 'Drink', email: 'anitadrink@example.com',
+        custom_field: 'Im a custom field!'
+      )
+    end
+
+    its(:status) { should eq 201 }
+  end
+
+  describe '#notes' do
+    it 'returns the associated notes' do
+      expect(contact.notes.map(&:class).uniq).to eq [AgileCRMWrapper::Note]
+    end
+  end
+
+  describe '#update' do
+
+    it 'updates the receiving contact with the supplied key-value pair(s)' do
+      expect do
+        contact.update(first_name: 'Foo!')
+      end.to change{
+        contact.get_property('first_name')
+      }.from('Anita').to('Foo!')
+    end
+  end
+
+  describe '#get_property' do
+    let(:contact) { AgileCRMWrapper::Contact.find(123) }
+
+    context 'supplied an existing property name' do
+      it 'returns the value' do
+        expect(contact.get_property('email')).to_not be_nil
+      end
+    end
+
+    context 'supplied a non-existing property name' do
+      it 'returns nil' do
+        expect(contact.get_property('nil-propety')).to be_nil
+      end
+    end
+  end
+
+  describe '#destroy' do
+    let(:contact) { AgileCRMWrapper::Contact.find(123) }
+    subject { contact.destroy }
+
+    its(:status) { should eq 204 }
+  end
+end

data/spec/agilecrm-wrapper/note_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AgileCRMWrapper::Note do
+  describe '.create' do
+    it 'creates a new note' do
+      expect(
+        AgileCRMWrapper::Note.create(123, subject: '', description: '')
+      ).to be_kind_of(AgileCRMWrapper::Note)
+    end
+  end
+end

data/spec/fixtures/contacts/create_contact.json

@@ -0,0 +1,45 @@
+{
+  "id": 123,
+  "type": "PERSON",
+  "created_time": 1412704793,
+  "updated_time": 0,
+  "viewed_time": 0,
+  "viewed": {
+    "viewed_time": 0
+  },
+  "star_value": 0,
+  "lead_score": 0,
+  "tags": ["sales", "rspec"],
+  "tagsWithTime": [{
+    "tag": "sales",
+    "createdTime": 1412704793874,
+    "availableCount": 0,
+    "entity_type": "tag"
+  }, {
+    "tag": "rspec",
+    "createdTime": 1412704793874,
+    "availableCount": 0,
+    "entity_type": "tag"
+  }],
+  "properties": [{
+    "type": "SYSTEM",
+    "name": "first_name",
+    "value": "Anita"
+  }, {
+    "type": "SYSTEM",
+    "name": "last_name",
+    "value": "Drink"
+  }, {
+    "type": "SYSTEM",
+    "name": "email",
+    "value": "anitadrink@example.com"
+  }, {
+    "type": "CUSTOM",
+    "name": "custom_field",
+    "value": "Im a custom field!"
+  }],
+  "campaignStatus": [],
+  "entity_type": "contact_entity",
+  "unsubscribeStatus": [],
+  "emailBounceStatus": []
+}

data/spec/fixtures/contacts/get_contact.json

@@ -0,0 +1,45 @@
+{
+  "id": 123,
+  "type": "PERSON",
+  "created_time": 1412704793,
+  "updated_time": 0,
+  "viewed_time": 0,
+  "viewed": {
+    "viewed_time": 0
+  },
+  "star_value": 0,
+  "lead_score": 0,
+  "tags": ["sales", "rspec"],
+  "tagsWithTime": [{
+    "tag": "sales",
+    "createdTime": 1412704793874,
+    "availableCount": 0,
+    "entity_type": "tag"
+  }, {
+    "tag": "rspec",
+    "createdTime": 1412704793874,
+    "availableCount": 0,
+    "entity_type": "tag"
+  }],
+  "properties": [{
+    "type": "SYSTEM",
+    "name": "first_name",
+    "value": "Anita"
+  }, {
+    "type": "SYSTEM",
+    "name": "last_name",
+    "value": "Drink"
+  }, {
+    "type": "SYSTEM",
+    "name": "email",
+    "value": "anitadrink@example.com"
+  }, {
+    "type": "CUSTOM",
+    "name": "custom_field",
+    "value": "Im a custom field!"
+  }],
+  "campaignStatus": [],
+  "entity_type": "contact_entity",
+  "unsubscribeStatus": [],
+  "emailBounceStatus": []
+}

data/spec/fixtures/contacts/get_contact_notes.json

@@ -0,0 +1,52 @@
+[{
+  "id": 80001,
+  "created_time": 1360561958,
+  "subject": "Note subject",
+  "description": "Note description",
+  "contacts": [{
+    "id": 123,
+    "type": "PERSON",
+    "created_time": 1412704793,
+    "updated_time": 0,
+    "viewed_time": 0,
+    "viewed": {
+      "viewed_time": 0
+    },
+    "star_value": 0,
+    "lead_score": 0,
+    "tags": ["sales", "rspec"],
+    "tagsWithTime": [{
+      "tag": "sales",
+      "createdTime": 1412704793874,
+      "availableCount": 0,
+      "entity_type": "tag"
+    }, {
+      "tag": "rspec",
+      "createdTime": 1412704793874,
+      "availableCount": 0,
+      "entity_type": "tag"
+    }],
+    "properties": [{
+      "type": "SYSTEM",
+      "name": "first_name",
+      "value": "Anita"
+    }, {
+      "type": "SYSTEM",
+      "name": "last_name",
+      "value": "Drink"
+    }, {
+      "type": "SYSTEM",
+      "name": "email",
+      "value": "anitadrink@example.com"
+    }, {
+      "type": "CUSTOM",
+      "name": "custom_field",
+      "value": "Im a custom field!"
+    }],
+    "campaignStatus": [],
+    "entity_type": "contact_entity",
+    "unsubscribeStatus": [],
+    "emailBounceStatus": []
+  }],
+  "entity_type": "note"
+}]