capsule_crm 1.2.0 → 1.3.0

data/lib/capsule_crm/persistence/persistable.rb

@@ -0,0 +1,76 @@
+module CapsuleCRM
+  module Persistence
+    module Persistable
+      extend ActiveSupport::Concern
+
+      def self.included(base)
+        base.send :include, CapsuleCRM::Persistence::Configuration
+        base.extend CapsuleCRM::Persistence::Persistable::ClassMethods
+      end
+
+      module ClassMethods
+        def create(attributes = {})
+          new(attributes).tap(&:save)
+        end
+
+        def create!(attributes = {})
+          new(attributes).tap(&:save!)
+        end
+      end
+
+      def save
+        if valid?
+          new_record? ? create_record : update_record
+        else
+          false
+        end
+      end
+
+      def save!
+        if valid?
+          new_record? ? create_record : update_record
+        else
+          raise CapsuleCRM::Errors::RecordInvalid.new(self)
+        end
+      end
+
+      def update_attributes(attributes = {})
+        self.attributes = attributes
+        save
+      end
+
+      def update_attributes!(attributes = {})
+        self.attributes = attributes
+        save!
+      end
+
+      def new_record?
+        !id
+      end
+
+      def persisted?
+        !new_record?
+      end
+
+      def create_record
+        self.attributes = CapsuleCRM::Connection.post(
+          build_create_path, to_capsule_json
+        )
+        self
+      end
+
+      def build_create_path
+        "/api/#{self.class.connection_options.create.call(self)}"
+      end
+
+      def build_update_path
+        "/api/#{self.class.connection_options.update.call(self)}"
+      end
+
+      def update_record
+        CapsuleCRM::Connection.put(build_update_path, to_capsule_json)
+        self
+      end
+    end
+  end
+end

data/lib/capsule_crm/persistence.rb

@@ -0,0 +1,3 @@
+require_relative 'persistence/configuration'
+require_relative 'persistence/deletable'
+require_relative 'persistence/persistable'

data/lib/capsule_crm/person.rb

@@ -1,12 +1,29 @@
 module CapsuleCRM
   class Person < CapsuleCRM::Party
-    include CapsuleCRM::Collection
     include CapsuleCRM::Contactable
+    include CapsuleCRM::Persistence::Persistable
+    include CapsuleCRM::Persistence::Deletable
+    include CapsuleCRM::Querying::Configuration
+    include CapsuleCRM::Serializable
 
     extend ActiveModel::Naming
     include ActiveModel::Conversion
     include ActiveModel::Validations
 
+    serializable_config do |config|
+      config.collection_root    = :parties
+      config.additional_methods = [:contacts]
+    end
+
+    queryable_config do |config|
+      config.singular = :party
+    end
+
+    persistable_config do |config|
+      config.create = lambda { |person| "person" }
+      config.destroy = lambda { |person| "party/#{person.id}" }
+    end
+
     attribute :id, Integer
     attribute :title
     attribute :first_name
@@ -15,24 +32,12 @@ module CapsuleCRM
     attribute :about
     attribute :organisation_name
 
-    belongs_to :organization, class_name: 'CapsuleCRM::Organization',
-      foreign_key: :organisation_id
-
-    has_many :custom_fields, class_name: 'CapsuleCRM::CustomField',
-      source: :party
+    belongs_to :organization, foreign_key: :organisation_id
 
     validates :id, numericality: { allow_blank: true }
     validates :first_name, presence: { if: :first_name_required? }
     validates :last_name, presence: { if: :last_name_required? }
 
-    def self._for_organization(organization_id)
-      init_collection(
-        CapsuleCRM::Connection.get(
-          "/api/party/#{organization_id}/people"
-        )['parties']['person']
-      )
-    end
-
     # Public: Get all people from Capsule. The list can be restricted
     # and/or paginated with various query parameters sent through the options
     # hash.
@@ -59,188 +64,8 @@ module CapsuleCRM
         delete_if { |item| !item.is_a?(CapsuleCRM::Person) }
     end
 
-    # Public: Create a new person in capsulecrm
-    #
-    # 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::Person
-    def self.create(attributes = {})
-      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,
-    # otherwise create a new person
-    #
-    # 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
-        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
-
-    # Public: Update the person in capsule
-    #
-    # 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
-
-    # 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
-    #
-    # Returns a Boolean
-    def new_record?
-      !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
-      serializer.serialize
-    end
-
     private
 
-    def serializer
-      @serializer ||= CapsuleCRM::Serializer.
-        new(self, additional_methods: [:contacts])
-    end
-
-    def create_record
-      self.attributes = CapsuleCRM::Connection.post(
-        '/api/person', to_capsule_json
-      )
-      self
-    end
-
-    def update_record
-      CapsuleCRM::Connection.put("/api/person/#{id}", to_capsule_json)
-      self
-    end
-
     # Private: Determines whether the person first name is required. Either the
     # first or the last name is always required
     #

data/lib/capsule_crm/phone.rb

