DEV Community: Jéssica Nathany

Effective Project Programming Practices for Real-Life Solutions

Jéssica Nathany — Wed, 14 Jun 2023 14:47:42 +0000

Introduction

I have always been interested in collaborating with open-source projects, but I wasn't sure how to get started. One day, while having a coffee break with my friend Felipe Rosas at our workplace, we began discussing our studies, hard skills, programming stacks, and various other programming topics.

During the conversation, Felipe asked me a thought-provoking question: "Why don't you create a small project and dedicate yourself to it using the concepts you are studying?". This idea resonated with me, and I realized it was the perfect opportunity to put my knowledge into practice.

The Project

Initially, the idea was to create a project centered around my favorite TV series, drawing inspiration from the Ricky Morty API. This sample project, which provides a comprehensive listing of characters, seasons, and episodes, inspired me to create a similar one.

So, why not design an API for my favorite series, the Office?
I have created a repository for my project here, where the goal of this API is to list characters, episodes, seasons, and memorable quotations from the characters. After sharing the project, I realized that I had some people who thought the idea was fantastic, and some started contributing. At the moment, my friend Reginaldo Alves de Barros sends a pull request every day, contributing to the project.

The Idea

During this development period of the project, I thought and came up with an idea. I want to create a simple web page and put all the APIs I create on it. This is fun and helps me train my code and my development architecture better, and helps other people contribute with projects open source. The challenge for me is development with the front, I need to create a simple page and I think the better idea is a creating a simple front using React.Js. Yeh, I need to do some class about react lol.

I use it a lot the Notions for creating documentation for my APIs and following the development time.

Has a lot of things to do but every day I have some goals for coding and finishing some tasks. It is not easy to divide your time, especially when you have other activities and work to do, but If have an objective you mind, you need to focus, and most importantly, don't so much pressure or demand on yourself.

The Conclusion

Create projects and create projects and take them seriously. Create projects and take them seriously. Create with care and dedication, It will serve as learning experience and help you further mature your technical skills.

How to create a simple Investiment API NET Core 6 for tranning Part.2

Jéssica Nathany — Mon, 04 Jul 2022 12:04:13 +0000

Continue the previous article How to create a simple Investiment API NET Core 6 for tranning Part.1, now we need to do this for separate our project in layers:

*Repository
*Services
*Response classes
*And injection dependencies

Creating the Response class

Inside the folder Response, I created the classe as shown in the image below.

Creating the Repository class

Inside the folder Data -> Repository, I created the class repositories and your interfaces. Before I created the interfaces, as show image bellow.

For now I just created one method GET, but the plan is I'll create the anothers methods, POST and PUT. In repository, we have the class as how image bellow. Notice that I used the mocky JSON that I created earlier.

Configure the injection dependency

I like the separate responsibility, for example, I could have put this injection dependency directly in the class Program, but to make the organization better my code, I thought it was better to separate it. So, I created the class DependencyInjectionRegistry and here I have an only static void method that receives the IServiceCollection.

Creating the Services class

Here I created the services classes, the service is called the repository class. I injected the dependency into the constructor. In this class I have put the business rules, in future I will create the unit test for this roles.

The service InvestmentServices return all investment in Investment Portfolio the client.

Creating Controllers and endpoints

I a created only controller is InvestmentController. Here our API has an everything about the investment client.

So this is a simple idea for the API, I will create the other version using VSCode, and finish the unit test. I hope that help you, and you can get the repository in URL bellow.

Github project: https://github.com/JessicaNathany/api-fanfareInvest

How to create a simple Investiment API NET Core 6 for tranning Part.1

Jéssica Nathany — Sat, 25 Jun 2022 21:08:05 +0000

I create this project to practice a little the code and include some concepts that I study. So was a sample idea, create a sample Investiment API that to return the all investiment the portfolio the customers.

I used the Visual Studio with language C# with .NET 6, but I will create a other article with coding in VSCode, now at the moment the environment this is.

So some rules the our API business investiment consunting, should have endpoints bellow:

List all investiments
Get investiments Fixed Income
Get invetiments Variable Rent
Get invetiments Funds
Investing Fixed Income is a POST
Investing Funds Property is a POST
GET Rescue invetiments

