Feat/web api missing functions #69

abderrahmaneMustapha · 2021-06-04T10:42:41Z

Description

i added some missing functions , that i need to use in leblad web api

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update
Updated the dataset

Checklist:

I checked that there's no dataset update (can be done by running npm run update-dataset)
npm test passes on my machine
npm run lint passes on my machine

…ndex

codecov-commenter · 2021-06-05T01:14:17Z

Codecov Report

Merging #69 (b7b52a9) into develop (5cd401b) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##           develop       #69   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        23    +4     
  Lines          164       210   +46     
  Branches        31        38    +7     
=========================================
+ Hits           164       210   +46

Impacted Files	Coverage Δ
.../api/getBaladiyaByCodeAndDairaCodeAndWilayaCode.js	`100.00% <100.00%> (ø)`
src/api/getBaldiyaByCodeForWilaya.js	`100.00% <100.00%> (ø)`
...c/api/getBaldiyatsForDairaByCodeForWilayaByCode.js	`100.00% <100.00%> (ø)`
src/api/getDairaByCodeAndWilayaCode.js	`100.00% <100.00%> (ø)`
src/index.js	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5cd401b...b7b52a9. Read the comment docs.

ZibanPirate

looks good to me, these functionally are needed for a web server where you have enpoints such as

.../api/Wilayas/{wilayaCode}/Daira/{dairaCode}/Baladiya/{baladiyaCode}

the code itself looks good.

The only thing missing is updating the readme documentation, can you please do that @abderrahmaneMustapha

abderrahmaneMustapha · 2021-06-07T00:26:49Z

@ZibanPirate done , i updated the documentation

Fcmam5

