capsule_crm 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1ae5fc726cd57ca7e7026cc85e30bab83221431
-  data.tar.gz: 98cbdf209e74f7ff4a0d8b5cb8cf6554773432ed
+  metadata.gz: 895602f68388ac5ca0d367ee33568425ea6b9b94
+  data.tar.gz: 426048ab8c437b47607fe449af53455ee22a6c14
 SHA512:
-  metadata.gz: 77e2bb19b4a89d0a41fbc823243448d3d341863c9bd0b5c1918e281c5f6c458f1c97b14c85ee427715a8cdb092224be9522bfdd81c1469da2b3b43a90d7777c9
-  data.tar.gz: 2151b5e5d3c3e8ecd2305f8c89e0ac3983779f705819193d9572f7b24fcb361c183c9ce1284218a8d627b0d162c6e6fb8fcb5a54a30c039f745400d69fa585f6
+  metadata.gz: 2c0c4236c700a3014c6ed84ed1122d4784047016dfc69b2f8431cac9b23bea80832f17858562e1adf86c0eaf8c3367e0fa21d365187197acce034c91c171400f
+  data.tar.gz: bab4f5d64be4d3bf1f75be0de9d98a1a294307b1fae5af38ee70bee1f26d2ba50c64e70508808d523713c61acb3b94e5e5cdff57c3949a745584aea8c18f4465

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 1.3.0
+
+- Refactored associations to allow classes to reflect on themselves in order to
+  allow serialization to happen in one place
+- Created a serializer to deal with all converting all objects into capsule crm
+  compliant hashes
+- Created CapsuleCRM::Normalizer to deal with converting capsule crm hashes into
+  ActiveModel compliant hashes
+- Extracted querying logic into modules
+- Extracted persistence logic into modules
+- Extracted deleting logic into a module
+- Added CapsuleCRM::Associations::BelongsToFinder to deal with querying the
+  belongs to side of associations
+- Added CapsuleCRM::CustomFieldDefinitions
+
 ## 1.2.0
 
 - Refactor associations. Now all classes know about their associations and

data/lib/capsule_crm/address.rb

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

data/lib/capsule_crm/associations/belongs_to.rb

@@ -1,4 +1,5 @@
 require_relative 'belongs_to_association'
+require_relative 'belongs_to_finder'
 
 module CapsuleCRM
   module Associations
@@ -41,7 +42,7 @@ module CapsuleCRM
 
           (class << self; self; end).instance_eval do
             define_method "_for_#{association_name}" do |id|
-              raise NotImplementedError.new("_for_#{association_name} needs to be implemented")
+              CapsuleCRM::Associations::BelongsToFinder.new(association).call(id)
             end
           end
 

data/lib/capsule_crm/associations/belongs_to_association.rb

@@ -25,13 +25,21 @@ module CapsuleCRM
         @options          = options
       end
 
+      def inverse
+        @inverse ||=
+          target_klass.has_many_associations.find do |name, association|
+          association.source == association_name &&
+            association.target_klass == defined_on
+        end.try(:last) if target_klass.respond_to?(:has_many_associations)
+      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"
+        @foreign_key ||= options[:foreign_key] || infer_foreign_key
       end
 
       # Public: Find the parent object of the supplied object
@@ -72,8 +80,17 @@ module CapsuleCRM
 
       private
 
+      def infer_foreign_key
+        "#{association_name}_id"
+      end
+
       def target_klass
-        @target_klass ||= options[:class_name].constantize
+        @target_klass ||=
+          (options[:class_name] || infer_target_klass).constantize
+      end
+
+      def infer_target_klass
+        "CapsuleCRM::#{association_name.to_s.camelize}"
       end
     end
   end

data/lib/capsule_crm/associations/belongs_to_finder.rb

