teamsupport 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4802bcfd75dfbac4c1b74c4e76e83bfd80daffdf
+  data.tar.gz: 4e9a7133091888f556ab04e5bc3039f8c9cb2e45
+SHA512:
+  metadata.gz: 16d923aceecaa410fd0ac83659f4a70bd7377cd7275d5e717e79447437a35bc32f1387d0054a0b4de7e03e68a30e98fd25f5ad288b1c4357523411c2b49258de
+  data.tar.gz: ea4add6266fa8f0db8f745dd07501e210336660152627fde974ac87f8dfb8f9f1c5c2cf99b879c5fd7ede6f55f9c6ceef6ca7e9a6866ae3ff59e1a382f388fda

data/.yardopts

@@ -0,0 +1,12 @@
+--no-private
+--protected
+--tag authentication:"Authentication"
+--markup markdown
+-
+CHANGELOG.md
+CONTRIBUTING.md
+LICENSE.md
+README.md
+examples/AllCustomers.md
+examples/Configuration.md
+examples/UpdateCustomer.md

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log (http://keepachangelog.com/)
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## Unreleased
+- Backlog and Future Milestones are managed via [Github](https://github.com/jrbeilke/teamsupport/issues)
+
+## 0.1.0 - 2016-09-22
+### Added
+- Initial release with support for customers, products, and tickets from the Teamsupport API.
+- Based on code from [The Twitter Ruby Gem](https://github.com/sferik/twitter)

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project. Here are some ways *you* can contribute:
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+* Use alpha, beta, and pre-release versions.
+* Report bugs.
+* Suggest new features.
+* Write or edit documentation.
+* Write specifications.
+* Write code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace).
+* Refactor code.
+* Fix [issues][].
+* Review patches.
+
+[issues]: https://github.com/jrbeilke/teamsupport/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake verify_measurements`. If your changes are not 100%
+   documented, go back to step 8.
+10. Commit and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/LICENSE.md

@@ -0,0 +1,26 @@
+Teamsupport Ruby Gem: https://github.com/jrbeilke/teamsupport
+
+Copyright (c) 2016 Jon Beilke
+
+Based on the Twitter Ruby Gem: https://github.com/sferik/twitter/
+
+Copyright (c) 2006-2016 Erik Michaels-Ober, John Nunemaker, Wynn Netherland, Steve Richert, Steve Agalloco
+
+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,132 @@
+# The Teamsupport Ruby Gem
+
+[![Gem Version](http://img.shields.io/gem/v/teamsupport.svg)][gem]
+[![Build Status](http://img.shields.io/travis/jrbeilke/teamsupport.svg)][travis]
+[![Dependency Status](http://img.shields.io/gemnasium/jrbeilke/teamsupport.svg)][gemnasium]
+[![Code Climate](http://img.shields.io/codeclimate/github/jrbeilke/teamsupport.svg)][codeclimate]
+[![Coverage Status](http://img.shields.io/coveralls/jrbeilke/teamsupport.svg)][coveralls]
+[![Inline docs](http://inch-ci.org/github/jrbeilke/teamsupport.svg?style=shields)][inchpages]
+
+[gem]: https://rubygems.org/gems/teamsupport
+[travis]: https://travis-ci.org/jrbeilke/teamsupport
+[gemnasium]: https://gemnasium.com/jrbeilke/teamsupport
+[codeclimate]: https://codeclimate.com/github/jrbeilke/teamsupport
+[coveralls]: https://coveralls.io/r/jrbeilke/teamsupport
+[inchpages]: http://inch-ci.org/github/jrbeilke/teamsupport
+
+A Ruby interface to the Teamsupport API.
+
+## Installation
+    gem install twitter
+
+## Documentation
+[http://rdoc.info/gems/teamsupport][documentation]
+
+[documentation]: http://rdoc.info/gems/teamsupport
+
+To access custom fields you will need to use the attrs method along with the api field name:
+```ruby
+customer = client.customer(213747670)
+customer.attrs[:CustomField1]
+```
+
+Caveat: The TeamSupport API currently returns boolean values as "True"/"False" strings. A workaround has been applied to the teamsupport gem that will return a boolean true/false for any of the standard TeamSupport values that should be a boolean (ie. IsActive on customers and IsClosed on tickets). Any additional custom fields that were created in TeamSupport will return the "True"/"False" string value instead of the proper boolean.
+
+## Examples
+[https://github.com/jrbeilke/teamsupport/tree/master/examples][examples]
+
+[examples]: https://github.com/jrbeilke/teamsupport/tree/master/examples
+
+## Configuration
+The Teamsupport API requires you to authenticate via Basic Auth, using an
+Organization ID (aka API Key) and an API Token (aka API Secret).
+
+You'll need to configure these values before you make a request or else
+you'll get the error:
+
+    Bad Authentication data
+
+You can pass configuration options as a block to `Teamsupport::REST::Client.new`.
+
+```ruby
+client = Teamsupport::REST::Client.new do |config|
+  config.api_key    = "TEAMSUPPORT_ORGANIZATION_ID"
+  config.api_secret = "TEAMSUPPORT_API_TOKEN"
+end
+```
+
+## Usage Examples
+After configuring a `client`, you can do the following things.
+
+**Fetch a single customer (by organization ID)**
+
+```ruby
+client.customer(213747670)
+```
+
+**Fetch a list of customers with details (by organization ID, or by implicit authenticated parent organization)**
+
+```ruby
+client.customers
+```
+
+**Fetch a single product (by product ID)**
+
+```ruby
+client.product(213747670)
+```
+
+**Fetch a list of products with details (by product ID, or by implicit authenticated parent organization)**
+
+```ruby
+client.products
+```
+
+**Fetch a list of products for a customer (by customer ID)**
+
+```ruby
+client.customer_products(213747670)
+```
+
+**Fetch a single ticket (by ticket ID, or by ticket Number)**
+
+```ruby
+client.ticket(213747670)
+```
+
+**Fetch a list of tickets with details (by ticket ID, or by implicit authenticated parent organization)**
+
+```ruby
+client.tickets
+```
+
+**Fetch a list of tickets for a customer (by customer ID)**
+
+```ruby
+client.customer_tickets(213747670)
+```
+
+## Object Graph
+![Entity-relationship diagram][erd]
+
+[erd]: etc/erd.svg "Entity-relationship diagram"
+
+This entity-relationship diagram is generated programatically. If you add or
+remove any Teamsupport objects, please regenerate the ERD with the following
+command:
+
+    bundle exec rake erd
+
+## Supported Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby versions:
+
+* Ruby 2.0.0
+* Ruby 2.1
+* Ruby 2.2
+* JRuby 9.1.1.0
+
+## Copyright
+Copyright (c) 2016 Jon Beilke.
+See [LICENSE][] for details.
+
+[license]: LICENSE.md

data/lib/teamsupport.rb

@@ -0,0 +1,21 @@
+require 'addressable/uri'
+require 'teamsupport/rest/client'
+
+# TODO: require 'teamsupport/asset'
+# TODO: require 'teamsupport/asset_ticket'
+# TODO: require 'teamsupport/contact'
+# TODO: require 'teamsupport/contact_ticket'
+require 'teamsupport/customer'
+# TODO: require 'teamsupport/customer_contact'
+require 'teamsupport/customer_product'
+# TODO: require 'teamsupport/customer_ticket'
+# TODO: require 'teamsupport/group'
+require 'teamsupport/product'
+# TODO: require 'teamsupport/product_customer'
+# TODO: require 'teamsupport/property'
+require 'teamsupport/ticket'
+require 'teamsupport/ticket_action'
+# TODO: require 'teamsupport/ticket_contact'
+# TODO: require 'teamsupport/ticket_customer'
+# TODO: require 'teamsupport/user'
+# TODO: require 'teamsupport/wiki'

data/lib/teamsupport/arguments.rb

@@ -0,0 +1,26 @@
+module Teamsupport
+  class Arguments < Array
+    # Provide an options method for reading argument options
+    #
+    # @example
+    #   teamsupport_arguments = Teamsupport::Arguments.new(args)
+    #   teamsupport_arguments.options
+    #
+    # @return [Hash]
+    #
+    # @api public
+    attr_reader :options
+
+    # Initializes a new Arguments object
+    #
+    # @param args [Hash]
+    #
+    # @return [Teamsupport::Arguments]
+    #
+    # @api private
+    def initialize(args)
+      @options = args.last.is_a?(::Hash) ? args.pop : {}
+      super(args.flatten)
+    end
+  end
+end

data/lib/teamsupport/base.rb

@@ -0,0 +1,173 @@
+require 'addressable/uri'
+require 'forwardable'
+require 'teamsupport/null_object'
+require 'teamsupport/utils'
+
+module Teamsupport
+  class Base
+    extend Forwardable
+    include Teamsupport::Utils
+    # Provide an attrs method for reading object attributes
+    #
+    # @example
+    #   teamsupport_object = Teamsupport::Base.new(ID: 1)
+    #   teamsupport_object.attrs[:ID]
+    #
+    # @return [Hash]
+    #
+    # @api public
+    attr_reader :attrs
+    alias to_h attrs
+    alias to_hash to_h
+
+    class << self
+      # Define methods for reading and checking existence of attributes
+      #
+      # @example
+      #   attr_reader :attrs
+      #
+      # @param attrs [Array, Symbol]
+      #
+      # @return [Object, Boolean, nil]
+      #
+      # @api public
+      def attr_reader(*attrs)
+        attrs.each do |attr|
+          define_attribute_method(attr)
+          define_predicate_method(attr)
+        end
+      end
+
+      # Define methods for checking existence of attributes
+      #
+      # @example
+      #   predicate_attr_reader :favorited
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def predicate_attr_reader(*attrs)
+        attrs.each do |attr|
+          define_predicate_method(attr)
+        end
+      end
+
+      # Define methods for reading and checking existence of attributes within an object
+      #
+      # @example
+      #   object_attr_reader :User, :user, :status
+      #
+      # @param klass [Symbol]
+      # @param key1 [Symbol]
+      # @param key2 [Symbol]
+      #
+      # @return [Object, Boolean, nil]
+      #
+      # @api public
+      def object_attr_reader(klass, key1, key2 = nil)
+        define_attribute_method(key1, klass, key2)
+        define_predicate_method(key1)
+      end
+
+      # Dynamically define a method for getting the value of an attribute
+      #
+      # @example
+      #   define_attribute_method(key1, klass, key2)
+      #
+      # @param key1 [Symbol]
+      # @param klass [Symbol]
+      # @param key2 [Symbol]
+      #
+      # @return [Object, nil]
+      #
+      # @api public
+      def define_attribute_method(key1, klass = nil, key2 = nil)
+        define_method(key1) do
+          if attr_falsey_or_empty?(key1)
+            NullObject.new
+          else
+            klass.nil? ? @attrs[key1] : Teamsupport.const_get(klass).new(attrs_for_object(key1, key2))
+          end
+        end
+      end
+
+      # Dynamically define a method for checking existence of an attribute
+      #
+      # @example
+      #   define_predicate_method(key1)
+      #
+      # @param key1 [Symbol]
+      # @param key2 [Symbol]
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def define_predicate_method(key1, key2 = key1)
+        define_method(:"#{key1}?") do
+          !attr_falsey_or_empty?(key2)
+        end
+      end
+    end
+
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    #
+    # @return [Teamsupport::Base]
+    #
+    # @api private
+    def initialize(attrs = {})
+      @attrs = attrs || {}
+    end
+
+    # Fetches an attribute of an object using hash notation
+    #
+    # @example
+    #   teamsupport_object = Teamsupport::Base.new(ID: 1)
+    #   teamsupport_object[:ID]
+    #
+    # @param method [String, Symbol] Message to send to the object
+    #
+    # @return [String, nil]
+    #
+    # @api public
+    #
+    # @deprecated Please use ##{method} to fetch the value instead
+    def [](method)
+      warn "#{Kernel.caller.first}: [DEPRECATION] #[#{method.inspect}] is deprecated. Use ##{method} to fetch the value."
+      send(method.to_sym)
+    rescue NoMethodError
+      nil
+    end
+
+  private
+
+    # Check to see if the value for an object attribute is falsey or empty
+    #
+    # @param key [Symbol]
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def attr_falsey_or_empty?(key)
+      !@attrs[key] || @attrs[key].respond_to?(:empty?) && @attrs[key].empty?
+    end
+
+    # Fetch and/or update the attributes for an object
+    #
+    # @param key1 [Symbol]
+    # @param key2 [Symbol]
+    #
+    # @return [Hash]
+    #
+    # @api private
+    def attrs_for_object(key1, key2 = nil)
+      if key2.nil?
+        @attrs[key1]
+      else
+        attrs = @attrs.dup
+        attrs.delete(key1).merge(key2 => attrs)
+      end
+    end
+  end
+end