Thanks man for your great efforts! I just got some comments (please don't hate me).

Also, please next time file an issue before started working on such features just to keep track of our changes, aaaand please it would be easier for us to review small PRs as you know, so it'd be ideal to work on each feature on a small PR which should be linked to our issue.

Fcmam5 · 2021-06-07T01:13:25Z

src/api/getBaladiyaByCodeAndDairaCodeAndWilayaCode.js

+   * @param { String[] } projection a list of Baladyia object attributes to keep
+   * @returns { Object | null } Returns  a baldiya's object, or null
+   */
+  (mattricule, code, bcode, projection)=>{


Please fix linting issues

I liked everything and learned a lot from it 😁; there is no cause to dislike you, and thank you very much for your valuable feedbacks.

Fcmam5 · 2021-06-07T01:15:43Z

src/api/getBaladiyaByCodeAndDairaCodeAndWilayaCode.js

+   * @param { integer } mattricule wilaya mattricule
+   * @param { integer } code daira code
+   * @param { integer } bcode baladiya code


Do you mean?

Suggested change

* @param { integer } mattricule wilaya mattricule

* @param { integer } code daira code

* @param { integer } bcode baladiya code

* @param { number } mattricule wilaya mattricule

* @param { number } code daira code

* @param { number } bcode baladiya code

Fcmam5 · 2021-06-07T01:18:52Z

src/api/getBaladiyaByCodeAndDairaCodeAndWilayaCode.js

@@ -0,0 +1,31 @@
+const projectBaladiya = require('../utils/projections/projectObject');
+
+const getBaladiyaByCodeAndDairaCodeAndWilayaCode = (data) =>


Please do you have any use case for such a feature? I believe that Baladyia code is unique overall, so if you'd use it it won't matter to add extra params. And if you want to get a baladyia by wilaya or daira code you'd just use their methods with a projection

can you please explain how can i get the same result by using projection

We do have these methods in place:

const { getBaladyiatsForWilaya, getBaladyiatsForDaira } = require("@dzcode-io/leblad"); const rs1 = getBaladyiatsForWilaya(31); // if this wasn't implemented, we'd use getWilayaByCode and project only "dairats" const rs2 = getBaladyiatsForDaira("ORAN");

Maybe it'd be nice to have another getBaladyiatsForDairaCode method. If you want to create it, please do it on a separate PR, based on develop

Fcmam5 · 2021-06-07T01:22:34Z

src/api/getBaldiyaByCodeForWilaya.js

@@ -0,0 +1,38 @@
+const projectBaladiya = require('../utils/projections/projectObject');
+
+const getBaldiyaByCodeForWilaya = (data) =>


I'd name it getBaladyiaByWilayaCode. But again, why we don't just use getWilayaByCode then call the projection.

Fcmam5 · 2021-06-07T01:23:09Z

src/api/getBaldiyaByCodeForWilaya.js

+   * @param { Number } mattricule wilaya code (mattricule)
+   * @param { Number } code baladiya code (code)


Please check jsdoc here and in all changed files

Suggested change

* @param { Number } mattricule wilaya code (mattricule)

* @param { Number } code baladiya code (code)

* @param { number } mattricule wilaya code (mattricule)

* @param { number } code baladiya code (code)

Fcmam5 · 2021-06-07T01:24:27Z

src/api/getBaldiyatsForDairaByCodeForWilayaByCode.js

@@ -0,0 +1,31 @@
+const projectBaladiya = require('../utils/projections/projectObject');
+
+const getBaldiyatsForDairaByCodeForWilayaByCode = (data) =>


Same as my previous comments, plus this name can be simplified to getBaldiyatsByWilayaCode or getBaldiyatsByDairaCode. And if you could find a counterexample/argument to keep such composed methods which means that daira code is not enough to identify wilayas. we can name this: getBaldiyatsByWilayaAndDairaCodes

Fcmam5 · 2021-06-07T01:27:30Z

src/index.js

+const getDairaByCodeAndWilayaCode = require('./api/getDairaByCodeAndWilayaCode');
+const getBaladiyaByCodeAndDairaCodeAndWilayaCode = require('./api/getBaladiyaByCodeAndDairaCodeAndWilayaCode');
+const getBaldiyatsForDairaByCodeForWilayaByCode =  require('./api/getBaldiyatsForDairaByCodeForWilayaByCode');
+const getBaldiyaByCodeForWilaya = require('./api/getBaldiyaByCodeForWilaya');
 const data = require('../data/WilayaList.json');


I'd leave a blank line before the dataset import just for the sake of clarity and readablity

Fcmam5 · 2021-06-07T01:28:47Z

tests/api/getBaldiyatsForDairaByCodeForWilayaByCode.test.js

+
+
+
+  it('should export a function', () => {


Please apply the linter+prettier to remove such whitespaces and to add an empty line at EOF

abderrahmaneMustapha added 9 commits June 3, 2021 02:01

feat : get a baladiya by the daira and wilaya code

4c5c91a

get a baladiya by daira code and wilaya code

9f51e6f

feat : get a baladiya by code for a given wilaya code

28dab16

feat : get baladiyats for a daira by code for a given wilaya code

0f140f8

feat : get a given daira by code for a wilaya code

30ebd22

add the new fucntions to index

6feba78

fix : typos and some undifined errors

91c69b4

fix some not defined variables and add new fucntions to the package i…

0923acc

…ndex

test : the new added , missing api functions

6449a99

abderrahmaneMustapha requested a review from Fcmam5 June 5, 2021 00:03

refactor : dont check if the baldyats list exists

37e736b

abderrahmaneMustapha requested review from souhaib-benbouzid, ZibanPirate and a team June 5, 2021 01:40

ZibanPirate requested changes Jun 5, 2021

View reviewed changes

abderrahmaneMustapha added 2 commits June 7, 2021 01:09

feat: add prjections for get baldiyats by code for a daira and a wilaya

9a2fcf1

doc : add missing api fucntions documentation

b7b52a9

abderrahmaneMustapha requested a review from ZibanPirate June 7, 2021 00:27

Fcmam5 requested changes Jun 7, 2021

View reviewed changes

ZibanPirate assigned abderrahmaneMustapha Feb 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/web api missing functions #69

Feat/web api missing functions #69

abderrahmaneMustapha commented Jun 4, 2021 •

edited

codecov-commenter commented Jun 5, 2021 •

edited

ZibanPirate left a comment

abderrahmaneMustapha commented Jun 7, 2021

Fcmam5 left a comment

Fcmam5 Jun 7, 2021

abderrahmaneMustapha Jun 17, 2021

Fcmam5 Jun 7, 2021

Fcmam5 Jun 7, 2021

abderrahmaneMustapha Jun 17, 2021 •

edited

Fcmam5 Jun 17, 2021 •

edited

Fcmam5 Jun 7, 2021

Fcmam5 Jun 7, 2021

Fcmam5 Jun 7, 2021

Fcmam5 Jun 7, 2021

Fcmam5 Jun 7, 2021

		@@ -0,0 +1,31 @@
		const projectBaladiya = require('../utils/projections/projectObject');

		const getBaladiyaByCodeAndDairaCodeAndWilayaCode = (data) =>

		@@ -0,0 +1,38 @@
		const projectBaladiya = require('../utils/projections/projectObject');

		const getBaldiyaByCodeForWilaya = (data) =>

		* @param { Number } mattricule wilaya code (mattricule)
		* @param { Number } code baladiya code (code)

		@@ -0,0 +1,31 @@
		const projectBaladiya = require('../utils/projections/projectObject');

		const getBaldiyatsForDairaByCodeForWilayaByCode = (data) =>

Feat/web api missing functions #69

Are you sure you want to change the base?

Feat/web api missing functions #69

Conversation

abderrahmaneMustapha commented Jun 4, 2021 • edited

Description

Checklist:

codecov-commenter commented Jun 5, 2021 • edited

Codecov Report

ZibanPirate left a comment

Choose a reason for hiding this comment

abderrahmaneMustapha commented Jun 7, 2021

Fcmam5 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abderrahmaneMustapha Jun 17, 2021 • edited

Choose a reason for hiding this comment

Fcmam5 Jun 17, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abderrahmaneMustapha commented Jun 4, 2021 •

edited

codecov-commenter commented Jun 5, 2021 •

edited

abderrahmaneMustapha Jun 17, 2021 •

edited

Fcmam5 Jun 17, 2021 •

edited