connectwise_sdk 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6d2d523b28059cb548e7681f1f2ec0765121470
-  data.tar.gz: 2994bc44e356d9f7a00dad0d04e83354763b4ca8
+  metadata.gz: 671e29c4c5672a85c98003621cc98720e306d375
+  data.tar.gz: 7fcb0eb04be9f02db99a3f7663a6cd028deb87b2
 SHA512:
-  metadata.gz: 060aca0059fe895b85139c1d8dc33a04e6eb49c0fa88f518c2e522b0291edcc942f961f4fbb872d8ac1c5ef68c3e920dbec747d9c498ef2f23551c076f698464
-  data.tar.gz: ae995236a9f669b16fc048e98d8499a4c010184ea4fec23dd2da00b470b26ea6b530048af553028279f567102e2706d369d7492892fcb0d776248012abef6b52
+  metadata.gz: cfbd2ae2a774a0d7aedbc5c7ce614458c2ebc225d9694f249a1d464624f936061816c3b40bc0c4653eea37d9e204a010cc5d88b3d9bd51b9588fd6065262bc6b
+  data.tar.gz: 8dab21de5c673309fd743a6c3b38e82d1c0cc8d1060e257b93b2cea6607b9d6caf528ab51dc1d07ebedfe7ea66f360698187aa1786584b51bfec34ae04b3a64d

data/README.md

