capsule_crm 0.0.1 → 0.0.2

data/lib/capsule_crm/person.rb

@@ -1,7 +1,7 @@
 class CapsuleCRM::Person
   include Virtus
 
-  include CapsuleCRM::Associations::HasMany
+  include CapsuleCRM::Contactable
 
   extend ActiveModel::Naming
   extend ActiveModel::Callbacks
@@ -9,7 +9,7 @@ class CapsuleCRM::Person
   include ActiveModel::Validations
   include ActiveModel::Validations::Callbacks
 
-  attribute :id
+  attribute :id, Integer
   attribute :title
   attribute :first_name
   attribute :last_name
@@ -21,11 +21,6 @@ class CapsuleCRM::Person
   validates :first_name, presence: { if: :first_name_required? }
   validates :last_name, presence: { if: :last_name_required? }
 
-  has_many :addresses
-  has_many :emails
-  has_many :phones
-  has_many :websites
-
   # Public: Set the attributes of a person
   #
   # attributes  - The Hash of attributes (default: {}):
@@ -109,7 +104,30 @@ class CapsuleCRM::Person
   #
   # Returns a CapsuleCRM::Person
   def self.create(attributes = {})
-    new CapsuleCRM::Connection.post('/api/person', attributes)['person']
+    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,
@@ -126,10 +144,32 @@ class CapsuleCRM::Person
   #
   # Returns a CapsuleCRM::Person
   def save
-    if new_record?
-      self.attributes = CapsuleCRM::Person.create(attributes).attributes
+    if valid?
+      new_record? ? create_record : update_record
     else
-      update_attributes attributes
+      false
+    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)
     end
   end
 
@@ -150,8 +190,35 @@ class CapsuleCRM::Person
   #
   # Returns a CapsuleCRM::Person
   def update_attributes(attributes = {})
-    self.attributes =
-      CapsuleCRM::Connection.put("/api/person/#{id}", attributes)['person']
+    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
 
   # Public: Determine whether this CapsuleCRM::Person is a new record or not
@@ -161,8 +228,45 @@ class CapsuleCRM::Person
     !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: 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
 
+  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
+
   # Private: Build a ResultsProxy from a Array of CapsuleCRM::Person attributes
   #
   # collection  - The Array of CapsuleCRM::Person attributes hashes

data/lib/capsule_crm/phone.rb

@@ -0,0 +1,13 @@
+module CapsuleCRM
+  class Phone
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Serializers::JSON
+
+    include CapsuleCRM::CapsuleJsonable
+
+    attribute :type
+    attribute :phone_number
+  end
+end

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/capsule_crm/website.rb

@@ -0,0 +1,17 @@
+module CapsuleCRM
+  class Website
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Validations
+    include ActiveModel::Serializers::JSON
+
+    include CapsuleCRM::CapsuleJsonable
+
+    attribute :type
+    attribute :web_service
+    attribute :web_address
+
+    validates :web_service, :web_address, presence: true
+  end
+end

data/lib/capsule_crm.rb

@@ -1,12 +1,18 @@
 require 'active_model'
 require 'faraday'
+require 'faraday_middleware'
 require 'virtus'
+require 'capsule_crm/capsule_jsonable'
+require 'capsule_crm/address'
 require 'capsule_crm/connection'
+require 'capsule_crm/email'
+require 'capsule_crm/phone'
+require 'capsule_crm/website'
 require 'capsule_crm/hash_helper'
 require 'capsule_crm/results_proxy'
-require 'capsule_crm/associations/belongs_to'
-require 'capsule_crm/associations/has_many'
-require 'capsule_crm/associations/has_many_proxy'
+require 'capsule_crm/errors/record_invalid'
+require 'capsule_crm/contacts'
+require 'capsule_crm/contactable'
 require 'capsule_crm/configuration'
 require 'capsule_crm/organization'
 require 'capsule_crm/person'

data/spec/lib/capsule_crm/address_spec.rb

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

data/spec/lib/capsule_crm/contacts_spec.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe CapsuleCRM::Contacts do
+
+  let(:address) do
+    CapsuleCRM::Address.new(
+      street: 'Oranienburgerstraße', city: 'Berlin', state: 'Berlin',
+      zip: '10117', country: 'Germany', type: 'Office'
+    )
+  end
+
+  let(:email) do
+    CapsuleCRM::Email.new(email_address: 'matt@gmail.com', type: 'Work')
+  end
+
+  let(:phone) do
+    CapsuleCRM::Phone.new(phone_number: '1234', type: 'Work')
+  end
+
+  let(:website) do
+    CapsuleCRM::Website.new(
+      type: 'Work', web_service: 'URL', web_address: 'http://somewhere.com'
+    )
+  end
+
+  describe '#initialize' do
+    context 'when addresses supplied' do
+      subject { CapsuleCRM::Contacts.new(addresses: [address]) }
+
+      it { subject.addresses.should_not be_blank }
+
+      it do
+        subject.addresses.
+          all? { |address| address.is_a?(CapsuleCRM::Address) }.should be_true
+      end
+    end
+
+    context 'when emails supplied' do
+      subject { CapsuleCRM::Contacts.new(emails: [email]) }
+
+      it { subject.emails.should_not be_blank }
+
+      it do
+        subject.emails.
+          all? { |email| email.is_a?(CapsuleCRM::Email) }.should be_true
+      end
+    end
+
+    context 'when phone numbers are supplied' do
+      subject { CapsuleCRM::Contacts.new(phones: [phone]) }
+
+      it { subject.phones.should_not be_blank }
+
+      it do
+        subject.phones.
+          all? { |phone| phone.is_a?(CapsuleCRM::Phone) }.should be_true
+      end
+    end
+
+    context 'when websites are supplied' do
+      subject { CapsuleCRM::Contacts.new(websites: [website]) }
+
+      it { subject.websites.should_not be_blank }
+
+      it do
+        subject.websites.
+          all? { |website| website.is_a?(CapsuleCRM::Website) }.should be_true
+      end
+    end
+  end
+end

data/spec/lib/capsule_crm/email_spec.rb

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

data/spec/lib/capsule_crm/person_spec.rb

@@ -1,3 +1,5 @@
+#encoding: utf-8
+
 require 'spec_helper'
 
 describe CapsuleCRM::Person do
@@ -49,33 +51,56 @@ describe CapsuleCRM::Person do
   end
 
   describe '.create' do
-    context 'when the person saves successfully' do
+    context 'when the person is valid' do
       before do
-        stub_request(:post, /.*/).
-          to_return(body: File.read('spec/support/create-person.json'))
+        stub_request(:post, /.*/).to_return(headers: {
+          'Location' => 'https://sample.capsulecrm.com/api/party/100'
+        })
       end
 
-      subject { CapsuleCRM::Person.create }
+      subject { CapsuleCRM::Person.create(first_name: 'Eric') }
 
       it { should be_a(CapsuleCRM::Person) }
 
-      it { subject.about.should eql('A comment here') }
+      it { subject.id.should eql(100) }
+    end
+
+    context 'when the person is not valid' do
+      subject { CapsuleCRM::Person.create }
+
+      it { subject.errors.should_not be_blank }
+    end
+  end
+
+  describe '.create!' do
+    context 'when the person is valid' do
+      before do
+        stub_request(:post, /.*/).to_return(headers: {
+          'Location' => 'https://sample.capsulecrm.com/api/party/101'
+        })
+      end
+
+      subject { CapsuleCRM::Person.create(first_name: 'Eric') }
 
-      it { subject.first_name.should eql('Eric') }
+      it { should be_a(CapsuleCRM::Person) }
 
-      it { subject.last_name.should eql('Schmidt') }
+      it { should be_persisted }
 
-      it { subject.organisation_name.should eql('Google Inc') }
+      it { subject.id.should eql(101) }
+    end
 
-      it { subject.job_title.should eql('Chairman') }
+    context 'when the person is not valid' do
+      it do
+        expect { CapsuleCRM::Person.create! }.
+          to raise_error(CapsuleCRM::Errors::RecordInvalid)
+      end
     end
   end
 
   describe '#update_attributes' do
