capsule_crm 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c9c330d4eeb07e7c78b092407c54bde1d851b7d
-  data.tar.gz: 745c544f60e55e8d7ce5aa9e8e3abdb79c80c0e2
+  metadata.gz: 143725dc45cebfffee7104b902cda999f6e5d5a4
+  data.tar.gz: b15eee85686b5e11f0f2c5cea64701ed85d02a9c
 SHA512:
-  metadata.gz: c8643c862014d2c0fa7980d6f9c6cdc82279a4fa9e513b556012e1bb902f325a1b61fbeb107d1f92dd5b781c0ce7ab4d5592f55921337c1dd85b90676d78d3f0
-  data.tar.gz: ff1850b21048a9994f05b1678895b522089c24240329d436da85e852874986049b8d53217b7122612c14488a8c0105092d59e036c288e61b4f339fc1b6d17a79
+  metadata.gz: d3ca68c5b10e99a3b7cbe9b2fad98d4a84e1d4b3d79bc7fcfdbe327c038a1b122a5504cd8c02a74b67620cc9f7704571d6b8c06e5717ab2d4aa3e938a16a80fe
+  data.tar.gz: b20d34a05f2695e836e07bf2c1053dcf7806a96297d31dacdfbcf1797b55d9c0f7577a1a77a03109b3f579be816c2cd924ae9b6b81dfc25a197de073c10e2115

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.9.1
+
+- Refactored code for finding parties/people/organizations to make sure that
+  contacts are always a CapsuleCRM::Contacts when finding a record
+- Moved attributes= into a module
+
 ## 0.9.0
 
 ### New Features

data/Guardfile

@@ -3,7 +3,7 @@
 
 notification :tmux
 
-guard 'rspec', all_on_start: true, all_after_pass: true do
+guard 'rspec', all_on_start: true, all_after_pass: true, keep_failed: true do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/lib/capsule_crm.rb

@@ -2,6 +2,7 @@ require 'active_model'
 require 'faraday'
 require 'faraday_middleware'
 require 'virtus'
+require 'capsule_crm/attributes'
 require 'capsule_crm/capsule_jsonable'
 require 'capsule_crm/taggable'
 require 'capsule_crm/collection'

data/lib/capsule_crm/attributes.rb

@@ -0,0 +1,11 @@
+module CapsuleCRM
+  module Attributes
+    extend ActiveSupport::Concern
+
+    def attributes=(attributes)
+      CapsuleCRM::HashHelper.underscore_keys!(attributes)
+      super(attributes)
+      self
+    end
+  end
+end

data/lib/capsule_crm/contactable.rb

@@ -14,6 +14,9 @@ module CapsuleCRM
     end
 
     def contacts=(contacts)
+      if contacts.is_a?(Hash)
+        contacts = CapsuleCRM::Contacts.new(contacts.symbolize_keys)
+      end
       @contacts = contacts
     end
 

data/lib/capsule_crm/contacts.rb

@@ -15,10 +15,10 @@ module CapsuleCRM
     #
     # Returns a CapsuleCRM::Contact
     def initialize(attributes = {})
-      self.addresses  = Array(attributes[:addresses])
-      self.emails     = Array(attributes[:emails])
-      self.phones     = Array(attributes[:phones])
-      self.websites   = Array(attributes[:websites])
+      self.addresses  = attributes[:addresses] || attributes[:address]
+      self.emails     = attributes[:emails] || attributes[:email]
+      self.phones     = attributes[:phones] || attributes[:phone]
+      self.websites   = attributes[:websites] || attributes[:website]
     end
 
     # Public: Sets the addresses for this contacts container
@@ -34,7 +34,8 @@ module CapsuleCRM
     #
     # Returns an Array of CapsuleCRM::Address objects
     def addresses=(addresses)
-      @addresses = addresses
+      addresses = CapsuleCRM::Address.new(addresses) if addresses.is_a?(Hash)
+      @addresses = Array(addresses)
     end
 
     # Public: Gets the addresses for this contacts container
@@ -45,7 +46,7 @@ module CapsuleCRM
     #
     # Returns an Array of CapsuleCRM::Address objects
     def addresses
-      @addresses || []
+      Array(@addresses)
     end
 
     # Public: Sets the emails for this contacts container
@@ -61,7 +62,8 @@ module CapsuleCRM
     #
     # Returns an Array of CapsuleCRM::Email objects
     def emails=(emails)
-      @emails = emails
+      emails = CapsuleCRM::Email.new(emails) if emails.is_a?(Hash)
+      @emails = Array(emails)
     end
 
     # Public: Gets the emails for this contacts container
@@ -87,7 +89,8 @@ module CapsuleCRM
     #
     # Returns an Array of CapsuleCRM::Phone objects
     def phones=(phones)
