capsule_crm 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40b178add184629b0011c050d6c021eecb3061ed
-  data.tar.gz: 07a406a438880798916012ef6af98fe59786db58
+  metadata.gz: 6cfdc83bc1370520aadef70ff71c92d7ce027a9b
+  data.tar.gz: 06ff75f4e1278b8c3f1b15a7a1c90a72ed2c860f
 SHA512:
-  metadata.gz: d5e6e13677f95912036882050ad7e5babb5a662b813007ffe94ed293a10d5b0b54858aaa9459206d9065cce3fd2583263876bc48f30b26e221b1f149f7013bd8
-  data.tar.gz: 4966758a6dfc65e830d68e133341dd104861e7afce472ea43907ed27fd7c65c3c23e15ed73138cdbd9a8154ee6201966e51f4b1247a13da56fa02ef316f0a3ea
+  metadata.gz: 69ff92ce9719c2756affb46c7de48027d72cd3a7378b0bc5f9798460f6ba097a39ec6007b06d5c8c83c09f8c8c239580092336977d42719526ac98479e3d03f0
+  data.tar.gz: 56acc7915da8a8a42344c5f1bfebf97e9b52f536b4f5200d962864e2a0a955e8a3c7e2a46c6d4a70051dd2583f0e7edcbccb09f8d1ead15e1e829ffca15bc435

data/.hound.yml

@@ -285,7 +285,7 @@ MethodDefParentheses:
 
 MethodLength:
   Description: 'Avoid methods longer than 10 lines of code.'
-  Enabled: false
+  Enabled: true
 
 MethodName:
   # Valid values are: snake_case, camelCase

data/CHANGELOG.md

@@ -1,27 +1,40 @@
 # Changelog
 
+## 1.9.0
+
+- Raise a CapsuleCRM::Errors::AssociationTypeMismatch when an object of the
+  wrong type is set on a belongs to association.
+  [#79](https://github.com/mattbeedle/capsule_crm/pull/79)
+- CapsuleCRM::Errors::RecordInvalid#to_s and #inspect methods are now more
+  descriptive [#78](https://github.com/mattbeedle/capsule_crm/pull/78)
+
 ## 1.8.0
 
 - Custom fields may now be deleted.
+  [#77](https://github.com/mattbeedle/capsule_crm/pull/77)
 
 ## 1.7.0
 
 - Inspecting items only displays their attributes now. Much cleaner for working
   on the console
+  [https://github.com/mattbeedle/capsule_crm/commit/cde082c1934ff97b6fa2dc9c56a01ca771d73b26](https://github.com/mattbeedle/capsule_crm/commit/cde082c1934ff97b6fa2dc9c56a01ca771d73b26)
 
 ## 1.6.2
 
-- Fix bug where responses errors always had a blank body
+- Fix bug where responses errors always had a blank body.
+  [#76](https://github.com/mattbeedle/capsule_crm/pull/76)
 
 ## 1.6.1
 
 - Fix issue where if capsulecrm.com returned a blank error response the
-  ResponseError would raise an undefined method exception
+  ResponseError would raise an undefined method exception.
+  [#74](https://github.com/mattbeedle/capsule_crm/pull/74)
 
 ## 1.6.0
 
 - ResponseError#to_s now return the response message from the server so errors
   are a little easier to debug.
+  [#69](https://github.com/mattbeedle/capsule_crm/pull/69)
 
 ## 1.5.3
 

data/lib/capsule_crm/associations/belongs_to.rb

@@ -2,12 +2,12 @@ require_relative 'belongs_to_association'
 require_relative 'belongs_to_finder'
 
 module CapsuleCRM
-  module Associations
-    module BelongsTo
+  module Associations # nodoc
+    module BelongsTo # nodoc
       extend ActiveSupport::Concern
 
+      # nodoc
       module ClassMethods
-
         # Public: Add getter and setter methods for belongs to associations
         #
         # association_name  - The String name of the association
@@ -32,9 +32,9 @@ module CapsuleCRM
         # person.organisation
         # => organisation
         def belongs_to(association_name, options = {})
-          association = CapsuleCRM::Associations::BelongsToAssociation.
-            new(association_name, self, options)
-          self.associations[association_name] = association
+          association = CapsuleCRM::Associations::BelongsToAssociation
+            .new(association_name, self, options)
+          associations[association_name] = association
 
           class_eval do
             attribute association.foreign_key, Integer
@@ -42,24 +42,25 @@ module CapsuleCRM
 
           (class << self; self; end).instance_eval do
             define_method "_for_#{association_name}" do |id|
-              CapsuleCRM::Associations::BelongsToFinder.new(association).
-                call(id)
+              CapsuleCRM::Associations::BelongsToFinder.new(association)
+                .call(id)
             end
           end
 
           define_method association_name do
             instance_variable_get(:"@#{association_name}") ||
-              if self.send(association.foreign_key)
+              if send(association.foreign_key)
                 association.parent(self).tap do |object|
-                  self.send("#{association_name}=", object)
+                  send("#{association_name}=", object)
                 end
               end
           end
 
           define_method "#{association_name}=" do |associated_object|
             associated_object.tap do |object|
-              instance_variable_set(:"@#{association_name}", associated_object)
-              self.send "#{association.foreign_key}=", associated_object.try(:id)
+              association.check_object! object if object
+              instance_variable_set(:"@#{association_name}", object)
+              send "#{association.foreign_key}=", object.try(:id)
             end
           end
         end

data/lib/capsule_crm/associations/belongs_to_association.rb

@@ -75,11 +75,28 @@ module CapsuleCRM
       end
 
       def serialize
-        @serialize ||= options[:serialize]
+        @serialize ||= options[:serialize] == false ? false : true
+      end
+
+      def check_object!(object)
+        association_mismatch!(object) if object_invalid?(object)
       end
 
       private
 
+      def enforce_type?
+        true unless options[:enforce_type] == false
+      end
+
+      def object_invalid?(object)
+        enforce_type? && !object.is_a?(target_klass)
+      end
+
+      def association_mismatch!(object)
+        fail CapsuleCRM::Errors::AssociationTypeMismatch,
+          [object.class, target_klass], caller
+      end
+
       def infer_foreign_key
         "#{association_name}_id"
       end

data/lib/capsule_crm/errors/association_type_mismatch.rb

@@ -0,0 +1,10 @@
+module CapsuleCRM
+  module Errors
+    class AssociationTypeMismatch < StandardError
+      def initialize(args)
+        received, expected = *args
+        super "#{expected} expected, received #{received}"
+      end
+    end
+  end
+end

data/lib/capsule_crm/errors/record_invalid.rb

@@ -1,6 +1,12 @@
 module CapsuleCRM
   module Errors
     class RecordInvalid < StandardError
+      attr_reader :record
+
+      def initialize(record)
+        @record = record
+        super(record.errors.full_messages.join(', '))
+      end
     end
   end
 end

data/lib/capsule_crm/opportunity.rb

@@ -40,6 +40,7 @@ module CapsuleCRM
     attribute :expected_close_date, DateTime
     attribute :actual_close_date, DateTime
     attribute :probability, Float
+    attribute :owner, String
 
     attr_accessor :milestone, :owner
 

data/lib/capsule_crm/task.rb

@@ -28,7 +28,7 @@ module CapsuleCRM
     belongs_to :case
     belongs_to :owner, class_name: 'CapsuleCRM::User', serializable_key: :owner
     belongs_to :category, class_name: 'CapsuleCRM::TaskCategory',
-      serializable_key: :category
+      serializable_key: :category, enforce_type: false
 
     validates :id, numericality: { allow_blank: true }
     validates :description, presence: true

data/lib/capsule_crm/task_category.rb

@@ -26,7 +26,7 @@ module CapsuleCRM
 
     validates :name, presence: true
 
-    has_many :tasks
+    has_many :tasks, source: :category
 
     def id; name; end
   end

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = '1.8.0'
+  VERSION = '1.9.0'
 end

data/lib/capsule_crm.rb

@@ -30,6 +30,7 @@ require 'capsule_crm/website'
 require 'capsule_crm/hash_helper'
 require 'capsule_crm/results_proxy'
 require 'capsule_crm/errors'
+require 'capsule_crm/errors/association_type_mismatch'
 require 'capsule_crm/errors/record_invalid'
 require 'capsule_crm/errors/record_not_saved'
 require 'capsule_crm/errors/response_error'

data/spec/lib/capsule_crm/associations/belongs_to_association_spec.rb

@@ -21,6 +21,38 @@ describe CapsuleCRM::Associations::BelongsToAssociation do
       new(association_name, defined_on, options)
   end
 
+  describe '#check_object!' do
+    context 'when the object is valid' do
+      let(:object) { CapsuleCRM::BelongsToAssociationTest.new }
+
+      it 'should not raise' do
+        expect { association.check_object!(object) }.not_to raise_error
+      end
+    end
+
+    context 'when the object is not valid' do
+      context 'when type checking is turned off' do
+        let(:options) do
+          {
+            class_name: 'CapsuleCRM::BelongsToAssociationTest',
+            enforce_type: false
+          }
+        end
+
+        it 'should not raise' do
+          expect { association.check_object!(double) }.not_to raise_error
+        end
+      end
+
+      context 'when type checking is turned on' do
+        it 'should raise an AssociationMismatch' do
+          expect { association.check_object!(double) }
+            .to raise_error(CapsuleCRM::Errors::AssociationTypeMismatch)
+        end
+      end
+    end
+  end
+
   describe '#macro' do
     subject { association.macro }
 

data/spec/lib/capsule_crm/errors/record_invalid_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe CapsuleCRM::Errors::RecordInvalid do
+  let(:errors) { double('errors', full_messages: full_messages) }
+  let(:full_messages) do
+    ["Record can't be squishy", "Record can't be pink"]
+  end
+  let(:record) { double('Record', errors: errors) }
+
+  subject { described_class.new(record) }
+
+  describe '#to_s' do
+    it 'should return the full messages joined by ,' do
+      expect(subject.to_s).to eql(full_messages.join(', '))
+    end
+  end
+
+  describe '#record' do
+    it 'should be accessible' do
+      expect(subject.record).to eql(record)
+    end
+  end
+end

data/spec/lib/capsule_crm/history_spec.rb

@@ -28,7 +28,7 @@ describe CapsuleCRM::History do
 
     context 'when it belongs to a case' do
       before do
-        subject.case = double('CapsuleCRM::Case', id: Random.rand(1..10))
+        subject.case = CapsuleCRM::Case.new(id: Random.rand(1..10))
       end
 
       it { should_not validate_presence_of(:party) }
@@ -37,7 +37,7 @@ describe CapsuleCRM::History do
 
     context 'when it belongs to a party' do
       before do
-        subject.party = double('CapsuleCRM::Party', id: Random.rand(1..10))
+        subject.party = CapsuleCRM::Party.new(id: Random.rand(1..10))
       end
 
       it { should_not validate_presence_of(:case) }
@@ -47,7 +47,7 @@ describe CapsuleCRM::History do
     context 'when it belongs to an opportunity' do
       before do
         subject.opportunity =
-          double('CapsuleCRM::Opportunity', id: Random.rand(1..10))
+          CapsuleCRM::Opportunity.new(id: Random.rand(1..10))
       end
 
       it { should_not validate_presence_of(:party) }

data/spec/lib/capsule_crm/serializer_spec.rb

@@ -92,7 +92,7 @@ describe CapsuleCRM::Serializer do
     context 'when there are belongs to associations' do
       before do
         SerializableTest.send(
-          :belongs_to, :person, class_name: 'SerializableTest'
+          :belongs_to, :person, class_name: 'CapsuleCRM::Person'
         )
         SerializableTest.send(
           :has_many, :things, class_name: 'SerializableTest',
@@ -100,7 +100,7 @@ describe CapsuleCRM::Serializer do
         )
         object.person = person
       end
-      let(:person) { double('CapsuleCRM::Person', id: Random.rand(1..10)) }
+      let(:person) { CapsuleCRM::Person.new(id: Random.rand(1..10)) }
 
       context 'without a serializable key' do
         it 'should include the person id' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capsule_crm
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Matt Beedle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -274,6 +274,7 @@ files:
 - lib/capsule_crm/custom_field_definition.rb
 - lib/capsule_crm/email.rb
 - lib/capsule_crm/errors.rb
+- lib/capsule_crm/errors/association_type_mismatch.rb
 - lib/capsule_crm/errors/record_invalid.rb
 - lib/capsule_crm/errors/record_not_saved.rb
 - lib/capsule_crm/errors/response_error.rb
@@ -334,6 +335,7 @@ files:
 - spec/lib/capsule_crm/custom_field_definition_spec.rb
 - spec/lib/capsule_crm/custom_field_spec.rb
 - spec/lib/capsule_crm/email_spec.rb
+- spec/lib/capsule_crm/errors/record_invalid_spec.rb
 - spec/lib/capsule_crm/errors/response_error_spec.rb
 - spec/lib/capsule_crm/errors_spec.rb
 - spec/lib/capsule_crm/faraday/middleware/raise_error_spec.rb
@@ -446,6 +448,7 @@ test_files:
 - spec/lib/capsule_crm/custom_field_definition_spec.rb
 - spec/lib/capsule_crm/custom_field_spec.rb
 - spec/lib/capsule_crm/email_spec.rb
+- spec/lib/capsule_crm/errors/record_invalid_spec.rb
 - spec/lib/capsule_crm/errors/response_error_spec.rb
 - spec/lib/capsule_crm/errors_spec.rb
 - spec/lib/capsule_crm/faraday/middleware/raise_error_spec.rb