capsulecrmii 0.0.5

data/lib/capsulecrm/collection.rb

@@ -0,0 +1,14 @@
+class CapsuleCRM::Collection < Array
+
+
+  # nodoc
+  def initialize(klass, data)
+    return if data.nil?
+    [data].flatten.each do |attributes|
+      attributes = klass.attributes_from_xml_hash(attributes)
+      self.push klass.new(attributes)
+    end
+  end
+
+
+end

data/lib/capsulecrm/contact.rb

@@ -0,0 +1,27 @@
+class CapsuleCRM::Contact < CapsuleCRM::Child
+
+  attr_accessor :type
+  define_attribute_methods [:type]
+
+  # nodoc
+  def attributes
+    attrs = {}
+    arr = [:type]
+    arr.each do |key|
+      attrs[key] = self.send(key)
+    end
+    attrs
+  end
+  
+  # nodoc
+  def type=(value)
+    type_will_change! unless value == type
+    @type = value
+  end
+  
+  # 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,64 @@
+class CapsuleCRM::Email < CapsuleCRM::Contact
+
+  attr_accessor :address
+  define_attribute_methods [:address]
+
+
+  # nodoc
+  def attributes
+    attrs = {}
+    arr = [:address, :type]
+    arr.each do |key|
+      attrs[key] = self.send(key)
+    end
+    attrs
+  end
+  
+  # nodoc
+  def address=(value)
+    address_will_change! unless value == address
+    @address = value
+  end
+  
+  # nodoc
+  def dirty_attributes
+    Hash[attributes.select { |k,v| changed.include? k.to_s }]
+  end
+  
+  def parent_type
+    return "person" if self.parent.class == CapsuleCRM::Person
+    return "organisation" if self.parent.class == CapsuleCRM::Organisation
+    raise "Unknown Parent Type"
+  end
+  
+  # nodoc
+  def save
+    path = ["", "api", parent_type, self.parent.id].join("/")
+    options = {:root => 'person', :path => path}
+    attrs = new_record?? attributes : {:id => id}.merge(dirty_attributes)
+    success = self.class.update id, attrs, options
+    changed_attributes.clear if success
+    success   
+  end
+  
+  # uses xml_map() to convert :attributes into an xml string
+  def self.attributes_to_xml(attributes, root=nil)
+    xml = {"contacts" => {"email" => {}}}
+    map = xml_map.invert
+    attributes.each do |k,v|
+      key = map[k.to_s]
+      xml["contacts"]["email"][key] = v
+    end
+    xml.to_xml :root => root
+  end
+  
+  # nodoc
+  def self.xml_map
+    map = {
+      'emailAddress' => 'address'
+    }
+    super.merge map
+  end
+
+
+end

data/lib/capsulecrm/history.rb

@@ -0,0 +1,32 @@
+module CapsuleCRM::History
+  # Reload history
+  def history!
+    @history = nil
+    history
+  end 
+
+  # Load history if not loaded
+  def history
+    return @history if @history
+
+    path = self.class.get_path
+    path = [path, id, 'history'].join '/'
+    last_response = self.class.get(path)
+    data = last_response['history'].try(:[], 'historyItem')
+    @history = CapsuleCRM::HistoryItem.init_many(self, data)
+  end
+
+  
+  def add_history(note)
+    if note
+      path = [self.class.get_path, self.id, 'history'].join '/'
+      self.class.create(Hash[{:note => note}], {:root => 'historyItem', :path => path})
+      
+      # TODO : Should be optimized so it doesn't reload history each time
+      @history = nil
+    end
+  end
+  
+  alias :add_note :add_history
+end
+

data/lib/capsulecrm/history_item.rb

@@ -0,0 +1,20 @@
+class CapsuleCRM::HistoryItem < CapsuleCRM::Child
+  attr_reader :id
+  attr_accessor :type
+  attr_accessor :entry_date
+  attr_accessor :creator
+  attr_accessor :subject
+  attr_accessor :note
+    
+  def self.xml_map
+    map = {
+      "id" => 'id',
+      "type" => 'type',
+      "entryDate" => 'entry_date',
+      "creator" => 'creator',
+      "subject" => 'subject',
+      "note" => 'note'
+    }
+    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.get_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,114 @@
+class CapsuleCRM::Party < CapsuleCRM::Base
+  include CapsuleCRM::History
+  
+  # nodoc
+  def addresses
+    return @addresses if @addresses
+    data = raw_data['contacts'].try(:[], 'address')
+    @addresses = CapsuleCRM::Address.init_many(self, data)
+  end
+
+
+  # nodoc
+  def custom_fields
+    return @custom_fields if @custom_fields
+    path = self.class.get_path
+    path = [path, '/', id, '/customfield'].join
+    last_response = self.class.get(path)
+    data = last_response['customFields'].try(:[], 'customField')
+    @custom_fields = CapsuleCRM::CustomField.init_many(self, data)
+  end
+
+  def tags
+    return @tags if @tags
+    path = self.class.get_path
+    path = [path, '/', id, '/tag'].join
+    last_response = self.class.get(path)
+    data = last_response['tags'].try(:[], 'tag')
+    @tags = CapsuleCRM::Tag.init_many(self, data)
+  end
+
+  def tag_names
+    tags.map(&:name)
+  end
+
+  # nodoc
+  def emails
+    return @emails if @emails
+    data = raw_data['contacts'].try(:[], 'email')
+    @emails = CapsuleCRM::Email.init_many(self, data)
+  end
+
+
+  # nodoc
+  def phone_numbers
+    return @phone_numbers if @phone_numbers
+    data = raw_data['contacts'].try(:[], 'phone')
+    @phone_numbers = CapsuleCRM::Phone.init_many(self, data)
+  end
+
+  # nodoc
+  def websites
+    return @websites if @websites
+    data = raw_data['contacts'].try(:[], 'website')
+    @websites = CapsuleCRM::Website.init_many(self, data)
+  end
+
+  def is?(kind)
+    required_class = kind.to_s.camelize
+    self.class.to_s.include? required_class
+  end
+
+  def tag(value)
+    # unset tags so that if anyone were to request tags again, it
+    # requests an update from the server.
+    @tags = nil
+    path = self.class.get_path
+    tag = URI.escape(value.to_s)
+    path = [path, id, 'tag', tag].join('/')
+    req = self.class.post(path)
+    req.response.code == ("201" || "200")
+  end
+
+  
+  def untag(value)
+    # unset tags so that if anyone were to request tags again, it
+    # requests an update from the server.
+    @tags = nil
+    path = self.class.get_path
+    tag = URI.escape(value.to_s)
+    path = [path, id, 'tag', tag].join('/')
+    req = self.class.delete(path)
+    req.response.code == "200"
+  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
+
+  def self.init_one(response)
+    return CapsuleCRM::Person.init_one(response) if response['person']
+    return CapsuleCRM::Organisation.init_one(response) if response['organisation']
+    raise CapsuleCRM::RecordNotRecognised, "Could not recognise returned entity type: #{response}"
+  end
+end

data/lib/capsulecrm/person.rb

@@ -0,0 +1,126 @@
+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
+  attr_accessor :note
+
+  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',
+      'note' => 'note'
+    }
+    super.merge map
+  end
+
+
+end