capsule_crm 0.1.6 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 808ce675363a8bae072d7242b8973f41cf5e0c08
-  data.tar.gz: edb34f7e67119375ed840b6da034b2fa653ea116
+  metadata.gz: 48c3f7884a088c4d42cee4aa450fc594c3f9fa96
+  data.tar.gz: 35822071aafa5ea3b7def6616e3e30003fb150ea
 SHA512:
-  metadata.gz: 5d0464a4804f4551450541ff4e237d9b04eb94581d074a7460b51eb4ab4dc6008109a98774778e597ad8c9534240e3899a291edb6cc7ad63253c92c9656f5628
-  data.tar.gz: 56388862805ba1ad015807817c545d9688930d87da6e4b96971e17d68e8d40a9a0adcfd9e92021d30419d69fe1e07db7b43a552ae92dd1c2cd728121d7a5327b
+  metadata.gz: 968f3d57a5f7228200488c74021a8c27d05269213094797fdd8124cb843f149cdfc9d1d1b9ffd2a3996fa44cc54b691f9f238bb8b84bf7fbc0a11d4e38376a3f
+  data.tar.gz: 782f7e740f951e5c7ca5114a1ea6f481b5638657f64c39f8210ff6da890a6342d03dedec30df05120d05f8d0c92d36ee0312289f619fa6749e90daec7ef42fee

data/capsule_crm.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('coveralls')
   gem.add_development_dependency('cucumber')
   gem.add_development_dependency('fabrication')
+  gem.add_development_dependency('faker')
   gem.add_development_dependency('guard')
   gem.add_development_dependency('guard-rspec')
   gem.add_development_dependency('rb-fsevent')

data/lib/capsule_crm/associations/belongs_to.rb

@@ -29,9 +29,10 @@ module CapsuleCRM
         # person.organisation
         # => organisation
         def belongs_to(association_name, options = {})
+          foreign_key = options[:foreign_key] || :"#{association_name}_id"
+
           class_eval do
-            attribute options[:foreign_key] ||
-              :"#{association_name}_id", Integer
+            attribute foreign_key, Integer
           end
 
           (class << self; self; end).instance_eval do
@@ -42,9 +43,9 @@ module CapsuleCRM
 
           define_method association_name do
             instance_variable_get(:"@#{association_name}") ||
-              if self.send("#{association_name}_id")
+              if self.send(foreign_key)
                 options[:class_name].constantize.
-                find(self.send("#{association_name}_id")).tap do |object|
+                find(self.send(foreign_key)).tap do |object|
                   self.send("#{association_name}=", object)
                 end
               else
@@ -55,7 +56,7 @@ module CapsuleCRM
           define_method "#{association_name}=" do |associated_object|
             instance_variable_set(:"@#{association_name}", associated_object)
             id = associated_object ? associated_object.id : nil
-            self.send "#{association_name}_id=", id
+            self.send "#{foreign_key}=", id
           end
         end
       end

data/lib/capsule_crm/associations/has_many.rb

@@ -11,15 +11,18 @@ module CapsuleCRM
         #
         # association_name  - The String name of the associated collection
         # options:          - The Hash of options (default: {}):
-        #                   class_name: The String name of the class used in the
-        #                   association
+        #                     :class_name - The String name of the class used in the
+        #                     association
+        #                     :source - the String method name used by the
+        #                     object on the belongs_to side of the association
+        #                     to set this object
         #
         # Examples
         #
         # class CapsuleCRM::Organizatio
         #   include CapsuleCRM::Associations::HasMany
         #
-        #   has_many :people, class_name: 'CapsuleCRM::Person'
+        #   has_many :people, class_name: 'CapsuleCRM::Person', source: :person
         # end
         #
         # organization = CapsuleCRM::Organization.find(1)
@@ -46,10 +49,14 @@ module CapsuleCRM
           end
 
           define_method "#{association_name}=" do |associated_objects|
+            if associated_objects.is_a?(Hash)
+              associated_objects = Array(options[:class_name].constantize.new(associated_objects[options[:class_name].demodulize.downcase]))
+            end
             instance_variable_set :"@#{association_name}",
               CapsuleCRM::Associations::HasManyProxy.new(
-                parent, associated_objects
-            )
+                self, options[:class_name].constantize,
+                associated_objects, options[:source]
+              )
           end
         end
       end

data/lib/capsule_crm/attachment.rb

@@ -0,0 +1,9 @@
+module CapsuleCRM
+  class Attachment
+    include Virtus
+
+    attribute :id,            Integer
+    attribute :filename,      String
+    attribute :content_type,  String
+  end
+end

data/lib/capsule_crm/country.rb

@@ -0,0 +1,21 @@
+module CapsuleCRM
+  class Country
+    include Virtus
+
+    attribute :name
+
+    # Public: Retrieve a list of countries from Capsule
+    #
+    # Examples
+    #
+    # CapsuleCRM::Country.all
+    #
+    # Returns an Array of CapsuleCRM::Country objects
+    def self.all
+      CapsuleCRM::Connection.
+        get('/api/countries')['countries']['country'].map do |country_name|
+        new name: country_name
+      end
+    end
+  end
+end

data/lib/capsule_crm/currency.rb

@@ -0,0 +1,25 @@
+module CapsuleCRM
+  class Currency
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    attribute :code, String
+
+    # Public: Retrieve a list of all currencies in Capsule
+    #
+    # Examples
+    #
+    # CapsuleCRM::Currency.all
+    #
+    # Returns an Array of CapsuleCRM::Currency objects
+    def self.all
+      CapsuleCRM::Connection.
+        get('/api/currencies')['currencies']['currency'].map do |currency_code|
+        new code: currency_code
+      end
+    end
+  end
+end

data/lib/capsule_crm/custom_field.rb

@@ -0,0 +1,39 @@
+module CapsuleCRM
+  class CustomField
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    attribute :id, Integer
+    attribute :date, DateTime
+    attribute :tag, String
+    attribute :boolean, Boolean
+    attribute :text, String
+    attribute :data_tag, String
+
+    def self.create(attributes = {})
+    end
+
+    def self.create!(attribute = {})
+    end
+
+    def save
+    end
+
+    def save!
+    end
+
+    def destroy
+    end
+
+    private
+
+    def create_record
+    end
+
+    def update_record
+    end
+  end
+end

data/lib/capsule_crm/history.rb

