supportpal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9904edb7c7891fe8166aaa215af16c51e29101f9
+  data.tar.gz: 26ae545b047d0b35f912e71bf205865466c3c94b
+SHA512:
+  metadata.gz: 29d7917c10182eca350ab4a2467eaefd6a563decc96aac49441f1798cacd9411f8453aa41644ef69c9e6eb96f4e590c15a2594dfd7f735073ef71bdeec3edd58
+  data.tar.gz: c1fb941b967e3a7c7a96eff06aa3334ec9fe504f06810c9908adc17e820f4a96fd8bcd4139271f836f95f478341d6df94ababf92bf8ddf4fd806bbd9be670d42

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+/tests/
+*.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in supportpal-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andrew White
+
+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,71 @@
+# supportpal-ruby
+
+This gem provides direct calls to the SupportPal REST APIs.
+
+Current functions:
+
+* Open a new ticket
+* Add a note to a ticket (by ID)
+* Close a ticket (by ID)
+
+Other features may be added later as needed by me, however pull requests are always welcomne.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'supportpal-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install supportpal-ruby
+
+## Usage
+
+Basic example:
+
+```ruby
+require 'supportpal'
+
+cwd = File.expand_path('../', __FILE__)
+
+supportpal = SupportPal::Session.new({
+  'base_uri'      => 'https://supportpal.local',
+  'config'        => "#{cwd}/config.yml"
+})
+puts "Loaded SupportPal API version #{SupportPal::VERSION}"
+
+ticket = supportpal.open_new_ticket(
+  "Ticket subject",
+  "This is a <strong>Ticket message!</strong>"
+)
+
+if ticket[:status] == 'success' then
+    note = supportpal.add_ticket_note(ticket[:ticket_id], 'This is a test note')
+    supportpal.close_ticket_by_id(ticket[:ticket_id])
+else
+    puts "Error opening new ticket - #{ticket[:message]}"
+end
+```
+
+```yaml
+ticket_user_id: 5
+ticket_department_id: 3
+auth_token: 2YpXPZ9BDYo6S9Unp5uQ4FH4q
+```
+
+`config` can be passed as path to yaml file, hash, or left blank for default options to be used.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WhiteyDude/supportpal-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "supportpal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/supportpal.rb

@@ -0,0 +1,118 @@
+require "supportpal/version"
+require 'supportpal/config'
+require "httparty"
+require 'yaml'
+
+module SupportPal
+  # Errors
+  class Error < StandardError; end
+
+  class Session
+    include HTTParty
+    # Uncomment to debug output
+    #debug_output $stdout
+
+    def initialize(options)
+      # Make a class variable
+      @options = options
+
+      # Load config
+      if @options['config'] then # Can be hash with values, or path to yaml
+        config = SupportPal::Configure.new(@options['config'])
+      else
+        config = SupportPal::Configure.new
+      end
+      @config = config.config
+        
+      # Check to ensure required options exist
+      raise Error, 'You must provide a base_uri option!' if ! @options['base_uri']
+      self.class.base_uri @options['base_uri']
+
+      raise Error, 'You must provide an auth token in config!' if ! @config[:auth_token]
+
+      # Default headers
+      @auth = { username: @config[:auth_token], password: 'X' }
+      @http_options = { basic_auth: @auth }
+    end
+
+    def test
+      puts "Base URI is #{self.class.base_uri}"
+      res = self.class.get('/api/selfservice/type', @http_options)
+    end
+
+    def open_new_ticket(subject, message, options = {})
+      params = {}
+      params['subject']           = subject
+      params['text']              = message
+
+      params['user']              = @config[:ticket_user_id]
+      params['user']              = options['operator_id'] if options['operator_id']
+      params['user']              = options['user_id'] if options['user_id']
+
+      params['department']        = (options['department']) ? options['department'] : @config[:ticket_department_id]
+      params['status']            = (options['status']) ? options['status'] : @config[:ticket_status]
+      params['priority']          = (options['priority']) ? options['priority'] : @config[:ticket_priority]
+
+      @http_options.merge!({ body: params })
+      res = self.class.post('/api/ticket/ticket', @http_options)
+      response = res.parsed_response
+      if response['status'] == 'success' then
+        return {
+          :status         => 'success',
+          :ticket_id      => response['data']['id']
+        }
+      else
+        return {
+          :status           => 'failure',
+          :message          => response['message']
+        }
+      end
+    end
+
+    def add_ticket_note(ticket_id, message, options = {})
+      params = {}
+      params['text']              = message
+
+      params['user_id']              = @config[:ticket_user_id]
+      params['user_id']              = options['operator_id'] if options['operator_id']
+      params['user_id']              = options['user_id'] if options['user_id']
+
+      params['ticket_id']         = ticket_id
+      params['message_type']      = 1 # 1 = note, 0 = reply
+
+      @http_options.merge!({ body: params })
+      res = self.class.post("/api/ticket/message", @http_options)
+      response = res.parsed_response
+      if response['status'] == 'success' then
+        return {
+          :status         => 'success',
+          :message        => response['message']
+        }
+      else
+        return {
+          :status           => 'failure',
+          :message          => response['message']
+        }
+      end
+    end
+
+    def close_ticket_by_id(ticket_id)
+      # Check if ticket_id is an integer
+      @http_options.merge!({ body: { status: 2 } })
+      res = self.class.put("/api/ticket/ticket/#{ticket_id}", @http_options)
+      response = res.parsed_response
+      if response['status'] == 'success' then
+        return {
+          :status         => 'success',
+          :message        => response['message']
+        }
+      else
+        return {
+          :status           => 'failure',
+          :message          => response['message']
+        }
+      end
+    end
+
+  end
+end

