onelogin 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d58de3abd209ce7e6de060541a04cb2ccc403645
-  data.tar.gz: 01491005b2597087ba28e3cae0d4466129b4e453
+  metadata.gz: 8069da07a08e3fe1e504af1a9fc63291976e91c0
+  data.tar.gz: f042c302a74c09a7fd1b4b7ddc7e06de2b5d3220
 SHA512:
-  metadata.gz: b484d5d34ac1b711ce41d32c217ddaeefd19e2c8b55d057e02b560bf0146171a6a6956cbd1f0301ce215ef4bd3a7183535c30a11b8fd82e18715e1df358c8085
-  data.tar.gz: 326e7dc9c1485f2ba5322432038498e3bd8973f9b58e0847c612ad14a882a8cadbb74a58e2ff7cb7a42f8c318872a901a8466bc0f3418300ed4f02de5f199dce
+  metadata.gz: e57dbe81b5aed13dcac3a3eeef4fcc44daaccac3383d4e90703792100dff2e8010448e3b19b5e4b92c7c65bca0f15a68307d1a3715aa277d8cafeafb75b62f72
+  data.tar.gz: 57ce0509e3f806865283cbd8ca091a316cb8a16cf69d34bd25249a1d60ec5f06ec61eb17f655184251682c49ecae42259ca0d88e50089bd8c804d1a70c9a88be

data/README.md

@@ -74,6 +74,14 @@ if users.nil?
 end
 ```
 
+In some scenarios there is an attribute not provided or invalid that causes the error,
+when that happens in addition to the error_description a error_attribute is available
+with the name of the attribute that caused the issue. Accesible at the client like:
+
+```ruby
+client.error_attribute
+```
+
 ### Authentication
 
 By default methods call internally to `get_access_token` if there is no valid access_token. You can also get tokens etc directly if needed.
@@ -312,7 +320,7 @@ enroll_factor = client.enroll_factor(user_id, auth_factors.first.id, 'My Device'
 
 # Get Enrolled Authentication Factors
 otp_devices = client.get_enrolled_factors(user_id)
- 
+
 # Activate an Authentication Factor
 device_id = 0000000
 enrollment_response = client.activate_factor(user_id, device_id)
@@ -334,6 +342,26 @@ embed_token = "30e256c101cd0d2e731de1ec222e93c4be8a1572"
 apps = client.get_embed_apps("30e256c101cd0d2e731de1ec222e93c4be8a1572", "user@example.com")
 ```
 
+## Proxy Servers
+If you're stuck behind a proxy then you can still use this SDK by providing at a minimum the
+host address of your proxy server.
+
+```ruby
+client = OneLogin::Api::Client.new(
+  client_id: 'some-client-id',
+  client_secret:'some-client-secret',
+  region: 'us',
+  proxy_host: 'https://blah.com',
+  proxy_port: '8080',
+  proxy_user: 'username',
+  proxy_pass: 'password'
+)
+```
+
+* `proxy_host` - required, the host address of your proxy server
+* `proxy_port` - optional, the port number of your proxy server
+* `proxy_user` - optional, the username for your proxy server
+* `proxy_pass` - optional, the password for your proxy server
 
 ## Development
 

data/examples/Gemfile.lock

@@ -1,13 +1,13 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    httparty (0.16.0)
+    httparty (0.16.2)
       multi_xml (>= 0.5.2)
     mini_portile2 (2.3.0)
     multi_xml (0.6.0)
-    nokogiri (1.8.2)
+    nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
-    onelogin (1.0.1)
+    onelogin (1.2.1)
       httparty (>= 0.13.7)
       nokogiri (>= 1.6.3.1)
 

data/examples/events-to-csv.rb

@@ -24,10 +24,10 @@ OptionParser.new do |opts|
     options[:since] = s.iso8601
   end
 
-  opts.on("-lLAST", "--LAST=LAST", Time, "Events since this many days ago") do |d|
+  opts.on("-lLAST", "--LAST=LAST", Integer, "Events since this many days ago") do |d|
     now = Date.today
     days_ago = (now - d)
-    options[:since] = days_ago.iso8601
+    options[:since] = days_ago.strftime('%Y-%m-%dT%H:%M:%SZ')
   end
 
   opts.on("-uUNTIL", "--UNTIL=UNTIL", Time, "Events before this date") do |u|
@@ -42,12 +42,12 @@ OptionParser.new do |opts|
     options[:event_type_id] = t
   end
 
