flexipass 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9c91b169d3c20a41871c20a3983a969974ff3d25097f518542837a49d88eada
+  data.tar.gz: ec6209b051dd70dfc730bdcec81e877d64c339c1d317b8b05f61be2263e9fc64
+SHA512:
+  metadata.gz: 25431ca3666a7063cedfd9c50e665a6c837a6e6ad4e0d1043c58acf6a025a19ff47d51f5f665d0a87c8b1957f347023bcd0d1400bfeec04ccbe355aa602debc9
+  data.tar.gz: 6f02dfe29466cd84129ca3548cd2447cc98b1fb5456a1f90464fe21a597ba4786da585cf1630b6585b5902cf993f563fff829c78008a0f29d4865dd119e0fec5

data/.byebug_history

@@ -0,0 +1,14 @@
+c
+DateTime.parse("hello #{time}")
+DateTime.parse("#{date} #{time}")
+date
+DateTime.parse("#{date} #{time}")
+c
+date
+c
+label
+time
+date
+c
+validate_date_time(params[:Checkin_date], params[:Checkin_time], "Check-in")
+params[:Checkin_date]

data/lib/flexipass/api_error.rb

@@ -0,0 +1,3 @@
+module Flexipass
+  class ApiError < StandardError; end
+end

data/lib/flexipass/client.rb

@@ -0,0 +1,63 @@
+require 'faraday'
+require 'base64'
+
+module Flexipass
+  class Client
+    def initialize
+      Flexipass.configuration.validate!
+      @conn = Faraday.new(url: Flexipass.configuration.server_address) do |faraday|
+        if Flexipass.configuration.enable_logging
+          # Create a logger instance
+          logger = Logger.new(STDOUT)
+          logger.level = Logger::DEBUG
+          faraday.response :logger, logger, bodies: true  # Set bodies: true to log request and response bodies
+        end
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.headers['Authorization'] = basic_auth_header
+      end
+    end
+
+    def mobile_key
+      @mobile_key ||= MobileKey.new(self)
+    end
+
+    def door
+      @door ||= Door.new(self)
+    end
+
+    def company
+      @company ||= Company.new(self)
+    end
+
+    def send_request(method, endpoint, params = {})
+      response = @conn.send(method.downcase) do |req|
+        req.url endpoint
+        req.params['companyToken'] = Flexipass.configuration.company_token
+        req.body = params.to_json if ['POST', 'PUT'].include?(method.upcase)
+      end
+
+      handle_response(response)
+    end
+
+    private
+
+    def basic_auth_header
+      credentials = "#{Flexipass.configuration.username}:#{Flexipass.configuration.password}"
+      encoded_credentials = Base64.strict_encode64(credentials)
+      "Basic #{encoded_credentials}"
+    end
+
+    def handle_response(response)
+      case response.status
+      when 200..299
+        JSON.parse(response.body)
+      else
+        raise ApiError.new("API request failed with status #{response.status}: #{response.body}")
+      end
+    rescue JSON::ParserError
+      response.body
+    end
+  end
+end

data/lib/flexipass/company.rb

@@ -0,0 +1,15 @@
+module Flexipass
+  class Company
+    def initialize(client)
+      @client = client
+    end
+
+    def details
+      @client.send_request('GET', '/Flexipass/rest/webapi/getCompanyDetails')
+    end
+
+    def permissions
+      @client.send_request('GET', '/Flexipass/rest/webapi/getPermissionList')
+    end
+  end
+end

data/lib/flexipass/configuration.rb

@@ -0,0 +1,42 @@
+# lib/flexipass/configuration.rb
+
+module Flexipass
+  class Configuration
+    attr_accessor :username, :password, :company_token, :environment, :enable_logging
+    attr_reader :server_address
+
+    DEV_SERVER = 'https://dev.flexipass.it'
+    PROD_SERVER = 'https://flexipass.it'
+
+    def initialize
+      @environment = :development
+      set_server_address
+    end
+
+    def environment=(env)
+      @environment = env.to_sym
+      set_server_address
+    end
+
+    def validate!
+      raise ConfigurationError, 'Username must be set' if @username.nil?
+      raise ConfigurationError, 'Password must be set' if @password.nil?
+      raise ConfigurationError, 'Company token must be set' if @company_token.nil?
+      raise ConfigurationError, "Invalid environment: #{@environment}. Must be :development or :production" unless [:development, :production].include?(@environment)
+    end
+
+    private
+
+    def set_server_address
+      @server_address = if @environment == :development
+                          DEV_SERVER
+                        elsif @environment == :production
+                          PROD_SERVER
+                        end
+    end
+
+
+  end
+
+  class ConfigurationError < StandardError; end
+end

