adp-connection 0.1.1

data/democlient/spec/adp_connection_ruby_spec.rb

@@ -0,0 +1,14 @@
+require_relative "spec_helper"
+require_relative "../adp_connection_ruby.rb"
+
+def app
+  AdpConnectionRuby
+end
+
+describe AdpConnectionRuby do
+  it "responds with a welcome message" do
+    get '/'
+
+    last_response.body.must_include 'Welcome to the Sinatra Template!'
+  end
+end

data/democlient/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+require 'bundler'
+
+Bundler.setup
+Bundler.require
+
+ENV["RACK_ENV"] = "test"
+
+require 'minitest/pride'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'rack/test'
+
+
+require "find"
+%w{./config/initializers ./lib}.each do |load_path|
+  Find.find(load_path) { |f| require f if f.match(/\.rb$/) }
+end
+
+class MiniTest::Spec
+  include Rack::Test::Methods
+end

data/democlient/views/authorization_code.erb

@@ -0,0 +1,90 @@
+<div>
+  <p>
+    <strong>Authorization </strong><br/>
+    <a href="/client_credentials" style="width:185px;height:32px;display:inline-block;background-color:#ccc;padding:10px 10px 10px 5px;text-align: center;vertical-align: middle;">Client Credential</a>  &nbsp; &nbsp;
+    <span href="authorization_code" style="width:185px;height:32px;display:inline-block;background-color:#ccc;padding:10px 10px 10px 5px;text-align: center;vertical-align: middle;">Authentication Code</span>
+  </p>
+</div>
+
+<div class="content">
+  <ol>
+    <li><b>1.</b>
+      <% if session["AuthorizationCode"].nil? %>
+          <a href="/authorization_code/login">Login</a>
+        <% else %>
+        <a>Loged in</a>
+      <% end %>
+    <br/>
+    <code>
+<pre>
+authorizationcode_config = AuthorizationCodeConfiguration.new(config);
+connection = ADPApiConnectionFactory::createConnection(authorizationcode_config)
+authorizationurl = connection.get_authorization_url
+redirect authorizationurl unless authorizationurl.nil?
+</pre>
+    </code>
+    </li>
+    <br/>
+    <li><b>2.</b>
+      <% if session["AuthorizationCode"].nil? || session["AuthorizationCode"].connection_configuration.authorizationCode.nil? %>
+          <a>Get Token</a>
+      <% else %>
+          <a href="/authorization_code/get_token">Get Token</a>
+      <% end %>
+      <br/>
+      <code>
+<pre>
+#store callback code
+connection.connection_configuration.authorizationCode = params[:code]
+#then connect
+connection.connect()
+</pre>
+      </code>
+    </li>
+
+    <% if !(session["AuthorizationCode"].nil? || session["AuthorizationCode"].connection_configuration.authorizationCode.nil?) %>
+
+        <li><b>4.</b>
+          <a href="/authorization_code/logout">Logout</a>
+          <code>
+
+            connection.logout()
+
+          </code>
+        </li>
+    <% end %>
+
+  </ol>
+
+</div>
+
+<div class="sidebar">
+  <h3>Results...</h3>
+  <ul>
+    <!--
+    <li><b>Ruby:</b> <%= RUBY_VERSION %></li>
+    <li><b>Environment:</b> <%= ENV["RACK_ENV"] %></li>
+    <li><b>Server:</b> <%= @env["SERVER_SOFTWARE"] %></li>
+    <li><b>Port:</b> <%= @env["SERVER_PORT"] %></li>
+    -->
+    <% if session["AuthorizationCode"].nil?  %>
+        <li><b>Access token:</b> not logged in</li>
+        <li>&nbsp;</li>
+        <li>&nbsp;</li>
+        <li>&nbsp;</li>
+        <li>&nbsp;</li>
+    <% else %>
+        <li><b>Authorization code:</b> <%= session["AuthorizationCode"].connection_configuration.authorizationCode %> </li>
+        <% unless session["AuthorizationCode"].access_token.nil? %>
+            <li><b>Access token:</b> <%= session["AuthorizationCode"].access_token.token %> </li>
+            <li><b>Token type:</b> <%= session["AuthorizationCode"].access_token.token_type %> </li>
+            <li><b>Expires in:</b> <%= session["AuthorizationCode"].access_token.expires_in %> </li>
+            <li><b>Scope:</b> <%= session["AuthorizationCode"].access_token.scope %> </li>
+            <li><b>Expires on:</b> <%= session["AuthorizationCode"].access_token.expires_on %> </li>
+        <% end %>
+    <% end %>
+  </ul>
+  <div class="results_footer" style="">
+    <a href="https://github.com/adplabs/adp-connection-ruby"><img class="sidebar_logo" src="/images/ADP_logo_tagline.png" alt="Marketplace/Ruby/Library" /></a>
+  </div>
+</div>

