capsule_crm 0.0.4 → 0.0.5

data/lib/capsule_crm/person.rb

@@ -1,294 +1,265 @@
-class CapsuleCRM::Person
-  include Virtus
+module CapsuleCRM
+  class Person < CapsuleCRM::Party
+    include Virtus
 
-  include CapsuleCRM::Contactable
+    include CapsuleCRM::Contactable
+    include CapsuleCRM::Associations::BelongsTo
 
-  extend ActiveModel::Naming
-  extend ActiveModel::Callbacks
-  include ActiveModel::Conversion
-  include ActiveModel::Validations
-  include ActiveModel::Validations::Callbacks
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
 
-  attribute :id, Integer
-  attribute :title
-  attribute :first_name
-  attribute :last_name
-  attribute :job_title
-  attribute :about
-  attribute :organisation_name
-  attribute :organisation_id
+    attribute :id, Integer
+    attribute :title
+    attribute :first_name
+    attribute :last_name
+    attribute :job_title
+    attribute :about
+    attribute :organisation_name
 
-  validates :first_name, presence: { if: :first_name_required? }
-  validates :last_name, presence: { if: :last_name_required? }
+    belongs_to :organization, class_name: 'CapsuleCRM::Organization',
+      foreign_key: :organisation_id
 
-  # Public: Set the attributes of a person
-  #
-  # attributes  - The Hash of attributes (default: {}):
-  #               :first_name         - The String person first name
-  #               :last_name          - The String person last name
-  #               :job_title          - The String job title
-  #               :about              - The String information about the person
-  #               :organisation_name  - The String name of the organisation. If
-  #               this organisation does not exist in capsule then a new one
-  #               will be created on save
-  #               :organisation_id    - The Integer ID of the organisation in
-  #               capsulecrm.
-  #
-  # Examples
-  #
-  # CapsuleCRM::Person.new
-  #
-  # Returns a CapsuleCRM::Person
-  def attributes=(attributes)
-    CapsuleCRM::HashHelper.underscore_keys!(attributes)
-    super(attributes)
-    self
-  end
+    validates :first_name, presence: { if: :first_name_required? }
+    validates :last_name, presence: { if: :last_name_required? }
 
-  # Public: Get all people from Capsule. The list can be restricted
-  # and/or paginated with various query parameters sent through the options
-  # hash.
-  #
-  # options - The Hash of allowed query parameters for Capsule (default: {}):
-  #           :q      - The String search term that will be matched against name,
-  #           telephone number and exact match on searchable custom fields
-  #           :email  - The String email address to search for
-  #           :tag    - The String tag to search for
-  #           :start  - The Integer first record to be returned in pagination.
-  #           The results start with an index of 1
-  #           :limit  - The Integer maximum number of matching records to be
-  #           returned
-  #
-  # Examples
-  #
-  # CapsuleCRM::Person.all
-  #
-  # CapsuleCRM::Person.all(q: "a search query", start: 10, limit: 20)
-  #
-  # Returns a ResultsProxy of organisations
-  def self.all(options = {})
-    init_collection(
-      CapsuleCRM::Connection.get('/api/party', options)['parties']['person']
-    )
-  end
+    def self._for_organization(organization_id)
+      init_collection(
+        CapsuleCRM::Connection.get(
+          "/api/party/#{organization_id}/people"
+        )['parties']['person']
+      )
+    end
 
-  # Public: Get a person by ID
-  #
-  # id  - The Integer person ID
-  #
-  # Examples
-  #
-  # CapsuleCRM::Person.find(1)
-  #
-  # Returns a CapsuleCRM::Person
-  def self.find(id)
-    new CapsuleCRM::Connection.get("/api/party/#{id}")['person']
-  end
+    # Public: Set the attributes of a person
+    #
+    # attributes  - The Hash of attributes (default: {}):
+    #               :first_name         - The String person first name
+    #               :last_name          - The String person last name
+    #               :job_title          - The String job title
+    #               :about              - The String information about the person
+    #               :organisation_name  - The String name of the organisation. If
+    #               this organisation does not exist in capsule then a new one
+    #               will be created on save
+    #               :organisation_id    - The Integer ID of the organisation in
+    #               capsulecrm.
+    #
+    # Examples
+    #
+    # CapsuleCRM::Person.new
+    #
+    # Returns a CapsuleCRM::Person
+    def attributes=(attributes)
+      CapsuleCRM::HashHelper.underscore_keys!(attributes)
+      super(attributes)
+      self
+    end
 
