DEV Community: Nimo Mohamed

RateMyReads API

Nimo Mohamed — Thu, 23 May 2024 10:41:46 +0000

Introduction

RateMyReads, a platform dedicated to book enthusiasts, relies on a robust API to facilitate seamless user interaction and efficient data management. This article delves into the development journey of RateMyReads API, outlining the technologies utilized, challenges encountered, and future directions.

Project Description

The RateMyReads API project was a solo endeavor, with the goal of crafting an intuitive platform for users to manage their book preferences and engage with a vibrant community of readers. Spearheaded entirely by me, the API development journey spanned from inception to completion, ensuring every aspect of the platform's functionality was meticulously crafted to deliver an exceptional user experience.

Technologies Used

Python: Chosen for its readability and extensive libraries, Python served as the primary programming language.
Django: Leveraged as a high-level Python web framework, Django accelerated development with its built-in features and adherence to the DRY principle.
Django Rest Framework (DRF): Complemented Django by simplifying API development, providing tools for serialization, authentication, and authorization.
Postman: Utilized as a comprehensive testing and debugging tool to ensure the reliability and functionality of RateMyReads API.
Docker: Employed for containerization, simplifying dependency management and deployment processes.

Developments

Throughout the development process, several milestones were achieved:

RESTful API Implementation: A robust API architecture was developed, seamlessly connecting user, book, and comment models for efficient data management.
User Authentication and Authorization: Robust authentication mechanisms were implemented to ensure secure access to the platform, prioritizing user data privacy.
Email Notification Integration: An email backend was integrated to enhance user communication, providing confirmation emails upon sign-up for a smooth registration process.

Challenges & Areas of Improvement

While significant progress was made, challenges were encountered:

Deployment Issues: The learning curve with deployment frameworks posed challenges during deployment, highlighting the need for optimization.
Areas for Improvement: Future iterations will focus on optimizing the deployment process, enhancing API functionality and security, and improving user experience with additional features.

Key Findings

Thorough Deployment Research: Emphasized the importance of mastering deployment procedures for smoother project deployment, prompting further exploration into deployment strategies.
Continuous Technology Learning: Highlighted the value of staying updated with new technologies for enhanced development processes, inspiring ongoing learning and adaptation.

Next Steps

Optimize Deployment Process: Research and implement deployment strategies to streamline the deployment process and mitigate deployment-related challenges.
Enhance API Functionality and Security: Continuously improve API functionality and security measures to ensure a seamless and secure user experience.
Incorporate Additional Features: Gather user feedback to identify and implement additional features that enhance the overall user experience and engagement on the platform.

Conclusion

The development of RateMyReads API has been an enriching experience, marked by significant achievements and valuable learnings. Despite challenges, I remain committed to refining and expanding the platform to meet user needs effectively and enhance overall functionality and usability.

Project Repository

https://github.com/Nimo08/RateMyReads-API

Harvest Hex: Cultivate Fun!

Nimo Mohamed — Fri, 19 Jan 2024 10:16:07 +0000

Purpose of the Project

The purpose of Harvest Hex is to provide a simple and enjoyable 2D runner game experience using the Pygame library. The game offers players the opportunity to navigate a pixelated world set in a forest, controlling a character through obstacles. The design emphasizes retro-style graphics, straightforward gameplay, and a stress-free environment with the option to restart the game upon losing.

Project Timeline

As a sole developer, I took on the roles of designing, coding, and testing the game. The timeline for the project spanned 01/12/2023 to 18/01/2024, with various stages of development and testing.

Target Audience

Harvest Hex was created for individuals who appreciate retro-style 2D games, enjoy pixelated characters, and seek a relaxing gaming experience. The game is accessible to both gaming enthusiasts and newcomers, aiming to provide a straightforward and enjoyable gameplay session for all.

Personal Focus

As a novice in game development, my personal focus during the creation of Harvest Hex was to explore the fundamentals of game design, programming, and the Pygame module. This project served as a learning opportunity to gain hands-on experience in developing a simple yet engaging game. The goal was to create an accessible and enjoyable gaming experience while honing my skills as a game developer.

Diagrammatic Representation of Harvest Hex Architecture

Technologies Used

Harvest Hex has been developed using Pygame, a Python module tailored for game development. Pygame provides tools for graphics, sounds and player input, allowing for the easy integration of pixelated characters and backgrounds, contributing to the game’s retro charm.

Features

Endless runner gameplay with obstacles and challenges.
Pixel art style for a visually engaging experience.
Simple controls for an easy and enjoyable gaming experience.
Score tracking to encourage competition and improvement.

Challenges Faced

