flexipass 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d5e87b63951ed59179a0bcba33c5ce4dd98fe5882a1eb0922c6ee41133fc63
-  data.tar.gz: b6f86a1cd68c8d8341fab16131a3cb43f08f4d5fc8e00f78d035d3b2e35052a3
+  metadata.gz: 30a77fddc6cce4ad68a97f565d5cab887d90f4fc177e295546d899b910c11894
+  data.tar.gz: b8111112a54163738e08b5dbb927dedd568ddf974ae00e131d29bd9c94eb5496
 SHA512:
-  metadata.gz: 2318a9dcec69e5d8fa49c9dc4b2883ccc2bfdc2d776de7f0e7370bbed0bdde9cb5d177f588c8bd55c238a5a9de4d1689c719638c1fd6f8f2f673b452bd12c7f0
-  data.tar.gz: ed2fc467ffd649d6d56dadad0caad2a9c6081a160f5101772700960c597a83728fc06b9018bbad58793f4d21e577b23d81a042ee65298206376640f452e3b4f4
+  metadata.gz: dc429547a93dffc3105af485abe852085a5def8cee5e84b4773689fc3b8420cb8312fbdb0063eceb2b2b6ad604c10d2dac200e86242fbbf1288e25845cd8cfc6
+  data.tar.gz: 79b30e43449408be529566eb63f8a18cca99d3896d29e6afcee695bd6587607d2fda94fa06586844103b7bf0fbad845035d833335e507f466ba568623c291898

data/lib/flexipass/client.rb

@@ -2,6 +2,7 @@ require 'faraday'
 require 'base64'
 
 module Flexipass
+  # The Client class is responsible for making API requests to the Flexipass server.
   class Client
     def initialize
       Flexipass.configuration.validate!
@@ -19,18 +20,28 @@ module Flexipass
       end
     end
 
+    # Returns an instance of the MobileKey class.
     def mobile_key
       @mobile_key ||= MobileKey.new(self)
     end
 
+    # Returns an instance of the Door class.
     def door
       @door ||= Door.new(self)
     end
 
+    # Returns an instance of the Company class.
     def company
       @company ||= Company.new(self)
     end
 
+    # Sends a request to the Flexipass server.
+    #
+    # @param method [String] The HTTP method for the request.
+    # @param endpoint [String] The API endpoint.
+    # @param params [Hash] The request parameters.
+    # @return [Hash] The parsed JSON response from the server.
+    # @raise [ApiError] If the API request fails.
     def send_request(method, endpoint, params = {})
       response = @conn.send(method.downcase) do |req|
         req.url endpoint
@@ -43,12 +54,21 @@ module Flexipass
 
     private
 
+    # Generates the basic authentication header.
+    #
+    # @return [String] The basic authentication header.
     def basic_auth_header
       credentials = "#{Flexipass.configuration.username}:#{Flexipass.configuration.password}"
       encoded_credentials = Base64.strict_encode64(credentials)
       "Basic #{encoded_credentials}"
     end
 
+    # Handles the API response.
+    #
+    # @param response [Faraday::Response] The API response.
+    # @return [Hash] The parsed JSON response if the response status is between 200 and 299.
+    # @return [String] The response body if the JSON parsing fails.
+    # @raise [ApiError] If the response status is not between 200 and 299.
     def handle_response(response)
       case response.status
       when 200..299

data/lib/flexipass/company.rb

@@ -1,13 +1,23 @@
 module Flexipass
+  # Represents a company in the Flexipass system.
   class Company
+    # Initializes a new instance of the Company class.
+    #
+    # @param client [Object] The client object used to communicate with the Flexipass API.
     def initialize(client)
       @client = client
     end
 
+    # Retrieves the details of the company.
+    #
+    # @return [Hash] The company details.
     def details
       @client.send_request('GET', '/Flexipass/rest/webapi/getCompanyDetails')
     end
 
+    # Retrieves the permissions list for the company.
+    #
+    # @return [Array] The list of permissions.
     def permissions
       @client.send_request('GET', '/Flexipass/rest/webapi/getPermissionList')
     end

data/lib/flexipass/configuration.rb

