capsule_crm 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 143725dc45cebfffee7104b902cda999f6e5d5a4
-  data.tar.gz: b15eee85686b5e11f0f2c5cea64701ed85d02a9c
+  metadata.gz: 8f08b4e0897c37f8539c3dc0fcde24c91c374d7f
+  data.tar.gz: 810a9aa84d4c3a2b8fd2fd855c68b65d9315dfc5
 SHA512:
-  metadata.gz: d3ca68c5b10e99a3b7cbe9b2fad98d4a84e1d4b3d79bc7fcfdbe327c038a1b122a5504cd8c02a74b67620cc9f7704571d6b8c06e5717ab2d4aa3e938a16a80fe
-  data.tar.gz: b20d34a05f2695e836e07bf2c1053dcf7806a96297d31dacdfbcf1797b55d9c0f7577a1a77a03109b3f579be816c2cd924ae9b6b81dfc25a197de073c10e2115
+  metadata.gz: 6c2ded3a643e2d174a0bc0b03c0a238434734f8320f85855994af9374abc86cb1a9d59358bb949c70b7830fec342c5f89aa9540bd97b9b2188b55e77a15c9067
+  data.tar.gz: ba7401ac676e2ae7130929c30522b448374d37b6f2be8c5f9133e8590cae2170468680f77c1b21a24c2df2ba6b91de4ffa9f265938a9aa5c81440c053715696e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.10.0
+
+- Added Track support
+
 ## 0.9.1
 
 - Refactored code for finding parties/people/organizations to make sure that

data/README.md

@@ -157,6 +157,12 @@ history = org.histories.build note: 'some note text'
 history = org.histories.create note: 'some note text'
 ```
 
+### Tracks
+```ruby
+# List tracks
+tracks = CapsuleCRM::Track.all
+```
+
 ### Opportunities
 ```ruby
 # Find an opportunity
@@ -165,6 +171,18 @@ opportunity = CapsuleCRM::Opportunity.find(ID)
 # List all opportunities
 opportunities = CapsuleCRM::Opportunity.all
 
+# Build a new opportunity
+opportunity = CapsuleCRM::Opportunity.new(
+  name: 'my first opportunity',
+  party: CapsuleCRM::Party.find(1)
+  milestone: CapsuleCRM::Milestone.find(10)
+  track: CapsuleCRM::Track.all.first
+)
+
+# Save the opportunity
+opportunity.save
+opportunity.save!
+
 # List tags
 opportunity.tags
 

data/lib/capsule_crm.rb

@@ -34,6 +34,7 @@ require 'capsule_crm/organization'
 require 'capsule_crm/participant'
 require 'capsule_crm/person'
 require 'capsule_crm/milestone'
+require 'capsule_crm/track'
 require 'capsule_crm/version'
 
 module CapsuleCRM

data/lib/capsule_crm/case.rb

@@ -22,6 +22,7 @@ module CapsuleCRM
     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
 
@@ -238,16 +239,24 @@ module CapsuleCRM
     def to_capsule_json
       {
         kase: CapsuleCRM::HashHelper.camelize_keys(
-          attributes.dup.delete_if { |key, value| value.blank? }
+          attributes.dup.delete_if do |key, value|
+            value.blank? || key == 'track_id'
+          end
         )
       }
     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 create_record
+      path = "/api/party/#{party_id}/kase"
+      path += "?trackId=#{track_id}" if track_id
       self.attributes = CapsuleCRM::Connection.post(
-        "/api/party/#{party_id}/kase", to_capsule_json
+        path, to_capsule_json
       )
       self
     end

data/lib/capsule_crm/opportunity.rb

@@ -30,8 +30,9 @@ module CapsuleCRM
 
     has_many :tasks, class_name: 'CapsuleCRM::Task', source: :opportunity
 
-    belongs_to :party, class_name: 'CapsuleCRM::Party'
+    belongs_to :party,     class_name: 'CapsuleCRM::Party'
     belongs_to :milestone, class_name: 'CapsuleCRM::Milestone'
+    belongs_to :track,     class_name: 'CapsuleCRM::Track'
 
     def milestone=(milestone)
       if milestone.is_a?(String)
@@ -42,6 +43,10 @@ module CapsuleCRM
       self
     end
 