@@ -39,7 +39,7 @@ conn = Connectwise::Connection.new host: 'host.domain.com', company_name: 'compa
 conn.call :contact, :find_contacts, conditions: 'EmailAddress like "test@test.com"'
 ```
 
- - The first parameter is the api you wish to use.  In this case the `contactApi`.  
+ - The first parameter is the api you wish to use.  In this case the `contactApi`.
  - The second parameter is the specific api call you wish to use (from the Connectwise Api documentation)
  - The third paramater is the data you wish to send the api
 
@@ -62,8 +62,7 @@ Currently the low level `Connection.call` method is working, as well as basic Me
 
 Remaining items include:
 
-1. Ticket class
-2. Support Notes for Opportunities (submitting them)
+1. Support Notes for Opportunities (submitting them)
 2. Creating a Facade layer so that the connection object doesn't need to be passed to each object
 3. Supporting a late binding way of accessing internal objects (accessing the company object within an opportunity for example)
 4. Supporting an intuitive way of accessing lists of phone numbers, addresses, and email addresses, while still allowing simple access to the first one of each.

data/lib/connectwise/model.rb

@@ -8,7 +8,7 @@ module Connectwise
       end
 
       def find(connection, id)
-        if (attrs = connection.call(cw_api_name, "get_#{cw_api_name}".to_sym, {id: id}))
+        if (attrs = connection.call(cw_api_name, "get_#{cw_model_name}".to_sym, {id: id}))
           self.new(connection, find_transform(attrs))
         else
           fail RecordNotFound
@@ -33,6 +33,10 @@ module Connectwise
         base_class_name.downcase.to_sym
       end
 
+      def cw_model_name
+        base_class_name.downcase.to_sym
+      end
+
       def plural_class_name
         ending = base_class_name[/[aeiou]$/] ? 'es' : 's'
         @plural_form ||= "#{base_class_name.downcase}#{ending}"
@@ -85,12 +89,12 @@ module Connectwise
     end
 
     def save
-      attrs = connection.call self.class.cw_api_name, "add_or_update_#{self.class.cw_api_name}".to_sym, {self.class.cw_api_name => to_cw_h}
+      attrs = connection.call self.class.cw_api_name, "add_or_update_#{self.class.cw_model_name}".to_sym, {self.class.cw_model_name => to_cw_h}
       self.class.new(connection, self.class.save_transform(attrs))
     end
 
     def destroy
-      connection.call self.class.cw_api_name, "delete_#{self.class.cw_api_name}".to_sym, {id: id}
+      connection.call self.class.cw_api_name, "delete_#{self.class.cw_model_name}".to_sym, {id: id}
       self
     end
 

data/lib/connectwise/ticket.rb

@@ -2,7 +2,7 @@ module Connectwise
   class Ticket
     include Model
     model_name 'service_ticket'
-    attr_accessor :id, :summary, :problem_description, :status_name, :board, :site_name, :status, :resolution, :remote_internal_company_name, :priority, :source, :severity, :impact,
+    attr_accessor :id, :summary, :problem_description, :status_name, :board, :site_name, :status, :resolution, :remote_internal_company_name, :priority, :source, :severity, :impact, :company
 
     #TODO - The use of SrServiceRecid and TicketNumber instead of id - may want to configure these
     # but this is so inconsistent for tickets that it may not be worth it unless other calls do the same thing
@@ -20,10 +20,6 @@ module Connectwise
       @status_name ||= 'New'
     end
 
-    def company=(company)
-      @company = company
-    end
-
     def save
       return false unless @company
       attrs = {companyId: @company.company_id, 'serviceTicket' => to_cw_h}
@@ -36,6 +32,11 @@ module Connectwise
       self
     end
 
+    def add_note(msg, **options)
+      note = TicketNote.new(connection, {note: msg, ticket: self}.merge(options))
+      note.save
+    end
+
     private
     def self.find_transform(attrs)
       attrs[:id] = attrs.delete(:ticket_number)
@@ -44,11 +45,13 @@ module Connectwise
 
     def self.save_transform(attrs)
       attrs[:id] = attrs.delete(:ticket_number)
+      attrs[:company] = OpenStruct.new id: attrs.delete(:company_rec_id)
       attrs
     end
 
     def to_cw_h
       attrs = super
+      attrs.delete('Company')
       attrs['TicketNumber'] = attrs[:id] || 0
       attrs
     end

data/lib/connectwise/ticket_note.rb

@@ -0,0 +1,46 @@
+module Connectwise
+  class TicketNote
+    include Model
+    model_name 'ticket_note'
+    attr_accessor :id, :note, :note_text, :is_part_of_internal_analysis, :is_part_of_resolution, :is_part_of_detail_description
+
+    def self.cw_api_name
+      :service_ticket
+    end
+
+    def self.transform(attrs)
+      type = attrs.delete(:type)
+      attrs[:note_text] ||= attrs.delete(:note)
+      if type == :internal
+        attrs[:is_part_of_internal_analysis] = true
+      elsif type == :resolution
+        attrs[:is_part_of_resolution] = true
+      else
+        attrs[:is_part_of_detail_description] = true
+      end
+      attrs
+    end
+
+    def initialize(connection, **attributes)
+      @ticket = attributes.delete(:ticket)
+      super(connection, attributes)
+    end
+
+    def save
+      attrs = connection.call self.class.cw_api_name, "update_#{self.class.cw_model_name}".to_sym, {'note' => to_cw_h, 'srServiceRecid' => @ticket.id}
+      self.class.new(connection, self.class.save_transform(attrs))
+    end
+
+    def external?
+      !!is_part_of_detail_description
+    end
+
+    def internal?
+      !!is_part_of_internal_analysis
+    end
+
+    def resolution?
+      !!is_part_of_resolution
+    end
+  end
+end

data/lib/connectwise/version.rb

@@ -1,3 +1,3 @@
 module Connectwise
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/connectwise_sdk.rb

@@ -9,3 +9,4 @@ require 'connectwise/company'
 require 'connectwise/contact'
 require 'connectwise/opportunity'
 require 'connectwise/ticket'
+require 'connectwise/ticket_note'

data/spec/lib/connectwise/ticket_note_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Connectwise::TicketNote do
+  let(:credentials) { connectwise_credentials }
+  let(:conn) { Connectwise::Connection.new(credentials) }
+  let(:company_attrs) { {name: 'Pandorica'} }
+  let(:ticket_attrs) { {summary: 'Help me', problem_description: 'I need the doctor!'} }
+  let(:company) { Connectwise::Company.new(conn, company_attrs) }
+  let(:ticket) {
+    t = Connectwise::Ticket.new(conn, ticket_attrs)
+    t.company = company.save
+    t.save
+  }
+  let(:ticket_note_attrs) { {note: 'some text to describe the note', type: :internal} }
+  subject { Connectwise::TicketNote.new(conn, ticket_note_attrs.merge({ticket: ticket})) }
+
+  it 'creates a ticket note' do
+    new_ticket_note = subject.save
+    expect(new_ticket_note.persisted?).to eq true
+  end
+end

data/spec/lib/connectwise/ticket_spec.rb

@@ -49,4 +49,20 @@ describe Connectwise::Ticket do
     expect(deleted_ticket).not_to be_nil
     expect {Connectwise::Ticket.find(conn, new_ticket.id)}.to raise_error Connectwise::RecordNotFound
   end
+
+  it 'adds a note to the ticket' do
+    subject.company = company.save
+    new_ticket = subject.save
+    ticket_note = new_ticket.add_note('Message of some kind')
+    expect(ticket_note.persisted?).to eq true
+    expect(ticket_note.external?).to eq true
+  end
+
+  it 'adds an internal note to the ticket' do
+    subject.company = company.save
+    new_ticket = subject.save
+    ticket_note = new_ticket.add_note('Message of some kind', type: :internal)
+    expect(ticket_note.persisted?).to eq true
+    expect(ticket_note.internal?).to eq true
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: connectwise_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Emery A. Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2014-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - lib/connectwise/model.rb
 - lib/connectwise/opportunity.rb
 - lib/connectwise/ticket.rb
+- lib/connectwise/ticket_note.rb
 - lib/connectwise/version.rb
 - lib/connectwise_sdk.rb
 - spec/credentials.yml.sample
@@ -98,6 +99,7 @@ files:
 - spec/lib/connectwise/contact_spec.rb
 - spec/lib/connectwise/member_spec.rb
 - spec/lib/connectwise/opportunity_spec.rb
+- spec/lib/connectwise/ticket_note_spec.rb
 - spec/lib/connectwise/ticket_spec.rb
 - spec/lib/connectwise_sdk_spec.rb
 - spec/spec_helper.rb
@@ -133,6 +135,7 @@ test_files:
 - spec/lib/connectwise/contact_spec.rb
 - spec/lib/connectwise/member_spec.rb
 - spec/lib/connectwise/opportunity_spec.rb
+- spec/lib/connectwise/ticket_note_spec.rb
 - spec/lib/connectwise/ticket_spec.rb
 - spec/lib/connectwise_sdk_spec.rb
 - spec/spec_helper.rb