Initially, the aim was to offer users a hassle-free gaming experience with a standalone executable – a one-stop solution for downloading and playing independently. However, as the development progressed, I re-evaluated this goal to enhance the overall user experience. The current implementation necessitates bundling the executable file with the rest of the game assets. While it deviates from the initial plan, this decision prioritizes seamless playability and accessibility.

In practical terms, this means that to enjoy Harvest Hex, users need to have all the necessary files in one place. While it might differ from the convenience of a standalone executable, it ensures that the game operates smoothly and is readily accessible when all the required components are present. This adjustment allowed for the prioritization of user satisfaction, providing a game that is not only enjoyable but also easy to access and play without complications.

Key Findings

Engaging in game development has been an illuminating journey, unveiling a realm of intricacies within the technical landscape of this craft. The project delved into captivating aspects such as animations, frame rates, and collision detection, unraveling the underlying complexities that contribute to the seamless and immersive gaming experience. These technical interests have not only broadened my understanding but also sparked a newfound intrigue, inspiring further exploration into the nuanced details that shape the world of game development.

About the developer

I'm Nimo Mohamed, a passionate enthusiast of all things fantasy, especially when it comes to literature. The development of Harvest Hex has proven to be an enjoyable exploration into the captivating realm of gaming.

Harvest Hex Github Link

https://github.com/Nimo08/Harvest-Hex

Harvest Hex Landing Page

https://harvest-hex.onrender.com/

Contact

Let's Connect on Linkedin: https://www.linkedin.com/in/nimo-mohamed/

What happens when you type https://www.google.com in your browser and press Enter

Nimo Mohamed — Thu, 16 Nov 2023 10:48:12 +0000

If you have watched any heist movie then you know, the wonder always comes from the behind-the-scenes events; all the detailed machinations set in place by the group of thieves that are played out in a grand reveal as every part of their plan falls into place just so.
When a user types in the URL into any browser of their choice, it takes seconds at most to receive results, the highest of which are the most accurate.
However, there are a lot of components in play under the hood communicating to allow the user access to the website as well as allowing them to interact with said website. This article aims to explain the processes that occur after pressing Enter.

Domain Name System (DNS)

Google.com is a lot easier to remember than a unique set of characters assigned to google’s domain name.
The DNS performs the conversion of the domain name typed into the browser into an IP address i.e., the digital equivalent of a postal address which identifies devices across the internet.
The client computer performs the series of steps below to get ahold of the required IP address.
The diagram below depicts the communication that occurs when the client computer submits a DNS query to find the matching IP address to the domain name entered by the user.
For each step in the diagram, the handover is performed if the current component does not contain the matching IP address.

Component Key

Hosts file & Cache: this is a temporary storage for previously visited IP address that allows the client computer to quickly access the requested website.
DNS Resolver: acts as an intermediary between the client computer and the other DNS servers
Root Name Server: main reference in the DNS hierarchy; provides directions to the correct TLD nameserver.
TLD Name server: stores information about domain names i.e. the last section of a domain name such as .com; for google.com the .com TLD name server leads to the location of the matching IP address in the final server; authoritative nameserver
Authoritative Name server: contains information related to domain names

TCP/IP (Transmission Control Protocol/Internet Protocol)

This refers to a suite of communications protocols used to interconnect network devices on the internet or any private network.
Computers use agreed-upon sets of rules i.e., protocols to communicate; when the same protocol is used, communication between devices is seamless, as opposed to the chaos that would occur if multiple protocols are used simultaneously.
Earlier on in the article, we touched on IP addresses and the part they play in allowing devices across the internet to communicate, TCP is the postman to IP’s postal address that enables the recipient to receive mail or the sender to send mail.
Information cannot be sent in one go using the above protocols, as this leads to potential loss of certain sections, therefore TCP/IP divides messages into packets to be sent separately and reassembled on the receiving end.

TCP/IP Layers

There are 4 layers involved in this process as explained below

Data Link layer: deals with the physical aspect of sending the packers i.e., media such as Ethernet cables, wireless networks etc
Internet layer: controls the movement of packets around the network
Transport layer: provides a reliable connection between the 2 devices essentially ensuring the receiving device has gotten hold of the all the packets
Application layer: this represents the applications that the user interacts with e.g. email

If you have heard that using public WiFi is not the safest option, that is because this form of communication is not private, thereby making the possible private data being sent vulnerable to access by unauthorized parties.

Firewalls

Historically firewalls referred to literal walls intended to contain fire from spreading to other buildings, this form of usage is close to the technological use of firewalls i.e., control of network traffic by selectively allowing or blocking data packets to pass through.
Firewalls enhance network security by intercepting malicious data packets and can be used with added DNS-based filtering to perform content filtering to deny access to unwanted URLs.
There are different types of firewalls namely: proxy firewalls, stateful firewalls, next-gen firewalls among others.
They can be deployed in different methods i.e., hardware-based, software-based or cloud firewalls.

