adp-product-userinfo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bfbd6a8ec974c83de5cc2ac74480636cd4d81f3
+  data.tar.gz: 1fcb6a0fa59f36ae9b76c00bb4eabcc38c5cf7e1
+SHA512:
+  metadata.gz: 9c0335a1cd1334e94cc2c66588c3bbb3dcd9d5335f8fac075d5ce75a37293e8acb10b513bcdd65540718808de0462460455126914841a053847f56b44ae16dc8
+  data.tar.gz: b4639bd14de9264890ea67a089a1a73fdaae93b79f8c7f38f41097d88fbfe42659188d5e940ce22ac7b5a9b4407b1983fb623625a43a921b14474a0d616f3f48

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,42 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at Junior.Napier-Contractor@adp.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in adp-product-userinfo.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,253 @@
+# ADP Userinfo Product Client Library for Ruby
+
+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.
+
+### Version
+1.0.0 (Beta)
+
+
+## Installation
+
+There are two ways of installing and using this library:
+
+  - 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
+  - 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
+
+
+**Clone from Github**
+
+You can either use the links on Github or the command line git instructions below to clone the repo.
+
+```sh
+
+$ git clone https://github.com/adplabs/adp-userinfo-ruby adp-userinfo-ruby
+
+```
+
+followed by
+
+```sh
+
+$ cd adp-userinfo-ruby
+$ rake -T
+$ rake install:local
+
+```
+
+*Run the sample demo client app*
+
+```sh
+
+$ cd ./democlient
+$ rackup
+
+```
+
+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).
+
+***
+
+
+**Clone from Github**
+
+Add this line to your application's Gemfile:
+
+```ruby
+
+gem 'adp-connection'
+gem 'adp-product-userinfo'
+
+```
+
+And then execute:
+
+```sh
+
+    $ bundle
+
+```
+
+Or install it yourself as:
+
+```sh
+
+    $ gem install adp-product-userinfo
+
+```
+
+## Usage
+
+Start using the library by requiring the gem in your ruby files
+
+```ruby
+
+require 'adp/connection'
+require 'adp/product/userinfo'
+
+```
+
+
+## Development
+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.
+
+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).
+
+A demo client is included that uses the adp-product-userinfo gem. Check it out.
+
+
+## Examples
+### Create Client Credentials ADP Connection
+
+Here is a Sinatra (http://www.sinatrarb.com/) example
+
+```ruby
+
+require 'yaml'
+require 'tilt/erb'
+require 'logger'
+require 'adp/connection'
+require 'adp/product/userinfo'
+
+clientcredential_config = YAML.load(ERB.new(File.read('config/clientcredential_config.yml')).result)
+authorizationcode_config = YAML.load(ERB.new(File.read('config/authorizationcode_config.yml')).result)
+
+configure do
+  Log = Logger.new(STDOUT);
+  #Logger.new("sinatra.log")
+  Log.level  = Logger::DEBUG
+end
+
+class AdpConnectionRuby < Sinatra::Base
+
+  enable :sessions
+  set :public_folder => "public", :static => true
+
+  #set :protection, :session => true
+  set :port, 8889
+
+  results = {
+      :message =>  "Welcome",
+      :auth_type => nil
+  }
+
+  get '/client_credentials/login' do
+    results[:auth_type] = :client_credentials
+    results[:message] = nil
+    connection = session["ClientCredential"]
+    results[:userinfo] = nil
+
+    if (connection.nil?)
+
+      # get new connection configuration
+      # YAML config object placed in yaml configuration files
+      config = YAML.load_file('config/clientcredential_config.yml');
+
+      if (!config || config.nil?)
+        results[:message] = "Unable to load configuration settings from file (config/clientcredential_config.yml)"
+      else
+        begin
+          clientcredential_config = Adp::Connection::ClientCredentialConfiguration.new(config);
+
+          connection = Adp::Connection::ApiConnectionFactory::createConnection(clientcredential_config)
+
+          connection.connect();
+
+          if (!connection.is_connected_indicator?)
+            results[:message] = "Error attempting to establish a connection"
+            Log.error "Not connected"
+          else
+            Log.debug("Connected and ready for getting data");
+            session["ClientCredential"] = connection;
+          end
+        end
+      end
+    end
+    erb :client_credentials, :locals => { :view_bag => results }
+  end
+
+
+  get '/authorization_code/get_userinfo' do
+    results[:auth_type] = :authorization_code
+    results[:message] = nil
+    connection = session["AuthorizationCode"]
+
+    begin
+      Log.debug("Do we have a connection object? #{connection}")
+      unless connection.nil? || connection.connection_configuration.authorizationCode.nil?
+        Log.debug("Check if we are connected: #{connection.access_token}")
+        if (connection.is_connected_indicator?)
+          Log.debug("Getting helper object")
+            helper = Adp::Product::Userinfo::Helper.new(connection)
+          Log.debug("getting userinfo using helper object")
+            json_data = helper.get_user_info()
+            results[:userinfo] = Adp::Product::DTO::Userinfo.new(json_data)
+
+            Log.debug("Got user info #{json_data}")
+        end
+      end
+      Log.debug("Done getting userinfo #{results[:userinfo]}")
+    rescue Adp::Connection::ConnectionException
+      e = env['sinatra.error']
+      results[:message] = "Connection error: #{e}"
+    end
+
+    erb :authorization_code, :locals => { :view_bag => results}
+  end
+
+end
+
+
+```
+
+
+## API Documentation ##
+
+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:
+
+```
+# not applicable
+```
+
+## Tests ##
+
+Automated unit tests are available in tests folder. To run the tests, please complete the following steps.
+
+```
+rake spec
+```
+
+The above will also display tests & code coverage information. 
+
+```
+# not applicable
+```
+
+The resulting report can be viewed by opening htmlcov/index.html in your browser.
+
+## Dependencies ##
+
+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.
+
+* json
+* adp-connection
+
+This library has the following **development/test** dependencies. These are installed automatically as part of the 'make setup' if they don't exist.
+
+* bundler
+* rake
+* rspec
+
+## Contributing ##
+
+To contribute to the library, please generate a pull request. Before generating the pull request, please insure the following:
+
+1. Appropriate unit tests have been updated or created.
+2. Code coverage on the unit tests must be no less than 95%.
+3. Your code updates have been fully tested.
+4. Update README.md and API documentation as appropriate.
+
+Author: Junior Napier
+
+## License ##
+The gem is available as open source under the terms of the Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0).
+