adp-product-userinfo 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +2 -0
- data/.travis.yml +4 -0
- data/CODE_OF_CONDUCT.md +42 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +253 -0
- data/Rakefile +6 -0
- data/adp-product-userinfo.gemspec +41 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/democlient/Gemfile +16 -0
- data/democlient/Gemfile.lock +47 -0
- data/democlient/LICENSE +201 -0
- data/democlient/README.md +2 -0
- data/democlient/Rakefile +9 -0
- data/democlient/adp_userinfo_ruby.rb +216 -0
- data/democlient/config.ru +24 -0
- data/democlient/config/authorizationcode_config.yml +15 -0
- data/democlient/config/certs/apiclient_iat.key +27 -0
- data/democlient/config/certs/apiclient_iat.pem +45 -0
- data/democlient/config/certs/apiclient_iat.pfx +0 -0
- data/democlient/config/clientcredential_config.yml +11 -0
- data/democlient/public/favicon.ico +0 -0
- data/democlient/public/images/.gitkeep +0 -0
- data/democlient/public/images/ADP_logo_tagline.png +0 -0
- data/democlient/public/images/busy.gif +0 -0
- data/democlient/public/images/hazel_icon.png +0 -0
- data/democlient/public/images/hazel_small.png +0 -0
- data/democlient/public/javascripts/.gitkeep +0 -0
- data/democlient/public/stylesheets/.gitkeep +0 -0
- data/democlient/public/stylesheets/main.css +225 -0
- data/democlient/spec/adp_connection_ruby_spec.rb +14 -0
- data/democlient/spec/spec_helper.rb +23 -0
- data/democlient/views/authorization_code.erb +128 -0
- data/democlient/views/client_credentials.erb +76 -0
- data/democlient/views/layout.erb +52 -0
- data/democlient/views/welcome.erb +33 -0
- data/lib/adp/product/dto/user_info.rb +30 -0
- data/lib/adp/product/userinfo.rb +11 -0
- data/lib/adp/product/userinfo/helper.rb +40 -0
- data/lib/adp/product/userinfo/version.rb +7 -0
- metadata +162 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 2bfbd6a8ec974c83de5cc2ac74480636cd4d81f3
|
4
|
+
data.tar.gz: 1fcb6a0fa59f36ae9b76c00bb4eabcc38c5cf7e1
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 9c0335a1cd1334e94cc2c66588c3bbb3dcd9d5335f8fac075d5ce75a37293e8acb10b513bcdd65540718808de0462460455126914841a053847f56b44ae16dc8
|
7
|
+
data.tar.gz: b4639bd14de9264890ea67a089a1a73fdaae93b79f8c7f38f41097d88fbfe42659188d5e940ce22ac7b5a9b4407b1983fb623625a43a921b14474a0d616f3f48
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, and in the interest of
|
4
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
5
|
+
contribute through reporting issues, posting feature requests, updating
|
6
|
+
documentation, submitting pull requests or patches, and other activities.
|
7
|
+
|
8
|
+
We are committed to making participation in this project a harassment-free
|
9
|
+
experience for everyone, regardless of level of experience, gender, gender
|
10
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
11
|
+
body size, race, ethnicity, age, religion, or nationality.
|
12
|
+
|
13
|
+
Examples of unacceptable behavior by participants include:
|
14
|
+
|
15
|
+
* The use of sexualized language or imagery
|
16
|
+
* Personal attacks
|
17
|
+
* Trolling or insulting/derogatory comments
|
18
|
+
* Public or private harassment
|
19
|
+
* Publishing other's private information, such as physical or electronic
|
20
|
+
addresses, without explicit permission
|
21
|
+
* Other unethical or unprofessional conduct
|
22
|
+
|
23
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
24
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
25
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
26
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
27
|
+
threatening, offensive, or harmful.
|
28
|
+
|
29
|
+
By adopting this Code of Conduct, project maintainers commit themselves to
|
30
|
+
fairly and consistently applying these principles to every aspect of managing
|
31
|
+
this project. Project maintainers who do not follow or enforce the Code of
|
32
|
+
Conduct may be permanently removed from the project team.
|
33
|
+
|
34
|
+
This code of conduct applies both within project spaces and in public spaces
|
35
|
+
when an individual is representing the project or its community.
|
36
|
+
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
38
|
+
reported by contacting a project maintainer at Junior.Napier-Contractor@adp.com. All
|
39
|
+
complaints will be reviewed and investigated and will result in a response that
|
40
|
+
is deemed necessary and appropriate to the circumstances. Maintainers are
|
41
|
+
obligated to maintain confidentiality with regard to the reporter of an
|
42
|
+
incident.
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,253 @@
|
|
1
|
+
# ADP Userinfo Product Client Library for Ruby
|
2
|
+
|
3
|
+
The ADP Userinfo Product Client Library is used to obtain basic information about the user that is logged-in to the ADP application. The Library includes a sample demo client application that can be run out-of-the-box to connect to the ADP Marketplace API **test** gateway. This library has a dependancy on the adp-connection library. Installing this library also installs the latest version of the adp-connection library, if not previously installed.
|
4
|
+
|
5
|
+
### Version
|
6
|
+
1.0.0 (Beta)
|
7
|
+
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
There are two ways of installing and using this library:
|
12
|
+
|
13
|
+
- Clone the repo from Github: This allows you to access the raw source code of the library as well as provide the ability to run the sample demo client application and view the Library documentation
|
14
|
+
- Install gem from RubyGems.org(https://github.com/adplabs/adp-userinfo-ruby): When you are ready to use the library in your own application use this method to install it using gem/bundle
|
15
|
+
|
16
|
+
|
17
|
+
**Clone from Github**
|
18
|
+
|
19
|
+
You can either use the links on Github or the command line git instructions below to clone the repo.
|
20
|
+
|
21
|
+
```sh
|
22
|
+
|
23
|
+
$ git clone https://github.com/adplabs/adp-userinfo-ruby adp-userinfo-ruby
|
24
|
+
|
25
|
+
```
|
26
|
+
|
27
|
+
followed by
|
28
|
+
|
29
|
+
```sh
|
30
|
+
|
31
|
+
$ cd adp-userinfo-ruby
|
32
|
+
$ rake -T
|
33
|
+
$ rake install:local
|
34
|
+
|
35
|
+
```
|
36
|
+
|
37
|
+
*Run the sample demo client app*
|
38
|
+
|
39
|
+
```sh
|
40
|
+
|
41
|
+
$ cd ./democlient
|
42
|
+
$ rackup
|
43
|
+
|
44
|
+
```
|
45
|
+
|
46
|
+
This starts an HTTP server on port 8889 (this port must be unused to run the sample application). You can point your browser to http://localhost:8889. The sample app allows you to connect to the ADP test API Gateway using the **client_credentials** and **authorization_code** grant types. For the **authorization_code** connection, you will be asked to provide an ADP username (MKPLDEMO) and password (marketplace1).
|
47
|
+
|
48
|
+
***
|
49
|
+
|
50
|
+
|
51
|
+
**Clone from Github**
|
52
|
+
|
53
|
+
Add this line to your application's Gemfile:
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
|
57
|
+
gem 'adp-connection'
|
58
|
+
gem 'adp-product-userinfo'
|
59
|
+
|
60
|
+
```
|
61
|
+
|
62
|
+
And then execute:
|
63
|
+
|
64
|
+
```sh
|
65
|
+
|
66
|
+
$ bundle
|
67
|
+
|
68
|
+
```
|
69
|
+
|
70
|
+
Or install it yourself as:
|
71
|
+
|
72
|
+
```sh
|
73
|
+
|
74
|
+
$ gem install adp-product-userinfo
|
75
|
+
|
76
|
+
```
|
77
|
+
|
78
|
+
## Usage
|
79
|
+
|
80
|
+
Start using the library by requiring the gem in your ruby files
|
81
|
+
|
82
|
+
```ruby
|
83
|
+
|
84
|
+
require 'adp/connection'
|
85
|
+
require 'adp/product/userinfo'
|
86
|
+
|
87
|
+
```
|
88
|
+
|
89
|
+
|
90
|
+
## Development
|
91
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
92
|
+
|
93
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
94
|
+
|
95
|
+
A demo client is included that uses the adp-product-userinfo gem. Check it out.
|
96
|
+
|
97
|
+
|
98
|
+
## Examples
|
99
|
+
### Create Client Credentials ADP Connection
|
100
|
+
|
101
|
+
Here is a Sinatra (http://www.sinatrarb.com/) example
|
102
|
+
|
103
|
+
```ruby
|
104
|
+
|
105
|
+
require 'yaml'
|
106
|
+
require 'tilt/erb'
|
107
|
+
require 'logger'
|
108
|
+
require 'adp/connection'
|
109
|
+
require 'adp/product/userinfo'
|
110
|
+
|
111
|
+
clientcredential_config = YAML.load(ERB.new(File.read('config/clientcredential_config.yml')).result)
|
112
|
+
authorizationcode_config = YAML.load(ERB.new(File.read('config/authorizationcode_config.yml')).result)
|
113
|
+
|
114
|
+
configure do
|
115
|
+
Log = Logger.new(STDOUT);
|
116
|
+
#Logger.new("sinatra.log")
|
117
|
+
Log.level = Logger::DEBUG
|
118
|
+
end
|
119
|
+
|
120
|
+
class AdpConnectionRuby < Sinatra::Base
|
121
|
+
|
122
|
+
enable :sessions
|
123
|
+
set :public_folder => "public", :static => true
|
124
|
+
|
125
|
+
#set :protection, :session => true
|
126
|
+
set :port, 8889
|
127
|
+
|
128
|
+
results = {
|
129
|
+
:message => "Welcome",
|
130
|
+
:auth_type => nil
|
131
|
+
}
|
132
|
+
|
133
|
+
get '/client_credentials/login' do
|
134
|
+
results[:auth_type] = :client_credentials
|
135
|
+
results[:message] = nil
|
136
|
+
connection = session["ClientCredential"]
|
137
|
+
results[:userinfo] = nil
|
138
|
+
|
139
|
+
if (connection.nil?)
|
140
|
+
|
141
|
+
# get new connection configuration
|
142
|
+
# YAML config object placed in yaml configuration files
|
143
|
+
config = YAML.load_file('config/clientcredential_config.yml');
|
144
|
+
|
145
|
+
if (!config || config.nil?)
|
146
|
+
results[:message] = "Unable to load configuration settings from file (config/clientcredential_config.yml)"
|
147
|
+
else
|
148
|
+
begin
|
149
|
+
clientcredential_config = Adp::Connection::ClientCredentialConfiguration.new(config);
|
150
|
+
|
151
|
+
connection = Adp::Connection::ApiConnectionFactory::createConnection(clientcredential_config)
|
152
|
+
|
153
|
+
connection.connect();
|
154
|
+
|
155
|
+
if (!connection.is_connected_indicator?)
|
156
|
+
results[:message] = "Error attempting to establish a connection"
|
157
|
+
Log.error "Not connected"
|
158
|
+
else
|
159
|
+
Log.debug("Connected and ready for getting data");
|
160
|
+
session["ClientCredential"] = connection;
|
161
|
+
end
|
162
|
+
end
|
163
|
+
end
|
164
|
+
end
|
165
|
+
erb :client_credentials, :locals => { :view_bag => results }
|
166
|
+
end
|
167
|
+
|
168
|
+
|
169
|
+
get '/authorization_code/get_userinfo' do
|
170
|
+
results[:auth_type] = :authorization_code
|
171
|
+
results[:message] = nil
|
172
|
+
connection = session["AuthorizationCode"]
|
173
|
+
|
174
|
+
begin
|
175
|
+
Log.debug("Do we have a connection object? #{connection}")
|
176
|
+
unless connection.nil? || connection.connection_configuration.authorizationCode.nil?
|
177
|
+
Log.debug("Check if we are connected: #{connection.access_token}")
|
178
|
+
if (connection.is_connected_indicator?)
|
179
|
+
Log.debug("Getting helper object")
|
180
|
+
helper = Adp::Product::Userinfo::Helper.new(connection)
|
181
|
+
Log.debug("getting userinfo using helper object")
|
182
|
+
json_data = helper.get_user_info()
|
183
|
+
results[:userinfo] = Adp::Product::DTO::Userinfo.new(json_data)
|
184
|
+
|
185
|
+
Log.debug("Got user info #{json_data}")
|
186
|
+
end
|
187
|
+
end
|
188
|
+
Log.debug("Done getting userinfo #{results[:userinfo]}")
|
189
|
+
rescue Adp::Connection::ConnectionException
|
190
|
+
e = env['sinatra.error']
|
191
|
+
results[:message] = "Connection error: #{e}"
|
192
|
+
end
|
193
|
+
|
194
|
+
erb :authorization_code, :locals => { :view_bag => results}
|
195
|
+
end
|
196
|
+
|
197
|
+
end
|
198
|
+
|
199
|
+
|
200
|
+
```
|
201
|
+
|
202
|
+
|
203
|
+
## API Documentation ##
|
204
|
+
|
205
|
+
Documentation on the individual API calls provided by the library is automatically generated from the library code. To generate the documentation, please complete the following steps:
|
206
|
+
|
207
|
+
```
|
208
|
+
# not applicable
|
209
|
+
```
|
210
|
+
|
211
|
+
## Tests ##
|
212
|
+
|
213
|
+
Automated unit tests are available in tests folder. To run the tests, please complete the following steps.
|
214
|
+
|
215
|
+
```
|
216
|
+
rake spec
|
217
|
+
```
|
218
|
+
|
219
|
+
The above will also display tests & code coverage information.
|
220
|
+
|
221
|
+
```
|
222
|
+
# not applicable
|
223
|
+
```
|
224
|
+
|
225
|
+
The resulting report can be viewed by opening htmlcov/index.html in your browser.
|
226
|
+
|
227
|
+
## Dependencies ##
|
228
|
+
|
229
|
+
This library has the following **install** dependencies. These are installed automatically as part of the 'make setup' or 'gem install adp-product-userinfo' if they don't exist.
|
230
|
+
|
231
|
+
* json
|
232
|
+
* adp-connection
|
233
|
+
|
234
|
+
This library has the following **development/test** dependencies. These are installed automatically as part of the 'make setup' if they don't exist.
|
235
|
+
|
236
|
+
* bundler
|
237
|
+
* rake
|
238
|
+
* rspec
|
239
|
+
|
240
|
+
## Contributing ##
|
241
|
+
|
242
|
+
To contribute to the library, please generate a pull request. Before generating the pull request, please insure the following:
|
243
|
+
|
244
|
+
1. Appropriate unit tests have been updated or created.
|
245
|
+
2. Code coverage on the unit tests must be no less than 95%.
|
246
|
+
3. Your code updates have been fully tested.
|
247
|
+
4. Update README.md and API documentation as appropriate.
|
248
|
+
|
249
|
+
Author: Junior Napier
|
250
|
+
|
251
|
+
## License ##
|
252
|
+
The gem is available as open source under the terms of the Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0).
|
253
|
+
|