@@ -0,0 +1,324 @@
+module CapsuleCRM
+  class History
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    include CapsuleCRM::Associations
+
+    attribute :id, Integer
+    attribute :type, String
+    attribute :entry_date, DateTime
+    attribute :subject, String
+    attribute :note, String
+
+    has_many :attachments,  class_name: 'CapsuleCRM::Attachment'
+    has_many :participants, class_name: 'CapsuleCRM::Participant'
+
+    belongs_to :creator,      class_name: 'CapsuleCRM::Person'
+    belongs_to :party,        class_name: 'CapsuleCRM::Party'
+    belongs_to :kase,         class_name: 'CapsuleCRM::Case',
+      foreign_key: :case_id
+    belongs_to :opportunity,  class_name: 'CapsuleCRM::Opportunity'
+
+    validates :note, presence: true
+    validates :party, :kase, :opportunity,
+      presence: { if: :belongs_to_required? }
+
+    # 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
+    #
+    # Examples
+    #
+    # CapsuleCRM::History.find(2)
+    #
+    # Returns a CapsuleCRM::History object
+    def self.find(id)
+      new CapsuleCRM::Connection.get("/api/history/#{id}")['historyItem']
+    end
+
+    # Public: Set the creator of this history item
+    #
+    # user  - The String username OR a CapsuleCRM::User object
+    #
+    # Examples
+    #
+    # history = CapsuleCRM::History.new
+    # history.creator = 'a.username'
+    #
+    # user = CapsuleCRM::User.find_by_username('another.username')
+    # history.creator = user
+    #
+    # Returns the CapsuleCRM::History object
+    def creator=(user)
+      if user.is_a?(String)
+        user = CapsuleCRM::User.find_by_username(user)
+      end
+      @creator = user
+      self
+    end
+
+    # Public: create a CapsuleCRM::History item and persist it
+    #
+    # attributes  - The Hash of attributes (default: {}):
+    #               :note       - The String note
+    #               :creator    - The CapsuleCRM::User who created this history
+    #               item
+    #               :entry_date   - The date when this history item was created
+    #
+    # Examples
+    #
+    # CapsuleCRM::History.create(note: 'Some history note text')
+    #
+    # person = CapsuleCRM::User.find_by_username('some.username')
+    # CapsuleCRM::History.create(
+    #   note: 'another note to add to the history', person: person,
+    #   entry_date: Time.now
+    # )
+    #
+    # Returns a CapsuleCRM::History object
+    def self.create(attributes = {})
+      new(attributes).tap(&:save)
+    end
+
+    # Public: create a CapsuleCRM::History item and persist it. If persistence
+    # is not possible then raise an error
+    #
+    # attributes  - The Hash of attributes (default: {}):
+    #               :note       - The String note
+    #               :creator    - The CapsuleCRM::User who created this history
+    #               item
+    #               :entry_date   - The date when this history item was created
+    #
+    # Examples
+    #
+    # CapsuleCRM::History.create!(note: 'Some history note text')
+    #
+    # person = CapsuleCRM::User.find_by_username('some.username')
+    # CapsuleCRM::History.create!(
+    #   note: 'another note to add to the history', person: person,
+    #   entry_date: Time.now
+    # )
+    #
+    # CapsuleCRM::History.create! {}
+    # => CapsuleCRM::Errors::RecordInvalid
+    #
+    # Returns a CapsuleCRM::History object
+    def self.create!(attributes = {})
+      new(attributes).tap(&:save!)
+    end
+
+    # Public: update the attributes of a CapsuleCRM::History item and persist
+    # the changes
+    #
+    # attributes  - The Hash of attributes (default: {}):
+    #               :note         - The String note
+    #               :creator      - The String creator username OR
+    #               a CapsuleCRM::Person object
+    #               :entry_date   - The DateTime when the history item was
+    #               created
+    #
+    # Examples
+    #
+    # history = CapsuleCRM::History.find(1)
+    # history.update_attributes note: 'some updated note text'
+    #
+    # Returns a CapsuleCRM::History item or false
+    def update_attributes(attributes = {})
+      self.attributes = attributes
+      save
+    end
+
+    # Public: update the attributes of a CapsuleCRM::History item and persist
+    # the changes. If persistence is not possible then raise an error
+    #
+    # attributes  - The Hash of attributes (default: {}):
+    #               :note         - The String note
+    #               :creator      - The String creator username OR
+    #               a CapsuleCRM::Person object
+    #               :entry_date   - The DateTime when the history item was
+    #               created
+    #
+    # Examples
+    #
+    # history = CapsuleCRM::History.find(1)
+    # history.update_attributes note: 'some updated note text'
+    #
+    # history.update_attributes note: nil
+    # => CapsuleCRM::Errors::RecordInvalid
+    #
+    # Returns a CapsuleCRM::History item or a CapsuleCRM::Errors::RecordInvalid
+    def update_attributes!(attributes = {})
+      self.attributes = attributes
+      save!
+    end
+
+    # Public: Save this history item. If it is already existing in capsule crm
+    # then update it, otherwise create a new one
+    #
+    # Examples
+    #
+    # CapsuleCRM::History.new(note: 'some note text').save
+    #
+    # Returns a CapsuleCRM::History object of false
+    def save
+      if valid?
+        new_record? ? create_record : update_record
+      else
+        false
+      end
+    end
+
+    # Public: Save this history item. If it is already existing in capsule crm
+    # then update it, otherwise create a new one. If persistence is not possible
+    # then raise an error
+    #
+    # Examples
+    #
+    # CapsuleCRM::History.new(note: 'the note text').save!
+    #
+    # CapsuleCRM::History.new.save!
+    # => CapsuleCRM::Errors::RecordInvalid
+    #
+    # Returns a CapsuleCRM::History object
+    def save!
+      if valid?
+        new_record? ? create_record : update_record
+      else
+        raise CapsuleCRM::Errors::RecordInvalid.new(self)
+      end
+    end
+
+    # Public: Delete this history item from capsule crm.
+    #
+    # Examples
+    #
+    # CapsuleCRM::History.find(1).destroy
+    #
+    # Returns the CapsuleCRM::History object
+    def destroy
+      self.id = nil if CapsuleCRM::Connection.delete("/api/history/#{id}")
+      self
+    end
+
+    # Public: Is this history item a new record?
+    #
+    # Examples
+    #
+    # CapsuleCRM::History.new.new_record?
+    # => true
+    #
+    # CapsuleCRM::History.find(1).new_record?
+    # => false
+    def new_record?
+      !id
+    end
+
+    # Public: Is this history item persisted?
+    #
+    # Examples
+    #
+    # CapsuleCRM::History.new.persisted?
+    # => fale
+    #
+    # CapsuleCRM::History.find(1).persisted?
+    # => true
+    def persisted?
+      !new_record?
+    end
+
+    # Public: Generate the attributes hash to send to capsule
+    #
+    # Examples
+    #
+    # CapsuleCRM::History.find(1).to_capsule_json
+    #
+    # Returns a Hash of attributes
+    def to_capsule_json
+      {
+        historyItem: CapsuleCRM::HashHelper.camelize_keys(
+          {
+            note: note, entry_date: entry_date, creator: creator.try(:username)
+          }.delete_if { |key, value| value.blank? }
+        )
+      }
+    end
+
+    private
+
+    def belongs_to_required?
+      party.blank? && kase.blank? && opportunity.blank?
+    end
+
+    def create_record
+      self.attributes = CapsuleCRM::Connection.post(
+        "/api/#{belongs_to_api_name}/#{belongs_to_id}/history", to_capsule_json
+      )
+      self
+    end
+
+    def belongs_to_api_name
+      {
+        person: 'party', organization: 'party', case: 'kase',
+        opportunity: 'opportunity'
+      }.stringify_keys[belongs_to_name]
+    end
+
+    def belongs_to_name
+      (party || kase || opportunity).class.to_s.demodulize.downcase
+    end
+
+    def belongs_to_id
+      (party || kase || opportunity).id
+    end
+
+    def update_record
+      CapsuleCRM::Connection.put("/api/history/#{id}", to_capsule_json)
+    end
+  end
+end

