lws 0.4.2 → 6.1.0.beta1

data/lib/lws/auth.rb

@@ -20,11 +20,12 @@ module LWS::Auth
   end
   # :nocov:
 
-  #@!visibility private
-  def self.api
-    LWS.setup_api(LWS.config.endpoints[:auth] ||
-                  ENDPOINT[LWS.config.environment])
+  # @!visibility private
+  class << self
+    attr_accessor :api
   end
+  @api = LWS.setup_api(LWS.config.endpoints[:auth] ||
+                       ENDPOINT[LWS.config.environment])
 
   ### Generic classes
 
@@ -33,138 +34,263 @@ module LWS::Auth
     use_api LWS::Auth.api
   end
 
-  # (see Generic::Task)
-  class Task < LWS::Generic::Task
-    use_api LWS::Auth.api
-  end
-
   ### App specific classes
 
   # = The account class
   class Account < LWS::Generic::Model
     use_api LWS::Auth.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the account
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the account
+    attribute :id
 
-    #@!attribute avatar_url
-    #  @return [String] the avatar URL of the account
+    # @!attribute avatar_url
+    #   @return [String] the avatar URL of the account
+    attribute :avatar_url
 
-    #@!attribute apps
-    #  @return [Array<App>] the apps that are assigned to the account
+    # @!attribute apps
+    #   @return [Array<App>] the apps that are assigned to the account
     has_many :apps
 
-    #@!attribute devices
-    #  @return [Array<Device>] the devices that are assigned to the account
+    # @!attribute company
+    #   @return [Company] the company that the account belongs to
+    belongs_to :company
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company that the account belongs to
+    attribute :company_id
+
+    # @!attribute devices
+    #   @return [Array<Device>] the devices that are assigned to the account
     has_many :devices
 
-    #@!attribute users
-    #  @return [Array<User>] the users that are assigned to the account
-    has_many :users
+    # @!attribute language
+    #   @return [String] the language of the account
+    #     (at least 2 characters long)
+    attribute :language
 
-    #@!attribute company
-    #  @return [Company] the company that the account belongs to
-    belongs_to :company
+    # @!attribute name
+    #   @return [String] the name of the account
+    #     (at least 8 characters long)
+    attribute :name
 
-    #@!attribute company_id
-    #  @return [Fixnum] the ID of the company that the account belongs to
+    # @!attribute start_app
+    #   @return [App, nil] the app to start with/open when logging in
+    belongs_to :start_app, class_name: "LWS::Auth::App"
 
-    #@!attribute language
-    #  @return [String] the language of the account
+    # @!attribute start_app_id
+    #   @return [Fixnum, nil] the ID of the app to start with/open when logging in
+    attribute :start_app_id
 
-    #@!attribute name
-    #  @return [String] the name of the account
+    # @!attribute users
+    #   @return [Array<User>] the users that are assigned to the account
+    has_many :users
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the account was created
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the account was created
+    attribute :created_at
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the account was last updated
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the account was last updated
+    attribute :updated_at
   end
 
   # = The app class
   class App < LWS::Generic::Model
     use_api LWS::Auth.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the account
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the account
+    attribute :id
+
+    # @!attribute accounts
+    #   @return [Array<Account>] the accounts using the app
+    has_many :accounts
+
+    # @!attribute app_key
+    #   @return [String] the (unique) internal key used for the app
+    attribute :app_key
 
-    #@!attribute name
-    #  @return [String] the name of the app
+    # @!attribute autoassign
+    #   @return [Boolean] whether the app is automatically assigned to
+    #     a newly created account and/or company
+    attribute :autoassign
 
-    #@!attribute app_key
-    #  @return [String] the internal key used for the app
+    # @!attribute companies
+    #   @return [Array<Company>] the companies using the app
+    has_many :companies
 
-    #@!attribute url
-    #  @return [String] the web location of the app
+    # @!attribute icon
+    #   @return [String] the icon ID/name of the app
+    attribute :icon
 
-    #@!attribute secret
-    #  @return [String] the shared secred used for logging in to the app
+    # @!attribute licenses
+    #   @return [Array<License>] the licenses that provide access to the app
+    has_many :licenses
 
