capsulecrm 0.0.1

data/lib/capsulecrm/contact.rb

@@ -0,0 +1,12 @@
+class CapsuleCRM::Contact < CapsuleCRM::Child
+
+  attr_accessor :type
+
+  # nodoc
+  def self.xml_map
+    map = {'type' => 'type'}
+    super.merge map
+  end
+
+
+end

data/lib/capsulecrm/custom_field.rb

@@ -0,0 +1,41 @@
+class CapsuleCRM::CustomField < CapsuleCRM::Child
+
+  attr_accessor :boolean
+  attr_accessor :date
+  attr_accessor :label
+  attr_accessor :text
+
+
+  # nodoc
+  def boolean=(value)
+    return @boolean = true if value.to_s == 'true'
+    @boolean = false
+  end
+
+
+  # nodoc
+  def date=(value)
+    value = Time.parse(value) if value.is_a?(String)
+    @date = value
+  end
+
+
+  # nodoc
+  def value
+    date || text || boolean
+  end
+
+
+  # nodoc
+  def self.xml_map
+    map = {
+      'label' => 'label',
+      'text' => 'text',
+      'date' => 'date',
+      'boolean' => 'boolean'
+    }
+    super.merge map
+  end
+
+
+end

data/lib/capsulecrm/email.rb

@@ -0,0 +1,15 @@
+class CapsuleCRM::Email < CapsuleCRM::Contact
+
+  attr_accessor :address
+
+
+  # nodoc
+  def self.xml_map
+    map = {
+      'emailAddress' => 'address'
+    }
+    super.merge map
+  end
+
+
+end

data/lib/capsulecrm/organisation.rb

@@ -0,0 +1,41 @@
+class CapsuleCRM::Organisation < CapsuleCRM::Party
+
+  attr_accessor :about
+  attr_accessor :name
+
+
+  # nodoc
+  def people
+    return @people if @people
+    path = self.class.base_path
+    path = [path, '/', id, '/people'].join
+    last_response = self.class.get(path)
+    @people = CapsuleCRM::Person.init_many(last_response)
+  end
+
+
+  # nodoc
+  def self.init_many(response)
+    data = response['parties']['organisation']
+    CapsuleCRM::Collection.new(self, data)
+  end
+
+
+  # nodoc
+  def self.init_one(response)
+    data = response['organisation']
+    new(attributes_from_xml_hash(data))
+  end
+
+
+  # nodoc
+  def self.xml_map
+    map = {
+      'about' => 'about',
+      'name' => 'name'
+    }
+    super.merge map
+  end
+
+
+end

data/lib/capsulecrm/party.rb

@@ -0,0 +1,64 @@
+class CapsuleCRM::Party < CapsuleCRM::Base
+
+
+  # nodoc
+  def addresses
+    return @addresses if @addresses
+    data = raw_data['contacts']['address']
+    @addresses = CapsuleCRM::Address.init_many(self, data)
+  end
+
+
+  # nodoc
+  def custom_fields
+    return @custom_fields if @custom_fields
+    path = self.class.base_path
+    path = [path, '/', id, '/customfield'].join
+    last_response = self.class.get(path)
+    data = last_response['customFields']['customField']
+    @custom_fields = CapsuleCRM::CustomField.init_many(self, data)
+  end
+
+
+  # nodoc
+  def emails
+    return @emails if @emails
+    data = raw_data['contacts']['email']
+    @emails = CapsuleCRM::Email.init_many(self, data)
+  end
+
+
+  # nodoc
+  def phone_numbers
+    return @phone_numbers if @phone_numbers
+    data = raw_data['contacts']['phone']
+    @phone_numbers = CapsuleCRM::Phone.init_many(self, data)
+  end
+
+
+  # nodoc
+  def self.get_path
+    '/api/party'
+  end
+
+
+  def self.find_all_by_email(email, options={})
+    options[:email] = email
+    find_all(options)
+  end
+
+
+  # nodoc
+  def self.find_by_email(email)
+    find_all_by_email(email, :limit => 1, :offset => 0).first
+  end
+
+
+  # nodoc
+  def self.search(query, options={})
+    options[:q] = query
+    find_all(options)
+  end
+
+
+end

data/lib/capsulecrm/person.rb

