autotask_ruby 0.1.0

data/lib/autotask_ruby/fields.rb

@@ -0,0 +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
+    end
+end

data/lib/autotask_ruby/project.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module AutotaskRuby
+
+    # 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
+
+        def post_initialize
+            has_many :tasks
+            belongs_to :account
+        end
+    end
+end

data/lib/autotask_ruby/query.rb

@@ -0,0 +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
+
+        # @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
+    end
+end

data/lib/autotask_ruby/query_response.rb

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

data/lib/autotask_ruby/resource.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module AutotaskRuby
+    # Represents the Autotask Entity Resource
+    class Resource
+        include AutotaskRuby::Entity
+        include AutotaskRuby::Query
+
+        FIELDS = %i[id Email Email2 Email3 FirstName HomePhone Initials LastName LocationID MiddleName
+                    MobilePhone OfficeExtension OfficePhone ResourceType Title UserName UserType Active].freeze
+        .each do |field|
+            self.attr_accessor :"#{field.to_s.underscore}"
+        end
+
+        def post_initialize
+            has_many :account_to_dos, foreign_key: 'AssignedToResourceID'
+            has_many :appointments, foreign_key: 'ResourceID'
+            has_many :tickets, foreign_key: 'AssignedResourceID'
+            has_many :tasks, foreign_key: 'AssignedResourceID'
+        end
+    end
+end

data/lib/autotask_ruby/response.rb

@@ -0,0 +1,28 @@
+module AutotaskRuby
+    module Response
+        include Constants
+        attr_accessor :entity_type, :errors, :return_code, :entities
+
+        def initialize(client, response)
+            @client = client
+            @entities = []
+            @errors = response.xpath('//Autotask:Errors', Autotask: AutotaskRuby.configuration.namespace).text
+            @return_code = response.xpath('//Autotask:ReturnCode', Autotask: AutotaskRuby.configuration.namespace).text.to_i
+            @entity_type = response.xpath('//Autotask:EntityResultType', Autotask: AutotaskRuby.configuration.namespace).text.classify
+            parse_entities(response.xpath('//Autotask:Entity', Autotask: AutotaskRuby.configuration.namespace))
+        end
+
+        private
+
+        def parse_entities(results)
+            return [] if results.blank?
+
+            klass = ('AutotaskRuby::' + results.first.attribute('type').to_s).constantize
+            results.collect do |entity|
+                obj = klass.new(client: @client)
+                obj.build(entity)
+                @entities.push(obj)
+            end
+        end
+    end
+end

data/lib/autotask_ruby/service_call.rb

@@ -0,0 +1,24 @@
+module AutotaskRuby
+    # Represents the Autotask Entity ServiceCall
+    class ServiceCall
+        include Entity
+        include Query
+
+        FIELDS = %i[id AccountID StartDateTime EndDateTime Description Complete CreateDateTime LastModifiedDateTime Duration Status].freeze
+        .each do |field|
+            self.attr_accessor :"#{field.to_s.underscore}"
+        end
+
+        # Returns the associated ResourceID.
+        def resource_id
+            service_call_ticket = find('ServiceCallTicket', 'ServiceCallId', self.id)
+            service_call_ticket_resource = find('ServiceCallTicketResource', 'ServiceCallTicketId', service_call_ticket.id)
+            service_call_ticket_resource.resource_id
+        end
+
+        # Returns the associated Resource
+        def resource
+            find('Resource', resource_id)
+        end
+    end
+end

data/lib/autotask_ruby/service_call_ticket.rb

@@ -0,0 +1,11 @@
+module AutotaskRuby
+    # Represents the Autotask Entity ServiceCallTicket
+    class ServiceCallTicket
+        include Entity
+
+        FIELDS = %i[id ServiceCallID TicketID].freeze
+        .each do |field|
+            self.attr_accessor :"#{field.to_s.underscore}"
+        end
+    end
+end

data/lib/autotask_ruby/service_call_ticket_resource.rb

@@ -0,0 +1,11 @@
+module AutotaskRuby
+    # Represents the Autotask Entity ServiceCallTicketResource
+    class ServiceCallTicketResource
+        include Entity
+
+        FIELDS = %i[id ServiceCallTicketID ResourceID].freeze
+        .each do |field|
+            self.attr_accessor :"#{field.to_s.underscore}"
+        end
+    end
+end

data/lib/autotask_ruby/task.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AutotaskRuby
+    # Represents the Autotask Entity Task
+    class Task
+        include Entity
+
+        FIELDS = %i[id AllocationCodeID AssignedResourceID CreateDateTime DepartmentID Description EstimatedHours
+        LastActivityDateTime ProjectID Status TaskNumber TaskType Title ].freeze
+        .each do |field|
+            self.attr_accessor :"#{field.to_s.underscore}"
+        end
+
+        def post_initialize
+            belongs_to :resource
+            belongs_to :project
+        end
+    end
+end

data/lib/autotask_ruby/ticket.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module AutotaskRuby
+    # Represents the Autotask Entity Ticket
+    class Ticket
+        include Entity
+
+        FIELDS = %i[id AccountID ContactID CreateDate Description DueDateTime LastActivityDate AssignedResourceID Status TicketNumber Title].freeze
+        .each do |field|
+            self.attr_accessor :"#{field.to_s.underscore}"
+        end
+
+        def post_initialize
+            belongs_to :account
+            belongs_to :contact
+        end
+    end
+end

data/lib/autotask_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AutotaskRuby
+    VERSION = '0.1.0'
+end

data/lib/autotask_ruby/zone_info.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module AutotaskRuby
+    class ZoneInfo
+        attr_reader :raw_result
+
+        ENDPOINT = 'https://webservices.autotask.net/ATServices/1.5/atws.asmx'
+
+        def initialize(username)
+            @client = Savon.client(wsdl: './atws.wsdl', endpoint: ENDPOINT)
+            @raw_result = @client.call(:get_zone_info, message: { 'UserName' => username })
+            @zone_info = @raw_result.body[:get_zone_info_response][:get_zone_info_result]
+        end
+
+        def error_code
+            @zone_info[:error_code].to_i
+        end
+
+        def web_url
+            @zone_info[:web_url]
+        end
+
+        def url
+            @zone_info[:url]
+        end
+
+        def method_missing(method, *_args)
+            @zone_info[method]
+        end
+    end
+end

metadata

@@ -0,0 +1,273 @@
+--- !ruby/object:Gem::Specification
+name: autotask_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jared L Jennings
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: A ruby client for the Autotask API. The client tries to use a full-featured
+  approach.
+email:
+- jared@jaredjennings.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- atws-1_6.wsdl
+- atws.wsdl
+- autotask_ruby.gemspec
+- bin/console
+- bin/setup
+- lib/autotask_ruby.rb
+- lib/autotask_ruby/account.rb
+- lib/autotask_ruby/account_to_do.rb
+- lib/autotask_ruby/action_type.rb
+- lib/autotask_ruby/appointment.rb
+- lib/autotask_ruby/association.rb
+- lib/autotask_ruby/client.rb
+- lib/autotask_ruby/configuration.rb
+- lib/autotask_ruby/constants.rb
+- lib/autotask_ruby/contact.rb
+- lib/autotask_ruby/create_response.rb
+- lib/autotask_ruby/delete_response.rb
+- lib/autotask_ruby/entity.rb
+- lib/autotask_ruby/fields.rb
+- lib/autotask_ruby/project.rb
+- lib/autotask_ruby/query.rb
+- lib/autotask_ruby/query_response.rb
+- lib/autotask_ruby/resource.rb
+- lib/autotask_ruby/response.rb
+- lib/autotask_ruby/service_call.rb
+- lib/autotask_ruby/service_call_ticket.rb
+- lib/autotask_ruby/service_call_ticket_resource.rb
+- lib/autotask_ruby/task.rb
+- lib/autotask_ruby/ticket.rb
+- lib/autotask_ruby/version.rb
+- lib/autotask_ruby/zone_info.rb
+homepage: https://github.com/trepidity/autotask_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/trepidity/autotask_ruby
+  source_code_uri: https://github.com/trepidity/autotask_ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: A ruby client for the Autotask API
+test_files: []