fusionauth_client 1.15.2 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9a503cb29d7f7d064778354d1c2e90ecde0f8177
-  data.tar.gz: 671e92f9f2e88694e2392c2f83a229437621222c
+SHA256:
+  metadata.gz: 21109a2d8e1bd5cb1229077c02415245b6f04574e91f05240cce4ad5900eb0eb
+  data.tar.gz: 971f1406ab820d744161bebaf1d427c665963789dd129bac32b092c05d8816ac
 SHA512:
-  metadata.gz: 74ced127af1c9ce394756371cd43e693da4d3fe1b788c4972841993c696681f9e99784850cda793d7cf6af2492271f76e0d1e8f19030cdea3957a028b8dc86ed
-  data.tar.gz: e49b8691a7bb274ebded8f060ed157b153786aeaa4584a8a913fd6c8c85356533fcffc23b21dd2f9f9816eae3e42595ea223c405af9def5d006ee618788cb794
+  metadata.gz: be173c20a7f84ce6c0155c6a6d3cbcdfc7114fde73b7698bbc61f3fa18731a55db4418ca8c2a42efa50b9bacda58726d0668d724bcdc6bac87ec8741dfcca3a4
+  data.tar.gz: 5c3f0faa5560a56daf6a4ee2bee68c448896ee529fab405507a258669f99d3a91e0430c12056ed76d9345978b5ff62db47243931e683769d041a7be82864dd7b

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.5.1

data/Gemfile

@@ -1,7 +1,21 @@
+# Copyright (c) 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.
+# 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.
+
 source 'https://rubygems.org'
-ruby '2.3.1'
+ruby '2.5.1'
 
-gem "rake",  "10.4.2"
+gem "rake",  "12.3.3"
 gem "minitest",  "5.8.3"
 
 # Specify your gem's dependencies in fusionauth_client.gemspec

data/README.md