-    context 'when the person saves successfully' do
+    context 'when the person is valid' do
       before do
-        stub_request(:put, /.*/).
-          to_return(body: File.read('spec/support/update-person.json'))
+        stub_request(:put, /.*/).to_return(status: 200)
       end
 
       let(:person) { CapsuleCRM::Person.new(id: 1) }
@@ -86,43 +111,96 @@ describe CapsuleCRM::Person do
 
       it { person.id.should eql(1) }
     end
+
+    context 'when the person is not valid' do
+      let(:person) { CapsuleCRM::Person.new(id: 1) }
+
+      before { person.update_attributes }
+
+      it { person.should_not be_valid }
+
+      it { person.errors.should_not be_blank }
+    end
+  end
+
+  describe '#update_attributes!' do
+
+    let(:person) { CapsuleCRM::Person.new(id: 1) }
+
+    context 'when the person is valid' do
+      before do
+        stub_request(:put, /.*/).to_return(status: 200)
+      end
+
+      before { person.update_attributes first_name: 'James' }
+
+      it { person.first_name.should eql('James') }
+
+      it { person.id.should eql(1) }
+    end
+
+    context 'when the person is not valid' do
+      it do
+        expect { person.update_attributes! }.
+          to raise_error(CapsuleCRM::Errors::RecordInvalid)
+      end
+    end
   end
 
   describe '#save' do
     context 'when the person is a new record' do
       before do
-        stub_request(:post, /.*/).
-          to_return(body: File.read('spec/support/create-person.json'))
+        stub_request(:post, /.*/).to_return(headers: {
+          'Location' => 'https://sample.capsulecrm.com/api/party/100'
+        }, status: 200)
       end
 
-      let(:person) { CapsuleCRM::Person.new }
+      let(:person) { CapsuleCRM::Person.new(first_name: 'Eric') }
 
       before { person.save }
 
-      it { person.about.should eql('A comment here') }
-
       it { person.first_name.should eql('Eric') }
 
-      it { person.last_name.should eql('Schmidt') }
+      it { person.should be_persisted }
+    end
+  end
 
-      it { person.organisation_name.should eql('Google Inc') }
+  describe '#save!' do
+    context 'when the person is a new record' do
+      context 'when the person is valid' do
+        before do
+          stub_request(:post, /.*/).to_return(headers: {
+            'Location' => 'https://sample.capsulecrm.com/api/party/100',
+          }, status: 200)
+        end
 
-      it { person.job_title.should eql('Chairman') }
-    end
+        let(:person) { CapsuleCRM::Person.new(first_name: 'Eric') }
 
-    context 'when the person is not a new record' do
-      before do
-        stub_request(:put, /.*/).
-          to_return(body: File.read('spec/support/update-person.json'))
+        before { person.save }
+
+        it { person.should be_persisted }
       end
 
-      let(:person) { CapsuleCRM::Person.new(id: 1) }
+      context 'when the person is not valid' do
+        let(:person) { CapsuleCRM::Person.new }
 
-      before { person.save }
+        it do
+          expect { person.save! }.
+            to raise_error(CapsuleCRM::Errors::RecordInvalid)
+        end
+      end
+    end
 
-      it { person.first_name.should eql('James') }
+    context 'when the person is not a new record' do
+      context 'when the person is not valid' do
 
-      it { person.id.should eql(1) }
+        let(:person) { CapsuleCRM::Person.new(id: 1) }
+
+        it do
+          expect { person.save! }.
+            to raise_exception(CapsuleCRM::Errors::RecordInvalid)
+        end
+      end
     end
   end
 
@@ -144,6 +222,24 @@ describe CapsuleCRM::Person do
     end
   end
 
