capsule_crm 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c009a947688f5f89bc4b47b49423502a91523bb9
-  data.tar.gz: 0efb281b53de063eff58eb3ae377111fe1a1399e
+  metadata.gz: a1ae5fc726cd57ca7e7026cc85e30bab83221431
+  data.tar.gz: 98cbdf209e74f7ff4a0d8b5cb8cf6554773432ed
 SHA512:
-  metadata.gz: 4b90a009a0257c2f54885f361191cbf36afce7fe0341f71b18afc4821eaca7d23a7cc095507c71447d1e533d33c301138047b6dc0b54217dd5694d78036221c2
-  data.tar.gz: b621f0a7989688a34e4505fb7952b8f69f26e17f6c715acd313b6a8ea4f4a3f0139334affebb8f02fa35535904b73f32fa7327e3c62e4a42bd3e94af20714751
+  metadata.gz: 77e2bb19b4a89d0a41fbc823243448d3d341863c9bd0b5c1918e281c5f6c458f1c97b14c85ee427715a8cdb092224be9522bfdd81c1469da2b3b43a90d7777c9
+  data.tar.gz: 2151b5e5d3c3e8ecd2305f8c89e0ac3983779f705819193d9572f7b24fcb361c183c9ce1284218a8d627b0d162c6e6fb8fcb5a54a30c039f745400d69fa585f6

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
   - jruby-19mode

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 1.2.0
+
+- Refactor associations. Now all classes know about their associations and
+  associations may be queried using
+  Class.associations/has_many_associations/belongs_to_associations
+- Add a serializer class to deal with serializing objects into their capsule crm
+  json
+- Refactor to_capsule_crm in all models to use the new serializer
+
+## 1.1.0
+
+- Refactored connection error raising to use faraday middleware
+
+## 1.0.1
+
+- Raise an error when trying to call create on a not yet saved has_many
+  association
+- Validate numericality of ID on all models
+
 ## 1.0.0
 
 - Using SemVer and this gem is being used in production, so bumped to version 1

data/README.md

@@ -304,7 +304,7 @@ CapsuleCRM::Currency.all
 
 ## Supported Rubies
 
-1.9.3, 2.0, jruby-19mode
+1.9.3, 2.0, 2.1, jruby-19mode
 
 ## Versioning
 

data/lib/capsule_crm/associations/belongs_to.rb

@@ -1,3 +1,5 @@
+require_relative 'belongs_to_association'
+
 module CapsuleCRM
   module Associations
     module BelongsTo
@@ -29,10 +31,12 @@ module CapsuleCRM
         # person.organisation
         # => organisation
         def belongs_to(association_name, options = {})
-          foreign_key = options[:foreign_key] || :"#{association_name}_id"
+          association = CapsuleCRM::Associations::BelongsToAssociation.
+            new(association_name, self, options)
+          self.associations[association_name] = association
 
           class_eval do
-            attribute foreign_key, Integer
+            attribute association.foreign_key, Integer
           end
 
           (class << self; self; end).instance_eval do
@@ -43,20 +47,18 @@ module CapsuleCRM
 
           define_method association_name do
             instance_variable_get(:"@#{association_name}") ||
-              if self.send(foreign_key)
-                options[:class_name].constantize.
-                find(self.send(foreign_key)).tap do |object|
+              if self.send(association.foreign_key)
+                association.parent(self).tap do |object|
                   self.send("#{association_name}=", object)
                 end
-              else
-                nil
               end
           end
 
           define_method "#{association_name}=" do |associated_object|
-            instance_variable_set(:"@#{association_name}", associated_object)
-            id = associated_object ? associated_object.id : nil
-            self.send "#{foreign_key}=", id
+            associated_object.tap do |object|
+              instance_variable_set(:"@#{association_name}", associated_object)
+              self.send "#{association.foreign_key}=", associated_object.try(:id)
+            end
           end
         end
       end

data/lib/capsule_crm/associations/belongs_to_association.rb

