autotask_ruby 0.1.0 → 2.0.0

data/lib/autotask_ruby/configuration.rb

@@ -1,25 +1,25 @@
-module AutotaskRuby
+# frozen_string_literal: true
 
-    class Configuration
-        attr_accessor :integration_code
-        attr_accessor :version
-        attr_accessor :namespace
+module AutotaskRuby
+  class Configuration
+    attr_accessor :integration_code
+    attr_accessor :version
+    attr_accessor :namespace
 
-        def initialize
-            @integration_code = nil
-            @version = 1.5
-            @namespace = 'http://autotask.net/ATWS/v1_5/'
-        end
+    def initialize
+      @integration_code = nil
+      @version = 1.5
+      @namespace = 'http://autotask.net/ATWS/v1_5/'
     end
+  end
 
-    class << self
-        def configuration
-            @configuration ||= Configuration.new
-        end
-
-        def configure
-            yield(configuration)
-        end
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
     end
 
+    def configure
+      yield(configuration)
+    end
+  end
 end

data/lib/autotask_ruby/constants.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
-    module Constants
-        AUTOTASK_TIME_FORMAT = '%Y-%m-%dT%H:%M:%S'
-    end
+  module Constants
+    AUTOTASK_TIME_FORMAT = '%Y-%m-%dT%H:%M:%S'
+  end
 end

data/lib/autotask_ruby/contact.rb

@@ -1,26 +1,25 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
+  # Represents the Autotask Entity Contact
+  class Contact
+    include Entity
 
-    # Represents the Autotask Entity Contact
-    class Contact
-        include Entity
-
-        FIELDS = %i[id Active AddressLine City Country CreateDate EMailAddress Extension FirstName AccountID LastName MobilePhone Phone State Title ZipCode].freeze
-        .each do |field|
-            self.attr_accessor :"#{field.to_s.underscore}"
-        end
+    FIELDS = %i[id Active AddressLine City Country CreateDate EMailAddress Extension FirstName AccountID LastName MobilePhone Phone State Title ZipCode].freeze
+                                                                                                                                                        .each do |field|
+      attr_accessor :"#{field.to_s.underscore}"
+    end
 
-        def post_initialize
-            belongs_to :account
-        end
+    def post_initialize
+      belongs_to :account
+    end
 
-        def full_name
-            [@first_name, @last_name].join(' ')
-        end
+    def full_name
+      [@first_name, @last_name].join(' ')
+    end
 
-        def email
-            @e_mail_address
-        end
+    def email
+      @e_mail_address
     end
+  end
 end

data/lib/autotask_ruby/create_response.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module AutotaskRuby
-    class CreateResponse
-        include Response
-    end
+  class CreateResponse
+    include Response
+  end
 end

data/lib/autotask_ruby/delete_response.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module AutotaskRuby
-    class DeleteResponse
-        include Response
-    end
+  class DeleteResponse
+    include Response
+  end
 end

data/lib/autotask_ruby/entity.rb

