hotdogprincess 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7c35fd12cdfc18cf8f3184c216dc0431aa5b129
+  data.tar.gz: 1df368952003b482dd2f857a921964c9e4728b31
+SHA512:
+  metadata.gz: 98743b6e01e4ecf64d5cdc3eec8f7df3bff6815ad9e3667a42b24b0db0e7d6756ea435ce6dcd6d1d1167f50adb9f57df02e52406b9b7b2915ef90a166ad8d27c
+  data.tar.gz: b9e01d4b3a3401a45b254f048866e5d5610212341e833859d9b3390419f262105c9384de412cc0a9d4a88b15a02557815ad020c86655f1fca79321b43797c3f9

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthew Callis
+
+MIT License
+
+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,315 @@
+# Hot Dog Princess
+
+![Hot Dog Princess](https://raw.githubusercontent.com/MatthewCallis/HotDogPrincess/master/hdp.png)
+
+_-- "Their message says, Baby... Us... Trouble... Time."_
+
+Integrate with the [Parature](http://www.parature.com/) API. It's gunna be so flippin' awesome!
+
+Currently a WIP.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hotdogprincess'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hotdogprincess
+
+## Usage
+
+### Setup
+
+You will need your host, the account ID, the department ID and your API token.
+
+### Testing
+
+You will need to make a copy of `spec/hotdogprincess.sample.yml` as `spec/hotdogprincess.yml` with your own testing credentials.
+
+### Examples
+
+You can use the client in two possible way, or more if you're really brave and creative:
+
+```ruby
+client = ::HotDogPrincess::Client.new(host: 'sandbox.parature.com', account_id: 123, department_id: 456, token: 'api_token')
+
+OR
+
+HotDogPrincess.client
+```
+
+From here you can do all sorts of wonderful things:
+
+```ruby
+# Schema, Status, View
+client.schema 'Customer'
+client.schema 'Ticket'
+client.schema 'Sla'
+=> {"?xml"=>{"@version"=>"1.0", "@encoding"=>"utf-8"}, "Customer"=> ...
+
+client.status 'Customer'
+client.status 'Ticket'
+client.status 'Sla'
+=> {"?xml"=>{"@version"=>"1.0", "@encoding"=>"utf-8"}, "entities"=> ...
+
+
+# Well that's neat, but XML? What the hell is wrong with you, is it 2001‽
+client.schema_json 'Customer'
+client.schema_json 'Ticket'
+client.schema_json 'Sla'
+=> # See below for important details about all JSON returns.
+
+client.status_json 'Customer'
+client.status_json 'Ticket'
+client.status_json 'Sla'
+=> "[{\"id\":16,\"uid\":\"123/456/Customer/status/10001\",\"href\":"...
+
+client.view 'Ticket'
+=> {"?xml"=>{"@version"=>"1.0", "@encoding"=>"utf-8"}, "Entities"=> ...
+
+client.view_json 'Ticket'
+=> "[{\"id\":7,\"uid\":\"123/456/Ticket/view/7\","...
+
+# Working with Customers / Tickets / SLAs
+# Raw XML: Page size defaults to 100 records.
+page_size = 50
+customers = client.fetch_customers(page_size)
+tickets   = client.fetch_ticket(page_size)
+slas      = client.fetch_slas(page_size)
+=> {"?xml"=>{"@version"=>"1.0", "@encoding"=>"utf-8"}, "Entities"=> {"@total"=>"12400", "@results"=>"50"...
+
+customers = client.fetch_customers
+tickets   = client.fetch_ticket
+slas      = client.fetch_slas
+=> {"?xml"=>{"@version"=>"1.0", "@encoding"=>"utf-8"}, "Entities"=> {"@total"=>"12400", "@results"=>"100"...
+
+# We have them cached, so if we need the raw XML again:
+customers = client.customers_raw
+tickets   = client.tickets_raw
+slas      = client.slas_raw
+=> {"?xml"=>{"@version"=>"1.0", "@encoding"=>"utf-8"}, "Entities"=> {"@total"=>"12400", "@results"=>"100"...
+
+# Hash: Page size defaults to 100 records, and force update defaults to false.
+customers = client.customers
+tickets   = client.tickets
+slas      = client.slas
+=> [#<Hash id="10002", uid="123/456/Customer/10002", href="https:..."] x 100 of 12400
+
+customers = client.customers(50, true)
+tickets   = client.tickets(50, true)
+slas      = client.slas(50, true)
+=> [#<Hash id="10002", uid="123/456/Customer/10002", href="https:..."] x 50 of 12401, we got a new entry since the last call!
+
+# Counts: Just for convenience.
+client.customer_count
+client.ticket_count
+client.sla_count
+=> 50
+
+# Fetch a single item by ID.
+customer = client.customer 10002
+ticket   = client.ticket 10001
+sla      = client.sla 1
+=> #<Hash id="1", uid="123/456/Sla/1", href="https://sandbox.parature.com/api/v1/123/456/Sla/1", name="System Default">
+
+# Searching: You search email with either exact match or a substring match.
+client.find_customer_by_email 'joe@exmaple.comz'
+=> [#<Hash id="26553", uid="16115/16155/Customer/26553",
+
+client.find_customer_by_email 'not_found@brandnewusers.io'
+=> []
+
+substring = true
+client.find_customer_by_email 'gmail.com', substring
+=> [#<Hash id="26553", uid="16115/16155/Customer/26553", x ~50
+
+# Creating Customers / Tickets: We are using https://github.com/savonrb/gyoku to create XML from Hashes, so see the docs for in-depth XML constructions.
+customer_hash = {
+  "Customer" => {
+    "First_Name" => 'Joe',
+    "Last_Name" => 'Blow',
+    "Email" => 'joe@example.comz',
+    "Password" => 'password',
+    "Password_Confirm" => 'password',
+    "Sla" => {
+      "Sla/" => {
+        :@id => "1"
+      }
+    }
+  }
+}
+customer = client.create_customer customer_hash
+=> #<Hash id="10003", uid="123/456/Customer/10003", ...
+
+ticket_hash = {
+  "Ticket" => {
+    "Ticket_Customer" => {
+      "Customer/" => {
+        :@id => "10003"
+      }
+    },
+    "Custom_Field" => [
+      {
+        :@id => 1,
+        :content! => "Notes: It's Godzilla, no it's Apptentive!"
+      },
+      {
+        :@id => 2,
+        :content! => "Status: Healthy"
+      },
+    ]
+  }
+}
+ticket = client.create_ticket input_xml
+=> #<Hash id="10004", uid="123/456/Ticket/10004", ...
+
+# Update Customers / Tickets: Typically this returns an ID, but we instead fetch that ID and return the entire updated entity.
+client.update_customer 10003, customer_hash
+=> #<Hash id="10003", uid="123/456/Customer/10003", ...
+
+client.update_ticket 10004, ticket_hash
+=> #<Hash id="10004", uid="123/456/Ticket/10004", ...
+
+# For more depth, have a peek at the source code.
+```
+
+#### Schema JSON Output
+
+The JSON output has tried to stay readable and match the keys from the XML. Object formats are converted to their native JSON types (Boolean, Integer, Float) when possible. This is particularly useful when you're using this in combination with native forms on a front end.
+
+```json
+{
+    "customer_role": {
+        "display_name": "Customer Role",
+        "required": false,
+        "editable": true,
+        "data_type": "entity",
+        "field_type": "entity",
+        "customerrole": {
+            "name": {
+                "display_name": "Name"
+            }
+        }
+    },
+    "date_created": {
+        "display_name": "Date Created",
+        "required": false,
+        "editable": false,
+        "field_type": "usdate",
+        "data_type": "date"
+    },
+    "date_updated": {
+        "display_name": "Date Updated",
+        "required": false,
+        "editable": false,
+        "field_type": "usdate",
+        "data_type": "date"
+    },
+    "date_visited": {
+        "display_name": "Date Visited",
+        "required": false,
+        "editable": false,
+        "field_type": "usdate",
+        "data_type": "date"
+    },
+    "email": {
+        "display_name": "Email",
+        "required": true,
+        "editable": true,
+        "field_type": "email",
+        "data_type": "string",
+        "max_length": 256
+    },
+    "first_name": {
+        "display_name": "First Name",
+        "required": true,
+        "editable": true,
+        "field_type": "text",
+        "data_type": "string",
+        "max_length": 128
+    },
+    "full_name": {
+        "display_name": "Full Name",
+        "required": false,
+        "editable": true,
+        "field_type": "text",
+        "data_type": "string",
+        "max_length": 256
+    },
+    "last_name": {
+        "display_name": "Last Name",
+        "required": true,
+        "editable": true,
+        "field_type": "text",
+        "data_type": "string",
+        "max_length": 128
+    },
+    "password": {
+        "display_name": "Password",
+        "required": true,
+        "editable": true,
+        "field_type": "password",
+        "data_type": "string",
+        "max_length": 96
+    },
+    "password_confirm": {
+        "display_name": "Password (confirm)",
+        "required": true,
+        "editable": true,
+        "field_type": "password",
+        "data_type": "string",
+        "max_length": 96
+    },
+    "sla": {
+        "display_name": "Service Level Agreement",
+        "required": true,
+        "editable": true,
+        "field_type": "dropdown",
+        "data_type": "entity",
+        "sla": {
+            "name": {
+                "display_name": "Name"
+            }
+        }
+    },
+    "status": {
+        "display_name": "Status",
+        "required": true,
+        "editable": true,
+        "data_type": "entity",
+        "field_type": "dropdown",
+        "status": {
+            "name": {
+                "display_name": "Name"
+            }
+        }
+    }
+}
+```
+
+#### Unimplemented Functionality
+
+Another useful thing about Hot Dog Princess is the GET/PUT/POST/DELETE methods are all available on the client, so any unimplemented feature could be constructed as needed, but it'd be awesome if you would just code and open a pull request.
+
+```ruby
+client.get 'Customer', "First_Name_like_" => "joe"
+=> {"?xml"=>{"@version"=>"1.0", "@encoding"=>"utf-8"}...
+```
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+![It's gunna be so flippin' awesome!](https://raw.githubusercontent.com/MatthewCallis/HotDogPrincess/master/awesome.gif)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/hotdogprincess.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hotdogprincess/version'
+
+Gem::Specification.new do |spec|
+  spec.authors = ['Matthew Callis']
+  spec.email = ['matthew.callis@gmail.com']
+
+  spec.name = 'hotdogprincess'
+  spec.description = %q{Integrate with the Parature API.}
+  spec.summary = "Integrate with the Parature API. It's gunna be so flippin' awesome!"
+  spec.homepage = 'https://github.com/MatthewCallis/hotdogprincess'
+
+  spec.files = %w(LICENSE.md README.md Rakefile hotdogprincess.gemspec)
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.licenses = ['MIT']
+
+  spec.add_development_dependency 'bundler', '~> 1.0'
+
+  spec.add_runtime_dependency 'gyoku', '~> 1'
+  spec.add_runtime_dependency 'nori', '~> 2'
+
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.2'
+  spec.required_rubygems_version = '>= 1.3.5'
+
+  spec.version = HotDogPrincess::VERSION.dup
+end

data/lib/hotdogprincess.rb

@@ -0,0 +1,25 @@
+require 'hotdogprincess/client'
+require 'hotdogprincess/core_extensions'
+
+module HotDogPrincess
+  class << self
+
+    def client(options = {})
+      @client = HotDogPrincess::Client.new(options) unless defined?(@client)
+      @client
+    end
+
+    # @private
+    def respond_to_missing?(method_name, include_private=false); client.respond_to?(method_name, include_private); end if RUBY_VERSION >= "1.9"
+    # @private
+    def respond_to?(method_name, include_private=false); client.respond_to?(method_name, include_private) || super; end if RUBY_VERSION < "1.9"
+
+  private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+  end
+end

data/lib/hotdogprincess/client.rb

@@ -0,0 +1,207 @@
+require "restclient"
+require "hotdogprincess/version"
+require "hotdogprincess/client/customers"
+require "hotdogprincess/client/tickets"
+require "hotdogprincess/client/slas"
+
+module HotDogPrincess
+
+  class Client
+
+    include HotDogPrincess::Client::Customers
+    include HotDogPrincess::Client::Tickets
+    include HotDogPrincess::Client::Slas
+
+    def initialize(options = {})
+      @host = options[:host]
+      @token = options[:token]
+      @account_id = options[:account_id]
+      @department_id = options[:department_id]
+      @output_format = :json
+    end
+
+    def get(path, options = {})
+      url = "https://#{@host}/api/v1/#{@account_id}/#{@department_id}/#{path.to_s}"
+      options = {
+        _output_: @output_format,
+        _token_: @token
+      }.merge(options)
+      @last_response = RestClient.get url, { params: options }
+      clean_response @last_response
+    end
+
+    def post(path, body, options = {})
+      url = "https://#{@host}/api/v1/#{@account_id}/#{@department_id}/#{path.to_s}?_token_=#{@token}"
+      options = {
+        content_type: :xml
+      }.merge(options)
+      @last_response = RestClient.post url, body, options
+      @last_response
+    end
+
+    def put(path, body, options = {})
+      url = "https://#{@host}/api/v1/#{@account_id}/#{@department_id}/#{path.to_s}?_token_=#{@token}&_enforceRequiredFields_=false"
+      options = {
+        content_type: :xml
+      }.merge(options)
+      @last_response = RestClient.put url, body, options
+      @last_response
+    end
+
+    def delete(path, options = {})
+      url = "https://#{@host}/api/v1/#{@account_id}/#{@department_id}/#{path.to_s}"
+      options = {
+        _output_: @output_format,
+        _token_: @token
+      }.merge(options)
+      @last_response = RestClient.delete url, { params: options }
+      @last_response
+    end
+
+    def host=(value)
+      @host = value
+    end
+
+    def host
+      @host
+    end
+
+    def token=(value)
+      @token = value
+    end
+
+    def token
+      @token
+    end
+
+    def account_id=(value)
+      @account_id = value
+    end
+
+    def account_id
+      @account_id
+    end
+
+    def department_id=(value)
+      @department_id = value
+    end
+
+    def department_id
+      @department_id
+    end
+
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    def clean_response(response)
+      return nil  unless response and response.class == String
+      return nil  unless response.length >= 3
+      # "\xEF", "\xBB", "\xBF"
+      if response[0].ord == 239 and response[1].ord == 187 and response[2].ord == 191
+        response_hash = JSON.parse response[3..-1]
+      else
+        response_hash = JSON.parse response
+      end
+      response_hash
+    end
+
+    def status(object)
+      get "#{object.to_s}/status"
+    end
+
+    def status_json(object)
+      status = status(object)
+      status_hash = schema_parse(status['entities']['Status'])
+
+      JSON.generate(status_hash)
+    end
+
+    def view(object)
+      get "#{object.to_s}/view"
+    end
+
+    def view_json(object)
+      views = view(object)
+      views_hash = schema_parse(views['Entities']['View'])
+
+      JSON.generate(views_hash)
+    end
+
+    def schema(object)
+      get "#{object.to_s}/schema"
+    end
+
+    def schema_json(object)
+      schema = schema(object)
+      schema_hash = schema_parse_hash(schema[object])
+
+      JSON.generate(schema_hash)
+    end
+
+    def schema_parse(input)
+      output = input
+      if input.class == Array
+        output = schema_parse_array(input)
+      elsif input.class == Hash
+        output = schema_parse_hash(input)
+      elsif input.class == String
+        output = schema_parse_string(input)
+      end
+      output
+    end
+
+    def schema_parse_array(input_array)
+      output = []
+      input_array.each do |item|
+        if item.class == Array
+          output.push  schema_parse_array(item)
+        elsif item.class == Hash
+          output.push  schema_parse_hash(item)
+        elsif value.class == String
+          output.push schema_parse_string(item)
+        else
+          output.push  item
+        end
+      end
+      output
+    end
+
+    def schema_parse_hash(input_hash)
+      output = {}
+      input_hash.each do |key, value|
+        if value.class == Array
+          output[key.to_s.name_to_key] = schema_parse_array(value)
+        elsif value.class == Hash
+          output[key.to_s.name_to_key] = schema_parse_hash(value)
+        elsif value.class == String
+          output[key.to_s.name_to_key] = schema_parse_string(value)
+        else
+          output[key.to_s.name_to_key] = value
+        end
+      end
+      output
+    end
+
+    def schema_parse_string(input_string)
+      case input_string
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        # Check for Integers / Floats
+        if /^-?(?:[0-9]+|[0-9]*\.[0-9]+)$/ =~ input_string
+          if input_string.to_i == input_string.to_f
+            input_string.to_i
+          else
+            input_string.to_f
+          end
+        else
+          input_string
+        end
+      end
+    end
+
+  end
+end

data/lib/hotdogprincess/client/customers.rb

@@ -0,0 +1,189 @@
+require 'gyoku'
+require 'nori'
+
+module HotDogPrincess
+  class Client
+    module Customers
+
+      @customers = nil
+      @customers_raw = nil
+
+      def fetch_customers(page_size = 100)
+        @customers_raw = get 'Customer', _pageSize_: page_size
+        @customers_raw
+      end
+
+      def customers(page_size = 100, force_update = false)
+        return @customers  if @customers and !force_update
+        fetch_customers(page_size)
+        return nil  unless @customers_raw
+        @customers ||= []
+        @customers_raw["Entities"]["Customer"].each do |customer|
+          @customers.push parse_customer customer
+        end
+        @customers
+      end
+
+      def customers_raw(page_size = 100)
+        return @customers_raw  if @customers_raw
+        fetch_customers(page_size)
+        @customers_raw
+      end
+
+      def customer_count
+        return @customers.length  if @customers
+        return @customers["Entities"].length  if @customers_raw
+        0
+      end
+
+      def customer(customer_id, history = false)
+        customer = get "Customer/#{customer_id}", _history_: history
+        parse_customer customer['Customer']
+      end
+
+      def update_customer(customer_id, customer)
+        xml = Gyoku.xml(customer)
+        customer_xml = put "Customer/#{customer_id}", xml
+
+        parser = Nori.new
+        new_customer_xml = parser.parse customer_xml
+
+        customer = get "Customer/#{new_customer_xml['Customer']['@id']}", _history_: false
+
+        parse_customer customer['Customer']
+      end
+
+      def create_customer(customer)
+        xml = Gyoku.xml(customer)
+        customer_xml = post 'Customer', xml
+
+        parser = Nori.new
+        new_customer_xml = parser.parse customer_xml
+
+        customer = get "Customer/#{new_customer_xml['Customer']['@id']}", _history_: false
+
+        parse_customer customer['Customer']
+      end
+
+      def find_customer_by_email(email, substring = false)
+        query = 'Email'
+        query << '_like_'  if substring
+        customers = get 'Customer', "#{query}" => email
+
+        found_customers = []
+        if customers and customers["Entities"] and customers["Entities"]["Customer"]
+          customers["Entities"]["Customer"].each do |customer|
+            found_customers.push parse_customer customer
+          end
+        end
+
+        found_customers
+      end
+
+      def parse_customer(customer)
+        # Meta
+        clean_customer = {}
+        clean_customer[:id]               = customer['@id'].to_i
+        clean_customer[:uid]              = customer['@uid']
+        clean_customer[:href]             = customer['@href']
+        clean_customer[:service_desk_uri] = customer['@service-desk-uri']
+
+        # Basic Info
+        clean_customer[:first_name] = customer['First_Name']['#text']
+        clean_customer[:last_name]  = customer['Last_Name']['#text']
+        clean_customer[:email]      = customer['Email']['#text']
+
+        # Dates
+        clean_customer[:date_created] = Time.parse(customer['Date_Created']['#text']).utc.to_date  if customer['Date_Created']
+        clean_customer[:date_updated] = Time.parse(customer['Date_Updated']['#text']).utc.to_date  if customer['Date_Updated']
+        clean_customer[:date_visited] = Time.parse(customer['Date_Visited']['#text']).utc.to_date  if customer['Date_Visited']
+
+        # Customer Role
+        if customer['Customer_Role'] and customer['Customer_Role']['CustomerRole']
+          clean_customer[:customer_role] = {}
+          clean_customer[:customer_role][:id]   = customer['Customer_Role']['CustomerRole']['@id'].to_i
+          clean_customer[:customer_role][:uid]  = customer['Customer_Role']['CustomerRole']['@uid']
+          clean_customer[:customer_role][:href] = customer['Customer_Role']['CustomerRole']['@href']
+          clean_customer[:customer_role][:name] = customer['Customer_Role']['CustomerRole']["Name"]['#text']
+        end
+
+        # SLA
+        if customer['Sla'] and customer['Sla']['Sla']
+          clean_customer[:sla] = {}
+          clean_customer[:sla][:id]   = customer['Sla']['Sla']['@id'].to_i
+          clean_customer[:sla][:uid]  = customer['Sla']['Sla']['@uid']
+          clean_customer[:sla][:href] = customer['Sla']['Sla']['@href']
+          clean_customer[:sla][:name] = customer['Sla']['Sla']["Name"]['#text']
+        end
+
+        # Status
+        if customer['Status'] and customer['Status']['Status']
+          clean_customer[:status] = {}
+          clean_customer[:status][:id]   = customer['Status']['Status']['@id'].to_i
+          clean_customer[:status][:uid]  = customer['Status']['Status']['@uid']
+          clean_customer[:status][:href] = customer['Status']['Status']['@href']
+          clean_customer[:status][:name] = customer['Status']['Status']["Name"]['#text']
+        end
+
+        # Custom Field
+        if customer['Custom_Field']
+          clean_customer[:custom_field] = {}
+
+          # Multple are returned as an Array, single as a Hash.
+          if customer['Custom_Field'].class != Array
+            customer['Custom_Field'] = [customer['Custom_Field']]
+          end
+
+          customer['Custom_Field'].each do |custom_field|
+            field = custom_field['@display-name'].name_to_key
+            field_key = field.to_sym
+            clean_customer[:custom_field][field_key] = {}
+            clean_customer[:custom_field][field_key][:id]          = custom_field['@id'].to_i
+            clean_customer[:custom_field][field_key][:required]    = custom_field['@required'].downcase == 'true'  if custom_field['@required']
+            clean_customer[:custom_field][field_key][:editable]    = custom_field['@editable'].downcase == 'true'  if custom_field['@editable']
+            clean_customer[:custom_field][field_key][:max_length]  = custom_field['@max-length'].to_i  if custom_field['@max-length']
+            clean_customer[:custom_field][field_key][:field_type]  = custom_field['@field-type']  if custom_field['@field-type']
+            clean_customer[:custom_field][field_key][:data_type]   = custom_field['@data-type']  if custom_field['@data-type']
+            clean_customer[:custom_field][field_key][:multi_value] = custom_field['@multi-value'].downcase == 'true'  if custom_field['@multi-value']
+
+            # Get the value or values.
+            case custom_field['@data-type']
+            when 'string'
+              clean_customer[:custom_field][field_key][:value] = custom_field['#text']
+            when 'int'
+              clean_customer[:custom_field][field_key][:value] = custom_field['#text'].to_i
+            when 'date'
+              clean_customer[:custom_field][field_key][:value] = Time.parse(custom_field['#text']).utc.to_date
+            when 'boolean'
+              clean_customer[:custom_field][field_key][:value] = custom_field['#text'] == 'true'
+            when 'float'
+              clean_customer[:custom_field][field_key][:value] = custom_field['#text'].to_f
+            when 'option'
+              selected_options = []
+              custom_field['Option'].each do |option|
+                if option["@selected"] == 'true'
+                  selected_option = {}
+                  selected_option[:id]         = option["@id"].to_i
+                  selected_option[:view_order] = option["@viewOrder"]
+                  selected_option[:value]      = option["Value"]
+                  selected_options.push selected_option
+                end
+              end
+              selected_options = selected_options.first  unless clean_customer[:custom_field][field_key][:multi_value]
+              clean_customer[:custom_field][field_key][:value] = selected_options
+            when 'entity'
+              clean_customer[:custom_field][field_key].value = nil
+            when 'attachment'
+              clean_customer[:custom_field][field_key].value = nil
+            else
+              clean_customer[:custom_field][field_key].value = nil
+            end
+          end
+        end
+
+        clean_customer
+      end
+
+    end
+  end
+end

data/lib/hotdogprincess/client/slas.rb

@@ -0,0 +1,57 @@
+require 'gyoku'
+require 'nori'
+
+module HotDogPrincess
+  class Client
+    module Slas
+
+      @slas = nil
+      @slas_raw = nil
+
+      def fetch_slas(page_size = 100)
+        @slas_raw = get "Sla", _pageSize_: page_size
+        @slas_raw
+      end
+
+      def slas(page_size = 100, force_update = false)
+        return @slas  if @slas and !force_update
+        fetch_slas(page_size)
+        return nil  unless @slas_raw
+        @slas ||= []
+        @slas_raw["Entities"]["Sla"].each do |sla|
+          @slas.push parse_sla sla
+        end
+        @slas
+      end
+
+      def slas_raw(page_size = 100)
+        return @slas_raw  if @slas_raw
+        fetch_slas(page_size)
+        @slas_raw
+      end
+
+      def sla_count
+        return @slas.length  if @slas
+        return @slas["Entities"].length  if @slas_raw
+        0
+      end
+
+      def sla(sla_id, history = false)
+        sla = get "Sla/#{sla_id}", _history_: history
+        parse_sla sla['Sla']
+      end
+
+      def parse_sla(sla)
+        # Meta
+        clean_sla = {}
+        clean_sla[:id]   = sla['@id'].to_i
+        clean_sla[:uid]  = sla['@uid']
+        clean_sla[:href] = sla['@href']
+        clean_sla[:name] = sla['Name']['#text']
+
+        clean_sla
+      end
+
+    end
+  end
+end

data/lib/hotdogprincess/client/tickets.rb

@@ -0,0 +1,219 @@
+require 'gyoku'
+require 'nori'
+
+module HotDogPrincess
+  class Client
+    module Tickets
+
+      @tickets = nil
+      @tickets_raw = nil
+
+      def fetch_tickets(page_size = 100)
+        @tickets_raw = get "Ticket", _pageSize_: page_size
+        @tickets_raw
+      end
+
+      def tickets(page_size = 100, force_update = false)
+        return @tickets  if @tickets and !force_update
+        fetch_tickets(page_size)
+        return nil  unless @tickets_raw
+        @tickets ||= []
+        @tickets_raw["Entities"]["Ticket"].each do |ticket|
+          @tickets.push parse_ticket ticket
+        end
+        @tickets
+      end
+
+      def tickets_raw(page_size = 100)
+        return @tickets_raw  if @tickets_raw
+        fetch_tickets(page_size)
+        @tickets_raw
+      end
+
+      def ticket_count
+        return @tickets.length  if @tickets
+        return @tickets["Entities"].length  if @tickets_raw
+        0
+      end
+
+      def ticket(ticket_id, history = false)
+        ticket = get "Ticket/#{ticket_id}", _history_: history
+        parse_ticket ticket['Ticket']
+      end
+
+      def update_ticket(ticket_id, ticket)
+        xml = Gyoku.xml(ticket)
+        ticket_xml = put "Ticket/#{ticket_id}", xml
+
+        parser = Nori.new
+        new_ticket_xml = parser.parse ticket_xml
+
+        ticket = get "Ticket/#{new_ticket_xml['Ticket']['@id']}", _history_: false
+
+        parse_ticket ticket['Ticket']
+      end
+
+      def create_ticket(ticket)
+        xml = Gyoku.xml(ticket)
+        ticket_xml = post "Ticket", xml
+
+        parser = Nori.new
+        new_ticket_xml = parser.parse ticket_xml
+
+        ticket = get "Ticket/#{new_ticket_xml['Ticket']['@id']}", _history_: false
+
+        parse_ticket ticket['Ticket']
+      end
+
+      def parse_ticket(ticket)
+        # Meta
+        clean_ticket = {}
+        clean_ticket[:id]               = ticket['@id'].to_i
+        clean_ticket[:uid]              = ticket['@uid']
+        clean_ticket[:href]             = ticket['@href']
+        clean_ticket[:service_desk_uri] = ticket['@service-desk-uri']
+
+        # Dates
+        clean_ticket[:date_created] = Time.parse(ticket['Date_Created']['#text']).utc.to_date  if ticket['Date_Created']
+        clean_ticket[:date_updated] = Time.parse(ticket['Date_Updated']['#text']).utc.to_date  if ticket['Date_Updated']
+
+        # Booleans
+        clean_ticket[:dont_overwrite_sla_in_rr]              = ticket['Dont_Overwrite_Sla_In_Rr']['#text'].downcase == 'true'
+        clean_ticket[:email_notification]                    = ticket['Email_Notification']['#text'].downcase == 'true'
+        clean_ticket[:email_notification_additional_contact] = ticket['Email_Notification_Additional_Contact']['#text'].downcase == 'true'
+        clean_ticket[:hide_from_customer]                    = ticket['Hide_From_Customer']['#text'].downcase == 'true'
+
+        # Durations
+        clean_ticket[:initial_resolution_target_duration] = ticket['Initial_Resolution_Target_Duration']['#text'].to_i
+        clean_ticket[:initial_response_target_duration]   = ticket['Initial_Response_Target_Duration']['#text'].to_i
+
+        # Ticket Number
+        if ticket['Ticket_Number']
+          clean_ticket[:ticket_number] = ticket['Ticket_Number']['#text']
+        end
+
+        # Queue
+        if ticket['Ticket_Queue'] and ticket['Ticket_Queue']['Queue']
+          clean_ticket[:ticket_queue] = {}
+          clean_ticket[:ticket_queue][:id]   = ticket['Ticket_Queue']['Queue']['@id'].to_i
+          clean_ticket[:ticket_queue][:uid]  = ticket['Ticket_Queue']['Queue']['@uid']
+          clean_ticket[:ticket_queue][:href] = ticket['Ticket_Queue']['Queue']['@href']
+          clean_ticket[:ticket_queue][:name] = ticket['Ticket_Queue']['Queue']["Name"]['#text']
+        end
+
+        # SLA
+        if ticket['Ticket_Sla'] and ticket['Ticket_Sla']['Sla']
+          clean_ticket[:ticket_sla] = {}
+          clean_ticket[:ticket_sla][:id]   = ticket['Ticket_Sla']['Sla']['@id'].to_i
+          clean_ticket[:ticket_sla][:uid]  = ticket['Ticket_Sla']['Sla']['@uid']
+          clean_ticket[:ticket_sla][:href] = ticket['Ticket_Sla']['Sla']['@href']
+          clean_ticket[:ticket_sla][:name] = ticket['Ticket_Sla']['Sla']["Name"]['#text']
+        end
+
+        # Status
+        if ticket['Ticket_Status'] and ticket['Ticket_Status']['Status']
+          clean_ticket[:ticket_status] = {}
+          clean_ticket[:ticket_status][:id]   = ticket['Ticket_Status']['Status']['@id'].to_i
+          clean_ticket[:ticket_status][:uid]  = ticket['Ticket_Status']['Status']['@uid']
+          clean_ticket[:ticket_status][:href] = ticket['Ticket_Status']['Status']['@href']
+          clean_ticket[:ticket_status][:name] = ticket['Ticket_Status']['Status']["Name"]['#text']
+        end
+
+        # Department
+        if ticket['Department'] and ticket['Department']['Department']
+          clean_ticket[:department] =  {}
+          clean_ticket[:department][:id]   = ticket['Department']['Department']["@id"].to_i
+          clean_ticket[:department][:uid]  = ticket['Department']['Department']["@uid"]
+          clean_ticket[:department][:href] = ticket['Department']['Department']["@href"]
+          clean_ticket[:department][:name] = ticket['Department']['Department']["Name"]['#text']
+        end
+
+        # Customer Service Represenative
+        if ticket['Entered_By'] and ticket['Entered_By']['Csr']
+          clean_ticket[:entered_by] = {}
+          clean_ticket[:entered_by][:id]        = ticket['Entered_By']['Csr']['@id'].to_i
+          clean_ticket[:entered_by][:uid]       = ticket['Entered_By']['Csr']['@uid']
+          clean_ticket[:entered_by][:href]      = ticket['Entered_By']['Csr']['@href']
+          clean_ticket[:entered_by][:full_name] = ticket['Entered_By']['Csr']["Full_Name"]['#text']
+        end
+
+        # Customer
+        if ticket['Ticket_Customer'] and ticket['Ticket_Customer']['Customer']
+          clean_ticket[:ticket_customer] = {}
+          clean_ticket[:ticket_customer][:id]        = ticket['Ticket_Customer']['Customer']['@id'].to_i
+          clean_ticket[:ticket_customer][:uid]       = ticket['Ticket_Customer']['Customer']['@uid']
+          clean_ticket[:ticket_customer][:href]      = ticket['Ticket_Customer']['Customer']['@href']
+          clean_ticket[:ticket_customer][:full_name] = ticket['Ticket_Customer']['Customer']["Full_Name"]['#text']
+        end
+
+        # Attachements
+        if ticket['Ticket_Attachments']
+          clean_ticket[:ticket_attachments] = {}
+          clean_ticket[:ticket_attachments][:id]          = ticket['Ticket_Attachments']['@id'].to_i
+          clean_ticket[:ticket_attachments][:uid]         = ticket['Ticket_Attachments']['@uid']
+          clean_ticket[:ticket_attachments][:href]        = ticket['Ticket_Attachments']['@href']
+          clean_ticket[:ticket_attachments][:attachments] = ticket['Ticket_Attachments']['Attachments']
+        end
+
+        # Custom Field
+        if ticket['Custom_Field']
+          clean_ticket[:custom_field] = {}
+
+          # Multple are returned as an Array, single as a Hash.
+          if ticket['Custom_Field'].class != Array
+            ticket['Custom_Field'] = [ticket['Custom_Field']]
+          end
+
+          ticket['Custom_Field'].each do |custom_field|
+            field = custom_field['@display-name'].name_to_key
+            field_key = field.to_sym
+            clean_ticket[:custom_field][field_key] = {}
+            clean_ticket[:custom_field][field_key][:id]          = custom_field['@id'].to_i
+            clean_ticket[:custom_field][field_key][:required]    = custom_field['@required'].downcase == 'true'  if custom_field['@required']
+            clean_ticket[:custom_field][field_key][:editable]    = custom_field['@editable'].downcase == 'true'  if custom_field['@editable']
+            clean_ticket[:custom_field][field_key][:max_length]  = custom_field['@max-length'].to_i  if custom_field['@max-length']
+            clean_ticket[:custom_field][field_key][:field_type]  = custom_field['@field-type']  if custom_field['@field-type']
+            clean_ticket[:custom_field][field_key][:data_type]   = custom_field['@data-type']  if custom_field['@data-type']
+            clean_ticket[:custom_field][field_key][:multi_value] = custom_field['@multi-value'].downcase == 'true'  if custom_field['@multi-value']
+
+            # Get the value or values.
+            case custom_field['@data-type']
+            when 'string'
+              clean_ticket[:custom_field][field_key][:value] = custom_field['#text']
+            when 'int'
+              clean_ticket[:custom_field][field_key][:value] = custom_field['#text'].to_i
+            when 'date'
+              clean_ticket[:custom_field][field_key][:value] = Time.parse(custom_field['#text']).utc.to_date
+            when 'boolean'
+              clean_ticket[:custom_field][field_key][:value] = custom_field['#text'] == 'true'
+            when 'float'
+              clean_ticket[:custom_field][field_key][:value] = custom_field['#text'].to_f
+            when 'option'
+              selected_options = []
+              custom_field['Option'].each do |option|
+                if option["@selected"] == 'true'
+                  selected_option = {}
+                  selected_option[:id]         = option["@id"].to_i
+                  selected_option[:view_order] = option["@viewOrder"]
+                  selected_option[:value]      = option["Value"]
+                  selected_options.push selected_option
+                end
+              end
+              selected_options = selected_options.first  unless clean_ticket[:custom_field][field_key][:multi_value]
+              clean_ticket[:custom_field][field_key][:value] = selected_options
+            when 'entity'
+              clean_ticket[:custom_field][field_key][:value] = nil
+            when 'attachment'
+              clean_ticket[:custom_field][field_key][:value] = nil
+            else
+              clean_ticket[:custom_field][field_key][:value] = nil
+            end
+          end
+        end
+
+        clean_ticket
+      end
+
+    end
+  end
+end

data/lib/hotdogprincess/core_extensions.rb

@@ -0,0 +1,8 @@
+require "restclient"
+require "hotdogprincess/version"
+require "hotdogprincess/core_extensions/string"
+
+module HotDogPrincess
+  class CoreExtensions
+  end
+end

data/lib/hotdogprincess/core_extensions/string.rb

@@ -0,0 +1,29 @@
+module HotDogPrincess
+  class CoreExtensions
+    module String
+
+      def name_to_key_camecase
+        self.gsub(/[^a-z _-]/i, '')
+            .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+            .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+            .tr(' ', '_')
+            .tr('-', '_')
+            .gsub(/(_)\1+/i, '_')
+            .downcase
+      end
+
+      def name_to_key
+        self.gsub(/[^a-z _-]/i, '')
+            .tr(' ', '_')
+            .tr('-', '_')
+            .gsub(/(_)\1+/i, '_')
+            .downcase
+      end
+
+    end
+  end
+end
+
+class String
+  include HotDogPrincess::CoreExtensions::String
+end

data/lib/hotdogprincess/version.rb

@@ -0,0 +1,3 @@
+module HotDogPrincess
+  VERSION = "0.1.1".freeze
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: hotdogprincess
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matthew Callis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Integrate with the Parature API.
+email:
+- matthew.callis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- hotdogprincess.gemspec
+- lib/hotdogprincess.rb
+- lib/hotdogprincess/client.rb
+- lib/hotdogprincess/client/customers.rb
+- lib/hotdogprincess/client/slas.rb
+- lib/hotdogprincess/client/tickets.rb
+- lib/hotdogprincess/core_extensions.rb
+- lib/hotdogprincess/core_extensions/string.rb
+- lib/hotdogprincess/version.rb
+homepage: https://github.com/MatthewCallis/hotdogprincess
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Integrate with the Parature API. It's gunna be so flippin' awesome!
+test_files: []
+has_rdoc: