teamsupport 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +18 -36
- data/lib/teamsupport/version.rb +1 -1
- data/teamsupport.gemspec +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 34efcc772aafee7ea6e94d94e079829a772b132c
|
4
|
+
data.tar.gz: d54e779b77291b47e05eb7ffca328ab4f96b851a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 225c7a5a5a9e1ff029b51b4a5e80a6f2dca64c057c3fe6a0893bddaa47008b0b2ac9c2e4572ea75a2f2be3576cfb7151a0caaf12cf6f2727725e3f36bf54657b
|
7
|
+
data.tar.gz: 9a0c4de0a90e7c313c8d839361782053a1616050bccd93e9437800aac717f7ea4fea4ba5539e0dd62a6649ebf5bb6a5b2e49daeccdfb7c92770b1f2b6b56dde8
|
data/CHANGELOG.md
CHANGED
@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
|
|
5
5
|
## Unreleased
|
6
6
|
- Backlog and Future Milestones are managed via [Github](https://github.com/jrbeilke/teamsupport/issues)
|
7
7
|
|
8
|
+
## 0.1.1 - 2016-09-22
|
9
|
+
### Fixed
|
10
|
+
- Fixed bad bundler dependency version in gemspec
|
11
|
+
|
8
12
|
## 0.1.0 - 2016-09-22
|
9
13
|
### Added
|
10
14
|
- Initial release with support for customers, products, and tickets from the Teamsupport API.
|
data/README.md
CHANGED
@@ -17,7 +17,8 @@
|
|
17
17
|
A Ruby interface to the Teamsupport API.
|
18
18
|
|
19
19
|
## Installation
|
20
|
-
|
20
|
+
|
21
|
+
gem install teamsupport
|
21
22
|
|
22
23
|
## Documentation
|
23
24
|
[http://rdoc.info/gems/teamsupport][documentation]
|
@@ -25,10 +26,9 @@ A Ruby interface to the Teamsupport API.
|
|
25
26
|
[documentation]: http://rdoc.info/gems/teamsupport
|
26
27
|
|
27
28
|
To access custom fields you will need to use the attrs method along with the api field name:
|
28
|
-
|
29
|
-
customer = client.customer(213747670)
|
30
|
-
customer.attrs[:CustomField1]
|
31
|
-
```
|
29
|
+
|
30
|
+
customer = client.customer(213747670)
|
31
|
+
customer.attrs[:CustomField1]
|
32
32
|
|
33
33
|
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.
|
34
34
|
|
@@ -48,68 +48,50 @@ you'll get the error:
|
|
48
48
|
|
49
49
|
You can pass configuration options as a block to `Teamsupport::REST::Client.new`.
|
50
50
|
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
end
|
56
|
-
```
|
51
|
+
client = Teamsupport::REST::Client.new do |config|
|
52
|
+
config.api_key = "TEAMSUPPORT_ORGANIZATION_ID"
|
53
|
+
config.api_secret = "TEAMSUPPORT_API_TOKEN"
|
54
|
+
end
|
57
55
|
|
58
56
|
## Usage Examples
|
59
57
|
After configuring a `client`, you can do the following things.
|
60
58
|
|
61
59
|
**Fetch a single customer (by organization ID)**
|
62
60
|
|
63
|
-
|
64
|
-
client.customer(213747670)
|
65
|
-
```
|
61
|
+
client.customer(213747670)
|
66
62
|
|
67
63
|
**Fetch a list of customers with details (by organization ID, or by implicit authenticated parent organization)**
|
68
64
|
|
69
|
-
|
70
|
-
client.customers
|
71
|
-
```
|
65
|
+
client.customers
|
72
66
|
|
73
67
|
**Fetch a single product (by product ID)**
|
74
68
|
|
75
|
-
|
76
|
-
client.product(213747670)
|
77
|
-
```
|
69
|
+
client.product(213747670)
|
78
70
|
|
79
71
|
**Fetch a list of products with details (by product ID, or by implicit authenticated parent organization)**
|
80
72
|
|
81
|
-
|
82
|
-
client.products
|
83
|
-
```
|
73
|
+
client.products
|
84
74
|
|
85
75
|
**Fetch a list of products for a customer (by customer ID)**
|
86
76
|
|
87
|
-
|
88
|
-
client.customer_products(213747670)
|
89
|
-
```
|
77
|
+
client.customer_products(213747670)
|
90
78
|
|
91
79
|
**Fetch a single ticket (by ticket ID, or by ticket Number)**
|
92
80
|
|
93
|
-
|
94
|
-
client.ticket(213747670)
|
95
|
-
```
|
81
|
+
client.ticket(213747670)
|
96
82
|
|
97
83
|
**Fetch a list of tickets with details (by ticket ID, or by implicit authenticated parent organization)**
|
98
84
|
|
99
|
-
|
100
|
-
client.tickets
|
101
|
-
```
|
85
|
+
client.tickets
|
102
86
|
|
103
87
|
**Fetch a list of tickets for a customer (by customer ID)**
|
104
88
|
|
105
|
-
|
106
|
-
client.customer_tickets(213747670)
|
107
|
-
```
|
89
|
+
client.customer_tickets(213747670)
|
108
90
|
|
109
91
|
## Object Graph
|
110
92
|
![Entity-relationship diagram][erd]
|
111
93
|
|
112
|
-
[erd]: etc/erd.svg "Entity-relationship diagram"
|
94
|
+
[erd]: https://cdn.rawgit.com/jrbeilke/teamsupport/master/etc/erd.svg "Entity-relationship diagram"
|
113
95
|
|
114
96
|
This entity-relationship diagram is generated programatically. If you add or
|
115
97
|
remove any Teamsupport objects, please regenerate the ERD with the following
|
data/lib/teamsupport/version.rb
CHANGED
data/teamsupport.gemspec
CHANGED
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
|
|
9
9
|
spec.add_dependency 'http', '~> 1.0'
|
10
10
|
spec.add_dependency 'http-form_data', '~> 1.0'
|
11
11
|
spec.add_dependency 'naught', '~> 1.0'
|
12
|
-
spec.add_development_dependency 'bundler', '~> 1.
|
12
|
+
spec.add_development_dependency 'bundler', '~> 1.0'
|
13
13
|
|
14
14
|
spec.name = 'teamsupport'
|
15
15
|
spec.version = Teamsupport::Version
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: teamsupport
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Jon Beilke
|
@@ -86,14 +86,14 @@ dependencies:
|
|
86
86
|
requirements:
|
87
87
|
- - "~>"
|
88
88
|
- !ruby/object:Gem::Version
|
89
|
-
version: '1.
|
89
|
+
version: '1.0'
|
90
90
|
type: :development
|
91
91
|
prerelease: false
|
92
92
|
version_requirements: !ruby/object:Gem::Requirement
|
93
93
|
requirements:
|
94
94
|
- - "~>"
|
95
95
|
- !ruby/object:Gem::Version
|
96
|
-
version: '1.
|
96
|
+
version: '1.0'
|
97
97
|
description: A Ruby interface to the Teamsupport API.
|
98
98
|
email:
|
99
99
|
- jrbeilke@gmail.com
|