capsule_crm 1.2.0 → 1.3.0

data/lib/capsule_crm/custom_field.rb

@@ -7,8 +7,17 @@ module CapsuleCRM
     include ActiveModel::Validations
 
     include CapsuleCRM::Associations
-    include CapsuleCRM::Attributes
-    include CapsuleCRM::Collection
+    include CapsuleCRM::Querying::Configuration
+    include CapsuleCRM::Serializable
+
+    serializable_config do |config|
+      config.root = 'customField'
+      config.collection_root = 'customFields'
+    end
+
+    queryable_config do |config|
+      config.plural = 'customfields'
+    end
 
     attribute :id, Integer
     attribute :label, String
@@ -20,62 +29,13 @@ module CapsuleCRM
     validates :id, numericality: { allow_blank: true }
     validates :label, presence: true
 
-    belongs_to :party, class_name: 'CapsuleCRM::Party'
-
-    def self._for_party(party_id)
-      init_collection(
-        CapsuleCRM::Connection.
-          get("/api/party/#{party_id}/customfields")['customFields'].
-          fetch('customField', nil)
-      )
-    end
+    belongs_to :party
+    belongs_to :opportunity
+    belongs_to :case
 
     class << self
       alias :_for_organization :_for_party
       alias :_for_person :_for_party
     end
-
-    def self.create(attributes = {})
-      new(attributes).tap(&:save)
-    end
-
-    def self.create!(attribute = {})
-      new(attributes).tap(&:save)
-    end
-
-    def save
-      if valid?
-        update_record
-      else
-        false
-      end
-    end
-
-    def save!
-      if valid?
-        update_record
-      else
-        raise CapsuleCRM::Errors::RecordInvalid.new(self)
-      end
-    end
-
-    def destroy
-    end
-
-    def to_capsule_json
-      { 'customFields' => serializer.serialize }
-    end
-
-    private
-
-    def serializer
-      @serializer ||= CapsuleCRM::Serializer.new(self, root: 'customField')
-    end
-
-    def update_record
-      CapsuleCRM::Connection.post(
-        "/api/party/#{party.id}/customfields", to_capsule_json
-      )
-    end
   end
 end

data/lib/capsule_crm/custom_field_definition.rb

@@ -0,0 +1,36 @@
+module CapsuleCRM
+  class CustomFieldDefinition
+    include Virtus
+    include CapsuleCRM::Serializable
+    include CapsuleCRM::Gettable
+
+    serializable_config do |config|
+      config.collection_root = :customFieldDefinitions
+      config.root = :customFieldDefinition
+    end
+
+    attribute :id, Integer
+    attribute :tag, String
+    attribute :label, String
+    attribute :type, String
+    attribute :options, String
+
+    def self.for_parties
+      normalizer.normalize_collection get('/api/party/customfield/definitions')
+    end
+
+    def self.for_opportunities
+      normalizer.normalize_collection(
+        get('/api/opportunity/customfield/definitions')
+      )
+    end
+
+    def self.for_cases
+      normalizer.normalize_collection get('/api/kase/customfield/definitions')
+    end
+
+    def self.normalizer
+      @normalizer ||= CapsuleCRM::Normalizer.new(self)
+    end
+  end
+end

data/lib/capsule_crm/email.rb

@@ -1,11 +1,12 @@
 module CapsuleCRM
   class Email
     include Virtus
-
+    include CapsuleCRM::Serializable
     extend  ActiveModel::Naming
-    include ActiveModel::Serializers::JSON
 
-    include CapsuleCRM::CapsuleJsonable
+    serializable_config do |config|
+      config.include_root = false
+    end
 
     attribute :type
     attribute :email_address

data/lib/capsule_crm/gettable.rb

@@ -0,0 +1,11 @@
+module CapsuleCRM
+  module Gettable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def get(path)
+        CapsuleCRM::Connection.get(path)
+      end
+    end
+  end
+end

data/lib/capsule_crm/hash_helper.rb

@@ -8,6 +8,11 @@ module CapsuleCRM
       end
     end
 
+    def self.underscore_keys(hash)
+      underscore_keys!(hash)
+      hash
+    end
+
     def self.camelize_keys!(hash)
       hash.keys.each do |key|
         hash[key.to_s.camelize(:lower)] = hash.delete(key)

data/lib/capsule_crm/history.rb

@@ -7,8 +7,26 @@ module CapsuleCRM
     include ActiveModel::Validations
 
     include CapsuleCRM::Associations
-    include CapsuleCRM::Attributes
-    include CapsuleCRM::Collection
+    include CapsuleCRM::Persistence::Persistable
+    include CapsuleCRM::Persistence::Deletable
+    include CapsuleCRM::Querying::Configuration
+    include CapsuleCRM::Querying::FindOne
+    include CapsuleCRM::Serializable
+
+    persistable_config do |config|
+      config.create = lambda do |history|
+        "#{history.belongs_to_api_name}/#{history.belongs_to_id}/history"
+      end
+    end
+
+    serializable_config do |config|
+      config.root            = :historyItem
+      config.collection_root = :history
+    end
+
+    queryable_config do |config|
+      config.plural = :history
+    end
 
     attribute :id, Integer
     attribute :type, String
@@ -16,63 +34,25 @@ module CapsuleCRM
     attribute :subject, String
     attribute :note, String
 
-    has_many :attachments,  class_name: 'CapsuleCRM::Attachment'
-    has_many :participants, class_name: 'CapsuleCRM::Participant'
+    has_many :attachments
+    has_many :participants
 
-    belongs_to :creator,      class_name: 'CapsuleCRM::Person',
-      serializable_key: :creator
-    belongs_to :party,        class_name: 'CapsuleCRM::Party', serialize: false
-    belongs_to :kase,         class_name: 'CapsuleCRM::Case',
-      foreign_key: :case_id, serialize: false
-    belongs_to :opportunity,  class_name: 'CapsuleCRM::Opportunity',
-      serialize: false
+    belongs_to :creator,      serializable_key: :creator,
+      class_name: 'CapsuleCRM::Person'
+    belongs_to :party,        serialize: false
+    belongs_to :case,         serialize: false
+    belongs_to :opportunity,  serialize: false
 
     validates :id, numericality: { allow_blank: true }
     validates :note, presence: true
-    validates :party, :kase, :opportunity,
+    validates :party, :case, :opportunity,
       presence: { if: :belongs_to_required? }
 
-    def self._for_party(party_id)
-      init_collection(
-        CapsuleCRM::Connection.
-          get("/api/party/#{party_id}/history")['history'].
-          fetch('historyItem', nil)
-      )
-    end
-
     class << self
       alias :_for_organization :_for_party
       alias :_for_person :_for_party
     end
 
-    def self._for_case(case_id)
-      init_collection(
-        CapsuleCRM::Connection.
-          get("/api/kase/#{case_id}/history")['history']['historyItem']
-      )
-    end
-
-    def self._for_opportunity(opportunity_id)
-      init_collection(
-        CapsuleCRM::Connection.
-          get("/api/opportunity/#{opportunity_id}/history")\
-          ['history']['historyItem']
-      )
-    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
@@ -94,220 +74,25 @@ module CapsuleCRM
       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
-      serializer.serialize
-    end
-
-    private
-
-    def serializer
-      @serializer ||= CapsuleCRM::Serializer.new(self, root: :historyItem)
-    end
-
-    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',
+        person: 'party', organization: 'party', case: 'case',
         opportunity: 'opportunity'
       }.stringify_keys[belongs_to_name]
     end
 
-    def belongs_to_name
-      (party || kase || opportunity).class.to_s.demodulize.downcase
+    def belongs_to_id
+      (party || self.case || opportunity).try(:id)
     end
 
-    def belongs_to_id
-      (party || kase || opportunity).id
+    private
+
+    def belongs_to_required?
+      party.blank? && self.case.blank? && opportunity.blank?
     end
 
-    def update_record
-      CapsuleCRM::Connection.put("/api/history/#{id}", to_capsule_json)
+    def belongs_to_name
+      (party || self.case || opportunity).class.to_s.demodulize.downcase
     end
   end
 end

data/lib/capsule_crm/milestone.rb

@@ -1,8 +1,15 @@
 module CapsuleCRM
   class Milestone
-    include Virtus
-    include CapsuleCRM::Collection
     include ActiveModel::Validations
+    include Virtus
+
+    include CapsuleCRM::Querying::Configuration
+    include CapsuleCRM::Querying::FindAll
+    include CapsuleCRM::Serializable
+
+    queryable_config do |config|
+      config.plural = 'opportunity/milestones'
+    end
 
     attribute :id, Integer
     attribute :name, String
@@ -12,13 +19,6 @@ module CapsuleCRM
 
     validates :id, numericality: { allow_blank: true }
 
-    def self.all
-      init_collection(
-        CapsuleCRM::Connection.
-          get('/api/opportunity/milestones')['milestones']['milestone']
-      )
-    end
-
     def self.find(id)
       all.select { |item| item.id == id }.first
     end

data/lib/capsule_crm/normalizer.rb

@@ -0,0 +1,85 @@
+module CapsuleCRM
+  class Normalizer
+    attr_reader :klass, :options
+
+    def initialize(klass, options = {})
+      @klass   = klass
+      @options = options
+    end
+
+    def normalize(attrs = {})
+      subclasses? ? normalize_subclass(attrs) : normalize_single(attrs)
+    end
+
+    def normalize_collection(attrs)
+      if subclasses?
+        normalize_subclass_collection(attrs)
+      else
+        normalize_standard_collection(attrs)
+      end
+    end
+
+    private
+
+    def root
+      @root ||= options[:root] || klass.serializable_options.root
+    end
+
+    def collection_root
+      @collection_root ||= options[:collection_root] ||
+        klass.serializable_options.collection_root
+    end
+
+    def attribute_to_assign
+      @attribute_to_assign ||= klass.serializable_options.attribute_to_assign
+    end
+
+    def normalize_subclass(attrs)
+      hash_helper.underscore_keys!(attrs[attrs.keys.first])
+      klass.child_classes[attrs.keys.first].constantize.new(
+        attrs[attrs.keys.first]
+      )
+    end
+
+    def normalize_single(attrs)
+      hash_helper.underscore_keys!(attrs[root.to_s])
+      klass.new(attrs[root.to_s])
+    end
+
+    def normalize_subclass_collection(attrs)
+      [].tap do |objects|
+        attrs[collection_root.to_s].each do |key, value|
+          next unless klass.child_classes.keys.include?(key)
+          if value.is_a?(Hash)
+            objects << klass.child_classes[key].constantize.
+              new(hash_helper.underscore_keys(value))
+          else
+            value.each do |attributes|
+              objects << klass.child_classes[key].constantize.
+                new(hash_helper.underscore_keys(attributes))
+            end
+          end
+        end
+      end
+    end
+
+    def normalize_standard_collection(attrs)
+      return [] unless attrs[collection_root.to_s][root.to_s]
+      [attrs[collection_root.to_s][root.to_s]].flatten.map do |singular|
+        if attribute_to_assign
+          klass.new attribute_to_assign => singular
+        else
+          klass.new hash_helper.underscore_keys(singular)
+        end
+      end
+    end
+
+    def subclasses?
+      root.is_a?(Array)
+    end
+
+    def hash_helper
+      @hash_helper ||= CapsuleCRM::HashHelper
+    end
+  end
+end