@@ -1,6 +1,7 @@
 # lib/flexipass/configuration.rb
 
 module Flexipass
+  # The `Flexipass` module provides configuration options for the Flexipass gem.
   class Configuration
     attr_accessor :username, :password, :company_token, :environment, :enable_logging
     attr_reader :server_address
@@ -18,6 +19,8 @@ module Flexipass
       set_server_address
     end
 
+    # Validates the configuration options.
+    # Raises a `ConfigurationError` if any required options are missing or if the environment is invalid.
     def validate!
       raise ConfigurationError, 'Username must be set' if @username.nil?
       raise ConfigurationError, 'Password must be set' if @password.nil?
@@ -34,9 +37,8 @@ module Flexipass
                           PROD_SERVER
                         end
     end
-
-
   end
 
+  # Custom error class for configuration-related errors.
   class ConfigurationError < StandardError; end
 end

data/lib/flexipass/door.rb

@@ -1,9 +1,16 @@
 module Flexipass
+  # Represents a door in the Flexipass system.
   class Door
+    # Initializes a new instance of the Door class.
+    #
+    # @param client [Object] The client object used to communicate with the Flexipass API.
     def initialize(client)
       @client = client
     end
 
+    # Retrieves a list of doors
+    #
+    # @return [Object] The response object containing the list of doors.
     def list
       @client.send_request('GET', '/Flexipass/rest/webapi/getDoorList')
     end

data/lib/flexipass/mobile_key.rb

@@ -1,43 +1,97 @@
 module Flexipass
+  # Represents a mobile key in the Flexipass system.
   class MobileKey
+    # Initializes a new instance of the MobileKey class.
+    #
+    # @param client [Object] The client object used to communicate with the Flexipass API.
     def initialize(client)
       @client = client
     end
 
+    # Creates a new mobile key.
+    #
+    # @param params [Hash] The parameters for creating the mobile key.
+    # @option params [String] :Name The name of the mobile key holder.
+    # @option params [String] :Surname The surname of the mobile key holder.
+    # @option params [String] :Mail The email of the mobile key holder.
+    # @option params [String] :Door The door associated with the mobile key.
+    # @option params [String] :Checkin_date The check-in date of the mobile key.
+    # @option params [String] :Checkin_time The check-in time of the mobile key.
+    # @option params [String] :Checkout_date The check-out date of the mobile key.
+    # @option params [String] :Checkout_time The check-out time of the mobile key.
+    # @option params [Integer] :MobileKeyType The type of the mobile key (0 or 1).
+    # @raise [ArgumentError] If any required parameters are missing or if the date or time format is invalid.
     def create(params)
       validate_params(params)
       @client.send_request('POST', '/Flexipass/rest/webapi/createMobileKey', params)
     end
 
+    # Updates an existing mobile key.
+    #
+    # @param mobile_key_id [String] The ID of the mobile key to update.
+    # @param params [Hash] The parameters for updating the mobile key.
+    # @option params [String] :Name The name of the mobile key holder.
+    # @option params [String] :Surname The surname of the mobile key holder.
+    # @option params [String] :Mail The email of the mobile key holder.
+    # @option params [String] :Door The door associated with the mobile key.
+    # @option params [String] :Checkin_date The check-in date of the mobile key.
+    # @option params [String] :Checkin_time The check-in time of the mobile key.
+    # @option params [String] :Checkout_date The check-out date of the mobile key.
+    # @option params [String] :Checkout_time The check-out time of the mobile key.
+    # @option params [Integer] :MobileKeyType The type of the mobile key (0 or 1).
+    # @raise [ArgumentError] If any required parameters are missing or if the date or time format is invalid.
     def update(mobile_key_id, params)
       validate_params(params)
       @client.send_request('PUT', "/Flexipass/rest/webapi/updateMobileKey?mkID=#{mobile_key_id}", params)
     end
 
+    # Deletes a mobile key.
+    #
+    # @param mobile_key_id [String] The ID of the mobile key to delete.
     def delete(mobile_key_id)
       @client.send_request('DELETE', "/Flexipass/rest/webapi/deleteMobileKey?mkID=#{mobile_key_id}")
     end
 