data/democlient/views/client_credentials.erb

@@ -0,0 +1,76 @@
+<div>
+  <p>
+    <strong>Authorization </strong><br/>
+    <span href="client_credentials" style="width:185px;height:32px;display:inline-block;background-color:#ccc;padding:10px 10px 10px 5px;text-align: center;vertical-align: middle;">Client Credential</span>  &nbsp; &nbsp;
+    <a href="/authorization_code" style="width:185px;height:32px;display:inline-block;background-color:#ccc;padding:10px 10px 10px 5px;text-align: center;vertical-align: middle;">Authentication Code</a>
+  </p>
+</div>
+
+<div class="content">
+  <ol>
+      <% if session["ClientCredential"].nil? %>
+        <li><b>1.</b>
+          <a href="/client_credentials/login">Login</a>
+          <code>
+<pre>
+clientcredential_config = ClientCredentialConfiguration.new(config);
+connection = ADPApiConnectionFactory::createConnection(clientcredential_config)
+connection.connect();
+</pre>
+          </code>
+          </li>
+      <% end %>
+      <% if !session["ClientCredential"].nil? %>
+        <li><b>1.</b>
+          <a>Logged in</a>
+          <code>
+<pre>
+clientcredential_config = ClientCredentialConfiguration.new(config);
+connection = ADPApiConnectionFactory::createConnection(clientcredential_config)
+connection.connect();
+</pre>
+          </code>
+        </li>
+        <br/>
+          <li><b>2.</b>
+          <a href="/client_credentials/logout">Logout</a>
+          <br/>
+          <code>
+
+            connection.logout()
+
+          </code>
+          </li>
+      <% end %>
+    <br/>
+    <!-- <li><b>2.</b> <a>Get Data</a></li> -->
+    <br/>
+  </ol>
+</div>
+
+<div class="sidebar">
+  <h3>Results...</h3>
+  <ul>
+    <!--
+    <li><b>Ruby:</b> <%= RUBY_VERSION %></li>
+    <li><b>Environment:</b> <%= ENV["RACK_ENV"] %></li>
+    <li><b>Server:</b> <%= @env["SERVER_SOFTWARE"] %></li>
+    <li><b>Port:</b> <%= @env["SERVER_PORT"] %></li>
+    -->
+
+    <% if session["ClientCredential"].nil? || session["ClientCredential"].access_token.nil? %>
+        <li><b>Access token:</b> not logged in</li>
+    <% else %>
+        <li><b>Access token:</b> <%= session["ClientCredential"].access_token.token %> </li>
+        <li><b>Token type:</b> <%= session["ClientCredential"].access_token.token_type %> </li>
+        <li><b>Expires in:</b> <%= session["ClientCredential"].access_token.expires_in %> </li>
+        <li><b>Scope:</b> <%= session["ClientCredential"].access_token.scope %> </li>
+        <li><b>Expires on:</b> <%= session["ClientCredential"].access_token.expires_on %> </li>
+    <% end %>
+    <li>&nbsp;</li>
+  </ul>
+
+  <div class="results_footer">
+    <a href="https://github.com/adplabs/adp-connection-ruby"><img class="sidebar_logo" src="/images/ADP_logo_tagline.png" alt="Marketplace/Ruby/Library" /></a>
+  </div>
+</div>