@@ -0,0 +1,80 @@
+module CapsuleCRM
+  module Associations
+    class BelongsToAssociation
+      attr_reader :association_name, :defined_on, :options
+
+      # Public: Initialize a new CapsuleCRM::Associations::BelongsToAssociation
+      #
+      # association_name  - The Symbol name of the association
+      # defined_on        - The String name of the class that this association
+      # is defined on
+      # options           - The Hash of association options
+      #                     foreign_key - The String foreign_key column name
+      #                     class_name  - The String name of the parent class
+      #
+      # Examples
+      #
+      # CapsuleCRM::Associations::BelongsToAssociation.new(
+      #   :person, 'CapsuleCRM::Opportunity', class_name: 'CapsuleCRM::Person'
+      # )
+      #
+      # Returns a CapsuleCRM::Associations::BelongsToAssociation
+      def initialize(association_name, defined_on, options)
+        @association_name = association_name
+        @defined_on       = defined_on
+        @options          = options
+      end
+
+      # Public: Build the foreign key column name. If a foreign key name was
+      # supplied in the options during initialization, then that is returned.
+      # Otherwise it is inferred from the association name
+      #
+      # Returns a String foreign key name
+      def foreign_key
+        @foreign_key ||= options[:foreign_key] || "#{association_name}_id"
+      end
+
+      # Public: Find the parent object of the supplied object
+      #
+      # object  - The object to find the parent for
+      #
+      # Examples
+      #
+      # association = CapsuleCRM::Associations::BelongsToAssociation.new(
+      #   :person, 'CapsuleCRM::Opportunity', class_name: 'CapsuleCRM::Person'
+      # )
+      # object = CapsuleCRM::Opportunity.first
+      # association.parent(object)
+      #
+      # Returns an Object that is on the parent side of the belongs to
+      # association
+      def parent(object)
+        target_klass.find(object.send(foreign_key))
+      end
+
+      # Public: The type of association. Just a convenience method
+      #
+      # Returns a Symbol :belongs_to
+      def macro
+        :belongs_to
+      end
+
+      # Public: The key to use when serializing this association
+      #
+      # Returns the String key
+      def serializable_key
+        @serializable_key ||= options[:serializable_key] || foreign_key
+      end
+
+      def serialize
+        @serialize ||= options[:serialize]
+      end
+
+      private
+
+      def target_klass
+        @target_klass ||= options[:class_name].constantize
+      end
+    end
+  end
+end

data/lib/capsule_crm/associations/has_many.rb

@@ -1,4 +1,5 @@
-require 'capsule_crm/associations/has_many_proxy'
+require_relative 'has_many_association'
+require_relative 'has_many_proxy'
 
 module CapsuleCRM
   module Associations
@@ -34,29 +35,18 @@ module CapsuleCRM
         # organization.people
         # => [person]
         def has_many(association_name, options = {})
+          association = CapsuleCRM::Associations::HasManyAssociation.
+            new(association_name, self, options)
+          self.associations[association_name] = association
+
           define_method association_name do
             instance_variable_get(:"@#{association_name}") ||
-              CapsuleCRM::Associations::HasManyProxy.new(
-                self, # parent
-                options[:class_name].constantize, # target class
-                options[:class_name].constantize.
-                  send("_for_#{self.class.to_s.demodulize.downcase}", self.id),
-                options[:source] # source
-              ).tap do |proxy|
-                instance_variable_set :"@#{association_name}", proxy
-              end
-            instance_variable_get :"@#{association_name}"
+              instance_variable_set(:"@#{association_name}", association.proxy(self))
           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(
-                self, options[:class_name].constantize,
-                associated_objects, options[:source]
-              )
+              association.proxy(self, associated_objects)
           end
         end
       end

data/lib/capsule_crm/associations/has_many_association.rb

@@ -0,0 +1,80 @@
+module CapsuleCRM
+  module Associations
+    class HasManyAssociation
+      attr_reader :association_name, :options, :defined_on
+
+      # Public: Initialize a new CapsuleCRM::Associations::HasManyAssociation
+      #
+      # association_name  - The Symbox association name
+      # defined_on        - The String name of the class that this association
+      # is defined on
+      # options           - The Hash of association options
+      #                     :class_name - The String name of the belongs to
+      #                     class
+      #                     :source - The Symbol name of the accessor method on
+      #                     the belongs to class
+      #
+      # Examples
+      #
+      # CapsuleCRM::Associations::HasManyAssociation.new(
+      #   :opportunities, CapsuleCRM::Person, class_name:
+      #   'CapsuleCRM::Opportunity, source: :person
+      # )
+      #
+      # Returns a CapsuleCRM::Associations::HasManyAssociation
+      def initialize(association_name, defined_on, options)
+        @association_name = association_name
+        @options          = options
+        @defined_on       = defined_on
+      end
+
+      # Public: Build the HasManyProxy object
+      #
+      # parent      - The instance of the class that the has many assocation is
+      # defined on
+      # collection  - An optional Array or Hash to use as the target for the
+      # proxy
+      #
+      # Returns a CapsuleCRM::Associations::HasManyProxy
+      def proxy(parent, collection = nil)
+        CapsuleCRM::Associations::HasManyProxy.new(
+          parent, target_klass, build_target(parent, collection), source
+        )
+      end
+
+      # Public: The type of association. Just a convenience method
+      #
+      # Return a Symbol :has_many
+      def macro
+        :has_many
+      end
+
+      private
+
+      def build_target(parent, collection)
+        collection.nil? ? target(parent) : collection_to_array(collection)
+      end
+
+      def collection_to_array(collection)
+        if collection.is_a?(Hash)
+          Array(target_klass.new(collection[collection.keys.first]))
+        else
+          collection
+        end
+      end
+
+      def target_klass
+        @target_klass ||= options[:class_name].constantize
+      end
+
+      def target(parent)
+        target_klass.
+          send("_for_#{parent.class.to_s.demodulize.downcase}", parent.id)
+      end
+
+      def source
+        @source ||= options[:source]
+      end
+    end
+  end
+end