HTTPS/SSL

When a user accesses a site on a browser, there are certain sites that have a padlock icon appearing next to the URL; this means that the site being accessed is secure.
HTTP is a protocol widely used for communication between browsers and web servers; HTTPS is the version of HTTP that has been secured by the Secure Sockets Layer (SSL) which encrypts the data being sent between a website and a browser in the user’s computer.
When a HTTPS connection to a webpage is requested, an exchange occurs between the website which sends its SSL certificate to the browser containing a public key to begin the secure session; this initiates an SSL handshake that encrypts communication between the browser and the website.

Load Balancer

In the quest for information retrieval across the internet, the user computer will encounter a load balancer which acts as a distributor of traffic to servers that contain the required information.
Load balancers rely on algorithms that dictate the distribution of traffic such as round-robin method whereby an authoritative nameserver returns the IP addresses of different servers in the server farm one by one.
Other algorithms such as weighted round-robin involve assignment of different weights to each server based on their priority or capacity.
Load balancers are essentially the bridge between the user computer and the servers containing the requested data.

Web Server

This server component is responsible for managing HTTP requests and responses, for a website, it accesses the source code and returns static content i.e. the HTML webpage of the website. Nginx is an example of a widely used web server.

Application Server

Provides the web server with the dynamic content of the website i.e., the business logic such as adding or updating information.

Here is a schema illustrating the flow of the request created when you type in a URL in your browser and press Enter.

References

https://www.hostinger.com/tutorials/what-is-dns
https://www.avast.com/c-what-is-tcp-ip#
https://nordlayer.com/learn/firewall/what-is-firewall/
https://www.instantssl.com/http-vs-https
https://aws.amazon.com/what-is/load-balancing/
https://en.wikipedia.org/wiki/Web_server

Introduction to Bash Scripting

Nimo Mohamed — Mon, 04 Sep 2023 12:14:13 +0000

Bash scripts are computer programs consisting of a series of commands that may be used in the command-line environment. They are commonly used for automating repetitive tasks in Linux systems.

Variable Assignment

The syntax below is used when assigning values to variables in Bash.

variable=value
echo $variable

The variable can be accessed in the code by prefixing the variable name with a '$' e.g. $variable as illustrated above.

Types of Variables

There are two types of variables in Bash.
Global variables: accessible anywhere in the script, regardless of scope, by default, every variable we create in Bash is global.
Local variables: confined to the section of code or function in which they are declared, they are created using the local keyword.

Difference between global and local variables.

#!/usr/bin/env bash
GLOBAL_VAR="This is a global variable"
function example {
      echo $GLOBAL_VAR
}
test # outputs: This is a global variable

#!usr/bin/env bash
function test {
local LOCAL_VAR="This is a local variable"
     echo $LOCAL_VAR
}
test # outputs: This is a local variable
echo $LOCAL_VAR # outputs nothing

Looping in Bash

There are three types of loops used in Bash: for loop, while loop and until loop. These loops have varying syntax but can carry out similar tasks when implemented in a Bash script.

for loop

Allows for specification of a list of values.

for NAME [in LIST ]; do COMMANDS; done

NAME represents the variable name; often denoted as ‘i’, LIST can be a list of words, strings, numbers etc, and COMMANDS represent any operating system commands, program or shell statement.
The loop will terminate once the NAME has taken on every value from LIST and no items are left in LIST.

#!/usr/bin/env bash
for i in {1..5};
do
echo $i
done

while loop

Allows for repetitive execution of a list of commands, as long as the command controlling the while loop is true.

while CONTROL-COMMAND; do CONSEQUENT-COMMANDS;done

CONTROL-COMMAND can represent any commands that will exit on success or failure.
The CONSEQUENT-COMMANDS can be any program or script.
When the CONTROL-COMMAND fails, i.e., is no longer true the loop exits and the done statement is executed.

#!/usr/bin/env bash
i=1
while [[ $i -le 10 ]];
do
    echo "While loop"
    (( i += 1))
done

until loop

Allows for repetitive execution of a list of commands as long as the TEST-COMMAND is false, once it succeeds, the loop terminates.

until TEST-COMMAND; do CONSEQUENT-COMMANDS; done

TEST-COMMAND can be any command that can exit on success or failure, CONSEQUENT-COMMANDS can represent any script or Linux command.

#!/usr/bin/env bash
i=0
until [ $i -eq 10 ];
do
    echo "Bash Scripting"
    (( i += 1))
done

References

