eli 0.1.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cdbb2b2e204e2d47796915fb1333006eaaa07285105546ac5c8a1b7920697e7
+  data.tar.gz: 5628df01ace38d93283345e0824eb5782666c52cd673477a61f4597536cbc56c
+SHA512:
+  metadata.gz: 9b91b4d86c32961aa378621ba08f76d22f960943e7da5894f7896de09c1b09a069ae4fb7dfd9153831c4ebe80e08803ba03065e2ffe1c24744ccda506e759765
+  data.tar.gz: 263cd04e49743941101c5f107960d27cd5a08e6f6148f581264e61df194e9e8fb76253ef6d288b876e05830dbfe50c0075a8faa267e0652960fb9c9a02809216

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Adilson Chacon Cavalcanti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# Eli
+
+Library for Letmein Integration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "eli"
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install eli
+```
+
+## Configuration
+
+Set the base URL of the Letmein server you are integrating with. It defaults to
+`http://localhost:4000` and can also be provided through the `LETMEIN_BASE_URL`
+environment variable.
+
+```ruby
+Eli::Config.base_url = "http://localhost:4000"
+```
+
+## Usage
+
+### Public API
+
+```ruby
+# Sign in and obtain a session token
+response = Eli.sign_in("app token", "user.email@domain.com", "secret.password")
+response.status # => 200
+response.body   # => { "data" => { "token" => "JWT session token" } }
+
+# Check whether a session token is still valid
+Eli.signed_in("JWT session token") # => true / false
+
+# Current user, refresh and sign out
+Eli.current_user("JWT session token")
+Eli.refresh("JWT session token")
+Eli.sign_out("JWT session token")
+
+# Account management
+Eli.unlock("Unlock token")
+Eli.confirm("Confirmation token")
+Eli.request_password_recovery("app token", "user@example.com")
+Eli.recover_password("token", "Secret.123", "Secret.123")
+Eli.update_password("JWT session token", {
+  current_password: "Secret.123",
+  new_password: "NewSecret.1234",
+  new_password_confirmation: "NewSecret.1234"
+})
+Eli.resend_account_confirmation_email("App token", "user@example.com")
+```
+
+### Admin API
+
+```ruby
+# Admin sessions
+Eli::Admin.sign_in("user.email@domain.com", "seCr#t.passw0rd")
+Eli::Admin.signed_in("JWT session token")
+Eli::Admin.current_user("JWT session token")
+Eli::Admin.refresh("JWT session token")
+Eli::Admin.sign_out("JWT session token")
+
+# Sign a user in on their behalf
+Eli::Admin.signs_in(
+  "JWT session token",
+  { email: "user.email@domain.com", name: "User Name" },
+  "app_id"
+)
+```
+
+### Organizations
+
+```ruby
+organization = Eli::Admin::Organization.new(
+  name: "New Organization",
+  description: "New organization description"
+)
+
+Eli::Admin::Organization.create("JWT session token", organization)
+Eli::Admin::Organization.list("JWT session token")
+Eli::Admin::Organization.get("JWT session token", "organization-id")
+Eli::Admin::Organization.update("JWT session token", "organization-id", organization)
+Eli::Admin::Organization.delete("JWT session token", "organization-id")
+
+Eli::Admin::Organization.list_admin_users("JWT session token", "organization-id")
+Eli::Admin::Organization.add_admin_user("JWT session token", "organization-id", "user@domain.com")
+Eli::Admin::Organization.remove_admin_user("JWT session token", "organization-id", "admin-user-id")
+```
+
+### Apps
+
+```ruby
+app = Eli::Admin::App.new(
+  name: "New App Name",
+  description: "New App Description",
+  organization_id: "organization-id",
+  unlock_sign_in_url: "http://localhost:4000"
+)
+
+Eli::Admin::App.create("JWT session token", app)
+Eli::Admin::App.list("JWT session token", "organization-id")
+Eli::Admin::App.get("JWT session token", "organization-id", "app-id")
+Eli::Admin::App.update("JWT session token", "app-id", app)
+Eli::Admin::App.delete("JWT session token", "organization-id", "app-id")
+
+# App users
+Eli::Admin::App.list_app_users("JWT session token", "organization-id", "app-id")
+Eli::Admin::App.add_app_user("JWT session token", "organization-id", "app-id", "user@domain.com", "Secret.123!")
+Eli::Admin::App.remove_app_user("JWT session token", "organization-id", "app-id", "app-user-id")
+
+# Tokens
+Eli::Admin::App.create_token("JWT session token", "organization-id", "app-id")
+Eli::Admin::App.list_tokens("JWT session token", "organization-id", "app-id")
+Eli::Admin::App.get_token("JWT session token", "organization-id", "app-id", "token-id")
+Eli::Admin::App.revoke_token("JWT session token", "organization-id", "app-id", "token-id")
+```
+
+## Responses
+
+Every request returns an `Eli::RestApi::Response` value object exposing:
+
+- `status` — the HTTP status code as an integer.
+- `body` — the response body, parsed from JSON into a Hash/Array when possible.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then run
+`bundle exec rake spec` to run the tests.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](LICENSE).