+    # Lists mobile keys for a specific door.
+    #
+    # @param door [String] The door for which to list mobile keys.
+    # @param params [Hash] The parameters for listing mobile keys.
+    # @option params [String] :StartDate The start date for filtering mobile keys.
+    # @option params [String] :EndDate The end date for filtering mobile keys.
+    # @raise [ArgumentError] If the date format is invalid.
     def list(door, params)
       validate_list_params(params)
       params[:Door] = door
       @client.send_request('POST', "/Flexipass/rest/webapi/getMobileKeyList", params)
     end
 
+    # Retrieves details of a mobile key.
+    #
+    # @param mobile_key_id [String] The ID of the mobile key to retrieve details for.
     def details(mobile_key_id)
       @client.send_request('GET', "/Flexipass/rest/webapi/getMobileKeyDetails?mkID=#{mobile_key_id}")
     end
 
+    # Sends an email for a mobile key.
+    #
+    # @param mobile_key_id [String] The ID of the mobile key to send the email for.
     def send_mail(mobile_key_id)
       @client.send_request('GET', "/Flexipass/rest/webapi/sendMail?mkID=#{mobile_key_id}")
     end
 
+    # Sends an SMS for a mobile key.
+    #
+    # @param mobile_key_id [String] The ID of the mobile key to send the SMS for.
     def send_sms(mobile_key_id)
       @client.send_request('GET', "/Flexipass/rest/webapi/sendSMS?mkID=#{mobile_key_id}")
     end
 
     private
 
+    # Validates the parameters for creating or updating a mobile key.
+    #
+    # @param params [Hash] The parameters to validate.
+    # @raise [ArgumentError] If any required parameters are missing or if the date or time format is invalid.
     def validate_params(params)
       required_params = [:Name, :Surname, :Mail, :Door, :Checkin_date, :Checkin_time, :Checkout_date, :Checkout_time, :MobileKeyType]
       missing_params = required_params - params.keys.map(&:to_sym)
@@ -49,6 +103,12 @@ module Flexipass
       validate_mobile_key_type(params[:MobileKeyType])
     end
 
+    # Validates the date and time format.
+    #
+    # @param date [String] The date to validate.
+    # @param time [String] The time to validate.
+    # @param label [String] The label for the date or time (e.g., "Check-in").
+    # @raise [ArgumentError] If the date or time format is invalid.
     def validate_date_time(date, time, label)
       date_format = /^(\d{4}-\d{2}-\d{2})$/
       time_format = /^(\d{2}:\d{2}:\d{2})$/
@@ -63,6 +123,10 @@ module Flexipass
       end
     end
 
+    # Validates the parameters for listing mobile keys.
+    #
+    # @param params [Hash] The parameters to validate.
+    # @raise [ArgumentError] If the date format is invalid.
     def validate_list_params(params)
       date_time_format = /(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})$/
 
@@ -75,6 +139,10 @@ module Flexipass
       end
     end
 
+    # Validates the mobile key type.
+    #
+    # @param type [Integer] The mobile key type.
+    # @raise [ArgumentError] If the mobile key type is invalid.
     def validate_mobile_key_type(type)
       unless [0, 1].include?(type)
         raise ArgumentError, "Invalid MobileKeyType. Must be 0 or 1"

data/lib/flexipass/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flexipass
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/flexipass.rb

@@ -9,12 +9,25 @@ require 'flexipass/company'
 require 'flexipass/api_error'
 
 module Flexipass
+  # The main module for Flexipass gem.
+  #
+  # This module provides configuration options for Flexipass.
   class Error < StandardError; end
 
   class << self
     attr_accessor :configuration
   end
 
+  # Configures Flexipass with the given options.
+  #
+  # Example:
+  # Flexipass.configure do |config|
+  #   config.username = 'your_username'
+  #   config.password = 'your_password'
+  #   config.company_token = 'your_company_token'
+  #   config.environment = :development # or :production
+  #   config.enable_logging = true # optional, defaults to false
+  # end
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexipass
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Kellen Kyros
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-19 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -98,6 +98,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.36
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.36
 description: A Ruby gem allows you to easily interact with Flexipass APIs
 email:
 - kellenkyros@gmail.com