Another rules the user cannot rescue the investiment in less than a month for all and The user cannot investing bonds that. The user cannot investing that does not fit your profile, and for the calculation rules:

If the date due date the investiment is than more that six month, so descount twent percent (20%) the yours yield
If the date due date the investiment is than more that twelve month, so descount ten percent (10%) the yours yield
If the date due date the investiment is equal due date all, so descount five percent (5%) the yours yield.

All ready, let´s the code.

Creating the project

First of all select the directory in your machine and create a solution blank with the name api-fanfareInvest or the name want do you want, image bellow.

After you have created, inside the solution blank, click right button -> new project and select ASP.NET Core API. In this case, we don't create a minimal API, ´follow the image.

This a structure basic the our Simple API. Now you can create the pasts: ConfigDependency, Controllers, Data, Model, Response and Service. I will explain later.

Creating the Models

For our API we need to create some Model class We need this class: (DirectTreasury, FixedIncome, Fund, VariableIncome and InvestimentPortfolio). The last class we will get all investments in the portfolio

The objective here is a create model class for get some investimet, for example I want to get all investiment direct treasury, or get fixed income, get variable income etc. I will mock data this investiment using Json Mock. But at moment, just let´s to create the classes model.

Let´s to create a class DirectTreasury in paste Model.

Let's repeat the process by creating the other classes

FixedIncome

Fund

InvestmentPortfolio

VariableIncome

Creating the Json Mocks

We are using these tools JSON Mocky this link https://designer.mocky.io/design. JSON Mocky is a nice tool because you can create JSON mocks to be consumed in APIs for testing. Bascally the tools generate a response Mock with a URL.

I created the JSON, so I used this website to validate my JSON https://jsoneditoronline.org. The first response we are to create is a Direct Treasury, as shown in the image below.

Creating JSON the response Direct Treasury

Copy the json and paste it in the field HTTP Response Body the website JSON Mocky, and after click in button Generate in my HTTP Response.

I have already prepared the response of the objects, just copy and save in a notepad. The procedure I did was the same, I created a JSON for each class, generated and formatted it in the online JSON Editor and pasted it in the body response of the JSON Mocky site.

Direct Tresuary Response: https://run.mocky.io/v3/52ad684e-30a4-4a45-9c88-3b18169c6137

Fixed Income Response: https://run.mocky.io/v3/ba42dc71-9176-46d0-8ede-a21faeb5b3ba

Fund Response: https://run.mocky.io/v3/7ac36199-db5c-4d21-bc8a-74fe91fa43b1

Variable Response: https://run.mocky.io/v3/4fcc8f18-8ab7-4a36-abc1-f466566e9785

In the next part of this article, I will continue to create the class Repository, Services, Response, and some configuration of the project.

Part2: https://dev.to/jessicanathany/how-to-create-a-simple-investiment-api-net-core-6-for-tranning-part2-1gb1

How to export and import data in DBeaver

Jéssica Nathany — Sun, 06 Mar 2022 00:34:29 +0000

In this article, I'll to teach how to export and import data using the DBweaver, its very simple.

In yours DBweaver select database and table that you want to export data.

Right mouse button and select option Export data

Select the option SQL Export to SQL INSERT statement click next and select the folder where you want to save the script.After that click Proceed.

Now, run the script in another database.

How to create database MySQL with Docker

Jéssica Nathany — Sat, 22 Jan 2022 17:03:43 +0000

I'll to show how to create an local database MySQL with Docker, in yours Windows. It is necessary has the last version Docker intalladed in your machine.

1st step: Dowload the MySQL image

Let's download the latest MySQL image to the Docker hub, type the following command below:

docker pull mysql/mysql-server

2st step: Execute the container

Let´s execute the container for an image that we did download. At first, we don´t configure environment variables, at moment just execute the MySQL for default users without a password. Before executing the command, you can create a directory with the name mysql. Write the command below in your terminal.

Note: create only the directory C:/mysql for default, the MySQL to need has folder */var/lib/mysql, this directory the MySQL will save your database.*

Write the command below

docker ryn -e MYSQL_ALLOW_EMPTY_PASSWORD=yes -v C:/mysql/var/lib/mysql mysql