data/lib/eli/admin/app.rb

@@ -0,0 +1,322 @@
+# frozen_string_literal: true
+
+module Eli
+  module Admin
+    # Represents an App belonging to an organization and exposes the
+    # administrative endpoints to manage apps, their users and tokens.
+    #
+    # Instances carry the attributes used by `create` and `update`:
+    #
+    #     app = Eli::Admin::App.new(
+    #       name: "New App Name",
+    #       description: "New App Description",
+    #       organization_id: "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+    #       unlock_sign_in_url: "http://localhost:4000"
+    #     )
+    class App
+      attr_accessor :name, :description, :organization_id, :unlock_sign_in_url
+
+      def initialize(name: nil, description: nil, organization_id: nil, unlock_sign_in_url: nil)
+        @name = name
+        @description = description
+        @organization_id = organization_id
+        @unlock_sign_in_url = unlock_sign_in_url
+      end
+
+      class << self
+        # ## Examples
+        #
+        #     app = Eli::Admin::App.new(
+        #       name: "New App Name",
+        #       description: "New App Description",
+        #       organization_id: "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       unlock_sign_in_url: "http://localhost:4000"
+        #     )
+        #
+        #     Eli::Admin::App.create("JWT session token", app)
+        #     # status: 201
+        #     # body: { "data" => { "description" => "New App Description",
+        #     #                     "id" => "319f3afa-69bd-4bcc-b168-f26613c9581f",
+        #     #                     "name" => "New App Name" } }
+        def create(session_token, app)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + app.organization_id + "/apps"
+
+          options = {
+            params: {
+              app: {
+                name: app.name,
+                description: app.description,
+                unlock_sign_in_url: app.unlock_sign_in_url
+              }
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.post(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::App.list("JWT session token", "3d36fb7c-bbb6-4b27-8945-c7880de5484f")
+        #     # status: 200
+        #     # body: { "data" => [ ... ], "pagination" => { ... } }
+        def list(session_token, organization_id, page = 1, per_page = 20)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + organization_id + "/apps"
+
+          options = {
+            params: {
+              page: page,
+              per_page: per_page
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.get(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::App.get(
+        #       "JWT session token",
+        #       "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       "5223b223-52f0-4e61-afbe-e44ce60515e4"
+        #     )
+        #     # status: 200
+        #     # body: { "data" => { "description" => nil,
+        #     #                     "id" => "5223b223-52f0-4e61-afbe-e44ce60515e4",
+        #     #                     "name" => "App Test" } }
+        def get(session_token, organization_id, id)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + organization_id + "/apps/" + id
+
+          options = {
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.get(url, options)
+        end
+
+        # ## Examples
+        #
+        #     app = Eli::Admin::App.new(
+        #       name: "Another App Name",
+        #       description: "Changed Description",
+        #       organization_id: "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       unlock_sign_in_url: "http://localhost:4000"
+        #     )
+        #
+        #     Eli::Admin::App.update("JWT session token", "319f3afa-69bd-4bcc-b168-f26613c9581f", app)
+        #     # status: 200
+        #     # body: { "data" => { "description" => "Changed Description",
+        #     #                     "id" => "319f3afa-69bd-4bcc-b168-f26613c9581f",
+        #     #                     "name" => "Another App Name" } }
+        def update(session_token, id, app)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + app.organization_id + "/apps/" + id
+
+          options = {
+            params: {
+              app: {
+                name: app.name,
+                description: app.description,
+                unlock_sign_in_url: app.unlock_sign_in_url
+              }
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.put(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::App.delete(
+        #       "JWT session token",
+        #       "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       "319f3afa-69bd-4bcc-b168-f26613c9581f"
+        #     )
+        #     # status: 204
+        #     # body: ""
+        def delete(session_token, organization_id, id)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + organization_id + "/apps/" + id
+
+          options = {
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.delete(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::App.list_app_users(
+        #       "JWT session token",
+        #       "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       "5223b223-52f0-4e61-afbe-e44ce60515e4"
+        #     )
+        #     # status: 200
+        #     # body: { "data" => [ ... ], "pagination" => { ... } }
+        def list_app_users(session_token, organization_id, id, page = 1, per_page = 20)
+          url = Eli::Config.base_url +
+                "/rest/admin/organizations/" + organization_id + "/apps/" + id + "/users"
+
+          options = {
+            params: {
+              page: page,
+              per_page: per_page
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.get(url, options)
+        end
+
+        # Add app user.
+        #
+        # ## Examples
+        #
+        #     Eli::Admin::App.add_app_user(
+        #       "JWT session token",
+        #       "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       "5223b223-52f0-4e61-afbe-e44ce60515e4",
+        #       "one.more_user@domain.com",
+        #       "Secret.123!"
+        #     )
+        #     # status: 201
+        #     # body: { "data" => { "id" => "...", "user" => { ... } } }
+        def add_app_user(session_token, organization_id, id, email, password)
+          url = Eli::Config.base_url +
+                "/rest/admin/organizations/" + organization_id + "/apps/" + id + "/users"
+
+          options = {
+            params: {
+              password: password,
+              email: email
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.post(url, options)
+        end
+
+        # Remove app user.
+        #
+        # ## Examples
+        #
+        #     Eli::Admin::App.remove_app_user(
+        #       "JWT session token",
+        #       "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       "5223b223-52f0-4e61-afbe-e44ce60515e4",
+        #       "b05b504b-d737-4962-835c-f5bc8a2518e2"
+        #     )
+        #     # status: 204
+        #     # body: ""
+        def remove_app_user(session_token, organization_id, id, app_user_id)
+          url = Eli::Config.base_url +
+                "/rest/admin/organizations/" + organization_id +
+                "/apps/" + id + "/users/" + app_user_id
+
+          options = {
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.delete(url, options)
+        end
+
+        # Create token.
+        #
+        # ## Examples
+        #
+        #     Eli::Admin::App.create_token(
+        #       "JWT session token",
+        #       "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       "5223b223-52f0-4e61-afbe-e44ce60515e4"
+        #     )
+        #     # status: 201
+        #     # body: { "data" => { "app_id" => "...", "id" => "...", "token" => "..." } }
+        def create_token(session_token, organization_id, app_id)
+          url = Eli::Config.base_url +
+                "/rest/admin/organizations/" + organization_id + "/apps/" + app_id + "/tokens"
+
+          options = {
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.post(url, options)
+        end
+
+        # List tokens.
+        #
+        # ## Examples
+        #
+        #     Eli::Admin::App.list_tokens(
+        #       "JWT session token",
+        #       "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       "5223b223-52f0-4e61-afbe-e44ce60515e4"
+        #     )
+        #     # status: 200
+        #     # body: { "data" => [ ... ], "pagination" => { ... } }
+        def list_tokens(session_token, organization_id, app_id, page = 1, per_page = 20)
+          url = Eli::Config.base_url +
+                "/rest/admin/organizations/" + organization_id + "/apps/" + app_id + "/tokens"
+
+          options = {
+            params: {
+              page: page,
+              per_page: per_page
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.get(url, options)
+        end
+
+        # Show token.
+        #
+        # ## Examples
+        #
+        #     Eli::Admin::App.get_token(
+        #       "JWT session token",
+        #       "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       "5223b223-52f0-4e61-afbe-e44ce60515e4",
+        #       "63cb25d9-d321-4f0e-aa24-a195e3aea2c4"
+        #     )
+        #     # status: 200
+        #     # body: { "data" => { "app_id" => "...", "id" => "..." } }
+        def get_token(session_token, organization_id, app_id, id)
+          url = Eli::Config.base_url +
+                "/rest/admin/organizations/" + organization_id +
+                "/apps/" + app_id + "/tokens/" + id
+
+          options = {
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.get(url, options)
+        end
+
+        # Revoke a token.
+        #
+        # ## Examples
+        #
+        #     Eli::Admin::App.revoke_token(
+        #       "JWT session token",
+        #       "3d36fb7c-bbb6-4b27-8945-c7880de5484f",
+        #       "5223b223-52f0-4e61-afbe-e44ce60515e4",
+        #       "63cb25d9-d321-4f0e-aa24-a195e3aea2c4"
+        #     )
+        #     # status: 204
+        #     # body: ""
+        def revoke_token(session_token, organization_id, app_id, id)
+          url = Eli::Config.base_url +
+                "/rest/admin/organizations/" + organization_id +
+                "/apps/" + app_id + "/tokens/" + id
+
+          options = {
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.delete(url, options)
+        end
+      end
+    end
+  end
+end

data/lib/eli/admin/organization.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Eli
+  module Admin
+    # Represents an Organization and exposes the administrative endpoints to
+    # manage organizations and their admin users.
+    #
+    # Instances carry the attributes used by `create` and `update`:
+    #
+    #     organization = Eli::Admin::Organization.new(
+    #       name: "New Organization",
+    #       description: "New organization description"
+    #     )
+    class Organization
+      attr_accessor :name, :description
+
+      def initialize(name: nil, description: nil)
+        @name = name
+        @description = description
+      end
+
+      class << self
+        # ## Examples
+        #
+        #     organization = Eli::Admin::Organization.new(
+        #       name: "New Organization",
+        #       description: "New orgranization description"
+        #     )
+        #
+        #     Eli::Admin::Organization.create("JWT session token", organization)
+        #     # status: 201
+        #     # body: { "data" => { "description" => "New orgranization description",
+        #     #                     "id" => "bf893f08-72ba-46f7-9320-0aec814d668c",
+        #     #                     "name" => "New Organization" } }
+        def create(session_token, organization)
+          url = Eli::Config.base_url + "/rest/admin/organizations"
+
+          options = {
+            params: {
+              organization: {
+                name: organization.name,
+                description: organization.description
+              }
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.post(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::Organization.list("JWT session token")
+        #     # status: 200
+        #     # body: { "data" => [ ... ], "pagination" => { ... } }
+        def list(session_token, page = 1, per_page = 20)
+          url = Eli::Config.base_url + "/rest/admin/organizations"
+
+          options = {
+            params: {
+              page: page,
+              per_page: per_page
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.get(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::Organization.get("JWT session token", "76f4b18b-e612-438c-a1e2-74b12beccdd1")
+        #     # status: 200
+        #     # body: { "data" => { "description" => "A description example",
+        #     #                     "id" => "76f4b18b-e612-438c-a1e2-74b12beccdd1",
+        #     #                     "name" => "Org Name Example" } }
+        def get(session_token, id)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + id
+
+          options = {
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.get(url, options)
+        end
+
+        # ## Examples
+        #
+        #     organization = Eli::Admin::Organization.new(
+        #       name: "New name for Organization",
+        #       description: "New Some description"
+        #     )
+        #
+        #     Eli::Admin::Organization.update(
+        #       "JWT session token",
+        #       "00543b54-ab48-458d-b73a-3fe0177315aa",
+        #       organization
+        #     )
+        #     # status: 200
+        #     # body: { "data" => { "description" => "New Some description",
+        #     #                     "id" => "00543b54-ab48-458d-b73a-3fe0177315aa",
+        #     #                     "name" => "New name for Organization" } }
+        def update(session_token, id, organization)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + id
+
+          options = {
+            params: {
+              organization: {
+                name: organization.name,
+                description: organization.description
+              }
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.put(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::Organization.delete("JWT session token", "00543b54-ab48-458d-b73a-3fe0177315aa")
+        #     # status: 204
+        #     # body: ""
+        def delete(session_token, id)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + id
+
+          options = {
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.delete(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::Organization.list_admin_users(
+        #       "Session token",
+        #       "c28de4d1-14ea-4494-99a9-cf7cf9f8f186"
+        #     )
+        #     # status: 200
+        #     # body: { "data" => [ ... ], "pagination" => { ... } }
+        def list_admin_users(session_token, id, page = 1, per_page = 20)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + id + "/admin_users"
+
+          options = {
+            params: {
+              page: page,
+              per_page: per_page
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.get(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::Organization.add_admin_user(
+        #       "Session token",
+        #       "c28de4d1-14ea-4494-99a9-cf7cf9f8f186",
+        #       "user.email@domain.com"
+        #     )
+        #     # status: 201
+        #     # body: { "data" => { "id" => "...", "user" => { ... } } }
+        def add_admin_user(session_token, id, email)
+          url = Eli::Config.base_url + "/rest/admin/organizations/" + id + "/admin_users"
+
+          options = {
+            params: {
+              email: email
+            },
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.post(url, options)
+        end
+
+        # ## Examples
+        #
+        #     Eli::Admin::Organization.remove_admin_user(
+        #       "Session token",
+        #       "c28de4d1-14ea-4494-99a9-cf7cf9f8f186",
+        #       "47dff89a-97ca-4eca-8057-2a9398d90e03"
+        #     )
+        #     # status: 204
+        #     # body: ""
+        def remove_admin_user(session_token, id, organization_admin_user_id)
+          url = Eli::Config.base_url +
+                "/rest/admin/organizations/" + id + "/admin_users/" + organization_admin_user_id
+
+          options = {
+            headers: { "authorization" => "Bearer #{session_token}" }
+          }
+
+          Eli::RestApi.delete(url, options)
+        end
+      end
+    end
+  end
+end