data/lib/supportpal/config.rb

@@ -0,0 +1,44 @@
+module SupportPal
+  class Configure
+    # Concept from https://stackoverflow.com/a/10112179
+
+    def default_config
+      @config = {
+        :ticket_status        => 1, # Open
+        :ticket_priority      => 1, # Low
+        :ticket_user_id       => nil, # Operator or user
+        :ticket_department_id => nil,
+        :auth_token           => nil, # SupportPal token
+      }
+    end  
+
+    def configure(opts = {})
+      opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+    end
+
+    def configure_with(path_to_yaml_file)
+      begin
+        config = YAML::load(IO.read(path_to_yaml_file))
+      rescue Errno::ENOENT
+        puts "YAML configuration file couldn't be found. Using defaults."; return
+      rescue Psych::SyntaxError
+        puts "YAML configuration file contains invalid syntax. Using defaults."; return
+      end
+      configure(config)
+    end
+
+    def config
+      @config
+    end
+
+    def initialize(config = nil)
+      default_config
+      @valid_config_keys = @config.keys
+      if config.class == Hash then
+        configure(config)
+      elsif config.class == String then
+        configure_with(config)
+      end
+    end
+  end
+end

data/lib/supportpal/version.rb

@@ -0,0 +1,3 @@
+module SupportPal
+  VERSION = "0.1.0"
+end

data/supportpal.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "supportpal/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "supportpal"
+  spec.version       = SupportPal::VERSION
+  spec.authors       = ["Andrew White"]
+  spec.email         = ["github@and.rew.ninja"]
+
+  spec.summary       = %q{Provides ruby functions to natively call SupportPal APIs directly without adding cURL or HTTP call gems to your code}
+  spec.description   = %q{Native SupportPal API calls}
+  spec.homepage      = "https://github.com/WhiteyDude/supportpal"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/WhiteyDude/supportpal"
+    spec.metadata["changelog_uri"] = "https://github.com/WhiteyDude/supportpal"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "dotenv", "~> 2.7"
+
+  # Runtime dependancies
+  spec.add_runtime_dependency "httparty", "~> 0.17.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: supportpal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew White
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: Native SupportPal API calls
+email:
+- github@and.rew.ninja
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/supportpal.rb
+- lib/supportpal/config.rb
+- lib/supportpal/version.rb
+- supportpal.gemspec
+homepage: https://github.com/WhiteyDude/supportpal
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/WhiteyDude/supportpal
+  source_code_uri: https://github.com/WhiteyDude/supportpal
+  changelog_uri: https://github.com/WhiteyDude/supportpal
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Provides ruby functions to natively call SupportPal APIs directly without
+  adding cURL or HTTP call gems to your code
+test_files: []