-      @phones = phones
+      phones = CapsuleCRM::Phone.new(phones) if phones.is_a?(Hash)
+      @phones = Array(phones)
     end
 
     # Public: Gets the phones for this contacts container
@@ -115,7 +118,8 @@ module CapsuleCRM
     #
     # Returns an Array of CapsuleCRM::Website objects
     def websites=(websites)
-      @websites = websites
+      websites = CapsuleCRM::Website.new(websites) if websites.is_a?(Hash)
+      @websites = Array(websites)
     end
 
     # Public: Gets the websites for this contacts container

data/lib/capsule_crm/custom_field.rb

@@ -7,6 +7,7 @@ module CapsuleCRM
     include ActiveModel::Validations
 
     include CapsuleCRM::Associations
+    include CapsuleCRM::Attributes
     include CapsuleCRM::Collection
 
     attribute :id, Integer
@@ -33,12 +34,6 @@ module CapsuleCRM
       alias :_for_person :_for_party
     end
 
-    def attributes=(attributes)
-      CapsuleCRM::HashHelper.underscore_keys!(attributes)
-      super(attributes)
-      self
-    end
-
     def self.create(attributes = {})
       new(attributes).tap(&:save)
     end
@@ -69,16 +64,10 @@ module CapsuleCRM
     def to_capsule_json
       {
         customFields: {
-          customField: [CapsuleCRM::HashHelper.camelize_keys(
-            {
-              id: id,
-              label: label,
-              date: date,
-              tag: tag,
-              boolean: boolean,
-              text: text,
-            }.delete_if { |key, value| value.blank? }
-          )]
+          customField: [
+            CapsuleCRM::HashHelper.camelize_keys(attributes).
+            delete_if { |key, value| value.blank? }
+          ]
         }
       }
     end

data/lib/capsule_crm/email.rb

@@ -9,5 +9,10 @@ module CapsuleCRM
 
     attribute :type
     attribute :email_address
+
+    def initialize(attributes = {})
+      CapsuleCRM::HashHelper.underscore_keys!(attributes)
+      super(attributes)
+    end
   end
 end

data/lib/capsule_crm/history.rb

@@ -7,6 +7,7 @@ module CapsuleCRM
     include ActiveModel::Validations
 
     include CapsuleCRM::Associations
+    include CapsuleCRM::Attributes
     include CapsuleCRM::Collection
 
     attribute :id, Integer
@@ -56,48 +57,6 @@ module CapsuleCRM
       )
     end
 
-    # Public: Underscore all of the attributes keys and set the attributes of
-    # this history item
-    #
-    # attributes  - The Hash of history attributes (default: {}):
-    #               :id               - The Integer ID of this history item
-    #               :creator          - The String username of the creator
-    #               (CapsuleCRM::User) OR a CapsuleCRM::User object
-    #               :type             - The String type (Note, Email or Task)
-    #               :note             - The String note
-    #               :subject          - The String email subject if this history
-    #               item is from an email
-    #               :entry_date       - The date when this history item was
-    #               created
-    #               :attachments      - An Array of CapsuleCRM::Attachment
-    #               objects OR an Array of CapsuleCRM::Attachment attributes
-    #               hashes
-    #               :participants     - An Array of CapsuleCRM::Participant
-    #               objects OR an Array of CapsuleCRM::Participant attributes
-    #               hashes
-    #               :party_id         - The Integer ID of the party that this
-    #               history item belongs to
-    #               :case_id          - The Integer ID of the case that this
-    #               history item belongs to
-    #               :opportunity_id   - The Integer ID of the opportunity that
-    #               this item belongs to
-    #
-    # Examples
-    #
-    # history = CapsuleCRM::History.new
-    # history.attributes = { entry_date: Time.now }
-    #
-    # or
-    #
-    # history.attributes = { entryDate: Time.now }
-    #
-    # Returns a CapsuleCRM::History object
-    def attributes=(attributes)
-      CapsuleCRM::HashHelper.underscore_keys!(attributes)
-      super(attributes)
-      self
-    end
-
     # Public: find a CapsuleCRM::History by ID
     #
     # id  - The Integer CapsuleCRM::History ID

data/lib/capsule_crm/opportunity.rb

@@ -7,6 +7,7 @@ module CapsuleCRM
     include ActiveModel::Validations
 
     include CapsuleCRM::Associations
+    include CapsuleCRM::Attributes
     include CapsuleCRM::Collection
 
     attribute :id, Integer
@@ -41,36 +42,6 @@ module CapsuleCRM
       self
     end
 
-    # Public: Set the attributes of a opportunity
-    #
-    # attributes  - The Hash of attributes (default: {}):
-    #               :name                 - The String opportunity name
-    #               :description          - The String opportunity description
-    #               :currency             - The String currency code
-    #               :value                - The Float opportunity (financial) value
-    #               :duration_basis       - The String duration basis
-    #               :duration             - The Integer duration (for opportunities
-    #               with a repeating (not FIXED) duratin basis
-    #               :party_id             - The Integer party id
-    #               :milestone_id         - The Integer milestone id
-    #               :expected_close_date  - The DateTime when the opportunity
-    #               is expected to be closed
-    #               :actual_close_date    - The DateTime when the opportunity
-    #               was actually closed
-    #               :probability          - The Float probability that this
-    #               opportunity will be won
-    #
-    # Examples
-    #
-    # CapsuleCRM::Opportunity.new
-    #
-    # Returns a CapsuleCRM::Opportunity
-    def attributes=(attributes)
-      CapsuleCRM::HashHelper.underscore_keys!(attributes)
-      super(attributes)
-      self
-    end
-
     # Public: Get all opportunities from Capsule. The list can be restricted
     # and/or paginated with various query parameters sent through the options
     # hash.

data/lib/capsule_crm/organization.rb

@@ -2,8 +2,6 @@ require 'active_support/core_ext'
 
 module CapsuleCRM
   class Organization < CapsuleCRM::Party
-    include Virtus
-
     extend ActiveModel::Naming
     extend ActiveModel::Callbacks
     extend ActiveModel::Conversion
@@ -24,23 +22,6 @@ module CapsuleCRM
     has_many :people, class_name: 'CapsuleCRM::Person', source: :organization
     has_many :custom_fields, class_name: 'CapsuleCRM::CustomField', source: :organization
 
-    # Public: Set the attributes of an organization
-    #
-    # attributes  - The Hash of attributes (default: {}):
-    #               :name   - The String organization name
-    #               :about  - The String information about the organization
-    #
-    # Examples
-    #
-    # CapsuleCRM::Organization.new
-    #
-    # Returns a CapsuleCRM::Organization
-    def attributes=(attributes)
-      CapsuleCRM::HashHelper.underscore_keys!(attributes)
-      super(attributes)
-      self
-    end
-
     # Public: Get all people from Capsule. The list can be restricted
     # and/or paginated with various query parameters sent through the options
     # hash.
@@ -229,9 +210,8 @@ module CapsuleCRM
     #
     # Returns a Hash
     def to_capsule_json
-      self.contacts = nil if self.contacts.blank?
       {
-        organisation: attributes.merge(self.contacts ? {contacts: (self.contacts.is_a?(Hash) ? self.contacts : self.contacts.to_capsule_json)} : {}).
+        organisation: attributes.merge(contacts: contacts.to_capsule_json).
         stringify_keys
       }.stringify_keys
     end

data/lib/capsule_crm/party.rb

@@ -1,6 +1,8 @@
 class CapsuleCRM::Party
-  include CapsuleCRM::Taggable
+  include Virtus
 
+  include CapsuleCRM::Attributes
+  include CapsuleCRM::Taggable
   include CapsuleCRM::Associations::HasMany
 
   has_many :histories, class_name: 'CapsuleCRM::History', source: :party

data/lib/capsule_crm/person.rb

@@ -1,7 +1,5 @@
 module CapsuleCRM
   class Person < CapsuleCRM::Party
-    include Virtus
-
     include CapsuleCRM::Collection
     include CapsuleCRM::Contactable
     include CapsuleCRM::Associations::BelongsTo
@@ -62,30 +60,6 @@ module CapsuleCRM
       )
     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: {}):
@@ -246,11 +220,10 @@ module CapsuleCRM
     #
     # Returns a Hash
     def to_capsule_json
-      self.contacts = nil if self.contacts.blank?
       {
         person: CapsuleCRM::HashHelper.camelize_keys(
           attributes.dup.delete_if { |key, value| value.blank? }.
-          merge(self.contacts ? {contacts: (self.contacts.is_a?(Hash) ? self.contacts : self.contacts.to_capsule_json)} : {})
+          merge(contacts: contacts.to_capsule_json)
         )
       }.stringify_keys
     end

data/lib/capsule_crm/phone.rb

@@ -9,5 +9,10 @@ module CapsuleCRM
 
     attribute :type
     attribute :phone_number
+
+    def initialize(attributes = {})
+      CapsuleCRM::HashHelper.underscore_keys!(attributes)
+      super(attributes)
+    end
   end
 end

data/lib/capsule_crm/task.rb

@@ -7,6 +7,7 @@ module CapsuleCRM
     include ActiveModel::Validations
 
     include CapsuleCRM::Associations::BelongsTo
+    include CapsuleCRM::Attributes
     include CapsuleCRM::Collection
 
     attribute :id, Integer