-    #@!attribute icon
-    #  @return [String] the icon ID/name of the app
+    # @!attribute order_priority
+    #   @return [Fixnum, nil] the order priority of the app with respect to the
+    #     other apps
+    attribute :order_priority
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the app was created
+    # @!attribute name
+    #   @return [String] the name of the app
+    attribute :name
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the app was last updated
+    # @!attribute secret
+    #   @return [String] the shared secred used for logging in to the app
+    attribute :secret
 
-    self # To ensure that YARD does not skip the attributes of this class
+    # @!attribute url
+    #   @return [String] the web location (URL) of the app
+    attribute :url
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the app was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the app was last updated
+    attribute :updated_at
   end
 
   # = The company class
   class Company < LWS::Generic::Model
     use_api LWS::Auth.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the company
-
-    #@!attribute apps
-    #  @return [Array<App>] the apps that are assigned to the company
-    has_many :apps
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the company
+    attribute :id
 
-    #@!attribute accounts
-    #  @return [Array<Account>] the accounts that are assigned to the company
+    # @!attribute accounts
+    #   @return [Array<Account>] the accounts that are assigned to the company
     has_many :accounts
 
-    #@!attribute address
-    #  @return [String] the address of the company
-
-    #@!attribute city
-    #  @return [String] the city of the company
+    # @!attribute activated
+    #   @return [Boolean] whether the company has been activated
+    attribute :activated
 
-    #@!attribute contact_person
-    #  @return [Account] the contact person of the company
-    belongs_to :contact_person, class_name: "Account"
+    # @!attribute apps
+    #   @return [Array<App>] the apps that are assigned to the company
+    has_many :apps
 
-    #@!attribute contact_person_id
-    #  @return [Fixnum] the ID of the contact person of the company
+    # @!attribute address
+    #   @return [String] the address of the company
+    #      (at least 2 characters long)
+    attribute :address
+
+    # @!attribute city
+    #   @return [String] the city of the company
+    #      (at least 2 characters long)
+    attribute :city
+
+    # @!attribute contact_person
+    #   @return [Account] the contact person of the company
+    belongs_to :contact_person, class_name: "LWS::Auth::Account",
+                                foreign_key: :contact_person_id,
+                                uri: "accounts/:id"
+
+    # @!attribute contact_person_id
+    #   @return [Fixnum] the ID of the contact person of the company
+    attribute :contact_person_id
+
+    # @!attribute contracts
+    #   @return [Array<Contract>] the contracts of the company
+    has_many :contracts
+
+    # @!attribute country
+    #   @return [String] the country of the company
+    #      (at least 2 characters long)
+    attribute :country
+
+    # @!attribute expire
+    #   @return [Boolean] whether the company is planned to be discontinued
+    #     after the contract ends
+    attribute :expire
+
+    # @!attribute licenses
+    #   @return [Array<License>] the licenses of the company
+    has_many :licenses
+
+    # @!attribute name
+    #   @return [String] the name of the company
+    #     (at least 2 characters long)
+    attribute :name
+
+    # @!attribute number
+    #   @return [String] the street address number of the company
+    #      (at least 1 character long)
+    attribute :number
+
+    # @!attribute parent
+    #   @return [Company, nil] the parenty company
+    belongs_to :parent, class_name: "LWS::Auth::Company",
+                        foreign_key: :parent_id,
+                        uri: "companies/:id"
+
+    # @!attribute parent_id
+    #   @return [Fixnum, nil] the ID of the parenty company
+    attribute :parent_id
+
+    # @!attribute telephone_number
+    #   @return [String] the telephone number of the company
+    #      (at least 2 characters long)
+    attribute :telephone_number
+
+    # @!attribute usage_reports
+    #   @return [Array<UsageReport>] the usage reports available/generated
+    #     for the company
+    has_many :usage_reports, uri: "company/:company_id/reports"
+
+    # @!attribute uuid
+    #   @return [String] the UUID of the company
+    attribute :uuid
+
+    # @!attribute zip_code
+    #   @return [String] the zip code of the company
+    #      (at least 2 characters long)
+    attribute :zip_code
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the company was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the company was last updated
+    attribute :updated_at
+  end
 
-    #@!attribute country
-    #  @return [String] the country of the company
+  # = The contract class
+  class Contract < LWS::Generic::Model
+    use_api LWS::Auth.api
 
-    #@!attribute name
-    #  @return [String] the name of the company
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the contract
+    attribute :id
 
-    #@!attribute number
-    #  @return [String] the street address number of the company
+    # @!attribute company
+    #   @return [Company] the company that has the contract
+    belongs_to :company
 