-  # Public: Create a new person in capsulecrm
-  #
-  # attributes  - The Hash of person attributes (default: {}):
-  #               :first_name         - The String first name
-  #               :last_name          - The String last name
-  #               :job_title          - The String job title
-  #               :about              - The String information about the person
-  #               :organisation_name  - The String organisation name. If now
-  #               :organisation_id is supplied, then a new one will be created
-  #               with this name
-  #               :organisation_id    - The Integer ID of the organisation this
-  #               person belongs to
-  #
-  # Examples
-  #
-  # CapsuleCRM::Person.create(first_name: 'Matt', last_name: 'Beedle')
-  #
-  # Returns a CapsuleCRM::Person
-  def self.create(attributes = {})
-    new(attributes).tap(&:save)
-  end
+    # Public: Create a new person in capsulecrm
+    #
+    # attributes  - The Hash of person attributes (default: {}):
+    #               :first_name         - The String first name
+    #               :last_name          - The String last name
+    #               :job_title          - The String job title
+    #               :about              - The String information about the person
+    #               :organisation_name  - The String organisation name. If now
+    #               :organisation_id is supplied, then a new one will be created
+    #               with this name
+    #               :organisation_id    - The Integer ID of the organisation this
+    #               person belongs to
+    #
+    # Examples
+    #
+    # CapsuleCRM::Person.create(first_name: 'Matt', last_name: 'Beedle')
+    #
+    # Returns a CapsuleCRM::Person
+    def self.create(attributes = {})
+      new(attributes).tap(&:save)
+    end
 
-  # Public: Create a new person in capsulecrm and raise a
-  # CapsuleCRM::Errors::InvalidRecord error if not possible
-  #
-  # attributes  - The Hash of person attributes (default: {}):
-  #               :first_name         - The String first name
-  #               :last_name          - The String last name
-  #               :job_title          - The String job title
-  #               :about              - The String information about the person
-  #               :organisation_name  - The String organisation name. If now
-  #               :organisation_id is supplied, then a new one will be created
-  #               with this name
-  #               :organisation_id    - The Integer ID of the organisation this
-  #               person belongs to
-  #
-  # Examples
-  #
-  # CapsuleCRM::Person.create!(first_name: 'Matt', last_name: 'Beedle')
-  #
-  # Returns a CapsuleCRM
-  def self.create!(attributes = {})
-    new(attributes).tap(&:save!)
-  end
+    # Public: Create a new person in capsulecrm and raise a
+    # CapsuleCRM::Errors::InvalidRecord error if not possible
+    #
+    # attributes  - The Hash of person attributes (default: {}):
+    #               :first_name         - The String first name
+    #               :last_name          - The String last name
+    #               :job_title          - The String job title
+    #               :about              - The String information about the person
+    #               :organisation_name  - The String organisation name. If now
+    #               :organisation_id is supplied, then a new one will be created
+    #               with this name
+    #               :organisation_id    - The Integer ID of the organisation this
+    #               person belongs to
+    #
+    # Examples
+    #
+    # CapsuleCRM::Person.create!(first_name: 'Matt', last_name: 'Beedle')
+    #
+    # Returns a CapsuleCRM
+    def self.create!(attributes = {})
+      new(attributes).tap(&:save!)
+    end
 