data/democlient/views/layout.erb

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
+<!--[if IE 7]>    <html class="no-js ie7 oldie" lang="en"> <![endif]-->
+<!--[if IE 8]>    <html class="no-js ie8 oldie" lang="en"> <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
+<head>
+  <meta charset="utf-8" />
+  <meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1" />
+
+  <title>Adp Connection API Library (Ruby)</title>
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+
+  <link rel="stylesheet" href="/stylesheets/main.css" />
+</head>
+<body>
+  <div class="wrapper">
+    <header class="branding">
+      <h1>Adp Connection API Library (Ruby)</h1>
+    </header>
+
+    <div class="main">
+      <%= yield %>
+    </div>
+
+    <footer class="branding error">
+      <%= view_bag[:message] %>
+      <hr/>
+      <small>&copy; <%= Time.now.year %></small>
+      <hr/>
+    </footer>
+  </div>
+
+  <script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>
+  <!--[if lt IE 7]>
+    <script src="//ajax.googleapis.com/ajax/libs/chrome-frame/1.0.2/CFInstall.min.js"></script>
+    <script>window.attachEvent("onload",function(){CFInstall.check({mode:"overlay"})})</script>
+  <![endif]-->
+</body>
+

data/democlient/views/welcome.erb

@@ -0,0 +1,34 @@
+<div>
+  <p>
+    <strong>Authorization </strong><br/>
+    <a href="/client_credentials" style="width:185px;height:32px;display:inline-block;background-color:#ccc;padding:10px 10px 10px 5px;text-align: center;vertical-align: middle;">Client Credential</a>  &nbsp; &nbsp;
+    <a href="/authorization_code" style="width:185px;height:32px;display:inline-block;background-color:#ccc;padding:10px 10px 10px 5px;text-align: center;vertical-align: middle;">Authentication Code</a>
+  </p>
+</div>
+
+<div class="content">
+  <ol>
+  </ol>
+</div>
+
+<div class="sidebar">
+  <h3>Results...</h3>
+  <ul>
+    <!--
+    <li><b>Ruby:</b> <%= RUBY_VERSION %></li>
+    <li><b>Environment:</b> <%= ENV["RACK_ENV"] %></li>
+    <li><b>Server:</b> <%= @env["SERVER_SOFTWARE"] %></li>
+    <li><b>Port:</b> <%= @env["SERVER_PORT"] %></li>
+    -->
+
+    <li></li>
+    <li></li>
+    <li></li>
+    <li></li>
+    <li></li>
+    <li></li>
+  </ul>
+  <div class="results_footer">
+    <a href="https://github.com/adplabs/adp-connection-ruby"><img class="sidebar_logo" src="/images/ADP_logo_tagline.png" alt="Marketplace/Ruby/Library" /></a>
+  </div>
+</div>

data/lib/adp/access_token.rb

@@ -0,0 +1,44 @@
+module Adp
+  module Connection
+
+    class AccessToken
+      attr_accessor :token
+      attr_accessor :token_type
+      attr_accessor :scope
+      attr_accessor :expires_on
+      attr_accessor :token
+      attr_accessor :_expires_in
+
+      # @return [Object]
+      def initialize(config = nil)
+
+        unless config.nil?
+          self.token = config["access_token"]
+          self.token_type = config["token_type"]
+          self.scope = config["scope"]
+          self.expires_in = config["expires_in"]
+        end
+      end
+
+      # @return [Object]
+      def expires_in=(value)
+        unless value.nil?
+          self._expires_in = value
+          self.expires_on = Time.new() + self._expires_in
+        end
+        self.expires_on
+      end
+
+      # @return [Object]
+      def expires_in
+        return self._expires_in
+      end
+
+      def is_valid?
+        return true;
+      end
+    end
+  end
+end
+
+

data/lib/adp/api_connection.rb

@@ -0,0 +1,153 @@
+require 'uri'
+require 'net/https'
+require 'base64'
+require 'json'
+
+require_relative "connection_configuration"
+require_relative 'access_token'
+require_relative "connection_exception"
+require_relative "api_connection"
+require_relative "client_credential_configuration"
+require_relative "authorization_code_configuration"
+
+module Adp
+  module Connection
+
+    class ApiConnection
+        attr_accessor :connection_configuration
+        attr_accessor :token_expiration
+        attr_accessor :state
+        attr_accessor :access_token
+
+        # @param [Object] config
+        def initialize( config = nil )
+            self.connection_configuration = config;
+        end
+
+        def connect
+
+            if self.connection_configuration.nil?
+                raise ADPConnectionException, "Configuration is empty or not found"
+            end
+
+            self.access_token = get_access_token()
+        end
+
+        def disconnect
+            self.access_token = null;
+        end
+
+        # @return [Boolean]
+        def is_connected_indicator?
+
+            is_connected = false;
+
+            if (!self.access_token.nil?)
+              # valid token to check if expired
+              is_connected = true if Time.new() < self.access_token.expires_on
+            end
+
+            return is_connected
+        end
+
+        def get_access_token
+            token = self.access_token;
+            result = nil;
+
+            if is_connected_indicator?
+
+                if self.connection_configuration.nil?
+                    raise ADPConnectionException, "Config error: Configuration is empty or not found"
+                end
+                if (self.connection_configuration.grantType.nil?)
+                    raise ADPConnectionException, "Config error: Grant Type is empty or not known"
+                end
+                if (self.connection_configuration.tokenServerURL.nil?)
+                    raise ADPConnectionException, "Config error: tokenServerURL is empty or not known"
+                end
+                if (self.connection_configuration.clientID.nil?)
+                    raise ADPConnectionException, "Config error: clientID is empty or not known"
+                end
+                if (self.connection_configuration.clientSecret.nil?)
+                    raise ADPConnectionException, "Config error: clientSecret is empty or not known"
+                end
+            end
+
+            data = {
+                "client_id" => self.connection_configuration.clientID,
+                "client_secret" => self.connection_configuration.clientSecret,
+                "grant_type" => self.connection_configuration.grantType
+            };
+
+            result = send_web_request(self.connection_configuration.tokenServerURL, data );
+
+            if result["error"].nil? then
+              token = AccessToken.new(result)
+            else
+              raise ADPConnectionException, "Connection error: #{result['error_description']}"
+            end
+
+           token
+        end
+
+        # @return [Object]
+        def get_adp_data(product_url)
+
+            raise ADPConnectionException, "Connection error: can't get data, not connected" if (self.access_token.nil? || !is_connected_indicator?)
+
+            authorization = "#{self.access_token.token_type} #{self.access_token.token}"
+
+            data = {
+                "client_id" => self.connection_configuration.clientID,
+                "client_secret" => self.connection_configuration.clientSecret,
+                "grant_type" => self.connection_configuration.grantType,
+                "code" => self.connection_configuration.authorizationCode,
+                "redirect_uri" => self.connection_configuration.redirectURL
+            };
+
+            data = send_web_request(product_url, data, authorization, 'application/json', 'GET')
+
+            raise ADPConnectionException, "Connection error: #{data['error']}, #{data['error_description']}" unless data["error"].nil?
+
+            return data
+        end
+
+        def send_web_request(url, data={}, authorization=nil, content_type=nil, method=nil)
+
+          data ||= {}
+          content_type ||= "application/x-www-form-urlencoded"
+          method ||= 'POST'
+
+            Log.debug("URL: #{url}")
+            Log.debug("Client ID: #{data["client_id"]}")
+            Log.debug("Client Secret: #{data["client_secret"]}")
+            Log.debug("Grant Type: #{data["grant_type"]}")
+
+            uri = URI.parse( url );
+            pem = File.read("#{self.connection_configuration.sslCertPath}");
+            key = File.read(self.connection_configuration.sslKeyPath);
+            http = Net::HTTP.new(uri.host, uri.port);
+            if (!self.connection_configuration.sslCertPath.nil?)
+                http.use_ssl = true
+                http.cert = OpenSSL::X509::Certificate.new( pem );
+                http.key = OpenSSL::PKey::RSA.new(key, self.connection_configuration.sslKeyPass);
+                http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+            end
+
+            if method.eql?('POST')
+              request = Net::HTTP::Post.new(uri.request_uri)
+              request.set_form_data( data );
+            else
+              request = Net::HTTP::Get.new(uri.request_uri)
+            end
+
+            request["Content-Type"] = content_type
+
+            # add credentials if available
+            request["Authorization"] = authorization unless authorization.nil?
+
+            response = JSON.parse(http.request(request).body)
+        end
+    end
+  end
+end