@@ -1,11 +1,12 @@
 module CapsuleCRM
   class Phone
     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 :phone_number

data/lib/capsule_crm/querying/configuration.rb

@@ -0,0 +1,21 @@
+module CapsuleCRM
+  module Querying
+    module Configuration
+      def self.included(base)
+        base.send :class_attribute, :queryable_options
+        base.extend CapsuleCRM::Querying::Configuration::ClassMethods
+
+        base.queryable_options = OpenStruct.new(
+          plural: base.to_s.demodulize.downcase.pluralize,
+          singular: base.to_s.demodulize.downcase.singularize
+        )
+      end
+
+      module ClassMethods
+        def queryable_config
+          yield(queryable_options)
+        end
+      end
+    end
+  end
+end

data/lib/capsule_crm/querying/find_all.rb

@@ -0,0 +1,16 @@
+module CapsuleCRM
+  module Querying
+    module FindAll
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def all(options = {})
+          CapsuleCRM::Normalizer.new(self).normalize_collection(
+            CapsuleCRM::Connection.
+            get("/api/#{queryable_options.plural}", options)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/capsule_crm/querying/find_one.rb

@@ -0,0 +1,14 @@
+module CapsuleCRM
+  module Querying
+    module FindOne
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def find(id)
+          from_capsule_json CapsuleCRM::Connection.
+            get("/api/#{queryable_options.singular}/#{id}")
+        end
+      end
+    end
+  end
+end

data/lib/capsule_crm/querying/findable.rb

@@ -0,0 +1,14 @@
+require_relative 'find_all'
+require_relative 'find_one'
+
+module CapsuleCRM
+  module Querying
+    module Findable
+      def self.included(base)
+        base.send :include, CapsuleCRM::Querying::Configuration
+        base.send :include, CapsuleCRM::Querying::FindAll
+        base.send :include, CapsuleCRM::Querying::FindOne
+      end
+    end
+  end
+end

data/lib/capsule_crm/querying.rb

@@ -0,0 +1,4 @@
+require_relative 'querying/configuration'
+require_relative 'querying/findable'
+require_relative 'querying/find_one'
+require_relative 'querying/find_all'

data/lib/capsule_crm/serializable.rb

@@ -0,0 +1,38 @@
+module CapsuleCRM
+  module Serializable
+    extend ActiveSupport::Concern
+
+    # We need to use "self.included" here instead of "included do" to make sure
+    # that organizations and people don't inherit a pointer to the
+    # serializable_options of their parent class and modify that.
+    def self.included(base)
+      base.send :class_attribute, :serializable_options
+
+      base.serializable_options = OpenStruct.new(
+        collection_root: base.to_s.demodulize.downcase.pluralize,
+        root: base.to_s.demodulize.downcase.singularize,
+        include_root: true,
+        excluded_keys: [],
+        additional_methods: []
+      )
+    end
+
+    def to_capsule_json
+      serializer.serialize(self)
+    end
+
+    def serializer
+      @serializer ||= CapsuleCRM::Serializer.new(self.serializable_options)
+    end
+
+    module ClassMethods
+      def from_capsule_json(json)
+        CapsuleCRM::Normalizer.new(self).normalize(json)
+      end
+
+      def serializable_config
+        yield(serializable_options)
+      end
+    end
+  end
+end

data/lib/capsule_crm/serializer.rb

@@ -2,13 +2,35 @@ module CapsuleCRM
   class Serializer
     attr_reader :object, :options
 
-    def initialize(object, options = {})
-      @object  = object
+    def initialize(options = {})
       @options = options
     end
 
-    def serialize
-      @serialized ||= { root => build_attributes_hash }.stringify_keys
+    def serialize(object)
+      @object = object
+      @serialized ||=
+        if include_root?
+          serialize_with_root
+        else
+          serialize_without_root
+        end
+    end
+
+    def self.serialize_collection(klass, collection)
+      collection = collection.map do |item|
+        options = klass.serializable_options
+        options.include_root = false
+        ::CapsuleCRM::Serializer.new(options).serialize(item)
+      end
+      { klass.serializable_options.root => collection }
+    end
+
+    def serialize_with_root
+      { root => build_attributes_hash }.stringify_keys
+    end
+
+    def serialize_without_root
+      build_attributes_hash
     end
 
     def root
@@ -16,8 +38,16 @@ module CapsuleCRM
         object.class.to_s.demodulize.downcase.singularize.camelize(:lower)
     end
 
+    def collection_root
+      @collection_root ||= options[:collection_root] || root.pluralize
+    end
+
     private
 
+    def include_root?
+      @include_root ||= true unless options[:include_root] == false
+    end
+
     def additional_methods
       @additional_methods ||= options[:additional_methods] || []
     end
@@ -30,20 +60,37 @@ module CapsuleCRM
       CapsuleCRM::HashHelper.camelize_keys(cleaned_attributes)
     end
 
+    def excluded_association_keys
+      @excluded_association_keys ||=
+        if object.class.respond_to?(:belongs_to_associations)
+          object.class.belongs_to_associations.map do |name, association|
+          association.foreign_key if association.inverse.try(:embedded)
+        end.compact
+        else
+          []
+        end
+    end
+
     def cleaned_attributes
       attributes.delete_if do |key, value|
-        value.blank? || key.to_s == 'id' || excluded_keys.include?(key)
+        value.blank? || key.to_s == 'id' || excluded_keys.include?(key) ||
+          excluded_association_keys.include?(key.to_s)
       end
     end
 
+    # TODO OMG, clean this up!
     def attributes
       object.attributes.dup.tap do |attrs|
         attrs.each do |key, value|
           attrs[key] = value.to_s(:db) if value.is_a?(Date)
-          attrs[key] = value.strftime("%Y-%m-%dT%H:%M:%SZ") if value.is_a?(DateTime)
+          if value.is_a?(DateTime)
+            attrs[key] = value.strftime("%Y-%m-%dT%H:%M:%SZ")
+          end
         end
         additional_methods.each do |method|
-          attrs.merge!(method => object.send(method).to_capsule_json)
+          unless object.send(method).blank?
+            attrs.merge!(method => object.send(method).to_capsule_json)
+          end
         end
         object.class.belongs_to_associations.each do |name, association|
           attrs.merge!(

data/lib/capsule_crm/task.rb

@@ -7,8 +7,14 @@ 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::Findable
+    include CapsuleCRM::Serializable
+
+    persistable_config do |config|
+      config.create = lambda { |task| task.create_url }
+    end
 
     attribute :id, Integer
     attribute :due_date, Date
@@ -17,9 +23,9 @@ module CapsuleCRM
     attribute :description, String
     attribute :detail, String
 
-    belongs_to :party, class_name: 'CapsuleCRM::Party'
-    belongs_to :opportunity, class_name: 'CapsuleCRM::Opportunity'
-    belongs_to :case, class_name: 'CapsuleCRM::Case'
+    belongs_to :party
+    belongs_to :opportunity
+    belongs_to :case
     belongs_to :owner, class_name: 'CapsuleCRM::User', serializable_key: :owner
 
     validates :id, numericality: { allow_blank: true }
@@ -57,55 +63,6 @@ module CapsuleCRM
       self
     end
 
-    def self.all(options = {})
-      init_collection(
-        CapsuleCRM::Connection.get('/api/tasks', options)['tasks']['task']
-      )
-    end
-
-    def self.find(id)
-      new CapsuleCRM::Connection.get("/api/task/#{id}")['task']
-    end
-
-    def self.create(attributes = {})
-      new(attributes).tap(&:save)
-    end
-
-    def self.create!(attributes = {})
-      new(attributes).tap(&:save!)
-    end
-
-    def update_attributes(attributes = {})
-      self.attributes = attributes
-      save
-    end
-
-    def update_attributes!(attributes = {})
-      self.attributes = attributes
-      save!
-    end
-
-    def save
-      if valid?
-        new_record? ? create_record : update_record
-      else
-        false
-      end
-    end
-
-    def save!
-      if valid?
-        save
-      else
-        raise CapsuleCRM::Errors::RecordInvalid.new(self)
-      end
-    end
-
-    def destroy
-      self.id = nil if CapsuleCRM::Connection.delete("/api/task/#{id}")
-      self
-    end
-
     def complete
       CapsuleCRM::Connection.post("/api/task/#{id}/complete")
       self
@@ -116,59 +73,22 @@ module CapsuleCRM
       self
     end
 
+    # TODO Change this to an embedded association, like custom fields
     def self.categories
       CapsuleCRM::Connection.
         get('/api/task/categories')['taskCategories']['taskCategory']
     end
 
-    def new_record?
-      !id
-    end
-
-    def persisted?
-      !new_record?
-    end
-
-    def to_capsule_json
-      serializer.serialize
-    end
-
-    private
-
-    def serializer
-      @serializer ||= CapsuleCRM::Serializer.new(self)
-    end
-
-    def capsule_attributes
-      { description: description, category: category }.tap do |attrs|
-        attrs.merge!(owner: owner.username) if owner
-        attrs.merge!(due_date: due_date.to_s(:db)) if due_date
-        attrs.merge!(due_date_time: due_date_time.to_s(:db)) if due_date_time
-      end
-    end
-
-    def create_record
-      self.attributes = CapsuleCRM::Connection.post(
-        create_url, to_capsule_json
-      )
-      self
-    end
-
     def create_url
       if party_id
-        "/api/party/#{party_id}/task"
+        "party/#{party_id}/task"
       elsif opportunity_id
-        "/api/opportunity/#{opportunity_id}/task"
+        "opportunity/#{opportunity_id}/task"
       elsif case_id
-        "/api/kase/#{case_id}/task"
+        "kase/#{case_id}/task"
       else
-        '/api/task'
+        'task'
       end
     end
-
-    def update_record
-      CapsuleCRM::Connection.put("/api/task/#{id}", to_capsule_json)
-      self
-    end
   end
 end