@@ -49,11 +50,6 @@ module CapsuleCRM
       )
     end
 
-    def attributes=(attributes)
-      CapsuleCRM::HashHelper.underscore_keys!(attributes)
-      super(attributes)
-    end
-
     def owner=(user)
       user = CapsuleCRM::User.find_by_username(user) if user.is_a?(String)
       @owner = user

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/lib/capsule_crm/website.rb

@@ -13,5 +13,10 @@ module CapsuleCRM
     attribute :web_address
 
     validates :web_service, :web_address, presence: true
+
+    def initialize(attributes = {})
+      CapsuleCRM::HashHelper.underscore_keys!(attributes)
+      super(attributes)
+    end
   end
 end

data/spec/lib/capsule_crm/party_spec.rb

@@ -4,7 +4,63 @@ describe CapsuleCRM::Party do
   before { configure }
 
   describe '.find' do
-    pending
+    context 'when finding an organization' do
+      before do
+        stub_request(:get, /\/api\/party\/#{id}$/).
+          to_return(body: File.read('spec/support/organisation.json'))
+      end
+
+      subject { CapsuleCRM::Party.find(id) }
+
+      let(:id) { rand(10) }
+
+      it { expect(subject).to be_a(CapsuleCRM::Organization) }
+
+      it { expect(subject.contacts).to be_a(CapsuleCRM::Contacts) }
+
+      it 'should get the contact address street' do
+        expect(subject.addresses.first.street).
+          to eql('1600 Amphitheatre Parkway')
+      end
+
+      it 'should get the contact address city' do
+        expect(subject.addresses.first.city).
+          to eql('Mountain View')
+      end
+
+      it { expect(subject.addresses.first.state).to eql('CA') }
+
+      it { expect(subject.addresses.first.zip).to eql('94043') }
+
+      it 'should get the contact address country' do
+        expect(subject.addresses.first.country).
+          to eql('United States')
+      end
+    end
+
+    context 'when finding a person' do
+      before do
+        stub_request(:get, /\/api\/party\/#{id}$/).
+          to_return(body: File.read('spec/support/person.json'))
+      end
+
+      subject { CapsuleCRM::Party.find(id) }
+
+      let(:id) { rand(10) }
+
+      it 'should get the email address' do
+        expect(subject.emails.first.email_address).
+          to eql('e.schmidt@google.com')
+      end
+
+      it 'should get the phone number' do
+        expect(subject.phones.first.phone_number).to eql('+1 888 555555')
+      end
+
+      it 'should get the website' do
+        expect(subject.websites.first.web_address).to eql('www.google.com')
+      end
+    end
   end
 
   describe '.all' do

data/spec/support/organisation.json

@@ -1,8 +1,17 @@
 {
   "organisation": {
-    "id": "50",
-    "createdOn": "2011-09-14T15:22:01Z",
+    "contacts": {
+      "address": {
+        "type": "Office",
+        "street": "1600 Amphitheatre Parkway",
+        "city": "Mountain View",
+        "state": "CA",
+        "zip": "94043",
+        "country": "United States"
+      }
+    },
+    "id": "1",
     "name": "Google Inc",
-    "updatedOn": "2011-12-14T10:45:46Z"
+    "about": "A comment here"
   }
 }

data/spec/support/person.json

@@ -1,9 +1,34 @@
 {
   "person": {
+    "contacts": {
+      "address": {
+        "type": "Office",
+        "street": "1600 Amphitheatre Parkway",
+        "city": "Mountain View",
+        "state": "CA",
+        "zip": "94043",
+        "country": "United States"
+      },
+      "email": {
+        "type": "Home",
+        "emailAddress": "e.schmidt@google.com"
+      },
+      "phone": {
+        "type": "Mobile",
+        "phoneNumber": "+1 888 555555"
+      },
+      "website": {
+        "type": "work",
+        "webService": "URL",
+        "webAddress": "www.google.com"
+      }
+    },
     "id": "100",
-    "lastName": "Schmidt",
-    "createdOn": "2011-09-14T15:22:01Z",
+    "title": "Mr",
     "firstName": "Eric",
-    "updatedOn": "2011-12-14T10:45:46Z"
+    "lastName": "Schmidt",
+    "jobTitle": "Chairman",
+    "organisationName": "Google Inc",
+    "about": "A comment here"
   }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capsule_crm
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Matt Beedle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -259,6 +259,7 @@ files:
 - lib/capsule_crm/associations/has_many.rb
 - lib/capsule_crm/associations/has_many_proxy.rb
 - lib/capsule_crm/attachment.rb
+- lib/capsule_crm/attributes.rb
 - lib/capsule_crm/capsule_jsonable.rb
 - lib/capsule_crm/case.rb
 - lib/capsule_crm/collection.rb