flexipass 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7353ebe300c9abc909c840d1a6be3057d80abaf49841186cb1b3399a4cd73912
-  data.tar.gz: 6cfa445710501c907d550d05d8f63ae546a89c3ba0ea199fe604e27c61f7d516
+  metadata.gz: aa9180bcd9e5f4de80776f1e6e58d46e07b1554becc568f0516d483f1f70ad01
+  data.tar.gz: 511b937fe43d4074213f2f5e1f5b0b88ce4f85121138d54f0da697ed22d53d4c
 SHA512:
-  metadata.gz: eb285a773a52917e8e35131385e67abed093ae4670f0e5e8642de216f31a6339fc13da33d1ed10d735dd87a21178bbf24d982ccb645483f0ccca78dbf0de9d93
-  data.tar.gz: 750b8754b734b1d0d813fc62864412af259c2a37300b84e036c9d5d2f915705fa18f9d693667ee845f22ad6626123a0764ba0dbb13a07a415eb5aaf19aab10be
+  metadata.gz: 013eb6052866d041514a2dcb747c97f1546ff28b74e6039a0799a031ffac8c1881c13a691461956ee5357cab2eb522ca62d8cc146f59429987c560da32abfe30
+  data.tar.gz: baed27e1fd15d18d051727f5a8421d2de3fe2dd28f6687a6c7111fd7906370878fc4bddd4e97cb0e7e2aa48a5ac6eaac0ef1cb35d002bb4bb2f0932943ad304b

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.3"
+  VERSION = "0.1.5"
 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.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Kellen Kyros
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-20 00:00:00.000000000 Z
+date: 2024-07-25 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
@@ -118,8 +132,7 @@ homepage: https://github.com/kellenkyros/flexipass
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/kellenkyros/flexipass
-  source_code_uri: https://github.com/kellenkyros/flexipass
+  documentation_uri: https://www.rubydoc.info/gems/flexipass/0.1.5
 post_install_message:
 rdoc_options: []
 require_paths: