autotask_api 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6021a61922f1e9db170a6d2bddc4f3b12b2ec204e38e6a34441aee39fa1c0482
+  data.tar.gz: 641aa14f45bd254a197b7b111c8aa9d81e6bbf0b6a79abf6ae98221a82724b12
+SHA512:
+  metadata.gz: 407cff3284b60e5ddd0d4bc95f16b8d6dec3ec0853c5bfca8191d8b05d39e3555f8ee0579673ae6a72445e71ac94fd9d1707633274b59add8f42fe5bcff45bae
+  data.tar.gz: 36eb930031433176d1a5374cc05774dc882ebdd66f4763cd2e3b61821a1189275b321cfc1968380e9df77946d6af3060a0e3efa15468965d07a227df7d81f61a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Kevin Pheasey
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,182 @@
+# AutotaskApi
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'autotask_api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install autotask_api
+```
+
+## Query
+
+### Simple field test
+
+SQL:
+```sql
+firstname = 'Joe'
+```
+
+Objects:
+```ruby
+e1 = AutotaskApi::Expression.new('firstname', 'equals', 'Joe')
+c = AutotaskApi::Condition.new(e1)
+
+AutotaskApi::Contact.where(c)
+```
+
+Hash:
+```ruby
+AutotaskApi::Condition.from_hash(
+    expressions: [
+        { field: 'firstname', operator: 'equals', value: 'Joe' }
+    ]
+)
+```
+
+### Multiple Field Test
+
+SQL:
+```sql
+firstname = ‘Joe’ AND lastname = ‘Smith’
+```
+
+Objects:
+```ruby
+e1 = AutotaskApi::Expression.new('firstname', 'equals', 'Joe')
+e2 = AutotaskApi::Expression.new('lastname', 'equals', 'Smith')
+c = AutotaskApi::Condition.new([e1, e2])
+
+AutotaskApi::Contact.where(c)
+```
+
+Hash:
+```ruby
+c = AutotaskApi::Condition.from_hash(
+    expressions: [
+      { field: 'firstname', operator: 'equals', value: 'Joe' },
+      { field: 'lastname', operator: 'equals', value: 'Smith' }
+    ]
+)
+
+AutotaskApi::Contact.where(c)
+```
+
+### Multiple Fields combined with OR
+
+SQL:
+```sql
+firstname = ‘Joe’ OR lastname = ‘Brown’
+```
+
+Objects:
+```ruby
+e1 = AutotaskApi::Expression.new('firstname', 'equals', 'Joe')
+e2 = AutotaskApi::Expression.new('lastname', 'equals', 'Brown')
+c = AutotaskApi::Condition.new([e1, e2], 'OR')
+
+AutotaskApi::Contact.where(c)
+```
+
+Hash:
+```ruby
+c = AutotaskApi::Condition.from_hash(
+    expressions: [
+        { field: 'firstname', operator: 'equals', value: 'Joe' },
+        { field: 'lastname', operator: 'equals', value: 'Brown' }
+    ],
+    operator: 'OR'
+)
+
+AutotaskApi::Contact.where(c)
+```
+
+### Nested Conditions
+
+SQL:
+```sql
+(
+  firstname = ‘Joe’
+  OR
+  (
+    (firstname = ‘Larry’ and lastname = ‘Brown’)
+    OR
+    (firstname = ‘Mary’ and lastname = ‘Smith’)
+  )
+)
+# AND city != 'Albany'
+```
+
+Objects:
+```ruby
+e1 = AutotaskApi::Expression.new('firstname', 'equals', 'Larry')
+e2 = AutotaskApi::Expression.new('lastname', 'equals', 'Brown')
+c1 = AutotaskApi::Condition.new([e1, e2])
+
+e3 = AutotaskApi::Expression.new('firstname', 'equals', 'Mary')
+e4 = AutotaskApi::Expression.new('lastname', 'equals', 'Smith')
+c2 = AutotaskApi::Condition.new([e3, e4])
+
+c3 = AutotaskApi::Condition.new([c1, c2], 'OR')
+
+e5 = AutotaskApi::Expression.new('firstname', 'equals', 'Joe')
+c4 = AutotaskApi::Condition.new([e5, c3], 'OR')
+
+e6 = AutotaskApi::Expression.new('city', 'notequal', 'Albany')
+c5 = AutotaskApi::Condition.new([c4, e6])
+
+AutotaskApi::Query.new('contact', c5).fetch
+```
+
+Hash:
+```
+c = AutotaskApi::Condition.from_hash(
+    expressions: [
+        {
+            expressions: [
+                { field: 'firstname', operator: 'equals', value: 'Joe' },
+                {
+                    expressions: [
+                        {
+                            expressions: [
+                                { field: 'firstname', operator: 'equals', value: 'Larry' },
+                                { field: 'lastname', operator: 'equals', value: 'Brown' }
+                            ]
+                        },
+                        {
+                            expressions: [
+                                { field: 'firstname', operator: 'equals', value: 'Marry' },
+                                { field: 'lastname', operator: 'equals', value: 'Smith' }
+                            ]
+                        }
+                    ],
+                    operator: 'OR'
+                }
+            ],
+            operator: 'OR'
+        },
+        { field: 'city', operator: 'notequal', value: 'Albany' }
+    ]
+)
+
+AutotaskApi::Contact.where(c)
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AutotaskApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/autotask_api.rb