+  describe '#persisted?' do
+    context 'when the person is persisted' do
+      let(:person) { CapsuleCRM::Person.new(id: 1) }
+
+      subject { person.persisted? }
+
+      it { should be_true }
+    end
+
+    context 'when the person is not persisted' do
+      let(:person) { CapsuleCRM::Person.new }
+
+      subject { person.persisted? }
+
+      it { should be_false }
+    end
+  end
+
   describe '.init_collection' do
     subject do
       CapsuleCRM::Person.init_collection(
@@ -193,4 +289,56 @@ describe CapsuleCRM::Person do
       it { should be_false }
     end
   end
+
+  describe '#to_capsule_json' do
+    let(:address) do
+      CapsuleCRM::Address.new(
+        street: 'Oranienburgerstraße', city: 'Berlin', state: 'Berlin',
+        zip: '10117', country: 'de'
+      )
+    end
+
+    let(:email) do
+      CapsuleCRM::Email.new(type: 'Work', email_address: 'matt@gmail.com')
+    end
+
+    let(:contacts) do
+      CapsuleCRM::Contacts.new(addresses: [address], emails: [email])
+    end
+
+    let(:person) do
+      CapsuleCRM::Person.new(
+        first_name: 'Matt', last_name: 'Beedle',
+        organisation_name: "Matt's Company", contacts: contacts
+      )
+    end
+
+    let(:email_json) { subject['contacts']['email'].first }
+
+    let(:address_json) { subject['contacts']['address'].first }
+
+    subject { person.to_capsule_json['person'] }
+
+    it { should have_key('firstName') }
+
+    it { should have_key('lastName') }
+
+    it { should have_key('organisationName') }
+
+    it { should have_key('contacts') }
+
+    it { address_json.should have_key('street') }
+
+    it { address_json.should have_key('city') }
+
+    it { address_json.should have_key('state') }
+
+    it { address_json.should have_key('zip') }
+
+    it { address_json.should have_key('country') }
+
+    it { email_json.should have_key('type') }
+
+    it { email_json.should have_key('emailAddress') }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capsule_crm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matt Beedle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +173,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -167,26 +182,31 @@ files:
 - capsule_crm.gemspec
 - features/organizations.feature
 - lib/capsule_crm.rb
+- lib/capsule_crm/address.rb
 - lib/capsule_crm/associations.rb
-- lib/capsule_crm/associations/belongs_to.rb
-- lib/capsule_crm/associations/has_many.rb
-- lib/capsule_crm/associations/has_many_proxy.rb
+- lib/capsule_crm/capsule_jsonable.rb
 - lib/capsule_crm/configuration.rb
 - lib/capsule_crm/connection.rb
-- lib/capsule_crm/contact.rb
+- lib/capsule_crm/contactable.rb
+- lib/capsule_crm/contacts.rb
+- lib/capsule_crm/email.rb
+- lib/capsule_crm/errors/record_invalid.rb
 - lib/capsule_crm/hash_helper.rb
 - lib/capsule_crm/organization.rb
 - lib/capsule_crm/party.rb
 - lib/capsule_crm/person.rb
+- lib/capsule_crm/phone.rb
 - lib/capsule_crm/results_proxy.rb
 - lib/capsule_crm/version.rb
+- lib/capsule_crm/website.rb
+- spec/lib/capsule_crm/address_spec.rb
+- spec/lib/capsule_crm/contacts_spec.rb
+- spec/lib/capsule_crm/email_spec.rb
 - spec/lib/capsule_crm/person_spec.rb
 - spec/spec_helper.rb
 - spec/support/all_parties.json
-- spec/support/create-person.json
 - spec/support/helpers.rb
 - spec/support/person.json
-- spec/support/update-person.json
 homepage: ''
 licenses: []
 metadata: {}
@@ -212,10 +232,11 @@ specification_version: 4
 summary: Gem to communicate with CapsuleCRM
 test_files:
 - features/organizations.feature
+- spec/lib/capsule_crm/address_spec.rb
+- spec/lib/capsule_crm/contacts_spec.rb
+- spec/lib/capsule_crm/email_spec.rb
 - spec/lib/capsule_crm/person_spec.rb
 - spec/spec_helper.rb
 - spec/support/all_parties.json
-- spec/support/create-person.json
 - spec/support/helpers.rb
 - spec/support/person.json
-- spec/support/update-person.json