data/lib/capsule_crm/associations.rb

@@ -8,6 +8,32 @@ module CapsuleCRM
     included do
       include CapsuleCRM::Associations::BelongsTo
       include CapsuleCRM::Associations::HasMany
+
+      class_attribute :associations
+      self.associations = {}
+    end
+
+    module ClassMethods
+      # Public: Gets all the has many associations defined on the class
+      #
+      # Returns a Hash
+      def has_many_associations
+        select_associations(:has_many)
+      end
+
+      # Public: Get all the belongs to associations defined on the class
+      #
+      # Returns a Hash
+      def belongs_to_associations
+        select_associations(:belongs_to)
+      end
+
+      def select_associations(macro)
+        associations.select do |name, association|
+          association.macro == macro &&
+            [self, self.parent].include?(association.defined_on)
+        end
+      end
     end
   end
 end

data/lib/capsule_crm/capsule_jsonable.rb

@@ -3,7 +3,11 @@ module CapsuleCRM
     extend ActiveSupport::Concern
 
     def to_capsule_json
-      CapsuleCRM::HashHelper.camelize_keys attributes
+      serializer.serialize.delete(serializer.root)
+    end
+
+    def serializer
+      @serializer ||= CapsuleCRM::Serializer.new(self)
     end
   end
 end

data/lib/capsule_crm/case.rb

@@ -7,8 +7,7 @@ module CapsuleCRM
     include ActiveModel::Validations
 
     include CapsuleCRM::Collection
-    include CapsuleCRM::Associations::HasMany
-    include CapsuleCRM::Associations::BelongsTo
+    include CapsuleCRM::Associations
     include CapsuleCRM::Taggable
 
     attribute :id, Integer
@@ -238,13 +237,7 @@ module CapsuleCRM
     end
 
     def to_capsule_json
-      {
-        kase: CapsuleCRM::HashHelper.camelize_keys(
-          attributes.dup.delete_if do |key, value|
-            value.blank? || key == 'track_id'
-          end
-        )
-      }
+      serializer.serialize
     end
 
     def self._for_track(track)
@@ -253,6 +246,11 @@ module CapsuleCRM
 
     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

data/lib/capsule_crm/contacts.rb

@@ -146,7 +146,7 @@ module CapsuleCRM
         email:    emails.map(&:to_capsule_json),
         phone:    phones.map(&:to_capsule_json),
         website:  websites.map(&:to_capsule_json)
-      }.stringify_keys
+      }.delete_if { |key, value| value.blank? }.stringify_keys
     end
   end
 end

data/lib/capsule_crm/custom_field.rb

@@ -63,18 +63,15 @@ module CapsuleCRM
     end
 
     def to_capsule_json
-      {
-        customFields: {
-          customField: [
-            CapsuleCRM::HashHelper.camelize_keys(attributes).
-            delete_if { |key, value| value.blank? }
-          ]
-        }
-      }
+      { '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

data/lib/capsule_crm/history.rb

@@ -19,11 +19,13 @@ module CapsuleCRM
     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 :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
-    belongs_to :opportunity,  class_name: 'CapsuleCRM::Opportunity'
+      foreign_key: :case_id, serialize: false
+    belongs_to :opportunity,  class_name: 'CapsuleCRM::Opportunity',
+      serialize: false
 
     validates :id, numericality: { allow_blank: true }
     validates :note, presence: true
@@ -269,17 +271,15 @@ module CapsuleCRM
     #
     # 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? }
-        )
-      }
+      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

data/lib/capsule_crm/opportunity.rb

@@ -293,13 +293,7 @@ module CapsuleCRM
     #
     # Returns a Hash
     def to_capsule_json
-      {
-        opportunity: CapsuleCRM::HashHelper.camelize_keys(
-          attributes.dup.delete_if do |key, value|
-            value.blank? || key == 'track_id'
-          end
-        )
-      }.stringify_keys
+      serializer.serialize
     end
 
     # Public: Delete the opportunity in capsule
@@ -316,6 +310,10 @@ module CapsuleCRM
 
     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

data/lib/capsule_crm/organization.rb