@@ -33,7 +33,7 @@ client = FusionAuth::FusionAuthClient.new(
 
 # Create a user + registration
 id = SecureRandom.uuid
-client.register!(id, {
+client.register(id, {
     :user => {
         :firstName => 'Ruby',
         :lastName => 'Client',
@@ -51,12 +51,12 @@ client.register!(id, {
 })
 
 # Authenticate the user
-response = client.login!({
+response = client.login({
     :loginId => 'ruby.client.test@fusionauth.io',
     :password => 'password',
     :applicationId => application_id
 })
-user = response.user
+user = response.success.response.user
 ```
 
 ## Contributing

data/build.savant

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

data/fusionauth-ruby-client.iml

@@ -6,10 +6,10 @@
       <sourceFolder url="file://$MODULE_DIR$/lib" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
     </content>
-    <orderEntry type="jdk" jdkName="rbenv: 2.3.1" jdkType="RUBY_SDK" />
+    <orderEntry type="jdk" jdkName="rbenv: 2.5.1" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.0.2, 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" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, rbenv: 2.5.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.5.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.1) [gem]" level="application" />
   </component>
 </module>

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.15.2'
+  spec.version       = '1.18.0'
   spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -43,16 +43,13 @@ module FusionAuth
 
     #
     # Takes an action on a user. The user being actioned is called the "actionee" and the user taking the action is called the
-    # "actioner". Both user ids are required. You pass the actionee's user id into the method and the actioner's is put into the
-    # request object.
+    # "actioner". Both user ids are required in the request object.
     #
-    # @param actionee_user_id [string] The actionee's user id.
     # @param request [OpenStruct, Hash] The action request that includes all of the information about the action being taken including
     #     the id of the action, any options and the duration (if applicable).
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
-    def action_user(actionee_user_id, request)
+    def action_user(request)
       start.uri('/api/user/action')
-          .url_segment(actionee_user_id)
           .body_handler(FusionAuth::JSONBodyHandler.new(request))
           .post()
           .go()
@@ -173,6 +170,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
+    #
+    # @param connector_id [string] (Optional) The Id for the connector. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the connector.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_connector(connector_id, request)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
     #
@@ -216,6 +227,34 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Creates a form.  You can optionally specify an Id for the form, if not provided one will be generated.
+    #
+    # @param form_id [string] (Optional) The Id for the form. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the form.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_form(form_id, request)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Creates a form field.  You can optionally specify an Id for the form, if not provided one will be generated.
+    #
+    # @param field_id [string] (Optional) The Id for the form field. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the form field.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_form_field(field_id, request)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
     #
@@ -467,6 +506,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the connector for the given Id.
+    #
+    # @param connector_id [string] The Id of the connector to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_connector(connector_id)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the consent for the given Id.
     #
@@ -491,6 +542,30 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the form for the given Id.
+    #
+    # @param form_id [string] The Id of the form to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_form(form_id)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Deletes the form field for the given Id.
+    #
+    # @param field_id [string] The Id of the form field to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_form_field(field_id)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the group for the given Id.
     #
@@ -530,11 +605,11 @@ module FusionAuth
     #
     # Deletes the key for the given Id.
     #
-    # @param key_od [string] The Id of the key to delete.
+    # @param key_id [string] The Id of the key to delete.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
-    def delete_key(key_od)
+    def delete_key(key_id)
       start.uri('/api/key')
-          .url_segment(key_od)
+          .url_segment(key_id)
           .delete()
           .go()
     end
@@ -922,11 +997,15 @@ module FusionAuth
     #
     # @param application_id [string] The Application Id for which you are requesting a new access token be issued.
     # @param encoded_jwt [string] The encoded JWT (access token).
+    # @param refresh_token [string] (Optional) An existing refresh token used to request a refresh token in addition to a JWT in the response.
+    #     <p>The target application represented by the applicationid request parameter must have refresh 
+    #     tokens enabled in order to receive a refresh token in the response.</p>
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
-    def issue_jwt(application_id, encoded_jwt)
+    def issue_jwt(application_id, encoded_jwt, refresh_token)
       start.uri('/api/jwt/issue')
           .authorization('JWT ' + encoded_jwt)
           .url_parameter('applicationId', application_id)
+          .url_parameter('refreshToken', refresh_token)
           .get()
           .go()
     end
@@ -1054,6 +1133,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates, via PATCH, the connector with the given Id.
+    #
+    # @param connector_id [string] The Id of the connector to update.
+    # @param request [OpenStruct, Hash] The request that contains just the new connector information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_connector(connector_id, request)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch()
+          .go()
+    end
+
     #
     # Updates, via PATCH, the consent with the given Id.
     #
@@ -1454,6 +1547,28 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the connector with the given Id.
+    #
+    # @param connector_id [string] The Id of the connector.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_connector(connector_id)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves all of the connectors.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_connectors()
+      start.uri('/api/connector')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the Consent for the given Id.
     #
@@ -1565,6 +1680,50 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the form with the given Id.
+    #
+    # @param form_id [string] The Id of the form.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_form(form_id)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves the form field with the given Id.
+    #
+    # @param field_id [string] The Id of the form field.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_form_field(field_id)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves all of the forms fields
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_form_fields()
+      start.uri('/api/form/field')
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves all of the forms.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_forms()
+      start.uri('/api/form')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the group for the given Id.
     #
@@ -2466,6 +2625,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates the connector with the given Id.
+    #
+    # @param connector_id [string] The Id of the connector to update.
+    # @param request [OpenStruct, Hash] The request object that contains all of the new connector information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_connector(connector_id, request)
+      start.uri('/api/connector')
+          .url_segment(connector_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
     #
     # Updates the consent with the given Id.
     #
@@ -2494,6 +2667,34 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates the form with the given Id.
+    #
+    # @param form_id [string] The Id of the form to update.
+    # @param request [OpenStruct, Hash] The request object that contains all of the new form information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_form(form_id, request)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
+    #
+    # Updates the form field with the given Id.
+    #
+    # @param field_id [string] The Id of the form field to update.
+    # @param request [OpenStruct, Hash] The request object that contains all of the new form field information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_form_field(field_id, request)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
     #
     # Updates the group with the given Id.
     #

data/lib/fusionauth/rest_client.rb

@@ -1,3 +1,17 @@
+# Copyright (c) 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.
+# 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.
+
 require 'base64'
 require 'json'
 require 'net/http'
@@ -41,7 +55,7 @@ module FusionAuth
     # @param body_handler [BodyHandler] The body handler.
     # @return [RESTClient] this
     #
-    def rbody_handler(body_handler)
+    def body_handler(body_handler)
       @body_handler = body_handler
       self
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.15.2
+  version: 1.18.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-07-19 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.1.4
 signing_key: 
 specification_version: 4
 summary: The Ruby client library for FusionAuth