-    #@!attribute parent
-    #  @return [Company] the parenty company
-    belongs_to :parent, class_name: "Company"
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company that has the contract
+    attribute :company_id
 
-    #@!attribute parent_id
-    #  @return [Fixnum] the ID of the parenty company
+    # @!attribute end_date
+    #   @return [String] the end date of the contract (date/time string)
+    attribute :end_date
 
-    #@!attribute zip_code
-    #  @return [String] the zip code of the company
+    # @!attribute start_date
+    #   @return [String] the start date of the contract (date/time string)
+    attribute :start_date
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the company was created
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the contract was created
+    attribute :created_at
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the company was last updated
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the contract was last updated
+    attribute :updated_at
   end
 
   # = The device class
@@ -174,80 +300,195 @@ module LWS::Auth
   class Device < LWS::Generic::Model
     use_api LWS::Auth.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the device
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the device
+    attribute :id
 
-    #@!attribute name
-    #  @return [String] the name of the device
-
-    #@!attribute account
-    #  @return [Account] the account that the device belongs to
+    # @!attribute account
+    #   @return [Account] the account that the device belongs to
     belongs_to :account
 
-    #@!attribute account_id
-    #  @return [Fixnum] the ID of the account that the device belongs to
+    # @!attribute account_id
+    #   @return [Fixnum] the ID of the account that the device belongs to
+    attribute :account_id
+
+    # @!attribute name
+    #   @return [String] the name of the device
+    attribute :name
+
+    # @!attribute tokens
+    #   @return [Array<Token>] the tokens available for the device
+    attribute :tokens
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the device was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the device was last updated
+    attribute :updated_at
+  end
+
+  # = The license class
+  class License < LWS::Generic::Model
+    use_api LWS::Auth.api
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the license
+    attribute :id
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the device was created
+    # @!attribute app
+    #   @return [App] the app the license is for
+    belongs_to :app
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the device was last updated
+    # @!attribute app_id
+    #   @return [Fixnum] the ID of the app the license is for
+    attribute :app_id
+
+    # @!attribute company
+    #   @return [Company] the company that has the license
+    belongs_to :company
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company that has the license
+    attribute :company_id
+
+    # @!attribute count
+    #   @return [Fixnum] the number of items the license provides
+    attribute :count
+
+    # @!attribute desc
+    #   @return [String] the description of the license
+    attribute :desc
+
+    # @!attribute key
+    #   @return [String] the key of the license
+    attribute :key
+
+    # @!attribute license_type
+    #   @return [String] the type of the license
+    attribute :license_type
+
+    # @!attribute name
+    #   @return [String] the name of the license
+    attribute :name
+
+    # @!attribute sku
+    #   @return [String] the stock-keeping unit of the license
+    attribute :sku
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the license was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the license was last updated
+    attribute :updated_at
   end
 
+
   # = The token class
   class Token < LWS::Generic::Model
     use_api LWS::Auth.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the token
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the token
+    attribute :id
 
-    #@!attribute name
-    #  @return [String] the name of the token
+    # @!attribute account
+    #   @return [Account] the account the token belongs to (through either
+    #     the user or the device)
+    belongs_to :account, uri: nil
 
-    #@!attribute token
-    #  @return [String] the actual token string
+    # @!attribute account_id
+    #   @return [Fixnum] the ID of the account the token belongs to
+    attribute :account_id
 
-    #@!attribute used_on
-    #  @return [String] the timestamp the token was last used
+    # @!attribute device
+    #   @note Each token is associated to either a user or a device.
+    #   @return [Device, nil] the device the token belongs to
+    belongs_to :device, uri: nil
 
-    #@!attribute ip_address
-    #  @return [String] the location/IP address the token is used on
+    # @!attribute device_id
+    #   @return [Fixnum, nil] the ID of the device the token belongs to
+    attribute :device_id
 
-    #@!attribute user_agent
-    #  @return [String] the user agent/browser string when the token was used
+    # @!attribute created_on [r]
+    #   @deprecated This is an old alias of {#created_at}.
+    #  @return [String] the timestamp of when the token was created
+    attribute :created_on
 
-    #@!attribute account
-    #  @return [Account] the account the token belongs to (through either
-    #    the user or the device)
-    belongs_to :account
+    # @!attribute expires_on
+    #   @return [String] the timestamp the token will (or has) expire(d)
+    attribute :expires_on
 