+    def self._for_track(track)
+      raise NotImplementedError.new("There is no way to find opportunities by trackId in the Capsule API right now")
+    end
+
     # Public: Get all opportunities from Capsule. The list can be restricted
     # and/or paginated with various query parameters sent through the options
     # hash.
@@ -289,7 +294,9 @@ module CapsuleCRM
     def to_capsule_json
       {
         opportunity: CapsuleCRM::HashHelper.camelize_keys(
-          attributes.dup.delete_if { |key, value| value.blank? }
+          attributes.dup.delete_if do |key, value|
+            value.blank? || key == 'track_id'
+          end
         )
       }.stringify_keys
     end
@@ -309,9 +316,9 @@ module CapsuleCRM
     private
 
     def create_record
-      self.attributes = CapsuleCRM::Connection.post(
-        "/api/party/#{party_id}/opportunity", to_capsule_json
-      )
+      path = "/api/party/#{party_id}/opportunity"
+      path += "?trackId=#{track_id}" if track_id
+      self.attributes = CapsuleCRM::Connection.post(path, to_capsule_json)
       self
     end
 

data/lib/capsule_crm/track.rb

@@ -0,0 +1,26 @@
+module CapsuleCRM
+  class Track
+    include Virtus
+
+    extend  ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    include CapsuleCRM::Associations::HasMany
+    include CapsuleCRM::Attributes
+    include CapsuleCRM::Collection
+
+    attribute :id,            Integer
+    attribute :description,   String
+    attribute :capture_rule,  String
+
+    has_many :opportunities, class_name: 'CapsuleCRM::Opportunity'
+    has_many :cases, class_name: 'CapsuleCRM::Case'
+
+    def self.all
+      init_collection(
+        CapsuleCRM::Connection.get('/api/tracks')['tracks']['track']
+      )
+    end
+  end
+end

data/lib/capsule_crm/version.rb

@@ -1,3 +1,3 @@
 module CapsuleCrm
-  VERSION = '0.9.1'
+  VERSION = '0.10.0'
 end

data/spec/lib/capsule_crm/case_spec.rb

@@ -12,6 +12,15 @@ describe CapsuleCRM::Case do
 
   it { should validate_presence_of(:party) }
 
+  describe '._for_track' do
+    let(:track) { CapsuleCRM::Track.new }
+
+    it do
+      expect { CapsuleCRM::Case._for_track(track) }.
+        to raise_error(NotImplementedError)
+    end
+  end
+
   describe '#tasks' do
     let(:kase) { Fabricate.build(:case, id: 3) }
 
@@ -58,17 +67,19 @@ describe CapsuleCRM::Case do
   end
 
   describe '.create' do
+    let(:request_uri) do
+      'https://1234:@company.capsulecrm.com/api/party/1/kase'
+    end
+
+    let(:party) { CapsuleCRM::Person.new(id: 1, first_name: 'Matt') }
+
     context 'when the case is valid' do
       before do