@@ -0,0 +1,46 @@
+module CapsuleCRM
+  module Associations
+    class BelongsToFinder
+      attr_reader :association
+      attr_writer :singular, :plural, :normalizer
+
+      def initialize(association)
+        @association = association
+      end
+
+      def call(id)
+        id ? find(id) : []
+      end
+
+      private
+
+      def inverse
+        @inverse ||= association.inverse
+      end
+
+      def singular
+        @singular ||= inverse.defined_on.queryable_options.singular
+      end
+
+      def plural
+        @plural ||= association.defined_on.queryable_options.plural
+      end
+
+      def find(id)
+        normalizer.normalize_collection get(path(id)) if inverse
+      end
+
+      def get(path_string)
+        CapsuleCRM::Connection.get(path_string)
+      end
+
+      def path(id)
+        "/api/#{singular}/#{id}/#{plural}"
+      end
+
+      def normalizer
+        @normalizer ||= CapsuleCRM::Normalizer.new(association.defined_on)
+      end
+    end
+  end
+end

data/lib/capsule_crm/associations/has_many_association.rb

@@ -38,7 +38,8 @@ module CapsuleCRM
       # Returns a CapsuleCRM::Associations::HasManyProxy
       def proxy(parent, collection = nil)
         CapsuleCRM::Associations::HasManyProxy.new(
-          parent, target_klass, build_target(parent, collection), source
+          parent, target_klass, build_target(parent, collection), source,
+          embedded
         )
       end
 
@@ -49,8 +50,29 @@ module CapsuleCRM
         :has_many
       end
 
+      def embedded
+        @embedded ||= !!options[:embedded]
+      end
+
+      def source
+        @source ||= options[:source] || infer_source
+      end
+
+      def target_klass
+        @target_klass ||=
+          (options[:class_name] || infer_target_klass).constantize
+      end
+
       private
 
+      def infer_source
+        defined_on.to_s.demodulize.downcase.singularize.to_sym
+      end
+
+      def infer_target_klass
+        "CapsuleCRM::#{association_name.to_s.singularize.camelize}"
+      end
+
       def build_target(parent, collection)
         collection.nil? ? target(parent) : collection_to_array(collection)
       end
@@ -63,18 +85,10 @@ module CapsuleCRM
         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/has_many_proxy.rb

@@ -2,11 +2,12 @@ module CapsuleCRM
   module Associations
     class HasManyProxy < BasicObject
 
-      def initialize(parent, target_klass, target, source)
+      def initialize(parent, target_klass, target, source, embedded)
         @target         = target
         @parent         = parent
         @target_klass   = target_klass
         @source         = source
+        @embedded       = embedded
       end
 
       def method_missing(name, *args, &block)
@@ -21,9 +22,17 @@ module CapsuleCRM
       end
 
       def create(attributes = {})
-        build(attributes).tap do |record|
-          record_not_saved(record) unless parent.persisted?
-        end.save
+        record = build(attributes).tap do |r|
+          record_not_saved(r) unless parent.persisted?
+        end
+        embedded? ? save : record.save
+      end
+
+      def create!(attributes = {})
+        record = build(attributes).tap do |r|
+          record_not_saved(r) unless parent.persisted?
+        end
+        embedded? ? save! : record.save!
       end
 
       def tap
@@ -31,8 +40,33 @@ module CapsuleCRM
         self
       end
 
+      def to_capsule_json(root = nil)
+        { root => serializer.serialize_collection(target_klass, target) }
+      end
+
       private
 
+      def serializer
+        @serializer ||= ::CapsuleCRM::Serializer
+      end
+
+      def save
+        json = to_capsule_json(target_klass.serializable_options.collection_root)
+        path = [
+          '/api', parent.class.queryable_options.singular, parent.id,
+          target_klass.queryable_options.plural
+        ].join('/')
+        ::CapsuleCRM::Connection.put(path, json)
+      end
+
+      def save!
+        save
+      end
+
+      def embedded?
+        @embedded
+      end
+
       def record_not_saved(record)
         raise ::CapsuleCRM::Errors::RecordNotSaved.new(record)
       end

