adp-product-userinfo 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/adp-product-userinfo.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adp/product/userinfo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "adp-product-userinfo"
+  spec.version       = Adp::Product::Userinfo::VERSION
+  spec.authors       = ["Napier, Junior (CORP)"]
+  spec.email         = ["Junior.Napier@gmail.com"]
+  # spec.owners        = ["ADP Marketplace, ADP Inc."]
+
+  spec.summary       = %q{ADP Ruby UserInfo product client library to get the logged-in user's info.}
+  spec.description   = %q{The ADP UserInfo Product Library can be used to obtain basic information about the user that is logged-in to the ADP application. The Library includes a sample 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.}
+  spec.homepage      = "https://github.com/adplabs/adp-userinfo-ruby"
+  spec.license       = "Apache-2.0"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency "uri"
+  # spec.add_dependency "net/https"
+  # spec.add_dependency "base64"
+  spec.add_dependency "json", '~> 1.8'
+  # spec.add_dependency 'securerandom'
+  spec.add_dependency 'adp-connection'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "adp/product/userinfo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/democlient/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org/"
+
+# adp library
+gem "adp-connection"
+gem "adp-product-userinfo"
+
+# App Stack
+gem "sinatra", "~> 1.4"
+gem "sinatra-config-file"
+
+
+group :development do
+  gem "rake", "~> 10.0"
+  gem "minitest", "~> 5.2"
+  gem "rack-test", "~> 0.6"
+end

data/democlient/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    adp-connection (0.1.1)
+      json (~> 1.8)
+    adp-product-userinfo (0.1.0)
+      adp-connection
+      json (~> 1.8)
+    backports (3.6.8)
+    json (1.8.3)
+    minitest (5.8.4)
+    multi_json (1.11.2)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (10.5.0)
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-config-file (1.0)
+      sinatra-contrib
+    sinatra-contrib (1.4.6)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adp-connection
+  adp-product-userinfo
+  minitest (~> 5.2)
+  rack-test (~> 0.6)
+  rake (~> 10.0)
+  sinatra (~> 1.4)
+  sinatra-config-file
+
+BUNDLED WITH
+   1.11.2

data/democlient/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/democlient/README.md

@@ -0,0 +1,2 @@
+# adp-userinfo-ruby
+ADP Ruby UserInfo product client library to get the logged-in user's info

data/democlient/Rakefile

@@ -0,0 +1,9 @@
+%w{ bundler find rake/testtask}.each { |lib| require lib }
+
+task :default => :spec
+
+Rake::TestTask.new(:spec) do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+end
+
+

data/democlient/adp_userinfo_ruby.rb

@@ -0,0 +1,216 @@
+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
+  }
+
+
+  before do
+
+    # request.path_info = '/foo/bar/baz'
+  end
+
+  after do
+      # erb :welcome, :locals => { :view_bag => results }
+  end
+
+  get "/" do
+    results[:message] = nil
+    erb :welcome, :locals => { :view_bag => results }
+  end
+
+  get '/client_credentials' do
+    results[:auth_type] = :client_credentials
+    results[:message] = nil
+
+    erb :client_credentials, :locals => { :view_bag => results }
+  end
+
+  get '/client_credentials/logout' do
+      session["ClientCredential"] = nil
+      results[:message] = nil
+      results[:auth_type] = :client_credentials
+      results[:userinfo] = nil
+
+      erb :client_credentials, :locals => { :view_bag => results }
+  end
+
+  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' do
+    results[:message] = nil
+    results[:auth_type] = :authorization_code
+    erb :authorization_code, :locals => { :view_bag => results}
+  end
+
+  get '/authorization_code/logout' do
+    session["AuthorizationCode"] = nil
+    results[:message] = nil
+    results[:auth_type] = :authorization_code
+    results[:userinfo] = nil
+
+    erb :authorization_code, :locals => { :view_bag => results }
+  end
+
+  get '/authorization_code/login' do
+    connection = session["AuthorizationCode"]
+    results[:message] = nil
+    authorizationurl = nil
+    results[:userinfo] = nil
+
+    if (connection.nil?)
+
+      # get new connection configuration
+      # YAML config object placed in yaml configuration files
+      config = YAML.load_file('config/authorizationcode_config.yml');
+
+      if (config.nil? || !config) then
+        results[:message] = "Unable to load configuration settings from file (config/authorizationcode_config.yml)"
+      else
+        begin
+          authorizationcode_config = Adp::Connection::AuthorizationCodeConfiguration.new(config);
+
+          Log.debug("Configuration from file was #{authorizationcode_config}")
+          connection = Adp::Connection::ApiConnectionFactory::createConnection(authorizationcode_config)
+
+          Log.debug("Connection object was #{connection}")
+          session["AuthorizationCode"] = connection;
+        end
+      end
+    end
+
+    authorizationurl = connection.get_authorization_url
+
+    Log.debug("Redirecting to authorizationurl #{authorizationurl} from connection #{connection}")
+
+    results[:auth_type] = :authorization_code
+    results[:authorizationurl] = authorizationurl
+
+    redirect authorizationurl unless authorizationurl.nil?
+
+    erb :authorization_code, :locals => { :view_bag => results}
+  end
+
+  get '/callback' do
+    results[:auth_type] = :authorization_code
+    results[:message] = nil
+
+    if !params[:error].nil?
+      results[:message] = "Callback Error: #{params[:error]}"
+    else
+      if params[:code].nil?
+        results[:message] = "Callback Error: Unauthorized"
+      else
+        connection = session["AuthorizationCode"]
+        unless connection.nil?
+          connection.connection_configuration.authorizationCode = params[:code]
+          Log.debug("Got authorization code #{connection.connection_configuration.authorizationCode}")
+        end
+      end
+    end
+    Log.debug("Back to callback with #{params[:code]}")
+    erb :authorization_code, :locals => { :view_bag => results}
+  end
+
+  get '/authorization_code/get_token' do
+    results[:auth_type] = :authorization_code
+    results[:message] = nil
+    results[:userinfo] = nil
+    connection = session["AuthorizationCode"]
+
+    begin
+      unless connection.nil? || connection.connection_configuration.authorizationCode.nil?
+        connection.connect()
+        session["AuthorizationCode"] = connection
+      end
+    rescue Adp::Connection::ConnectionException
+      e = env['sinatra.error']
+      results[:message] = "Connection error: The requested token could not be retrieved"
+    end
+
+    erb :authorization_code, :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