data/lib/capsule_crm/participant.rb

@@ -0,0 +1,21 @@
+module CapsuleCRM
+  class Participant
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+
+    attribute :name,          String
+    attribute :email_address,  String
+    attribute :role,          String
+
+    def self._for_history(history_id)
+      CapsuleCRM::ResultsProxy.new([])
+    end
+
+    def to_capsule_json
+      CapsuleCRM::HashHelper.camelize_keys(attributes.dup)
+    end
+  end
+end

data/lib/capsule_crm/party.rb

@@ -1,6 +1,10 @@
 class CapsuleCRM::Party
   include CapsuleCRM::Taggable
 
+  include CapsuleCRM::Associations::HasMany
+
+  has_many :histories, class_name: 'CapsuleCRM::History'
+
   def self.all(options = {})
     attributes = CapsuleCRM::Connection.get('/api/party', options)
     init_collection(

data/lib/capsule_crm/user.rb

@@ -30,5 +30,9 @@ module CapsuleCRM
         end
       )
     end
+
+    def self.find_by_username(username)
+      all.select { |user| user.username == username }.first
+    end
   end
 end

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = '0.1.6'
+  VERSION = '0.4.6'
 end

data/lib/capsule_crm.rb

@@ -8,7 +8,12 @@ require 'capsule_crm/associations'
 require 'capsule_crm/address'
 require 'capsule_crm/case'
 require 'capsule_crm/connection'
+
+require 'capsule_crm/attachment'
+require 'capsule_crm/country'
+require 'capsule_crm/currency'
 require 'capsule_crm/email'
+require 'capsule_crm/history'
 require 'capsule_crm/party'
 require 'capsule_crm/phone'
 require 'capsule_crm/tag'
@@ -22,6 +27,7 @@ require 'capsule_crm/contactable'
 require 'capsule_crm/configuration'
 require 'capsule_crm/opportunity'
 require 'capsule_crm/organization'
+require 'capsule_crm/participant'
 require 'capsule_crm/person'
 require 'capsule_crm/version'
 

data/spec/fabricators/case_fabricator.rb

@@ -0,0 +1,3 @@
+Fabricator(:case, class_name: :'CapsuleCRM::Case') do
+  name { Faker::Lorem.sentence }
+end

data/spec/fabricators/history_fabricator.rb

@@ -0,0 +1,3 @@
+Fabricator(:history, class_name: :'CapsuleCRM::History') do
+  note { Faker::Lorem.paragraph }
+end

data/spec/fabricators/person_fabricator.rb

@@ -0,0 +1,3 @@
+Fabricator(:person, class_name: :'CapsuleCRM::Person') do
+  first_name { Faker::Name.first_name }
+end

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

@@ -1,4 +1,8 @@
 require 'spec_helper'
 
 describe CapsuleCRM::Associations::HasMany do
+
+  describe '#has_many' do
+    pending
+  end
 end

data/spec/lib/capsule_crm/country_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe CapsuleCRM::Country do
+  before { configure }
+
+  describe '.all' do
+    before do
+      stub_request(:get, /\/api\/countries$/).
+        to_return(body: File.read('spec/support/countries.json'))
+    end
+
+    subject { CapsuleCRM::Country.all }
+
+    it { should be_a(Array) }
+
+    it { subject.count.should eql(2) }
+
+    it do
+      subject.all? { |item| item.is_a?(CapsuleCRM::Country) }.should be_true
+    end
+  end
+end

data/spec/lib/capsule_crm/currency_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe CapsuleCRM::Currency do
+  before { configure }
+
+  describe '.all' do
+    before do
+      stub_request(:get, /\/api\/currencies$/).
+        to_return(body: File.read('spec/support/currencies.json'))
+    end
+
+    subject { CapsuleCRM::Currency.all }
+
+    it { should be_a(Array) }
+
+    it { subject.length.should eql(3) }
+
+    it do
+      subject.all? { |item| item.is_a?(CapsuleCRM::Currency) }.should be_true
+    end
+
+    it { subject.first.code.should eql('AUD') }
+  end
+end