@@ -0,0 +1,125 @@
+class CapsuleCRM::Person < CapsuleCRM::Party
+
+  attr_accessor :about
+  attr_accessor :first_name
+  attr_accessor :job_title
+  attr_accessor :last_name
+  attr_accessor :organisation_id
+  attr_accessor :title
+
+
+  define_attribute_methods [:about, :first_name, :last_name, :job_title, :organisation_id, :title]
+
+
+  # nodoc
+  def attributes
+    attrs = {}
+    arr = [:about, :first_name, :last_name, :title, :job_title]
+    arr.each do |key|
+      attrs[key] = self.send(key)
+    end
+    attrs
+  end
+
+
+  # nodoc
+  def first_name=(value)
+    first_name_will_change! unless value == first_name
+    @first_name = value
+  end
+
+
+  # nodoc
+  def last_name=(value)
+    last_name_will_change! unless value == last_name
+    @last_name = value
+  end
+
+
+  # nodoc
+  def title=(value)
+    title_will_change! unless value == title
+    @title = value
+  end
+
+
+  # nodoc
+  def organisation
+    return nil if organisation_id.nil?
+    @organisation ||= CapsuleCRM::Organisation.find(organisation_id)
+  end
+
+
+  # nodoc
+  def save
+    new_record?? create : update
+  end
+
+
+  private
+
+
+  # nodoc
+  def create
+    path = '/api/person'
+    options = {:root => 'person', :path => path}
+    new_id = self.class.create dirty_attributes, options
+    unless new_id
+      errors << self.class.last_response.response.message
+      return false
+    end
+    @errors = []
+    changed_attributes.clear
+    self.id = new_id
+    self
+  end
+
+
+  # nodoc
+  def dirty_attributes
+    Hash[attributes.select { |k,v| changed.include? k.to_s }]
+  end
+
+
+  # nodoc
+  def update
+    path = '/api/person/' + id.to_s
+    options = {:root => 'person', :path => path}
+    success = self.class.update id, dirty_attributes, options
+    changed_attributes.clear if success
+    success
+  end
+
+
+  # -- Class methods --
+
+  
+  # nodoc
+  def self.init_many(response)
+    data = response['parties']['person']
+    CapsuleCRM::Collection.new(self, data)
+  end
+
+
+  # nodoc
+  def self.init_one(response)
+    data = response['person']
+    new(attributes_from_xml_hash(data))
+  end
+
+
+  # nodoc
+  def self.xml_map
+    map = {
+      'about' => 'about',
+      'firstName' => 'first_name',
+      'jobTitle' => 'job_title',
+      'lastName' => 'last_name',
+      'organisationId' => 'organisation_id',
+      'title' => 'title'
+    }
+    super.merge map
+  end
+
+
+end

data/lib/capsulecrm/phone.rb

@@ -0,0 +1,15 @@
+class CapsuleCRM::Phone < CapsuleCRM::Contact
+
+  attr_accessor :number
+
+
+  # nodoc
+  def self.xml_map
+    map = {
+      'phoneNumber' => 'number'
+    }
+    super.merge map
+  end
+
+
+end

data/lib/capsulecrm/record_not_found.rb

@@ -0,0 +1 @@
+class CapsuleCRM::RecordNotFound < StandardError; end

data/lib/capsulecrm/version.rb

@@ -0,0 +1,3 @@
+module CapsuleCRM
+  VERSION = "0.0.1"
+end

data/test/create_person_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+class CreatePersonTest < Test::Unit::TestCase
+
+  # nodoc
+  def setup
+  end
+
+
+  # nodoc
+  def test_success
+    VCR.use_cassette('create_person') do
+
+      # save a new object, check for the id
+      person = CapsuleCRM::Person.new
+      person.first_name = 'Homer'
+      person.last_name = 'Simpson'
+      assert person.save
+      assert !person.id.nil?
+
+
+      # check it was persisted
+      person = CapsuleCRM::Person.find person.id
+      assert_equal 'Homer', person.first_name
+      assert_equal 'Simpson', person.last_name
+
+    end
+  end
+
+
+  # nodoc
+  def teardown
+    WebMock.reset!
+  end
+
+
+end

data/test/fixtures/responses/create_person.yml