-        stub_request(
-          :post, 'https://1234:@company.capsulecrm.com/api/party/1/kase'
-        ).to_return(
+        stub_request(:post, request_uri).to_return(
           headers: { 'Location' => 'https://sample.capsulecrm.com/api/kase/59' }
         )
       end
 
-      let(:party) { CapsuleCRM::Person.new(id: 1, first_name: 'Matt') }
-
       subject { CapsuleCRM::Case.create name: 'Test Case', party: party }
 
       it { should be_a(CapsuleCRM::Case) }
@@ -81,6 +92,30 @@ describe CapsuleCRM::Case do
 
       it { kase.errors.should_not be_blank }
     end
+
+    context 'when the case has a track' do
+      before do
+        stub_request(:post, "#{request_uri}?trackId=#{track.id}").to_return(
+          headers: { 'Location' => 'https://sample.capsulecrm.com/api/kase/59' }
+        )
+      end
+
+      let(:track) { CapsuleCRM::Track.new(id: rand(10)) }
+
+      subject do
+        CapsuleCRM::Case.create(name: 'Test Case', party: party, track: track)
+      end
+
+      it { expect(subject).to be_a(CapsuleCRM::Case) }
+
+      it { expect(subject).to be_persisted }
+
+      it do
+        subject
+        expect(WebMock).
+          to have_requested(:post, "#{request_uri}?trackId=#{track.id}")
+      end
+    end
   end
 
   describe '.create!' do

data/spec/lib/capsule_crm/opportunity_spec.rb

@@ -35,6 +35,15 @@ describe CapsuleCRM::Opportunity do
     it { should_not validate_presence_of(:milestone_id) }
   end
 
+  describe '._for_track' do
+    let(:track) { CapsuleCRM::Track.new }
+
+    it 'should raise a not implemented error' do
+      expect { CapsuleCRM::Opportunity._for_track(track) }.
+        to raise_error(NotImplementedError)
+    end
+  end
+
   describe '#tasks' do
     let(:opportunity) { Fabricate.build(:opportunity, id: 5) }
 
@@ -237,6 +246,32 @@ describe CapsuleCRM::Opportunity do
       it { should be_persisted }
 
       it { subject.id.should eql(59) }
+
+      context 'when the opportunity has a track' do
+        before do
+          stub_request(:post, "#{request_path}?trackId=#{track.id}").to_return(
+            headers: {
+              'Location' => 'https://sample.capsulecrm.com/api/opportunity/59'
+            }
+          )
+        end
+
+        let(:track) { CapsuleCRM::Track.new(id: rand(10)) }
+
+        subject do
+          CapsuleCRM::Opportunity.
+            create(opportunity_attributes.merge(track: track))
+        end
+
+        it { expect(subject).to be_a(CapsuleCRM::Opportunity) }
+
+        it do
+          subject
+          WebMock.should have_requested(
+            :post, "#{request_path}?trackId=#{track.id}"
+          )
+        end
+      end
     end
 
     context 'when the opportunity is not valid' do

data/spec/lib/capsule_crm/track_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe CapsuleCRM::Track do
+  before { configure }
+
+  describe '.all' do
+    before do
+      stub_request(:get, /\/api\/tracks$/).
+        to_return(body: File.read('spec/support/tracks.json'))
+    end
+
+    subject { CapsuleCRM::Track.all }
+
+    it { expect(subject).to be_a(Array) }
+
+    it { expect(subject.length).to eql(2) }
+
+    it { expect(subject.first).to be_a(CapsuleCRM::Track) }
+
+    it { expect(subject.first.description).to eql('Sales follow up') }
+
+    it { expect(subject.first.capture_rule).to eql('OPPORTUNITY') }
+
+    it { expect(subject.first.id).to eql(1) }
+  end
+end

data/spec/support/tracks.json

@@ -0,0 +1,16 @@
+{
+  "tracks": {
+    "track": [
+      {
+        "id": "1",
+        "description": "Sales follow up",
+        "captureRule": "OPPORTUNITY"
+      },
+      {
+        "id": "2",
+        "description": "Customer service feedback",
+        "captureRule": "CASEFILE"
+      }
+    ]
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capsule_crm
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Matt Beedle
@@ -285,6 +285,7 @@ files:
 - lib/capsule_crm/tag.rb
 - lib/capsule_crm/taggable.rb
 - lib/capsule_crm/task.rb
+- lib/capsule_crm/track.rb
 - lib/capsule_crm/user.rb
 - lib/capsule_crm/version.rb
 - lib/capsule_crm/website.rb
@@ -312,6 +313,7 @@ files:
 - spec/lib/capsule_crm/tag_spec.rb
 - spec/lib/capsule_crm/taggable_spec.rb
 - spec/lib/capsule_crm/task_spec.rb
+- spec/lib/capsule_crm/track_spec.rb
 - spec/lib/capsule_crm/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/all_cases.json
@@ -339,6 +341,7 @@ files:
 - spec/support/single_user.json
 - spec/support/task.json
 - spec/support/task_categories.json
+- spec/support/tracks.json
 homepage: ''
 licenses: []
 metadata: {}
@@ -388,6 +391,7 @@ test_files:
 - spec/lib/capsule_crm/tag_spec.rb
 - spec/lib/capsule_crm/taggable_spec.rb
 - spec/lib/capsule_crm/task_spec.rb
+- spec/lib/capsule_crm/track_spec.rb
 - spec/lib/capsule_crm/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/all_cases.json
@@ -415,3 +419,4 @@ test_files:
 - spec/support/single_user.json
 - spec/support/task.json
 - spec/support/task_categories.json
+- spec/support/tracks.json