autotask_ruby 0.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7ad34429eb41909dc0182250592d4912aa0537099a206b4d59f47d71786784
-  data.tar.gz: 8d3e4ca3b363e9bf3bb72fb79f51a1693a42f7b10f04a38ca220af62d2178c72
+  metadata.gz: 508e05d8468713f8dd50ce98719c0b1ff139a0935459be0cc0ed08fffc14451b
+  data.tar.gz: '09592b92714f90db2f070fa5487eed58853418b55ff3df40c8f257508573780f'
 SHA512:
-  metadata.gz: a8f742c6bc21caf1e510f472fb7019297e0066cc5e61e914b0d4703e0e1040cff8bd476049c7afee1b533dd4d7744dfbadfa67c1cc49aa463f37f469e6ec9527
-  data.tar.gz: 34bd4b992cf23590ea7807aa7f667aa4b24267ab345ac55d6f1b5331721e299efe50583e6ca94a2c5a0c1bf76298d1ad501fde651dd01a09bbe774ed78e8e770
+  metadata.gz: 41947b77a8ed8f45bdbe1ae1b37ced6da2938180373913fc6ef5c2beb93e523cd4ef18655b431a3deeb4f6a61fe27a488cd9cd75ec7c5d081ec383e552502fbb
+  data.tar.gz: 63ce5fe9e0eb34f7fde68233fc4d413fee9b90c40493c9971b5c97e289fcb63fabd45a8f3be87a52e6cdffa31d9186ccf4b1a0f4534340f31729924b69dc5ab2

data/.rubocop.yml

@@ -1,7 +1,7 @@
 require: rubocop-rspec
 
 Metrics/LineLength:
-  Max: 160
+  Max: 120
 
 Layout/IndentationWidth:
-  Width: 4
+  Width: 2

data/.ruby-version

@@ -1 +1,2 @@
-ruby-2.5.3
+ruby-2.6.4
+

data/Gemfile.lock

@@ -2,35 +2,36 @@ PATH
   remote: .
   specs:
     autotask_ruby (0.1.0)