data/lib/flexipass/door.rb

@@ -0,0 +1,11 @@
+module Flexipass
+  class Door
+    def initialize(client)
+      @client = client
+    end
+
+    def list
+      @client.send_request('GET', '/Flexipass/rest/webapi/getDoorList')
+    end
+  end
+end

data/lib/flexipass/mobile_key.rb

@@ -0,0 +1,84 @@
+module Flexipass
+  class MobileKey
+    def initialize(client)
+      @client = client
+    end
+
+    def create(params)
+      validate_params(params)
+      @client.send_request('POST', '/Flexipass/rest/webapi/createMobileKey', params)
+    end
+
+    def update(mobile_key_id, params)
+      validate_params(params)
+      @client.send_request('PUT', "/Flexipass/rest/webapi/updateMobileKey?mkID=#{mobile_key_id}", params)
+    end
+
+    def delete(mobile_key_id)
+      @client.send_request('DELETE', "/Flexipass/rest/webapi/deleteMobileKey?mkID=#{mobile_key_id}")
+    end
+
+    def list(door, params)
+      validate_list_params(params)
+      params[:Door] = door
+      @client.send_request('POST', "/Flexipass/rest/webapi/getMobileKeyList", params)
+    end
+
+    def details(mobile_key_id)
+      @client.send_request('GET', "/Flexipass/rest/webapi/getMobileKeyDetails?mkID=#{mobile_key_id}")
+    end
+
+    def send_mail(mobile_key_id)
+      @client.send_request('GET', "/Flexipass/rest/webapi/sendMail?mkID=#{mobile_key_id}")
+    end
+
+    def send_sms(mobile_key_id)
+      @client.send_request('GET', "/Flexipass/rest/webapi/sendSMS?mkID=#{mobile_key_id}")
+    end
+
+    private
+
+    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)
+      raise ArgumentError, "Missing required parameters: #{missing_params.join(', ')}" if missing_params.any?
+
+      validate_date_time(params[:Checkin_date], params[:Checkin_time], "Check-in")
+      validate_date_time(params[:Checkout_date], params[:Checkout_time], "Check-out")
+
+      validate_mobile_key_type(params[:MobileKeyType])
+    end
+
+    def validate_date_time(date, time, label)
+      date_format = /^(\d{4}-\d{2}-\d{2})$/
+      time_format = /^(\d{2}:\d{2}:\d{2})$/
+
+      unless date.match?(date_format) && time.match?(time_format)
+        raise ArgumentError, "Invalid #{label} date or time format"
+      end
+      begin
+        DateTime.parse("#{date} #{time}")
+      rescue ArgumentError
+        raise ArgumentError, "Invalid #{label} date or time format"
+      end
+    end
+
+    def validate_list_params(params)
+      date_time_format = /(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})$/
+
+      unless params[:StartDate].match?(date_time_format)
+        raise ArgumentError, "Invalid StartDate format"
+      end
+
+      unless params[:EndDate].match?(date_time_format)
+        raise ArgumentError, "Invalid EndDate format"
+      end
+    end
+
+    def validate_mobile_key_type(type)
+      unless [0, 1].include?(type)
+        raise ArgumentError, "Invalid MobileKeyType. Must be 0 or 1"
+      end
+    end
+  end
+end

data/lib/flexipass/version.rb

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

data/lib/flexipass.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'flexipass/version'
+require 'flexipass/configuration'
+require 'flexipass/client'
+require 'flexipass/mobile_key'
+require 'flexipass/door'
+require 'flexipass/company'
+require 'flexipass/api_error'
+
+module Flexipass
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: flexipass
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kellen Kyros
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.11
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.23.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.23.1
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A Ruby gem allows you to easily interact with Flexipass APIs
+email:
+- kellenkyros@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- lib/flexipass.rb
+- lib/flexipass/api_error.rb
+- lib/flexipass/client.rb
+- lib/flexipass/company.rb
+- lib/flexipass/configuration.rb
+- lib/flexipass/door.rb
+- lib/flexipass/mobile_key.rb
+- lib/flexipass/version.rb
+homepage: https://github.com/kellenkyros/flexipass
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kellenkyros/flexipass
+  source_code_uri: https://github.com/kellenkyros/flexipass
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Flexipass mobile key integration gem.
+test_files: []