issue_centre 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f132de3629c640920cfc8e8555a929f90208faa
-  data.tar.gz: d1b501cd78971e84d0b94f1a310329b79d0a2f06
+  metadata.gz: 830a7056a3b03c3608b9c40c60957ef57e8096dc
+  data.tar.gz: cf976d1a5b762e6caceeb00526ece11488323e3f
 SHA512:
-  metadata.gz: ccb88c3ed4af9a07ae456f2be76bc2436b2e4fbeee57059a4ff6f5daef4442cffae20ed79afa0fa39e2e75b4e03b37e81945f56d229167f83b74e3b6a4dc2d92
-  data.tar.gz: 3048e65166921a3393a75a132c6a97ce1a6786a40f35d7f14774f15fe3ed7df0bb8196d67ece91f66135adf47a539d0be6aff0cc5b8d847077bf1b118562ab3c
+  metadata.gz: bf512818f61e3fbb6489e18dc03741232f50e609fc905d326a1ce35549f2b9499ce2ebeeeae10ba3579ddb97397d5cec753c80c283eb0f25aa9e1f47f586f717
+  data.tar.gz: 19333ce58d952ca2c8703fc9b5030c297b69ca130fec74742d85772c02fbfe95132e8f7608e55185c63f869cb7539b687aeb817a580335c5f75e18c5752a159e

data/README.md

@@ -63,6 +63,10 @@ open_tickets = ticket_conn.get_open_tickets( session_key, companies.first[:id],
 # Grab a list of closed tickets for the specified company
 closed_tickets = ticket_conn.get_closed_tickets( session_key, companies.first[:id], 100, 1)
 
+# Grab a list of events for the specified ticket
+events = ticket_conn.get_events_for_ticket( session_key, closed_tickets.last[:id])
+
+
 ```
 
 ## Contributing

data/issue_centre.gemspec

@@ -36,4 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday"
   spec.add_dependency "savon", "~> 2.0"
   spec.add_dependency "activesupport"
+
+  spec.has_rdoc = 'yard'
 end

data/lib/issue_centre/auth_connection.rb

@@ -4,9 +4,9 @@ module IssueCentre
     # Connection client for authenticating and retrieving contracts
     # from IssueCentre
     #
-    # @param [String] endpoint_url IssueCentre endpoint url
+    # @param auth_url [String] IssueCentre endpoint url
     #   (e.g. {https://support.callclosed.net/issuecentre/Connection})
-    # @param [Hash] options Other options to pass to the constructors
+    # @param options [Hash] Other options to pass to the constructors
     #
     # @return [AuthConnection] Instance of AuthConnection client
     #

data/lib/issue_centre/customer_connection.rb

@@ -4,7 +4,7 @@ module IssueCentre
     # Connection client for authenticating and retrieving customer
     # information from IssueCentre
     #
-    # @param [String] endpoint_url IssueCentre endpoint url
+    # @param [String] customer_url IssueCentre endpoint url
     #   (e.g. {https://support.callclosed.net/issuecentre/Customer})
     # @param [String] session_key SessionKey for this session
     # @param [Hash] options Other options to pass to the constructors

data/lib/issue_centre/generic_connection.rb

@@ -5,10 +5,8 @@ module IssueCentre
     # @see AuthConnection
     # @see CustomerConnection
     #
-    # @param [String] endpoint_url IssueCentre endpoint url
+    # @param [String] base_url IssueCentre endpoint url
     #   (e.g. {https://support.callclosed.net/issuecentre/Connection})
-    # @param [String] username A valid IssueCentre username
-    # @param [String] password A valid IssueCentre password
     # @param [Hash] options Other options to pass to the constructors
     #
     # @return [Connection] instance of Connection

data/lib/issue_centre/ticket_connection.rb

@@ -4,7 +4,7 @@ module IssueCentre
     # Connection client for authenticating and retrieving ticket
     # information from IssueCentre
     #
-    # @param [String] endpoint_url IssueCentre endpoint url (e.g.
+    # @param [String] customer_url IssueCentre endpoint url (e.g.
     #   {https://support.callclosed.net/issuecentre/Customer})
     #
     # @param [String] session_key SessionKey for this session
@@ -46,7 +46,7 @@ module IssueCentre
 
     # Return (closed) tickets from IssueCentre for this contract
     #
-    # @param [SessionKey] session SessionKey object
+    # @param [SessionKey] session_key SessionKey object
     #
     # @param [Integer] company_id A Company ID for the function to
     #   return closed tickets for.  Zero returns a list of all closed
@@ -71,9 +71,9 @@ module IssueCentre
 
     # Return all events from IssueCentre for this ticket
     #
-    # @param [String] session SessionKey object
+    # @param [String] session_key SessionKey object
     #
-    # @param [Integer] ticket Ticket ID for the required ticket
+    # @param [Integer] ticket_id Ticket ID for the required ticket
     #
     # @return [Array] An array of events and details as hashes
     #    

data/lib/issue_centre/version.rb

@@ -1,3 +1,3 @@
 module IssueCentre
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: issue_centre
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jason Holloway