Compare commits
89 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fbad4456d7 | ||
|
|
deec626feb | ||
|
|
88c6641485 | ||
|
|
f4eedda658 | ||
|
|
d2b80561f8 | ||
|
|
3bda88a075 | ||
|
|
86465e0076 | ||
|
|
d947dad488 | ||
|
|
23ef434fe1 | ||
|
|
5e6d92c5be | ||
|
|
4ba098e0b6 | ||
|
|
2d1a9a0452 | ||
|
|
6fbee3e7c6 | ||
|
|
46775c3662 | ||
|
|
1feb5bfda1 | ||
|
|
3ec9ed3b2a | ||
|
|
75a536d5ab | ||
|
|
f3cded7e5d | ||
|
|
d7c9c4bf76 | ||
|
|
2c5eceb0c1 | ||
|
|
7d0ec72a0c | ||
|
|
faf020bd53 | ||
|
|
7df0754217 | ||
|
|
11a3e8771b | ||
|
|
af996d81c9 | ||
|
|
8a5fbcdf71 | ||
|
|
60bb75da57 | ||
|
|
45411080ab | ||
|
|
4785cf797d | ||
|
|
e155e992d4 | ||
|
|
3ce08a3f2e | ||
|
|
169655800b | ||
|
|
baf57b3641 | ||
|
|
47e4230b39 | ||
|
|
c5f4333878 | ||
|
|
c99b78fb54 | ||
|
|
88e1e1d3a9 | ||
|
|
31174b3c85 | ||
|
|
265ea58bab | ||
|
|
ab5ee59d72 | ||
|
|
2062aa11a3 | ||
|
|
a4501007ff | ||
|
|
bc01806421 | ||
|
|
bfba6d4bd9 | ||
|
|
676d48807a | ||
|
|
1a37773a40 | ||
|
|
67497d9828 | ||
|
|
62ea296f3b | ||
|
|
52dafcef97 | ||
|
|
a06d20ee53 | ||
|
|
5347d0014d | ||
|
|
946b70003f | ||
|
|
a6e6656882 | ||
|
|
fbea1aabc4 | ||
|
|
2dd01ca38f | ||
|
|
f010e8951b | ||
|
|
5225098006 | ||
|
|
6e6144e02f | ||
|
|
aa49773a4d | ||
|
|
b6b8d6814c | ||
|
|
b8d658a948 | ||
|
|
bce0c57b02 | ||
|
|
5e547baa76 | ||
|
|
b368ca7ab8 | ||
|
|
eb85641dfb | ||
|
|
0a13037b83 | ||
|
|
5600b9766b | ||
|
|
63b232521e | ||
|
|
2f5cc31ae3 | ||
|
|
70e78492ec | ||
|
|
47adb88cb5 | ||
|
|
e5627e1d02 | ||
|
|
c831057fba | ||
|
|
355f3bfc76 | ||
|
|
949abcaf09 | ||
|
|
24e925ae0d | ||
|
|
2764b2b776 | ||
|
|
0de6d3df04 | ||
|
|
45a18529ba | ||
|
|
84c8aa6d72 | ||
|
|
0f7a07e7fb | ||
|
|
7a65b788b9 | ||
|
|
ec7689f73f | ||
|
|
5a13e6a0a0 | ||
|
|
7bd36e554c | ||
|
|
d7e3dfc05e | ||
|
|
c1c4d55ede | ||
|
|
aad0884976 | ||
|
|
c0ae72424b |
@@ -1,3 +1,7 @@
|
|||||||
node_modules
|
node_modules/
|
||||||
npm-debug.log
|
npm-debug.log
|
||||||
test
|
test/
|
||||||
|
conf/
|
||||||
|
db/
|
||||||
|
.git/
|
||||||
|
.github/
|
||||||
|
|||||||
@@ -1,12 +1,11 @@
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
env: {
|
env: {
|
||||||
commonjs: true,
|
es2021: true,
|
||||||
es6: true,
|
|
||||||
node: true,
|
node: true,
|
||||||
browser: true,
|
browser: true,
|
||||||
mocha: true,
|
mocha: true,
|
||||||
},
|
},
|
||||||
parser: 'babel-eslint',
|
parser: '@babel/eslint-parser',
|
||||||
extends: ['eslint:recommended', 'prettier'],
|
extends: ['eslint:recommended', 'prettier'],
|
||||||
plugins: ['react'],
|
plugins: ['react'],
|
||||||
globals: {
|
globals: {
|
||||||
@@ -17,7 +16,6 @@ module.exports = {
|
|||||||
fetch: true,
|
fetch: true,
|
||||||
},
|
},
|
||||||
parserOptions: {
|
parserOptions: {
|
||||||
ecmaVersion: 2018,
|
|
||||||
sourceType: 'module',
|
sourceType: 'module',
|
||||||
},
|
},
|
||||||
rules: {
|
rules: {
|
||||||
@@ -205,10 +203,6 @@ module.exports = {
|
|||||||
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md
|
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md
|
||||||
'react/self-closing-comp': 'warn',
|
'react/self-closing-comp': 'warn',
|
||||||
|
|
||||||
// Enforce spaces before the closing bracket of self-closing JSX elements
|
|
||||||
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-space-before-closing.md
|
|
||||||
'react/jsx-space-before-closing': ['warn', 'always'],
|
|
||||||
|
|
||||||
// Enforce component methods order
|
// Enforce component methods order
|
||||||
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md
|
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md
|
||||||
'react/sort-comp': 'off',
|
'react/sort-comp': 'off',
|
||||||
@@ -239,7 +233,7 @@ module.exports = {
|
|||||||
|
|
||||||
// only .jsx files may have JSX
|
// only .jsx files may have JSX
|
||||||
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-filename-extension.md
|
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-filename-extension.md
|
||||||
'react/jsx-filename-extension': ['error', { extensions: ['.js'] }],
|
'react/jsx-filename-extension': ['error', { extensions: ['.jsx'] }],
|
||||||
|
|
||||||
// prevent accidental JS comments from being injected into JSX as text
|
// prevent accidental JS comments from being injected into JSX as text
|
||||||
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-comment-textnodes.md
|
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-comment-textnodes.md
|
||||||
@@ -284,15 +278,5 @@ module.exports = {
|
|||||||
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-children-prop.md
|
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-children-prop.md
|
||||||
'react/no-children-prop': 'warn',
|
'react/no-children-prop': 'warn',
|
||||||
|
|
||||||
// Validate whitespace in and around the JSX opening and closing brackets
|
|
||||||
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-tag-spacing.md
|
|
||||||
'react/jsx-tag-spacing': [
|
|
||||||
'warn',
|
|
||||||
{
|
|
||||||
closingSlash: 'never',
|
|
||||||
beforeSelfClosing: 'always',
|
|
||||||
afterOpening: 'never',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
24
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**To Reproduce**
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Screenshots**
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
**Describe alternatives you've considered**
|
||||||
|
A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context or screenshots about the feature request here.
|
||||||
46
.github/workflows/docker.yml
vendored
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
name: Create and publish Docker image
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- 'master'
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
|
||||||
|
env:
|
||||||
|
REGISTRY: ghcr.io
|
||||||
|
IMAGE_NAME: ${{ github.repository }}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-and-push-image:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v1
|
||||||
|
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Log in to the Container registry
|
||||||
|
uses: docker/login-action@v1
|
||||||
|
with:
|
||||||
|
registry: ${{ env.REGISTRY }}
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Extract metadata (tags, labels) for Docker
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@v3
|
||||||
|
with:
|
||||||
|
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||||
|
|
||||||
|
- name: Build and push Docker image
|
||||||
|
uses: docker/build-push-action@v2
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
21
.github/workflows/test.yml
vendored
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
name: Test
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
name: Test
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v1
|
||||||
|
- name: Setup node
|
||||||
|
uses: actions/setup-node@v2.5.1
|
||||||
|
with:
|
||||||
|
node-version: 16
|
||||||
|
cache: 'yarn'
|
||||||
|
- run: yarn install
|
||||||
|
- run: yarn run test
|
||||||
1
.gitignore
vendored
@@ -3,3 +3,4 @@ ui/public/
|
|||||||
db/
|
db/
|
||||||
npm-debug.log
|
npm-debug.log
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
.idea
|
||||||
|
|||||||
42
CHANGELOG.md
@@ -1,3 +1,43 @@
|
|||||||
|
Newer release changelog see https://github.com/orangecoding/fredy/releases
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
###### [V5.5.0]
|
||||||
|
- Upgrading dependencies
|
||||||
|
- fixing provider
|
||||||
|
- allow multiple instances of 1 provider
|
||||||
|
- __BREAKING__: Minimum node version is now 16
|
||||||
|
|
||||||
|
###### [V5.4.6]
|
||||||
|
- Adding Instana node.js monitoring
|
||||||
|
-
|
||||||
|
###### [V5.4.5]
|
||||||
|
- Adding Instana node.js monitoring
|
||||||
|
|
||||||
|
###### [V5.4.4]
|
||||||
|
- Add support for Immo Südwest Presse (immo.swp.de)
|
||||||
|
- Telegram: Use job name instead of ID and link in title
|
||||||
|
- Fix race condition if user ID is in session but not in user store
|
||||||
|
- Allow visiting the original provider URL
|
||||||
|
|
||||||
|
###### [V5.4.3]
|
||||||
|
- re-writing readme
|
||||||
|
- improving docker build
|
||||||
|
- using github's actions to build docker and test automatically
|
||||||
|
|
||||||
|
###### [V5.4.2]
|
||||||
|
- Fixing prod build
|
||||||
|
|
||||||
|
###### [V5.4.1]
|
||||||
|
- Upgrading dependencies
|
||||||
|
- Provider urls are now automagically been changed to include the correct sort order for search results
|
||||||
|
|
||||||
|
```
|
||||||
|
Note: It has been an point of confusion since the very beginning of Fredy, that people simply copied the url, but
|
||||||
|
did not take care of sorting the search results by date. If this is not done, Fredy will most likely not see the latest
|
||||||
|
results, thus cannot report them. This release fixes it by adding the necessary params (or replaces them).
|
||||||
|
```
|
||||||
|
|
||||||
###### [V5.3.0]
|
###### [V5.3.0]
|
||||||
- Upgrading dependencies
|
- Upgrading dependencies
|
||||||
- It's now possible to send mails to multiple receiver using comma separation for MailJet & Sendgrid
|
- It's now possible to send mails to multiple receiver using comma separation for MailJet & Sendgrid
|
||||||
@@ -35,4 +75,4 @@ on the new ui and use the values from your previous config file if needed.
|
|||||||
[BREAKING CHANGES]
|
[BREAKING CHANGES]
|
||||||
- The config has been changed, the config of V1.x will not work any longer
|
- The config has been changed, the config of V1.x will not work any longer
|
||||||
- Sources have been renamed to provider
|
- Sources have been renamed to provider
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ function normalize(o) {
|
|||||||
return Object.assign(o, { id });
|
return Object.assign(o, { id });
|
||||||
}
|
}
|
||||||
|
|
||||||
//apply blaclist if needed
|
//apply blacklist if needed
|
||||||
function applyBlacklist(o) {
|
function applyBlacklist(o) {
|
||||||
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
||||||
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
||||||
|
|||||||
18
Dockerfile
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# syntax=docker/dockerfile:1.3
|
||||||
|
FROM node:16-alpine AS builder
|
||||||
|
COPY --chown=1000:1000 . /fredy
|
||||||
|
WORKDIR /fredy
|
||||||
|
USER 1000
|
||||||
|
RUN yarn install
|
||||||
|
RUN yarn run prod
|
||||||
|
|
||||||
|
FROM node:16-alpine
|
||||||
|
COPY --from=builder --chown=1000:1000 /fredy /fredy
|
||||||
|
RUN mkdir /db /conf && \
|
||||||
|
chown 1000:1000 /db /conf && \
|
||||||
|
ln -s /db /fredy/db && ln -s /conf /fredy/conf
|
||||||
|
EXPOSE 9998
|
||||||
|
USER 1000
|
||||||
|
VOLUME [ "/conf", "/db" ]
|
||||||
|
WORKDIR /fredy
|
||||||
|
CMD node index.js --no-daemon
|
||||||
98
README.md
@@ -1,77 +1,79 @@
|
|||||||
<img src="https://github.com/orangecoding/fredy/blob/master/doc/logo.png" width="400">
|
<img src="https://github.com/orangecoding/fredy/blob/master/doc/logo.png" width="400">
|
||||||
|
|
||||||
[](https://travis-ci.org/orangecoding/fredy)
|

|
||||||
|
|
||||||
Searching an apartment in Germany can be quite frustrating. Not any longer as Fredy will take over and only notifies you once new listings have been found that matches your requirements.
|
Searching an apartment in Germany can be a frustrating task. Not any longer though, as _Fredy_ will take over and will only notify you once new listings have been found that match your requirements.
|
||||||
|
|
||||||
_Fredy_ scrapes multiple services (Immonet, Immowelt etc.) and send new listings to you once they appear. The list of available services can easily be extended. For your convenience, a ui helps you to configure your search jobs.
|
_Fredy_ scrapes multiple services (Immonet, Immowelt etc.) and send new listings to you once they become available. The list of available services can easily be extended. For your convenience, _Fredy_ has a UI to help you configure your search jobs.
|
||||||
|
|
||||||
If _Fredy_ found matching results, it will send them to you via Slack, Email, Telegram etc. (More adapter possible.) As _Fredy_ will store the listings it has found, new results will not be sent twice (and as a side-effect, _Fredy_ can show some statistics..). Furthermore, _Fredy_ checks duplicates per scraping so that the same listings are not being sent when posted on various platforms. (Happens more often than one might think)
|
If _Fredy_ finds matching results, it will send them to you via Slack, Email, Telegram etc. (More adapters can be configured.) As _Fredy_ stores the listings it has found, new results will not be sent to you twice (and as a side-effect, _Fredy_ can show some statistics). Furthermore, _Fredy_ checks duplicates per scraping so that the same listings are not being sent twice or more when posted on various platforms (which happens more often than one might think).
|
||||||
|
|
||||||
|
# Sponsorship [](https://github.com/sponsors/orangecoding)
|
||||||
|
If you like my work, consider becoming a sponsor. I'm not expecting anybody to pay for _Fredy_ or any other Open Source Project I'm maintaining, however keep in mind, I'm doing all of this in my spare time :) Thanks.
|
||||||
|
|
||||||
|
<img src="https://github.com/orangecoding/fredy/blob/master/doc/jetbrains.png" width="200">
|
||||||
|
|
||||||
|
_Fredy_ is supported by JetBrains under Open Source Support Program
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
- Make sure to use NodeJs 12 and above
|
- Make sure to use Node.js 16 or above
|
||||||
- Run the following commands
|
- Run the following commands:
|
||||||
```ssh
|
```ssh
|
||||||
yarn (or npm install)
|
yarn (or npm install)
|
||||||
yarn run prod
|
yarn run prod
|
||||||
yarn run start
|
yarn run start
|
||||||
```
|
```
|
||||||
_Fredy_ will start with the default port, set to `9998`. You can access _Fredy_ by opening a browser `http://localhost:9998`. The default login is `admin` both for username and password. (You should change the password asap when you plan to run Fredy on your server.)
|
_Fredy_ will start with the default port, set to `9998`. You can access _Fredy_ by opening your browser at `http://localhost:9998`. The default login is `admin`, both for username and password. You should change the password as soon as possible when you plan to run Fredy on a server.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img alt="Job Configuration" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot__1.png" width="30%">
|
<img alt="Job Configuration" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot1.png" width="30%">
|
||||||
|
|
||||||
<img alt="Job Analytics" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot2.png" width="30%">
|
<img alt="Job Analytics" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot_2.png" width="30%">
|
||||||
|
|
||||||
<img alt="Job Overview" width="30%" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot3.png">
|
<img alt="Job Overview" width="30%" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot_3.png">
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## Immoscout
|
|
||||||
I have added **experimental** support for Immoscout. Immoscout is somewhat special, coz they have decided to secure their service from bots using Re-Capture. Finding a way around this is barely possible. For _Fredy_ to be able to bypass the check, I'm using a service called [ScrapingAnt](https://scrapingant.com/). The trick is to use a headless browser, rotating proxies and (once successful validated) re-send the cookies each time.
|
|
||||||
|
|
||||||
To be able to use Immoscout, you need to create an account at ScrapingAnt. Configure the ApiKey in the "General Settings" tab (visible when logged in as administrator).
|
|
||||||
The rest should be done by _Fredy_. Keep in mind, the support is experimental. There might be bugs and you might not always get pass the re-capture check, but most of the time it works pretty good :)
|
|
||||||
|
|
||||||
If you need more that the 1000 api calls you can do per month, I'd suggest opting for a paid account... ScrapingAnt loves OpenSource, therefor they've decided to give all _Fredy_ users a 10% discount by using the code **FREDY10** (No I don't get any money for recommending good services...)
|
|
||||||
|
|
||||||
|
|
||||||
## Understanding the fundamentals
|
## Understanding the fundamentals
|
||||||
There are 3 important parts in Fredy, that you need to understand leveraging the full power of _Fredy_.
|
There are 3 important parts in Fredy, that you need to understand to leverage the full power of _Fredy_.
|
||||||
|
|
||||||
#### Adapter
|
|
||||||
_Fredy_ supports multiple services. Immonet, Immowelt and Ebay are just a few. Those services are called adapter within _Fredy_. When creating a new job, you can choose 1 or many adapter.
|
|
||||||
An adapter holds the url that points to the search results for the service. If you go to immonet.de and search for something, the shown url in the browser is what the adapter needs to do it's magic.
|
|
||||||
**It is important that you order the search results by date, so that _Fredy_ always picks the latest ones first**
|
|
||||||
|
|
||||||
#### Provider
|
#### Provider
|
||||||
_Fredy_ supports multiple provider. Slack, SendGrid, Telegram etc. A search job can have as many provider as supported by _Fredy_. Each provider needs different configuration values, which you have to provide when using it. A provider itself dictactes how the frontend renders by telling the frontend what information it needs in order to send listings to the user.
|
_Fredy_ supports multiple services. Immonet, Immowelt and Ebay are just a few examples. Those services are called providers within _Fredy_. When creating a new job, you can choose one or more providers.
|
||||||
|
A provider contains the URL that points to the search results for the respective service. If you go to immonet.de and search for something, the displayed URL in the browser is what the provider needs to do its magic.
|
||||||
|
**It is important that you order the search results by date, so that _Fredy_ always picks the latest results first!**
|
||||||
|
|
||||||
|
#### Adapter
|
||||||
|
_Fredy_ supports multiple adapters, such as Slack, SendGrid, Telegram etc. A search job can have as many adapters as supported by _Fredy_. Each adapter needs different configuration values, which you have to provide when using them. A adapter dictactes how the frontend renders by telling the frontend what information it needs in order to send listings to the user.
|
||||||
|
|
||||||
#### Jobs
|
#### Jobs
|
||||||
A Job wraps adapter and provider. _Fredy_ runs the configured jobs in a specific interval (can be configured in `/conf/config.json`).
|
A Job wraps adapters and providers. _Fredy_ runs the configured jobs in a specific interval (can be configured in `/conf/config.json`).
|
||||||
|
|
||||||
## Creating your first job
|
## Creating your first job
|
||||||
To create your first job, click on the button "Create New Job" on the job table. The job creation dialog should be self explanatory, however there's one important thing.
|
To create your first job, click on the button "Create New Job" on the job table. The job creation dialog should be self-explanatory, however there is one important thing.
|
||||||
When configuring adapter, before copying the url from your browser make sure that you have sorted the results by date to make sure _Fredy_ always picks the latest results first.
|
When configuring providers, before copying the URL from your browser, make sure that you have sorted the results by date to make sure _Fredy_ always picks the latest results first.
|
||||||
|
|
||||||
## User management
|
## User management
|
||||||
As an administrator, you can create/edit and remove user from _Fredy_. Be careful, each job is connected to the user that has created the job. If you remove the user, the jobs will also be removed.
|
As an administrator, you can create, edit and remove users from _Fredy_. Be careful, each job is connected to the user that has created the job. If you remove the user, their jobs will also be removed.
|
||||||
|
|
||||||
|
|
||||||
# Development
|
# Development
|
||||||
|
|
||||||
### Running Fredy in dev mode
|
### Running Fredy in development mode
|
||||||
To run _Fredy_ in dev mode, you need to run the backend & frontend separately. Run the backend in your favorite IDE, the frontend can be started from the terminal.
|
To run _Fredy_ in development mode, you need to run the backend & frontend separately.
|
||||||
|
Start the backend with:
|
||||||
|
```shell
|
||||||
|
yarn run start
|
||||||
|
```
|
||||||
|
For the frontend, run:
|
||||||
```shell
|
```shell
|
||||||
yarn run dev
|
yarn run dev
|
||||||
```
|
```
|
||||||
You should now be able to access _Fredy_ with your browser. Go to `http://localhost:9000`
|
You should now be able to access _Fredy_ from your browser. Check your Terminal to see what port the frontend is running on.
|
||||||
|
|
||||||
### Running Tests
|
### Running Tests
|
||||||
To run the tests, simply run
|
To run the tests, run
|
||||||
```shell
|
```shell
|
||||||
yarn run test
|
yarn run test
|
||||||
```
|
```
|
||||||
@@ -79,22 +81,20 @@ yarn run test
|
|||||||
# Architecture
|
# Architecture
|
||||||

|

|
||||||
|
|
||||||
## Immoscout
|
### Immoscout / Immonet
|
||||||
I have added EXPERIMENTAL support for Immoscout. Immoscout is somewhat special, coz they have decided to secure their service from bots using Re-Capture. Finding a way
|
I have added **experimental** support for Immoscout and Immonet. They both are somewhat special, because they have decided to secure their service from bots using Re-Capture. Finding a way around this is barely possible. For _Fredy_ to be able to bypass this check, I'm using a service called [ScrapingAnt](https://scrapingant.com/). The trick is to use a headless browser, rotating proxies and (once successfully validated) to re-send the cookies each time.
|
||||||
around this is barely possible. For _Fredy_ to be able to bypass the check, I'm using a service called [ScrapingAnt](https://scrapingant.com/).
|
|
||||||
|
|
||||||
To be able to use Immoscout, you need to create an account and copy the apiKey into the config file under /conf/config.json.
|
To be able to use Immoscout / Immonet, you need to create an account at ScrapingAnt. Configure the API key in the "General Settings" tab (visible when logged in as administrator).
|
||||||
The rest should be done by _Fredy_. Keep in mind, the support is experimental. There might be bugs and you might not always get pass the re-capture check, but most of the time
|
The rest will be handled by _Fredy_. Keep in mind, the support is experimental. There might be bugs and you might not always pass the re-capture check, but most of the time it works rather well :)
|
||||||
it works pretty good :)
|
|
||||||
|
|
||||||
If you need more that the 1000 api calls you can do per month, I'd suggest opting for a paid account... (No I don't get any money for recommending good service)
|
If you need more than the 1000 API calls allowed per month, I'd suggest opting for a paid account... ScrapingAnt loves OpenSource, therefore they have decided to give all _Fredy_ users a 10% discount by using the code **FREDY10** (Disclaimer: I do not earn any money for recommending their service).
|
||||||
|
|
||||||
#### Contribution guidelines
|
### Contribution guidelines
|
||||||
|
|
||||||
See [Contribution](https://github.com/orangecoding/fredy/blob/master/CONTRIBUTION.md)
|
See [Contributing](https://github.com/orangecoding/fredy/blob/master/CONTRIBUTING.md)
|
||||||
|
|
||||||
# Docker
|
# Docker
|
||||||
Use the Dockerfile in this Repository to build an image.
|
Use the Dockerfile in this repository to build an image.
|
||||||
|
|
||||||
Example: `docker build -t fredy/fredy /path/to/your/Dockerfile`
|
Example: `docker build -t fredy/fredy /path/to/your/Dockerfile`
|
||||||
|
|
||||||
@@ -102,12 +102,16 @@ Or use docker-compose:
|
|||||||
|
|
||||||
Example `docker-compose build`
|
Example `docker-compose build`
|
||||||
|
|
||||||
|
Or use the container that will be built automatically.
|
||||||
|
|
||||||
|
`docker pull ghcr.io/orangecoding/fredy:master`
|
||||||
|
|
||||||
## Create & run a container
|
## Create & run a container
|
||||||
|
|
||||||
Put your config.json to `/path/to/your/conf/`
|
Put your config.json into a path of your choice, such as `/path/to/your/conf/`.
|
||||||
|
|
||||||
Example: `docker create --name fredy -v /path/to/your/conf/:/conf -p 9998:9998 fredy/fredy`
|
Example: `docker create --name fredy -v /path/to/your/conf/:/conf -p 9998:9998 fredy/fredy`
|
||||||
|
|
||||||
## Logs
|
## Logs
|
||||||
|
|
||||||
You can browse the logs with `docker logs fredy -f`
|
You can browse the logs with `docker logs fredy -f`.
|
||||||
|
|||||||
@@ -1,33 +0,0 @@
|
|||||||
FROM alpine:latest AS build
|
|
||||||
# use given repository, default below:
|
|
||||||
ARG repo=https://github.com/orangecoding/fredy.git
|
|
||||||
|
|
||||||
RUN mkdir -p /usr/src/
|
|
||||||
#Install Software
|
|
||||||
RUN apk add --update nodejs npm git
|
|
||||||
|
|
||||||
# Output used repository
|
|
||||||
RUN echo "Cloning from $repo"
|
|
||||||
|
|
||||||
RUN cd /usr/src && git clone $repo
|
|
||||||
|
|
||||||
RUN ln -s /usr/src/fredy/conf/ /conf
|
|
||||||
|
|
||||||
# create db folder
|
|
||||||
RUN mkdir /usr/src/fredy/db/
|
|
||||||
|
|
||||||
RUN ln -s /usr/src/fredy/db/ /db
|
|
||||||
|
|
||||||
RUN npm i -g yarn
|
|
||||||
|
|
||||||
RUN cd /usr/src/fredy/ && yarn
|
|
||||||
|
|
||||||
WORKDIR /usr/src/fredy
|
|
||||||
|
|
||||||
RUN yarn run prod
|
|
||||||
|
|
||||||
EXPOSE 9998
|
|
||||||
|
|
||||||
VOLUME [ "/conf", "/db" ]
|
|
||||||
# --no-daemon is required for keeping Container alive
|
|
||||||
CMD node index.js --no-daemon
|
|
||||||
@@ -1 +1 @@
|
|||||||
{"interval":"60","port":9998,"scrapingAnt":{"apiKey":""},"workingHours":{"from":"","to":""}}
|
{"interval":"60","port":9998,"scrapingAnt":{"apiKey":"","proxy":"datacenter"},"workingHours":{"from":"","to":""}}
|
||||||
84
doc/Untitled Diagram.drawio
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
<mxfile host="app.diagrams.net" modified="2022-01-29T18:34:51.211Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36" etag="W0jmvptvMSkuHq89hwUy" version="16.5.2" type="github">
|
||||||
|
<diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">
|
||||||
|
<mxGraphModel dx="850" dy="907" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
|
||||||
|
<root>
|
||||||
|
<mxCell id="WIyWlLk6GJQsqaUBKTNV-0" />
|
||||||
|
<mxCell id="WIyWlLk6GJQsqaUBKTNV-1" parent="WIyWlLk6GJQsqaUBKTNV-0" />
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-5" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="WIyWlLk6GJQsqaUBKTNV-3" target="WIyWlLk6GJQsqaUBKTNV-7">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="WIyWlLk6GJQsqaUBKTNV-3" value="Job1" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
|
||||||
|
<mxGeometry x="100" y="50" width="120" height="30" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-8" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="WIyWlLk6GJQsqaUBKTNV-7" target="4kAlOAlRylSy7JMoHAEd-2">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="WIyWlLk6GJQsqaUBKTNV-7" target="4kAlOAlRylSy7JMoHAEd-3">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-11" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="WIyWlLk6GJQsqaUBKTNV-7" target="4kAlOAlRylSy7JMoHAEd-4">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="WIyWlLk6GJQsqaUBKTNV-7" value="FredyRuntime" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#fff2cc;strokeColor=#d6b656;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
|
||||||
|
<mxGeometry x="110" y="120" width="360" height="40" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-6" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-0" target="WIyWlLk6GJQsqaUBKTNV-7">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-0" value="Job2" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="230" y="50" width="120" height="30" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-7" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-1" target="WIyWlLk6GJQsqaUBKTNV-7">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-1" value="Job3" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="360" y="50" width="120" height="30" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-13" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-2" target="4kAlOAlRylSy7JMoHAEd-12">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-2" value="Provider1" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="100" y="210" width="120" height="40" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-14" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-3">
|
||||||
|
<mxGeometry relative="1" as="geometry">
|
||||||
|
<mxPoint x="290" y="290" as="targetPoint" />
|
||||||
|
</mxGeometry>
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-3" value="Provider2" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="230" y="210" width="120" height="40" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-4" target="4kAlOAlRylSy7JMoHAEd-12">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-4" value="Provider3" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="360" y="210" width="120" height="40" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-17" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-12" target="4kAlOAlRylSy7JMoHAEd-16">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-12" value="Similarity check" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="110" y="290" width="360" height="40" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-20" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-16" target="4kAlOAlRylSy7JMoHAEd-18">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-16" value="Found similarity" style="rhombus;whiteSpace=wrap;html=1;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="250" y="360" width="80" height="80" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-21" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-18" target="4kAlOAlRylSy7JMoHAEd-19">
|
||||||
|
<mxGeometry relative="1" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-18" value="Notification Adapter1" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="230" y="460" width="120" height="40" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-19" value="Notification Adapter2" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="230" y="520" width="120" height="40" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
<mxCell id="4kAlOAlRylSy7JMoHAEd-22" value="No" style="text;html=1;resizable=0;autosize=1;align=center;verticalAlign=middle;points=[];fillColor=none;strokeColor=none;rounded=0;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
|
||||||
|
<mxGeometry x="300" y="440" width="30" height="20" as="geometry" />
|
||||||
|
</mxCell>
|
||||||
|
</root>
|
||||||
|
</mxGraphModel>
|
||||||
|
</diagram>
|
||||||
|
</mxfile>
|
||||||
BIN
doc/jetbrains.png
Normal file
|
After Width: | Height: | Size: 150 KiB |
BIN
doc/screenshot1.png
Normal file
|
After Width: | Height: | Size: 121 KiB |
|
Before Width: | Height: | Size: 279 KiB |
|
Before Width: | Height: | Size: 380 KiB |
BIN
doc/screenshot_2.png
Normal file
|
After Width: | Height: | Size: 323 KiB |
BIN
doc/screenshot_3.png
Normal file
|
After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 202 KiB |
@@ -4,10 +4,8 @@ services:
|
|||||||
container_name: fredy
|
container_name: fredy
|
||||||
# build from empty build folder to reduce size of image
|
# build from empty build folder to reduce size of image
|
||||||
build:
|
build:
|
||||||
context: ./build
|
context: .
|
||||||
dockerfile: Dockerfile
|
dockerfile: Dockerfile
|
||||||
args:
|
|
||||||
repo: https://github.com/orangecoding/fredy.git
|
|
||||||
image: fredy/fredy
|
image: fredy/fredy
|
||||||
# map existing config and database
|
# map existing config and database
|
||||||
volumes:
|
volumes:
|
||||||
|
|||||||
@@ -4,14 +4,13 @@
|
|||||||
<meta charset="UTF-8"
|
<meta charset="UTF-8"
|
||||||
name="viewport"
|
name="viewport"
|
||||||
content="user-scalable=no, width=device-width, initial-scale=1, maximum-scale=1">
|
content="user-scalable=no, width=device-width, initial-scale=1, maximum-scale=1">
|
||||||
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.4.1/semantic.min.css">
|
|
||||||
<meta name="google" content="notranslate">
|
<meta name="google" content="notranslate">
|
||||||
|
|
||||||
<title>Fredy</title>
|
<title>Fredy</title>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body theme-mode="dark">
|
||||||
|
|
||||||
<div id="fredy" style="position: absolute;top: 0;left: 0;right: 0;bottom: 0;"></div>
|
<div id="fredy" style="position: absolute;top: 0;left: 0;right: 0;bottom: 0;"></div>
|
||||||
</body>
|
</body>
|
||||||
<script src="fredy.bundle.js"></script>
|
<script type="module" src="/ui/src/Index.jsx"></script>
|
||||||
</html>
|
</html>
|
||||||
58
index.js
@@ -1,63 +1,41 @@
|
|||||||
const fs = require('fs');
|
import fs from 'fs';
|
||||||
|
import { config } from './lib/utils.js';
|
||||||
|
import * as similarityCache from './lib/services/similarity-check/similarityCache.js';
|
||||||
|
import { setLastJobExecution } from './lib/services/storage/listingsStorage.js';
|
||||||
|
import * as jobStorage from './lib/services/storage/jobStorage.js';
|
||||||
|
import FredyRuntime from './lib/FredyRuntime.js';
|
||||||
|
import { duringWorkingHoursOrNotSet } from './lib/utils.js';
|
||||||
|
import './lib/api/api.js';
|
||||||
//if db folder does not exist, ensure to create it before loading anything else
|
//if db folder does not exist, ensure to create it before loading anything else
|
||||||
if (!fs.existsSync('./db')) {
|
if (!fs.existsSync('./db')) {
|
||||||
fs.mkdirSync('./db');
|
fs.mkdirSync('./db');
|
||||||
}
|
}
|
||||||
|
|
||||||
const path = './lib/provider';
|
const path = './lib/provider';
|
||||||
const provider = fs.readdirSync(path).filter((file) => file.endsWith('.js'));
|
const provider = fs.readdirSync(path).filter((file) => file.endsWith('.js'));
|
||||||
const config = require('./conf/config.json');
|
|
||||||
|
|
||||||
const similarityCache = require('./lib/services/similarity-check/similarityCache');
|
|
||||||
const { setLastJobExecution } = require('./lib/services/storage/listingsStorage');
|
|
||||||
const jobStorage = require('./lib/services/storage/jobStorage');
|
|
||||||
const FredyRuntime = require('./lib/FredyRuntime');
|
|
||||||
|
|
||||||
const { duringWorkingHoursOrNotSet } = require('./lib/utils');
|
|
||||||
|
|
||||||
//starting the api service
|
|
||||||
require('./lib/api/api');
|
|
||||||
|
|
||||||
//assuming interval is always in minutes
|
//assuming interval is always in minutes
|
||||||
const INTERVAL = config.interval * 60 * 1000;
|
const INTERVAL = config.interval * 60 * 1000;
|
||||||
|
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
console.log(`Started Fredy successfully. Ui can be accessed via http://localhost:${config.port}`);
|
console.log(`Started Fredy successfully. Ui can be accessed via http://localhost:${config.port}`);
|
||||||
/* eslint-enable no-console */
|
/* eslint-enable no-console */
|
||||||
|
const fetchedProvider = await Promise.all(
|
||||||
|
provider.filter((provider) => provider.endsWith('.js')).map(async (pro) => import(`${path}/${pro}`))
|
||||||
|
);
|
||||||
|
|
||||||
setInterval(
|
setInterval(
|
||||||
(function exec() {
|
(function exec() {
|
||||||
const isDuringWorkingHoursOrNotSet = duringWorkingHoursOrNotSet(config, Date.now());
|
const isDuringWorkingHoursOrNotSet = duringWorkingHoursOrNotSet(config, Date.now());
|
||||||
|
|
||||||
if (isDuringWorkingHoursOrNotSet) {
|
if (isDuringWorkingHoursOrNotSet) {
|
||||||
config.lastRun = Date.now();
|
config.lastRun = Date.now();
|
||||||
jobStorage
|
jobStorage
|
||||||
.getJobs()
|
.getJobs()
|
||||||
.filter((job) => job.enabled)
|
.filter((job) => job.enabled)
|
||||||
.forEach((job) => {
|
.forEach((job) => {
|
||||||
const providerIds = job.provider.map((provider) => provider.id);
|
job.provider
|
||||||
|
.filter((p) => fetchedProvider.find((fp) => fp.metaInformation.id === p.id) != null)
|
||||||
provider
|
.forEach(async (prov) => {
|
||||||
.filter((provider) => provider.endsWith('.js'))
|
const pro = fetchedProvider.find((fp) => fp.metaInformation.id === prov.id);
|
||||||
.map((pro) => require(`${path}/${pro}`))
|
pro.init(prov, job.blacklist);
|
||||||
.filter((provider) => providerIds.indexOf(provider.metaInformation.id) !== -1)
|
await new FredyRuntime(pro.config, job.notificationAdapter, prov.id, job.id, similarityCache).execute();
|
||||||
.forEach(async (pro) => {
|
|
||||||
const providerId = pro.metaInformation.id;
|
|
||||||
if (providerId == null || providerId.length === 0) {
|
|
||||||
throw new Error('Provider id must not be empty. => ' + pro);
|
|
||||||
}
|
|
||||||
const providerConfig = job.provider.find((jobProvider) => jobProvider.id === providerId);
|
|
||||||
if (providerConfig == null) {
|
|
||||||
throw new Error(`Provider Config for provider with id ${providerId} not found.`);
|
|
||||||
}
|
|
||||||
pro.init(providerConfig, job.blacklist);
|
|
||||||
await new FredyRuntime(
|
|
||||||
pro.config,
|
|
||||||
job.notificationAdapter,
|
|
||||||
providerId,
|
|
||||||
job.id,
|
|
||||||
similarityCache
|
|
||||||
).execute();
|
|
||||||
setLastJobExecution(job.id);
|
setLastJobExecution(job.id);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
const { NoNewListingsWarning } = require('./errors');
|
import { NoNewListingsWarning } from './errors.js';
|
||||||
const { setKnownListings, getKnownListings } = require('./services/storage/listingsStorage');
|
import { setKnownListings, getKnownListings } from './services/storage/listingsStorage.js';
|
||||||
|
import * as notify from './notification/notify.js';
|
||||||
const notify = require('./notification/notify');
|
import xray from './services/scraper.js';
|
||||||
const xray = require('./services/scraper');
|
import * as scrapingAnt from './services/scrapingAnt.js';
|
||||||
const scrapingAnt = require('./services/scrapingAnt');
|
import urlModifier from './services/queryStringMutator.js';
|
||||||
|
|
||||||
class FredyRuntime {
|
class FredyRuntime {
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
@@ -21,10 +20,10 @@ class FredyRuntime {
|
|||||||
this._jobKey = jobKey;
|
this._jobKey = jobKey;
|
||||||
this._similarityCache = similarityCache;
|
this._similarityCache = similarityCache;
|
||||||
}
|
}
|
||||||
|
|
||||||
execute() {
|
execute() {
|
||||||
return (
|
return (
|
||||||
Promise.resolve(this._providerConfig.url)
|
//modify the url to make sure search order is correctly set
|
||||||
|
Promise.resolve(urlModifier(this._providerConfig.url, this._providerConfig.sortByDateParam))
|
||||||
//scraping the site and try finding new listings
|
//scraping the site and try finding new listings
|
||||||
.then(this._getListings.bind(this))
|
.then(this._getListings.bind(this))
|
||||||
//bring them in a proper form (dictated by the provider)
|
//bring them in a proper form (dictated by the provider)
|
||||||
@@ -43,24 +42,22 @@ class FredyRuntime {
|
|||||||
.catch(this._handleError.bind(this))
|
.catch(this._handleError.bind(this))
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
_getListings(url) {
|
_getListings(url) {
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
const id = this._providerId;
|
const id = this._providerId;
|
||||||
if (scrapingAnt.isImmoscout(id) && !scrapingAnt.isScrapingAntApiKeySet()) {
|
if (scrapingAnt.needScrapingAnt(id) && !scrapingAnt.isScrapingAntApiKeySet()) {
|
||||||
const error = 'Immoscout can only be used with if you have set an apikey for scrapingAnt.';
|
const error = 'Immoscout or Immonet can only be used with if you have set an apikey for scrapingAnt.';
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
console.log(error);
|
console.log(error);
|
||||||
/* eslint-enable no-console */
|
/* eslint-enable no-console */
|
||||||
reject(error);
|
reject(error);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const u = scrapingAnt.isImmoscout(id) ? scrapingAnt.transformUrlForScrapingAnt(url, id) : url;
|
const u = scrapingAnt.needScrapingAnt(id) ? scrapingAnt.transformUrlForScrapingAnt(url, id) : url;
|
||||||
try {
|
try {
|
||||||
if (this._providerConfig.paginate != null) {
|
if (this._providerConfig.paginate != null) {
|
||||||
xray(u, this._providerConfig.crawlContainer, [this._providerConfig.crawlFields])
|
xray(u, this._providerConfig.crawlContainer, [this._providerConfig.crawlFields])
|
||||||
//the first 2 pages should be enough here
|
//the first 2 pages should be enough here
|
||||||
//TODO: Think about automagically sort by date
|
|
||||||
.limit(2)
|
.limit(2)
|
||||||
.paginate(this._providerConfig.paginate)
|
.paginate(this._providerConfig.paginate)
|
||||||
.then((listings) => {
|
.then((listings) => {
|
||||||
@@ -86,25 +83,19 @@ class FredyRuntime {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
_normalize(listings) {
|
_normalize(listings) {
|
||||||
return listings.map(this._providerConfig.normalize);
|
return listings.map(this._providerConfig.normalize);
|
||||||
}
|
}
|
||||||
|
|
||||||
_filter(listings) {
|
_filter(listings) {
|
||||||
return listings.filter(this._providerConfig.filter);
|
return listings.filter(this._providerConfig.filter);
|
||||||
}
|
}
|
||||||
|
|
||||||
_findNew(listings) {
|
_findNew(listings) {
|
||||||
const newListings = listings.filter((o) => getKnownListings(this._jobKey, this._providerId)[o.id] == null);
|
const newListings = listings.filter((o) => getKnownListings(this._jobKey, this._providerId)[o.id] == null);
|
||||||
|
|
||||||
if (newListings.length === 0) {
|
if (newListings.length === 0) {
|
||||||
throw new NoNewListingsWarning();
|
throw new NoNewListingsWarning();
|
||||||
}
|
}
|
||||||
|
|
||||||
return newListings;
|
return newListings;
|
||||||
}
|
}
|
||||||
|
|
||||||
_notify(newListings) {
|
_notify(newListings) {
|
||||||
if (newListings.length === 0) {
|
if (newListings.length === 0) {
|
||||||
throw new NoNewListingsWarning();
|
throw new NoNewListingsWarning();
|
||||||
@@ -112,7 +103,6 @@ class FredyRuntime {
|
|||||||
const sendNotifications = notify.send(this._providerId, newListings, this._notificationConfig, this._jobKey);
|
const sendNotifications = notify.send(this._providerId, newListings, this._notificationConfig, this._jobKey);
|
||||||
return Promise.all(sendNotifications).then(() => newListings);
|
return Promise.all(sendNotifications).then(() => newListings);
|
||||||
}
|
}
|
||||||
|
|
||||||
_save(newListings) {
|
_save(newListings) {
|
||||||
const currentListings = getKnownListings(this._jobKey, this._providerId) || {};
|
const currentListings = getKnownListings(this._jobKey, this._providerId) || {};
|
||||||
newListings.forEach((listing) => {
|
newListings.forEach((listing) => {
|
||||||
@@ -121,7 +111,6 @@ class FredyRuntime {
|
|||||||
setKnownListings(this._jobKey, this._providerId, currentListings);
|
setKnownListings(this._jobKey, this._providerId, currentListings);
|
||||||
return newListings;
|
return newListings;
|
||||||
}
|
}
|
||||||
|
|
||||||
_filterBySimilarListings(listings) {
|
_filterBySimilarListings(listings) {
|
||||||
const filteredList = listings.filter((listing) => {
|
const filteredList = listings.filter((listing) => {
|
||||||
const similar = this._similarityCache.hasSimilarEntries(this._jobKey, listing.title);
|
const similar = this._similarityCache.hasSimilarEntries(this._jobKey, listing.title);
|
||||||
@@ -135,10 +124,8 @@ class FredyRuntime {
|
|||||||
filteredList.forEach((filter) => this._similarityCache.addCacheEntry(this._jobKey, filter.title));
|
filteredList.forEach((filter) => this._similarityCache.addCacheEntry(this._jobKey, filter.title));
|
||||||
return filteredList;
|
return filteredList;
|
||||||
}
|
}
|
||||||
|
|
||||||
_handleError(err) {
|
_handleError(err) {
|
||||||
if (err.name !== 'NoNewListingsWarning') console.error(err);
|
if (err.name !== 'NoNewListingsWarning') console.error(err);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
export default FredyRuntime;
|
||||||
module.exports = FredyRuntime;
|
|
||||||
|
|||||||
@@ -1,44 +1,36 @@
|
|||||||
const { notificationAdapterRouter } = require('./routes/notificationAdapterRouter');
|
import { notificationAdapterRouter } from './routes/notificationAdapterRouter.js';
|
||||||
const { authInterceptor, cookieSession, adminInterceptor } = require('./security');
|
import { authInterceptor, cookieSession, adminInterceptor } from './security.js';
|
||||||
const { generalSettingsRouter } = require('./routes/generalSettingsRoute');
|
import { generalSettingsRouter } from './routes/generalSettingsRoute.js';
|
||||||
const { analyticsRouter } = require('./routes/analyticsRouter');
|
import { analyticsRouter } from './routes/analyticsRouter.js';
|
||||||
const { providerRouter } = require('./routes/providerRouter');
|
import { providerRouter } from './routes/providerRouter.js';
|
||||||
const { loginRouter } = require('./routes/loginRoute');
|
import { loginRouter } from './routes/loginRoute.js';
|
||||||
const config = require('../../conf/config.json');
|
import { config } from '../utils.js';
|
||||||
const { userRouter } = require('./routes/userRoute');
|
import { userRouter } from './routes/userRoute.js';
|
||||||
const { jobRouter } = require('./routes/jobRouter');
|
import { jobRouter } from './routes/jobRouter.js';
|
||||||
const bodyParser = require('body-parser');
|
import bodyParser from 'body-parser';
|
||||||
const service = require('restana')();
|
import restana from 'restana';
|
||||||
const files = require('serve-static');
|
import files from 'serve-static';
|
||||||
const path = require('path');
|
import path from 'path';
|
||||||
|
import { getDirName } from '../utils.js';
|
||||||
const staticService = files(path.join(__dirname, '../../ui/public'));
|
const service = restana();
|
||||||
|
const staticService = files(path.join(getDirName(), '../ui/public'));
|
||||||
const PORT = config.port || 9998;
|
const PORT = config.port || 9998;
|
||||||
|
|
||||||
service.use(bodyParser.json());
|
service.use(bodyParser.json());
|
||||||
|
|
||||||
service.use(cookieSession());
|
service.use(cookieSession());
|
||||||
|
|
||||||
service.use(staticService);
|
service.use(staticService);
|
||||||
|
|
||||||
service.use('/api/admin', authInterceptor());
|
service.use('/api/admin', authInterceptor());
|
||||||
service.use('/api/jobs', authInterceptor());
|
service.use('/api/jobs', authInterceptor());
|
||||||
|
|
||||||
// /admin can only be accessed when user is having admin permissions
|
// /admin can only be accessed when user is having admin permissions
|
||||||
service.use('/api/admin', adminInterceptor());
|
service.use('/api/admin', adminInterceptor());
|
||||||
|
|
||||||
service.use('/api/jobs/notificationAdapter', notificationAdapterRouter);
|
service.use('/api/jobs/notificationAdapter', notificationAdapterRouter);
|
||||||
service.use('/api/admin/generalSettings', generalSettingsRouter);
|
service.use('/api/admin/generalSettings', generalSettingsRouter);
|
||||||
service.use('/api/jobs/provider', providerRouter);
|
service.use('/api/jobs/provider', providerRouter);
|
||||||
service.use('/api/jobs/insights', analyticsRouter);
|
service.use('/api/jobs/insights', analyticsRouter);
|
||||||
service.use('/api/admin/users', userRouter);
|
service.use('/api/admin/users', userRouter);
|
||||||
service.use('/api/jobs', jobRouter);
|
service.use('/api/jobs', jobRouter);
|
||||||
|
|
||||||
service.use('/api/login', loginRouter);
|
service.use('/api/login', loginRouter);
|
||||||
|
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
service.start(PORT).then(() => {
|
service.start(PORT).then(() => {
|
||||||
console.info(`Started API service on port ${PORT}`);
|
console.info(`Started API service on port ${PORT}`);
|
||||||
});
|
});
|
||||||
/* eslint-enable no-console */
|
|
||||||
|
|||||||
@@ -1,12 +1,10 @@
|
|||||||
const service = require('restana')();
|
import restana from 'restana';
|
||||||
|
import * as listingStorage from '../../services/storage/listingsStorage.js';
|
||||||
|
const service = restana();
|
||||||
const analyticsRouter = service.newRouter();
|
const analyticsRouter = service.newRouter();
|
||||||
const listingStorage = require('../../services/storage/listingsStorage');
|
|
||||||
|
|
||||||
analyticsRouter.get('/:jobId', async (req, res) => {
|
analyticsRouter.get('/:jobId', async (req, res) => {
|
||||||
const { jobId } = req.params;
|
const { jobId } = req.params;
|
||||||
|
|
||||||
res.body = listingStorage.getListingProviderDataForAnalytics(jobId) || {};
|
res.body = listingStorage.getListingProviderDataForAnalytics(jobId) || {};
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
export { analyticsRouter };
|
||||||
exports.analyticsRouter = analyticsRouter;
|
|
||||||
|
|||||||
@@ -1,18 +1,16 @@
|
|||||||
const service = require('restana')();
|
import restana from 'restana';
|
||||||
|
import { config, getDirName } from '../../utils.js';
|
||||||
|
import fs from 'fs';
|
||||||
|
const service = restana();
|
||||||
const generalSettingsRouter = service.newRouter();
|
const generalSettingsRouter = service.newRouter();
|
||||||
const config = require('../../../conf/config.json');
|
|
||||||
const fs = require('fs');
|
|
||||||
|
|
||||||
generalSettingsRouter.get('/', async (req, res) => {
|
generalSettingsRouter.get('/', async (req, res) => {
|
||||||
res.body = Object.assign({}, config);
|
res.body = Object.assign({}, config);
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
|
||||||
generalSettingsRouter.post('/', async (req, res) => {
|
generalSettingsRouter.post('/', async (req, res) => {
|
||||||
const settings = req.body;
|
const settings = req.body;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
fs.writeFileSync(`${__dirname}/../../../conf/config.json`, JSON.stringify(settings));
|
fs.writeFileSync(`${getDirName()}/../conf/config.json`, JSON.stringify(settings));
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.send(new Error('Error while trying to write settings.'));
|
res.send(new Error('Error while trying to write settings.'));
|
||||||
@@ -20,5 +18,4 @@ generalSettingsRouter.post('/', async (req, res) => {
|
|||||||
}
|
}
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
export { generalSettingsRouter };
|
||||||
exports.generalSettingsRouter = generalSettingsRouter;
|
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
const service = require('restana')();
|
import restana from 'restana';
|
||||||
|
import fetch from 'node-fetch';
|
||||||
|
import * as jobStorage from '../../services/storage/jobStorage.js';
|
||||||
|
import * as userStorage from '../../services/storage/userStorage.js';
|
||||||
|
import * as immoscoutProvider from '../../provider/immoscout.js';
|
||||||
|
import { config } from '../../utils.js';
|
||||||
|
import { isAdmin } from '../security.js';
|
||||||
|
const service = restana();
|
||||||
const jobRouter = service.newRouter();
|
const jobRouter = service.newRouter();
|
||||||
const jobStorage = require('../../services/storage/jobStorage');
|
|
||||||
const userStorage = require('../../services/storage/userStorage');
|
|
||||||
const immoscoutProvider = require('../../provider/immoscout');
|
|
||||||
const config = require('../../../conf/config.json');
|
|
||||||
|
|
||||||
const { isAdmin } = require('../security');
|
|
||||||
|
|
||||||
function doesJobBelongsToUser(job, req) {
|
function doesJobBelongsToUser(job, req) {
|
||||||
const userId = req.session.currentUser;
|
const userId = req.session.currentUser;
|
||||||
if (userId == null) {
|
if (userId == null) {
|
||||||
@@ -16,28 +16,31 @@ function doesJobBelongsToUser(job, req) {
|
|||||||
if (user == null) {
|
if (user == null) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
return user.isAdmin || job.userId === job.userId;
|
return user.isAdmin || job.userId === job.userId;
|
||||||
}
|
}
|
||||||
|
|
||||||
jobRouter.get('/', async (req, res) => {
|
jobRouter.get('/', async (req, res) => {
|
||||||
const isUserAdmin = isAdmin(req);
|
const isUserAdmin = isAdmin(req);
|
||||||
|
|
||||||
//show only the jobs which belongs to the user (or all of the user is an admin)
|
//show only the jobs which belongs to the user (or all of the user is an admin)
|
||||||
res.body = jobStorage.getJobs().filter((job) => isUserAdmin || job.userId === req.session.currentUser);
|
res.body = jobStorage.getJobs().filter((job) => isUserAdmin || job.userId === req.session.currentUser);
|
||||||
|
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
|
||||||
jobRouter.get('/processingTimes', async (req, res) => {
|
jobRouter.get('/processingTimes', async (req, res) => {
|
||||||
|
let scrapingAntData = null;
|
||||||
|
if (config.scrapingAnt.apiKey != null && config.scrapingAnt.apiKey.length > 0) {
|
||||||
|
try {
|
||||||
|
const response = await fetch(`https://api.scrapingant.com/v2/usage?x-api-key=${config.scrapingAnt.apiKey}`);
|
||||||
|
scrapingAntData = await response.json();
|
||||||
|
} catch (Exception) {
|
||||||
|
console.error('Could not query plan data from scraping ant.', Exception);
|
||||||
|
}
|
||||||
|
}
|
||||||
res.body = {
|
res.body = {
|
||||||
interval: config.interval,
|
interval: config.interval,
|
||||||
lastRun: config.lastRun || null,
|
lastRun: config.lastRun || null,
|
||||||
|
scrapingAntData,
|
||||||
};
|
};
|
||||||
|
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
|
||||||
jobRouter.post('/', async (req, res) => {
|
jobRouter.post('/', async (req, res) => {
|
||||||
const { provider, notificationAdapter, name, blacklist = [], jobId, enabled } = req.body;
|
const { provider, notificationAdapter, name, blacklist = [], jobId, enabled } = req.body;
|
||||||
if (
|
if (
|
||||||
@@ -65,7 +68,6 @@ jobRouter.post('/', async (req, res) => {
|
|||||||
}
|
}
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
|
||||||
jobRouter.delete('', async (req, res) => {
|
jobRouter.delete('', async (req, res) => {
|
||||||
const { jobId } = req.body;
|
const { jobId } = req.body;
|
||||||
try {
|
try {
|
||||||
@@ -81,7 +83,6 @@ jobRouter.delete('', async (req, res) => {
|
|||||||
}
|
}
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
|
||||||
jobRouter.put('/:jobId/status', async (req, res) => {
|
jobRouter.put('/:jobId/status', async (req, res) => {
|
||||||
const { status } = req.body;
|
const { status } = req.body;
|
||||||
const { jobId } = req.params;
|
const { jobId } = req.params;
|
||||||
@@ -101,5 +102,4 @@ jobRouter.put('/:jobId/status', async (req, res) => {
|
|||||||
}
|
}
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
export { jobRouter };
|
||||||
exports.jobRouter = jobRouter;
|
|
||||||
|
|||||||
@@ -1,32 +1,28 @@
|
|||||||
const service = require('restana')();
|
import restana from 'restana';
|
||||||
|
import * as userStorage from '../../services/storage/userStorage.js';
|
||||||
|
import * as hasher from '../../services/security/hash.js';
|
||||||
|
const service = restana();
|
||||||
const loginRouter = service.newRouter();
|
const loginRouter = service.newRouter();
|
||||||
const userStorage = require('../../services/storage/userStorage');
|
|
||||||
const hasher = require('../../services/security/hash');
|
|
||||||
|
|
||||||
loginRouter.get('/user', async (req, res) => {
|
loginRouter.get('/user', async (req, res) => {
|
||||||
const currentUserId = req.session.currentUser;
|
const currentUserId = req.session.currentUser;
|
||||||
const isAdmin = currentUserId == null ? false : userStorage.getUser(currentUserId).isAdmin;
|
const currentUser = currentUserId == null ? null : userStorage.getUser(currentUserId);
|
||||||
if (currentUserId == null) {
|
if (currentUser == null) {
|
||||||
res.body = {};
|
res.body = {};
|
||||||
} else {
|
} else {
|
||||||
res.body = {
|
res.body = {
|
||||||
userId: currentUserId,
|
userId: currentUser.id,
|
||||||
isAdmin,
|
isAdmin: currentUser.isAdmin,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
|
||||||
loginRouter.post('/', async (req, res) => {
|
loginRouter.post('/', async (req, res) => {
|
||||||
const { username, password } = req.body;
|
const { username, password } = req.body;
|
||||||
|
|
||||||
const user = userStorage.getUsers(true).find((user) => user.username === username);
|
const user = userStorage.getUsers(true).find((user) => user.username === username);
|
||||||
|
|
||||||
if (user == null) {
|
if (user == null) {
|
||||||
res.send(401);
|
res.send(401);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (user.password === hasher.hash(password)) {
|
if (user.password === hasher.hash(password)) {
|
||||||
req.session.currentUser = user.id;
|
req.session.currentUser = user.id;
|
||||||
userStorage.setLastLoginToNow({ userId: user.id });
|
userStorage.setLastLoginToNow({ userId: user.id });
|
||||||
@@ -35,13 +31,10 @@ loginRouter.post('/', async (req, res) => {
|
|||||||
} else {
|
} else {
|
||||||
console.error(`User ${username} tried to login, but password was wrong.`);
|
console.error(`User ${username} tried to login, but password was wrong.`);
|
||||||
}
|
}
|
||||||
|
|
||||||
res.send(401);
|
res.send(401);
|
||||||
});
|
});
|
||||||
|
|
||||||
loginRouter.post('/logout', async (req, res) => {
|
loginRouter.post('/logout', async (req, res) => {
|
||||||
req.session = null;
|
req.session = null;
|
||||||
res.send(200);
|
res.send(200);
|
||||||
});
|
});
|
||||||
|
export { loginRouter };
|
||||||
exports.loginRouter = loginRouter;
|
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
const fs = require('fs');
|
import fs from 'fs';
|
||||||
const service = require('restana')();
|
import restana from 'restana';
|
||||||
|
const service = restana();
|
||||||
const notificationAdapterRouter = service.newRouter();
|
const notificationAdapterRouter = service.newRouter();
|
||||||
|
|
||||||
const notificationAdapterList = fs.readdirSync('./lib//notification/adapter').filter((file) => file.endsWith('.js'));
|
const notificationAdapterList = fs.readdirSync('./lib//notification/adapter').filter((file) => file.endsWith('.js'));
|
||||||
|
const notificationAdapter = await Promise.all(
|
||||||
const notificationAdapter = notificationAdapterList.map((pro) => {
|
notificationAdapterList.map(async (pro) => {
|
||||||
return require(`../../notification/adapter/${pro}`);
|
return await import(`../../notification/adapter/${pro}`);
|
||||||
});
|
})
|
||||||
|
);
|
||||||
notificationAdapterRouter.post('/try', async (req, res) => {
|
notificationAdapterRouter.post('/try', async (req, res) => {
|
||||||
const { id, fields } = req.body;
|
const { id, fields } = req.body;
|
||||||
const adapter = notificationAdapter.find((adapter) => adapter.config.id === id);
|
const adapter = notificationAdapter.find((adapter) => adapter.config.id === id);
|
||||||
@@ -24,7 +24,6 @@ notificationAdapterRouter.post('/try', async (req, res) => {
|
|||||||
enabled: true,
|
enabled: true,
|
||||||
id,
|
id,
|
||||||
});
|
});
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await adapter.send({
|
await adapter.send({
|
||||||
serviceName: 'TestCall',
|
serviceName: 'TestCall',
|
||||||
@@ -40,16 +39,13 @@ notificationAdapterRouter.post('/try', async (req, res) => {
|
|||||||
notificationConfig,
|
notificationConfig,
|
||||||
jobKey: 'TestJob',
|
jobKey: 'TestJob',
|
||||||
});
|
});
|
||||||
|
|
||||||
res.send();
|
res.send();
|
||||||
} catch (Exception) {
|
} catch (Exception) {
|
||||||
res.send(new Error(Exception));
|
res.send(new Error(Exception));
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
notificationAdapterRouter.get('/', async (req, res) => {
|
notificationAdapterRouter.get('/', async (req, res) => {
|
||||||
res.body = notificationAdapter.map((adapter) => adapter.config);
|
res.body = notificationAdapter.map((adapter) => adapter.config);
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
export { notificationAdapterRouter };
|
||||||
exports.notificationAdapterRouter = notificationAdapterRouter;
|
|
||||||
|
|||||||
@@ -1,16 +1,15 @@
|
|||||||
const fs = require('fs');
|
import fs from 'fs';
|
||||||
const service = require('restana')();
|
import restana from 'restana';
|
||||||
|
const service = restana();
|
||||||
const providerRouter = service.newRouter();
|
const providerRouter = service.newRouter();
|
||||||
|
|
||||||
const providerList = fs.readdirSync('./lib/provider').filter((file) => file.endsWith('.js'));
|
const providerList = fs.readdirSync('./lib/provider').filter((file) => file.endsWith('.js'));
|
||||||
|
const provider = await Promise.all(
|
||||||
const provider = providerList.map((pro) => {
|
providerList.map(async (pro) => {
|
||||||
return require(`../../provider/${pro}`).metaInformation;
|
return await import(`../../provider/${pro}`);
|
||||||
});
|
})
|
||||||
|
);
|
||||||
providerRouter.get('/', async (req, res) => {
|
providerRouter.get('/', async (req, res) => {
|
||||||
res.body = provider;
|
res.body = provider.map((p) => p.metaInformation);
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
export { providerRouter };
|
||||||
exports.providerRouter = providerRouter;
|
|
||||||
|
|||||||
@@ -1,33 +1,27 @@
|
|||||||
const service = require('restana')();
|
import restana from 'restana';
|
||||||
|
import * as userStorage from '../../services/storage/userStorage.js';
|
||||||
|
import * as jobStorage from '../../services/storage/jobStorage.js';
|
||||||
|
const service = restana();
|
||||||
const userRouter = service.newRouter();
|
const userRouter = service.newRouter();
|
||||||
const userStorage = require('../../services/storage/userStorage');
|
|
||||||
const jobStorage = require('../../services/storage/jobStorage');
|
|
||||||
|
|
||||||
function checkIfAnyAdminAfterRemovingUser(userIdToBeRemoved, allUser) {
|
function checkIfAnyAdminAfterRemovingUser(userIdToBeRemoved, allUser) {
|
||||||
return allUser.filter((user) => user.id !== userIdToBeRemoved && user.isAdmin).length > 0;
|
return allUser.filter((user) => user.id !== userIdToBeRemoved && user.isAdmin).length > 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
function checkIfUserToBeRemovedIsLoggedIn(userIdToBeRemoved, req) {
|
function checkIfUserToBeRemovedIsLoggedIn(userIdToBeRemoved, req) {
|
||||||
return req.session.currentUser === userIdToBeRemoved;
|
return req.session.currentUser === userIdToBeRemoved;
|
||||||
}
|
}
|
||||||
|
|
||||||
const nullOrEmpty = (str) => str == null || str.length === 0;
|
const nullOrEmpty = (str) => str == null || str.length === 0;
|
||||||
|
|
||||||
userRouter.get('/', async (req, res) => {
|
userRouter.get('/', async (req, res) => {
|
||||||
res.body = userStorage.getUsers(false);
|
res.body = userStorage.getUsers(false);
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
|
||||||
userRouter.get('/:userId', async (req, res) => {
|
userRouter.get('/:userId', async (req, res) => {
|
||||||
const { userId } = req.params;
|
const { userId } = req.params;
|
||||||
res.body = userStorage.getUser(userId);
|
res.body = userStorage.getUser(userId);
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
|
||||||
userRouter.delete('/', async (req, res) => {
|
userRouter.delete('/', async (req, res) => {
|
||||||
const { userId } = req.body;
|
const { userId } = req.body;
|
||||||
const allUser = userStorage.getUsers(false);
|
const allUser = userStorage.getUsers(false);
|
||||||
|
|
||||||
if (!checkIfAnyAdminAfterRemovingUser(userId, allUser)) {
|
if (!checkIfAnyAdminAfterRemovingUser(userId, allUser)) {
|
||||||
res.send(new Error('You are trying to remove the last admin user. This is prohibited.'));
|
res.send(new Error('You are trying to remove the last admin user. This is prohibited.'));
|
||||||
return;
|
return;
|
||||||
@@ -36,14 +30,11 @@ userRouter.delete('/', async (req, res) => {
|
|||||||
res.send(new Error('You are trying to remove yourself. This is prohibited.'));
|
res.send(new Error('You are trying to remove yourself. This is prohibited.'));
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
//TODO: Remove also analytics
|
//TODO: Remove also analytics
|
||||||
jobStorage.removeJobsByUserId(userId);
|
jobStorage.removeJobsByUserId(userId);
|
||||||
userStorage.removeUser(userId);
|
userStorage.removeUser(userId);
|
||||||
|
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
|
||||||
userRouter.post('/', async (req, res) => {
|
userRouter.post('/', async (req, res) => {
|
||||||
const { username, password, password2, isAdmin, userId } = req.body;
|
const { username, password, password2, isAdmin, userId } = req.body;
|
||||||
if (password !== password2) {
|
if (password !== password2) {
|
||||||
@@ -55,22 +46,18 @@ userRouter.post('/', async (req, res) => {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const allUser = userStorage.getUsers(false);
|
const allUser = userStorage.getUsers(false);
|
||||||
|
|
||||||
if (!isAdmin && !checkIfAnyAdminAfterRemovingUser(userId, allUser)) {
|
if (!isAdmin && !checkIfAnyAdminAfterRemovingUser(userId, allUser)) {
|
||||||
res.send(
|
res.send(
|
||||||
new Error('You cannot change the admin flag for this user as otherwise, there is no other user in the system')
|
new Error('You cannot change the admin flag for this user as otherwise, there is no other user in the system')
|
||||||
);
|
);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
userStorage.upsertUser({
|
userStorage.upsertUser({
|
||||||
userId,
|
userId,
|
||||||
username,
|
username,
|
||||||
password,
|
password,
|
||||||
isAdmin,
|
isAdmin,
|
||||||
});
|
});
|
||||||
|
|
||||||
res.send();
|
res.send();
|
||||||
});
|
});
|
||||||
|
export { userRouter };
|
||||||
exports.userRouter = userRouter;
|
|
||||||
|
|||||||
@@ -1,15 +1,12 @@
|
|||||||
const userStorage = require('../services/storage/userStorage');
|
import * as userStorage from '../services/storage/userStorage.js';
|
||||||
const cookieSession = require('cookie-session');
|
import cookieSession from 'cookie-session';
|
||||||
const { nanoid } = require('nanoid');
|
import { nanoid } from 'nanoid';
|
||||||
|
|
||||||
const unauthorized = (res) => {
|
const unauthorized = (res) => {
|
||||||
return res.send(401);
|
return res.send(401);
|
||||||
};
|
};
|
||||||
|
|
||||||
const isUnauthorized = (req) => {
|
const isUnauthorized = (req) => {
|
||||||
return req.session.currentUser == null;
|
return req.session.currentUser == null;
|
||||||
};
|
};
|
||||||
|
|
||||||
const isAdmin = (req) => {
|
const isAdmin = (req) => {
|
||||||
if (!isUnauthorized(req)) {
|
if (!isUnauthorized(req)) {
|
||||||
const user = userStorage.getUser(req.session.currentUser);
|
const user = userStorage.getUser(req.session.currentUser);
|
||||||
@@ -17,7 +14,6 @@ const isAdmin = (req) => {
|
|||||||
}
|
}
|
||||||
return false;
|
return false;
|
||||||
};
|
};
|
||||||
|
|
||||||
const authInterceptor = () => {
|
const authInterceptor = () => {
|
||||||
return (req, res, next) => {
|
return (req, res, next) => {
|
||||||
if (isUnauthorized(req)) {
|
if (isUnauthorized(req)) {
|
||||||
@@ -27,7 +23,6 @@ const authInterceptor = () => {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
const adminInterceptor = () => {
|
const adminInterceptor = () => {
|
||||||
return (req, res, next) => {
|
return (req, res, next) => {
|
||||||
if (!isAdmin(req)) {
|
if (!isAdmin(req)) {
|
||||||
@@ -37,8 +32,7 @@ const adminInterceptor = () => {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
const cookieSession$0 = (userId) => {
|
||||||
exports.cookieSession = (userId) => {
|
|
||||||
return cookieSession({
|
return cookieSession({
|
||||||
name: 'fredy-admin-session',
|
name: 'fredy-admin-session',
|
||||||
keys: ['fredy', 'super', 'fancy', 'key', nanoid()],
|
keys: ['fredy', 'super', 'fancy', 'key', nanoid()],
|
||||||
@@ -46,8 +40,8 @@ exports.cookieSession = (userId) => {
|
|||||||
maxAge: 8 * 60 * 60 * 1000, // 8 hours
|
maxAge: 8 * 60 * 60 * 1000, // 8 hours
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
export { cookieSession$0 as cookieSession };
|
||||||
exports.adminInterceptor = adminInterceptor;
|
export { adminInterceptor };
|
||||||
exports.authInterceptor = authInterceptor;
|
export { authInterceptor };
|
||||||
exports.isUnauthorized = isUnauthorized;
|
export { isUnauthorized };
|
||||||
exports.isAdmin = isAdmin;
|
export { isAdmin };
|
||||||
|
|||||||
@@ -9,7 +9,8 @@ class ExtendableError extends Error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class NoNewListingsWarning extends ExtendableError {}
|
class NoNewListingsWarning extends ExtendableError {}
|
||||||
|
export { NoNewListingsWarning };
|
||||||
module.exports = { NoNewListingsWarning };
|
export default {
|
||||||
|
NoNewListingsWarning,
|
||||||
|
};
|
||||||
|
|||||||
@@ -1,19 +1,12 @@
|
|||||||
const { markdown2Html } = require('../../services/markdown');
|
import { markdown2Html } from '../../services/markdown.js';
|
||||||
|
|
||||||
/**
|
export const send = ({ serviceName, newListings, jobKey }) => {
|
||||||
* simply prints out the found data to the console
|
|
||||||
* @param serviceName e.g immowelt
|
|
||||||
* @param newListings an array with newly found listings
|
|
||||||
* @param jobKey name of the current job that is being executed
|
|
||||||
*/
|
|
||||||
exports.send = ({ serviceName, newListings, jobKey }) => {
|
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
return [Promise.resolve(console.info(`Found entry from service ${serviceName}, Job: ${jobKey}:`, newListings))];
|
return [Promise.resolve(console.info(`Found entry from service ${serviceName}, Job: ${jobKey}:`, newListings))];
|
||||||
/* eslint-enable no-console */
|
/* eslint-enable no-console */
|
||||||
};
|
};
|
||||||
|
export const config = {
|
||||||
exports.config = {
|
id: 'console',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
|
||||||
name: 'Console',
|
name: 'Console',
|
||||||
description: 'This adapter sends new listings to the console. It is mostly useful for debugging.',
|
description: 'This adapter sends new listings to the console. It is mostly useful for debugging.',
|
||||||
config: {},
|
config: {},
|
||||||
|
|||||||
@@ -1,35 +1,24 @@
|
|||||||
const mailjet = require('node-mailjet');
|
import mailjet from 'node-mailjet';
|
||||||
|
import path from 'path';
|
||||||
const path = require('path');
|
import fs from 'fs';
|
||||||
const fs = require('fs');
|
import Handlebars from 'handlebars';
|
||||||
const template = fs.readFileSync(path.resolve(__dirname, '../', 'emailTemplate/template.hbs'), 'utf8');
|
import { markdown2Html } from '../../services/markdown.js';
|
||||||
|
import { getDirName } from '../../utils.js';
|
||||||
const Handlebars = require('handlebars');
|
const __dirname = getDirName();
|
||||||
|
const template = fs.readFileSync(path.resolve(__dirname + '/notification/emailTemplate/template.hbs'), 'utf8');
|
||||||
const emailTemplate = Handlebars.compile(template);
|
const emailTemplate = Handlebars.compile(template);
|
||||||
const { markdown2Html } = require('../../services/markdown');
|
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
||||||
|
|
||||||
/**
|
|
||||||
* sends a new listing using MailJet
|
|
||||||
* @param serviceName e.g immowelt
|
|
||||||
* @param newListings an array with newly found listings
|
|
||||||
* @param notificationConfig config of this notification adapter
|
|
||||||
* * @param jobKey name of the current job that is being executed
|
|
||||||
* @returns {Promise<Chat.PostMessage.Response> | void}
|
|
||||||
*/
|
|
||||||
exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
|
||||||
const { apiPublicKey, apiPrivateKey, receiver, from } = notificationConfig.find(
|
const { apiPublicKey, apiPrivateKey, receiver, from } = notificationConfig.find(
|
||||||
(adapter) => adapter.id === 'mailJet'
|
(adapter) => adapter.id === 'mailjet'
|
||||||
).fields;
|
).fields;
|
||||||
|
|
||||||
const to = receiver
|
const to = receiver
|
||||||
.trim()
|
.trim()
|
||||||
.split(',')
|
.split(',')
|
||||||
.map((r) => ({
|
.map((r) => ({
|
||||||
Email: r.trim(),
|
Email: r.trim(),
|
||||||
}));
|
}));
|
||||||
|
|
||||||
return mailjet
|
return mailjet
|
||||||
.connect(apiPublicKey, apiPrivateKey)
|
.apiConnect(apiPublicKey, apiPrivateKey)
|
||||||
.post('send', { version: 'v3.1' })
|
.post('send', { version: 'v3.1' })
|
||||||
.request({
|
.request({
|
||||||
Messages: [
|
Messages: [
|
||||||
@@ -49,9 +38,8 @@ exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
|||||||
],
|
],
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
export const config = {
|
||||||
exports.config = {
|
id: 'mailjet',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
|
||||||
name: 'MailJet',
|
name: 'MailJet',
|
||||||
description: 'MailJet is being used to send new listings via mail.',
|
description: 'MailJet is being used to send new listings via mail.',
|
||||||
readme: markdown2Html('lib/notification/adapter/mailJet.md'),
|
readme: markdown2Html('lib/notification/adapter/mailJet.md'),
|
||||||
|
|||||||
39
lib/notification/adapter/mattermost.js
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
import { markdown2Html } from '../../services/markdown.js';
|
||||||
|
import { getJob } from '../../services/storage/jobStorage.js';
|
||||||
|
import fetch from 'node-fetch';
|
||||||
|
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
||||||
|
const { webhook, channel } = notificationConfig.find((adapter) => adapter.id === 'mattermost').fields;
|
||||||
|
const job = getJob(jobKey);
|
||||||
|
const jobName = job == null ? jobKey : job.name;
|
||||||
|
let message = `### *${jobName}* (${serviceName}) found **${newListings.length}** new listings:\n\n`;
|
||||||
|
message += `| Title | Address | Size | Price |\n|:----|:----|:----|:----|\n`;
|
||||||
|
message += newListings.map(
|
||||||
|
(o) => `| [${o.title}](${o.link}) | ` + [o.address, o.size.replace(/2m/g, '$m^2$'), o.price].join(' | ') + ' |\n'
|
||||||
|
);
|
||||||
|
return fetch(webhook, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: { 'Content-Type': 'application/json' },
|
||||||
|
body: {
|
||||||
|
channel: channel,
|
||||||
|
text: message,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
};
|
||||||
|
export const config = {
|
||||||
|
id: 'mattermost',
|
||||||
|
name: 'Mattermost',
|
||||||
|
readme: markdown2Html('lib/notification/adapter/mattermost.md'),
|
||||||
|
description: 'Fredy will send new listings to your mattermost team chat.',
|
||||||
|
fields: {
|
||||||
|
webhook: {
|
||||||
|
type: 'text',
|
||||||
|
label: 'Webhook-URL',
|
||||||
|
description: 'The incoming webhook url',
|
||||||
|
},
|
||||||
|
channel: {
|
||||||
|
type: 'text',
|
||||||
|
label: 'Channel',
|
||||||
|
description: 'The channel where fredy should send notifications to.',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
5
lib/notification/adapter/mattermost.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
### Mattermost Adapter
|
||||||
|
|
||||||
|
For Mattermost, you need to create a incoming webhook. This is pretty easy. Please visit the steps in the [developer docs](https://docs.mattermost.com/developer/webhooks-incoming.html) and follow the instructions.
|
||||||
|
|
||||||
|
As a result, you get the webhook URL for configuration in fredy. In addition, the target channel must be defined.
|
||||||
51
lib/notification/adapter/ntfy.js
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
import { markdown2Html } from '../../services/markdown.js';
|
||||||
|
import { getJob } from '../../services/storage/jobStorage.js';
|
||||||
|
import fetch from 'node-fetch';
|
||||||
|
|
||||||
|
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
||||||
|
const { priority, server, topic } = notificationConfig.find((adapter) => adapter.id === 'ntfy').fields;
|
||||||
|
const job = getJob(jobKey);
|
||||||
|
const jobName = job == null ? jobKey : job.name;
|
||||||
|
const promises = newListings.map((newListing) => {
|
||||||
|
const message = `Address: ${newListing.address} Size: ${newListing.size.replace(/2m/g, '$m^2$')} Price: ${
|
||||||
|
newListing.price
|
||||||
|
}`;
|
||||||
|
return fetch(server, {
|
||||||
|
method: 'POST',
|
||||||
|
body: JSON.stringify({
|
||||||
|
topic: topic,
|
||||||
|
message: message,
|
||||||
|
title: newListing.title,
|
||||||
|
tags: [serviceName, jobName],
|
||||||
|
priority: parseInt(priority),
|
||||||
|
click: newListing.link,
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
return Promise.all(promises);
|
||||||
|
};
|
||||||
|
export const config = {
|
||||||
|
id: 'ntfy',
|
||||||
|
name: 'ntfy',
|
||||||
|
readme: markdown2Html('lib/notification/adapter/ntfy.md'),
|
||||||
|
description: 'Fredy will send new listings to your ntfy.',
|
||||||
|
fields: {
|
||||||
|
priority: {
|
||||||
|
type: 'number',
|
||||||
|
label: 'Priority',
|
||||||
|
description: 'The priority of the send notification.',
|
||||||
|
},
|
||||||
|
server: {
|
||||||
|
type: 'text',
|
||||||
|
label: 'Server-URL',
|
||||||
|
description: 'The server url to the send the notification to.',
|
||||||
|
},
|
||||||
|
topic: {
|
||||||
|
type: 'text',
|
||||||
|
label: 'topic',
|
||||||
|
description:
|
||||||
|
'The topic where fredy should send notifications to. The topic is a secret, only known to you, make sure it is something not generic.',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
5
lib/notification/adapter/ntfy.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
### ntfy Adapter
|
||||||
|
|
||||||
|
For ntfy, you need to create a topic on your preferred ntfy instance. This is pretty easy. Please visit the steps in the [docs](https://docs.ntfy.sh/publish/) and follow the instructions.
|
||||||
|
|
||||||
|
As a result, you get the URL for configuration in fredy. In addition, the priority must be defined.
|
||||||
@@ -1,15 +1,6 @@
|
|||||||
const sgMail = require('@sendgrid/mail');
|
import sgMail from '@sendgrid/mail';
|
||||||
const { markdown2Html } = require('../../services/markdown');
|
import { markdown2Html } from '../../services/markdown.js';
|
||||||
|
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
||||||
/**
|
|
||||||
* sends a new listing using SendGrid
|
|
||||||
* @param serviceName e.g immowelt
|
|
||||||
* @param newListings an array with newly found listings
|
|
||||||
* @param notificationConfig config of this notification adapter
|
|
||||||
* @param jobKey name of the current job that is being executed
|
|
||||||
* @returns {Promise<Chat.PostMessage.Response> | void}
|
|
||||||
*/
|
|
||||||
exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
|
||||||
const { apiKey, receiver, from, templateId } = notificationConfig.find((adapter) => adapter.id === 'sendGrid').fields;
|
const { apiKey, receiver, from, templateId } = notificationConfig.find((adapter) => adapter.id === 'sendGrid').fields;
|
||||||
sgMail.setApiKey(apiKey);
|
sgMail.setApiKey(apiKey);
|
||||||
const msg = {
|
const msg = {
|
||||||
@@ -28,9 +19,8 @@ exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
|||||||
};
|
};
|
||||||
return sgMail.send(msg);
|
return sgMail.send(msg);
|
||||||
};
|
};
|
||||||
|
export const config = {
|
||||||
exports.config = {
|
id: 'sendgrid',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
|
||||||
name: 'SendGrid',
|
name: 'SendGrid',
|
||||||
description: 'SendGrid is being used to send new listings via mail.',
|
description: 'SendGrid is being used to send new listings via mail.',
|
||||||
readme: markdown2Html('lib/notification/adapter/sendGrid.md'),
|
readme: markdown2Html('lib/notification/adapter/sendGrid.md'),
|
||||||
|
|||||||
@@ -1,16 +1,7 @@
|
|||||||
const Slack = require('slack');
|
import Slack from 'slack';
|
||||||
|
import { markdown2Html } from '../../services/markdown.js';
|
||||||
const msg = Slack.chat.postMessage;
|
const msg = Slack.chat.postMessage;
|
||||||
const { markdown2Html } = require('../../services/markdown');
|
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
||||||
|
|
||||||
/**
|
|
||||||
* sends a new listing to slack
|
|
||||||
* @param serviceName e.g immowelt
|
|
||||||
* @param newListings an array with newly found listings
|
|
||||||
* @param notificationConfig config of this notification adapter
|
|
||||||
* * @param jobKey name of the current job that is being executed
|
|
||||||
* @returns {Promise<Chat.PostMessage.Response> | void}
|
|
||||||
*/
|
|
||||||
exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
|
||||||
const { token, channel } = notificationConfig.find((adapter) => adapter.id === 'slack').fields;
|
const { token, channel } = notificationConfig.find((adapter) => adapter.id === 'slack').fields;
|
||||||
return newListings.map((payload) =>
|
return newListings.map((payload) =>
|
||||||
msg({
|
msg({
|
||||||
@@ -47,9 +38,8 @@ exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
|||||||
})
|
})
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
export const config = {
|
||||||
exports.config = {
|
id: 'slack',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
|
||||||
name: 'Slack',
|
name: 'Slack',
|
||||||
readme: markdown2Html('lib/notification/adapter/slack.md'),
|
readme: markdown2Html('lib/notification/adapter/slack.md'),
|
||||||
description: 'Fredy will send new listings to the slack channel of your choice..',
|
description: 'Fredy will send new listings to the slack channel of your choice..',
|
||||||
|
|||||||
25
lib/notification/adapter/sqlite.js
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
import { markdown2Html } from '../../services/markdown.js';
|
||||||
|
import Database from 'better-sqlite3';
|
||||||
|
export const send = ({ serviceName, newListings, jobKey }) => {
|
||||||
|
const db = new Database('db/listings.db');
|
||||||
|
const fields = ['serviceName', 'jobKey', 'id', 'size', 'rooms', 'price', 'address', 'title', 'link', 'description'];
|
||||||
|
db.prepare(`CREATE TABLE IF NOT EXISTS listing (${fields.join(' TEXT, ')} TEXT);`).run();
|
||||||
|
const insert = db.prepare(`INSERT INTO listing (${fields.join(', ')}) VALUES (@${fields.join(', @')})`);
|
||||||
|
newListings.map((listing) => {
|
||||||
|
let insertListing = {};
|
||||||
|
fields.map((field) => {
|
||||||
|
insertListing[field] = listing[field];
|
||||||
|
});
|
||||||
|
insertListing.serviceName = serviceName;
|
||||||
|
insertListing.jobKey = jobKey;
|
||||||
|
insert.run(insertListing);
|
||||||
|
});
|
||||||
|
return Promise.resolve();
|
||||||
|
};
|
||||||
|
export const config = {
|
||||||
|
id: 'sqlite',
|
||||||
|
name: 'Sqlite',
|
||||||
|
description: 'This adapter stores listings in a local sqlite3 database.',
|
||||||
|
config: {},
|
||||||
|
readme: markdown2Html('lib/notification/adapter/sqlite.md'),
|
||||||
|
};
|
||||||
3
lib/notification/adapter/sqlite.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
### Sqlite Adapter
|
||||||
|
|
||||||
|
This adapter stores search results in an sqlite database in db/listings.db
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
const { markdown2Html } = require('../../services/markdown');
|
import { markdown2Html } from '../../services/markdown.js';
|
||||||
const axios = require('axios');
|
import { getJob } from '../../services/storage/jobStorage.js';
|
||||||
|
import fetch from 'node-fetch';
|
||||||
|
const MAX_ENTITIES_PER_CHUNK = 8;
|
||||||
|
const RATE_LIMIT_INTERVAL = 1010;
|
||||||
/**
|
/**
|
||||||
* splitting an array into chunks because Telegram only allows for messages up to
|
* splitting an array into chunks because Telegram only allows for messages up to
|
||||||
* 4096 chars, thus we have to split messages into chunks
|
* 4096 chars, thus we have to split messages into chunks
|
||||||
@@ -13,53 +15,51 @@ const arrayChunks = (inputArray, perChunk) =>
|
|||||||
all[ch] = [].concat(all[ch] || [], one);
|
all[ch] = [].concat(all[ch] || [], one);
|
||||||
return all;
|
return all;
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
/**
|
|
||||||
* sends new listings to telegram
|
|
||||||
* @param serviceName e.g immowelt
|
|
||||||
* @param newListings an array with newly found listings
|
|
||||||
* @param notificationConfig config of this notification adapter
|
|
||||||
* * @param jobKey name of the current job that is being executed
|
|
||||||
* @returns {Promise<Void> | void}
|
|
||||||
*/
|
|
||||||
exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
|
||||||
const { token, chatId } = notificationConfig.find((adapter) => adapter.id === 'telegram').fields;
|
|
||||||
|
|
||||||
//we have to split messages into chunk, because otherwise messages are going to become too big and will fail
|
|
||||||
const chunks = arrayChunks(newListings, 3);
|
|
||||||
|
|
||||||
const promises = chunks.map((chunk) => {
|
|
||||||
let message = `Job: ${jobKey} | Service <b>${serviceName}</b> found <b>${newListings.length}</b> new listings:\n\n`;
|
|
||||||
message += chunk.map(
|
|
||||||
(o) =>
|
|
||||||
`<b>${shorten(o.title.replace(/\*/g, ''), 45)}</b>\n` +
|
|
||||||
[o.address, o.price, o.size].join(' | ') +
|
|
||||||
'\n' +
|
|
||||||
`<a href="${o.link}">${o.link}</a>\n\n`
|
|
||||||
);
|
|
||||||
|
|
||||||
return axios.post(`https://api.telegram.org/bot${token}/sendMessage`, {
|
|
||||||
chat_id: chatId,
|
|
||||||
text: message,
|
|
||||||
parse_mode: 'HTML',
|
|
||||||
disable_web_page_preview: true,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
return Promise.all(promises);
|
|
||||||
};
|
|
||||||
|
|
||||||
function shorten(str, len = 30) {
|
function shorten(str, len = 30) {
|
||||||
return str.length > len ? str.substring(0, len) + '...' : str;
|
return str.length > len ? str.substring(0, len) + '...' : str;
|
||||||
}
|
}
|
||||||
|
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
|
||||||
/**
|
const { token, chatId } = notificationConfig.find((adapter) => adapter.id === 'telegram').fields;
|
||||||
* exported config is being used in the frontend to generate the fields
|
const job = getJob(jobKey);
|
||||||
* incoming values will be the keys (and values) of the fields
|
const jobName = job == null ? jobKey : job.name;
|
||||||
*
|
//we have to split messages into chunk, because otherwise messages are going to become too big and will fail
|
||||||
*/
|
const chunks = arrayChunks(newListings, MAX_ENTITIES_PER_CHUNK);
|
||||||
exports.config = {
|
const promises = chunks.map((chunk) => {
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
let message = `<i>${jobName}</i> (${serviceName}) found <b>${newListings.length}</b> new listings:\n\n`;
|
||||||
|
message += chunk.map(
|
||||||
|
(o) =>
|
||||||
|
`<a href='${o.link}'><b>${shorten(o.title.replace(/\*/g, ''), 45).trim()}</b></a>\n` +
|
||||||
|
[o.address, o.price, o.size].join(' | ') +
|
||||||
|
'\n\n'
|
||||||
|
);
|
||||||
|
/**
|
||||||
|
* This is to not break the rate limit. It is to only send 1 message per second
|
||||||
|
*/
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
setTimeout(() => {
|
||||||
|
fetch(`https://api.telegram.org/bot${token}/sendMessage`, {
|
||||||
|
method: 'post',
|
||||||
|
body: JSON.stringify({
|
||||||
|
chat_id: chatId,
|
||||||
|
text: message,
|
||||||
|
parse_mode: 'HTML',
|
||||||
|
disable_web_page_preview: true,
|
||||||
|
}),
|
||||||
|
headers: { 'Content-Type': 'application/json' },
|
||||||
|
})
|
||||||
|
.then(() => {
|
||||||
|
resolve();
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
reject();
|
||||||
|
});
|
||||||
|
}, RATE_LIMIT_INTERVAL);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
return Promise.all(promises);
|
||||||
|
};
|
||||||
|
export const config = {
|
||||||
|
id: 'telegram',
|
||||||
name: 'Telegram',
|
name: 'Telegram',
|
||||||
readme: markdown2Html('lib/notification/adapter/telegram.md'),
|
readme: markdown2Html('lib/notification/adapter/telegram.md'),
|
||||||
description: 'Fredy will send new listings to your mobile, using Telegram.',
|
description: 'Fredy will send new listings to your mobile, using Telegram.',
|
||||||
|
|||||||
@@ -1,24 +1,24 @@
|
|||||||
const fs = require('fs');
|
import fs from 'fs';
|
||||||
const path = './adapter';
|
const path = './adapter';
|
||||||
|
|
||||||
/** Read every integration existing in ./adapter **/
|
/** Read every integration existing in ./adapter **/
|
||||||
const adapter = fs
|
const adapter = await Promise.all(
|
||||||
.readdirSync('./lib/notification/adapter')
|
fs
|
||||||
.filter((file) => file.endsWith('.js'))
|
.readdirSync('./lib/notification/adapter')
|
||||||
.map((integPath) => require(`${path}/${integPath}`));
|
.filter((file) => file.endsWith('.js'))
|
||||||
|
.map(async (integPath) => await import(`${path}/${integPath}`))
|
||||||
|
);
|
||||||
|
|
||||||
if (adapter.length === 0) {
|
if (adapter.length === 0) {
|
||||||
throw new Error('Please specify at least one notification provider');
|
throw new Error('Please specify at least one notification provider');
|
||||||
}
|
}
|
||||||
|
const findAdapter = (notificationAdapter) => {
|
||||||
exports.send = (serviceName, newListings, notificationConfig, jobKey) => {
|
return adapter.find((a) => a.config.id === notificationAdapter.id);
|
||||||
|
};
|
||||||
|
export const send = (serviceName, newListings, notificationConfig, jobKey) => {
|
||||||
//this is not being used in tests, therefore adapter are always set
|
//this is not being used in tests, therefore adapter are always set
|
||||||
return notificationConfig
|
return notificationConfig
|
||||||
.filter((notificationAdapter) => findAdapter(notificationAdapter) != null)
|
.filter((notificationAdapter) => findAdapter(notificationAdapter) != null)
|
||||||
.map((notificationAdapter) => findAdapter(notificationAdapter))
|
.map((notificationAdapter) => findAdapter(notificationAdapter))
|
||||||
.map((a) => a.send({ serviceName, newListings, notificationConfig, jobKey }));
|
.map((a) => a.send({ serviceName, newListings, notificationConfig, jobKey }));
|
||||||
};
|
};
|
||||||
|
|
||||||
const findAdapter = (notificationAdapter) => {
|
|
||||||
return adapter.find((a) => a.config.id === notificationAdapter.id);
|
|
||||||
};
|
|
||||||
|
|||||||
@@ -1,27 +1,22 @@
|
|||||||
const utils = require('../utils');
|
import utils from '../utils.js';
|
||||||
|
|
||||||
let appliedBlackList = [];
|
let appliedBlackList = [];
|
||||||
|
|
||||||
function normalize(o) {
|
function normalize(o) {
|
||||||
let size = `${o.size.replace(' Wohnfläche ', '').trim()}`;
|
let size = `${o.size.replace(' Wohnfläche ', '').trim()}`;
|
||||||
if (o.rooms != null) {
|
if (o.rooms != null) {
|
||||||
size += ` / / ${o.rooms.trim()}`;
|
size += ` / / ${o.rooms.trim()}`;
|
||||||
}
|
}
|
||||||
const link = `https://www.1a-immobilienmarkt.de/expose/${o.id}.html`;
|
const link = `https://www.1a-immobilienmarkt.de/expose/${o.id}.html`;
|
||||||
|
|
||||||
return Object.assign(o, { size, link });
|
return Object.assign(o, { size, link });
|
||||||
}
|
}
|
||||||
|
|
||||||
function applyBlacklist(o) {
|
function applyBlacklist(o) {
|
||||||
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
||||||
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
||||||
|
|
||||||
return titleNotBlacklisted && descNotBlacklisted;
|
return titleNotBlacklisted && descNotBlacklisted;
|
||||||
}
|
}
|
||||||
|
|
||||||
const config = {
|
const config = {
|
||||||
url: null,
|
url: null,
|
||||||
crawlContainer: '.tabelle',
|
crawlContainer: '.tabelle',
|
||||||
|
sortByDateParam: 'sort_type=newest',
|
||||||
crawlFields: {
|
crawlFields: {
|
||||||
id: '.inner_object_data input[name="marker_objekt_id"]@value | int',
|
id: '.inner_object_data input[name="marker_objekt_id"]@value | int',
|
||||||
price: '.tabelle .inner_object_data .single_data_price | removeNewline | trim',
|
price: '.tabelle .inner_object_data .single_data_price | removeNewline | trim',
|
||||||
@@ -33,17 +28,14 @@ const config = {
|
|||||||
normalize: normalize,
|
normalize: normalize,
|
||||||
filter: applyBlacklist,
|
filter: applyBlacklist,
|
||||||
};
|
};
|
||||||
|
export const init = (sourceConfig, blacklist) => {
|
||||||
exports.init = (sourceConfig, blacklist) => {
|
|
||||||
config.enabled = sourceConfig.enabled;
|
config.enabled = sourceConfig.enabled;
|
||||||
config.url = sourceConfig.url;
|
config.url = sourceConfig.url;
|
||||||
appliedBlackList = blacklist || [];
|
appliedBlackList = blacklist || [];
|
||||||
};
|
};
|
||||||
|
export const metaInformation = {
|
||||||
exports.metaInformation = {
|
|
||||||
name: '1a Immobilien',
|
name: '1a Immobilien',
|
||||||
baseUrl: 'https://www.1a-immobilienmarkt.de/',
|
baseUrl: 'https://www.1a-immobilienmarkt.de/',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
id: 'einsAImmobilien',
|
||||||
};
|
};
|
||||||
|
export { config };
|
||||||
exports.config = config;
|
|
||||||
|
|||||||
49
lib/provider/immobilienDe.js
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
import utils from '../utils.js';
|
||||||
|
let appliedBlackList = [];
|
||||||
|
function shortenLink(link) {
|
||||||
|
return link.substring(0, link.indexOf('?'));
|
||||||
|
}
|
||||||
|
function parseId(shortenedLink) {
|
||||||
|
return shortenedLink.substring(shortenedLink.lastIndexOf('/') + 1);
|
||||||
|
}
|
||||||
|
function normalize(o) {
|
||||||
|
const id = parseId(shortenLink(o.link));
|
||||||
|
const size = o.size || 'N/A m²';
|
||||||
|
const price = o.price || 'N/A €';
|
||||||
|
const title = o.title || 'No title available';
|
||||||
|
const address = o.address || 'No address available';
|
||||||
|
const link = shortenLink(o.link);
|
||||||
|
return Object.assign(o, { id, price, size, title, address, link });
|
||||||
|
}
|
||||||
|
function applyBlacklist(o) {
|
||||||
|
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
||||||
|
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
||||||
|
return titleNotBlacklisted && descNotBlacklisted;
|
||||||
|
}
|
||||||
|
const config = {
|
||||||
|
url: null,
|
||||||
|
crawlContainer: '.estates_list .list_immo a._ref',
|
||||||
|
sortByDateParam: 'sort_col=*created_ts&sort_dir=desc',
|
||||||
|
crawlFields: {
|
||||||
|
price: '.list_entry .immo_preis .label_info',
|
||||||
|
size: '.list_entry .flaeche .label_info | removeNewline | trim',
|
||||||
|
title: '.list_entry .part_text h3 span',
|
||||||
|
description: '.list_entry .description | trim',
|
||||||
|
link: '@href',
|
||||||
|
address: '.list_entry .place',
|
||||||
|
},
|
||||||
|
paginate: '.list_immo .blocknav .blocknav_list li.next a@href',
|
||||||
|
normalize: normalize,
|
||||||
|
filter: applyBlacklist,
|
||||||
|
};
|
||||||
|
export const init = (sourceConfig, blacklist) => {
|
||||||
|
config.enabled = sourceConfig.enabled;
|
||||||
|
config.url = sourceConfig.url;
|
||||||
|
appliedBlackList = blacklist || [];
|
||||||
|
};
|
||||||
|
export const metaInformation = {
|
||||||
|
name: 'Immobilien.de',
|
||||||
|
baseUrl: 'https://www.immobilien.de/',
|
||||||
|
id: 'immobilienDe',
|
||||||
|
};
|
||||||
|
export { config };
|
||||||
@@ -1,51 +1,42 @@
|
|||||||
const utils = require('../utils');
|
import utils from '../utils.js';
|
||||||
|
|
||||||
let appliedBlackList = [];
|
let appliedBlackList = [];
|
||||||
|
|
||||||
function normalize(o) {
|
function normalize(o) {
|
||||||
const id = parseInt(o.id.substring(o.id.indexOf('_') + 1, o.id.length));
|
const id = o.id.substring(o.id.lastIndexOf('/') + 1, o.id.length);
|
||||||
const size = o.size != null ? o.size.replace('Wohnfläche ', '') : 'N/A m²';
|
const size = o.size != null ? o.size.replace('Wohnfläche ', '') : 'N/A m²';
|
||||||
const price = o.price.replace('Kaufpreis ', '');
|
const price = o.price.replace('Kaufpreis ', '');
|
||||||
const address = o.address.split(' • ')[1];
|
const address = o.address.split(' • ')[o.address.split(' • ').length - 1];
|
||||||
const title = o.title || 'No title available';
|
const title = o.title || 'No title available';
|
||||||
//normally we would just read the link from the source, but immonet decided to trick user by adding a click listener instead of
|
const link = o.id;
|
||||||
//a href to do some weird reporting. (Very user friendly for handicaped ppl... not)
|
|
||||||
const link = `https://www.immonet.de/angebot/${id}`;
|
|
||||||
return Object.assign(o, { id, address, price, size, title, link });
|
return Object.assign(o, { id, address, price, size, title, link });
|
||||||
}
|
}
|
||||||
|
|
||||||
function applyBlacklist(o) {
|
function applyBlacklist(o) {
|
||||||
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
||||||
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
||||||
|
|
||||||
return titleNotBlacklisted && descNotBlacklisted;
|
return titleNotBlacklisted && descNotBlacklisted;
|
||||||
}
|
}
|
||||||
|
|
||||||
const config = {
|
const config = {
|
||||||
url: null,
|
url: null,
|
||||||
crawlContainer: '#result-list-stage .item',
|
crawlContainer: '.content-wrapper-tiles .ng-star-inserted',
|
||||||
|
sortByDateParam: 'sortby=19',
|
||||||
crawlFields: {
|
crawlFields: {
|
||||||
id: '@id',
|
id: '.card a@href',
|
||||||
price: 'div[id*="selPrice_"] | trim',
|
title: '.card h3 |trim',
|
||||||
size: 'div[id*="selArea_"] | trim',
|
price: '.card .has-font-300 .is-bold | trim',
|
||||||
title: '.item a img@title',
|
size: '.card .has-font-300 .ml-100 | trim',
|
||||||
address: '.item .box-25 .ellipsis .text-100 | removeNewline | trim',
|
address: '.card span:nth-child(2) | trim',
|
||||||
},
|
},
|
||||||
paginate: '#idResultList .margin-bottom-6.margin-bottom-sm-12 .panel a.pull-right@href',
|
paginate: '#idResultList .margin-bottom-6.margin-bottom-sm-12 .panel a.pull-right@href',
|
||||||
normalize: normalize,
|
normalize: normalize,
|
||||||
filter: applyBlacklist,
|
filter: applyBlacklist,
|
||||||
};
|
};
|
||||||
|
export const init = (sourceConfig, blacklist) => {
|
||||||
exports.init = (sourceConfig, blacklist) => {
|
|
||||||
config.enabled = sourceConfig.enabled;
|
config.enabled = sourceConfig.enabled;
|
||||||
config.url = sourceConfig.url;
|
config.url = sourceConfig.url;
|
||||||
appliedBlackList = blacklist || [];
|
appliedBlackList = blacklist || [];
|
||||||
};
|
};
|
||||||
|
export const metaInformation = {
|
||||||
exports.metaInformation = {
|
|
||||||
name: 'Immonet',
|
name: 'Immonet',
|
||||||
baseUrl: 'https://www.immonet.de/',
|
baseUrl: 'https://www.immonet.de/',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
id: 'immonet',
|
||||||
};
|
};
|
||||||
|
export { config };
|
||||||
exports.config = config;
|
|
||||||
|
|||||||
@@ -1,25 +1,21 @@
|
|||||||
const utils = require('../utils');
|
import utils from '../utils.js';
|
||||||
|
|
||||||
let appliedBlackList = [];
|
let appliedBlackList = [];
|
||||||
|
|
||||||
function nullOrEmpty(val) {
|
function nullOrEmpty(val) {
|
||||||
return val == null || val.length === 0;
|
return val == null || val.length === 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
function normalize(o) {
|
function normalize(o) {
|
||||||
const title = nullOrEmpty(o.title) ? 'NO TITLE FOUND' : o.title.replace('NEU', '');
|
const title = nullOrEmpty(o.title) ? 'NO TITLE FOUND' : o.title.replace('NEU', '');
|
||||||
const address = nullOrEmpty(o.address) ? 'NO ADDRESS FOUND' : (o.address || '').replace(/\(.*\),.*$/, '').trim();
|
const address = nullOrEmpty(o.address) ? 'NO ADDRESS FOUND' : (o.address || '').replace(/\(.*\),.*$/, '').trim();
|
||||||
const link = `https://www.immobilienscout24.de${o.link.substring(o.link.indexOf('/expose'))}`;
|
const link = `https://www.immobilienscout24.de${o.link.substring(o.link.indexOf('/expose'))}`;
|
||||||
return Object.assign(o, { title, address, link });
|
return Object.assign(o, { title, address, link });
|
||||||
}
|
}
|
||||||
|
|
||||||
function applyBlacklist(o) {
|
function applyBlacklist(o) {
|
||||||
return !utils.isOneOf(o.title, appliedBlackList);
|
return !utils.isOneOf(o.title, appliedBlackList);
|
||||||
}
|
}
|
||||||
|
|
||||||
const config = {
|
const config = {
|
||||||
url: null,
|
url: null,
|
||||||
crawlContainer: '#resultListItems li.result-list__listing',
|
crawlContainer: '#resultListItems li.result-list__listing',
|
||||||
|
sortByDateParam: 'sorting=2',
|
||||||
crawlFields: {
|
crawlFields: {
|
||||||
id: '.result-list-entry@data-obid | int',
|
id: '.result-list-entry@data-obid | int',
|
||||||
price: '.result-list-entry .result-list-entry__criteria .grid-item:first-child dd | removeNewline | trim',
|
price: '.result-list-entry .result-list-entry__criteria .grid-item:first-child dd | removeNewline | trim',
|
||||||
@@ -32,17 +28,14 @@ const config = {
|
|||||||
normalize: normalize,
|
normalize: normalize,
|
||||||
filter: applyBlacklist,
|
filter: applyBlacklist,
|
||||||
};
|
};
|
||||||
|
export const init = (sourceConfig, blacklist) => {
|
||||||
exports.init = (sourceConfig, blacklist) => {
|
|
||||||
config.enabled = sourceConfig.enabled;
|
config.enabled = sourceConfig.enabled;
|
||||||
config.url = sourceConfig.url;
|
config.url = sourceConfig.url;
|
||||||
appliedBlackList = blacklist || [];
|
appliedBlackList = blacklist || [];
|
||||||
};
|
};
|
||||||
|
export const metaInformation = {
|
||||||
exports.metaInformation = {
|
|
||||||
name: 'Immoscout',
|
name: 'Immoscout',
|
||||||
baseUrl: 'https://www.immobilienscout24.de/',
|
baseUrl: 'https://www.immobilienscout24.de/',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
id: 'immoscout',
|
||||||
};
|
};
|
||||||
|
export { config };
|
||||||
exports.config = config;
|
|
||||||
|
|||||||
44
lib/provider/immoswp.js
Executable file
@@ -0,0 +1,44 @@
|
|||||||
|
import utils from '../utils.js';
|
||||||
|
let appliedBlackList = [];
|
||||||
|
function normalize(o) {
|
||||||
|
const id = o.id.substring(o.id.indexOf('-') + 1, o.id.length);
|
||||||
|
const size = o.size || 'N/A m²';
|
||||||
|
const price = (o.price || '--- €').replace('Preis auf Anfrage', '--- €');
|
||||||
|
const address = o.address || 'No address available';
|
||||||
|
const title = o.title || 'No title available';
|
||||||
|
const link = `https://immo.swp.de/immobilien/${id}`;
|
||||||
|
const description = o.description;
|
||||||
|
return Object.assign(o, { id, address, price, size, title, link, description });
|
||||||
|
}
|
||||||
|
function applyBlacklist(o) {
|
||||||
|
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
||||||
|
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
||||||
|
return titleNotBlacklisted && descNotBlacklisted;
|
||||||
|
}
|
||||||
|
const config = {
|
||||||
|
url: null,
|
||||||
|
crawlContainer: '.js-serp-item',
|
||||||
|
sortByDateParam: 's=most_recently_updated_first',
|
||||||
|
crawlFields: {
|
||||||
|
id: '@id',
|
||||||
|
price: 'div.item__spec.item-spec-price | trim',
|
||||||
|
size: 'div.item__spec.item-spec-area | trim',
|
||||||
|
title: 'a.js-item-title-link@title',
|
||||||
|
address: 'div.item__locality | removeNewline | trim',
|
||||||
|
description: 'div.item__main-info-points.clearfix p small | removeNewline | trim',
|
||||||
|
},
|
||||||
|
paginate: 'li.page-item.pagination__item a.page-link@href',
|
||||||
|
normalize: normalize,
|
||||||
|
filter: applyBlacklist,
|
||||||
|
};
|
||||||
|
export const init = (sourceConfig, blacklist) => {
|
||||||
|
config.enabled = sourceConfig.enabled;
|
||||||
|
config.url = sourceConfig.url;
|
||||||
|
appliedBlackList = blacklist || [];
|
||||||
|
};
|
||||||
|
export const metaInformation = {
|
||||||
|
name: 'Immo Südwest Presse',
|
||||||
|
baseUrl: 'https://immo.swp.de/',
|
||||||
|
id: 'immoswp',
|
||||||
|
};
|
||||||
|
export { config };
|
||||||
@@ -1,21 +1,17 @@
|
|||||||
const utils = require('../utils');
|
import utils from '../utils.js';
|
||||||
|
|
||||||
let appliedBlackList = [];
|
let appliedBlackList = [];
|
||||||
|
|
||||||
function normalize(o) {
|
function normalize(o) {
|
||||||
return o;
|
return o;
|
||||||
}
|
}
|
||||||
|
|
||||||
function applyBlacklist(o) {
|
function applyBlacklist(o) {
|
||||||
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
||||||
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
||||||
|
|
||||||
return titleNotBlacklisted && descNotBlacklisted;
|
return titleNotBlacklisted && descNotBlacklisted;
|
||||||
}
|
}
|
||||||
|
|
||||||
const config = {
|
const config = {
|
||||||
url: null,
|
url: null,
|
||||||
crawlContainer: "div[class^='EstateItem-']",
|
crawlContainer: "div[class^='EstateItem-']",
|
||||||
|
sortByDateParam: 'sd=DESC&sf=TIMESTAMP',
|
||||||
crawlFields: {
|
crawlFields: {
|
||||||
id: 'a@id',
|
id: 'a@id',
|
||||||
price: "div[class^='KeyFacts-'] [data-test='price'] | removeNewline | trim",
|
price: "div[class^='KeyFacts-'] [data-test='price'] | removeNewline | trim",
|
||||||
@@ -28,16 +24,14 @@ const config = {
|
|||||||
normalize: normalize,
|
normalize: normalize,
|
||||||
filter: applyBlacklist,
|
filter: applyBlacklist,
|
||||||
};
|
};
|
||||||
|
export const init = (sourceConfig, blacklist) => {
|
||||||
exports.init = (sourceConfig, blacklist) => {
|
|
||||||
config.enabled = sourceConfig.enabled;
|
config.enabled = sourceConfig.enabled;
|
||||||
config.url = sourceConfig.url;
|
config.url = sourceConfig.url;
|
||||||
appliedBlackList = blacklist || [];
|
appliedBlackList = blacklist || [];
|
||||||
};
|
};
|
||||||
exports.metaInformation = {
|
export const metaInformation = {
|
||||||
name: 'Immowelt',
|
name: 'Immowelt',
|
||||||
baseUrl: 'https://www.immowelt.de/',
|
baseUrl: 'https://www.immowelt.de/',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
id: 'immowelt',
|
||||||
};
|
};
|
||||||
|
export { config };
|
||||||
exports.config = config;
|
|
||||||
|
|||||||
@@ -1,26 +1,22 @@
|
|||||||
const utils = require('../utils');
|
import utils from '../utils.js';
|
||||||
|
|
||||||
let appliedBlackList = [];
|
let appliedBlackList = [];
|
||||||
let appliedBlacklistedDistricts = [];
|
let appliedBlacklistedDistricts = [];
|
||||||
|
|
||||||
function normalize(o) {
|
function normalize(o) {
|
||||||
const size = o.size || '--- m²';
|
const size = o.size || '--- m²';
|
||||||
|
|
||||||
return Object.assign(o, { size });
|
return Object.assign(o, { size });
|
||||||
}
|
}
|
||||||
|
|
||||||
function applyBlacklist(o) {
|
function applyBlacklist(o) {
|
||||||
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
||||||
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
||||||
const isBlacklistedDistrict =
|
const isBlacklistedDistrict =
|
||||||
appliedBlacklistedDistricts.length === 0 ? false : utils.isOneOf(o.description, appliedBlacklistedDistricts);
|
appliedBlacklistedDistricts.length === 0 ? false : utils.isOneOf(o.description, appliedBlacklistedDistricts);
|
||||||
|
|
||||||
return !isBlacklistedDistrict && titleNotBlacklisted && descNotBlacklisted;
|
return !isBlacklistedDistrict && titleNotBlacklisted && descNotBlacklisted;
|
||||||
}
|
}
|
||||||
|
|
||||||
const config = {
|
const config = {
|
||||||
url: null,
|
url: null,
|
||||||
crawlContainer: '#srchrslt-adtable .ad-listitem ',
|
crawlContainer: '#srchrslt-adtable .ad-listitem ',
|
||||||
|
//sort by date is standard oO
|
||||||
|
sortByDateParam: null,
|
||||||
crawlFields: {
|
crawlFields: {
|
||||||
id: '.aditem@data-adid | int',
|
id: '.aditem@data-adid | int',
|
||||||
price: '.aditem-main--middle--price | removeNewline | trim',
|
price: '.aditem-main--middle--price | removeNewline | trim',
|
||||||
@@ -34,18 +30,15 @@ const config = {
|
|||||||
normalize: normalize,
|
normalize: normalize,
|
||||||
filter: applyBlacklist,
|
filter: applyBlacklist,
|
||||||
};
|
};
|
||||||
|
export const metaInformation = {
|
||||||
exports.metaInformation = {
|
|
||||||
name: 'Ebay Kleinanzeigen',
|
name: 'Ebay Kleinanzeigen',
|
||||||
baseUrl: 'https://www.ebay-kleinanzeigen.de/',
|
baseUrl: 'https://www.kleinanzeigen.de/',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
id: 'kleinanzeigen',
|
||||||
};
|
};
|
||||||
|
export const init = (sourceConfig, blacklist, blacklistedDistricts) => {
|
||||||
exports.init = (sourceConfig, blacklist, blacklistedDistricts) => {
|
|
||||||
config.enabled = sourceConfig.enabled;
|
config.enabled = sourceConfig.enabled;
|
||||||
config.url = sourceConfig.url;
|
config.url = sourceConfig.url;
|
||||||
appliedBlacklistedDistricts = blacklistedDistricts || [];
|
appliedBlacklistedDistricts = blacklistedDistricts || [];
|
||||||
appliedBlackList = blacklist || [];
|
appliedBlackList = blacklist || [];
|
||||||
};
|
};
|
||||||
|
export { config };
|
||||||
exports.config = config;
|
|
||||||
|
|||||||
@@ -1,18 +1,15 @@
|
|||||||
const utils = require('../utils');
|
import utils from '../utils.js';
|
||||||
|
|
||||||
let appliedBlackList = [];
|
let appliedBlackList = [];
|
||||||
|
|
||||||
function normalize(o) {
|
function normalize(o) {
|
||||||
return o;
|
return o;
|
||||||
}
|
}
|
||||||
|
|
||||||
function applyBlacklist(o) {
|
function applyBlacklist(o) {
|
||||||
return !utils.isOneOf(o.title, appliedBlackList);
|
return !utils.isOneOf(o.title, appliedBlackList);
|
||||||
}
|
}
|
||||||
|
|
||||||
const config = {
|
const config = {
|
||||||
url: null,
|
url: null,
|
||||||
crawlContainer: '.nbk-container >div article',
|
crawlContainer: '.nbk-container >div article',
|
||||||
|
sortByDateParam: 'Sortierung=Id&Richtung=DESC',
|
||||||
crawlFields: {
|
crawlFields: {
|
||||||
id: '@id',
|
id: '@id',
|
||||||
title: 'a.nbk-truncate@title | removeNewline | trim',
|
title: 'a.nbk-truncate@title | removeNewline | trim',
|
||||||
@@ -24,17 +21,14 @@ const config = {
|
|||||||
normalize: normalize,
|
normalize: normalize,
|
||||||
filter: applyBlacklist,
|
filter: applyBlacklist,
|
||||||
};
|
};
|
||||||
|
export const init = (sourceConfig, blacklist) => {
|
||||||
exports.init = (sourceConfig, blacklist) => {
|
|
||||||
config.enabled = sourceConfig.enabled;
|
config.enabled = sourceConfig.enabled;
|
||||||
config.url = sourceConfig.url;
|
config.url = sourceConfig.url;
|
||||||
appliedBlackList = blacklist || [];
|
appliedBlackList = blacklist || [];
|
||||||
};
|
};
|
||||||
|
export const metaInformation = {
|
||||||
exports.metaInformation = {
|
|
||||||
name: 'Neubau Kompass',
|
name: 'Neubau Kompass',
|
||||||
baseUrl: 'https://www.neubaukompass.de/',
|
baseUrl: 'https://www.neubaukompass.de/',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
id: 'neubauKompass',
|
||||||
};
|
};
|
||||||
|
export { config };
|
||||||
exports.config = config;
|
|
||||||
|
|||||||
@@ -1,21 +1,17 @@
|
|||||||
const utils = require('../utils');
|
import utils from '../utils.js';
|
||||||
|
|
||||||
let appliedBlackList = [];
|
let appliedBlackList = [];
|
||||||
|
|
||||||
function normalize(o) {
|
function normalize(o) {
|
||||||
return o;
|
return o;
|
||||||
}
|
}
|
||||||
|
|
||||||
function applyBlacklist(o) {
|
function applyBlacklist(o) {
|
||||||
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
|
||||||
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
|
||||||
|
|
||||||
return o.id != null && titleNotBlacklisted && descNotBlacklisted;
|
return o.id != null && titleNotBlacklisted && descNotBlacklisted;
|
||||||
}
|
}
|
||||||
|
|
||||||
const config = {
|
const config = {
|
||||||
url: null,
|
url: null,
|
||||||
crawlContainer: '#main_column .wgg_card',
|
crawlContainer: '#main_column .wgg_card',
|
||||||
|
sortByDateParam: 'sort_column=0&sort_order=0',
|
||||||
crawlFields: {
|
crawlFields: {
|
||||||
id: '@data-id',
|
id: '@data-id',
|
||||||
details: '.row .noprint .col-xs-11 |removeNewline |trim',
|
details: '.row .noprint .col-xs-11 |removeNewline |trim',
|
||||||
@@ -27,17 +23,14 @@ const config = {
|
|||||||
normalize: normalize,
|
normalize: normalize,
|
||||||
filter: applyBlacklist,
|
filter: applyBlacklist,
|
||||||
};
|
};
|
||||||
|
export const init = (sourceConfig, blacklist) => {
|
||||||
exports.init = (sourceConfig, blacklist) => {
|
|
||||||
config.enabled = sourceConfig.enabled;
|
config.enabled = sourceConfig.enabled;
|
||||||
config.url = sourceConfig.url;
|
config.url = sourceConfig.url;
|
||||||
appliedBlackList = blacklist || [];
|
appliedBlackList = blacklist || [];
|
||||||
};
|
};
|
||||||
|
export const metaInformation = {
|
||||||
exports.metaInformation = {
|
|
||||||
name: 'Wg gesucht',
|
name: 'Wg gesucht',
|
||||||
baseUrl: 'https://www.wg-gesucht.de/',
|
baseUrl: 'https://www.wg-gesucht.de/',
|
||||||
id: __filename.slice(__dirname.length + 1, -3),
|
id: 'wgGesucht',
|
||||||
};
|
};
|
||||||
|
export { config };
|
||||||
exports.config = config;
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
const markdown = require('markdown').markdown;
|
import markdown$0 from 'markdown';
|
||||||
const fs = require('fs');
|
import fs from 'fs';
|
||||||
|
const markdown = markdown$0.markdown;
|
||||||
exports.markdown2Html = function markdown2Html(filePath) {
|
export function markdown2Html(filePath) {
|
||||||
return markdown.toHTML(fs.readFileSync(filePath, 'utf8'));
|
return markdown.toHTML(fs.readFileSync(filePath, 'utf8'));
|
||||||
};
|
}
|
||||||
|
|||||||
10
lib/services/queryStringMutator.js
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
import queryString from 'query-string';
|
||||||
|
export default (_url, sortByDateParam) => {
|
||||||
|
//if no mutation is necessary, just return the original url
|
||||||
|
if (sortByDateParam == null) {
|
||||||
|
return _url;
|
||||||
|
}
|
||||||
|
const original = queryString.parseUrl(_url);
|
||||||
|
const mutate = queryString.parse(sortByDateParam);
|
||||||
|
return `${original.url}?${queryString.stringify({ ...original.query, ...mutate })}`;
|
||||||
|
};
|
||||||
@@ -1,37 +1,74 @@
|
|||||||
const axios = require('axios');
|
import fetch from 'node-fetch';
|
||||||
const axiosRetry = require('axios-retry');
|
import { config } from '../utils.js';
|
||||||
|
import { makeUrlResidential } from './scrapingAnt.js';
|
||||||
axiosRetry(axios, { retryDelay: axiosRetry.exponentialDelay, retries: 3 });
|
import https from 'https';
|
||||||
|
//if ScrapingAnt got blocked, this http status is returned
|
||||||
|
const BLOCKED_HTTP_STATUS = 423;
|
||||||
|
const NOT_FOUND_HTTP_STATUS = 404;
|
||||||
|
const MAX_RETRIES_SCRAPING_ANT = 10;
|
||||||
|
const EXPECTED_STATUS_CODES = [BLOCKED_HTTP_STATUS, NOT_FOUND_HTTP_STATUS];
|
||||||
|
const agent = new https.Agent({
|
||||||
|
rejectUnauthorized: false,
|
||||||
|
});
|
||||||
|
|
||||||
function makeDriver(headers = {}) {
|
function makeDriver(headers = {}) {
|
||||||
let cookies = '';
|
let cookies = '';
|
||||||
|
async function scrapingAntDriver(context, callback, retryCounter = 0) {
|
||||||
return async function driver(context, callback) {
|
const proxyType = config.scrapingAnt?.proxy || 'datacenter';
|
||||||
const url = context.url;
|
|
||||||
let result;
|
|
||||||
try {
|
try {
|
||||||
result = await axios({
|
const url = proxyType === 'residential' ? makeUrlResidential(context.url) : context.url;
|
||||||
url,
|
const response = await fetch(url, {
|
||||||
|
headers: {
|
||||||
|
...headers,
|
||||||
|
cookie: cookies,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const result = await response.text();
|
||||||
|
if (cookies.length === 0) {
|
||||||
|
cookies = response.headers.raw()['set-cookie'] || [];
|
||||||
|
}
|
||||||
|
callback(null, result);
|
||||||
|
} catch (exception) {
|
||||||
|
/* eslint-disable no-console */
|
||||||
|
if (!EXPECTED_STATUS_CODES.includes(exception.response?.status)) {
|
||||||
|
console.error(`Error while trying to scrape data from scraping ant. Received error: ${exception.message}`);
|
||||||
|
callback(null, []);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (retryCounter <= MAX_RETRIES_SCRAPING_ANT) {
|
||||||
|
retryCounter++;
|
||||||
|
console.debug(`ScrapingAnt got blocked. Retrying ${retryCounter} / ${MAX_RETRIES_SCRAPING_ANT}`);
|
||||||
|
await scrapingAntDriver(context, callback, retryCounter);
|
||||||
|
} else {
|
||||||
|
console.error(`Error while trying to scrape data from scraping ant. Received error: ${exception.message}`);
|
||||||
|
callback(null, []);
|
||||||
|
}
|
||||||
|
/* eslint-enable no-console */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The regular request driver is taking care of everyting, that doesn't need to be scraped by ScrapingAnt (which is
|
||||||
|
* everything != Immoscout & Immonet as of writing this)
|
||||||
|
*/
|
||||||
|
return async function driver(context, callback) {
|
||||||
|
if (context.url.toLowerCase().indexOf('scrapingant') !== -1) {
|
||||||
|
return scrapingAntDriver(context, callback);
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const response = await fetch(context.url, {
|
||||||
headers: {
|
headers: {
|
||||||
...headers,
|
...headers,
|
||||||
Cookie: cookies,
|
Cookie: cookies,
|
||||||
},
|
},
|
||||||
|
agent,
|
||||||
});
|
});
|
||||||
|
const result = await response.text();
|
||||||
|
callback(null, result);
|
||||||
} catch (exception) {
|
} catch (exception) {
|
||||||
console.error(`Error while trying to scrape data. Received error: ${exception.message}`);
|
console.error(`Error while trying to scrape data. Received error: ${exception.message}`);
|
||||||
callback(null, []);
|
callback(null, []);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (typeof result.data === 'object' && url.toLowerCase().indexOf('scrapingant') !== -1) {
|
|
||||||
//assume we have gotten a response from scrapingAnt
|
|
||||||
if (cookies.length === 0) {
|
|
||||||
cookies = result.data.cookies;
|
|
||||||
}
|
|
||||||
callback(null, result.data.content);
|
|
||||||
} else {
|
|
||||||
callback(null, result.data);
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
export default makeDriver;
|
||||||
module.exports = makeDriver;
|
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
const config = require('../../conf/config.json');
|
import { config } from '../utils.js';
|
||||||
const makeDriver = require('./requestDriver');
|
import makeDriver from './requestDriver.js';
|
||||||
const Xray = require('x-ray');
|
import Xray from 'x-ray';
|
||||||
|
|
||||||
class Scraper {
|
class Scraper {
|
||||||
constructor() {
|
constructor() {
|
||||||
const filters = {
|
const filters = {
|
||||||
@@ -9,38 +8,29 @@ class Scraper {
|
|||||||
trim: this._trim,
|
trim: this._trim,
|
||||||
int: this._int,
|
int: this._int,
|
||||||
};
|
};
|
||||||
|
|
||||||
const headers = {
|
const headers = {
|
||||||
'User-Agent':
|
'User-Agent':
|
||||||
'Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.85 Safari/537.36',
|
'Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.85 Safari/537.36',
|
||||||
};
|
};
|
||||||
|
|
||||||
if (config.scrapingAnt != null && config.scrapingAnt.apiKey != null) {
|
if (config.scrapingAnt != null && config.scrapingAnt.apiKey != null) {
|
||||||
headers['x-api-key'] = config.scrapingAnt.apiKey;
|
headers['x-api-key'] = config.scrapingAnt.apiKey;
|
||||||
}
|
}
|
||||||
const driver = makeDriver(headers);
|
const driver = makeDriver(headers);
|
||||||
|
|
||||||
const xray = Xray({ filters });
|
const xray = Xray({ filters });
|
||||||
xray.driver(driver);
|
xray.driver(driver);
|
||||||
|
|
||||||
this.xray = xray;
|
this.xray = xray;
|
||||||
}
|
}
|
||||||
|
|
||||||
get x() {
|
get x() {
|
||||||
return this.xray;
|
return this.xray;
|
||||||
}
|
}
|
||||||
|
|
||||||
_removeNewline(value) {
|
_removeNewline(value) {
|
||||||
return typeof value === 'string' ? value.replace(/\\n/g, '') : value;
|
return typeof value === 'string' ? value.replace(/\\n/g, '') : value;
|
||||||
}
|
}
|
||||||
|
|
||||||
_trim(value) {
|
_trim(value) {
|
||||||
return typeof value === 'string' ? value.replace(/\s+/g, ' ').trim() : value;
|
return typeof value === 'string' ? value.replace(/\s+/g, ' ').trim() : value;
|
||||||
}
|
}
|
||||||
|
|
||||||
_int(value) {
|
_int(value) {
|
||||||
return typeof value === 'string' ? parseInt(value, 10) : value;
|
return typeof value === 'string' ? parseInt(value, 10) : value;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
export default new Scraper().x;
|
||||||
module.exports = new Scraper().x;
|
|
||||||
|
|||||||
@@ -1,24 +1,29 @@
|
|||||||
const { metaInformation } = require('../provider/immoscout');
|
import { metaInformation as immoScoutInfo } from '../provider/immoscout.js';
|
||||||
//to better confure re-capture chose a random proxy each time we do a call
|
import { metaInformation as immoNetInfo } from '../provider/immonet.js';
|
||||||
const proxies = ['ae', 'br', 'cn', 'de', 'es', 'fr', 'gb', 'hk', 'in', 'it', 'il', 'jp', 'nl', 'ru', 'sa', 'us', 'cz'];
|
import { config } from '../utils.js';
|
||||||
const config = require('../../conf/config.json');
|
|
||||||
|
|
||||||
const isImmoscout = (id) => {
|
const additionalImmonetUrlParams = `&wait_for_selector=.content-wrapper-tiles&js_snippet=${Buffer.from(
|
||||||
return id.toLowerCase() === metaInformation.id;
|
'window.scrollTo(0,document.body.scrollHeight);'
|
||||||
|
).toString('base64')}`;
|
||||||
|
|
||||||
|
const needScrapingAnt = (id) => {
|
||||||
|
return id.toLowerCase() === immoScoutInfo.id || id.toLowerCase() === immoNetInfo.id;
|
||||||
};
|
};
|
||||||
|
export const transformUrlForScrapingAnt = (url, id) => {
|
||||||
exports.transformUrlForScrapingAnt = (url, id) => {
|
let urlParams = '';
|
||||||
const randomProxy = proxies[Math.floor(Math.random() * proxies.length)];
|
if (needScrapingAnt(id)) {
|
||||||
|
if (id.toLowerCase() === immoNetInfo.id) {
|
||||||
if (isImmoscout(id)) {
|
urlParams = additionalImmonetUrlParams;
|
||||||
//only do calls to scrapingAnt when dealing with Immoscout
|
}
|
||||||
url = `https://api.scrapingant.com/v1/general?url=${encodeURIComponent(url)}&proxy_country=${randomProxy}`;
|
//only do calls to scrapingAnt when dealing with Immoscout/Immonet
|
||||||
|
url = `https://api.scrapingant.com/v2/general?url=${encodeURIComponent(url)}&proxy_type=datacenter${urlParams}`;
|
||||||
}
|
}
|
||||||
return url;
|
return url;
|
||||||
};
|
};
|
||||||
|
export const isScrapingAntApiKeySet = () => {
|
||||||
exports.isScrapingAntApiKeySet = () => {
|
|
||||||
return config.scrapingAnt != null && config.scrapingAnt.apiKey != null && config.scrapingAnt.apiKey.length > 0;
|
return config.scrapingAnt != null && config.scrapingAnt.apiKey != null && config.scrapingAnt.apiKey.length > 0;
|
||||||
};
|
};
|
||||||
|
export const makeUrlResidential = (url) => {
|
||||||
exports.isImmoscout = isImmoscout;
|
return url.replace('datacenter', 'residential');
|
||||||
|
};
|
||||||
|
export { needScrapingAnt };
|
||||||
|
|||||||
@@ -1,3 +1,2 @@
|
|||||||
const crypto = require('crypto');
|
import crypto from 'crypto';
|
||||||
|
export const hash = (x) => crypto.createHash('sha256').update(x, 'utf8').digest('hex');
|
||||||
exports.hash = (x) => crypto.createHash('sha256').update(x, 'utf8').digest('hex');
|
|
||||||
|
|||||||
@@ -1,27 +1,17 @@
|
|||||||
const stringSimilarity = require('string-similarity');
|
import stringSimilarity from 'string-similarity';
|
||||||
|
|
||||||
//if the score is higher than this, it will be considered a match
|
//if the score is higher than this, it will be considered a match
|
||||||
const MAX_DICE_INDEX = 0.7;
|
const MAX_DICE_INDEX = 0.7;
|
||||||
|
export default (class SimilarityCacheEntry {
|
||||||
/**
|
|
||||||
* The similarity check is based on the dice coefficient. => https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient
|
|
||||||
*
|
|
||||||
* @type {module.SimilarityCacheEntry}
|
|
||||||
*/
|
|
||||||
module.exports = class SimilarityCacheEntry {
|
|
||||||
constructor(time) {
|
constructor(time) {
|
||||||
this.time = time;
|
this.time = time;
|
||||||
this.values = [];
|
this.values = [];
|
||||||
}
|
}
|
||||||
|
|
||||||
setCacheEntry = (entry) => {
|
setCacheEntry = (entry) => {
|
||||||
this.values.push(entry);
|
this.values.push(entry);
|
||||||
};
|
};
|
||||||
|
|
||||||
getTime = () => {
|
getTime = () => {
|
||||||
return this.time;
|
return this.time;
|
||||||
};
|
};
|
||||||
|
|
||||||
hasSimilarEntries = (value) => {
|
hasSimilarEntries = (value) => {
|
||||||
if (this.values.length > 0) {
|
if (this.values.length > 0) {
|
||||||
for (let i = 0; i < this.values.length; i++) {
|
for (let i = 0; i < this.values.length; i++) {
|
||||||
@@ -33,4 +23,4 @@ module.exports = class SimilarityCacheEntry {
|
|||||||
}
|
}
|
||||||
return false;
|
return false;
|
||||||
};
|
};
|
||||||
};
|
});
|
||||||
|
|||||||
@@ -1,63 +1,40 @@
|
|||||||
/**
|
import SimilarityCacheEntry from './SimilarityCacheEntry.js';
|
||||||
* each job that runs scrapes all provider. This cache holds the titles of the found listing(s) and provides
|
import { config } from '../../utils.js';
|
||||||
* a similarity check. if this check returns true, it will not be forwarded to the notification adapter, thus
|
|
||||||
* the user won't see any duplicates
|
|
||||||
*
|
|
||||||
* The retention of this cache is per default 5 minutes, but can be smaller if the interval is > 5 mins.
|
|
||||||
*
|
|
||||||
* @type {module.SimilarityCacheEntry|{}}
|
|
||||||
*/
|
|
||||||
const SimilarityCacheEntry = require('./SimilarityCacheEntry');
|
|
||||||
const config = require('../../../conf/config.json');
|
|
||||||
|
|
||||||
//5 minutes
|
//5 minutes
|
||||||
let retention = 5 * 60 * 1000;
|
let retention = 5 * 60 * 1000;
|
||||||
|
|
||||||
const intervalInMs = config.interval * 60 * 1000;
|
const intervalInMs = config.interval * 60 * 1000;
|
||||||
//an interval below 5 mins sounds crazy, but there are ppl out there doing crazy shit.
|
//an interval below 5 mins sounds crazy, but there are ppl out there doing crazy shit.
|
||||||
if (intervalInMs <= retention) {
|
if (intervalInMs <= retention) {
|
||||||
retention = Math.floor(intervalInMs / 2);
|
retention = Math.floor(intervalInMs / 2);
|
||||||
}
|
}
|
||||||
|
|
||||||
//jobid -> SimilarityCacheEntry
|
//jobid -> SimilarityCacheEntry
|
||||||
const cache = {};
|
const cache = {};
|
||||||
|
|
||||||
let intervalId;
|
let intervalId;
|
||||||
|
|
||||||
exports.addCacheEntry = (jobId, value) => {
|
|
||||||
cache[jobId] = cache[jobId] || new SimilarityCacheEntry(Date.now());
|
|
||||||
cache[jobId].setCacheEntry(value);
|
|
||||||
};
|
|
||||||
|
|
||||||
exports.hasSimilarEntries = (jobId, value) => {
|
|
||||||
if (cache[jobId] == null) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
return cache[jobId].hasSimilarEntries(value);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* cleanup
|
* cleanup
|
||||||
*/
|
*/
|
||||||
intervalId = setInterval(() => {
|
intervalId = setInterval(() => {
|
||||||
const keysToBeRemoved = [];
|
const keysToBeRemoved = [];
|
||||||
const now = Date.now();
|
const now = Date.now();
|
||||||
|
|
||||||
Object.keys(cache).forEach((key) => {
|
Object.keys(cache).forEach((key) => {
|
||||||
if (cache[key].getTime() + retention < now) {
|
if (cache[key].getTime() + retention < now) {
|
||||||
keysToBeRemoved.push(key);
|
keysToBeRemoved.push(key);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
if (keysToBeRemoved.length > 0) {
|
if (keysToBeRemoved.length > 0) {
|
||||||
keysToBeRemoved.forEach((key) => delete cache[key]);
|
keysToBeRemoved.forEach((key) => delete cache[key]);
|
||||||
}
|
}
|
||||||
}, 10000);
|
}, 10000);
|
||||||
|
export const addCacheEntry = (jobId, value) => {
|
||||||
/**
|
cache[jobId] = cache[jobId] || new SimilarityCacheEntry(Date.now());
|
||||||
* mostly used for tests
|
cache[jobId].setCacheEntry(value);
|
||||||
*/
|
};
|
||||||
exports.stopCacheCleanup = () => {
|
export const hasSimilarEntries = (jobId, value) => {
|
||||||
|
if (cache[jobId] == null) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return cache[jobId].hasSimilarEntries(value);
|
||||||
|
};
|
||||||
|
export const stopCacheCleanup = () => {
|
||||||
clearInterval(intervalId);
|
clearInterval(intervalId);
|
||||||
};
|
};
|
||||||
|
|||||||
8
lib/services/storage/LowDashAdapter.js
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
import lodash from 'lodash';
|
||||||
|
import { LowSync } from 'lowdb';
|
||||||
|
export default class LowdashAdapter extends LowSync {
|
||||||
|
constructor(adapter, defaultData = {}) {
|
||||||
|
super(adapter, defaultData);
|
||||||
|
this.chain = lodash.chain(this).get('data');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,28 +1,29 @@
|
|||||||
const path = require('path');
|
import { JSONFileSync } from 'lowdb/node';
|
||||||
const DB_PATH = path.dirname(require.main.filename) + '/db/jobs.json';
|
import { nanoid } from 'nanoid';
|
||||||
const FileSync = require('lowdb/adapters/FileSync');
|
import * as listingStorage from './listingsStorage.js';
|
||||||
const adapter = new FileSync(DB_PATH);
|
import { getDirName } from '../../utils.js';
|
||||||
const low = require('lowdb');
|
import path from 'path';
|
||||||
const db = low(adapter);
|
import LowdashAdapter from './LowDashAdapter.js';
|
||||||
const { nanoid } = require('nanoid');
|
|
||||||
const listingStorage = require('./listingsStorage');
|
|
||||||
|
|
||||||
db.defaults({ jobs: [] }).write();
|
const file = path.join(getDirName(), '../', 'db/jobs.json');
|
||||||
|
const adapter = new JSONFileSync(file);
|
||||||
|
const db = new LowdashAdapter(adapter, { jobs: [] });
|
||||||
|
|
||||||
exports.upsertJob = ({ jobId, name, blacklist = [], enabled = true, provider, notificationAdapter, userId }) => {
|
db.read();
|
||||||
|
|
||||||
|
|
||||||
|
export const upsertJob = ({ jobId, name, blacklist = [], enabled = true, provider, notificationAdapter, userId }) => {
|
||||||
const currentJob =
|
const currentJob =
|
||||||
jobId == null
|
jobId == null
|
||||||
? null
|
? null
|
||||||
: db
|
: db.chain
|
||||||
.get('jobs')
|
.get('jobs')
|
||||||
.find((job) => job.id === jobId)
|
.find((job) => job.id === jobId)
|
||||||
.value();
|
.value();
|
||||||
|
const jobs = db.chain
|
||||||
const jobs = db
|
|
||||||
.get('jobs')
|
.get('jobs')
|
||||||
.value()
|
.filter((job) => job.id !== jobId)
|
||||||
.filter((job) => job.id !== jobId);
|
.value();
|
||||||
|
|
||||||
jobs.push({
|
jobs.push({
|
||||||
id: jobId || nanoid(),
|
id: jobId || nanoid(),
|
||||||
//make sure to not overwrite the user id in case an admin changes the job
|
//make sure to not overwrite the user id in case an admin changes the job
|
||||||
@@ -33,57 +34,55 @@ exports.upsertJob = ({ jobId, name, blacklist = [], enabled = true, provider, no
|
|||||||
provider,
|
provider,
|
||||||
notificationAdapter,
|
notificationAdapter,
|
||||||
});
|
});
|
||||||
|
db.chain.set('jobs', jobs).value();
|
||||||
db.set('jobs', jobs).write();
|
db.write();
|
||||||
};
|
};
|
||||||
|
export const getJob = (jobId) => {
|
||||||
exports.getJob = (jobId) => {
|
const job = db.chain
|
||||||
const job = db
|
|
||||||
.get('jobs')
|
.get('jobs')
|
||||||
.find((job) => job.id === jobId)
|
.find((job) => job.id === jobId)
|
||||||
.value();
|
.value();
|
||||||
|
|
||||||
if (job == null) {
|
if (job == null) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
...job,
|
...job,
|
||||||
numberOfFoundListings: listingStorage.getNumberOfAllKnownListings(job.id).length,
|
numberOfFoundListings: listingStorage.getNumberOfAllKnownListings(job.id).length,
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
export const setJobStatus = ({ jobId, status }) => {
|
||||||
exports.setJobStatus = ({ jobId, status }) => {
|
db.chain
|
||||||
db.get('jobs')
|
.get('jobs')
|
||||||
.find((job) => job.id === jobId)
|
.find((job) => job.id === jobId)
|
||||||
.assign({ enabled: status })
|
.assign({ enabled: status })
|
||||||
.write();
|
.value();
|
||||||
|
db.write();
|
||||||
};
|
};
|
||||||
|
export const removeJob = (jobId) => {
|
||||||
exports.removeJob = (jobId) => {
|
|
||||||
listingStorage.removeListings(jobId);
|
listingStorage.removeListings(jobId);
|
||||||
db.get('jobs')
|
db.chain
|
||||||
|
.get('jobs')
|
||||||
.remove((job) => job.id === jobId)
|
.remove((job) => job.id === jobId)
|
||||||
.write();
|
.value();
|
||||||
|
db.write();
|
||||||
};
|
};
|
||||||
|
export const removeJobsByUserId = (userId) => {
|
||||||
exports.removeJobsByUserId = (userId) => {
|
db.chain
|
||||||
db.get('jobs')
|
.get('jobs')
|
||||||
.value()
|
|
||||||
.filter((job) => job.userId === userId)
|
.filter((job) => job.userId === userId)
|
||||||
.forEach((job) => listingStorage.removeListings(job.id));
|
.forEach((job) => listingStorage.removeListings(job.id));
|
||||||
|
db.chain
|
||||||
db.get('jobs')
|
.get('jobs')
|
||||||
.remove((job) => job.userId === userId)
|
.remove((job) => job.userId === userId)
|
||||||
.write();
|
.value();
|
||||||
};
|
db.write();
|
||||||
|
};
|
||||||
exports.getJobs = () => {
|
export const getJobs = () => {
|
||||||
return db
|
return db.chain
|
||||||
.get('jobs')
|
.get('jobs')
|
||||||
.value()
|
|
||||||
.map((job) => ({
|
.map((job) => ({
|
||||||
...job,
|
...job,
|
||||||
numberOfFoundListings: listingStorage.getNumberOfAllKnownListings(job.id),
|
numberOfFoundListings: listingStorage.getNumberOfAllKnownListings(job.id),
|
||||||
}));
|
}))
|
||||||
|
.value();
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,10 +1,13 @@
|
|||||||
const path = require('path');
|
import { JSONFileSync } from 'lowdb/node';
|
||||||
|
import { getDirName } from '../../utils.js';
|
||||||
|
import path from 'path';
|
||||||
|
import LowdashAdapter from './LowDashAdapter.js';
|
||||||
|
|
||||||
const DB_PATH = path.dirname(require.main.filename) + '/db/jobListingData.json';
|
const file = path.join(getDirName(), '../', 'db/jobListingData.json');
|
||||||
const FileSync = require('lowdb/adapters/FileSync');
|
const adapter = new JSONFileSync(file);
|
||||||
const adapter = new FileSync(DB_PATH);
|
const db = new LowdashAdapter(adapter, {});
|
||||||
const low = require('lowdb');
|
|
||||||
const db = low(adapter);
|
db.read();
|
||||||
|
|
||||||
const buildKey = (jobKey, providerId, endpoint) => {
|
const buildKey = (jobKey, providerId, endpoint) => {
|
||||||
let key = `${jobKey}`;
|
let key = `${jobKey}`;
|
||||||
@@ -19,35 +22,31 @@ const buildKey = (jobKey, providerId, endpoint) => {
|
|||||||
}
|
}
|
||||||
return key;
|
return key;
|
||||||
};
|
};
|
||||||
|
export const getNumberOfAllKnownListings = (jobId) => {
|
||||||
exports.getNumberOfAllKnownListings = (jobId) => {
|
const data = db.chain.get(`${jobId}.providerData`).value() || {};
|
||||||
const data = db.get(`${jobId}.providerData`).value() || {};
|
|
||||||
return Object.values(data)
|
return Object.values(data)
|
||||||
.map((values) => Object.keys(values).length)
|
.map((values) => Object.keys(values).length)
|
||||||
.reduce((accumulator, currentValue) => accumulator + currentValue, 0);
|
.reduce((accumulator, currentValue) => accumulator + currentValue, 0);
|
||||||
};
|
};
|
||||||
|
export const getListingProviderDataForAnalytics = (jobId) => {
|
||||||
exports.getListingProviderDataForAnalytics = (jobId) => {
|
|
||||||
const key = buildKey(jobId, 'providerData');
|
const key = buildKey(jobId, 'providerData');
|
||||||
return db.get(key).value() || {};
|
return db.chain.get(key).value() || {};
|
||||||
};
|
};
|
||||||
|
export const getKnownListings = (jobId, providerId) => {
|
||||||
exports.getKnownListings = (jobId, providerId) => {
|
|
||||||
const providerListingsKey = buildKey(jobId, 'providerData', providerId, 'listings');
|
const providerListingsKey = buildKey(jobId, 'providerData', providerId, 'listings');
|
||||||
return db.get(providerListingsKey).value() || {};
|
return db.chain.get(providerListingsKey).value() || {};
|
||||||
};
|
};
|
||||||
|
export const setKnownListings = (jobId, providerId, listings) => {
|
||||||
exports.setKnownListings = (jobId, providerId, listings) => {
|
|
||||||
const providerListingsKey = buildKey(jobId, 'providerData', providerId, 'listings');
|
const providerListingsKey = buildKey(jobId, 'providerData', providerId, 'listings');
|
||||||
|
db.chain.set(providerListingsKey, listings).value();
|
||||||
return db.set(providerListingsKey, listings).write();
|
return db.write();
|
||||||
};
|
};
|
||||||
|
export const setLastJobExecution = (jobId) => {
|
||||||
exports.setLastJobExecution = (jobId) => {
|
|
||||||
const key = buildKey(jobId, null, 'lastExecution');
|
const key = buildKey(jobId, null, 'lastExecution');
|
||||||
return db.set(key, Date.now()).write();
|
db.chain.set(key, Date.now()).value();
|
||||||
|
return db.write();
|
||||||
};
|
};
|
||||||
|
export const removeListings = (jobId) => {
|
||||||
exports.removeListings = (jobId) => {
|
db.chain.unset(jobId).value();
|
||||||
db.unset(jobId).write();
|
db.write();
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,30 +1,33 @@
|
|||||||
const path = require('path');
|
import { JSONFileSync } from 'lowdb/node';
|
||||||
const DB_PATH = path.dirname(require.main.filename) + '/db/users.json';
|
import { getDirName } from '../../utils.js';
|
||||||
const FileSync = require('lowdb/adapters/FileSync');
|
import * as hasher from '../security/hash.js';
|
||||||
const adapter = new FileSync(DB_PATH);
|
import { nanoid } from 'nanoid';
|
||||||
const low = require('lowdb');
|
import * as jobStorage from './jobStorage.js';
|
||||||
const db = low(adapter);
|
import path from 'path';
|
||||||
const hasher = require('../security/hash');
|
import LowdashAdapter from './LowDashAdapter.js';
|
||||||
const { nanoid } = require('nanoid');
|
|
||||||
const jobStorage = require('./jobStorage');
|
|
||||||
|
|
||||||
db.defaults({
|
const defaultData = {
|
||||||
user: [
|
user: [
|
||||||
//you probably want to change the default password ;)
|
//you probably want to change the default password ;)
|
||||||
{
|
{
|
||||||
id: nanoid(),
|
id: nanoid(),
|
||||||
lastLogin: Date.now(),
|
lastLogin: Date.now(),
|
||||||
username: 'admin',
|
username: 'admin',
|
||||||
password: hasher.hash('admin'),
|
password: hasher.hash('admin'),
|
||||||
isAdmin: true,
|
isAdmin: true,
|
||||||
isDemo: false,
|
},
|
||||||
},
|
],
|
||||||
],
|
};
|
||||||
}).write();
|
|
||||||
|
|
||||||
exports.getUsers = (withPassword) => {
|
const file = path.join(getDirName(), '../', 'db/users.json');
|
||||||
|
const adapter = new JSONFileSync(file);
|
||||||
|
const db = new LowdashAdapter(adapter, defaultData);
|
||||||
|
|
||||||
|
db.read();
|
||||||
|
|
||||||
|
export const getUsers = (withPassword) => {
|
||||||
const jobs = jobStorage.getJobs();
|
const jobs = jobStorage.getJobs();
|
||||||
return db
|
return db.chain
|
||||||
.get('user')
|
.get('user')
|
||||||
.value()
|
.value()
|
||||||
.map((user) => ({
|
.map((user) => ({
|
||||||
@@ -34,13 +37,12 @@ exports.getUsers = (withPassword) => {
|
|||||||
numberOfJobs: jobs.filter((job) => job.userId === user.id).length,
|
numberOfJobs: jobs.filter((job) => job.userId === user.id).length,
|
||||||
}));
|
}));
|
||||||
};
|
};
|
||||||
|
export const getUser = (id) => {
|
||||||
exports.getUser = (id) => {
|
|
||||||
const jobs = jobStorage.getJobs();
|
const jobs = jobStorage.getJobs();
|
||||||
const user = db
|
const user = db.chain
|
||||||
.get('user')
|
.get('user')
|
||||||
.value()
|
.find((user) => user.id === id)
|
||||||
.find((user) => user.id === id);
|
.value();
|
||||||
if (user == null) {
|
if (user == null) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
@@ -49,13 +51,11 @@ exports.getUser = (id) => {
|
|||||||
numberOfJobs: jobs.filter((job) => job.userId === user.id).length,
|
numberOfJobs: jobs.filter((job) => job.userId === user.id).length,
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
export const upsertUser = ({ username, password, userId, isAdmin }) => {
|
||||||
exports.upsertUser = ({ username, password, userId, isAdmin }) => {
|
const user = db.chain
|
||||||
const user = db
|
|
||||||
.get('user')
|
.get('user')
|
||||||
.value()
|
.filter((u) => u.id !== userId)
|
||||||
.filter((u) => u.id !== userId);
|
.value();
|
||||||
|
|
||||||
user.push({
|
user.push({
|
||||||
id: userId || nanoid(),
|
id: userId || nanoid(),
|
||||||
username,
|
username,
|
||||||
@@ -63,21 +63,24 @@ exports.upsertUser = ({ username, password, userId, isAdmin }) => {
|
|||||||
password: hasher.hash(password),
|
password: hasher.hash(password),
|
||||||
isAdmin,
|
isAdmin,
|
||||||
});
|
});
|
||||||
|
db.chain.set('user', user).value();
|
||||||
db.set('user', user).write();
|
db.write();
|
||||||
};
|
};
|
||||||
|
export const setLastLoginToNow = ({ userId }) => {
|
||||||
exports.setLastLoginToNow = ({ userId }) => {
|
db.chain
|
||||||
db.get('user')
|
.get('user')
|
||||||
.find((u) => u.id === userId)
|
.find((u) => u.id === userId)
|
||||||
.assign({ lastLogin: Date.now() })
|
.assign({ lastLogin: Date.now() })
|
||||||
.write();
|
.value();
|
||||||
|
db.write();
|
||||||
};
|
};
|
||||||
|
export const removeUser = (userId) => {
|
||||||
exports.removeUser = (userId) => {
|
const user = db.chain.get('user').value();
|
||||||
const user = db.get('user').value();
|
db.chain
|
||||||
db.set(
|
.set(
|
||||||
'user',
|
'user',
|
||||||
user.filter((u) => u.id !== userId)
|
user.filter((u) => u.id !== userId)
|
||||||
).write();
|
)
|
||||||
|
.value();
|
||||||
|
db.write();
|
||||||
};
|
};
|
||||||
|
|||||||
29
lib/utils.js
@@ -1,17 +1,18 @@
|
|||||||
|
import { dirname } from 'node:path';
|
||||||
|
import { fileURLToPath } from 'node:url';
|
||||||
|
import { readFile } from 'fs/promises';
|
||||||
|
|
||||||
function isOneOf(word, arr) {
|
function isOneOf(word, arr) {
|
||||||
if (arr == null || arr.length === 0) {
|
if (arr == null || arr.length === 0) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
const expression = String.raw`\b(${arr.join('|')})\b`;
|
const expression = String.raw`\b(${arr.join('|')})\b`;
|
||||||
const blacklist = new RegExp(expression, 'ig');
|
const blacklist = new RegExp(expression, 'ig');
|
||||||
|
|
||||||
return blacklist.test(word);
|
return blacklist.test(word);
|
||||||
}
|
}
|
||||||
|
|
||||||
function nullOrEmpty(val) {
|
function nullOrEmpty(val) {
|
||||||
return val == null || val.length === 0;
|
return val == null || val.length === 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
function timeStringToMs(timeString, now) {
|
function timeStringToMs(timeString, now) {
|
||||||
const d = new Date(now);
|
const d = new Date(now);
|
||||||
const parts = timeString.split(':');
|
const parts = timeString.split(':');
|
||||||
@@ -20,17 +21,31 @@ function timeStringToMs(timeString, now) {
|
|||||||
d.setSeconds(0);
|
d.setSeconds(0);
|
||||||
return d.getTime();
|
return d.getTime();
|
||||||
}
|
}
|
||||||
|
|
||||||
function duringWorkingHoursOrNotSet(config, now) {
|
function duringWorkingHoursOrNotSet(config, now) {
|
||||||
const { workingHours } = config;
|
const { workingHours } = config;
|
||||||
if (workingHours == null || nullOrEmpty(workingHours.from) || nullOrEmpty(workingHours.to)) {
|
if (workingHours == null || nullOrEmpty(workingHours.from) || nullOrEmpty(workingHours.to)) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
const toDate = timeStringToMs(workingHours.to, now);
|
const toDate = timeStringToMs(workingHours.to, now);
|
||||||
const fromDate = timeStringToMs(workingHours.from, now);
|
const fromDate = timeStringToMs(workingHours.from, now);
|
||||||
|
|
||||||
return fromDate <= now && toDate >= now;
|
return fromDate <= now && toDate >= now;
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { isOneOf, nullOrEmpty, duringWorkingHoursOrNotSet };
|
function getDirName() {
|
||||||
|
return dirname(fileURLToPath(import.meta.url));
|
||||||
|
}
|
||||||
|
|
||||||
|
const config = JSON.parse(await readFile(new URL('../conf/config.json', import.meta.url)));
|
||||||
|
|
||||||
|
export { isOneOf };
|
||||||
|
export { nullOrEmpty };
|
||||||
|
export { duringWorkingHoursOrNotSet };
|
||||||
|
export { getDirName };
|
||||||
|
export { config };
|
||||||
|
export default {
|
||||||
|
isOneOf,
|
||||||
|
nullOrEmpty,
|
||||||
|
duringWorkingHoursOrNotSet,
|
||||||
|
getDirName,
|
||||||
|
config,
|
||||||
|
};
|
||||||
|
|||||||
106
package.json
@@ -1,19 +1,22 @@
|
|||||||
{
|
{
|
||||||
"name": "fredy",
|
"name": "fredy",
|
||||||
"version": "5.3.2",
|
"version": "7.3.2",
|
||||||
"description": "[F]ind [R]eal [E]states [d]amn eas[y].",
|
"description": "[F]ind [R]eal [E]states [d]amn eas[y].",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "node index.js",
|
"start": "node index.js",
|
||||||
"dev": "yarn && export BUILD_DEV='true' && export NODE_ENV='development' && webpack-dev-server --progress --colors --watch --config ./webpack.dev.js",
|
"dev": "yarn && rm -rf ./ui/public/* && vite",
|
||||||
"prod": "export BUILD_DEV='false' && webpack --node-env=production --config ./webpack.prod.js",
|
"ui": "rm -rf ./ui/public/* && vite",
|
||||||
"format": "prettier --write lib/**/*.js ui/src/**/*.js test/**/*.js *.js --single-quote --print-width 120",
|
"prod": "yarn && vite build --emptyOutDir",
|
||||||
"test": "mocha --timeout 20000 test/**/*.test.js"
|
"format": "prettier --write lib/**/*.js ui/src/**/*.jsx test/**/*.js *.js --single-quote --print-width 120",
|
||||||
|
"test": "mocha --loader=esmock --timeout 3000000 test/**/*.test.js",
|
||||||
|
"lint": "eslint ./index.js ./lib/**/*.js ./test/**/*.js ./ui/src/**/*.jsx"
|
||||||
},
|
},
|
||||||
"husky": {
|
"husky": {
|
||||||
"hooks": {
|
"hooks": {
|
||||||
"pre-commit": "lint-staged"
|
"pre-commit": "lint-staged"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"type": "module",
|
||||||
"lint-staged": {
|
"lint-staged": {
|
||||||
"*.js": [
|
"*.js": [
|
||||||
"eslint ./index.js ./lib/**/*.js ./test/**/*.js",
|
"eslint ./index.js ./lib/**/*.js ./test/**/*.js",
|
||||||
@@ -42,8 +45,8 @@
|
|||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=12.13.0",
|
"node": ">=16.0.0",
|
||||||
"npm": ">=6.0.0"
|
"npm": ">=7.0.0"
|
||||||
},
|
},
|
||||||
"browserslist": [
|
"browserslist": [
|
||||||
"> 0.5%",
|
"> 0.5%",
|
||||||
@@ -52,63 +55,54 @@
|
|||||||
"Firefox ESR"
|
"Firefox ESR"
|
||||||
],
|
],
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@rematch/core": "2.1.0",
|
"@douyinfe/semi-ui": "2.42.4",
|
||||||
"@rematch/loading": "2.1.0",
|
"@rematch/core": "2.2.0",
|
||||||
"@sendgrid/mail": "7.4.7",
|
"@rematch/loading": "2.1.2",
|
||||||
"axios": "0.24.0",
|
"@sendgrid/mail": "7.7.0",
|
||||||
"axios-retry": "^3.2.4",
|
"@vitejs/plugin-react": "4.0.4",
|
||||||
"body-parser": "1.19.0",
|
"better-sqlite3": "8.6.0",
|
||||||
"cookie-session": "1.4.0",
|
"body-parser": "1.20.2",
|
||||||
"handlebars": "4.7.7",
|
"cookie-session": "2.0.0",
|
||||||
"highcharts": "9.2.2",
|
"handlebars": "4.7.8",
|
||||||
"highcharts-react-official": "3.0.0",
|
"highcharts": "11.1.0",
|
||||||
"lowdb": "1.0.0",
|
"highcharts-react-official": "3.2.1",
|
||||||
|
"lodash": "4.17.21",
|
||||||
|
"lowdb": "6.0.1",
|
||||||
"markdown": "^0.5.0",
|
"markdown": "^0.5.0",
|
||||||
"nanoid": "3.1.28",
|
"nanoid": "4.0.2",
|
||||||
"node-mailjet": "3.3.4",
|
"node-fetch": "3.3.2",
|
||||||
"react": "17.0.2",
|
"node-mailjet": "6.0.4",
|
||||||
"react-dom": "17.0.2",
|
"query-string": "8.1.0",
|
||||||
"react-redux": "7.2.5",
|
"react": "18.2.0",
|
||||||
|
"react-dom": "18.2.0",
|
||||||
|
"react-redux": "8.1.2",
|
||||||
"react-router": "5.2.1",
|
"react-router": "5.2.1",
|
||||||
"react-router-dom": "5.3.0",
|
"react-router-dom": "5.3.0",
|
||||||
"react-switch": "^6.0.0",
|
"redux": "4.2.1",
|
||||||
"redux": "4.1.1",
|
"redux-thunk": "2.4.2",
|
||||||
"redux-thunk": "2.3.0",
|
"restana": "4.9.7",
|
||||||
"restana": "4.9.1",
|
"serve-static": "1.15.0",
|
||||||
"semantic-ui-react": "2.0.4",
|
|
||||||
"serve-static": "^1.14.1",
|
|
||||||
"slack": "11.0.2",
|
"slack": "11.0.2",
|
||||||
"string-similarity": "^4.0.4",
|
"string-similarity": "^4.0.4",
|
||||||
|
"vite": "4.4.9",
|
||||||
"x-ray": "2.3.4"
|
"x-ray": "2.3.4"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@babel/core": "7.15.5",
|
"@babel/core": "7.22.15",
|
||||||
"@babel/preset-env": "7.15.6",
|
"@babel/eslint-parser": "7.22.15",
|
||||||
"@babel/preset-react": "7.14.5",
|
"@babel/preset-env": "7.22.15",
|
||||||
"babel-eslint": "10.1.0",
|
"@babel/preset-react": "7.22.15",
|
||||||
"babel-loader": "8.2.2",
|
"chai": "4.3.8",
|
||||||
"chai": "4.3.4",
|
"eslint": "8.48.0",
|
||||||
"clean-webpack-plugin": "4.0.0",
|
"eslint-config-prettier": "8.8.0",
|
||||||
"copy-webpack-plugin": "9.0.1",
|
"eslint-plugin-react": "7.33.2",
|
||||||
"css-loader": "6.3.0",
|
"esmock": "2.4.0",
|
||||||
"eslint": "7.32.0",
|
"history": "5.3.0",
|
||||||
"eslint-config-prettier": "8.3.0",
|
|
||||||
"eslint-plugin-react": "7.26.1",
|
|
||||||
"file-loader": "6.2.0",
|
|
||||||
"history": "5.0.1",
|
|
||||||
"husky": "4.3.8",
|
"husky": "4.3.8",
|
||||||
"less": "4.1.1",
|
"less": "4.2.0",
|
||||||
"less-loader": "10.0.1",
|
"lint-staged": "13.2.2",
|
||||||
"lint-staged": "11.1.2",
|
"mocha": "10.2.0",
|
||||||
"mocha": "9.1.2",
|
"prettier": "2.8.8",
|
||||||
"prettier": "2.4.1",
|
"redux-logger": "3.0.6"
|
||||||
"proxyquire": "2.1.3",
|
|
||||||
"redux-logger": "3.0.6",
|
|
||||||
"style-loader": "3.3.0",
|
|
||||||
"url-loader": "4.1.1",
|
|
||||||
"webpack": "5.56.0",
|
|
||||||
"webpack-cli": "3.3.12",
|
|
||||||
"webpack-dev-server": "3.11.2",
|
|
||||||
"webpack-merge": "5.8.0"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,12 +1,10 @@
|
|||||||
module.exports = {
|
let tmpStore = {};
|
||||||
_tmpStore: {},
|
|
||||||
|
|
||||||
send: (serviceName, payload) => {
|
export const send = (serviceName, payload) => {
|
||||||
this._tmpStore = { serviceName, payload };
|
tmpStore = { serviceName, payload };
|
||||||
return [Promise.resolve()];
|
return [Promise.resolve()];
|
||||||
},
|
};
|
||||||
|
|
||||||
get: () => {
|
export const get = () => {
|
||||||
return this._tmpStore;
|
return tmpStore;
|
||||||
},
|
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,11 +1,8 @@
|
|||||||
const db = {};
|
const db = {};
|
||||||
|
export const setKnownListings = (jobKey, providerId, listings) => {
|
||||||
exports.setKnownListings = (jobKey, providerId, listings) => {
|
|
||||||
if (!Array.isArray(listings)) throw Error('Not a valid array');
|
if (!Array.isArray(listings)) throw Error('Not a valid array');
|
||||||
|
|
||||||
db[providerId] = listings;
|
db[providerId] = listings;
|
||||||
};
|
};
|
||||||
|
export const getKnownListings = (jobKey, providerId) => {
|
||||||
exports.getKnownListings = (jobKey, providerId) => {
|
|
||||||
return db[providerId] || [];
|
return db[providerId] || [];
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,35 +1,25 @@
|
|||||||
const similarityCache = require('../../lib/services/similarity-check/similarityCache');
|
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
|
||||||
const mockNotification = require('../mocks/mockNotification');
|
import { get } from '../mocks/mockNotification.js';
|
||||||
const providerConfig = require('./testProvider.json');
|
import { providerConfig, mockFredy } from '../utils.js';
|
||||||
const mockStore = require('../mocks/mockStore');
|
import chai from 'chai';
|
||||||
const proxyquire = require('proxyquire').noCallThru();
|
import * as provider from '../../lib/provider/einsAImmobilien.js';
|
||||||
const expect = require('chai').expect;
|
|
||||||
const provider = require('../../lib/provider/einsAImmobilien');
|
const expect = chai.expect;
|
||||||
|
|
||||||
describe('#einsAImmobilien testsuite()', () => {
|
describe('#einsAImmobilien testsuite()', () => {
|
||||||
after(() => {
|
after(() => {
|
||||||
similarityCache.stopCacheCleanup();
|
similarityCache.stopCacheCleanup();
|
||||||
});
|
});
|
||||||
|
|
||||||
provider.init(providerConfig.einsAImmobilien, [], []);
|
provider.init(providerConfig.einsAImmobilien, [], []);
|
||||||
|
|
||||||
const Fredy = proxyquire('../../lib/FredyRuntime', {
|
|
||||||
'./services/storage/listingsStorage': {
|
|
||||||
...mockStore,
|
|
||||||
},
|
|
||||||
'./notification/notify': mockNotification,
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should test einsAImmobilien provider', async () => {
|
it('should test einsAImmobilien provider', async () => {
|
||||||
|
const Fredy = await mockFredy();
|
||||||
return await new Promise((resolve) => {
|
return await new Promise((resolve) => {
|
||||||
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
|
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'einsAImmobilien', similarityCache);
|
||||||
fredy.execute().then((listings) => {
|
fredy.execute().then((listings) => {
|
||||||
expect(listings).to.be.a('array');
|
expect(listings).to.be.a('array');
|
||||||
|
const notificationObj = get();
|
||||||
const notificationObj = mockNotification.get();
|
|
||||||
expect(notificationObj).to.be.a('object');
|
expect(notificationObj).to.be.a('object');
|
||||||
expect(notificationObj.serviceName).to.equal('einsAImmobilien');
|
expect(notificationObj.serviceName).to.equal('einsAImmobilien');
|
||||||
|
|
||||||
notificationObj.payload.forEach((notify) => {
|
notificationObj.payload.forEach((notify) => {
|
||||||
/** check the actual structure **/
|
/** check the actual structure **/
|
||||||
expect(notify.id).to.be.a('number');
|
expect(notify.id).to.be.a('number');
|
||||||
@@ -37,9 +27,7 @@ describe('#einsAImmobilien testsuite()', () => {
|
|||||||
expect(notify.size).to.be.a('string');
|
expect(notify.size).to.be.a('string');
|
||||||
expect(notify.title).to.be.a('string');
|
expect(notify.title).to.be.a('string');
|
||||||
expect(notify.link).to.be.a('string');
|
expect(notify.link).to.be.a('string');
|
||||||
|
|
||||||
/** check the values if possible **/
|
/** check the values if possible **/
|
||||||
expect(notify.price).that.does.include('EUR');
|
|
||||||
expect(notify.size).to.be.not.empty;
|
expect(notify.size).to.be.not.empty;
|
||||||
expect(notify.title).to.be.not.empty;
|
expect(notify.title).to.be.not.empty;
|
||||||
expect(notify.link).that.does.include('https://www.1a-immobilienmarkt.de');
|
expect(notify.link).that.does.include('https://www.1a-immobilienmarkt.de');
|
||||||
|
|||||||
40
test/provider/immobilienDe.test.js
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
|
||||||
|
import { get } from '../mocks/mockNotification.js';
|
||||||
|
import { providerConfig, mockFredy } from '../utils.js';
|
||||||
|
import chai from 'chai';
|
||||||
|
import * as provider from '../../lib/provider/immobilienDe.js';
|
||||||
|
const expect = chai.expect;
|
||||||
|
describe('#immobilien.de testsuite()', () => {
|
||||||
|
after(() => {
|
||||||
|
similarityCache.stopCacheCleanup();
|
||||||
|
});
|
||||||
|
provider.init(providerConfig.immobilienDe, [], []);
|
||||||
|
it('should test immobilien.de provider', async () => {
|
||||||
|
const Fredy = await mockFredy();
|
||||||
|
return await new Promise((resolve) => {
|
||||||
|
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
|
||||||
|
fredy.execute().then((listing) => {
|
||||||
|
expect(listing).to.be.a('array');
|
||||||
|
const notificationObj = get();
|
||||||
|
expect(notificationObj).to.be.a('object');
|
||||||
|
expect(notificationObj.serviceName).to.equal('immobilienDe');
|
||||||
|
notificationObj.payload.forEach((notify) => {
|
||||||
|
/** check the actual structure **/
|
||||||
|
expect(notify.id).to.be.a('string');
|
||||||
|
expect(notify.price).to.be.a('string');
|
||||||
|
expect(notify.size).to.be.a('string');
|
||||||
|
expect(notify.title).to.be.a('string');
|
||||||
|
expect(notify.link).to.be.a('string');
|
||||||
|
expect(notify.address).to.be.a('string');
|
||||||
|
/** check the values if possible **/
|
||||||
|
expect(notify.price).that.does.include('€');
|
||||||
|
expect(notify.size).that.does.include('m²');
|
||||||
|
expect(notify.title).to.be.not.empty;
|
||||||
|
expect(notify.link).that.does.include('https://www.immobilien.de');
|
||||||
|
expect(notify.address).to.be.not.empty;
|
||||||
|
});
|
||||||
|
resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,37 +1,34 @@
|
|||||||
const similarityCache = require('../../lib/services/similarity-check/similarityCache');
|
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
|
||||||
const mockNotification = require('../mocks/mockNotification');
|
import { get } from '../mocks/mockNotification.js';
|
||||||
const providerConfig = require('./testProvider.json');
|
import { mockFredy, providerConfig } from '../utils.js';
|
||||||
const mockStore = require('../mocks/mockStore');
|
import chai from 'chai';
|
||||||
const proxyquire = require('proxyquire').noCallThru();
|
import * as provider from '../../lib/provider/immonet.js';
|
||||||
const expect = require('chai').expect;
|
import * as scrapingAnt from '../../lib/services/scrapingAnt.js';
|
||||||
const provider = require('../../lib/provider/immonet');
|
const expect = chai.expect;
|
||||||
|
|
||||||
describe('#immonet testsuite()', () => {
|
describe('#immonet testsuite()', () => {
|
||||||
after(() => {
|
after(() => {
|
||||||
similarityCache.stopCacheCleanup();
|
similarityCache.stopCacheCleanup();
|
||||||
});
|
});
|
||||||
|
|
||||||
provider.init(providerConfig.immonet, [], []);
|
provider.init(providerConfig.immonet, [], []);
|
||||||
const Fredy = proxyquire('../../lib/FredyRuntime', {
|
|
||||||
'./services/storage/listingsStorage': {
|
|
||||||
...mockStore,
|
|
||||||
},
|
|
||||||
'./notification/notify': mockNotification,
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should test immonet provider', async () => {
|
it('should test immonet provider', async () => {
|
||||||
|
const Fredy = await mockFredy();
|
||||||
return await new Promise((resolve) => {
|
return await new Promise((resolve) => {
|
||||||
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
|
if (!scrapingAnt.isScrapingAntApiKeySet()) {
|
||||||
|
/* eslint-disable no-console */
|
||||||
|
console.info('Skipping Immonet test as ScrapingAnt Api Key is not set.');
|
||||||
|
/* eslint-enable no-console */
|
||||||
|
resolve();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'immonet', similarityCache);
|
||||||
fredy.execute().then((listing) => {
|
fredy.execute().then((listing) => {
|
||||||
expect(listing).to.be.a('array');
|
expect(listing).to.be.a('array');
|
||||||
|
const notificationObj = get();
|
||||||
const notificationObj = mockNotification.get();
|
|
||||||
expect(notificationObj).to.be.a('object');
|
expect(notificationObj).to.be.a('object');
|
||||||
expect(notificationObj.serviceName).to.equal('immonet');
|
expect(notificationObj.serviceName).to.equal('immonet');
|
||||||
|
|
||||||
notificationObj.payload.forEach((notify) => {
|
notificationObj.payload.forEach((notify) => {
|
||||||
/** check the actual structure **/
|
/** check the actual structure **/
|
||||||
expect(notify.id).to.be.a('number');
|
expect(notify.id).to.be.a('string');
|
||||||
expect(notify.price).to.be.a('string');
|
expect(notify.price).to.be.a('string');
|
||||||
expect(notify.size).to.be.a('string');
|
expect(notify.size).to.be.a('string');
|
||||||
expect(notify.title).to.be.a('string');
|
expect(notify.title).to.be.a('string');
|
||||||
@@ -42,7 +39,6 @@ describe('#immonet testsuite()', () => {
|
|||||||
expect(notify.price).that.does.include('€');
|
expect(notify.price).that.does.include('€');
|
||||||
expect(notify.size).that.does.include('m²');
|
expect(notify.size).that.does.include('m²');
|
||||||
expect(notify.title).to.be.not.empty;
|
expect(notify.title).to.be.not.empty;
|
||||||
expect(notify.link).that.does.include('https://www.immonet.de');
|
|
||||||
expect(notify.address).to.be.not.empty;
|
expect(notify.address).to.be.not.empty;
|
||||||
});
|
});
|
||||||
resolve();
|
resolve();
|
||||||
|
|||||||
@@ -1,25 +1,17 @@
|
|||||||
const similarityCache = require('../../lib/services/similarity-check/similarityCache');
|
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
|
||||||
const mockNotification = require('../mocks/mockNotification');
|
import { get } from '../mocks/mockNotification.js';
|
||||||
const providerConfig = require('./testProvider.json');
|
import { mockFredy, providerConfig } from '../utils.js';
|
||||||
const mockStore = require('../mocks/mockStore');
|
import chai from 'chai';
|
||||||
const proxyquire = require('proxyquire').noCallThru();
|
import * as provider from '../../lib/provider/immoscout.js';
|
||||||
const expect = require('chai').expect;
|
import * as scrapingAnt from '../../lib/services/scrapingAnt.js';
|
||||||
const provider = require('../../lib/provider/immoscout');
|
const expect = chai.expect;
|
||||||
const scrapingAnt = require('../../lib/services/scrapingAnt');
|
|
||||||
|
|
||||||
describe('#immoscout testsuite()', () => {
|
describe('#immoscout testsuite()', () => {
|
||||||
after(() => {
|
after(() => {
|
||||||
similarityCache.stopCacheCleanup();
|
similarityCache.stopCacheCleanup();
|
||||||
});
|
});
|
||||||
provider.init(providerConfig.immoscout, [], []);
|
provider.init(providerConfig.immoscout, [], []);
|
||||||
const Fredy = proxyquire('../../lib/FredyRuntime', {
|
|
||||||
'./services/storage/listingsStorage': {
|
|
||||||
...mockStore,
|
|
||||||
},
|
|
||||||
'./notification/notify': mockNotification,
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should test immoscout provider', async () => {
|
it('should test immoscout provider', async () => {
|
||||||
|
const Fredy = await mockFredy();
|
||||||
return await new Promise((resolve) => {
|
return await new Promise((resolve) => {
|
||||||
if (!scrapingAnt.isScrapingAntApiKeySet()) {
|
if (!scrapingAnt.isScrapingAntApiKeySet()) {
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
@@ -28,15 +20,12 @@ describe('#immoscout testsuite()', () => {
|
|||||||
resolve();
|
resolve();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'immoscout', similarityCache);
|
||||||
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
|
|
||||||
fredy.execute().then((listing) => {
|
fredy.execute().then((listing) => {
|
||||||
expect(listing).to.be.a('array');
|
expect(listing).to.be.a('array');
|
||||||
|
const notificationObj = get();
|
||||||
const notificationObj = mockNotification.get();
|
|
||||||
expect(notificationObj).to.be.a('object');
|
expect(notificationObj).to.be.a('object');
|
||||||
expect(notificationObj.serviceName).to.equal('immoscout');
|
expect(notificationObj.serviceName).to.equal('immoscout');
|
||||||
|
|
||||||
notificationObj.payload.forEach((notify) => {
|
notificationObj.payload.forEach((notify) => {
|
||||||
/** check the actual structure **/
|
/** check the actual structure **/
|
||||||
expect(notify.id).to.be.a('number');
|
expect(notify.id).to.be.a('number');
|
||||||
@@ -45,7 +34,6 @@ describe('#immoscout testsuite()', () => {
|
|||||||
expect(notify.title).to.be.a('string');
|
expect(notify.title).to.be.a('string');
|
||||||
expect(notify.link).to.be.a('string');
|
expect(notify.link).to.be.a('string');
|
||||||
expect(notify.address).to.be.a('string');
|
expect(notify.address).to.be.a('string');
|
||||||
|
|
||||||
/** check the values if possible **/
|
/** check the values if possible **/
|
||||||
expect(notify.price).that.does.include('€');
|
expect(notify.price).that.does.include('€');
|
||||||
expect(notify.size).that.does.include('m²');
|
expect(notify.size).that.does.include('m²');
|
||||||
|
|||||||
39
test/provider/immoswp.test.js
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
|
||||||
|
import { get } from '../mocks/mockNotification.js';
|
||||||
|
import { mockFredy, providerConfig } from '../utils.js';
|
||||||
|
import chai from 'chai';
|
||||||
|
import * as provider from '../../lib/provider/immoswp.js';
|
||||||
|
const expect = chai.expect;
|
||||||
|
describe('#immoswp testsuite()', () => {
|
||||||
|
after(() => {
|
||||||
|
similarityCache.stopCacheCleanup();
|
||||||
|
});
|
||||||
|
provider.init(providerConfig.immoswp, [], []);
|
||||||
|
it('should test immoswp provider', async () => {
|
||||||
|
const Fredy = await mockFredy();
|
||||||
|
return await new Promise((resolve) => {
|
||||||
|
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'immoswp', similarityCache);
|
||||||
|
fredy.execute().then((listing) => {
|
||||||
|
expect(listing).to.be.a('array');
|
||||||
|
const notificationObj = get();
|
||||||
|
expect(notificationObj).to.be.a('object');
|
||||||
|
expect(notificationObj.serviceName).to.equal('immoswp');
|
||||||
|
notificationObj.payload.forEach((notify) => {
|
||||||
|
/** check the actual structure **/
|
||||||
|
expect(notify.id).to.be.a('string');
|
||||||
|
expect(notify.price).to.be.a('string');
|
||||||
|
expect(notify.size).to.be.a('string');
|
||||||
|
expect(notify.title).to.be.a('string');
|
||||||
|
expect(notify.link).to.be.a('string');
|
||||||
|
expect(notify.address).to.be.a('string');
|
||||||
|
/** check the values if possible **/
|
||||||
|
expect(notify.price).that.does.include('€');
|
||||||
|
expect(notify.title).to.be.not.empty;
|
||||||
|
expect(notify.link).that.does.include('https://immo.swp.de');
|
||||||
|
expect(notify.address).to.be.not.empty;
|
||||||
|
});
|
||||||
|
resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,45 +1,32 @@
|
|||||||
const similarityCache = require('../../lib/services/similarity-check/similarityCache');
|
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
|
||||||
const mockNotification = require('../mocks/mockNotification');
|
import { get } from '../mocks/mockNotification.js';
|
||||||
const providerConfig = require('./testProvider.json');
|
import { mockFredy, providerConfig } from '../utils.js';
|
||||||
const mockStore = require('../mocks/mockStore');
|
import chai from 'chai';
|
||||||
const proxyquire = require('proxyquire').noCallThru();
|
import * as provider from '../../lib/provider/immowelt.js';
|
||||||
const expect = require('chai').expect;
|
const expect = chai.expect;
|
||||||
const provider = require('../../lib/provider/immowelt');
|
|
||||||
|
|
||||||
describe('#immowelt testsuite()', () => {
|
describe('#immowelt testsuite()', () => {
|
||||||
after(() => {
|
after(() => {
|
||||||
similarityCache.stopCacheCleanup();
|
similarityCache.stopCacheCleanup();
|
||||||
});
|
});
|
||||||
it('should test immowelt provider', async () => {
|
it('should test immowelt provider', async () => {
|
||||||
|
const Fredy = await mockFredy();
|
||||||
provider.init(providerConfig.immowelt, [], []);
|
provider.init(providerConfig.immowelt, [], []);
|
||||||
const Fredy = proxyquire('../../lib/FredyRuntime', {
|
|
||||||
'./services/storage/listingsStorage': {
|
|
||||||
...mockStore,
|
|
||||||
},
|
|
||||||
'./notification/notify': mockNotification,
|
|
||||||
});
|
|
||||||
|
|
||||||
return await new Promise((resolve) => {
|
return await new Promise((resolve) => {
|
||||||
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
|
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'immowelt', similarityCache);
|
||||||
fredy.execute().then((listing) => {
|
fredy.execute().then((listing) => {
|
||||||
expect(listing).to.be.a('array');
|
expect(listing).to.be.a('array');
|
||||||
|
const notificationObj = get();
|
||||||
const notificationObj = mockNotification.get();
|
|
||||||
expect(notificationObj).to.be.a('object');
|
expect(notificationObj).to.be.a('object');
|
||||||
expect(notificationObj.serviceName).to.equal('immowelt');
|
expect(notificationObj.serviceName).to.equal('immowelt');
|
||||||
|
|
||||||
notificationObj.payload.forEach((notify) => {
|
notificationObj.payload.forEach((notify) => {
|
||||||
/** check the actual structure **/
|
/** check the actual structure **/
|
||||||
expect(notify.id).to.be.a('string');
|
expect(notify.id).to.be.a('string');
|
||||||
expect(notify.price).to.be.a('string');
|
expect(notify.price).to.be.a('string');
|
||||||
expect(notify.size).to.be.a('string');
|
|
||||||
expect(notify.title).to.be.a('string');
|
expect(notify.title).to.be.a('string');
|
||||||
expect(notify.link).to.be.a('string');
|
expect(notify.link).to.be.a('string');
|
||||||
expect(notify.address).to.be.a('string');
|
expect(notify.address).to.be.a('string');
|
||||||
|
|
||||||
/** check the values if possible **/
|
/** check the values if possible **/
|
||||||
expect(notify.price).that.does.include('€');
|
if (notify.size != null && notify.size.trim().toLowerCase() !== 'k.a.') {
|
||||||
if (notify.size.trim().toLowerCase() !== 'k.a.') {
|
|
||||||
expect(notify.size).that.does.include('m²');
|
expect(notify.size).that.does.include('m²');
|
||||||
}
|
}
|
||||||
expect(notify.title).to.be.not.empty;
|
expect(notify.title).to.be.not.empty;
|
||||||
|
|||||||
@@ -1,45 +1,32 @@
|
|||||||
const similarityCache = require('../../lib/services/similarity-check/similarityCache');
|
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
|
||||||
const mockNotification = require('../mocks/mockNotification');
|
import { get } from '../mocks/mockNotification.js';
|
||||||
const providerConfig = require('./testProvider.json');
|
import { mockFredy, providerConfig } from '../utils.js';
|
||||||
const mockStore = require('../mocks/mockStore');
|
import chai from 'chai';
|
||||||
const proxyquire = require('proxyquire').noCallThru();
|
import * as provider from '../../lib/provider/kleinanzeigen.js';
|
||||||
const expect = require('chai').expect;
|
const expect = chai.expect;
|
||||||
const provider = require('../../lib/provider/kleinanzeigen');
|
|
||||||
|
|
||||||
describe('#kleinanzeigen testsuite()', () => {
|
describe('#kleinanzeigen testsuite()', () => {
|
||||||
after(() => {
|
after(() => {
|
||||||
similarityCache.stopCacheCleanup();
|
similarityCache.stopCacheCleanup();
|
||||||
});
|
});
|
||||||
it('should test kleinanzeigen provider', async () => {
|
it('should test kleinanzeigen provider', async () => {
|
||||||
|
const Fredy = await mockFredy();
|
||||||
provider.init(providerConfig.kleinanzeigen, [], []);
|
provider.init(providerConfig.kleinanzeigen, [], []);
|
||||||
const Fredy = proxyquire('../../lib/FredyRuntime', {
|
|
||||||
'./services/storage/listingsStorage': {
|
|
||||||
...mockStore,
|
|
||||||
},
|
|
||||||
'./notification/notify': mockNotification,
|
|
||||||
});
|
|
||||||
|
|
||||||
return await new Promise((resolve) => {
|
return await new Promise((resolve) => {
|
||||||
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
|
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'kleinanzeigen', similarityCache);
|
||||||
fredy.execute().then((listing) => {
|
fredy.execute().then((listing) => {
|
||||||
expect(listing).to.be.a('array');
|
expect(listing).to.be.a('array');
|
||||||
|
const notificationObj = get();
|
||||||
const notificationObj = mockNotification.get();
|
|
||||||
expect(notificationObj).to.be.a('object');
|
expect(notificationObj).to.be.a('object');
|
||||||
expect(notificationObj.serviceName).to.equal('kleinanzeigen');
|
expect(notificationObj.serviceName).to.equal('kleinanzeigen');
|
||||||
|
|
||||||
notificationObj.payload.forEach((notify) => {
|
notificationObj.payload.forEach((notify) => {
|
||||||
/** check the actual structure **/
|
/** check the actual structure **/
|
||||||
expect(notify.id).to.be.a('number');
|
expect(notify.id).to.be.a('number');
|
||||||
expect(notify.size).to.be.a('string');
|
|
||||||
expect(notify.title).to.be.a('string');
|
expect(notify.title).to.be.a('string');
|
||||||
expect(notify.link).to.be.a('string');
|
expect(notify.link).to.be.a('string');
|
||||||
expect(notify.price).to.be.a('string');
|
|
||||||
expect(notify.address).to.be.a('string');
|
expect(notify.address).to.be.a('string');
|
||||||
|
|
||||||
/** check the values if possible **/
|
/** check the values if possible **/
|
||||||
expect(notify.title).to.be.not.empty;
|
expect(notify.title).to.be.not.empty;
|
||||||
expect(notify.link).that.does.include('https://www.ebay-kleinanzeigen.de');
|
expect(notify.link).that.does.include('https://www.kleinanzeigen.de');
|
||||||
expect(notify.address).to.be.not.empty;
|
expect(notify.address).to.be.not.empty;
|
||||||
});
|
});
|
||||||
resolve();
|
resolve();
|
||||||
|
|||||||
@@ -1,41 +1,29 @@
|
|||||||
const similarityCache = require('../../lib/services/similarity-check/similarityCache');
|
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
|
||||||
const mockNotification = require('../mocks/mockNotification');
|
import { get } from '../mocks/mockNotification.js';
|
||||||
const providerConfig = require('./testProvider.json');
|
import { mockFredy, providerConfig } from '../utils.js';
|
||||||
const mockStore = require('../mocks/mockStore');
|
import chai from 'chai';
|
||||||
const proxyquire = require('proxyquire').noCallThru();
|
import * as provider from '../../lib/provider/neubauKompass.js';
|
||||||
const expect = require('chai').expect;
|
const expect = chai.expect;
|
||||||
const provider = require('../../lib/provider/neubauKompass');
|
|
||||||
|
|
||||||
describe('#neubauKompass testsuite()', () => {
|
describe('#neubauKompass testsuite()', () => {
|
||||||
after(() => {
|
after(() => {
|
||||||
similarityCache.stopCacheCleanup();
|
similarityCache.stopCacheCleanup();
|
||||||
});
|
});
|
||||||
provider.init(providerConfig.neubauKompass, [], []);
|
provider.init(providerConfig.neubauKompass, [], []);
|
||||||
const Fredy = proxyquire('../../lib/FredyRuntime', {
|
|
||||||
'./services/storage/listingsStorage': {
|
|
||||||
...mockStore,
|
|
||||||
},
|
|
||||||
'./notification/notify': mockNotification,
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should test neubauKompass provider', async () => {
|
it('should test neubauKompass provider', async () => {
|
||||||
|
const Fredy = await mockFredy();
|
||||||
return await new Promise((resolve) => {
|
return await new Promise((resolve) => {
|
||||||
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
|
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'neubauKompass', similarityCache);
|
||||||
fredy.execute().then((listing) => {
|
fredy.execute().then((listing) => {
|
||||||
expect(listing).to.be.a('array');
|
expect(listing).to.be.a('array');
|
||||||
|
const notificationObj = get();
|
||||||
const notificationObj = mockNotification.get();
|
|
||||||
expect(notificationObj.serviceName).to.equal('neubauKompass');
|
expect(notificationObj.serviceName).to.equal('neubauKompass');
|
||||||
|
|
||||||
notificationObj.payload.forEach((notify) => {
|
notificationObj.payload.forEach((notify) => {
|
||||||
expect(notify).to.be.a('object');
|
expect(notify).to.be.a('object');
|
||||||
|
|
||||||
/** check the actual structure **/
|
/** check the actual structure **/
|
||||||
expect(notify.id).to.be.a('string');
|
expect(notify.id).to.be.a('string');
|
||||||
expect(notify.title).to.be.a('string');
|
expect(notify.title).to.be.a('string');
|
||||||
expect(notify.link).to.be.a('string');
|
expect(notify.link).to.be.a('string');
|
||||||
expect(notify.address).to.be.a('string');
|
expect(notify.address).to.be.a('string');
|
||||||
|
|
||||||
/** check the values if possible **/
|
/** check the values if possible **/
|
||||||
expect(notify.title).to.be.not.empty;
|
expect(notify.title).to.be.not.empty;
|
||||||
expect(notify.link).that.does.include('https://www.neubaukompass.de');
|
expect(notify.link).that.does.include('https://www.neubaukompass.de');
|
||||||
|
|||||||
@@ -4,8 +4,12 @@
|
|||||||
"enabled": true,
|
"enabled": true,
|
||||||
"id": "einsAImmobilien"
|
"id": "einsAImmobilien"
|
||||||
},
|
},
|
||||||
|
"immobilienDe": {
|
||||||
|
"url": "https://www.immobilien.de/Wohnen/Suchergebnisse-51797.html?search._digest=true&search._filter=wohnen&search.flaeche_von=50&search.objektart=wohnung&search.preis_bis=1200&search.typ=mieten&search.umkreis=15&search.wo=district%3A2434%2C2695%2C2621%2C2700%2C2967%2C2734%2C2909%2C2955%2C2392%2C2746%2C2767%2C2982%2C2904%2C2612%2C2892%2C2587%2C2871%2C2975%2C2591%2C2887%2C2569%2C2640%2C2735&sort_col=*created_ts&sort_dir=desc",
|
||||||
|
"enabled": true
|
||||||
|
},
|
||||||
"immonet": {
|
"immonet": {
|
||||||
"url": "https://www.immonet.de/immobiliensuche/sel.do?pageoffset=1&listsize=100&objecttype=1&locationname=Düsseldorf&acid=&actype=&district=8717&district=8718&district=8719&district=8720&district=8721&district=8723&district=8724&district=8725&district=8727&district=8728&district=8729&district=8730&district=8731&district=8732&district=8733&district=8737&district=8738&district=8741&district=8745&district=8747&district=8750&district=8752&district=8754&district=8755&district=8756&district=8759&district=8760&district=8761&district=8763&district=8764&district=8765&ajaxIsRadiusActive=false&sortby=19&suchart=1&radius=0&pcatmtypes=1_1&pCatMTypeStoragefield=&parentcat=1&marketingtype=1&fromprice=&toprice=420000&fromarea=90&toarea=&fromplotarea=&toplotarea=&fromrooms=3&torooms=&objectcat=225&objectcat=18&objectcat=17&objectcat=12&objectcat=16&objectcat=181&objectcat=14&objectcat=15&objectcat=226&objectcat=13&wbs=-1&fromyear=&toyear=",
|
"url": "https://www.immonet.de/immobiliensuche/beta?pageoffset=1&listsize=100&objecttype=1&locationname=D%C3%BCsseldorf&acid=&actype=&district=8717&district=8718&district=8719&district=8720&district=8721&district=8723&district=8724&district=8725&district=8727&district=8728&district=8729&district=8730&district=8731&district=8732&district=8733&district=8737&district=8738&district=8741&district=8745&district=8747&district=8750&district=8752&district=8754&district=8755&district=8756&district=8759&district=8760&district=8761&district=8763&district=8764&district=8765&ajaxIsRadiusActive=false&sortby=19&suchart=1&radius=0&pcatmtypes=1_1&pCatMTypeStoragefield=&parentcat=1&marketingtype=1&fromprice=&toprice=420000&fromarea=90&toarea=&fromplotarea=&toplotarea=&fromrooms=3&torooms=&objectcat=225&objectcat=18&objectcat=17&objectcat=12&objectcat=16&objectcat=181&objectcat=14&objectcat=15&objectcat=226&objectcat=13&wbs=-1&fromyear=&toyear=",
|
||||||
"enabled": true
|
"enabled": true
|
||||||
},
|
},
|
||||||
"immowelt": {
|
"immowelt": {
|
||||||
@@ -16,12 +20,16 @@
|
|||||||
"url": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/wohnung-mieten?enteredFrom=one_step_search",
|
"url": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/wohnung-mieten?enteredFrom=one_step_search",
|
||||||
"enabled": true
|
"enabled": true
|
||||||
},
|
},
|
||||||
|
"immoswp": {
|
||||||
|
"url": "https://immo.swp.de/suchergebnisse?l=M%C3%BCnchen&r=0km&_multiselect_r=0km&ut=private&t=apartment%3Arental&a=de.muenchen&pf=&pt=&rf=0&rt=0&sf=50&st=&yf=&yt=&ff=&ft=&s=most_recently_updated_first&pa=&o=&ad=&u=",
|
||||||
|
"enabled": true
|
||||||
|
},
|
||||||
"kalaydo": {
|
"kalaydo": {
|
||||||
"url": "https://www.kalaydo.de/immobilien/eigentumswohnung-kaufen/o/duesseldorf/4/?attr_gt_estate_size_living_area=90.0&attr_gt_no_of_rooms=3.5&maxPrice=420000.00&radius=5&resultsPerPage=50&sorting=-date",
|
"url": "https://www.kalaydo.de/immobilien/eigentumswohnung-kaufen/o/duesseldorf/4/?attr_gt_estate_size_living_area=90.0&attr_gt_no_of_rooms=3.5&maxPrice=420000.00&radius=5&resultsPerPage=50&sorting=-date",
|
||||||
"enabled": true
|
"enabled": true
|
||||||
},
|
},
|
||||||
"kleinanzeigen": {
|
"kleinanzeigen": {
|
||||||
"url": "https://www.ebay-kleinanzeigen.de/s-immobilien/duesseldorf/anzeige:angebote/wohnung/k0c195l2068r5",
|
"url": "https://www.kleinanzeigen.de/s-immobilien/duesseldorf/anzeige:angebote/wohnung/k0c195l2068r5",
|
||||||
"enabled": true
|
"enabled": true
|
||||||
},
|
},
|
||||||
"neubauKompass": {
|
"neubauKompass": {
|
||||||
@@ -32,4 +40,4 @@
|
|||||||
"url": "https://www.wg-gesucht.de/wg-zimmer-in-Duesseldorf.30.0.1.0.html?offer_filter=1&noDeact=1&city_id=30&category=0&rent_type=0&rMax=5000",
|
"url": "https://www.wg-gesucht.de/wg-zimmer-in-Duesseldorf.30.0.1.0.html?offer_filter=1&noDeact=1&city_id=30&category=0&rent_type=0&rMax=5000",
|
||||||
"enabled": true
|
"enabled": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,14 +1,13 @@
|
|||||||
const utils = require('../../lib/utils');
|
import utils from '../../lib/utils.js';
|
||||||
const assert = require('assert');
|
import assert from 'assert';
|
||||||
const expect = require('chai').expect;
|
import chai from 'chai';
|
||||||
|
const expect = chai.expect;
|
||||||
const fakeWorkingHoursConfig = (from, to) => ({
|
const fakeWorkingHoursConfig = (from, to) => ({
|
||||||
workingHours: {
|
workingHours: {
|
||||||
to,
|
to,
|
||||||
from,
|
from,
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('utils', () => {
|
describe('utils', () => {
|
||||||
describe('#isOneOf()', () => {
|
describe('#isOneOf()', () => {
|
||||||
it('should be false', () => {
|
it('should be false', () => {
|
||||||
@@ -18,7 +17,6 @@ describe('utils', () => {
|
|||||||
assert.equal(utils.isOneOf('bla blub blubber', ['bla']), true);
|
assert.equal(utils.isOneOf('bla blub blubber', ['bla']), true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('#duringWorkingHoursOrNotSet()', () => {
|
describe('#duringWorkingHoursOrNotSet()', () => {
|
||||||
it('should be false', () => {
|
it('should be false', () => {
|
||||||
expect(utils.duringWorkingHoursOrNotSet(fakeWorkingHoursConfig('12:00', '13:00'), 0)).to.be.false;
|
expect(utils.duringWorkingHoursOrNotSet(fakeWorkingHoursConfig('12:00', '13:00'), 0)).to.be.false;
|
||||||
|
|||||||
@@ -1,39 +1,28 @@
|
|||||||
const similarityCache = require('../../lib/services/similarity-check/similarityCache');
|
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
|
||||||
const mockNotification = require('../mocks/mockNotification');
|
import { get } from '../mocks/mockNotification.js';
|
||||||
const providerConfig = require('./testProvider.json');
|
import { mockFredy, providerConfig } from '../utils.js';
|
||||||
const mockStore = require('../mocks/mockStore');
|
import chai from 'chai';
|
||||||
const proxyquire = require('proxyquire').noCallThru();
|
import * as provider from '../../lib/provider/wgGesucht.js';
|
||||||
const expect = require('chai').expect;
|
const expect = chai.expect;
|
||||||
const provider = require('../../lib/provider/wgGesucht');
|
|
||||||
|
|
||||||
describe('#wgGesucht testsuite()', () => {
|
describe('#wgGesucht testsuite()', () => {
|
||||||
after(() => {
|
after(() => {
|
||||||
similarityCache.stopCacheCleanup();
|
similarityCache.stopCacheCleanup();
|
||||||
});
|
});
|
||||||
provider.init(providerConfig.wgGesucht, [], []);
|
provider.init(providerConfig.wgGesucht, [], []);
|
||||||
const Fredy = proxyquire('../../lib/FredyRuntime', {
|
|
||||||
'./services/storage/listingsStorage': {
|
|
||||||
...mockStore,
|
|
||||||
},
|
|
||||||
'./notification/notify': mockNotification,
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should test wgGesucht provider', async () => {
|
it('should test wgGesucht provider', async () => {
|
||||||
|
const Fredy = await mockFredy();
|
||||||
return await new Promise((resolve) => {
|
return await new Promise((resolve) => {
|
||||||
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
|
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'wgGesucht', similarityCache);
|
||||||
fredy.execute().then((listing) => {
|
fredy.execute().then((listing) => {
|
||||||
expect(listing).to.be.a('array');
|
expect(listing).to.be.a('array');
|
||||||
const notificationObj = mockNotification.get();
|
const notificationObj = get();
|
||||||
expect(notificationObj.serviceName).to.equal('wgGesucht');
|
expect(notificationObj.serviceName).to.equal('wgGesucht');
|
||||||
notificationObj.payload.forEach((notify) => {
|
notificationObj.payload.forEach((notify) => {
|
||||||
expect(notify).to.be.a('object');
|
expect(notify).to.be.a('object');
|
||||||
|
|
||||||
/** check the actual structure **/
|
/** check the actual structure **/
|
||||||
|
|
||||||
expect(notify.id).to.be.a('string');
|
expect(notify.id).to.be.a('string');
|
||||||
expect(notify.title).to.be.a('string');
|
expect(notify.title).to.be.a('string');
|
||||||
expect(notify.details).to.be.a('string');
|
expect(notify.details).to.be.a('string');
|
||||||
expect(notify.size).to.be.a('string');
|
|
||||||
expect(notify.price).to.be.a('string');
|
expect(notify.price).to.be.a('string');
|
||||||
expect(notify.link).to.be.a('string');
|
expect(notify.link).to.be.a('string');
|
||||||
});
|
});
|
||||||
|
|||||||
36
test/queryStringMutator/queryStringMutator.test.js
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
import fs from 'fs';
|
||||||
|
import chai from 'chai';
|
||||||
|
import { readFile } from 'fs/promises';
|
||||||
|
import mutator from '../../lib/services/queryStringMutator.js';
|
||||||
|
import queryString from 'query-string';
|
||||||
|
const expect = chai.expect;
|
||||||
|
|
||||||
|
const data = await readFile(new URL('./testData.json', import.meta.url));
|
||||||
|
|
||||||
|
const testData = JSON.parse(data);
|
||||||
|
|
||||||
|
let _provider = await Promise.all(
|
||||||
|
fs.readdirSync('./lib/provider/').map(async (integPath) => await import(`../../lib/provider/${integPath}`))
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test test might look a bit weird at first, but listen stranger...
|
||||||
|
* It's not wise to compare 2 urls, as this means all url params must be in the expected order. This is however not
|
||||||
|
* guaranteed, as params (and their order) are totally variable.
|
||||||
|
*/
|
||||||
|
describe('queryStringMutator', () => {
|
||||||
|
it('should fix all urls', () => {
|
||||||
|
for (let test of testData) {
|
||||||
|
const provider = _provider.find((p) => p.metaInformation.id === test.id);
|
||||||
|
if (provider == null) {
|
||||||
|
throw new Error(`Cannot find provider for given id: ${test.id}`);
|
||||||
|
}
|
||||||
|
const fixedUrl = mutator(test.url, provider.config.sortByDateParam);
|
||||||
|
const expectedParams = queryString.parseUrl(test.shouldBecome);
|
||||||
|
const actualParams = queryString.parseUrl(fixedUrl);
|
||||||
|
//check if all new params are existing
|
||||||
|
expect(Object.keys(expectedParams.query)).to.include.members(Object.keys(actualParams.query));
|
||||||
|
expect(Object.values(expectedParams.query)).to.include.members(Object.values(actualParams.query));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
33
test/queryStringMutator/testData.json
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
[
|
||||||
|
{
|
||||||
|
"url": "https://www.immowelt.de/liste/40589/wohnungen/mieten?d=true&sd=DESC&sf=PRIMARY_PRICE_AMOUNT&sp=1",
|
||||||
|
"shouldBecome": "https://www.immowelt.de/liste/40589/wohnungen/mieten?d=true&sd=DESC&sf=TIMESTAMP&sp=1",
|
||||||
|
"id": "immowelt"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"url": "https://www.1a-immobilienmarkt.de/suchen/duesseldorf/wohnung-mieten.html?search=yes",
|
||||||
|
"shouldBecome": "https://www.1a-immobilienmarkt.de/suchen/duesseldorf/wohnung-mieten.html?search=yes&sort_type=newest",
|
||||||
|
"id": "einsAImmobilien"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"url": "https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Dusseldorf.30.1.1.0.html?sort_column=1&sort_order=0",
|
||||||
|
"shouldBecome": "https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Dusseldorf.30.1.1.0.html?sort_column=0&sort_order=0",
|
||||||
|
"id": "wgGesucht"
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
"url": "https://www.immonet.de/immobiliensuche/sel.do?sortby=0&suchart=1&objecttype=1&marketingtype=2&parentcat=1&locationname=d%C3%BCsseldorf",
|
||||||
|
"shouldBecome": "https://www.immonet.de/immobiliensuche/sel.do?sortby=19&suchart=1&objecttype=1&marketingtype=2&parentcat=1&locationname=d%C3%BCsseldorf",
|
||||||
|
"id": "immonet"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"url": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/wohnung-mieten",
|
||||||
|
"shouldBecome": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/wohnung-mieten?sorting=2",
|
||||||
|
"id": "immoscout"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"url": "https://www.neubaukompass.de/neubau-immobilien/berlin-region/",
|
||||||
|
"shouldBecome": "https://www.neubaukompass.de/neubau-immobilien/berlin-region/?Sortierung=Id&Richtung=DESC",
|
||||||
|
"id": "neubauKompass"
|
||||||
|
}
|
||||||
|
]
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
const SimilarityCacheEntry = require('../../lib/services/similarity-check/SimilarityCacheEntry');
|
import SimilarityCacheEntry from '../../lib/services/similarity-check/SimilarityCacheEntry.js';
|
||||||
const expect = require('chai').expect;
|
import chai from 'chai';
|
||||||
|
const expect = chai.expect;
|
||||||
describe('similarityCheck', () => {
|
describe('similarityCheck', () => {
|
||||||
describe('#similarityCheck()', () => {
|
describe('#similarityCheck()', () => {
|
||||||
it('should be false', () => {
|
it('should be false', () => {
|
||||||
|
|||||||
17
test/utils.js
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
import { readFile } from 'fs/promises';
|
||||||
|
import esmock from 'esmock';
|
||||||
|
import * as mockStore from './mocks/mockStore.js';
|
||||||
|
import { send } from './mocks/mockNotification.js';
|
||||||
|
|
||||||
|
export const providerConfig = JSON.parse(await readFile(new URL('./provider/testProvider.json', import.meta.url)));
|
||||||
|
|
||||||
|
export const mockFredy = async () => {
|
||||||
|
return await esmock('../lib/FredyRuntime', {
|
||||||
|
'../lib/services/storage/listingsStorage.js': {
|
||||||
|
...mockStore,
|
||||||
|
},
|
||||||
|
'../lib/notification/notify.js': {
|
||||||
|
send,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
};
|
||||||
@@ -1,97 +0,0 @@
|
|||||||
import React, { useEffect } from 'react';
|
|
||||||
|
|
||||||
import InsufficientPermission from './components/permission/InsufficientPermission';
|
|
||||||
import PermissionAwareRoute from './components/permission/PermissionAwareRoute';
|
|
||||||
import GeneralSettings from './views/generalSettings/GeneralSettings';
|
|
||||||
import ToastsContainer from './components/toasts/ToastContainer';
|
|
||||||
import JobMutation from './views/jobs/mutation/JobMutation';
|
|
||||||
import UserMutator from './views/user/mutation/UserMutator';
|
|
||||||
import ToastContext from './components/toasts/ToastContext';
|
|
||||||
import JobInsight from './views/jobs/insights/JobInsight';
|
|
||||||
import { useDispatch, useSelector } from 'react-redux';
|
|
||||||
import useToast from './components/toasts/useToast';
|
|
||||||
import { Switch, Redirect } from 'react-router-dom';
|
|
||||||
import Logout from './components/logout/Logout';
|
|
||||||
import Logo from './components/logo/Logo';
|
|
||||||
import Menu from './components/menu/Menu';
|
|
||||||
import Login from './views/login/Login';
|
|
||||||
import Users from './views/user/Users';
|
|
||||||
import Jobs from './views/jobs/Jobs';
|
|
||||||
import { Route } from 'react-router';
|
|
||||||
|
|
||||||
import './App.less';
|
|
||||||
|
|
||||||
export default function FredyApp() {
|
|
||||||
const dispatch = useDispatch();
|
|
||||||
const [showToast, onToastFinished, toasts] = useToast();
|
|
||||||
const [loading, setLoading] = React.useState(true);
|
|
||||||
const currentUser = useSelector((state) => state.user.currentUser);
|
|
||||||
|
|
||||||
useEffect(async () => {
|
|
||||||
await dispatch.provider.getProvider();
|
|
||||||
await dispatch.jobs.getJobs();
|
|
||||||
await dispatch.jobs.getProcessingTimes();
|
|
||||||
await dispatch.notificationAdapter.getAdapter();
|
|
||||||
await dispatch.user.getCurrentUser();
|
|
||||||
|
|
||||||
setLoading(false);
|
|
||||||
}, [currentUser?.userId]);
|
|
||||||
|
|
||||||
const needsLogin = () => {
|
|
||||||
return currentUser == null || Object.keys(currentUser).length === 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
const isAdmin = () => currentUser != null && currentUser.isAdmin;
|
|
||||||
|
|
||||||
const login = () => (
|
|
||||||
<Switch>
|
|
||||||
<Route name="Login" path={'/login'} component={Login} />
|
|
||||||
<Redirect from="*" to={'/login'} />
|
|
||||||
</Switch>
|
|
||||||
);
|
|
||||||
|
|
||||||
return loading ? null : needsLogin() ? (
|
|
||||||
login()
|
|
||||||
) : (
|
|
||||||
<ToastContext.Provider value={{ showToast }}>
|
|
||||||
<div className="app">
|
|
||||||
<div className="app__container">
|
|
||||||
<Logout />
|
|
||||||
<Logo width={190} white />
|
|
||||||
<Menu isAdmin={isAdmin()} />
|
|
||||||
<ToastsContainer toasts={toasts} onToastFinished={onToastFinished} />
|
|
||||||
<Switch>
|
|
||||||
<Route name="Insufficient Permission" path={'/403'} component={InsufficientPermission} />
|
|
||||||
<Route name="Create new Job" path={'/jobs/new'} component={JobMutation} />
|
|
||||||
<Route name="Edit a Job" path={'/jobs/edit/:jobId'} component={JobMutation} />
|
|
||||||
<Route name="Insights into a Job" path={'/jobs/insights/:jobId'} component={JobInsight} />
|
|
||||||
<Route name="Job overview" path={'/jobs'} component={Jobs} />
|
|
||||||
<PermissionAwareRoute
|
|
||||||
name="Create new User"
|
|
||||||
path="/users/new"
|
|
||||||
component={<UserMutator />}
|
|
||||||
currentUser={currentUser}
|
|
||||||
/>
|
|
||||||
<PermissionAwareRoute
|
|
||||||
name="Edit a user"
|
|
||||||
path="/users/edit/:userId"
|
|
||||||
component={<UserMutator />}
|
|
||||||
currentUser={currentUser}
|
|
||||||
/>
|
|
||||||
<PermissionAwareRoute name="Users" path="/users" component={<Users />} currentUser={currentUser} />
|
|
||||||
<PermissionAwareRoute
|
|
||||||
name="General Settings"
|
|
||||||
path="/generalSettings"
|
|
||||||
component={<GeneralSettings />}
|
|
||||||
currentUser={currentUser}
|
|
||||||
/>
|
|
||||||
|
|
||||||
<Redirect from="/" to={'/jobs'} />
|
|
||||||
</Switch>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</ToastContext.Provider>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
FredyApp.displayName = 'FredyApp';
|
|
||||||
95
ui/src/App.jsx
Normal file
@@ -0,0 +1,95 @@
|
|||||||
|
import React, { useEffect } from 'react';
|
||||||
|
|
||||||
|
import InsufficientPermission from './components/permission/InsufficientPermission';
|
||||||
|
import PermissionAwareRoute from './components/permission/PermissionAwareRoute';
|
||||||
|
import GeneralSettings from './views/generalSettings/GeneralSettings';
|
||||||
|
import JobMutation from './views/jobs/mutation/JobMutation';
|
||||||
|
import UserMutator from './views/user/mutation/UserMutator';
|
||||||
|
import JobInsight from './views/jobs/insights/JobInsight.jsx';
|
||||||
|
import { useDispatch, useSelector } from 'react-redux';
|
||||||
|
import { Switch, Redirect } from 'react-router-dom';
|
||||||
|
import Logout from './components/logout/Logout';
|
||||||
|
import Logo from './components/logo/Logo';
|
||||||
|
import Menu from './components/menu/Menu';
|
||||||
|
import Login from './views/login/Login';
|
||||||
|
import Users from './views/user/Users';
|
||||||
|
import Jobs from './views/jobs/Jobs';
|
||||||
|
import { Route } from 'react-router';
|
||||||
|
|
||||||
|
import './App.less';
|
||||||
|
|
||||||
|
export default function FredyApp() {
|
||||||
|
const dispatch = useDispatch();
|
||||||
|
const [loading, setLoading] = React.useState(true);
|
||||||
|
const currentUser = useSelector((state) => state.user.currentUser);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
async function init() {
|
||||||
|
await dispatch.user.getCurrentUser();
|
||||||
|
if (!needsLogin()) {
|
||||||
|
await dispatch.provider.getProvider();
|
||||||
|
await dispatch.jobs.getJobs();
|
||||||
|
await dispatch.jobs.getProcessingTimes();
|
||||||
|
await dispatch.notificationAdapter.getAdapter();
|
||||||
|
}
|
||||||
|
setLoading(false);
|
||||||
|
}
|
||||||
|
|
||||||
|
init();
|
||||||
|
}, [currentUser?.userId]);
|
||||||
|
|
||||||
|
const needsLogin = () => {
|
||||||
|
return currentUser == null || Object.keys(currentUser).length === 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
const isAdmin = () => currentUser != null && currentUser.isAdmin;
|
||||||
|
|
||||||
|
const login = () => (
|
||||||
|
<Switch>
|
||||||
|
<Route name="Login" path={'/login'} component={Login} />
|
||||||
|
<Redirect from="*" to={'/login'} />
|
||||||
|
</Switch>
|
||||||
|
);
|
||||||
|
|
||||||
|
return loading ? null : needsLogin() ? (
|
||||||
|
login()
|
||||||
|
) : (
|
||||||
|
<div className="app">
|
||||||
|
<div className="app__container">
|
||||||
|
<Logout />
|
||||||
|
<Logo width={190} white />
|
||||||
|
<Menu isAdmin={isAdmin()} />
|
||||||
|
<Switch>
|
||||||
|
<Route name="Insufficient Permission" path={'/403'} component={InsufficientPermission} />
|
||||||
|
<Route name="Create new Job" path={'/jobs/new'} component={JobMutation} />
|
||||||
|
<Route name="Edit a Job" path={'/jobs/edit/:jobId'} component={JobMutation} />
|
||||||
|
<Route name="Insights into a Job" path={'/jobs/insights/:jobId'} component={JobInsight} />
|
||||||
|
<Route name="Job overview" path={'/jobs'} component={Jobs} />
|
||||||
|
<PermissionAwareRoute
|
||||||
|
name="Create new User"
|
||||||
|
path="/users/new"
|
||||||
|
component={<UserMutator />}
|
||||||
|
currentUser={currentUser}
|
||||||
|
/>
|
||||||
|
<PermissionAwareRoute
|
||||||
|
name="Edit a user"
|
||||||
|
path="/users/edit/:userId"
|
||||||
|
component={<UserMutator />}
|
||||||
|
currentUser={currentUser}
|
||||||
|
/>
|
||||||
|
<PermissionAwareRoute name="Users" path="/users" component={<Users />} currentUser={currentUser} />
|
||||||
|
<PermissionAwareRoute
|
||||||
|
name="General Settings"
|
||||||
|
path="/generalSettings"
|
||||||
|
component={<GeneralSettings />}
|
||||||
|
currentUser={currentUser}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<Redirect from="/" to={'/jobs'} />
|
||||||
|
</Switch>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
FredyApp.displayName = 'FredyApp';
|
||||||
@@ -4,10 +4,40 @@
|
|||||||
width:100%;
|
width:100%;
|
||||||
|
|
||||||
&__container {
|
&__container {
|
||||||
width: 100%;
|
|
||||||
|
|
||||||
padding: 1rem 1rem;
|
padding: 1rem 1rem;
|
||||||
background-color: #3f3e3ef5;
|
color: var(--semi-color-text-0);
|
||||||
color: #f1f1f1;
|
background-color: #232429;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.ui.inverted.segment{
|
||||||
|
background: #31303078!important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ui.black.label, .ui.black.labels .label {
|
||||||
|
background-color: #31303078!important;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:link {
|
||||||
|
color: #54a9ff;
|
||||||
|
background-color: transparent;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:visited {
|
||||||
|
color: #54a9ff;
|
||||||
|
background-color: transparent;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
color: #54a9ff;
|
||||||
|
background-color: transparent;
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:active {
|
||||||
|
color: #54a9ff;
|
||||||
|
background-color: transparent;
|
||||||
|
text-decoration: underline;
|
||||||
}
|
}
|
||||||
@@ -4,19 +4,24 @@ import { reduxStore } from './services/rematch/store';
|
|||||||
import { HashRouter } from 'react-router-dom';
|
import { HashRouter } from 'react-router-dom';
|
||||||
import { createHashHistory } from 'history';
|
import { createHashHistory } from 'history';
|
||||||
import { Provider } from 'react-redux';
|
import { Provider } from 'react-redux';
|
||||||
import ReactDOM from 'react-dom';
|
import { createRoot } from 'react-dom/client';
|
||||||
|
import en_US from '@douyinfe/semi-ui/lib/es/locale/source/en_US';
|
||||||
|
import { LocaleProvider } from '@douyinfe/semi-ui';
|
||||||
|
|
||||||
|
const container = document.getElementById('fredy');
|
||||||
|
const root = createRoot(container);
|
||||||
const history = createHashHistory();
|
const history = createHashHistory();
|
||||||
|
|
||||||
import App from './App';
|
import App from './App';
|
||||||
|
|
||||||
import './Index.less';
|
import './Index.less';
|
||||||
|
|
||||||
ReactDOM.render(
|
root.render(
|
||||||
<Provider store={reduxStore}>
|
<Provider store={reduxStore}>
|
||||||
<HashRouter history={history}>
|
<HashRouter history={history}>
|
||||||
<App />
|
<LocaleProvider locale={en_US}>
|
||||||
|
<App />
|
||||||
|
</LocaleProvider>
|
||||||
</HashRouter>
|
</HashRouter>
|
||||||
</Provider>,
|
</Provider>
|
||||||
document.getElementById('fredy')
|
|
||||||
);
|
);
|
||||||
@@ -2,5 +2,14 @@ body, html {
|
|||||||
margin: 0;
|
margin: 0;
|
||||||
height: 100%;
|
height: 100%;
|
||||||
width: 100%;
|
width: 100%;
|
||||||
background-color: #3f3e3ef5;
|
background-color: #232429;
|
||||||
|
}
|
||||||
|
|
||||||
|
.semi-table-row-head{
|
||||||
|
background-color: #2b2b2b !important;
|
||||||
|
color: #fff !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.semi-table-row-cell {
|
||||||
|
background-color: #333333 !important;
|
||||||
}
|
}
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
import React from 'react';
|
|
||||||
import { Header } from 'semantic-ui-react';
|
|
||||||
|
|
||||||
import './Headline.less';
|
|
||||||
|
|
||||||
export default function Headline({ text, size = 'medium', className = '' } = {}) {
|
|
||||||
return (
|
|
||||||
<Header className={`headline ${className}`} size={size}>
|
|
||||||
{text}
|
|
||||||
</Header>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
11
ui/src/components/headline/Headline.jsx
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import { Typography } from '@douyinfe/semi-ui';
|
||||||
|
|
||||||
|
export default function Headline({ text, size = 3 } = {}) {
|
||||||
|
const { Title } = Typography;
|
||||||
|
return (
|
||||||
|
<Title heading={size} style={{ marginBottom: '1rem' }}>
|
||||||
|
{text}
|
||||||
|
</Title>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
.headline{
|
|
||||||
color: #f1f1f1 !important;
|
|
||||||
}
|
|
||||||
@@ -1,20 +1,20 @@
|
|||||||
import React from 'react';
|
import React from 'react';
|
||||||
import { Button } from 'semantic-ui-react';
|
import { Button } from '@douyinfe/semi-ui';
|
||||||
import { xhrPost } from '../../services/xhr';
|
import { xhrPost } from '../../services/xhr';
|
||||||
|
import { IconUser } from '@douyinfe/semi-icons';
|
||||||
const Logout = function Logout() {
|
const Logout = function Logout() {
|
||||||
return (
|
return (
|
||||||
<Button
|
<Button
|
||||||
content="Logout"
|
icon={<IconUser />}
|
||||||
labelPosition="left"
|
type="danger"
|
||||||
icon="user"
|
theme="solid"
|
||||||
size="mini"
|
|
||||||
onClick={async () => {
|
onClick={async () => {
|
||||||
await xhrPost('/api/login/logout');
|
await xhrPost('/api/login/logout');
|
||||||
location.reload();
|
location.reload();
|
||||||
}}
|
}}
|
||||||
negative
|
>
|
||||||
/>
|
Logout
|
||||||
|
</Button>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
import React from 'react';
|
|
||||||
import { useHistory } from 'react-router-dom';
|
|
||||||
import { Icon, Menu } from 'semantic-ui-react';
|
|
||||||
|
|
||||||
import './Menu.less';
|
|
||||||
import { useLocation } from 'react-router';
|
|
||||||
|
|
||||||
const TopMenu = function TopMenu({ isAdmin }) {
|
|
||||||
const history = useHistory();
|
|
||||||
const location = useLocation();
|
|
||||||
|
|
||||||
const isActiveRoute = (name) => location.pathname.indexOf(name) !== -1;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Menu pointing secondary className="topMenu">
|
|
||||||
<Menu.Item
|
|
||||||
name="jobs"
|
|
||||||
active={isActiveRoute('jobs')}
|
|
||||||
className={isActiveRoute('jobs') ? 'topMenu__active' : 'topMenu__item'}
|
|
||||||
onClick={() => history.push('/jobs')}
|
|
||||||
>
|
|
||||||
<Icon name="search" /> Job Configuration
|
|
||||||
</Menu.Item>
|
|
||||||
|
|
||||||
{isAdmin && (
|
|
||||||
<Menu.Item
|
|
||||||
name="user"
|
|
||||||
active={isActiveRoute('users')}
|
|
||||||
className={isActiveRoute('users') ? 'topMenu__active' : 'topMenu__item'}
|
|
||||||
onClick={() => history.push('/users')}
|
|
||||||
>
|
|
||||||
<Icon name="user" /> User configuration
|
|
||||||
</Menu.Item>
|
|
||||||
)}
|
|
||||||
|
|
||||||
{isAdmin && (
|
|
||||||
<Menu.Item
|
|
||||||
name="general"
|
|
||||||
active={isActiveRoute('general')}
|
|
||||||
className={isActiveRoute('general') ? 'topMenu__active' : 'topMenu__item'}
|
|
||||||
onClick={() => history.push('/generalSettings')}
|
|
||||||
>
|
|
||||||
<Icon name="cog" /> General Settings
|
|
||||||
</Menu.Item>
|
|
||||||
)}
|
|
||||||
</Menu>
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
export default TopMenu;
|
|
||||||
55
ui/src/components/menu/Menu.jsx
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import { useHistory } from 'react-router-dom';
|
||||||
|
import { Tabs, TabPane } from '@douyinfe/semi-ui';
|
||||||
|
|
||||||
|
import { useLocation } from 'react-router';
|
||||||
|
import { IconUser, IconTerminal, IconSetting } from '@douyinfe/semi-icons';
|
||||||
|
|
||||||
|
function parsePathName(name) {
|
||||||
|
const split = name.split('/').filter((s) => s.length !== 0);
|
||||||
|
return '/' + split[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
const TopMenu = function TopMenu({ isAdmin }) {
|
||||||
|
const history = useHistory();
|
||||||
|
const location = useLocation();
|
||||||
|
return (
|
||||||
|
<Tabs type="line" activeKey={parsePathName(location.pathname)} onTabClick={(key) => history.push(key)}>
|
||||||
|
<TabPane
|
||||||
|
itemKey="/jobs"
|
||||||
|
tab={
|
||||||
|
<span>
|
||||||
|
<IconTerminal />
|
||||||
|
Jobs
|
||||||
|
</span>
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
|
||||||
|
{isAdmin && (
|
||||||
|
<TabPane
|
||||||
|
itemKey="/users"
|
||||||
|
tab={
|
||||||
|
<span>
|
||||||
|
<IconUser />
|
||||||
|
User
|
||||||
|
</span>
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{isAdmin && (
|
||||||
|
<TabPane
|
||||||
|
itemKey="/generalSettings"
|
||||||
|
tab={
|
||||||
|
<span>
|
||||||
|
<IconSetting />
|
||||||
|
General
|
||||||
|
</span>
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</Tabs>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export default TopMenu;
|
||||||