@@ -1,113 +1,112 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
-    # The base type for all objects represented by AutotaskRuby.
-    # This module should extend any object type being used with AutoTask.
-    module Entity
-        include AutotaskRuby::Constants
-        include AutotaskRuby::Association
-
-        FIELDS = %i[id].freeze
-
-        def self.included(base)
-            base.const_set :FIELDS, Entity::FIELDS unless base.const_defined?(:FIELDS)
-        end
-
-        def initialize(options = {})
-            @client = options if options.instance_of?(Client)
-            return unless options.kind_of?(Hash)
-
-            options.each do |k, v|
-                instance_variable_set("@#{k}", v)
-            end
-
-            post_initialize
-        end
-
-        # default post_initialize methods.
-        # Other classes that implement the Entity Class may override this.
-        def post_initialize
-
-        end
-
-        # Iterates the fields of a Entity Class Type.
-        # The fields are turned into instance variables.
-        # Fields could include id, StartDateTime, Title, etc.
-        def build(entity)
-            self.class.const_get(:FIELDS).each do |field|
-                instance_variable_set("@#{field}".underscore, field_set(entity, field))
-            end
-        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
-            @client.soap_client.call(:update, message: "<Entity xsi:type=\"#{self.class.to_s.demodulize}\">#{fields_to_xml}</Entity>")
-        end
-
-        # creates an entity in AutoTask.
-        def create
-            result = @client.soap_client.call(:create, message: "<Entity xsi:type=\"#{self.class.to_s.demodulize}\">#{fields_to_xml}</Entity>")
-            CreateResponse.new(@client, result)
-        end
-
-        # converts the AutoTask dateTime string value to a ActiveSupport::TimeWithZone object.
-        # All dateTimes in AutoTask are in the Eastern Timezone.
-        def to_date_time(arg)
-            Time.find_zone!('Eastern Time (US & Canada)').parse(arg)
-        end
-
-        # Converts the specified field in the AutoTask XML response to the entity object field/attribute.
-        # @param
-        # - entity
-        # - field
-        def field_set(entity, field)
-            node = entity.xpath("Autotask:#{field}", Autotask: AutotaskRuby.configuration.namespace)
-
-            # entity may not contain all fields that are possible.
-            # Example: The entity may not have a contact specified.
-            return if node.blank?
-
-            return node.text.to_i if node.attr('type').blank? || node.attr('type').text.eql?('xsd:int')
-            return to_date_time(node.text) if node.attr('type').text.eql?('xsd:dateTime')
-            return node.text.to_f if node.attr('type').text.eql?('xsd:double')
-            return node.text.to_f if node.attr('type').text.eql?('xsd:decimal')
-
-            node.text
-        end
-
-        def to_bool(arg)
-            return true if arg == true || arg =~ (/(true|t|yes|y|1)$/i)
-            return false if arg == false || arg.empty? || arg =~ (/(false|f|no|n|0)$/i)
-            raise ArgumentError.new("invalid value for Boolean: \"#{arg}\"")
-        end
-
-        # converts the entity attributes to XML representation.
-        # This is used when sending the object to the AutoTask API.
-        def fields_to_xml
-            str = ++''
-
-            self.class.const_get(:FIELDS).each do |field|
-                obj = instance_variable_get("@#{field}".underscore)
-                next unless obj
-
-                str << format_field_to_xml(field, obj)
-            end
-            str
-        end
-
-        # Returns the specified field as an XML element for the XML Body.
-        # I.E. <id>xxx</id>
-        # @param field_name
-        #   the field name
-        # @param field_value
-        #   the field value.
-        def format_field_to_xml(field_name, field_value)
-            return "<#{field_name}>#{field_value.strftime(AUTOTASK_TIME_FORMAT)}</#{field_name}>" if field_value.instance_of?(ActiveSupport::TimeWithZone)
-
-            "<#{field_name}>#{field_value}</#{field_name}>"
-        end
+  # The base type for all objects represented by AutotaskRuby.
+  # This module should extend any object type being used with AutoTask.
+  module Entity
+    include AutotaskRuby::Constants
+    include AutotaskRuby::Association
+
+    FIELDS = %i[id].freeze
+
+    def self.included(base)
+      base.const_set :FIELDS, Entity::FIELDS unless base.const_defined?(:FIELDS)
+    end
+
+    def initialize(options = {})
+      @client = options if options.instance_of?(Client)
+      return unless options.is_a?(Hash)
+
+      options.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+
+      post_initialize
+    end
+
+    # default post_initialize methods.
+    # Other classes that implement the Entity Class may override this.
+    def post_initialize; end
+
+    # Iterates the fields of a Entity Class Type.
+    # The fields are turned into instance variables.
+    # Fields could include id, StartDateTime, Title, etc.
+    def build(entity)
+      self.class.const_get(:FIELDS).each do |field|
+        instance_variable_set("@#{field}".underscore, field_set(entity, field))
+      end
+    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
+      @client.soap_client.call(:update, message: "<Entity xsi:type=\"#{self.class.to_s.demodulize}\">#{fields_to_xml}</Entity>")
+    end
+
+    # creates an entity in AutoTask.
+    def create
+      result = @client.soap_client.call(:create, message: "<Entity xsi:type=\"#{self.class.to_s.demodulize}\">#{fields_to_xml}</Entity>")
+      CreateResponse.new(@client, result)
+    end
+
+    # converts the AutoTask dateTime string value to a ActiveSupport::TimeWithZone object.
+    # All dateTimes in AutoTask are in the Eastern Timezone.
+    def to_date_time(arg)
+      Time.find_zone!('Eastern Time (US & Canada)').parse(arg)
+    end
+
+    # Converts the specified field in the AutoTask XML response to the entity object field/attribute.
+    # @param
+    # - entity
+    # - field
+    def field_set(entity, field)
+      node = entity.xpath("Autotask:#{field}", Autotask: AutotaskRuby.configuration.namespace)
+
+      # entity may not contain all fields that are possible.
+      # Example: The entity may not have a contact specified.
+      return if node.blank?
+
+      return node.text.to_i if node.attr('type').blank? || node.attr('type').text.eql?('xsd:int')
+      return to_date_time(node.text) if node.attr('type').text.eql?('xsd:dateTime')
+      return node.text.to_f if node.attr('type').text.eql?('xsd:double')
+      return node.text.to_f if node.attr('type').text.eql?('xsd:decimal')
+
+      node.text
+    end
+
+    def to_bool(arg)
+      return true if arg == true || arg =~ /(true|t|yes|y|1)$/i
+      return false if arg == false || arg.empty? || arg =~ /(false|f|no|n|0)$/i
+
+      raise ArgumentError, "invalid value for Boolean: \"#{arg}\""
+    end
+
+    # converts the entity attributes to XML representation.
+    # This is used when sending the object to the AutoTask API.
+    def fields_to_xml
+      str = ++''
+
+      self.class.const_get(:FIELDS).each do |field|
+        obj = instance_variable_get("@#{field}".underscore)
+        next unless obj
+
+        str << format_field_to_xml(field, obj)
+      end
+      str
+    end
+
+    # Returns the specified field as an XML element for the XML Body.
+    # I.E. <id>xxx</id>
+    # @param field_name
+    #   the field name
+    # @param field_value
+    #   the field value.
+    def format_field_to_xml(field_name, field_value)
+      return "<#{field_name}>#{field_value.strftime(AUTOTASK_TIME_FORMAT)}</#{field_name}>" if field_value.instance_of?(ActiveSupport::TimeWithZone)
+
+      "<#{field_name}>#{field_value}</#{field_name}>"
     end
