fusionauth_client 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e1af1d4d1609856fae8d8d8a6a2a26dbc8ff013b
-  data.tar.gz: 622bf5fc6df1e113e9b546f47fc3b582a38b114e
+SHA256:
+  metadata.gz: dc854aa03f670febd02bb2cc779f008016db68e0ecad374cc9b645ccb0a62080
+  data.tar.gz: dca34dc551c1364d229afb4fd67b9606f2c910adc8f8561398bf9d3386545f01
 SHA512:
-  metadata.gz: 5cc350be0b7397b81274060cb393c4ac45f8fa29b0cef74f0e103cb5d3150305082936aa82b00ea3cdba4d77368f45fbe417cd6256eb128246b0800f475be4d1
-  data.tar.gz: ef7457fd9c6436e22b145988e19e66decb628ae9b0caa9fa2531ac9ce4d4f36af0e6d7cb138707e17cce8ecd4ef0abf0fc1723dda7480d3cdf8d259464befa81
+  metadata.gz: be763a4bd39d86f6e77914061e5f2706fa9c2e4eb065a81bf4b3d0fed595ec20ea1d42dde57347b3e2e7767ac224405a4a0b0ffcbce3105ce0c181d777bb7568
+  data.tar.gz: 727c58a17b14d20e2f17bf110afff8ebf10f5a08855eda3302700875fe7bbcfd770175aabdfa8b90150596be8c301b511bbdfb75db1a77bd2d39cb6e514b89fd

data/build.savant

@@ -16,7 +16,7 @@
 savantVersion = "1.0.0"
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.3.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.4.0", licenses: ["ApacheV2_0"]) {
   workflow {
     standard()
   }

data/fusionauth-ruby-client.iml

@@ -8,7 +8,7 @@
     </content>
     <orderEntry type="jdk" jdkName="rbenv: 2.3.1" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.16.2, rbenv: 2.3.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.0.1, rbenv: 2.3.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.3.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v10.4.2, rbenv: 2.3.1) [gem]" level="application" />
   </component>

data/fusionauth_client.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'fusionauth_client'
-  spec.version       = '1.3.0'
+  spec.version       = '1.4.0'
   spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -2,7 +2,7 @@ require 'ostruct'
 require 'fusionauth/rest_client'
 
 #
-# Copyright (c) 2018, FusionAuth, All Rights Reserved
+# Copyright (c) 2018-2019, FusionAuth, All Rights Reserved
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -896,7 +896,8 @@ module FusionAuth
     end
 
     #
-    # Retrieves all of the actions for the user with the given Id.
+    # Retrieves all of the actions for the user with the given Id. This will return all time based actions that are active,
+    # and inactive as well as non-time based actions.
     #
     # @param user_id [string] The Id of the user to fetch the actions for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -908,6 +909,35 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.
+    #
+    # @param user_id [string] The Id of the user to fetch the actions for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_actions_preventing_login(user_id)
+      start.uri('/api/user/action')
+           .url_parameter('userId', user_id)
+           .url_parameter('preventingLogin', true)
+           .get()
+           .go()
+    end
+
+    #
+    # Retrieves all of the actions for the user with the given Id that are currently active.
+    # An active action means one that is time based and has not been canceled, and has not ended.
+    #
+    # @param user_id [string] The Id of the user to fetch the actions for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_active_actions(user_id)
+      start.uri('/api/user/action')
+           .url_parameter('userId', user_id)
+           .url_parameter('active', true)
+           .get()
+           .go()
+    end
+
     #
     # Retrieves the application for the given id or all of the applications if the id is null.
     #
@@ -1172,6 +1202,21 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Retrieves the last number of login records.
+    #
+    # @param offset [Numeric] The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
+    # @param limit [Numeric] (Optional, defaults to 10) The number of records to retrieve.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_recent_logins(offset, limit)
+      start.uri('/api/user/recent-login')
+           .url_parameter('offset', offset)
+           .url_parameter('limit', limit)
+           .get()
+           .go()
+    end
+
     #
     # Retrieves the refresh tokens that belong to the user with the given Id.
     #
@@ -1408,6 +1453,46 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the
+    # login counts for that application.
+    #
+    # @param application_id [string] (Optional) The application id.
+    # @param user_id [string] The userId id.
+    # @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
+    # @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_user_login_report(application_id, user_id, start, _end)
+      start.uri('/api/report/login')
+           .url_parameter('applicationId', application_id)
+           .url_parameter('userId', user_id)
+           .url_parameter('start', start)
+           .url_parameter('end', _end)
+           .get()
+           .go()
+    end
+
+    #
+    # Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the
+    # login counts for that application.
+    #
+    # @param application_id [string] (Optional) The application id.
+    # @param login_id [string] The userId id.
+    # @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
+    # @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_user_login_report_by_login_id(application_id, login_id, start, _end)
+      start.uri('/api/report/login')
+           .url_parameter('applicationId', application_id)
+           .url_parameter('loginId', login_id)
+           .url_parameter('start', start)
+           .url_parameter('end', _end)
+           .get()
+           .go()
+    end
+
     #
     # Retrieves the last number of login records for a user.
     #
@@ -1416,8 +1501,8 @@ module FusionAuth
     # @param limit [Numeric] (Optional, defaults to 10) The number of records to retrieve.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     #
-    def retrieve_user_login_report(user_id, offset, limit)
-      start.uri('/api/report/user-login')
+    def retrieve_user_recent_logins(user_id, offset, limit)
+      start.uri('/api/user/recent-login')
            .url_parameter('userId', user_id)
            .url_parameter('offset', offset)
            .url_parameter('limit', limit)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.
@@ -51,8 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: The Ruby client library for FusionAuth