-  # Public: If the person already exists in capsule then update them,
-  # otherwise create a new person
-  #
-  # Examples
-  #
-  # person = CapsuleCRM::Person.new(first_name: 'Matt')
-  # person.save
-  #
-  # person = CapsuleCRM::Person.find(1)
-  # person.first_name = 'Matt'
-  # person.save
-  #
-  # Returns a CapsuleCRM::Person
-  def save
-    if valid?
-      new_record? ? create_record : update_record
-    else
-      false
+    # Public: If the person already exists in capsule then update them,
+    # otherwise create a new person
+    #
+    # Examples
+    #
+    # person = CapsuleCRM::Person.new(first_name: 'Matt')
+    # person.save
+    #
+    # person = CapsuleCRM::Person.find(1)
+    # person.first_name = 'Matt'
+    # person.save
+    #
+    # Returns a CapsuleCRM::Person
+    def save
+      if valid?
+        new_record? ? create_record : update_record
+      else
+        false
+      end
     end
-  end
 
-  # Public: If the person already exists in capsule then update them,
-  # otherwise create a new person. If the person is not valid then a
-  # CapsuleCRM::Errors::RecordInvalid exception is raised
-  #
-  # Examples
-  #
-  # person = CapsuleCRM::Person.new(first_name: 'Matt')
-  # person.save
-  #
-  # person = CapsuleCRM::Person.find(1)
-  # person.first_name = 'Matt'
-  # person.save
-  #
-  # Returns a CapsuleCRM::Person
-  def save!
-    if valid?
-      new_record? ? create_record : update_record
-    else
-      raise CapsuleCRM::Errors::RecordInvalid.new(self)
+    # Public: If the person already exists in capsule then update them,
+    # otherwise create a new person. If the person is not valid then a
+    # CapsuleCRM::Errors::RecordInvalid exception is raised
+    #
+    # Examples
+    #
+    # person = CapsuleCRM::Person.new(first_name: 'Matt')
+    # person.save
+    #
+    # person = CapsuleCRM::Person.find(1)
+    # person.first_name = 'Matt'
+    # person.save
+    #
+    # Returns a CapsuleCRM::Person
+    def save!
+      if valid?
+        new_record? ? create_record : update_record
+      else
+        raise CapsuleCRM::Errors::RecordInvalid.new(self)
+      end
     end
-  end
 
-  # Public: Update the person in capsule
-  #
-  # attributes  - The Hash of person attributes (default: {}):
-  #               :first_name         - The String first name
-  #               :last_name          - The String last name
-  #               :job_title          - The String job title
-  #               :about              - The String information about the person
-  #               :organisation_name  - The String organisation name
-  #               :organisation_id    - The String organisation id
-  #
-  # Examples
-  #
-  # person = CapsuleCRM::Person.find(1)
-  # person.update_attributes first_name: 'Matt', last_name: 'Beedle'
-  #
-  # Returns a CapsuleCRM::Person
-  def update_attributes(attributes = {})
-    self.attributes = attributes
-    save
-  end
+    # Public: Update the person in capsule
+    #
+    # attributes  - The Hash of person attributes (default: {}):
+    #               :first_name         - The String first name
+    #               :last_name          - The String last name
+    #               :job_title          - The String job title
+    #               :about              - The String information about the person
+    #               :organisation_name  - The String organisation name
+    #               :organisation_id    - The String organisation id
+    #
+    # Examples
+    #
+    # person = CapsuleCRM::Person.find(1)
+    # person.update_attributes first_name: 'Matt', last_name: 'Beedle'
+    #
+    # Returns a CapsuleCRM::Person
+    def update_attributes(attributes = {})
+      self.attributes = attributes
+      save
+    end
 