+  end
 end

data/lib/autotask_ruby/fields.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
-    # Converts Autotask Entity Fields into methods.
-    module Fields
-        def field(method_name)
-            inst_variable_name = "@#{method_name}".to_sym
-            define_method method_name do
-                instance_variable_get inst_variable_name
-            end
-            define_method "#{method_name}=" do |new_value|
-                instance_variable_set inst_variable_name, new_value
-            end
-        end
+  # Converts Autotask Entity Fields into methods.
+  module Fields
+    def field(method_name)
+      inst_variable_name = "@#{method_name}".to_sym
+      define_method method_name do
+        instance_variable_get inst_variable_name
+      end
+      define_method "#{method_name}=" do |new_value|
+        instance_variable_set inst_variable_name, new_value
+      end
     end
+  end
 end

data/lib/autotask_ruby/project.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
+  # Represents the Autotask Entity Project
+  class Project
+    include Entity
 
-    # Represents the Autotask Entity Project
-    class Project
-        include Entity
-
-        FIELDS = %i[id ProjectName AccountID Type ProjectNumber Description CreateDateTime StartDateTime
-        EndDateTime Duration EstimatedTime Status ProjectLeadResourceID StatusDetail StatusDateTime].freeze
-        .each do |field|
-            self.attr_accessor :"#{field.to_s.underscore}"
-        end
+    FIELDS = %i[id ProjectName AccountID Type ProjectNumber Description CreateDateTime StartDateTime
+                EndDateTime Duration EstimatedTime Status ProjectLeadResourceID StatusDetail StatusDateTime].freeze
+             .each do |field|
+      attr_accessor :"#{field.to_s.underscore}"
+    end
 
-        def post_initialize
-            has_many :tasks
-            belongs_to :account
-        end
+    def post_initialize
+      has_many :tasks
+      belongs_to :account
     end
+  end
 end

data/lib/autotask_ruby/query.rb

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
-    module Query
-        def query(entity_type, field = 'id', op = 'equals', value)
-            result = @client.soap_client.call(:query, message: "<sXML><![CDATA[<queryxml><entity>#{entity_type}</entity><query><field>#{field}<expression op=\"#{op}\">#{value}</expression></field></query></queryxml>]]></sXML>")
-            AutotaskRuby::QueryResponse.new(@client, result)
-        end
+  module Query
+    def query(entity_type, field = 'id', op = 'equals', value)
+      result = @client.soap_client.call(:query, message: "<sXML><![CDATA[<queryxml><entity>#{entity_type}</entity><query><field>#{field}<expression op=\"#{op}\">#{value}</expression></field></query></queryxml>]]></sXML>")
+      AutotaskRuby::QueryResponse.new(@client, result)
+    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, field = 'id', id)
-            response = query(entity, field, id)
-            return nil if response.entities.empty?
+    # @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, field = 'id', id)
+      response = query(entity, field, id)
+      return nil if response.entities.empty?
 
-            response.entities.first
-        end
+      response.entities.first
     end
+  end
 end

data/lib/autotask_ruby/query_response.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module AutotaskRuby
-    class QueryResponse
-        include Constants
-        include Response
-    end
+  class QueryResponse
+    include Constants
+    include Response
+  end
 end