onelogin 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0b09f92686da99fbe19429f8ae65da9962f97a0
-  data.tar.gz: 8fe313cf382979cc481a5bb26961ca4091a615d3
+  metadata.gz: 891448f2f234475b2f392acef115af5b20424599
+  data.tar.gz: 7ebc413eef700591b78c3654d194595994e5d5a6
 SHA512:
-  metadata.gz: feaa630f6e10bbeaac2f783dfa4af64fb19afabbe4c6781745be745dce0f5fe52863d9ce7e7202f8be86b61d286ec211074c524b54475d7ae178a26f90b65207
-  data.tar.gz: 9276fb49aa63b3d9f2cc04ff089eeb5decd8c6b5329d7fe57bbd70e371c3b1f4784bf8a5cc486c4abbf2baaa487487240904a22feabc59e56c1d7d117141ea22
+  metadata.gz: 01f1f2c8dae4fcfc8606ae68bd8c18d8d1a664fc857da76af5fe7a5f04eb2a7e46c25cab9b1643016d893dbf5bae065c0c1e7a2348e7eb72f818ef3a1d2d63d6
+  data.tar.gz: b3fd44cb52795b239704b1879dd3d6695880705e52d32d6e7c52c2a9f37a260e3ede5ba36975d5d182ba57d8fccff72ce9edb65447a9aaaa3bfc50e4043a0b77

data/examples/rails-custom-login-page/app/assets/stylesheets/application.css

@@ -61,3 +61,15 @@ body {
   text-align: center;
 }
 
+form.edit div {
+  padding: 10px;
+}
+
+table.list {
+  width: 100%;
+}
+
+table.list tr td {
+  padding: 5px;
+  border-bottom: 1px #ccc solid;
+}

data/examples/rails-custom-login-page/app/controllers/users_controller.rb