-  opts.on("-uTYPE", "--user=TYPE", Integer, "Filter by user id") do |u|
+  opts.on("-uUSER", "--user=USER", Integer, "Filter by user id") do |u|
     options[:user_id] = u
   end
 
   # Sort direction is done by adding a + or - before the field name that you want to sort on
-  opts.on("-zTYPE", "--sort=TYPE", String, "Sort by this field") do |s|
+  opts.on("-zSORT", "--sort=SORT", String, "Sort by this field") do |s|
     options[:sort] = s
   end
 end.parse!

data/examples/last-app-user-login-to-csv.rb

@@ -0,0 +1,71 @@
+require 'onelogin'
+require 'optparse'
+require 'optparse/time'
+
+#
+# This generates a report listing the last login date for all users who have logged into a specified app in the last x days.
+#
+# Usage:
+# 1. Set your own CLIENT_ID and CLIENT_SECRET below
+# 2. From terminal run "ruby last-app-user-login-to-csv.rb"
+# 3. Use the command line args to filter events
+#
+# e.g. "ruby last-app-user-login-to-csv.rb -l 90" for last 90 days
+#
+
+
+# Parse CLI arguments
+options = {
+  event_type_id: 8, # User Logged into an App
+  sort: '-created_at'
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: last-app-user-login-to-csv.rb [options]"
+
+  opts.on("-lLAST", "--LAST=LAST", Integer, "Events since this many days ago") do |d|
+    now = Date.today
+    days_ago = (now - d)
+    options[:since] = days_ago.strftime('%Y-%m-%dT%H:%M:%SZ')
+  end
+
+end.parse!
+
+client = OneLogin::Api::Client.new(
+  client_id: 'ONELOGIN_CLIENT_ID_GOES_HERE',
+  client_secret: 'ONELOGIN_CLIENT_SECRET_GOES_HERE',
+  region: 'us'
+)
+
+counter = 0
+
+logins = {}
+
+# build a hash from events which contains user_id and latest login date
+client.get_events(options).each do |event|
+  key = "#{event.app_id}-#{event.user_id}"
+
+  unless logins[key]
+    logins[key] = {
+      app_id: event.app_id,
+      app_name: event.app_name,
+      user_id: event.user_id,
+      user_name: event.user_name,
+      last_login_at: event.created_at
+    }
+  end
+end
+
+CSV.open('last-login-by-app.csv', 'wb') do |csv|
+  puts "Exporting user logins to last-login-by-app.csv"
+
+  # header row
+  csv << ['app_id', 'app_name', 'user_id', 'user_name', 'last_login_at']
+
+  logins.each do |login|
+    csv << login[1].values
+    counter += 1
+  end
+end
+
+puts "Exported #{counter} user logins to last-login-by-app.csv"

data/lib/onelogin/api/client.rb

@@ -16,9 +16,10 @@ module OneLogin
   	#
     class Client
       include OneLogin::Api::Util
+      include HTTParty
 
       attr_accessor :client_id, :client_secret, :region
-      attr_accessor :user_agent, :error, :error_description
+      attr_accessor :user_agent, :error, :error_description, :error_attribute
 
       NOKOGIRI_OPTIONS = Nokogiri::XML::ParseOptions::STRICT |
                          Nokogiri::XML::ParseOptions::NONET
@@ -37,6 +38,10 @@ module OneLogin
         @region = options[:region] || 'us'
         @max_results = options[:max_results] || 1000
 
+        if options[:proxy_host]
+          self.class.http_proxy options[:proxy_host], options[:proxy_port], options[:proxy_user], options[:proxy_pass]
+        end
+
         validate_config
 
         @user_agent = DEFAULT_USER_AGENT
@@ -51,6 +56,7 @@ module OneLogin
       def clean_error
         @error = nil
         @error_description = nil
+        @error_attribute = nil
       end
 
       def extract_error_message_from_response(response)
@@ -59,7 +65,13 @@ module OneLogin
         if content && content.has_key?('status')
           status = content['status']
           if status.has_key?('message')
-            message = status['message']
+            if status['message'].instance_of?(Hash)
+              if status['message'].has_key?('description')
+                message = status['message']['description']
+              end
+            else
+              message = status['message']
+            end
           elsif status.has_key?('type')
             message = status['type']
           end
@@ -67,6 +79,20 @@ module OneLogin
         message
       end
 
+      def extract_error_attribute_from_response(response)
+        attribute = nil
+        content = JSON.parse(response.body)
+        if content && content.has_key?('status')
+          status = content['status']
+          if status.has_key?('message') && status['message'].instance_of?(Hash)
+            if status['message'].has_key?('attribute')
+              attribute = status['message']['attribute']
+            end
+          end
+        end
+        attribute
+      end
+
       def expired?
         Time.now.utc > @expiration
       end
@@ -168,7 +194,7 @@ module OneLogin
             'grant_type' => 'client_credentials'
           }
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers(false),
             body: data.to_json