-    #@!attribute account_id
-    #  @return [Fixnum] the ID of the account the token belongs to
+    # @!attribute ip_address
+    #   @return [String] the location/IP address the token is used on
+    attribute :ip_address
 
-    #@!attribute user
-    #  @note Each token is associated to either a user or a device.
-    #  @return [User] the user the token belongs to
-    belongs_to :user
+    # @!attribute name
+    #   @return [String, nil] the name of the token
+    attribute :name
 
-    #@!attribute user_id
-    #  @return [Fixnum] the ID of the user the token belongs to
+    # @!attribute token
+    #   @return [String] the actual token string
+    attribute :token
 
-    #@!attribute device
-    #  @note Each token is associated to either a user or a device.
-    #  @return [Device] the device the token belongs to
-    belongs_to :device
+    # @!attribute used_on
+    #   @return [String, nil] the timestamp the token was last used
+    attribute :used_on
 
-    #@!attribute device_id
-    #  @return [Fixnum] the ID of the device the token belongs to
+    # @!attribute user_agent
+    #   @return [String, nil] the user agent/browser string when the token
+    #     was used
+    attribute :user_agent
 
-    #@!attribute expires_on
-    #  @return [String] the timestamp the token will (or has) expire(d)
+    # @!attribute user
+    #   @note Each token is associated to either a user or a device.
+    #   @return [User, nil] the user the token belongs to
+    belongs_to :user, uri: nil
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the token was created
+    # @!attribute user_id
+    #   @return [Fixnum, nil] the ID of the user the token belongs to
+    attribute :user_id
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the token was last updated
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the token was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the token was last updated
+    attribute :updated_at
+  end
+
+  # = The usage report class
+  class UsageReport < LWS::Generic::Model
+    use_api LWS::Auth.api
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the usage report
+    attribute :id
+
+    # @!attribute company
+    #   @return [Company] the company that the usage report is for
+    belongs_to :company
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company that the usage report is for
+    attribute :company_id
+
+    # @!attribute object
+    #   @return [String, nil] the (partial) HTML document of the usage report.
+    #     (The value is +nil+ until the report has been successfully generated.)
+    attribute :object
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the usage report was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the usage report was last updated
+    attribute :updated_at
   end
 
   # = The user class
@@ -257,27 +498,59 @@ module LWS::Auth
   class User < LWS::Generic::Model
     use_api LWS::Auth.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the user
-
-    #@!attribute email
-    #  @return [String] the email address of the user
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the user
+    attribute :id
 
-    #@!attribute password_digest
-    #  @return [String] the digested version of the password of the user
-
-    #@!attribute account
-    #  @return [Account] the account that the user belongs to
+    # @!attribute account
+    #   @return [Account] the account that the user belongs to
     belongs_to :account
 
-    #@!attribute account_id
-    #  @return [Fixnum] the ID of the account that the user belongs to
-
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the user was created
-
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the user was last updated
+    # @!attribute account_id
+    #   @return [Fixnum] the ID of the account that the user belongs to
+    attribute :account_id
+
+    # @!attribute auth_provider
+    #   @return [String] the name of the authentication provider
+    attribute :auth_provider
+
+    # @!attribute email
+    #   @return [String] the email address of the user
+    attribute :email
+
+    # @!attribute mfa_enabled
+    #   @return [Boolean] whether MFA (multi-factor authentication) is
+    #     enabled for the user
+    attribute :mfa_enabled
+
+    # @!attribute mfa_verified
+    #   @return [Boolean] whether MFA (multi-factor authentication) has
+    #     been verified for the user
+    attribute :mfa_verified
+
+    # @!attribute oauth_expires_at
+    #   @return [String, nil] the timestamp of when the OAuth token of the
+    #     user expires
+    attribute :oauth_expires_at
+
+    # @!attribute password_digest
+    #   @return [String, nil] the digested version of the password of the user.
+    #     (Can be +nil+ if the authentication provider (see {#auth_provider})
+    #     is not +"lws"+.)
+    attribute :password_digest
+
+    # @!attribute use_for_communication
+    #   @return [Boolean] whether the email address (see {#email}) of
+    #     the user is/will be used to send messages/announcements
+    attribute :use_for_communication
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the user was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the user was last updated
+    attribute :updated_at
   end
 
 end