data/lib/capsule_crm/case.rb

@@ -6,10 +6,34 @@ module CapsuleCRM
     include ActiveModel::Conversion
     include ActiveModel::Validations
 
-    include CapsuleCRM::Collection
     include CapsuleCRM::Associations
+    include CapsuleCRM::Persistence::Persistable
+    include CapsuleCRM::Persistence::Deletable
+    include CapsuleCRM::Querying::Findable
+    include CapsuleCRM::Serializable
     include CapsuleCRM::Taggable
 
+    serializable_config do |config|
+      config.collection_root = :kases
+      config.root            = :kase
+      config.excluded_keys   = [:track_id]
+    end
+
+    queryable_config do |config|
+      config.plural   = :kase
+      config.singular = :kase
+    end
+
+    persistable_config do |config|
+      config.create = lambda do |kase|
+        path = "party/#{kase.party.try(:id)}/kase"
+        path += "?trackId=#{kase.track.id}" if kase.track
+        path
+      end
+      config.update = lambda { |kase| "kase/#{kase.id}" }
+      config.destroy = lambda { |kase| "kase/#{kase.id}" }
+    end
+
     attribute :id, Integer
     attribute :name, String
     attribute :description, String
@@ -21,247 +45,20 @@ module CapsuleCRM
     validates :name, presence: true
     validates :party, presence: true
 
