capsule_crm 1.2.0 → 1.3.0

data/lib/capsule_crm/opportunity.rb

@@ -7,8 +7,26 @@ module CapsuleCRM
     include ActiveModel::Validations
 
     include CapsuleCRM::Associations
-    include CapsuleCRM::Attributes
-    include CapsuleCRM::Collection
+    include CapsuleCRM::Querying::Findable
+    include CapsuleCRM::Persistence::Persistable
+    include CapsuleCRM::Persistence::Deletable
+    include CapsuleCRM::Serializable
+
+    serializable_config do |config|
+      config.excluded_keys = [:track_id]
+    end
+
+    queryable_config do |config|
+      config.plural = :opportunity
+    end
+
+    persistable_config do |config|
+      config.create = lambda do |opportunity|
+        path = "party/#{opportunity.party.try(:id)}/opportunity"
+        path += "?trackId=#{opportunity.track_id}" if opportunity.track_id
+        path
+      end
+    end
 
     attribute :id, Integer
     attribute :name, String
@@ -29,11 +47,13 @@ module CapsuleCRM
     validates :party, presence: true
     validates :milestone, presence: true
 
-    has_many :tasks, class_name: 'CapsuleCRM::Task', source: :opportunity
+    has_many :tasks
+    has_many :histories
+    has_many :custom_fields, embedded: true
 
-    belongs_to :party,     class_name: 'CapsuleCRM::Party'
-    belongs_to :milestone, class_name: 'CapsuleCRM::Milestone'
-    belongs_to :track,     class_name: 'CapsuleCRM::Track'
+    belongs_to :party
+    belongs_to :milestone
+    belongs_to :track
 
     def milestone=(milestone)
       if milestone.is_a?(String)
@@ -48,34 +68,6 @@ module CapsuleCRM
       raise NotImplementedError.new("There is no way to find opportunities by trackId in the Capsule API right now")
     end
 
-    # Public: Get all opportunities 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: {}):
-    #           :milestone      - The String milestone name
-    #           :lastmodified   - The Date when the opportunity was last modified
-    #           :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::Opportunity.all
-    #
-    # CapsuleCRM::Opportunity.all(start: 10, limit: 20)
-    #
-    # Returns a ResultsProxy of opportunities
-    def self.all(options = {})
-      init_collection(
-        CapsuleCRM::Connection.get(
-          '/api/opportunity', options
-        )['opportunities']['opportunity']
-      )
-    end
-
     # Public: Get all deleted opportunities since the specified date
     #
     # since - The Date to start checking for deleted opportunities
@@ -86,244 +78,11 @@ module CapsuleCRM
     #
     # Returns a ResultsProxy of opportunities
     def self.deleted(since)