https://tldp.org/LDP/Bash-Beginners-Guide/html/sect_09_01.html

Introduction to Sets in Python

Nimo Mohamed — Sat, 19 Aug 2023 10:40:09 +0000

Data structures are used to organize data for efficient access when needed.
They are a vital part of programming languages and in Python they include: lists, dictionaries,sets and tuples. This article provides a brief overview of the set data structure.

What are Sets?

These are unordered collections with no duplicate elements, they can be created using curly braces ({}) or the set() function.
Creating empty sets is only possible through the set() function, as the {} will create an empty dictionary, which is a different data structure altogether.
Sets are mutable and therefore elements can be added or removed.
Sets are used for membership testing i.e., checking whether a specific element is present in the sequence, elimination of duplicate entries as well as mathematical operations.

Creation of a set

Using set() function

>>> a = set((1, 2, 3))
>>> a
{1, 2, 3}

Using curly braces

>>> my_set = {'Red', 'Yellow', 'Blue'}
>>> type(my_set)
<class 'set'>

Modifying a set

The mutability of sets allows for the addition or removal of elements within a set, this is demonstrated below.

Adding elements

>>> my_set = {1, 2, 3, 4, 5, 6}
>>> my_set.update((67,))
>>> my_set
{1, 2, 3, 4, 5, 6, 67}

Removing elements

>>> my_set = {1, 2, 3, 4, 5, 6}
>>> my_set.remove((5))
>>> my_set
{1, 2, 3, 4, 6}

Mathematical operations in sets

Union: set of all the elements of both sets, without duplicates, uses the ‘|’ operator or the union() method

>>> a = {1, 2, 3, 4,  5, 6,} 
>>> b = {9, 10 ,1, 11, 4}
>>> a | b
{1, 2, 3, 4, 5, 6, 9, 10, 11}

>>> a.union(b)
{1, 2, 3, 4, 5, 6, 9, 10, 11}

Intersection: set of all common elements of both the sets, uses the ‘&’ operator or the intersection() method

>>> a = {1, 2, 3, 4,  5, 6,} 
>>> b = {9, 10 ,1, 11, 4}
>>> a & b
{1, 4}

>>> a.intersection(b)
{1, 4}

Difference: set of all elements in the first set that are not present in the second set, uses the ‘-’ operator or the difference() method

>>> a = {1, 2, 3, 4,  5, 6,} 
>>> b = {9, 10 ,1, 11, 4}
>>> a - b
{2, 3, 5, 6}

>>> a.difference(b)
{2, 3, 5, 6}

Symmetric difference: set of all elements that are either in the first set or the second set, but not in both, uses the ‘^’ operator or the symmetric_difference() method

>>> a = {1, 2, 3, 4,  5, 6,} 
>>> b = {9, 10 ,1, 11, 4}
>>> a ^ b
{2, 3, 5, 6, 9, 10, 11}

>>> a.symmetric_difference(b)
{2, 3, 5, 6, 9, 10, 11}

References

https://docs.python.org/3/tutorial/datastructures.html

Python: Imports and modules

Nimo Mohamed — Wed, 09 Aug 2023 08:32:36 +0000

When writing scripts in Python, some definitions prove to be useful in different scripts; instead of rewriting these definitions in several files, importing modules can make this process less cumbersome.

What is a module?

A module is a file containing Python definitions and statements, the specific file name is simply suffixed by .py
Importing a module in Python allows you to access the functions, classes, variables, and other objects defined within that module for use within your Python script.

What are the contents of a module?

Python modules contain various objects such as functions, variables among others.
For example: we have module named calc; within the calc.py file we have 4 function definitions for mathematical operations i.e., add, sub, multiply, divide.
We can import the calc module into a script where we want to perform these mathematical operations instead of redefining them again within the script.
Modules contain executable statements as well, which are used to initialize the module and are run only the first time the module name is encountered in an import statement.

How to import modules

import 'module': this allows access to the entire module from the script.
from 'module' import 'object': using the ‘from’ keyword allows you to access specific objects within the module i.e. from math import pi; this imports the pi variable of the math module.
from 'module' import *: using the * wildcard allows access to all the names within the module except those starting with an ‘_’; this is not recommended as it introduces an unknown set of names into the interpreter, possibly concealing some parts that you have already defined.
python3 -m 'module' 'file_name': modules can be imported in the command-line as well; the -m represents the module, we then specify the module name, and the name of the file in which we want to use the module.

Module search path

When a module is imported e.g. calc, the interpreter first searches for a built in module with the name calc, the module names are listed in sys.builtin_module_names; if the name is not found, it proceeds to search for the calc.py in a list of directories given by the variable sys.path.

References:

https://docs.python.org/3/tutorial/modules.html