@@ -0,0 +1,86 @@
+class UsersController < ApplicationController
+
+  before_action :require_current_user
+  before_action :set_user, only: [:show, :edit, :update, :destroy]
+
+  # GET /users
+  # GET /users.json
+  def index
+    @users = api_client.get_users.take(25) # only fetch the first 50 users
+  end
+
+  # GET /users/1
+  # GET /users/1.json
+  def show
+  end
+
+  # GET /users/new
+  def new
+    @user = User.new
+  end
+
+  # GET /users/1/edit
+  def edit
+  end
+
+  # POST /users
+  # POST /users.json
+  def create
+    @user = User.new(user_params)
+
+    respond_to do |format|
+      if @user.save
+        format.html { redirect_to @user, notice: 'User was successfully created.' }
+        format.json { render :show, status: :created, location: @user }
+      else
+        format.html { render :new }
+        format.json { render json: @user.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT /users/1
+  # PATCH/PUT /users/1.json
+  def update
+    # update the user
+    api_client.update_user(params[:id], user_params)
+
+    # update custom attributes
+    api_client.set_custom_attribute_to_user(params[:id], custom_user_params)
+
+    respond_to do |format|
+      unless api_client.error
+        format.html { redirect_to user_path(params[:id]), notice: 'User was successfully updated.' }
+        format.json { render :show, status: :ok, location: @user }
+      else
+        format.html { render :edit }
+        format.json { render json: @user.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /users/1
+  # DELETE /users/1.json
+  def destroy
+    @user.destroy
+    respond_to do |format|
+      format.html { redirect_to users_url, notice: 'User was successfully destroyed.' }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_user
+      @user = api_client.get_user(params[:id])
+    end
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def user_params
+      params.permit(:firstname, :lastname, :email, :phone, :custom_field)
+    end
+
+    def custom_user_params
+      params.permit(:custom_field)
+    end
+end

data/examples/rails-custom-login-page/app/helpers/users_helper.rb

@@ -0,0 +1,2 @@
+module UsersHelper
+end

data/examples/rails-custom-login-page/app/views/dashboard/index.html.erb

@@ -5,7 +5,7 @@
 </p>
 
 <p>
-  <a href="/logout">Log Out</a>
+  <a href="/users">List Users</a> | <a href="/logout">Log Out</a>
 </p>
 
 <h2>Apps</h2>

data/examples/rails-custom-login-page/app/views/users/_form.html.erb

@@ -0,0 +1 @@
+

data/examples/rails-custom-login-page/app/views/users/_user.json.jbuilder

@@ -0,0 +1,2 @@
+json.extract! user, :id, :created_at, :updated_at
+json.url user_url(user, format: :json)

data/examples/rails-custom-login-page/app/views/users/edit.html.erb

@@ -0,0 +1,27 @@
+<h1>Editing User</h1>
+
+<%= form_tag update_user_path, method: "patch", class: "edit" do %>
+
+  <div>
+    First Name: <input type="text" name="firstname" value="<%= @user.firstname%>">
+  </div>
+  <div>
+    Last Name: <input type="text" name="lastname" value="<%= @user.lastname%>">
+  </div>
+  <div>
+    Email: <input type="text" name="email" value="<%= @user.email%>">
+  </div>
+  <div>
+    Phone: <input type="text" name="phone" value="<%= @user.phone%>">
+  </div>
+  </div>
+  <div>
+    Custom Field: <input type="text" name="custom_field" value="<%= @user.custom_attributes['custom_field']%>">
+  </div>
+
+  <div class="actions">
+    <%= submit_tag %>
+  </div>
+<% end %>
+
+<%= link_to 'Back', users_path %>

data/examples/rails-custom-login-page/app/views/users/index.html.erb

@@ -0,0 +1,30 @@
+<p id="notice"><%= notice %></p>
+
+<h1>Users</h1>
+
+<table class="list">
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Email</th>
+      <th>Phone</th>
+      <th>Custom Field</th>
+      <th colspan="2"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @users.each do |user| %>
+      <tr>
+        <td><%= user.firstname %> <%= user.lastname %></td>
+        <td><%= user.email %></td>
+        <td><%= user.phone %></td>
+        <td><%= user.custom_attributes["custom_field"] if user.custom_attributes.is_a?(Hash) %></td>
+        <td><%= link_to 'Show', user_path(user.id) %></td>
+        <td><%= link_to 'Edit', edit_user_path(user.id) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>

data/examples/rails-custom-login-page/app/views/users/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @users, partial: 'users/user', as: :user

data/examples/rails-custom-login-page/app/views/users/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New User</h1>
+
+<%= render 'form', user: @user %>
+
+<%= link_to 'Back', users_path %>

data/examples/rails-custom-login-page/app/views/users/show.html.erb

@@ -0,0 +1,12 @@
+<p id="notice"><%= notice %></p>
+
+<%= link_to 'Edit', edit_user_path(@user.id) %> |
+<%= link_to 'Back', users_path %>
+
+<h2>Profile</h2>
+
+<%@user.instance_values.symbolize_keys.each do |k, v|%>
+  <div class="row">
+    <span><%= k%>:</span> <%= v%>
+  </div>
+<%end%>

data/examples/rails-custom-login-page/app/views/users/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "users/user", user: @user

data/examples/rails-custom-login-page/config/routes.rb

@@ -7,6 +7,11 @@ Rails.application.routes.draw do
 
   get 'dashboard', to: 'dashboard#index'
 
+  get 'users', to: 'users#index'
+  get 'users/:id', to: 'users#show', as: 'user'
+  get 'users/:id/edit', to: 'users#edit', as: 'edit_user'
+  patch 'users/:id', to: 'users#update', as: 'update_user'
+
   root 'home#index'
   # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
 end

data/examples/rails-custom-login-page/test/controllers/users_controller_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+class UsersControllerTest < ActionDispatch::IntegrationTest
+  setup do
+    @user = users(:one)
+  end
+
+  test "should get index" do
+    get users_url
+    assert_response :success
+  end
+
+  test "should get new" do
+    get new_user_url
+    assert_response :success
+  end
+
+  test "should create user" do
+    assert_difference('User.count') do
+      post users_url, params: { user: {  } }
+    end
+
+    assert_redirected_to user_url(User.last)
+  end
+
+  test "should show user" do
+    get user_url(@user)
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get edit_user_url(@user)
+    assert_response :success
+  end
+
+  test "should update user" do
+    patch user_url(@user), params: { user: {  } }
+    assert_redirected_to user_url(@user)
+  end
+
+  test "should destroy user" do
+    assert_difference('User.count', -1) do
+      delete user_url(@user)
+    end
+
+    assert_redirected_to users_url
+  end
+end

data/lib/onelogin/api/client.rb

@@ -110,15 +110,17 @@ module OneLogin
 
       def handle_saml_endpoint_response(response)
         content = JSON.parse(response.body)
-        if content && content.has_key?('status') && content.has_key?('data') && content['status'].has_key?('message') && content['status'].has_key?('type')
+        if content && content.has_key?('status') && content['status'].has_key?('message') && content['status'].has_key?('type')
           status_type = content['status']['type']
           status_message = content['status']['message']
           saml_endpoint_response = OneLogin::Api::Models::SAMLEndpointResponse.new(status_type, status_message)
-          if status_message == 'Success'
-            saml_endpoint_response.saml_response = content['data']
-          else
-            mfa = OneLogin::Api::Models::MFA.new(content['data'][0])
-            saml_endpoint_response.mfa = mfa
+          if content.has_key?('data')
+            if status_message == 'Success'
+              saml_endpoint_response.saml_response = content['data']
+            else
+              mfa = OneLogin::Api::Models::MFA.new(content['data'][0])
+              saml_endpoint_response.mfa = mfa
+            end
           end
 
           return saml_endpoint_response
@@ -731,6 +733,45 @@ module OneLogin
         false
       end
 
+      # Set User State
+      #
+      # @param id [Integer] Id of the user to be modified
+      # @param state [Integer] Set to the state value. [Unapproved: 0, Approved (licensed): 1, Rejected: 2, Unlicensed: 3]
+      #
+      # @return [Boolean] if the action succeed
+      #
+      # @see {https://developers.onelogin.com/api-docs/1/users/set-state Set User State documentation}
+      def set_state_to_user(user_id, state)
+        clean_error
+        prepare_token
+
+        begin
+          url = url_for(SET_USER_STATE_URL, user_id)
+
+          data = {
+            'state' => state
+          }
+
+          response = HTTParty.put(
+            url,
+            headers: authorized_headers,
+            body: data.to_json
+          )
+
+          if response.code == 200
+            return handle_operation_response(response)
+          else
+            @error = response.code.to_s
+            @error_description = extract_error_message_from_response(response)
+          end
+        rescue Exception => e
+          @error = '500'
+          @error_description = e.message
+        end
+
+        false
+      end
+
       # Set Custom Attribute Value
       #
       # @param user_id [Integer] Id of the user

data/lib/onelogin/api/models/user.rb

@@ -5,7 +5,7 @@ module OneLogin
       class User
 
         attr_accessor :id, :external_id, :email, :username, :firstname, :lastname, :distinguished_name,
-                      :phone, :company, :department, :status, :member_of, :samaccountname, :userprincipalname,
+                      :phone, :company, :department, :status, :state, :member_of, :samaccountname, :userprincipalname,
                       :group_id, :role_ids, :custom_attributes, :openid_name, :locale_code, :comment, :directory_id,
                       :title, :manager_ad_id, :trusted_idp_id, :activated_at, :created_at, :updated_at,
                       :password_changed_at, :invitation_sent_at, :invalid_login_attempts, :last_login, :locked_until
@@ -23,6 +23,7 @@ module OneLogin
           @department = data['department'].to_s
           @title = data['title'].to_s
           @status = data['status']
+          @state = data['state']
           @member_of = data['member_of'].to_s
           @samaccountname = data['samaccountname'].to_s
           @userprincipalname = data['userprincipalname'].to_s
@@ -66,6 +67,7 @@ module OneLogin
           user_data.department = @department
           user_data.title = @title
           user_data.status = @status
+          user_data.state = @state
           user_data.member_of = @member_of
           user_data.samaccountname = @samaccountname
           user_data.userprincipalname = @userprincipalname
@@ -110,6 +112,7 @@ module OneLogin
             "department"=> self.department,
             "title"=> self.title,
             "status"=> self.status,
+            "state"=> self.state,
             "member_of"=> self.member_of,
             "samaccountname"=> self.samaccountname,
             "invalid_login_attempts"=> self.invalid_login_attempts,

data/lib/onelogin/api/models/user_data.rb

@@ -5,7 +5,7 @@ module OneLogin
       class UserData
 
         attr_accessor :id, :external_id, :email, :username, :firstname, :lastname, :distinguished_name,
-                      :phone, :company, :department, :status, :member_of, :samaccountname, :userprincipalname,
+                      :phone, :company, :department, :status, :state, :member_of, :samaccountname, :userprincipalname,
                       :title, :openid_name, :locale_code, :directory_id, :manager_ad_id, :trusted_idp_id
       end
     end

data/lib/onelogin/api/util/constants.rb

@@ -10,7 +10,7 @@ module OneLogin
         # OAuth2 Tokens URLs
         TOKEN_REQUEST_URL = "https://api.%s.onelogin.com/auth/oauth2/v2/token"
         TOKEN_REFRESH_URL = "https://api.%s.onelogin.com/auth/oauth2/v2/token"
-        TOKEN_REVOKE_URL = "https://api.%s.onelogin.com/auth/oauth2/v2/revoke"
+        TOKEN_REVOKE_URL = "https://api.%s.onelogin.com/auth/oauth2/revoke"
         GET_RATE_URL = "https://api.%s.onelogin.com/auth/rate_limit"
 
         # User URLs
@@ -30,6 +30,7 @@ module OneLogin
         SET_PW_CLEARTEXT = "https://api.%s.onelogin.com/api/1/users/set_password_clear_text/%s"
         SET_PW_SALT = "https://api.%s.onelogin.com/api/1/users/set_password_using_salt/%s"
         SET_CUSTOM_ATTRIBUTE_TO_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s/set_custom_attributes"
+        SET_USER_STATE_URL = "https://api.%s.onelogin.com/api/1/users/%s/set_state"
         LOG_USER_OUT_URL = "https://api.%s.onelogin.com/api/1/users/%s/logout"
         LOCK_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s/lock_user"
 

data/lib/onelogin/version.rb

@@ -1,3 +1,3 @@
 module OneLogin
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onelogin
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - OneLogin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -131,10 +131,12 @@ files:
 - examples/rails-custom-login-page/app/controllers/dashboard_controller.rb
 - examples/rails-custom-login-page/app/controllers/home_controller.rb
 - examples/rails-custom-login-page/app/controllers/sessions_controller.rb
+- examples/rails-custom-login-page/app/controllers/users_controller.rb
 - examples/rails-custom-login-page/app/helpers/application_helper.rb
 - examples/rails-custom-login-page/app/helpers/dashboard_helper.rb
 - examples/rails-custom-login-page/app/helpers/home_helper.rb
 - examples/rails-custom-login-page/app/helpers/sessions_helper.rb
+- examples/rails-custom-login-page/app/helpers/users_helper.rb
 - examples/rails-custom-login-page/app/jobs/application_job.rb
 - examples/rails-custom-login-page/app/mailers/application_mailer.rb
 - examples/rails-custom-login-page/app/models/application_record.rb
@@ -144,6 +146,14 @@ files:
 - examples/rails-custom-login-page/app/views/layouts/application.html.erb
 - examples/rails-custom-login-page/app/views/layouts/mailer.html.erb
 - examples/rails-custom-login-page/app/views/layouts/mailer.text.erb
+- examples/rails-custom-login-page/app/views/users/_form.html.erb
+- examples/rails-custom-login-page/app/views/users/_user.json.jbuilder
+- examples/rails-custom-login-page/app/views/users/edit.html.erb
+- examples/rails-custom-login-page/app/views/users/index.html.erb
+- examples/rails-custom-login-page/app/views/users/index.json.jbuilder
+- examples/rails-custom-login-page/app/views/users/new.html.erb
+- examples/rails-custom-login-page/app/views/users/show.html.erb
+- examples/rails-custom-login-page/app/views/users/show.json.jbuilder
 - examples/rails-custom-login-page/bin/bundle
 - examples/rails-custom-login-page/bin/rails
 - examples/rails-custom-login-page/bin/rake
@@ -190,6 +200,7 @@ files:
 - examples/rails-custom-login-page/test/controllers/dashboard_controller_test.rb
 - examples/rails-custom-login-page/test/controllers/home_controller_test.rb
 - examples/rails-custom-login-page/test/controllers/sessions_controller_test.rb
+- examples/rails-custom-login-page/test/controllers/users_controller_test.rb
 - examples/rails-custom-login-page/test/fixtures/.keep
 - examples/rails-custom-login-page/test/fixtures/files/.keep
 - examples/rails-custom-login-page/test/helpers/.keep