@@ -210,7 +236,7 @@ module OneLogin
             'refresh_token' => @refresh_token
           }
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: headers,
             body: data.to_json
@@ -250,7 +276,7 @@ module OneLogin
             access_token: @access_token
           }
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers(false),
             body: data.to_json
@@ -285,7 +311,7 @@ module OneLogin
         begin
           url = url_for(GET_RATE_URL)
 
-          response = HTTParty.get(
+          response = self.class.get(
             url,
             headers: authorized_headers
           )
@@ -327,7 +353,8 @@ module OneLogin
             model: OneLogin::Api::Models::User,
             headers: authorized_headers,
             max_results: @max_results,
-            params: params
+            params: params,
+            client: self.class
           }
 
           return Cursor.new(url_for(GET_USERS_URL), options)
@@ -355,7 +382,7 @@ module OneLogin
 
           url = url_for(GET_USER_URL, user_id)
 
-          response = HTTParty.get(
+          response = self.class.get(
             url,
             headers: authorized_headers
           )
@@ -419,7 +446,7 @@ module OneLogin
         begin
           url = url_for(GET_ROLES_FOR_USER_URL, user_id)
 
-          response = HTTParty.get(
+          response = self.class.get(
             url,
             headers: authorized_headers
           )
@@ -454,7 +481,7 @@ module OneLogin
         begin
           url = url_for(GET_CUSTOM_ATTRIBUTES_URL)
 
-          response = HTTParty.get(
+          response = self.class.get(
             url,
             headers: authorized_headers
           )
@@ -498,7 +525,7 @@ module OneLogin
         begin
           url = url_for(CREATE_USER_URL)
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers,
             body: user_params.to_json
@@ -512,6 +539,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -541,7 +569,7 @@ module OneLogin
         begin
           url = url_for(UPDATE_USER_URL, user_id)
 
-          response = HTTParty.put(
+          response = self.class.put(
             url,
             headers: authorized_headers,
             body: user_params.to_json
@@ -555,6 +583,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -583,7 +612,7 @@ module OneLogin
             'role_id_array' => role_ids
           }
 
-          response = HTTParty.put(
+          response = self.class.put(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -594,6 +623,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -622,7 +652,7 @@ module OneLogin
             'role_id_array' => role_ids
           }
 
-          response = HTTParty.put(
+          response = self.class.put(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -633,6 +663,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -665,7 +696,7 @@ module OneLogin
             'validate_policy' => validate_policy
           }
 
-          response = HTTParty.put(
+          response = self.class.put(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -676,6 +707,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -713,7 +745,7 @@ module OneLogin
             data['password_salt'] = password_salt
           end
 
-          response = HTTParty.put(
+          response = self.class.put(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -724,6 +756,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -752,7 +785,7 @@ module OneLogin
             'state' => state
           }
 
-          response = HTTParty.put(
+          response = self.class.put(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -763,6 +796,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -791,7 +825,7 @@ module OneLogin
             'custom_attributes' => custom_attributes
           }
 
-          response = HTTParty.put(
+          response = self.class.put(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -802,6 +836,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -825,7 +860,7 @@ module OneLogin
         begin
           url = url_for(LOG_USER_OUT_URL, user_id)
 
-          response = HTTParty.put(
+          response = self.class.put(
             url,
             headers: authorized_headers
           )
@@ -835,6 +870,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -865,7 +901,7 @@ module OneLogin
             'locked_until' => minutes
           }
 
-          response = HTTParty.put(
+          response = self.class.put(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -876,6 +912,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -899,7 +936,7 @@ module OneLogin
         begin
           url = url_for(DELETE_USER_URL, user_id)
 
-          response = HTTParty.delete(
+          response = self.class.delete(
             url,
             headers: authorized_headers
           )
@@ -909,6 +946,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -941,7 +979,7 @@ module OneLogin
             raise "username_or_email, password and subdomain are required parameters"
           end
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers.merge({ 'Custom-Allowed-Origin-Header-1' => allowed_origin }),
             body: query_params.to_json
@@ -986,7 +1024,7 @@ module OneLogin
             data['otp_token'] = otp_token
           end
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers.merge({ 'Custom-Allowed-Origin-Header-1' => allowed_origin }),
             body: data.to_json
@@ -1054,7 +1092,7 @@ module OneLogin
         begin
           url = url_for(GET_ROLE_URL, role_id)
 
-          response = HTTParty.get(
+          response = self.class.get(
             url,
             headers: authorized_headers
           )
@@ -1149,7 +1187,7 @@ module OneLogin
         begin
           url = url_for(GET_EVENT_URL, event_id)
 
-          response = HTTParty.get(
+          response = self.class.get(
             url,
             headers: authorized_headers
           )
@@ -1191,7 +1229,7 @@ module OneLogin
         begin
           url = url_for(CREATE_EVENT_URL)
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers,
             body: event_params.to_json
@@ -1202,6 +1240,7 @@ module OneLogin
           else
             @error = response.code.to_s
             @error_description = extract_error_message_from_response(response)
+            @error_attribute = extract_error_attribute_from_response(response)
           end
         rescue Exception => e
           @error = '500'
@@ -1256,7 +1295,7 @@ module OneLogin
         begin
           url = url_for(GET_GROUP_URL, group_id)
 
-          response = HTTParty.get(
+          response = self.class.get(
             url,
             headers: authorized_headers
           )
@@ -1311,7 +1350,7 @@ module OneLogin
             data['ip_address'] = ip_address
           end
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -1364,7 +1403,7 @@ module OneLogin
             data['otp_token'] = otp_token
           end
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -1402,7 +1441,7 @@ module OneLogin
         begin
           url = url_for(GET_FACTORS_URL, user_id)
 
-          response = HTTParty.get(
+          response = self.class.get(
             url,
             :headers => authorized_headers
           )
@@ -1451,7 +1490,7 @@ module OneLogin
             'number'=> number
           }
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             :headers => authorized_headers,
             body: data.to_json
@@ -1488,7 +1527,7 @@ module OneLogin
         begin
           url = url_for(GET_ENROLLED_FACTORS_URL, user_id)
 
-          response = HTTParty.get(
+          response = self.class.get(
             url,
             :headers => authorized_headers
           )
@@ -1530,7 +1569,7 @@ module OneLogin
         begin
           url = url_for(ACTIVATE_FACTOR_URL, user_id, device_id)
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers
           )
@@ -1587,7 +1626,7 @@ module OneLogin
             data['state_token'] = state_token
           end
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -1622,7 +1661,7 @@ module OneLogin
         begin
           url = url_for(REMOVE_FACTOR_URL, user_id, device_id)
 
-          response = HTTParty.delete(
+          response = self.class.delete(
             url,
             :headers => authorized_headers
           )
@@ -1664,7 +1703,7 @@ module OneLogin
             'email'=> email
           }
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -1712,7 +1751,7 @@ module OneLogin
             data['personal_email'] = personal_email
           end
 
-          response = HTTParty.post(
+          response = self.class.post(
             url,
             headers: authorized_headers,
             body: data.to_json
@@ -1744,7 +1783,7 @@ module OneLogin
         clean_error
 
         begin
-          response = HTTParty.get(
+          response = self.class.get(
             EMBED_APP_URL,
             headers: {
               'User-Agent' => @user_agent

data/lib/onelogin/api/cursor.rb

@@ -19,6 +19,7 @@ class Cursor
     @headers = options[:headers] || {}
     @params = options[:params] || {}
     @max_results = options[:max_results]
+    @client = options[:client]
 
     @collection = []
     @after_cursor = options.fetch(:after_cursor, nil)
@@ -49,7 +50,7 @@ class Cursor
   def fetch_next_page
     @params = @params.merge(after_cursor: @after_cursor) if @after_cursor
 
-    response = HTTParty.get(
+    response = @client.get(
       @url,
       headers: @headers,
       query: @params

data/lib/onelogin/version.rb

@@ -1,3 +1,3 @@
 module OneLogin
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onelogin
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - OneLogin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -105,6 +105,7 @@ files:
 - examples/all-users-to-csv.rb
 - examples/create-user.rb
 - examples/events-to-csv.rb
+- examples/last-app-user-login-to-csv.rb
 - examples/list-users.rb
 - examples/rails-custom-login-page/.gitignore
 - examples/rails-custom-login-page/.ruby-version