-  # Public: Update the person in capsule. If the person is not valid then a
-  # CapsuleCRM::Errors::RecordInvalid exception will be raised
-  #
-  # attributes  - The Hash of person attributes (default: {}):
-  #               :first_name         - The String first name
-  #               :last_name          - The String last name
-  #               :job_title          - The String job title
-  #               :about              - The String information about the person
-  #               :organisation_name  - The String organisation name
-  #               :organisation_id    - The String organisation id
-  #
-  # Examples
-  #
-  # person = CapsuleCRM::Person.find(1)
-  # person.update_attributes first_name: 'Matt', last_name: 'Beedle'
-  #
-  # Returns a CapsuleCRM::Person
-  def update_attributes!(attributes = {})
-    self.attributes = attributes
-    save!
-  end
+    # Public: Update the person in capsule. If the person is not valid then a
+    # CapsuleCRM::Errors::RecordInvalid exception will be raised
+    #
+    # attributes  - The Hash of person attributes (default: {}):
+    #               :first_name         - The String first name
+    #               :last_name          - The String last name
+    #               :job_title          - The String job title
+    #               :about              - The String information about the person
+    #               :organisation_name  - The String organisation name
+    #               :organisation_id    - The String organisation id
+    #
+    # Examples
+    #
+    # person = CapsuleCRM::Person.find(1)
+    # person.update_attributes first_name: 'Matt', last_name: 'Beedle'
+    #
+    # Returns a CapsuleCRM::Person
+    def update_attributes!(attributes = {})
+      self.attributes = attributes
+      save!
+    end
 
-  def destroy
-    self.id = nil if CapsuleCRM::Connection.delete("/api/party/#{id}")
-    self
-  end
+    def destroy
+      self.id = nil if CapsuleCRM::Connection.delete("/api/party/#{id}")
+      self
+    end
 
-  # Public: Determine whether this CapsuleCRM::Person is a new record or not
-  #
-  # Returns a Boolean
-  def new_record?
-    !id
-  end
+    # Public: Determine whether this CapsuleCRM::Person is a new record or not
+    #
+    # Returns a Boolean
+    def new_record?
+      !id
+    end
 
-  # Public: Determine whether or not this CapsuleCRM::Person has already been
-  # persisted to capsulecrm
-  #
-  # Returns a Boolean
-  def persisted?
-    !new_record?
-  end
+    # Public: Determine whether or not this CapsuleCRM::Person has already been
+    # persisted to capsulecrm
+    #
+    # Returns a Boolean
+    def persisted?
+      !new_record?
+    end
 
-  # Public: Build a hash of attributes and merge in the attributes for the
-  # contact information
-  #
-  # Examples
-  #
-  # person.to_capsule_json
-  #
-  # Returns a Hash
-  def to_capsule_json
-    {
-      person: CapsuleCRM::HashHelper.camelize_keys(
-        attributes.dup.delete_if { |key, value| value.blank? }.
-        merge(contacts: contacts.to_capsule_json)
-      )
-    }.stringify_keys
-  end
+    # Public: Build a hash of attributes and merge in the attributes for the
+    # contact information
+    #
+    # Examples
+    #
+    # person.to_capsule_json
+    #
+    # Returns a Hash
+    def to_capsule_json
+      {
+        person: CapsuleCRM::HashHelper.camelize_keys(
+          attributes.dup.delete_if { |key, value| value.blank? }.
+          merge(contacts: contacts.to_capsule_json)
+        )
+      }.stringify_keys
+    end
 
-  private
+    private
 
-  def create_record
-    self.attributes = CapsuleCRM::Connection.post(
-      '/api/person', to_capsule_json
-    )
-    self
-  end
+    def create_record
+      self.attributes = CapsuleCRM::Connection.post(
+        '/api/person', to_capsule_json
+      )
+      self
+    end
 
-  def update_record
-    CapsuleCRM::Connection.put("/api/person/#{id}", attributes)
-    self
-  end
+    def update_record
+      CapsuleCRM::Connection.put("/api/person/#{id}", attributes)
+      self
+    end
 