3st step: Getting the container's IP

For discovery the container IP, write command docker container ls for verify the containers that running and copy the ID the container, using the command docker container inpect ID_CONTAINER.

4st step: Acess database from container

To access the database through the container, we need to go inside the container, so write the command below

docker exec -it ID_CONTAINER

Already. We have a datbase MySQL in container Docker. Now you can create your database and tables.

Conslusion

This is a sample example for you create database with docker. Of course this example I created the sample database, but you can configure user and password in your database.

Write for don´t forget.

Some useful Libraries for .NET projects

Jéssica Nathany — Sat, 02 Oct 2021 18:29:17 +0000

Introduction

I will share same libraries and packages to make your .NET project easier, and explain a little about their functionality.Note: You can copy copy the library links from github and paste them into your Notions.

NBuilder
Is a library that allows you to rapidly create test data, automatically. Some examples below.

NBuilder Github
Nuget: Install-Package NBuilder -Version 6.1.0

I wrote about this library in my last articleTools o improve your unit test with .NET. I have a Github repository about Unit Test and I used this library for test ([Unit Test]https://github.com/JessicaNathany/unit-test) the code ist portuguese but I will write in english.

Faker.NET

This library is a little diferent the NBuilder, because if you want something whic looks like actual names, address, email, thelephone numbers, etc you can use Faker.NET.

Faker.Net Github
Nuget: Install-Package Faker.Net -Version 1.5.148

Bogus

Bogus is a simple and sane fake data generator for .NET languages like C#, F# and VB.NET. Bogus is fundamentally a C# port of faker.js and inspired by FluentValidation's syntax sugar. Created by Brian Chavez.

Bogus Github
Nuget: Install-Package Bogus -Version 33.1.1

The example bellow is from repository Brian Chavez

Ocelot

Ocelot is a .NET API Gateway. This project is aimed at people using .NET running a micro services / service oriented architecture that need a unified point of entry into their system. However it will work with anything that speaks HTTP and run on any platform that ASP.NET Core supports.

Ocelot Github
Nuget: Install-Package Ocelot -Version 17.0.0

The example below is taken from the website Microsoft Documentation API Gateway with Ocelot.

Polly

Polly is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner.

Polly Github
Nuget: Install-Package Polly -Version 7.2.2

The example below is taken from repository Polly Github.

CacheManager

CacheManager is an open source caching abstraction layer for .NET written in C#. It supports various cache providers and implements many advanced features.

The main goal of the CacheManager package is to make developer's life easier to handle even very complex caching scenarios..

CacheManager Github
Nuget: Install-Package CacheManager.Core -Version 2.0.0-beta-1629

AutoMapper

AutoMapper is a simple little library built to solve a deceptively complex problem - getting rid of code that mapped one object to another.

Automapper Github
Nuget: Install-Package AutoMapper -Version 10.1.1

The example below is taken from repository AutoMapper Github.

FluentValidation

A small validation library for .NET that uses a fluent interface and lambda expressions for building validation rules.

FluentValidation Github
Nuget: Install-Package FluentValidation -Version 10.3.3

The example below is taken from repository FluentValidation Github.

Swagger

Swagger tooling for APIs built with ASP.NET Core. Generate beautiful API documentation, including a UI to explore and test operations, directly from your routes, controllers and models.

Swagger Github
Nuget: Install-Package Swashbuckle.AspNetCore.Swagger -Version 6.2.2

Tools o improve your unit test with .NET

Jéssica Nathany — Fri, 18 Jun 2021 11:56:06 +0000

In this article, I will show you some kind tools for you can write unit test better and make you job easier. In this case, I'm using here the Dotnet platform C# language. But first, let's understand some concepts.

Test stuntmen

First, what are test stuntmen? They are fake implementation the object real can be simulated the unit real or the object real.

Mock
Are what we are talking about here: objects pre-programmed with expectations which form a specification of the calls they are expected to receive.

Stubs
Provide canned answers to calls made during the test, usually not responding at all to anything outside what's programmed in for the test.

Fakes
Are objects actually have working implementations, but usually take some shortcut that makes them not suitable for production (an in-memory database is a good example).

Spies
Are stubs that also record some information based on how they were called. One form of this might be an email service that records how many messages it was sent.

Dummy
Are objects are passed around but never actually used. Usually, they are just used to fill parameter lists.
Fake objects actually have working implementations, but usually take some.

XUnit Code Snippets

If you use these "code snippets", you can save time coding/typing to create unit test code based on xUnit framework. You can use write the command below I will show two options.

You can download the Snippets in your Visual Studio

Use command below
1.xtestm [Tab] or
2.fact [Tab]

Then, this snippet expanded following C# code.

NBuilder

Is a library that allows you to rapidly create test data, automatically. Some examples below.

Its a great idea and helps facilitates the process if you need to generate a quantity of data for testing.

Faker.NET

This library is different the NBuilder, because if you want something which looks like actual names, address, email, telephone, etc you can use Faker.NET.

Coverlet

Coverlet is a cross platform code coverage framework for .NET, with support for line, branch and method coverage. It works with .NET Framework on Windows and .NET Core on all supported platforms.

Coverlet documentation reflect the current repository state of the features, not the released ones.
Check the changelog to understand if the documented feature you want to use has been officially released. You can see for more details in Coverlet Github

Let´s first install the package coverlet in your test project in image below.

Now we can configure the tests to execute, for to generate the XML file format, for code coverage with the command and image below.

dotnet test --verbosity minimal --collect:"XPlat Code Coverage"

The option --collect:”XPlat Code Coverage” will create the file coverage.cobertura.xml in a folder named identified by a GUID and located in the TestResults directory of the test project.

Install Report Generator the command below.

dotnet tool install --global dotnet-reportgenerator-globaltool --version 4.8.6

In the power shell open the folder where the xml file was generated, and write the command reportgenerator "-reports:coverage.cobertura.xml" "-targetdir:coveragereport" -reporttypes:Html

As you can see, the report generator created files in which it shows the test coverage of your code.

Conclusion

Whenever I can, I write an article to document my programs and processes so I don't forget. Here I have put some tools that I use in my personal projects and at work to improve the way I write my unit tests, and observe test coverage. I hope you enjoyed it and it helps you.

References

Martin Fowler - article MocksArentStubs
Documentation dotnet core unit testing code
Jerrie Pelser
Coverlate

Links
Unit Test project in Github
Mock4 Quickstart
NBuilder GitHub
Faker.NET
NBuilder documentation
XUnitCodeSnippets
Link package Moq
coverlet.msbuild
coverlet-coverage

Creating a simple project Web API with VSCode and Entity Framework

Jéssica Nathany — Sat, 13 Mar 2021 18:44:46 +0000

In this article, I will teach how to create API using Visual Studio Code. For this, you need to install VSCode at this link. In this case, I'm using de NET version 5.0 but you can use the version .NET 3.0.

First step: First of all, before installing the VSCode open the Windows Power Shell and select your directory, the directory where you will create this project API.

Second step: Write in the Power Shell the command dotnet new webapi -o CourseApi. Where the syntax -o is used for creating the directory for your project.

Third step: Open the Visual Studio Code and select your directory, the directory where we created the project Web API. Delete the files WeatherForecast.cs and WeatherForecastController.cs.

Now we let´s create some folders and classes. Lets to create the folder: Model and Data.

We will create the classes Category and Course. How you can see in the image below, we will use the validation in properties using DataAnnotations in fields.

Category { Id, Title and CategoryName }
Courses {Id, Name, Description, Price, CategoryId and Category }
DataContext - for to work EntityFrameworkCore and We will using database in memory.

How the Amazon interview set me thinking about my soft skills

Jéssica Nathany — Sun, 27 Dec 2020 17:38:12 +0000

I decided to share here the experience I had when I did the job interview at Amazon. I didn't spend, but I have some learning about that.

I thought about my career and my soft skills, and I don´t know if you will agree with me, but let´s go. The Amazon test that I did, I had problems to solve, I don´t know the details but that I remember, I had to use some kind of algorithm and I separated a time to study this algorithm, it´s wasn't easy for me.

Anyway, I knew it would be difficult to move to that position, but I wanted to try. So I was studying for two days about the algorithm: BigO, Diijkastra, and QuickSort. I still didn't get the job, but I got the chance to try and about what I want.

The biggest companies like Amazon, Google, Facebook, etc, most likely the tests for a job opportunity they are looking for people that have a domain in the algorithm, data structure because they look for minds that know how to solve complex problems. I'm not saying it is impossible, no I don´t. What I want to say is you need to prepare more if you want to work for the biggest companies technology.

Developers and Work

Today we know how the IT area has a lot of job opportunities, has a lot of people changing the area, because the salary, opportunity, change etc.

In my opinion, all programmers need to have some knowledge of algorithms and data structure. When I say algorithms and data structure I mean say basic knowledge for example BigO, Binary search algorithm, Recursion, QuickSort anyway to understand data structure and how things work underneath the framework.

If you want to work with the biggest companies for example Google, Facebook, Amazon, LinkedIn whatever you need a broad domain of it. I thought a lot about the job test that I made the Amazon. I think why didn't I have this domain before? I don't know, maybe I think about the framework that made them work for us for underneath. Do not be a slave your framework!

Okay, if you want only a great salary and do your job without worrying about it, you can to continue working normally. But, if you want to grow, you need to change your habits.

My focus

I decided to focus more on algorithms and data structure and better my skills. So I wrote some tips, my opinion and feel free to follow these tips:

BigO Notation
Binary Search
Recursion
QuickSort
Understand how the framework works
Some Knowledge of Architecture
Some Knowledge Designer Patterns
Some Knowledge Unit Test
Some Knowledge DevOps

Conclusion

Don't be dependent on your framework, to understand how things work. You don't need to digest all the existing data structures, but you do need to know how things work under your framework.

Design Patterns, good habits and good sense!

Jéssica Nathany — Sun, 26 Apr 2020 21:11:09 +0000

This week we made a recording on the Café debug podcast about Design Patterns, good habits and good sense. The podcast is in Portuguese, but I dcided to write our conversation in English, of course just a summary.

Let's start with Clean Code. The book Clean Code for some people is considered the Bible of developers, because it teaches some techniques to make yours code cleaner and more inteligible.

But, why do we need to wirte code? Let´s see.

Because we want to deliver results faster;
The requirements were changed during development;
The code was bad and a given situation´s refactor is not a good idea;

And what changes in a programmer´s life when you write clean code?

Evolution as a developer: you make your code cleaner, to improve your skill;
Produtivity increase: the team can have a produtivity increase and fast delivery;
Clean, cohesive code: a code that everyone can understand where everyone talks the same "language" fallowing an standard;
Reduce bugs: of course, the quantity of bugs redeced in your code the project and you have less time for correction.

Let's see some good practices that can be applied to clean code.

Meaningful Name

Your method, class or variables need to have meaningful names. It's not important if your code name is long, but the name needs to be specific according to its functionality.

Comments are not very good!

You cannot put comments in your code, I think it depends on the situation. Normally we can put comments when we are talking about the code version, or business roles or something specific. So, avoid comments in code.

Make your code elegant

Try to make your code more elegant, write very well, think about someone that will read your code.

Last but not least: you need to test your code!

Unit testing is important, very important and you know this. Unit testing prevents future bugs in your project, and tests will teach you if you're learning.
But why don't we test it? Let's look at some reasons why some developers don't test their code.

A small amount of people understand that unit testing is very important
Don't know how to test your code
Short deadlines
The project is not prepared to implement unit tests
The pressure from the team or manager
Bad architecture and "code smell"

So I will leave some links about documentation of the unit test on the Microsoft platform .Net and the documentation of the framework Moq.

1- Best practices for unit testing with .NET Core e .NET Standard
https://docs.microsoft.com/pt-br/dotnet/core/testing/unit-testing-best-practices

2- Framework Moq no Net
https://discoverdot.net/projects/moq

3- Moq documentation
http://www.nudoq.org/#!/Projects/Moq
https://github.com/JessicaNathany/cafedebug

4- Link to technology podcast Café debug
https://soundcloud.com/cafe-de-bug/40-design-patterns-e-boas-praticas-e-bom-senso

5 - Code smell (Martin Fowler)
https://martinfowler.com/bliki/CodeSmell.html

6 - Refactoring
https://refactoring.com/