@@ -6,12 +6,9 @@ module CapsuleCRM
     extend ActiveModel::Callbacks
     extend ActiveModel::Conversion
     include ActiveModel::Validations
-    include ActiveModel::Validations::Callbacks
 
-    include CapsuleCRM::Associations::HasMany
     include CapsuleCRM::Collection
     include CapsuleCRM::Contactable
-    include CapsuleCRM::Taggable
 
     attribute :id,    Integer
     attribute :name,  String
@@ -209,10 +206,7 @@ module CapsuleCRM
     #
     # Returns a Hash
     def to_capsule_json
-      {
-        organisation: attributes.merge(contacts: contacts.to_capsule_json).
-        stringify_keys
-      }.stringify_keys
+      serializer.serialize
     end
 
     # Public: Delete the organization in capsule
@@ -229,6 +223,11 @@ module CapsuleCRM
 
     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

data/lib/capsule_crm/participant.rb

@@ -13,9 +13,5 @@ module CapsuleCRM
     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

@@ -3,7 +3,7 @@ class CapsuleCRM::Party
 
   include CapsuleCRM::Attributes
   include CapsuleCRM::Taggable
-  include CapsuleCRM::Associations::HasMany
+  include CapsuleCRM::Associations
 
   has_many :histories, class_name: 'CapsuleCRM::History', source: :party
   has_many :tasks, class_name: 'CapsuleCRM::Task', source: :party

data/lib/capsule_crm/person.rb

@@ -2,7 +2,6 @@ module CapsuleCRM
   class Person < CapsuleCRM::Party
     include CapsuleCRM::Collection
     include CapsuleCRM::Contactable
-    include CapsuleCRM::Associations::BelongsTo
 
     extend ActiveModel::Naming
     include ActiveModel::Conversion
@@ -220,16 +219,16 @@ module CapsuleCRM
     #
     # Returns a Hash
     def to_capsule_json
-      {
-        person: CapsuleCRM::HashHelper.camelize_keys(
-          attributes.dup.delete_if { |key, value| value.blank? }.
-          merge(contacts: contacts.to_capsule_json)
-        )
-      }.stringify_keys
+      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

data/lib/capsule_crm/serializer.rb

@@ -0,0 +1,56 @@
+module CapsuleCRM
+  class Serializer
+    attr_reader :object, :options
+
+    def initialize(object, options = {})
+      @object  = object
+      @options = options
+    end
+
+    def serialize
+      @serialized ||= { root => build_attributes_hash }.stringify_keys
+    end
+
+    def root
+      @root ||= options[:root] ||
+        object.class.to_s.demodulize.downcase.singularize.camelize(:lower)
+    end
+
+    private
+
+    def additional_methods
+      @additional_methods ||= options[:additional_methods] || []
+    end
+
+    def excluded_keys
+      @excluded_keys ||= options[:excluded_keys] || []
+    end
+
+    def build_attributes_hash
+      CapsuleCRM::HashHelper.camelize_keys(cleaned_attributes)
+    end
+
+    def cleaned_attributes
+      attributes.delete_if do |key, value|
+        value.blank? || key.to_s == 'id' || excluded_keys.include?(key)
+      end
+    end
+
+    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)
+        end
+        additional_methods.each do |method|
+          attrs.merge!(method => object.send(method).to_capsule_json)
+        end
+        object.class.belongs_to_associations.each do |name, association|
+          attrs.merge!(
+            association.serializable_key => object.send(name).try(:id)
+          ) unless association.serialize == false
+        end if object.class.respond_to?(:belongs_to_associations)
+      end
+    end
+  end
+end

data/lib/capsule_crm/task.rb

@@ -6,7 +6,7 @@ module CapsuleCRM
     include ActiveModel::Conversion
     include ActiveModel::Validations
 
-    include CapsuleCRM::Associations::BelongsTo
+    include CapsuleCRM::Associations
     include CapsuleCRM::Attributes
     include CapsuleCRM::Collection
 
@@ -20,7 +20,7 @@ module CapsuleCRM
     belongs_to :party, class_name: 'CapsuleCRM::Party'
     belongs_to :opportunity, class_name: 'CapsuleCRM::Opportunity'
     belongs_to :case, class_name: 'CapsuleCRM::Case'
-    belongs_to :owner, class_name: 'CapsuleCRM::User'
+    belongs_to :owner, class_name: 'CapsuleCRM::User', serializable_key: :owner
 
     validates :id, numericality: { allow_blank: true }
     validates :description, presence: true
@@ -130,13 +130,15 @@ module CapsuleCRM
     end
 
     def to_capsule_json
-      {
-        task: CapsuleCRM::HashHelper.camelize_keys(capsule_attributes)
-      }.stringify_keys
+      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