Working on serializer improvements

lib/capsule_crm.rb

@@ -8,11 +8,12 @@
 require 'capsule_crm/collection'
 require 'capsule_crm/associations'
 require 'capsule_crm/address'
-require 'capsule_crm/case'
 require 'capsule_crm/connection'
 require 'capsule_crm/serializer'
+require 'capsule_crm/serializable'
 
 require 'capsule_crm/attachment'
+require 'capsule_crm/case'
 require 'capsule_crm/country'
 require 'capsule_crm/currency'
 require 'capsule_crm/email'

lib/capsule_crm/case.rb

@@ -6,10 +6,15 @@ class Case
     include ActiveModel::Conversion
     include ActiveModel::Validations
 
-    include CapsuleCRM::Collection
     include CapsuleCRM::Associations
+    include CapsuleCRM::Collection
+    include CapsuleCRM::Serializable
     include CapsuleCRM::Taggable
 
+    self.serializable_options = {
+      root: :kase, excluded_keys: [:track_id]
+    }
+
     attribute :id, Integer
     attribute :name, String
     attribute :description, String
@@ -236,21 +241,12 @@ def persisted?
       !new_record?
     end
 
-    def to_capsule_json
-      serializer.serialize
-    end
-
     def self._for_track(track)
       raise NotImplementedError.new("There is no way to find cases by trackId in the Capsule API right now")
     end
 
     private
 
-    def serializer
-      @serializer ||= CapsuleCRM::Serializer.
-        new(self, excluded_keys: ['track_id'], root: :kaze)
-    end
-
     def create_record
       path = "/api/party/#{party_id}/kase"
       path += "?trackId=#{track_id}" if track_id

lib/capsule_crm/custom_field.rb

@@ -9,6 +9,9 @@ class CustomField
     include CapsuleCRM::Associations
     include CapsuleCRM::Attributes
     include CapsuleCRM::Collection
+    include CapsuleCRM::Serializable
+
+    self.serializable_options = { root: 'customField' }
 
     attribute :id, Integer
     attribute :label, String
@@ -68,10 +71,6 @@ def to_capsule_json
 
     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

lib/capsule_crm/history.rb

@@ -9,6 +9,9 @@ class History
     include CapsuleCRM::Associations
     include CapsuleCRM::Attributes
     include CapsuleCRM::Collection
+    include CapsuleCRM::Serializable
+
+    self.serializable_options = { root: :historyItem }
 
     attribute :id, Integer
     attribute :type, String
@@ -263,23 +266,8 @@ 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

lib/capsule_crm/opportunity.rb

@@ -9,6 +9,9 @@ class Opportunity
     include CapsuleCRM::Associations
     include CapsuleCRM::Attributes
     include CapsuleCRM::Collection
+    include CapsuleCRM::Serializable
+
+    self.serializable_options = { excluded_keys: [:track_id] }
 
     attribute :id, Integer
     attribute :name, String
@@ -284,18 +287,7 @@ 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
@@ -310,10 +302,6 @@ def destroy
 
     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

lib/capsule_crm/organization.rb

@@ -9,6 +9,11 @@ class Organization < CapsuleCRM::Party
 
     include CapsuleCRM::Collection
     include CapsuleCRM::Contactable
+    include CapsuleCRM::Serializable
+
+    self.serializable_options = {
+      root: :organisation, additional_methods: [:contacts]
+    }
 
     attribute :id,    Integer
     attribute :name,  String
@@ -196,19 +201,7 @@ def new_record?
     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
@@ -223,11 +216,6 @@ def destroy
 
     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

lib/capsule_crm/person.rb

@@ -2,11 +2,16 @@ module CapsuleCRM
   class Person < CapsuleCRM::Party
     include CapsuleCRM::Collection
     include CapsuleCRM::Contactable
+    include CapsuleCRM::Serializable
 
     extend ActiveModel::Naming
     include ActiveModel::Conversion
     include ActiveModel::Validations
 
+    self.serializable_options = {
+      additional_methods: [:contacts]
+    }
+
     attribute :id, Integer
     attribute :title
     attribute :first_name
@@ -210,25 +215,8 @@ 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

lib/capsule_crm/serializable.rb

@@ -0,0 +1,20 @@
+module CapsuleCRM
+  module Serializable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :serializable_options
+      self.serializable_options = {}
+    end
+
+    def to_capsule_json
+      serializer.serialize
+    end
+
+    def serializer
+      @serializer ||= CapsuleCRM::Serializer.new(
+        self, self.serializable_options
+      )
+    end
+  end
+end

lib/capsule_crm/task.rb

@@ -9,6 +9,7 @@ class Task
     include CapsuleCRM::Associations
     include CapsuleCRM::Attributes
     include CapsuleCRM::Collection
+    include CapsuleCRM::Serializable
 
     attribute :id, Integer
     attribute :due_date, Date
@@ -129,24 +130,8 @@ 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

spec/lib/capsule_crm/case_spec.rb

@@ -373,4 +373,13 @@
       it { should_not be_persisted }
     end
   end
+
+  describe '#to_capsule_json' do
+    let(:kase) { CapsuleCRM::Case.new }
+    subject { kase.to_capsule_json }
+
+    it 'should have a root of "kase"' do
+      expect(subject.keys.first).to eql('kase')
+    end
+  end
 end

spec/lib/capsule_crm/organization_spec.rb

@@ -111,7 +111,6 @@
     end
     let(:email_json) { subject['contacts']['email'].first }
     let(:address_json) { subject['contacts']['address'].first }
-
     subject { organization.to_capsule_json['organisation'] }
 
     it { should have_key('name') }