-    belongs_to :party, class_name: 'CapsuleCRM::Party'
-    belongs_to :track, class_name: 'CapsuleCRM::Track'
-
-    has_many :tasks, class_name: 'CapsuleCRM::Task', source: :case
-
-    # Public: Search and retrieve all cases in CapsuleCRM
-    #
-    # options   - the Hash of query options (default: {}):
-    #             :tag            - the String tag to search for
-    #             :lastmodified   - the Date after which the case was last
-    #             modified by
-    #             :start          - the Integer index of the first record to
-    #             return.
-    #             :limit          - the Integer number of records to return
-    #
-    # Examples
-    #
-    # CapsuleCRM::Case.all(tag: 'Some Tag')
-    #
-    # Returns a CapsuleCRM::ResultsProxy of CapsuleCRM::Case objects
-    def self.all(options = {})
-      init_collection(
-        CapsuleCRM::Connection.get('/api/kase', options)['kases']['kase']
-      )
-    end
-
-    # Public: Search for a single case by ID
-    #
-    # id - the Integer ID of the record to search for
-    #
-    # Examples
-    #
-    # CapsuleCRM::Case.find(1)
-    #
-    # Returns a CapsuleCRM::Case object
-    def self.find(id)
-      new CapsuleCRM::Connection.get("/api/kase/#{id}")['kase']
-    end
-
-    # Public: Create a CapsuleCRM::Case
-    #
-    # attributes  - the Hash of attributes (default: {}):
-    #               :name         - the String name of the case (required)
-    #               :description  - the String description
-    #               :status       - the String status (OPEN or CLOSED), default
-    #               is OPEN
-    #               :owner        - the String username of the owner
-    #               :close_date   - the Date when the case was/will be closed.
-    #               Ignored if the status is set to CLOSED
-    #
-    # Examples
-    #
-    # CapsuleCRM::Case.create name: "Matt's test case"
-    #
-    # Returns a CapsuleCRM::Case
-    def self.create(attributes = {})
-      new(attributes).tap(&:save)
-    end
-
-    # Public: Create a CapsuleCRM::Case or raise a error
-    #
-    # attributes  - the Hash of attributes (default: {}):
-    #               :name         - the String name of the case (required)
-    #               :description  - the String description
-    #               :status       - the String status (OPEN or CLOSED), default
-    #               is OPEN
-    #               :owner        - the String username of the owner
-    #               :close_date   - the Date when the case was/will be closed.
-    #               Ignored if the status is set to CLOSED
-    #
-    # Examples
-    #
-    # CapsuleCRM::Case.create! name: "Matt's test case"
-    # => CapsuleCRM::Case object
-    #
-    # CapsuleCRM::Case.create! name: nil
-    # => CapsuleCRM::Errors::RecordInvalid
-    #
-    # Returns a CapsuleCRM::Case
-    def self.create!(attributes = {})
-      new(attributes).tap(&:save!)
-    end
-
-    # Public: Updates an existing CapsuleCRM::Case with the supplied attributes
-    #
-    # attributes  - the Hash of attributes (default: {}):
-    #               :name         - the String name of the case (required)
-    #               :description  - the String description
-    #               :status       - the String status (OPEN or CLOSED), default
-    #               is OPEN
-    #               :owner        - the String username of the owner
-    #               :close_date   - the Date when the case was/will be closed.
-    #               Ignored if the status is set to CLOSED
-    #
-    # Examples
-    #
-    # kase = CapsuleCRM::Case.find(1)
-    # kase.update_attributes name: 'A new name'
-    #
-    # Returns a CapsuleCRM::Case
-    def update_attributes(attributes = {})
-      self.attributes = attributes
-      save
-    end
-
-    # Public: Updates an existing CapsuleCRM::Case with the supplied attributes
-    # or raises an error
-    #
-    # attributes  - the Hash of attributes (default: {}):
-    #               :name         - the String name of the case (required)
-    #               :description  - the String description
-    #               :status       - the String status (OPEN or CLOSED), default
-    #               is OPEN
-    #               :owner        - the String username of the owner
-    #               :close_date   - the Date when the case was/will be closed.
-    #               Ignored if the status is set to CLOSED
-    #
-    # Examples
-    #
-    # kase = CapsuleCRM::Case.find(1)
-    # kase.update_attributes! name: 'A new name'
-    # => CapsuleCRM::Case object
-    #
-    # kase.update_attributes! name: nil
-    # => CapsuleCRM::Errors::RecordInvalid
-    #
-    # Returns a CapsuleCRM::Case
-    def update_attributes!(attributes = {})
-      self.attributes = attributes
-      save!
-    end
-
-    # Public: Saves this CapsuleCRM::Case
-    #
-    # Examples:
-    #
-    # kase = CapsuleCRM::Case.new(
-    #   name: 'Case Name', party: person_or_organization
-    # )
-    # kase.save
-    # => CapsuleCRM::Case object
-    #
-    # Returns the CapsuleCRM::Case or false
-    def save
-      if valid?
-        new_record? ? create_record : update_record
-      else
-        false
-      end
-    end
-
-    # Public: Saves this CapsuleCRM::Case or raises an error
-    #
-    # Examples
-    #
-    # kase = CapsuleCRM::Case.find(1)
-    # kase.name = 'Changed name'
-    # kase.save!
-    # => CapsuleCRM::Case object
-    #
-    # kase.name = nil
-    # kase.save!
-    # => CapsuleCRM::Errors::RecordInvalid
-    #
-    # Returns a CapsuleCRM::Case
-    def save!
-      if valid?
-        new_record? ? create_record : update_record
-      else
-        raise CapsuleCRM::Errors::RecordInvalid.new(self)
-      end
-    end
+    belongs_to :party
+    belongs_to :track
 
-    # Public: Deletes this CapsuleCRM::Case from CapsuleCRM
-    #
-    # Examples
-    #
-    # CapsuleCRM::Case.find(1).destroy
-    #
-    # Returns the CapsuleCRM::Case object
-    def destroy
-      self.id = nil if CapsuleCRM::Connection.delete("/api/kase/#{id}")
-      self
-    end
-
-    # Public: Is this case a new record?
-    #
-    # Examples
-    #
-    # CapsuleCRM::Case.find(1).new_record?
-    # => false
-    #
-    # CapsuleCRM::Case.new.new_record?
-    # => true
-    #
-    # Returns a Boolean
-    def new_record?
-      !id
-    end
+    has_many :tasks
+    has_many :histories
+    has_many :custom_fields, embedded: true
 
-    # Public: Is this case persisted to CapsuleCRM?
-    #
-    # Examples
-    #
-    # CapsuleCRM::Case.find(1).persisted?
-    # => true
-    #
-    # CapsuleCRM::Case.new.persisted?
-    # => false
-    #
-    # Returns a Boolean
-    def persisted?
-      !new_record?
-    end
-
-    def to_capsule_json
-      serializer.serialize
+    class << self
+      alias :_for_organization :_for_party
+      alias :_for_person :_for_party
     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
-      self.attributes = CapsuleCRM::Connection.post(
-        path, to_capsule_json
-      )
-      self
-    end
-
-    def update_record
-      CapsuleCRM::Connection.put("/api/kase/#{id}", to_capsule_json)
-    end
   end
 end

data/lib/capsule_crm/configuration.rb

@@ -1,6 +1,6 @@
 class CapsuleCRM::Configuration
 
-  attr_accessor :api_token, :logger, :subdomain
+  attr_accessor :api_token, :logger, :subdomain, :perform_logging
 
   def logger
     @logger || Logger.new(STDOUT)

data/lib/capsule_crm/connection.rb

@@ -27,8 +27,11 @@ module CapsuleCRM
     private
 
     def self.request(method, path, params)
+      CapsuleCRM.log "CapsuleCRM: #{method.upcase} #{path} with #{params}"
       faraday.send(method, path, params) do |req|
         req.headers.update default_request_headers
+      end.tap do |response|
+        CapsuleCRM.log "CapsuleCRM Response: #{response.body}"
       end
     end
 

data/lib/capsule_crm/contactable.rb

@@ -17,7 +17,7 @@ module CapsuleCRM
       if contacts.is_a?(Hash)
         contacts = CapsuleCRM::Contacts.new(contacts.symbolize_keys)
       end
-      @contacts = contacts
+      @contacts = contacts unless contacts.blank?
     end
 
     def contacts

data/lib/capsule_crm/country.rb

@@ -2,20 +2,14 @@ module CapsuleCRM
   class Country
     include Virtus
 
-    attribute :name
+    include CapsuleCRM::Serializable
+    include CapsuleCRM::Querying::Configuration
+    include CapsuleCRM::Querying::FindAll
 
-    # Public: Retrieve a list of countries from Capsule
-    #
-    # Examples
-    #
-    # CapsuleCRM::Country.all
-    #
-    # Returns an Array of CapsuleCRM::Country objects
-    def self.all
-      CapsuleCRM::Connection.
-        get('/api/countries')['countries']['country'].map do |country_name|
-        new name: country_name
-      end
+    serializable_config do |config|
+      config.attribute_to_assign = :name
     end
+
+    attribute :name
   end
 end

data/lib/capsule_crm/currency.rb

@@ -6,20 +6,14 @@ module CapsuleCRM
     include ActiveModel::Conversion
     include ActiveModel::Validations
 
-    attribute :code, String
+    include CapsuleCRM::Querying::Configuration
+    include CapsuleCRM::Querying::FindAll
+    include CapsuleCRM::Serializable
 
-    # Public: Retrieve a list of all currencies in Capsule
-    #
-    # Examples
-    #
-    # CapsuleCRM::Currency.all
-    #
-    # Returns an Array of CapsuleCRM::Currency objects
-    def self.all
-      CapsuleCRM::Connection.
-        get('/api/currencies')['currencies']['currency'].map do |currency_code|
-        new code: currency_code
-      end
+    serializable_config do |config|
+      config.attribute_to_assign = :code
     end
+
+    attribute :code, String
   end
 end