-  # Private: Build a ResultsProxy from a Array of CapsuleCRM::Person attributes
-  #
-  # collection  - The Array of CapsuleCRM::Person attributes hashes
-  #
-  # Returns a CapsuleCRM::ResultsProxy
-  def self.init_collection(collection)
-    CapsuleCRM::ResultsProxy.new(collection.map { |item| new item })
-  end
+    # Private: Build a ResultsProxy from a Array of CapsuleCRM::Person attributes
+    #
+    # collection  - The Array of CapsuleCRM::Person attributes hashes
+    #
+    # Returns a CapsuleCRM::ResultsProxy
+    def self.init_collection(collection)
+      CapsuleCRM::ResultsProxy.new(collection.map { |item| new item })
+    end
 
-  # Private: Determines whether the person first name is required. Either the
-  # first or the last name is always required
-  #
-  # Returns a Boolean
-  def first_name_required?
-    last_name.blank?
-  end
+    # Private: Determines whether the person first name is required. Either the
+    # first or the last name is always required
+    #
+    # Returns a Boolean
+    def first_name_required?
+      last_name.blank?
+    end
 
-  # Private: Determines whether the person last name is required. Either the
-  # first or the last name is always required
-  #
-  # Return a Boolean
-  def last_name_required?
-    first_name.blank?
+    # Private: Determines whether the person last name is required. Either the
+    # first or the last name is always required
+    #
+    # Return a Boolean
+    def last_name_required?
+      first_name.blank?
+    end
   end
 end

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/capsule_crm.rb

@@ -3,9 +3,11 @@ require 'faraday'
 require 'faraday_middleware'
 require 'virtus'
 require 'capsule_crm/capsule_jsonable'
+require 'capsule_crm/associations'
 require 'capsule_crm/address'
 require 'capsule_crm/connection'
 require 'capsule_crm/email'
+require 'capsule_crm/party'
 require 'capsule_crm/phone'
 require 'capsule_crm/website'
 require 'capsule_crm/hash_helper'

data/spec/fabricators/opportunity_fabricator.rb

@@ -0,0 +1,5 @@
+Fabricator(:opportunity, class_name: :'CapsuleCRM::Opportunity') do
+  name          'Test'
+  milestone_id  1
+  party_id      { rand(10) }
+end

data/spec/fabricators/organization_fabricator.rb

@@ -0,0 +1,3 @@
+Fabricator(:organization, class_name: :'CapsuleCRM::Organization') do
+  name  'Test Organization'
+end

data/spec/lib/capsule_crm/associations/has_many_proxy_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+class Parent
+  include Virtus
+  include CapsuleCRM::Associations::HasMany
+
+  attribute :id, Integer
+
+  has_many :children, class_name: 'Child', source: :parent
+end
+
+class Child
+  include Virtus
+  include CapsuleCRM::Associations::BelongsTo
+
+  attribute :name
+
+  belongs_to :parent
+
+  def self._for_parent(parent_id)
+    []
+  end
+
+  def save
+    @persisted = true
+  end
+
+  def persisted?
+    @persisted
+  end
+end
+
+describe CapsuleCRM::Associations::HasManyProxy do
+  let(:proxy) do
+    CapsuleCRM::Associations::HasManyProxy.new(
+      parent, Child, target, :parent
+    )
+  end
+
+  let(:parent) { Parent.new }
+
+  let(:target) { [] }
+
+  describe '#build' do
+    before { parent.children.build(name: 'a test name') }
+
+    it 'should build a child object' do
+      parent.children.first.should be_a(Child)
+    end
+
+    it 'should set the child object attributes' do
+      parent.children.first.name.should eql('a test name')
+    end
+
+    it 'should add an object to the target' do
+      parent.children.length.should eql(1)
+    end
+
+    it 'should add the target to the parent' do
+      parent.children.length.should eql(1)
+    end
+  end
+
+  describe '#create' do
+    before { parent.children.create(name: 'a test name') }
+
+    it 'should persist the child' do
+      parent.children.last.should be_persisted
+    end
+  end
+end

data/spec/lib/capsule_crm/associations/has_many_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe CapsuleCRM::Associations::HasMany do
+end