xasin-telegram 0.2.3 → 0.3.0

data/lib/xasin/telegram/TestHTTPCore.rb

@@ -3,6 +3,10 @@ require_relative 'HTTPCore.rb'
 
 module Xasin
 	module Telegram
+		# This is a purely test-related class. It implements all of HTTPCore's
+		# functionality, but does not connect to the Telegram API. Instead,
+		# it simply saves the last POST request, and simulates received requests,
+		# allowing testing.
 		class TestCore < HTTPCore
 			attr_accessor :lastPostData, :lastPostRequest
 			attr_reader   :currentMessageID
@@ -10,6 +14,8 @@ module Xasin
 
 			def initialize()
 				prepare();
+
+				@receptors = Array.new();
 			end
 
 			def prepare()
@@ -19,14 +25,11 @@ module Xasin
 				@currentMessageID = rand(0..9999);
 
 				@toReturn = {
-					ok: true,
-					result: {
-						message_id: @currentMessageID
-					}
-				}
-			end
-
-			def attach_receptor(receptor)
+									ok: true,
+									result: {
+										message_id: @currentMessageID
+									}
+								}
 			end
 
 			def perform_post(postRequest, postData)
@@ -35,6 +38,25 @@ module Xasin
 
 				return @toReturn;
 			end
+
+			def simulate_send_packet(packet)
+				@receptors.each do |r|
+					r.handle_packet(packet);
+				end
+			end
+
+			def simulate_sent_message(text, chatID: "test", reply_id: nil )
+				outData = Hash.new();
+
+				outData[:chat] = {id: chatID};
+				outData[:text] = text;
+
+				if(reply_id)
+					outData[:reply_to_message] = reply_id;
+				end
+
+				simulate_send_packet({message: outData});
+			end
 		end
 	end
 end

data/lib/xasin/telegram/User.rb

@@ -0,0 +1,142 @@
+
+require_relative 'Chat.rb'
+
+module Xasin
+	module Telegram
+		# Telegram User class.
+		#
+		# This class is an extension of a Telegram {Chat} object that
+		# represents a DM with a User, and represents the user himself.
+		# This is because Telegram's User ID is equivalent to the
+		# Chat ID of the DM with the User.
+		class User	< Chat
+			# Username, without the @
+			attr_reader :username
+			# First name, always guaranteed to be set.
+			attr_reader :first_name
+			# Last name, may not be set.
+			attr_reader :last_name
+
+			# A human readable name.
+			# Overrides {Chat#casual_name}
+			attr_reader :casual_name
+
+			# List of permissions this user has.
+			# This Array of Strings will be used to check against
+			# a executed command, to see if the User has appropriate rights
+			# to run said command.
+			#
+			# Note that the {Handler#permissions_list} will be used to expand
+			# this list, i.e. if the permissions list is:
+			# `{ 'admin' => ['basic_rights'] }`
+			# And the user has the 'admin' permission, he will also have
+			# basic_rights *without them being listed in {#permissions}*
+			#
+			# Use {#has_permissions?} to check if a user has a certain permission.
+			attr_reader :permissions
+
+			# Permanent user state. Will be saved to disk.
+			# @todo Actually save to disk.
+			attr_reader :perm_state
+
+			# Temporary state. Will be lost of restart, should be cleaned
+			# out and only used for intermediary work.
+			attr_accessor :temp_state
+
+			# Initialize a new user object.
+			#
+			# Pass the handler used for this User as well as the
+			# Hash containing Telegram's "User" Object.
+			def initialize(handler, user_info)
+				super(handler, user_info);
+
+				@username   = user_info[:username]
+				@first_name = user_info[:first_name]
+				@last_name  = user_info[:last_name]
+
+				@casual_name = user_info[:first_name]
+
+				@permissions = user_info[:permissions] || []
+				@perm_state  = user_info[:perm_state] || {}
+			end
+
+			def add_permissions(list)
+				list = [list].flatten
+
+				list.each do |perm|
+					next if perm.is_a? Symbol
+					next if perm.is_a? String
+
+					raise ArgumentError, "Permission must be String or Symbol!"
+				end
+
+				@permissions = (@permissions + list).uniq
+			end
+			alias add_permission add_permissions
+
+			def take_permissions(list)
+				list = [list].flatten
+
+				list.each do |perm|
+					next if perm.is_a? Symbol
+					next if perm.is_a? String
+
+					raise ArgumentError, "Permission must be String or Symbol!"
+				end
+
+				@permissions -= list;
+			end
+			alias take_permission take_permissions
+
+			# Check if a user has all given permissions.
+			# Will run {#has_permission} against every permission
+			# in the list, returns false if any one permission is not met.
+			#
+			# An empty list counts as true
+			def has_permissions?(*targets)
+				targets = targets.flatten
+
+				return true if targets.nil?
+				return true if @permissions.include? :sudo
+
+				targets.each do |perm|
+					return false unless has_permission? perm
+				end
+
+				true
+			end
+
+			# Check whether a user has a given permission.
+			#
+			# This function will check if the given permission is in the
+			# User's {#permissions}. It will also use the
+			# {Handler#permissions_list} to expand the user's permissions,
+			# i.e. if the permissions list is:
+			# `{ 'admin' => ['basic_rights'] }`
+			# And the user has the 'admin' permission, he will also have
+			# basic_rights *without them being listed in {#permissions}*
+			#
+			# nil will return true.
+			#
+			# @note This will always return true if the user has the :sudo
+			#   permission, use only for full admin access!
+			def has_permission?(target)
+				return true if @permissions.include? :sudo
+				return true if target.nil?
+
+				unchecked = @permissions.dup
+				checked = {}
+
+				while perm = unchecked.pop
+					next if checked[perm]
+					return true if perm == target
+
+					unchecked += @handler.permissions_list[perm] || []
+					checked[perm] = true
+				end
+
+				false
+			end
+		end
+	end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: xasin-telegram
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Xasin
+- Neira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-18 00:00:00.000000000 Z
+date: 2020-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt-sub_handler
@@ -32,11 +33,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/xasin/bad_config.yml
+- lib/xasin/bad_test.rb
 - lib/xasin/telegram.rb
+- lib/xasin/telegram/Chat.rb
+- lib/xasin/telegram/GroupingAdapter.rb
 - lib/xasin/telegram/HTTPCore.rb
+- lib/xasin/telegram/Handler.rb
+- lib/xasin/telegram/KeyboardLayout.rb
 - lib/xasin/telegram/MQTT_Adapter.rb
+- lib/xasin/telegram/Message.rb
+- lib/xasin/telegram/OnCommand.rb
+- lib/xasin/telegram/OnMessage.rb
 - lib/xasin/telegram/SingleUser.rb
 - lib/xasin/telegram/TestHTTPCore.rb
+- lib/xasin/telegram/User.rb
 homepage: https://github.com/XasWorks/XasCode/tree/GEM_Telegram/Ruby/Telegram
 licenses:
 - GPL-3.0
@@ -57,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Xasin's Telegram gem