-      init_collection(
-        CapsuleCRM::Connection.get(
-          '/api/opportunity/deleted', since: since
-        )['deletedOpportunities']['deletedOpportunity']
+      CapsuleCRM::Normalizer.new(
+        self, root: 'deletedOpportunity', collection_root: 'deletedOpportunities'
+      ).normalize_collection(
+        CapsuleCRM::Connection.get('/api/opportunity/deleted', since: since)
       )
     end
-
-    # Public: Find an opportunity by id
-    #
-    # id  - The Integer ID
-    #
-    # Examples
-    #
-    # CapsuleCRM::Opportunity.find(id)
-    #
-    # Returns a CapsuleCRM::Opportunity
-    def self.find(id)
-      new CapsuleCRM::Connection.get("/api/opportunity/#{id}")['opportunity']
-    end
-
-    # Public: Create a new opportunity in capsulecrm
-    #
-    # attributes  - The Hash of opportunity 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.create(name: 'Test', milestone_id: 1)
-    #
-    # Returns a CapsuleCRM::opportunity
-    def self.create(attributes = {})
-      new(attributes).tap(&:save)
-    end
-
-    # Public: Create a new opportunity in capsulecrm and raise a
-    # CapsuleCRM::Errors::InvalidRecord error if not possible
-    #
-    # attributes  - The Hash of opportunity 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.create!(name: 'Test', milestone_id: 1)
-    #
-    # Returns a CapsuleCRM
-    def self.create!(attributes = {})
-      new(attributes).tap(&:save!)
-    end
-
-    # Public: If the opportunity already exists in capsule then update them,
-    # otherwise create a new opportunity
-    #
-    # Examples
-    #
-    # opportunity = CapsuleCRM::Opportunity.new(name: 'Test', milestone_id: 1)
-    # opportunity.save
-    #
-    # opportunity = CapsuleCRM::Opportunity.find(1)
-    # opportunity.name = 'Another Test'
-    # opportunity.save
-    #
-    # Returns a CapsuleCRM::opportunity
-    def save
-      if valid?
-        new_record? ? create_record : update_record
-      else
-        false
-      end
-    end
-
-    # Public: If the opportunity already exists in capsule then update them,
-    # otherwise create a new opportunity. If the opportunity is not valid then a
-    # CapsuleCRM::Errors::RecordInvalid exception is raised
-    #
-    # Examples
-    #
-    # opportunity = CapsuleCRM::Opportunity.new(name: 'Test, milestone_id: 1)
-    # opportunity.save
-    #
-    # opportunity = CapsuleCRM::Opportunity.find(1)
-    # opportunity.name = 'Another test'
-    # opportunity.save
-    #
-    # Returns a CapsuleCRM::opportunity
-    def save!
-      if valid?
-        new_record? ? create_record : update_record
-      else
-        raise CapsuleCRM::Errors::RecordInvalid.new(self)
-      end
-    end
-
-    # Public: Determine whether this CapsuleCRM::opportunity is a new record or not
-    #
-    # Returns a Boolean
-    def new_record?
-      !id
-    end
-
-    # Public: Determine whether or not this CapsuleCRM::opportunity has already been
-    # persisted to capsulecrm
-    #
-    # Returns a Boolean
-    def persisted?
-      !new_record?
-    end
-
-    # Public: Update the opportunity in capsule
-    #
-    # attributes  - The Hash of opportunity 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
-    #
-    # opportunity = CapsuleCRM::Opportunity.find(1)
-    # opportunity.update_attributes name: 'A New Name'
-    #
-    # Returns a CapsuleCRM::opportunity
-    def update_attributes(attributes = {})
-      self.attributes = attributes
-      save
-    end
-
-    # Public: Update the opportunity in capsule. If the person is not valid then a
-    # CapsuleCRM::Errors::RecordInvalid exception will be raised
-    #
-    # attributes  - The Hash of opportunity 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
-    #
-    # opportunity = CapsuleCRM::Opportunity.find(1)
-    # opportunity.update_attributes! name: 'A New Name'
-    # => CapsuleCRM::Opportunity
-    #
-    # opportunity.update_attributes! name: nil
-    # => CapsuleCRM::Errors::RecordInvalid
-    #
-    # Returns a CapsuleCRM::opportunity
-    def update_attributes!(attributes = {})
-      self.attributes = attributes
-      save!
-    end
-
-    # Public: Build a hash of attributes and camelize the keys for capsule
-    #
-    # Examples
-    #
-    # opportunity.to_capsule_json
-    #
-    # Returns a Hash
-    def to_capsule_json
-      serializer.serialize
-    end
-
-    # Public: Delete the opportunity in capsule
-    #
-    # Examples
-    #
-    # opportunity.destroy
-    #
-    # Return the CapsuleCRM::Opportunity
-    def destroy
-      self.id = nil if CapsuleCRM::Connection.delete("/api/opportunity/#{id}")
-      self
-    end
-
-    private
-
-    def serializer
-      @serializer ||= CapsuleCRM::Serializer.new(self, excluded_keys: ['track_id'])
-    end
-
-    def create_record
-      path = "/api/party/#{party_id}/opportunity"
-      path += "?trackId=#{track_id}" if track_id
-      self.attributes = CapsuleCRM::Connection.post(path, to_capsule_json)
-      self
-    end
-
-    def update_record
-      CapsuleCRM::Connection.put("/api/opportunity/#{id}", attributes)
-      self
-    end
   end
 end

data/lib/capsule_crm/organization.rb

@@ -7,8 +7,25 @@ module CapsuleCRM
     extend ActiveModel::Conversion
     include ActiveModel::Validations
 
-    include CapsuleCRM::Collection
     include CapsuleCRM::Contactable
+    include CapsuleCRM::Persistence::Persistable
+    include CapsuleCRM::Persistence::Deletable
+    include CapsuleCRM::Querying::Configuration
+    include CapsuleCRM::Serializable
+
+    queryable_config do |config|
+      config.singular = :party
+    end
+
+    serializable_config do |config|
+      config.root               = :organisation
+      config.additional_methods = [:contacts]
+    end
+
+    persistable_config do |config|
+      config.create = lambda { |org| "organisation" }
+      config.destroy = lambda { |org| "party/#{org.id}" }
+    end
 
     attribute :id,    Integer
     attribute :name,  String
@@ -16,9 +33,7 @@ module CapsuleCRM
 
     validates :name, presence: true
 
-    has_many :people, class_name: 'CapsuleCRM::Person', source: :organization
-    has_many :custom_fields, class_name: 'CapsuleCRM::CustomField',
-      source: :party
+    has_many :people
 
     # Public: Get all people from Capsule. The list can be restricted
     # and/or paginated with various query parameters sent through the options
@@ -45,198 +60,5 @@ module CapsuleCRM
       CapsuleCRM::Party.all(options).
         delete_if { |item| !item.is_a?(CapsuleCRM::Organization) }
     end
-
-    # Public: Get an organization by ID
-    #
-    # id  - The Integer organization ID
-    #
-    # Examples
-    #
-    # CapsuleCRM::Organization.find(1)
-    #
-    # Returns a CapsuleCRM::Organization
-    def self.find(id)
-      new CapsuleCRM::Connection.get("/api/party/#{id}")['organisation']
-    end
-
-    # Public: Create a new organization in capsulecrm
-    #
-    # attributes  - The Hash of organization attributes (default: {}):
-    #               :name   - The String organization name
-    #               :about  - The String information about the organization
-    #
-    # Examples
-    #
-    # CapsuleCRM::Organization.create(name: 'Google Inc')
-    #
-    # Returns a CapsuleCRM::Organization
-    def self.create(attributes = {})
-      new(attributes).tap(&:save)
-    end
-
-    # Public: Create a new organization in capsulecrm and raise a
-    # CapsuleCRM::Errors::InvalidRecord error if not possible
-    #
-    # attributes  - The Hash of organization attributes (default: {}):
-    #               :name   - The String organization name
-    #               :about  - The String information about the organization
-    #
-    # Examples
-    #
-    # CapsuleCRM::Organization.create!(name: 'Google Inc')
-    #
-    # Returns a CapsuleCRM
-    def self.create!(attributes = {})
-      new(attributes).tap(&:save!)
-    end
-
-    # Public: If the organization already exists in capsule then update them,
-    # otherwise create a new organization
-    #
-    # Examples
-    #
-    # organization = CapsuleCRM::Organization.new(name: 'Google Inc')
-    # organization.save
-    #
-    # organization = CapsuleCRM::Organization.find(1)
-    # organization.name = 'Apple'
-    # organization.save
-    #
-    # Returns a CapsuleCRM::Organization
-    def save
-      if valid?
-        new_record? ? create_record : update_record
-      else
-        false
-      end
-    end
-
-    # Public: If the organization already exists in capsule then update them,
-    # otherwise create a new organization. If the organization is not valid
-    # then a CapsuleCRM::Errors::RecordInvalid exception is raised
-    #
-    # Examples
-    #
-    # organization = CapsuleCRM::Organization.new(name: 'Google Inc')
-    # organization.save!
-    #
-    # organization = CapsuleCRM::Organization.find(1)
-    # organization.name = 'Apple'
-    # organization.save!
-    #
-    # organization = CapsuleCRM::Organization.new
-    # organization.save!
-    # => CapsuleCRM::Errors::InvalidRecord
-    #
-    # Returns a CapsuleCRM::Organization
-    def save!
-      if valid?
-        new_record? ? create_record : update_record
-      else
-        raise CapsuleCRM::Errors::RecordInvalid.new(self)
-      end
-    end
-
-    # Public: Update the organization in capsule
-    #
-    # attributes  - The Hash of organization attributes (default: {}):
-    #               :name   - The String organization name
-    #               :about  - The String information about the organization
-    #
-    # Examples
-    #
-    # organization = CapsuleCRM::Organization.find(1)
-    # organization.update_attributes name: 'Google Inc'
-    # => true
-    #
-    # organization.update_attributes {}
-    # => false
-    #
-    # Returns a CapsuleCRM::Organization
-    def update_attributes(attributes = {})
-      self.attributes = attributes
-      save
-    end
-
-    # Public: Update the organization in capsule. If the organization is not
-    # valid then a CapsuleCRM::Errors::RecordInvalid exception will be raised
-    #
-    # attributes  - The Hash of organization attributes (default: {}):
-    #               :name   - The String organization name
-    #               :about  - The String information about the organization
-    #
-    # Examples
-    #
-    # organization = CapsuleCRM::Organization.find(1)
-    # organization.update_attributes! name: 'Microsoft'
-    # => true
-    #
-    # organization = CapsuleCRM::Organization.find(1)
-    # organization.update_attributes!
-    # => CapsuleCRM::Errors::RecordInvalid
-    #
-    # Returns a CapsuleCRM::Organization
-    def update_attributes!(attributes = {})
-      self.attributes = attributes
-      save!
-    end
-
-    # Public: Determine whether this CapsuleCRM::Organization is a new record
-    # or not
-    #
-    # Returns a Boolean
-    def new_record?
-      !id
-    end
-
-    # Public: Determine whether or not this CapsuleCRM::Organization 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
-    #
-    # organization.to_capsule_json
-    #
-    # Returns a Hash
-    def to_capsule_json
-      serializer.serialize
-    end
-
-    # Public: Delete the organization in capsule
-    #
-    # Examples
-    #
-    # organization.destroy
-    #
-    # Return the CapsuleCRM::Organization
-    def destroy
-      self.id = nil if CapsuleCRM::Connection.delete("/api/party/#{id}")
-      self
-    end
-
-    private
-
-    def serializer
-      @serializer ||= CapsuleCRM::Serializer.
-        new(self, root: :organisation, additional_methods: [:contacts])
-    end
-
-    def create_record
-      self.attributes = CapsuleCRM::Connection.post(
-        '/api/organisation', to_capsule_json
-      )
-    end
-
-    def update_record
-      CapsuleCRM::Connection.put("/api/organisation/#{id}", to_capsule_json)
-      self
-    end
   end
 end

data/lib/capsule_crm/party.rb

@@ -1,40 +1,27 @@
 class CapsuleCRM::Party
   include Virtus
 
-  include CapsuleCRM::Attributes
-  include CapsuleCRM::Taggable
   include CapsuleCRM::Associations
+  include CapsuleCRM::Querying::Findable
+  include CapsuleCRM::Serializable
+  include CapsuleCRM::Taggable
 
-  has_many :histories, class_name: 'CapsuleCRM::History', source: :party
-  has_many :tasks, class_name: 'CapsuleCRM::Task', source: :party
-
-  def self.all(options = {})
-    init_collection(
-      CapsuleCRM::Connection.get('/api/party', options)['parties']
-    )
+  serializable_config do |config|
+    config.root = [:organisation, :person]
   end
 
-  def self.find(id)
-    attributes = CapsuleCRM::Connection.get("/api/party/#{id}")
-    party_classes[attributes.keys.first].constantize.new(
-      attributes[attributes.keys.first]
-    )
+  queryable_config do |config|
+    config.plural = :party
   end
 
-  private
+  has_many :histories
+  has_many :tasks
+  has_many :custom_fields, embedded: true
+  has_many :cases
 
-  def self.init_collection(collection)
-    CapsuleCRM::ResultsProxy.new(
-      collection.map do |key, value|
-        next unless %w(organisation person).include?(key)
-        [collection[key]].flatten.map do |attrs|
-          party_classes[key].constantize.new(attrs)
-        end.flatten
-      end.flatten
-    )
-  end
+  private
 
-  def self.party_classes
+  def self.child_classes
     { person: 'CapsuleCRM::Person', organisation: 'CapsuleCRM::Organization' }.
       stringify_keys
   end

data/lib/capsule_crm/persistence/configuration.rb

@@ -0,0 +1,25 @@
+module CapsuleCRM
+  module Persistence
+    module Configuration
+      extend ActiveSupport::Concern
+
+      def self.included(base)
+        base.send :class_attribute, :connection_options
+
+        klass_name = base.to_s.demodulize.downcase
+
+        base.connection_options = OpenStruct.new(
+          create: lambda { |object| "#{klass_name.pluralize}" },
+          update: lambda { |object| "#{klass_name.singularize}/#{object.id}" },
+          destroy: lambda { |object| "#{klass_name.singularize}/#{object.id}" }
+        )
+      end
+
+      module ClassMethods
+        def persistable_config
+          yield(connection_options)
+        end
+      end
+    end
+  end
+end

data/lib/capsule_crm/persistence/deletable.rb

@@ -0,0 +1,14 @@
+module CapsuleCRM
+  module Persistence
+    module Deletable
+      def destroy
+        self.id = nil if CapsuleCRM::Connection.delete(build_destroy_path)
+        self
+      end
+
+      def build_destroy_path
+        "/api/#{self.class.connection_options.destroy.call(self)}"
+      end
+    end
+  end
+end