-      activesupport (~> 5.2)
-      savon (~> 2.12)
+      activesupport
+      savon
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (6.0.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+      zeitwerk (~> 2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     akami (1.3.1)
       gyoku (>= 0.4.0)
       nokogiri
     ast (2.4.0)
     awesome_print (1.8.0)
-    builder (3.2.3)
-    byebug (10.0.2)
+    builder (3.2.4)
+    byebug (11.1.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    dotenv (2.5.0)
-    ffi (1.9.25)
+    dotenv (2.7.5)
+    ffi (1.12.2)
     formatador (0.2.5)
-    guard (2.15.0)
+    guard (2.16.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -46,68 +47,64 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     gyoku (1.3.1)
       builder (>= 2.1.2)
-    hashdiff (0.3.8)
+    hashdiff (1.0.0)
     httpi (2.4.4)
       rack
       socksify
-    i18n (1.4.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.13)
+    jaro_winkler (1.5.4)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.4)
     method_source (0.9.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
+    minitest (5.14.0)
     nenv (0.3.0)
-    nokogiri (1.9.1)
+    nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
     nori (2.6.0)
-    notiffany (0.1.1)
+    notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.3)
-    rack (2.0.6)
+    public_suffix (4.0.3)
+    rack (2.2.1)
     rainbow (3.0.0)
-    rake (12.3.2)
+    rake (13.0.1)
     rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
+    rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.62.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    rubocop-rspec (1.31.0)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.0)
-    ruby_dep (1.5.0)
-    safe_yaml (1.0.4)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.37.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
     savon (2.12.0)
       akami (~> 1.2)
       builder (>= 2.1.2)
@@ -118,35 +115,36 @@ GEM
       wasabi (~> 3.4)
     shellany (0.0.1)
     socksify (1.7.1)
-    thor (0.20.3)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    unicode-display_width (1.4.1)
+    unicode-display_width (1.6.1)
     wasabi (3.5.0)
       httpi (~> 2.0)
       nokogiri (>= 1.4.2)
-    webmock (3.5.1)
+    webmock (3.8.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   autotask_ruby!
-  awesome_print (~> 1.8)
-  bundler (~> 1.17)
-  byebug (~> 10.0)
-  dotenv (~> 2.5)
-  guard (~> 2.15)
-  guard-rspec (~> 4.7)
-  rake (~> 12.3)
-  rspec (~> 3.8)
-  rubocop (~> 0.62)
-  rubocop-rspec (~> 1.31)
-  webmock (~> 3.5)
+  awesome_print
+  bundler
+  byebug
+  dotenv
+  guard
+  guard-rspec
+  rake
+  rspec
+  rubocop
+  rubocop-rspec
+  webmock
 
 BUNDLED WITH
-   1.17.1
+   2.1.2

data/lib/autotask_ruby.rb

@@ -9,11 +9,13 @@ require 'nokogiri'
 require 'autotask_ruby/configuration'
 require 'autotask_ruby/constants'
 require 'autotask_ruby/query'
+require 'autotask_ruby/query_xml'
 require 'autotask_ruby/association'
 require 'autotask_ruby/response'
 require 'autotask_ruby/query_response'
 require 'autotask_ruby/create_response'
 require 'autotask_ruby/delete_response'
+require 'autotask_ruby/update_response'
 require 'autotask_ruby/zone_info'
 require 'autotask_ruby/entity'
 require 'autotask_ruby/client'
@@ -22,6 +24,7 @@ require 'autotask_ruby/account'
 require 'autotask_ruby/contact'
 require 'autotask_ruby/account_to_do'
 require 'autotask_ruby/appointment'
+require 'autotask_ruby/action_type'
 require 'autotask_ruby/task'
 require 'autotask_ruby/ticket'
 require 'autotask_ruby/project'

data/lib/autotask_ruby/account.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
-    # Represents the Autotask Account Entity
-    class Account
-        include Entity
-
-        FIELDS = %i[id Address1 City Country CreateDate AccountName AccountNumber Phone PostalCode State Active].freeze
-        .each do |field|
-            self.attr_accessor :"#{field.to_s.underscore}"
-        end
+  # Represents the Autotask Account Entity
+  class Account
+    include Entity
 
+    FIELDS = %i[id Address1 City Country CreateDate AccountName AccountNumber Phone PostalCode State Active].freeze
+                                                                                                            .each do |field|
+      attr_accessor :"#{field.to_s.underscore}"
     end
+  end
 end

data/lib/autotask_ruby/account_to_do.rb

@@ -1,20 +1,29 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
-    # Represents the Autotask AccountToDo entity
-    class AccountToDo
-        include AutotaskRuby::Entity
-        include AutotaskRuby::Query
+  # Represents the Autotask AccountToDo entity
+  class AccountToDo
+    include AutotaskRuby::Entity
+    include AutotaskRuby::Query
 
-        FIELDS = %i[id AccountID ContactID ActivityDescription StartDateTime EndDateTime
-                    AssignedToResourceID ActionType CreateDateTime LastModifiedDate].freeze
-        .each do |field|
-            self.attr_accessor :"#{field.to_s.underscore}"
-        end
+    FIELDS = %i[id AccountID ContactID ActivityDescription StartDateTime EndDateTime
+                AssignedToResourceID CreateDateTime LastModifiedDate ActionType].freeze
+             .each do |field|
+      attr_accessor :"#{field.to_s.underscore}"
+    end
+
+    def post_initialize
+      belongs_to :resource
+      belongs_to :account
+    end
 
-        def post_initialize
-            belongs_to :resource
-            belongs_to :account
-        end
+    def contact
+      find('Contact', contact_id)
     end
+
+    def action
+      find('ActionType', action_type)
+    end
+
+  end
 end

data/lib/autotask_ruby/action_type.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
-    # Represents the Autotask Entity Action Type
-    class ActionType
-        include Entity
+  # Represents the Autotask Entity Action Type
+  class ActionType
+    include Entity
 
-        FIELDS = %i[id Name View Active SystemActionType].freeze
-        .each do |field|
-            self.attr_accessor :"#{field.to_s.underscore}"
-        end
+    FIELDS = %i[id Name View Active SystemActionType].freeze
+                                                     .each do |field|
+      attr_accessor :"#{field.to_s.underscore}"
     end
+  end
 end

data/lib/autotask_ruby/appointment.rb

@@ -1,20 +1,17 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
+  # Represents an AutoTask Appointment Entity
+  class Appointment
+    include Entity
 
-    # Represents an AutoTask Appointment Entity
-    class Appointment
-        include Entity
-
-        FIELDS = %i[id Title Description ResourceID StartDateTime EndDateTime CreateDateTime UpdateDateTime].freeze
-        .each do |field|
-            self.attr_accessor :"#{field.to_s.underscore}"
-        end
-
-        def post_initialize
-            belongs_to :resource
-        end
-
+    FIELDS = %i[id Title Description ResourceID StartDateTime EndDateTime CreateDateTime UpdateDateTime].freeze
+                                                                                                        .each do |field|
+      attr_accessor :"#{field.to_s.underscore}"
     end
 
+    def post_initialize
+      belongs_to :resource
+    end
+  end
 end

data/lib/autotask_ruby/association.rb

@@ -1,38 +1,40 @@
+# frozen_string_literal: true
+
 module AutotaskRuby
-    # handles loading associated entities.
-    module Association
-        # loads parent entity.
-        # Thanks to scoop for this example.
-        def belongs_to(name, options = {})
-            name = name.to_s
-            klass = "#{(options[:class_name] || name).to_s.classify}"
-            foreign_key = name.foreign_key
-            define_singleton_method(name) do
-                find(klass, send(foreign_key))
-            end
-        end
+  # handles loading associated entities.
+  module Association
+    # loads parent entity.
+    # Thanks to scoop for this example.
+    def belongs_to(name, options = {})
+      name = name.to_s
+      klass = (options[:class_name] || name).to_s.classify.to_s
+      foreign_key = name.foreign_key
+      define_singleton_method(name) do
+        find(klass, send(foreign_key))
+      end
+    end
 
-        # Example, an appointment can have one contact.
-        # Thanks to scoop for this example.
-        def has_one(name, options = {})
-            name = name.to_s
-            options.reverse_merge! foreign_key: self.to_s.foreign_key.camelize
-            klass = "#{(options[:class_name] || name).to_s.classify}"
-            define_singleton_method(name) do
-                find(klass, options[:foreign_key], id).first
-            end
-        end
+    # Example, an appointment can have one contact.
+    # Thanks to scoop for this example.
+    def has_one(name, options = {})
+      name = name.to_s
+      options.reverse_merge! foreign_key: to_s.foreign_key.camelize
+      klass = (options[:class_name] || name).to_s.classify.to_s
+      define_singleton_method(name) do
+        find(klass, options[:foreign_key], id).first
+      end
+    end
 
-        # loads child entities.
-        # Example: A project can have many tasks.
-        # Thanks to scoop for this example.
-        def has_many(name, options = {})
-            name = name.to_s
-            options.reverse_merge! foreign_key: self.to_s.foreign_key.camelize
-            klass = "#{(options[:class_name] || name).to_s.classify}"
-            define_singleton_method(name) do
-                query(klass, options[:foreign_key], id)
-            end
-        end
+    # loads child entities.
+    # Example: A project can have many tasks.
+    # Thanks to scoop for this example.
+    def has_many(name, options = {})
+      name = name.to_s
+      options.reverse_merge! foreign_key: to_s.foreign_key.camelize
+      klass = (options[:class_name] || name).to_s.classify.to_s
+      define_singleton_method(name) do
+        query(klass, options[:foreign_key], id)
+      end
     end
+  end
 end

data/lib/autotask_ruby/client.rb

@@ -4,88 +4,106 @@ require 'autotask_ruby/version'
 require 'autotask_ruby/resource'
 
 module AutotaskRuby
+  # the primary client that interfaces with the SOAP Client that will interface with AutoTask.
+  class Client
+    attr_accessor :soap_client, :headers, :logger
 
-    # the primary client that interfaces with the SOAP Client that will interface with AutoTask.
-    class Client
-        attr_accessor :soap_client, :headers, :logger
-
-        def initialize(options = {})
-            @version = options[:version] || AutotaskRuby.configuration.version
-            integration_code = options[:integration_code] || AutotaskRuby.configuration.integration_code
-            @headers = {
-                'tns:AutotaskIntegrations' =>
-                    {
-                        'tns:IntegrationCode' => integration_code
-                    }
+    def initialize(options = {})
+      @version = options[:version] || AutotaskRuby.configuration.version
+      integration_code = options[:integration_code] || AutotaskRuby.configuration.integration_code
+      @headers = {
+        'tns:AutotaskIntegrations' =>
+            {
+              'tns:IntegrationCode' => integration_code
             }
+      }
 
-            @ssl_version = options[:ssl_version] || :TLSv1_2
-
-            @host = options[:host] || 'webservices.autotask.net'
-            @endpoint = options[:endpoint] || "https://#{@host}/ATServices/#{@version}/atws.asmx"
-
-            # Override optional Savon attributes
-            savon_options = {}
-            %w[read_timeout open_timeout proxy raise_errors log_level basic_auth log raise_errors].each do |prop|
-                key = prop.to_sym
-                savon_options[key] = options[key] if options.key?(key)
-            end
-
-            @soap_client = Savon.client({
-                wsdl: './atws.wsdl',
-                soap_header: @headers,
-                namespaces: { xmlns: AutotaskRuby.configuration.namespace },
-                logger: Logger.new($stdout),
-                raise_errors: false,
-                log: true,
-                endpoint: @endpoint,
-                ssl_version: @ssl_version # Sets ssl_version for HTTPI adapter
-            }.update(savon_options))
-        end
-
-        # Public: Get the names of all wsdl operations.
-        # List all available operations from the atws.wsdl
-        def operations
-            @soap_client.operations
-        end
-
-        # @param entity, id
-        #   pass in the entity_type, I.E. AccountToDo, Resource, etc. and the ID of the entity.
-        # @return Entity
-        # Returns a single Entity if a match was found.
-        # Returns nil if no match is found.
-        def find(entity, id)
-            response = query(entity.to_s, id)
-
-            return nil if response.entities.empty?
-
-            response.entities.first
-        end
-
-        # @param entity_type and value
-        # Other parameters, are optional.
-        #   full set of parameters include entity_type, field, operation, value.
-        # Queries the Autotask QUERY API. Returns a QueryResponse result set.
-        # @return AutotaskRuby::Response.
-        def query(entity_type, field = 'id', operation = 'equals', value)
-            result = @soap_client.call(:query, message: "<sXML><![CDATA[<queryxml><entity>#{entity_type}</entity><query><field>#{field}<expression op=\"#{operation}\">#{value}</expression></field></query></queryxml>]]></sXML>")
-            AutotaskRuby::QueryResponse.new(self, result)
-        end
-
-        # @param entity_type
-        #   include the entity type. ServiceCall, Appointment, etc.
-        # @param ids
-        #   One or more entity ID's that should be deleted.
-        # @return
-        #   AutotaskRuby::DeleteResponse
-        def delete(entity_type, *ids)
-            entities = ++''
-            ids.each do |id|
-                entities << "<Entity xsi:type=\"#{entity_type}\"><id xsi:type=\"xsd:int\">#{id}</id></Entity>"
-            end
-            resp = @soap_client.call(:delete, message: "<Entities>#{entities.to_s}</Entities>")
-            AutotaskRuby::DeleteResponse.new(@client, resp)
-        end
+      @ssl_version = options[:ssl_version] || :TLSv1_2
 
+      @host = options[:host] || 'webservices.autotask.net'
+      @endpoint = options[:endpoint] || "https://#{@host}/ATServices/#{@version}/atws.asmx"
+
+      # Override optional Savon attributes
+      savon_options = {}
+      %w[read_timeout open_timeout proxy raise_errors log_level basic_auth log raise_errors].each do |prop|
+        key = prop.to_sym
+        savon_options[key] = options[key] if options.key?(key)
+      end
+
+      @soap_client = Savon.client({
+        wsdl: './atws.wsdl',
+        soap_header: @headers,
+        namespaces: { xmlns: AutotaskRuby.configuration.namespace },
+        logger: Logger.new($stdout),
+        raise_errors: false,
+        log: true,
+        endpoint: @endpoint,
+        ssl_version: @ssl_version # Sets ssl_version for HTTPI adapter
+      }.update(savon_options))
+    end
+
+    # Public: Get the names of all wsdl operations.
+    # List all available operations from the atws.wsdl
+    def operations
+      @soap_client.operations
+    end
+
+    # @param entity, id
+    #   pass in the entity_type, I.E. AccountToDo, Resource, etc. and the ID of the entity.
+    # @return Entity
+    # Returns a single Entity if a match was found.
+    # Returns nil if no match is found.
+    def find(entity, id)
+      response = query(entity.to_s, id)
+
+      return nil if response.entities.empty?
+
+      response.entities.first
+    end
+
+    # @param entity_type and value
+    # Other parameters, are optional.
+    #   full set of parameters include entity_type, field, operation, value.
+    # Queries the Autotask QUERY API. Returns a QueryResponse result set.
+    # @return AutotaskRuby::Response.
+    def query(entity_type, field = 'id', operation = 'equals', value)
+      result = @soap_client.call(:query, message: "<sXML><![CDATA[<queryxml><entity>#{entity_type}</entity><query><field>#{field}<expression op=\"#{operation}\">#{value}</expression></field></query></queryxml>]]></sXML>")
+      AutotaskRuby::QueryResponse.new(self, result)
+    end
+
+    # @param entity_type
+    #   include the entity type. ServiceCall, Appointment, etc.
+    # @param ids
+    #   One or more entity ID's that should be deleted.
+    # @return
+    #   AutotaskRuby::DeleteResponse
+    def delete(entity_type, *ids)
+      entities = ++''
+      ids.each do |id|
+        entities << "<Entity xsi:type=\"#{entity_type}\"><id xsi:type=\"xsd:int\">#{id}</id></Entity>"
+      end
+      resp = @soap_client.call(:delete, message: "<Entities>#{entities}</Entities>")
+      AutotaskRuby::DeleteResponse.new(@client, resp)
+    end
+
+    def query_for(message)
+      result = @soap_client.call(:query, message: message)
+      AutotaskRuby::QueryResponse.new(self, result)
+    end
+
+    # updates the entity in the AutoTask API.
+    # All fields are iterated and this builds the XML message that is sent to AutoTask.
+    # Any field that is not filled out will be sent as empty. This means that it will wipe
+    # any value that AutoTask has for that field.
+    def update(entity_xml)
+      result = @soap_client.call(:update, message: "<Entities>#{entity_xml}</Entities>")
+      UpdateResponse.new(@client, result)
+    end
+
+    # creates an entity in AutoTask.
+    def create(entity_xml)
+      result = @soap_client.call(:create, message: "<Entities>#{entity_xml}</Entities>")
+      CreateResponse.new(@client, result)
     end
+  end
 end