@@ -0,0 +1,22 @@
+require 'nokogiri'
+require 'savon'
+
+require 'autotask_api/version'
+require 'autotask_api/config'
+require 'autotask_api/client'
+require 'autotask_api/query'
+require 'autotask_api/entity'
+require 'autotask_api/entity_collection'
+
+module AutotaskApi
+  class Error < StandardError
+    def initialize(msg)
+      # extract SOAP Exception message if present
+      if msg.include?('[SoapException:')
+        msg = msg[/\[SoapException:(.*?)\]/, 1]&.strip
+      end
+
+      super(msg)
+    end
+  end
+end

data/lib/autotask_api/client.rb

@@ -0,0 +1,37 @@
+module AutotaskApi
+
+  class << self
+    attr_accessor :client
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+
+  class Client
+
+    NAMESPACE = 'http://autotask.net/ATWS/v1_5/'
+
+    attr_reader :config
+
+    def initialize
+      @config = AutotaskApi.config
+      yield @config if block_given?
+    end
+
+    def savon_client
+      @savon_client ||= Savon.client(
+          wsdl: config.wsdl,
+          logger: Rails.logger,
+          log_level: :debug,
+          log: config.debug,
+          basic_auth: [config.username, config.password]
+      )
+    end
+
+    def call(operation, message = {})
+      savon_client.call(operation, message: message, attributes: { xmlns: NAMESPACE })
+    end
+
+  end
+end

data/lib/autotask_api/config.rb

@@ -0,0 +1,37 @@
+module AutotaskApi
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :wsdl, :username, :password, :read_timeout, :open_timeout, :debug
+
+    def initialize
+      @wsdl = 'https://webservices.autotask.net/atservices/1.5/atws.wsdl'
+      @read_timeout = 30
+      @open_timeout = 30
+      @debug = false
+    end
+
+    def set(options = {})
+      options.each { |k, v| self.send("#{k.to_s}=", v) }
+    end
+
+    def to_hash
+      hash = {}
+      instance_variables.each { |var| hash[var.to_s.delete('@').to_sym] = instance_variable_get(var) }
+      hash
+    end
+
+  end
+
+end

data/lib/autotask_api/entity.rb

@@ -0,0 +1,322 @@
+module AutotaskApi
+  class Entity
+
+    def self.all(client = AutotaskApi.client, id = 1)
+      where(Condition.new(Expression.new('id', 'GreaterThanorEquals', id)), client)
+    end
+
+    # @param conditions [Hash]
+    def self.where(condition, client = AutotaskApi.client)
+      query = Query.new(self::NAME, condition, client)
+
+      begin
+        response = query.fetch
+      rescue RuntimeError => e
+        raise Error.new(e.message)
+      end
+
+      # return empty collection if there were no results
+      return EntityCollection.new(self, [], condition, client) if response[:entity_results].nil?
+
+      results = response[:entity_results][:entity]
+      results = [results] unless results.is_a?(Array)
+      results = clean_results(results)
+
+      EntityCollection.new(self, results, condition, client)
+    end
+
+    def self.expression(value)
+      case value.class
+      when TrueClass
+        1
+      when FalseClass
+        0
+      else
+        value
+      end
+    end
+
+    # @param results [Array(Hash)]
+    def self.clean_results(results)
+      results.each do |record|
+        record.update(record) { |_k, v| v == { :"@xsi:type" => "xsd:string" } ? nil : v }
+          .delete('@xsi:type'.to_sym)
+      end
+
+      return results
+    end
+
+  end
+
+  class Account < Entity
+    NAME = 'Account'
+  end
+
+  class AccountLocation < Entity
+    NAME = 'AccountLocation'
+  end
+
+  class AccountTeam < Entity
+    NAME = 'AccountTeam'
+  end
+
+  class AllocationCode < Entity
+    NAME = 'AllocationCode'
+  end
+
+  class BillingItem < Entity
+    NAME = 'BillingItem'
+  end
+
+  class Contact < Entity
+    NAME = 'Contact'
+  end
+
+  class Contract < Entity
+    NAME = 'Contract'
+  end
+
+  class ContractBlock < Entity
+    NAME = 'ContractBlock'
+  end
+
+  class ContractCost < Entity
+    NAME = 'ContractCost'
+  end
+
+  class ContractExclusionAllocationCode < Entity
+    NAME = 'ContractExclusionAllocationCode'
+  end
+
+  class ContractExclusionRole < Entity
+    NAME = 'ContractExclusionRole'
+  end
+
+  class ContractFactor < Entity
+    NAME = 'ContractFactor'
+  end
+
+  class ContractMilestone < Entity
+    NAME = 'ContractMilestone'
+  end
+
+  class ContractRate < Entity
+    NAME = 'ContractRate'
+  end
+
+  class ContractRetainer < Entity
+    NAME = 'ContractRetainer'
+  end
+
+  class ContractRoleCost < Entity
+    NAME = 'ContractRoleCost'
+  end
+
+  class ContractService < Entity
+    NAME = 'ContractService'
+  end
+
+  class ContractServiceAdjustment < Entity
+    NAME = 'ContractServiceAdjustment'
+  end
+
+  class ContractServiceBundle < Entity
+    NAME = 'ContractServiceBundle'
+  end
+
+  class ContractServiceBundleAdjustment < Entity
+    NAME = 'ContractServiceBundleAdjustment'
+  end
+
+  class ContractServiceBundleUnit < Entity
+    NAME = 'ContractServiceBundleUnit'
+  end
+
+  class ContractServiceUnit < Entity
+    NAME = 'ContractServiceUnit'
+  end
+
+  class ContractTicketPurchase < Entity
+    NAME = 'ContractTicketPurchase'
+  end
+
+  class Country < Entity
+    NAME = 'Country'
+  end
+
+  class Department < Entity
+    NAME = 'Department'
+  end
+
+  class ExpenseItem < Entity
+    NAME = 'ExpenseItem'
+  end
+
+  class ExpenseReport < Entity
+    NAME = 'ExpenseReport'
+  end
+
+  class InstalledProduct < Entity
+    NAME = 'InstalledProduct'
+  end
+
+  class InstalledProductType < Entity
+    NAME = 'InstalledProductType'
+  end
+
+  class InternalLocation < Entity
+    NAME = 'InternalLocation'
+  end
+
+  class InventoryItem < Entity
+    NAME = 'InventoryItem'
+  end
+
+  class InventoryLocation < Entity
+    NAME = 'InventoryLocation'
+  end
+
+  class Invoice < Entity
+    NAME = 'Invoice'
+  end
+
+  class Opportunity < Entity
+    NAME = 'Opportunity'
+  end
+
+  class PaymentTerm < Entity
+    NAME = 'PaymentTerm'
+  end
+
+  class Phase < Entity
+    NAME = 'Phase'
+  end
+
+  class Product < Entity
+    NAME = 'Product'
+  end
+
+  class Project < Entity
+    NAME = 'Project'
+  end
+
+  class ProjectCost < Entity
+    NAME = 'ProjectCost'
+  end
+
+  class ProjectNote < Entity
+    NAME = 'ProjectNote'
+  end
+
+  class PurchaseOrderItem < Entity
+    NAME = 'PurchaseOrderItem'
+  end
+
+  class Quote < Entity
+    NAME = 'Quote'
+  end
+
+  class QuoteItem < Entity
+    NAME = 'QuoteItem'
+  end
+
+  class QuoteLocation < Entity
+    NAME = 'QuoteLocation'
+  end
+
+  class Resource < Entity
+    NAME = 'Resource'
+  end
+
+  class ResourceRole < Entity
+    NAME = 'ResourceRole'
+  end
+
+  class ResourceSkill < Entity
+    NAME = 'ResourceSkill'
+  end
+
+  class Role < Entity
+    NAME = 'Role'
+  end
+
+  class SalesOrder < Entity
+    NAME = 'SalesOrder'
+  end
+
+  class Service < Entity
+    NAME = 'Service'
+  end
+
+  class ServiceBundle < Entity
+    NAME = 'ServiceBundle'
+  end
+
+  class ServiceBundleService < Entity
+    NAME = 'ServiceBundleService'
+  end
+
+  class ServiceCall < Entity
+    NAME = 'ServiceCall'
+  end
+
+  class ServiceCallTask < Entity
+    NAME = 'ServiceCallTask'
+  end
+
+  class ServiceCallTaskResource < Entity
+    NAME = 'ServiceCallTaskResource'
+  end
+
+  class ServiceCallTicket < Entity
+    NAME = 'ServiceCallTicket'
+  end
+
+  class ServiceCallTicketResource < Entity
+    NAME = 'ServiceCallTicketResource'
+  end
+
+  class Skill < Entity
+    NAME = 'Skill'
+  end
+
+  class Task < Entity
+    NAME = 'Task'
+  end
+
+  class TaskPredecessor < Entity
+    NAME = 'TaskPredecessor'
+  end
+
+  class TaskSecondaryResource < Entity
+    NAME = 'TaskSecondaryResource'
+  end
+
+  class Tax < Entity
+    NAME = 'Tax'
+  end
+
+  class TaxCategory < Entity
+    NAME = 'TaxCategory'
+  end
+
+  class TaxRegion < Entity
+    NAME = 'TaxRegion'
+  end
+
+  class Ticket < Entity
+    NAME = 'Ticket'
+  end
+
+  class TicketCost < Entity
+    NAME = 'TicketCost'
+  end
+
+  class TicketSecondaryResource < Entity
+    NAME = 'TicketSecondaryResource'
+  end
+
+  class TimeEntry < Entity
+    NAME = 'TimeEntry'
+  end
+end

data/lib/autotask_api/entity_collection.rb

@@ -0,0 +1,45 @@
+module AutotaskApi
+  class EntityCollection
+    include Enumerable
+
+    PAGE_SIZE = 500
+
+    attr_accessor :condition
+
+    attr_reader :entities, :client, :class_name
+
+    def initialize(class_name, entities, condition, client = AutotaskApi.client)
+      @class_name = class_name
+      @entities = entities
+      @condition = condition
+      @client = client
+    end
+
+    def each(&block)
+      entities.each(&block)
+    end
+
+    def last(&block)
+      entities.last(&block)
+    end
+
+    def next_page?
+      entities.size >= PAGE_SIZE
+    end
+
+    def next_page
+      new_expression = Expression.new('id', 'GreaterThan', entities.last[:id])
+
+      condition.remove_expression_by_field('id')
+      params = condition.expressions.empty? ? new_expression : [condition, new_expression]
+
+      new_condition = Condition.new(params)
+
+      class_name.where(new_condition, client)
+    end
+
+    def empty?
+      entities.empty?
+    end
+  end
+end

data/lib/autotask_api/query.rb

@@ -0,0 +1,93 @@
+module AutotaskApi
+  class Query
+    attr_accessor :entity, :client, :condition
+
+    def initialize(entity, condition = nil, client = AutotaskApi.client)
+      @entity = entity
+      @client = client
+      @condition = condition
+    end
+
+    def fetch
+      response = client.call :query, query_string
+
+      result = response.body[:query_response][:query_result]
+
+      if result[:return_code].to_i == -1
+        raise result[:errors][:atws_error][:message]
+      else
+        return result
+      end
+    end
+
+    def query_string
+      Nokogiri::XML::Builder.new do
+        sXML do
+          cdata(Nokogiri::XML::Builder.new do |xml|
+            xml.queryxml do
+              xml.entity entity
+              xml.query do
+                condition.to_xml(xml)
+              end
+            end
+          end.doc.root)
+        end
+      end.doc.root.to_s
+    end
+
+  end
+
+  class Condition
+
+    attr_reader :expressions, :operator
+
+    def initialize(expressions, operator = 'AND')
+      @expressions = expressions.is_a?(Array) ? expressions : [expressions]
+      @operator = operator
+    end
+
+    def to_xml(xml)
+      xml.condition operator: operator do
+        expressions.each { |expression| expression.to_xml(xml) }
+      end
+    end
+
+    def self.from_hash(condition = {})
+      expressions = condition[:expressions].map do |exprnewession|
+        expression.has_key?(:expressions) ? Condition.from_hash(expression) : Expression.from_hash(expression)
+      end
+
+      new expressions, condition[:operator] || 'AND'
+    end
+
+    def remove_expression_by_field(field)
+      expressions.reject! do |expression|
+        expression.is_a?(Condition) ? expression.remove_expression_by_field(field) : expression.field == field
+      end
+    end
+    
+  end
+
+  class Expression
+
+    attr_reader :field, :operator, :value
+
+    def initialize(field, operator, value)
+      @field = field
+      @operator = operator
+      @value = value
+    end
+
+    def to_xml(xml)
+      xml.field field do
+        xml.expression value, op: operator
+      end
+    end
+
+    def self.from_hash(expression = {})
+      new(expression[:field], expression[:operator], expression[:value])
+    end
+
+  end
+
+end

data/lib/autotask_api/version.rb

@@ -0,0 +1,3 @@
+module AutotaskApi
+  VERSION = '0.3.0'
+end

data/lib/tasks/autotask_api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :autotask_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: autotask_api
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Kevin Pheasey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Abstracted Autotask API 1.5 wrapper
+email:
+- kevin@kpsoftware.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/autotask_api.rb
+- lib/autotask_api/client.rb
+- lib/autotask_api/config.rb
+- lib/autotask_api/entity.rb
+- lib/autotask_api/entity_collection.rb
+- lib/autotask_api/query.rb
+- lib/autotask_api/version.rb
+- lib/tasks/autotask_api_tasks.rake
+homepage: https://github.com/MSPCFO/autotask_api
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key: 
+specification_version: 4
+summary: Autotask API wrapper
+test_files: []