@@ -0,0 +1,59 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://[API-TOKEN]:x@[ACCOUNT-NAME].capsulecrm.com:443/api/person
+    body: |
+      <?xml version="1.0" encoding="UTF-8"?>
+      <person>
+        <lastName>Simpson</lastName>
+        <firstName>Homer</firstName>
+      </person>
+
+    headers: 
+      content-type: 
+      - text/xml
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 201
+      message: Created
+    headers: 
+      location: 
+      - https://[ACCOUNT-NAME].capsulecrm.com/api/party/10256313
+      content-type: 
+      - text/plain; charset=UTF-8
+      server: 
+      - Apache
+      date: 
+      - Tue, 12 Apr 2011 12:28:36 GMT
+      content-length: 
+      - "0"
+      set-cookie: 
+      - "[SESSION-COOKIE]"
+    body: 
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://[API-TOKEN]:x@[ACCOUNT-NAME].capsulecrm.com:443/api/party/10256313
+    body: 
+    headers: 
+      user-agent: 
+      - CapsuleCRM ruby gem
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - "*/*"
+      server: 
+      - Apache
+      date: 
+      - Tue, 12 Apr 2011 12:28:38 GMT
+      content-length: 
+      - "268"
+      set-cookie: 
+      - "[SESSION-COOKIE]"
+    body: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><person><id>10256313</id><contacts/><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/person_avatar_70.png</pictureURL><firstName>Homer</firstName><lastName>Simpson</lastName></person>
+    http_version: "1.1"

data/test/fixtures/responses/person_find_all.yml

@@ -0,0 +1,28 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://[API-TOKEN]:x@[ACCOUNT-NAME].capsulecrm.com:443/api/party?
+    body: 
+    headers: 
+      user-agent: 
+      - CapsuleCRM ruby gem
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - "*/*"
+      server: 
+      - Apache
+      date: 
+      - Tue, 12 Apr 2011 12:31:18 GMT
+      content-length: 
+      - "3305"
+      set-cookie: 
+      - "[SESSION-COOKIE]"
+    body: |-
+      <?xml version="1.0" encoding="UTF-8" standalone="yes"?><parties size="8"><person><id>9719416</id><contacts><email><id>17716757</id><emailAddress>at@example.com</emailAddress></email></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/person_avatar_70.png</pictureURL><title>Prof</title><firstName>Alan</firstName><lastName>Turing</lastName></person><person><id>10185304</id><contacts><email><id>18565226</id><emailAddress>cd@example.com</emailAddress></email></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/person_avatar_70.png</pictureURL><title>Dr</title><firstName>Charles</firstName><lastName>Darwin</lastName></person><person><id>10185257</id><contacts><address><id>18565068</id><type>Office</type><street>10 Downing Street</street><city>London</city><zip>SW1A 2AA</zip><country>United Kingdom</country></address><email><id>18565066</id><type>Work</type><emailAddress>pm@example.com</emailAddress></email><phone><id>18566503</id><phoneNumber>12345 67890</phoneNumber></phone><website><id>18565067</id><webAddress>http://www.number10.gov.uk/</webAddress><webService>URL</webService><url>http://www.number10.gov.uk/</url></website></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/person_avatar_70.png</pictureURL><title>Mr</title><firstName>David</firstName><lastName>Cameron</lastName><jobTitle>Prime Minister</jobTitle><organisationId>10185256</organisationId><organisationName>UK Government</organisationName></person><organisation><id>10185222</id><contacts/><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/org_avatar_70.png</pictureURL><name>foo.com</name></organisation><person><id>10185308</id><contacts><email><id>18565231</id><emailAddress>mc@example.com</emailAddress></email></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/person_avatar_70.png</pictureURL><title>Ms</title><firstName>Marie</firstName><lastName>Curie</lastName></person><person><id>10185261</id><contacts><address><id>18565115</id><type>Office</type><street>Deputy Prime Minister's Office&#xD;
+      70 Whitehall</street><city>London</city><zip>SW1A 2AS</zip><country>United Kingdom</country></address><email><id>18565116</id><type>Work</type><emailAddress>dpm@example.com</emailAddress></email></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/person_avatar_70.png</pictureURL><title>Mr</title><firstName>Nick</firstName><lastName>Clegg</lastName><jobTitle>Deputy Prime Minister</jobTitle><organisationId>10185256</organisationId><organisationName>UK Government</organisationName></person><person><id>9851220</id><contacts><email><id>18565224</id><emailAddress>tbl@example.com</emailAddress></email></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/person_avatar_70.png</pictureURL><title>Prof</title><firstName>Tim</firstName><lastName>Berners-Lee</lastName></person><organisation><id>10185256</id><contacts><email><id>18583945</id><emailAddress>gov@example.com</emailAddress></email></contacts><pictureURL>https://d365sd3k9yw37.cloudfront.net/a/543325/theme/default/images/org_avatar_70.png</pictureURL><name>UK Government</name></organisation></parties>
+    http_version: "1.1"