Compare commits

...

41 Commits

Author SHA1 Message Date
weakmap@gmail.com
dd8d88404a next release version 2025-08-30 21:22:09 +02:00
Christian Kellner
f0b146fd7f Adding images to scraping data (#157)
* Fredy now supports pulling the main Image from the listing and send it together with the usual information
2025-08-30 21:21:34 +02:00
Christian Kellner
da743c8279 only check js files 2025-08-26 08:00:33 +02:00
Christian Kellner
aeffddc5a4 upgrade dependencies 2025-08-25 21:14:45 +02:00
Christian Kellner
3f92b5b099 next version 2025-08-25 21:12:23 +02:00
Christian Kellner
34317107be improve feature and bug templates 2025-08-25 21:11:30 +02:00
Christian Kellner
0bf211cb93 improve feature and bug templates 2025-08-25 21:10:01 +02:00
Christian Kellner
44a84cc3f2 improve feature and bug templates 2025-08-25 21:07:56 +02:00
Christian Kellner
d1566cf689 improve feature and bug templates 2025-08-25 20:56:10 +02:00
Christian Kellner
36f1bddedd deny blank issues 2025-08-25 20:51:07 +02:00
Christian Kellner
220df3f11a improve bug/feature templates 2025-08-25 20:47:16 +02:00
Nic
3a54ab0e31 Fix typo in test import (#154)
* Fix typo in test import

* Rename test file
2025-08-25 20:42:40 +02:00
Alexander Roidl
963a309889 Inline architecture diagram in README (#152) 2025-08-02 07:18:19 +02:00
Alexander Roidl
b66f873a91 Telegram request throttling per chat ID (#147)
* feat: telegram request throttling per chat id

* feat: telegram chat throttle cleanup

* feat: telegram throttled chats cleanup
This reverts commit 6c1786dcc2.
2025-08-01 10:03:40 +02:00
Alexander Roidl
ae4b6d1f40 Mobile view and wording (#151)
* feat(ui): simplified titles and adjusted some wording

* style(ui): simplified some views for mobile

* style(ui): make job table responsive for mobile

* style(ui): login button gap

* style(ui): dont hide mobile columns

* fix: method return type
2025-08-01 09:51:42 +02:00
Alexander Roidl
2b36f868e7 Project-wide linting and formatting (#150)
* chore: configure project-wide linting and formatting

* chore: run lint autofix and formatter
2025-07-26 20:42:58 +02:00
Christian Kellner
206f768b41 next version 2025-07-25 13:21:12 +02:00
Alexander Roidl
2302f69ff3 Rename NPM startup scripts (#144)
* feat: rename npm start scripts
2025-07-25 13:13:04 +02:00
Alexander Roidl
9bb33e723a Workflow to check sourcecode's linting and formatting (#146)
* ci: workflow to check sourcecode

* fix: make workflow to check source fail for incorrect linting/formatting

* ci: change step name for workflow to check sourcecode
2025-07-23 08:58:43 +02:00
Alexander Roidl
cca1463a68 chore: run formatter (#145) 2025-07-23 08:47:26 +02:00
Alexander Roidl
314b1818d7 Formatting and linting pre-commit hook (#143) 2025-07-22 21:39:52 +02:00
Christian Kellner
25cc7fb650 next release version 2025-07-22 20:01:01 +02:00
Alexander Roidl
78df4b21a6 Remove leading commas from listings in Telegram messages (#142) 2025-07-22 19:58:16 +02:00
weakmap@gmail.com
d89b078237 lol 2025-07-19 22:41:30 +02:00
weakmap@gmail.com
395199a4a2 fixing duplicate provider removal / ugrade dependencies 2025-07-19 20:10:19 +02:00
weakmap@gmail.com
c2680fe49f next release version 2025-06-14 19:26:17 +02:00
weakmap@gmail.com
2b862b2d98 fixing blacklist 2025-06-14 19:25:52 +02:00
weakmap@gmail.com
9065448b6b upgrade dependencies 2025-06-14 19:12:55 +02:00
weakmap@gmail.com
b9f49cb5b2 upgrade dependencies 2025-06-14 19:06:27 +02:00
weakmap@gmail.com
53121742c2 improving error message 2025-06-14 19:03:23 +02:00
Christian Kellner
1a3eae0390 next version 2025-06-04 09:47:42 +02:00
Christian Kellner
a42905d63f fixing docker ignore issue 2025-06-04 09:46:07 +02:00
Christian Kellner
9917491728 Merge branch 'master' of github.com:orangecoding/fredy 2025-06-04 09:29:50 +02:00
Christian Kellner
f032e6a724 test: verify unrelated text yields no similarity (#130) 2025-06-04 09:15:53 +02:00
Christian Kellner
111c154ae3 Fix job ownership verification (#132) 2025-06-04 09:15:36 +02:00
Christian Kellner
2194ffe0f4 Fix typo in README (#133) 2025-06-04 09:15:15 +02:00
Christian Kellner
cfa25fc0e0 docs: fix adapter sentence (#131) 2025-06-04 09:14:57 +02:00
Christian Kellner
d50dd61f3e Merge branch 'master' of github.com:orangecoding/fredy 2025-06-04 09:12:00 +02:00
Christian Kellner
31e7f77bde uprade restana & vite 2025-05-27 12:01:26 +02:00
Christian Kellner
a418d64f1a uprade dependencies 2025-05-27 11:51:57 +02:00
Christian Kellner
d099872950 Update README.md 2025-05-26 13:23:36 +02:00
113 changed files with 3109 additions and 2541 deletions

View File

@@ -3,9 +3,7 @@
[ [
"@babel/preset-env", "@babel/preset-env",
{ {
"exclude": [ "exclude": ["transform-regenerator"]
"transform-regenerator"
]
} }
], ],
[ [
@@ -15,4 +13,4 @@
} }
] ]
] ]
} }

View File

@@ -2,5 +2,6 @@ node_modules/
npm-debug.log npm-debug.log
test/ test/
db/ db/
conf/
.git/ .git/
.github/ .github/

3
.eslintignore Normal file
View File

@@ -0,0 +1,3 @@
/ui/public
/db/
/conf/

View File

@@ -277,6 +277,5 @@ module.exports = {
// Prevent passing of children as props // Prevent passing of children as props
// 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',
}, },
}; };

73
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@@ -0,0 +1,73 @@
name: Bug Report
description: Help us improve Fredy by reporting a bug
title: "[Bug]: "
labels: [bug]
assignees: []
body:
- type: textarea
id: description
attributes:
label: Bug Description
description: Provide a clear and concise description of the bug.
placeholder: e.g. "Fredy crashes when I click on Save."
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: List the steps to reproduce the issue.
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: "It should save without errors."
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
placeholder: "Fredy crashed with error XYZ."
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots / Logs
description: Add screenshots or paste log output to help explain the problem.
placeholder: "Drag and drop screenshots here, or paste logs."
validations:
required: false
- type: input
id: environment
attributes:
label: Environment
description: Provide details about your environment.
placeholder: "OS: macOS 15, Browser: Chrome 124, App version: 1.2.3"
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any other context about the problem here.
placeholder: "Any other information that might help..."
validations:
required: false

View File

@@ -1,24 +0,0 @@
---
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.

1
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1 @@
blank_issues_enabled: false

51
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@@ -0,0 +1,51 @@
name: Feature Request
description: Suggest an improvement or new idea for Fredy
title: "[Feature]: "
labels: [enhancement]
assignees: []
body:
- type: textarea
id: problem
attributes:
label: Related Problem
description: Is your feature request related to a problem? Describe it clearly.
placeholder: "Example: Its difficult to do X when Y happens..."
validations:
required: false
- type: textarea
id: solution
attributes:
label: Proposed Feature
description: Describe the feature you would like to see.
placeholder: "I would like Fredy to automatically..."
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: List any alternative solutions or workarounds youve tried or thought about.
placeholder: "Instead of this, I also considered..."
validations:
required: false
- type: textarea
id: benefits
attributes:
label: Benefits
description: Explain how this feature would improve Fredy or it's user experience.
placeholder: "This would save users time by..."
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any other context, examples, or screenshots that might help clarify your idea.
placeholder: "Any other relevant information..."
validations:
required: false

View File

@@ -1,20 +0,0 @@
---
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.

26
.github/workflows/check_source.yml vendored Normal file
View File

@@ -0,0 +1,26 @@
name: Check the source code
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
check_source_code:
name: Check the source code
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
cache: 'yarn'
- name: Install dependencies
run: yarn install
- name: Check formatting
run: yarn format:check
- name: Lint
run: yarn lint

View File

@@ -1,8 +1,8 @@
name: "Close stale issues and PRs" name: Close stale issues and PRs
on: on:
schedule: schedule:
- cron: '0 0 * * *' # Daily - cron: '0 0 * * *' # Daily
jobs: jobs:
stale: stale:
@@ -12,10 +12,10 @@ jobs:
with: with:
days-before-stale: 30 days-before-stale: 30
days-before-close: 7 days-before-close: 7
stale-issue-message: "This issue has been automatically marked as stale due to inactivity." stale-issue-message: 'This issue has been automatically marked as stale due to inactivity.'
stale-pr-message: "This PR has been automatically marked as stale due to inactivity." stale-pr-message: 'This PR has been automatically marked as stale due to inactivity.'
close-issue-message: "Closing this issue due to prolonged inactivity." close-issue-message: 'Closing this issue due to prolonged inactivity.'
close-pr-message: "Closing this PR due to prolonged inactivity." close-pr-message: 'Closing this PR due to prolonged inactivity.'
exempt-issue-labels: "keep-open" exempt-issue-labels: 'keep-open'
exempt-pr-labels: "keep-open" exempt-pr-labels: 'keep-open'
only: "pulls" only: 'pulls'

View File

@@ -13,8 +13,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Setup Node.js - uses: actions/setup-node@v4
uses: actions/setup-node@v4
with: with:
node-version: 20 node-version: 20
cache: 'yarn' cache: 'yarn'

6
.prettierignore Normal file
View File

@@ -0,0 +1,6 @@
/ui/public
/db/
/conf/
# TODO re-write from scratch or fix all html structure issues
/lib/notification/emailTemplate/template.hbs

4
.prettierrc Normal file
View File

@@ -0,0 +1,4 @@
{
"singleQuote": true,
"printWidth": 120
}

View File

@@ -1,34 +1,42 @@
Newer release changelog see https://github.com/orangecoding/fredy/releases Newer release changelog see https://github.com/orangecoding/fredy/releases
------------ ---
###### [V5.5.0] ###### [V5.5.0]
- Upgrading dependencies - Upgrading dependencies
- fixing provider - fixing provider
- allow multiple instances of 1 provider - allow multiple instances of 1 provider
- __BREAKING__: Minimum node version is now 16 - **BREAKING**: Minimum node version is now 16
###### [V5.4.6] ###### [V5.4.6]
- Adding Instana node.js monitoring - Adding Instana node.js monitoring
- -
###### [V5.4.5] ###### [V5.4.5]
- Adding Instana node.js monitoring
- Adding Instana node.js monitoring
###### [V5.4.4] ###### [V5.4.4]
- Add support for Immo Südwest Presse (immo.swp.de) - Add support for Immo Südwest Presse (immo.swp.de)
- Telegram: Use job name instead of ID and link in title - 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 - Fix race condition if user ID is in session but not in user store
- Allow visiting the original provider URL - Allow visiting the original provider URL
###### [V5.4.3] ###### [V5.4.3]
- re-writing readme - re-writing readme
- improving docker build - improving docker build
- using github's actions to build docker and test automatically - using github's actions to build docker and test automatically
###### [V5.4.2] ###### [V5.4.2]
- Fixing prod build - Fixing prod build
###### [V5.4.1] ###### [V5.4.1]
- Upgrading dependencies - Upgrading dependencies
- Provider urls are now automagically been changed to include the correct sort order for search results - Provider urls are now automagically been changed to include the correct sort order for search results
@@ -39,36 +47,44 @@ results, thus cannot report them. This release fixes it by adding the necessary
``` ```
###### [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
- Fixing Immowelt scraping - Fixing Immowelt scraping
###### [V5.2.0] ###### [V5.2.0]
- Upgrading dependencies - Upgrading dependencies
- Adding new similarity check layer (Duplicates are being removed now) - Adding new similarity check layer (Duplicates are being removed now)
- Adding paging for search results - Adding paging for search results
###### [V5.1.0] ###### [V5.1.0]
- Upgrading dependencies - Upgrading dependencies
- NodeJS 12.13 is now the minimum supported version - NodeJS 12.13 is now the minimum supported version
- Adding general settings as new configuration page to ui - Adding general settings as new configuration page to ui
- Adding new feature working hours - Adding new feature working hours
###### [V5.0.0] ###### [V5.0.0]
- Upgrading dependencies - Upgrading dependencies
- NodeJS 12 is now the minimum supported version - NodeJS 12 is now the minimum supported version
###### [V4.0.0] ###### [V4.0.0]
Bringing back Immoscout :tada: Bringing back Immoscout :tada:
###### [V3.0.0] ###### [V3.0.0]
This is basically a re-write, your old config file will not be compatible anymore. Please re-created your search jobs This is basically a re-write, your old config file will not be compatible anymore. Please re-created your search jobs
on the new ui and use the values from your previous config file if needed. on the new ui and use the values from your previous config file if needed.
``` ```
- We're getting rid of manual config changes, Fredy, now ships with a UI so that it's easy for you to create and edit jobs - We're getting rid of manual config changes, Fredy, now ships with a UI so that it's easy for you to create and edit jobs
``` ```
###### [V2.0.0] ###### [V2.0.0]
``` ```
- Fredy can now run multiple search job on one instance - Fredy can now run multiple search job on one instance
- Changed lot's of the structure of Fredy to make this happen - Changed lot's of the structure of Fredy to make this happen

View File

@@ -2,8 +2,8 @@
If you want to contribute, please make sure you've executed the tests. If you want to contribute, please make sure you've executed the tests.
### How to write new provider? ### How to write new provider?
- create the provider filer under `/lib/provider` - create the provider filer under `/lib/provider`
- create a test under /test and make sure it is running successfully - create a test under /test and make sure it is running successfully
@@ -13,7 +13,7 @@ let appliedBlackList = [];
//normalize incoming values //normalize incoming values
function normalize(o) { function normalize(o) {
const id = parseInt(o.id.substring(o.id.indexOf('_') + 1, o.id.length)); const id = parseInt(o.id.substring(o.id.indexOf('_') + 1, o.id.length));
return Object.assign(o, { id }); return Object.assign(o, { id });
} }
@@ -27,7 +27,7 @@ function applyBlacklist(o) {
const config = { const config = {
url: null, url: null,
//this is the container wrapping the search listings //this is the container wrapping the search listings
crawlContainer: '#result-list-stage .item', crawlContainer: '#result-list-stage .item',
crawlFields: { crawlFields: {
id: '@id', id: '@id',
@@ -49,7 +49,7 @@ exports.init = (sourceConfig, blacklist) => {
appliedBlackList = blacklist || []; appliedBlackList = blacklist || [];
}; };
//ths //ths
exports.metaInformation = { exports.metaInformation = {
name: 'your provider name', name: 'your provider name',
baseUrl: 'https://www.yourprovider.de/', baseUrl: 'https://www.yourprovider.de/',
@@ -57,11 +57,10 @@ exports.metaInformation = {
}; };
exports.config = config; exports.config = config;
``` ```
### How to write new notification adapter? ### How to write new notification adapter?
- create the provider filer under `/lib/notification/adapter` - create the provider filer under `/lib/notification/adapter`
- create a description of the provider under `/lib/notification/adapter/*.md`. Make sure the name of the md file is equal to the notification adapter - create a description of the provider under `/lib/notification/adapter/*.md`. Make sure the name of the md file is equal to the notification adapter
@@ -72,48 +71,48 @@ const Slack = require('slack');
const msg = Slack.chat.postMessage; const msg = Slack.chat.postMessage;
const { markdown2Html } = require('../../services/markdown'); const { markdown2Html } = require('../../services/markdown');
//as a parameter, you will always get the serviceName, newListings and all the values, that //as a parameter, you will always get the serviceName, newListings and all the values, that
//you have defined exports.config.fields. (This is being used for rendering in the frontend) //you have defined exports.config.fields. (This is being used for rendering in the frontend)
exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => { 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) => {
//tho whatever needs to be done to send the data to the receiver, make sure the format is human readable //tho whatever needs to be done to send the data to the receiver, make sure the format is human readable
}); });
}; };
exports.config = { exports.config = {
id: __filename.slice(__dirname.length + 1, -3), id: __filename.slice(__dirname.length + 1, -3),
name: 'someUniqueName, used in the frontend', name: 'someUniqueName, used in the frontend',
//this readme is rendered in the frontend to explain how to use this //this readme is rendered in the frontend to explain how to use this
readme: markdown2Html('lib/notification/adapter/slack.md'), readme: markdown2Html('lib/notification/adapter/slack.md'),
description: 'Some description text rendered on the notification page', description: 'Some description text rendered on the notification page',
fields: { fields: {
token: { token: {
//type can be text/number/boolean //type can be text/number/boolean
type: 'text', type: 'text',
label: 'Token', label: 'Token',
description: 'The token needed to send notifications to slack.', description: 'The token needed to send notifications to slack.',
},
channel: {
type: 'channel',
label: 'Channel',
description: 'The channel where fredy should send notifications to.',
},
}, },
channel: {
type: 'channel',
label: 'Channel',
description: 'The channel where fredy should send notifications to.',
},
},
}; };
``` ```
#### Running Tests #### Running Tests
If you've written a new provider you are an awesome person. If you now write tests for it, you are even more awesome. And who doesn't want to be more awesome right?
If you've written a new provider you are an awesome person. If you now write tests for it, you are even more awesome. And who doesn't want to be more awesome, right?
#### Codestyle #### Codestyle
I'm using Eslint to maintain quote style and quality. Do not skip it...
##### To do before merging: I'm using ESLint to maintain quote style and quality. Do not skip it...
- executed tests? (`pnpm test`) ##### To-do before merging:
- sure the changes are useful for everybody? Or is it maybe a custom modification just for your case?
- Have you executed the tests? (`yarn test`)
- Are you sure the changes are useful for everybody? Or is it maybe a custom modification just for your case?
_Thanks!_ :heart: _Thanks!_ :heart:

View File

@@ -11,16 +11,16 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true \
PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium
# Copy lockfiles first to leverage cache for dependencies # Copy lockfiles first to leverage cache for dependencies
COPY package.json yarn.lock ./ COPY package.json yarn.lock .
# Set Yarn timeout, install dependencies and PM2 globally # Set Yarn timeout, install dependencies and PM2 globally
RUN yarn config set network-timeout 600000 \ RUN yarn config set network-timeout 600000 \
&& yarn install --frozen-lockfile \ && yarn --frozen-lockfile \
&& yarn global add pm2 && yarn global add pm2
# Copy application source and build production assets # Copy application source and build production assets
COPY . ./ COPY . .
RUN yarn run prod RUN yarn build:frontend
# Prepare runtime directories and symlinks for data and config # Prepare runtime directories and symlinks for data and config
RUN mkdir -p /db /conf \ RUN mkdir -p /db /conf \

107
README.md
View File

@@ -1,16 +1,15 @@
<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">
![Build Status](https://github.com/orangecoding/fredy/actions/workflows/test.yml/badge.svg) [![Create and publish Docker image](https://github.com/orangecoding/fredy/actions/workflows/docker.yml/badge.svg)](https://github.com/orangecoding/fredy/actions/workflows/docker.yml) ![Test](https://github.com/orangecoding/fredy/actions/workflows/test.yml/badge.svg) [![Create and publish Docker image](https://github.com/orangecoding/fredy/actions/workflows/docker.yml/badge.svg)](https://github.com/orangecoding/fredy/actions/workflows/docker.yml) ![Check the sourcecode](https://github.com/orangecoding/fredy/actions/workflows/check_source.yml/badge.svg)
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. 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 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. _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_ 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). 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).
<a href="https://www.producthunt.com/posts/fredy-find-real-estates-damn-easy?embed=true&utm_source=badge-featured&utm_medium=badge&utm_source=badge-fredy&#0045;find&#0045;real&#0045;estates&#0045;damn&#0045;easy" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=965690&theme=light&t=1747292331626" alt="Fredy&#0032;&#0045;&#0032;Find&#0032;Real&#0032;Estates&#0032;Damn&#0032;EasY&#0032; - Your&#0032;personal&#0032;real&#0032;estate&#0032;search&#0032;bot | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a> # Sponsorship [![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/orangecoding)
# Sponsorship [![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](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. 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.
[![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport) [![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)
@@ -18,17 +17,20 @@ If you like my work, consider becoming a sponsor. I'm not expecting anybody to p
_Fredy_ is supported by JetBrains under Open Source Support Program _Fredy_ is supported by JetBrains under Open Source Support Program
## Demo ## Demo
If you want to try out _Fredy_, you can access the demo version [here](https://fredy.orange-coding.net) 🤘 If you want to try out _Fredy_, you can access the demo version [here](https://fredy.orange-coding.net) 🤘
## Usage ## Usage
- Make sure to use Node.js 20 or above - Make sure to use Node.js 20 or above
- Run the following commands: - Run the following commands:
```ssh ```ssh
yarn (or npm install) yarn
yarn run prod yarn run start:backend
yarn run start yarn run start:frontend
``` ```
_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. _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">
@@ -40,63 +42,118 @@ _Fredy_ will start with the default port, set to `9998`. You can access _Fredy_
</p> </p>
## Understanding the fundamentals ## Understanding the fundamentals
There are 3 important parts in Fredy, that you need to understand to leverage the full power of _Fredy_. There are 3 important parts in Fredy, that you need to understand to leverage the full power of _Fredy_.
#### Provider #### Provider
_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. _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. 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!** **It is important that you order the search results by date, so that _Fredy_ always picks the latest results first!**
#### Adapter #### 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.
_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. An adapter dictates 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 adapters and providers. _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 is 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 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. 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 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. 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 development mode ### Running Fredy in development mode
To run _Fredy_ in development mode, you need to run the backend & frontend separately.
Start the backend with: Start the backend with:
```shell ```shell
yarn run start yarn run start:backend:dev
``` ```
For the frontend, run: For the frontend, run:
```shell ```shell
yarn run dev yarn run start:frontend:dev
``` ```
You should now be able to access _Fredy_ from your browser. Check your Terminal to see what port the frontend is running on. 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, run To run the tests, run
```shell ```shell
yarn run test yarn run test
``` ```
# Architecture # Architecture
![Architecture](/doc/architecture.jpg "Architecture")
```mermaid
flowchart TD
subgraph Jobs["Jobs"]
A1["Job 1"]
A2["Job 2"]
A3["Job 3"]
end
subgraph Providers["Providers"]
C1["Provider 1"]
C2["Provider 2"]
C3["Provider 3"]
end
subgraph NotificationAdapters["Notification Adapters"]
F1["Notification Adapter 1"]
F2["Notification Adapter 2"]
end
A1 --> B["FredyRuntime"]
A2 --> B
A3 --> B
B --> C1 & C2 & C3
C1 --> D["Similarity-Check"]
C2 --> D
C3 --> D
D --> E{"Found<br>similarity?"}
E -- No --> F1
F1 --> F2
style A1 fill:#fde9a0,stroke:#333333,color:#333333
style A2 fill:#fde9a0,stroke:#333333,color:#333333
style A3 fill:#fde9a0,stroke:#333333,color:#333333
style C1 fill:#c4c9f1,stroke:#333333,color:#333333
style C2 fill:#c4c9f1,stroke:#333333,color:#333333
style C3 fill:#c4c9f1,stroke:#333333,color:#333333
style F1 fill:#d2edba,stroke:#333333,color:#333333
style F2 fill:#d2edba,stroke:#333333,color:#333333
style B fill:#abd8f9,stroke:#333333,color:#333333
style D fill:#fab4a8,stroke:#333333,color:#333333
style E fill:#fffbb4,stroke:#333333,color:#333333
```
### Immoscout ### Immoscout
Immoscout has implemented advanced bot detection. In order to work around this, we are using a reversed engineered version of their mobile api. See See [Immoscout Reverse Engineering Documentation](https://github.com/orangecoding/fredy/blob/master/reverse-engineered-immoscout.md)
Immoscout has implemented advanced bot detection. In order to work around this, we are using a reversed engineered version of their mobile api. See [Immoscout Reverse Engineering Documentation](https://github.com/orangecoding/fredy/blob/master/reverse-engineered-immoscout.md)
# Analytics # Analytics
Fredy is completely free (and will always remain free). However, it would be a huge help if youd allow me to collect some analytical data.
Before you freak out, let me explain... Fredy is completely free (and will always remain free). However, it would be a huge help if youd allow me to collect some analytical data.
If you agree, Fredy will send a ping to my Mixpanel project each time it runs. Before you freak out, let me explain...
If you agree, Fredy will send a ping to my Mixpanel project each time it runs.
The data includes: names of active adapters/providers, OS, architecture, Node version, and language. The information is entirely anonymous and helps me understand which adapters/providers are most frequently used.</p> The data includes: names of active adapters/providers, OS, architecture, Node version, and language. The information is entirely anonymous and helps me understand which adapters/providers are most frequently used.</p>
**Thanks**🤘 **Thanks**🤘
# Docker # Docker
Use the Dockerfile in this repository to build an image.
Example: `docker build -t fredy/fredy /path/to/your/Dockerfile` Use the Dockerfile in this repository to build an image.
Example: `docker build -t fredy/fredy /path/to/your/Dockerfile`
Or use docker-compose: Or use docker-compose:
@@ -106,17 +163,18 @@ Or use the container that will be built automatically.
`docker pull ghcr.io/orangecoding/fredy:master` `docker pull ghcr.io/orangecoding/fredy:master`
## Create & run a container ## Create & run a container
Put your config.json into a path of your choice, such as `/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`.
### 👐 Contributing ### 👐 Contributing
Thanks to all the people who already contributed! Thanks to all the people who already contributed!
<a href="https://github.com/orangecoding/fredy/graphs/contributors"> <a href="https://github.com/orangecoding/fredy/graphs/contributors">
@@ -125,7 +183,6 @@ Thanks to all the people who already contributed!
See [Contributing](https://github.com/orangecoding/fredy/blob/master/CONTRIBUTING.md) See [Contributing](https://github.com/orangecoding/fredy/blob/master/CONTRIBUTING.md)
## Star History ## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=orangecoding/fredy&type=Date)](https://www.star-history.com/#orangecoding/fredy&Date) [![Star History Chart](https://api.star-history.com/svg?repos=orangecoding/fredy&type=Date)](https://www.star-history.com/#orangecoding/fredy&Date)

View File

@@ -1 +1,7 @@
{"interval":"60","port":9998,"workingHours":{"from":"","to":""},"demoMode":false,"analyticsEnabled":null} {
"interval": "60",
"port": 9998,
"workingHours": { "from": "", "to": "" },
"demoMode": false,
"analyticsEnabled": null
}

View File

@@ -1,84 +0,0 @@
<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>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 189 KiB

View File

@@ -1,4 +1,3 @@
version: '3.8'
services: services:
fredy: fredy:
container_name: fredy container_name: fredy
@@ -12,5 +11,5 @@ services:
- ./conf:/conf - ./conf:/conf
- ./db:/db - ./db:/db
ports: ports:
- 9998:9998 - 9998:9998
restart: unless-stopped restart: unless-stopped

View File

@@ -1,16 +1,17 @@
<!DOCTYPE html> <!doctype html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8" <meta
name="viewport" charset="UTF-8"
content="user-scalable=no, width=device-width, initial-scale=1, maximum-scale=1"> name="viewport"
<meta name="google" content="notranslate"> content="user-scalable=no, width=device-width, initial-scale=1, maximum-scale=1"
/>
<meta name="google" content="notranslate" />
<title>Fredy</title> <title>Fredy</title>
</head> </head>
<body theme-mode="dark"> <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 type="module" src="/ui/src/Index.jsx"></script>
<script type="module" src="/ui/src/Index.jsx"></script> </html>
</html>

View File

@@ -1,14 +1,14 @@
import fs from 'fs'; import fs from 'fs';
import {config} from './lib/utils.js'; import { config } from './lib/utils.js';
import * as similarityCache from './lib/services/similarity-check/similarityCache.js'; import * as similarityCache from './lib/services/similarity-check/similarityCache.js';
import { setLastJobExecution } from './lib/services/storage/listingsStorage.js'; import { setLastJobExecution } from './lib/services/storage/listingsStorage.js';
import * as jobStorage from './lib/services/storage/jobStorage.js'; import * as jobStorage from './lib/services/storage/jobStorage.js';
import FredyRuntime from './lib/FredyRuntime.js'; import FredyRuntime from './lib/FredyRuntime.js';
import { duringWorkingHoursOrNotSet } from './lib/utils.js'; import { duringWorkingHoursOrNotSet } from './lib/utils.js';
import './lib/api/api.js'; import './lib/api/api.js';
import {track} from './lib/services/tracking/Tracker.js'; import { track } from './lib/services/tracking/Tracker.js';
import {handleDemoUser} from './lib/services/storage/userStorage.js'; import { handleDemoUser } from './lib/services/storage/userStorage.js';
import {cleanupDemoAtMidnight} from './lib/services/demoCleanup.js'; import { cleanupDemoAtMidnight } from './lib/services/demoCleanup.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');
@@ -19,13 +19,13 @@ const provider = fs.readdirSync(path).filter((file) => file.endsWith('.js'));
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}`);
if(config.demoMode){ if (config.demoMode) {
console.info('Running in demo mode'); console.info('Running in demo mode');
cleanupDemoAtMidnight(); cleanupDemoAtMidnight();
} }
/* eslint-enable no-console */ /* eslint-enable no-console */
const fetchedProvider = await Promise.all( const fetchedProvider = await Promise.all(
provider.filter((provider) => provider.endsWith('.js')).map(async (pro) => import(`${path}/${pro}`)) provider.filter((provider) => provider.endsWith('.js')).map(async (pro) => import(`${path}/${pro}`)),
); );
handleDemoUser(); handleDemoUser();
@@ -33,30 +33,30 @@ handleDemoUser();
setInterval( setInterval(
(function exec() { (function exec() {
const isDuringWorkingHoursOrNotSet = duringWorkingHoursOrNotSet(config, Date.now()); const isDuringWorkingHoursOrNotSet = duringWorkingHoursOrNotSet(config, Date.now());
if(!config.demoMode) { if (!config.demoMode) {
if (isDuringWorkingHoursOrNotSet) { if (isDuringWorkingHoursOrNotSet) {
track(); track();
config.lastRun = Date.now(); config.lastRun = Date.now();
jobStorage jobStorage
.getJobs() .getJobs()
.filter((job) => job.enabled) .filter((job) => job.enabled)
.forEach((job) => { .forEach((job) => {
job.provider job.provider
.filter((p) => fetchedProvider.find((fp) => fp.metaInformation.id === p.id) != null) .filter((p) => fetchedProvider.find((fp) => fp.metaInformation.id === p.id) != null)
.forEach(async (prov) => { .forEach(async (prov) => {
const pro = fetchedProvider.find((fp) => fp.metaInformation.id === prov.id); const pro = fetchedProvider.find((fp) => fp.metaInformation.id === prov.id);
pro.init(prov, job.blacklist); pro.init(prov, job.blacklist);
await new FredyRuntime(pro.config, job.notificationAdapter, prov.id, job.id, similarityCache).execute(); await new FredyRuntime(pro.config, job.notificationAdapter, prov.id, job.id, similarityCache).execute();
setLastJobExecution(job.id); setLastJobExecution(job.id);
}); });
}); });
} else { } else {
/* eslint-disable no-console */ /* eslint-disable no-console */
console.debug('Working hours set. Skipping as outside of working hours.'); console.debug('Working hours set. Skipping as outside of working hours.');
/* eslint-enable no-console */ /* eslint-enable no-console */
} }
} }
return exec; return exec;
})(), })(),
INTERVAL INTERVAL,
); );

View File

@@ -12,7 +12,7 @@ import restana from 'restana';
import files from 'serve-static'; import files from 'serve-static';
import path from 'path'; import path from 'path';
import { getDirName } from '../utils.js'; import { getDirName } from '../utils.js';
import {demoRouter} from './routes/demoRouter.js'; import { demoRouter } from './routes/demoRouter.js';
const service = restana(); const service = restana();
const staticService = files(path.join(getDirName(), '../ui/public')); const staticService = files(path.join(getDirName(), '../ui/public'));
const PORT = config.port || 9998; const PORT = config.port || 9998;

View File

@@ -1,10 +1,10 @@
import restana from 'restana'; import restana from 'restana';
import {config} from '../../utils.js'; import { config } from '../../utils.js';
const service = restana(); const service = restana();
const demoRouter = service.newRouter(); const demoRouter = service.newRouter();
demoRouter.get('/', async (req, res) => { demoRouter.get('/', async (req, res) => {
res.body = Object.assign({}, {demoMode: config.demoMode}); res.body = Object.assign({}, { demoMode: config.demoMode });
res.send(); res.send();
}); });

View File

@@ -1,7 +1,7 @@
import restana from 'restana'; import restana from 'restana';
import {config, getDirName, readConfigFromStorage, refreshConfig} from '../../utils.js'; import { config, getDirName, readConfigFromStorage, refreshConfig } from '../../utils.js';
import fs from 'fs'; import fs from 'fs';
import {handleDemoUser} from '../../services/storage/userStorage.js'; import { handleDemoUser } from '../../services/storage/userStorage.js';
const service = restana(); const service = restana();
const generalSettingsRouter = service.newRouter(); const generalSettingsRouter = service.newRouter();
generalSettingsRouter.get('/', async (req, res) => { generalSettingsRouter.get('/', async (req, res) => {
@@ -11,12 +11,12 @@ generalSettingsRouter.get('/', async (req, res) => {
generalSettingsRouter.post('/', async (req, res) => { generalSettingsRouter.post('/', async (req, res) => {
const settings = req.body; const settings = req.body;
try { try {
if(config.demoMode){ if (config.demoMode) {
res.send(new Error('In demo mode, it is not allowed to change these settings.')); res.send(new Error('In demo mode, it is not allowed to change these settings.'));
return; return;
} }
const currentConfig = await readConfigFromStorage(); const currentConfig = await readConfigFromStorage();
fs.writeFileSync(`${getDirName()}/../conf/config.json`, JSON.stringify({...currentConfig, ...settings})); fs.writeFileSync(`${getDirName()}/../conf/config.json`, JSON.stringify({ ...currentConfig, ...settings }));
await refreshConfig(); await refreshConfig();
handleDemoUser(); handleDemoUser();
} catch (err) { } catch (err) {

View File

@@ -15,7 +15,7 @@ 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 === user.id;
} }
jobRouter.get('/', async (req, res) => { jobRouter.get('/', async (req, res) => {
const isUserAdmin = isAdmin(req); const isUserAdmin = isAdmin(req);

View File

@@ -1,8 +1,8 @@
import restana from 'restana'; import restana from 'restana';
import * as userStorage from '../../services/storage/userStorage.js'; import * as userStorage from '../../services/storage/userStorage.js';
import * as hasher from '../../services/security/hash.js'; import * as hasher from '../../services/security/hash.js';
import {config} from '../../utils.js'; import { config } from '../../utils.js';
import {trackDemoAccessed} from '../../services/tracking/Tracker.js'; import { trackDemoAccessed } from '../../services/tracking/Tracker.js';
const service = restana(); const service = restana();
const loginRouter = service.newRouter(); const loginRouter = service.newRouter();
loginRouter.get('/user', async (req, res) => { loginRouter.get('/user', async (req, res) => {
@@ -26,8 +26,7 @@ loginRouter.post('/', async (req, res) => {
return; return;
} }
if (user.password === hasher.hash(password)) { if (user.password === hasher.hash(password)) {
if (config.demoMode) {
if(config.demoMode){
trackDemoAccessed(); trackDemoAccessed();
} }

View File

@@ -6,7 +6,7 @@ const notificationAdapterList = fs.readdirSync('./lib//notification/adapter').fi
const notificationAdapter = await Promise.all( const notificationAdapter = await Promise.all(
notificationAdapterList.map(async (pro) => { notificationAdapterList.map(async (pro) => {
return await import(`../../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;

View File

@@ -6,7 +6,7 @@ const providerList = fs.readdirSync('./lib/provider').filter((file) => file.ends
const provider = await Promise.all( const provider = await Promise.all(
providerList.map(async (pro) => { providerList.map(async (pro) => {
return await import(`../../provider/${pro}`); return await import(`../../provider/${pro}`);
}) }),
); );
providerRouter.get('/', async (req, res) => { providerRouter.get('/', async (req, res) => {
res.body = provider.map((p) => p.metaInformation); res.body = provider.map((p) => p.metaInformation);

View File

@@ -1,7 +1,7 @@
import restana from 'restana'; import restana from 'restana';
import * as userStorage from '../../services/storage/userStorage.js'; import * as userStorage from '../../services/storage/userStorage.js';
import * as jobStorage from '../../services/storage/jobStorage.js'; import * as jobStorage from '../../services/storage/jobStorage.js';
import {config} from '../../utils.js'; import { config } from '../../utils.js';
const service = restana(); const service = restana();
const userRouter = service.newRouter(); const userRouter = service.newRouter();
function checkIfAnyAdminAfterRemovingUser(userIdToBeRemoved, allUser) { function checkIfAnyAdminAfterRemovingUser(userIdToBeRemoved, allUser) {
@@ -21,7 +21,7 @@ userRouter.get('/:userId', async (req, res) => {
res.send(); res.send();
}); });
userRouter.delete('/', async (req, res) => { userRouter.delete('/', async (req, res) => {
if(config.demoMode){ if (config.demoMode) {
res.send(new Error('In demo mode, it is not allowed to remove user.')); res.send(new Error('In demo mode, it is not allowed to remove user.'));
return; return;
} }
@@ -42,10 +42,9 @@ userRouter.delete('/', async (req, res) => {
res.send(); res.send();
}); });
userRouter.post('/', async (req, res) => { userRouter.post('/', async (req, res) => {
if (config.demoMode) {
if(config.demoMode){ res.send(new Error('In demo mode, it is not allowed to change or add user.'));
res.send(new Error('In demo mode, it is not allowed to change or add user.')); return;
return;
} }
const { username, password, password2, isAdmin, userId } = req.body; const { username, password, password2, isAdmin, userId } = req.body;
@@ -60,7 +59,7 @@ userRouter.post('/', async (req, res) => {
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;
} }

View File

@@ -1,7 +1,7 @@
export const DEFAULT_CONFIG = { export const DEFAULT_CONFIG = {
'interval': '60', interval: '60',
'port': 9998, port: 9998,
'workingHours': {'from': '', 'to': ''}, workingHours: { from: '', to: '' },
'demoMode': false, demoMode: false,
'analyticsEnabled': null analyticsEnabled: null,
}; };

View File

@@ -1,4 +1,4 @@
### Console Adapter ### Console Adapter
The console adapter prints everything found by Fredy into the console (not sending any notifications to you). This can be useful when you want to check if your search The console adapter prints everything found by Fredy into the console (not sending any notifications to you). This can be useful when you want to check if your search
criteria meet the expectations. criteria meet the expectations.

View File

@@ -2,68 +2,120 @@ import mailjet from 'node-mailjet';
import path from 'path'; import path from 'path';
import fs from 'fs'; import fs from 'fs';
import Handlebars from 'handlebars'; import Handlebars from 'handlebars';
import fetch from 'node-fetch';
import { markdown2Html } from '../../services/markdown.js'; import { markdown2Html } from '../../services/markdown.js';
import { getDirName } from '../../utils.js'; import { getDirName, normalizeImageUrl } from '../../utils.js';
const __dirname = getDirName(); const __dirname = getDirName();
const template = fs.readFileSync(path.resolve(__dirname + '/notification/emailTemplate/template.hbs'), 'utf8'); const template = fs.readFileSync(path.resolve(__dirname + '/notification/emailTemplate/template.hbs'), 'utf8');
const emailTemplate = Handlebars.compile(template); const emailTemplate = Handlebars.compile(template);
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
const guessMime = (url) => {
const lower = url.split('?')[0].toLowerCase();
if (lower.endsWith('.png')) return 'image/png';
if (lower.endsWith('.gif')) return 'image/gif';
return 'image/jpeg';
};
const toBase64 = async (url) => {
try {
const res = await fetch(url);
if (!res.ok) throw new Error(`Fetch failed with status ${res.status} for URL: ${url}`);
const ab = await res.arrayBuffer();
return Buffer.from(ab).toString('base64');
} catch (error) {
console.error(`Error fetching image from ${url}:`, error.message);
throw error;
}
};
const mapListingsWithCid = async (serviceName, jobKey, listings) => {
const out = [];
const attachments = [];
for (let i = 0; i < listings.length; i++) {
const l = listings[i] || {};
const imgUrl = normalizeImageUrl(l.image);
const item = {
title: l.title || '',
link: l.link || '',
address: l.address || '',
size: l.size || '',
price: l.price || '',
serviceName,
jobKey,
hasImage: false,
imageCid: '',
};
if (imgUrl) {
try {
const base64 = await toBase64(imgUrl);
const cid = `listing-${i}`;
attachments.push({
ContentType: guessMime(imgUrl),
Filename: `listing-${i}.${imgUrl.split('.').pop().split('?')[0] || 'jpg'}`,
Base64Content: base64,
ContentID: cid,
});
item.hasImage = true;
item.imageCid = cid;
} catch (error) {
console.warn(`Skipping image for listing ${i} due to error: ${error.message}`);
}
}
out.push(item);
}
return { listings: out, attachments };
};
export const send = async ({ serviceName, newListings, notificationConfig, jobKey }) => {
const { apiPublicKey, apiPrivateKey, receiver, from } = notificationConfig.find( const { apiPublicKey, apiPrivateKey, receiver, from } = notificationConfig.find(
(adapter) => adapter.id === config.id, (adapter) => adapter.id === config.id,
).fields; ).fields;
const to = receiver const to = receiver
.trim() .trim()
.split(',') .split(',')
.map((r) => ({ .map((r) => ({ Email: r.trim() }))
Email: r.trim(), .filter((r) => r.Email.length > 0);
}));
const { listings, attachments } = await mapListingsWithCid(serviceName, jobKey, newListings);
const html = emailTemplate({
serviceName: `Job: (${jobKey}) | Service: ${serviceName}`,
numberOfListings: listings.length,
listings,
});
return mailjet return mailjet
.apiConnect(apiPublicKey, apiPrivateKey) .apiConnect(apiPublicKey, apiPrivateKey)
.post('send', { version: 'v3.1' }) .post('send', { version: 'v3.1' })
.request({ .request({
Messages: [ Messages: [
{ {
From: { From: { Email: from, Name: 'Fredy' },
Email: from,
Name: 'Fredy',
},
To: to, To: to,
Subject: `Fredy found ${newListings.length} new listings for ${serviceName}`, Subject: `Fredy found ${listings.length} new listing(s) for ${serviceName}`,
HTMLPart: emailTemplate({ HTMLPart: html,
serviceName: `Job: (${jobKey}) | Service: ${serviceName}`, InlinedAttachments: attachments,
numberOfListings: newListings.length,
listings: newListings,
}),
}, },
], ],
}); });
}; };
export const config = { export const config = {
id: 'mailjet', id: 'mailjet',
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'),
fields: { fields: {
apiPublicKey: { apiPublicKey: { type: 'text', label: 'Public Api Key' },
type: 'text', apiPrivateKey: { type: 'text', label: 'Private Api Key' },
label: 'Public Api Key', receiver: { type: 'email', label: 'Receiver Email' },
description: 'The public api key needed to access this service.', from: { type: 'email', label: 'Sender email' },
},
apiPrivateKey: {
type: 'text',
label: 'Private Api Key',
description: 'The private api key needed to access this service.',
},
receiver: {
type: 'email',
label: 'Receiver Email',
description: 'The email address (single one) which Fredy is using to send notifications to.',
},
from: {
type: 'email',
label: 'Sender email',
description:
'The email address from which Fredy send email. Beware, this email address needs to be verified by Sendgrid.',
},
}, },
}; };

View File

@@ -1,8 +1,8 @@
### MailJet Adapter ### MailJet Adapter
To use [MailJet](https://mailjet.com), you need to create an account. You'll need to decided from which email address you want Fredy to send from. To use [MailJet](https://mailjet.com), you need to create an account. You'll need to decide from which email address you want Fredy to send from.
E.g. if you use yourGmailAccount@gmail.com, you have to add this to MailJet and verify it as well. E.g. if you use yourGmailAccount@gmail.com, you have to add this to MailJet and verify it as well.
The given public/private api keys are needed in order to use MailJet with Fredy. Fredy will use the same template, it is using for SendGrid. The given public/private api keys are needed in order to use MailJet with Fredy. Fredy will use the same template, it is using for SendGrid.
If this email should be sent to multiple receiver use a comma separator (some@email.com, someOther@email.com). If this email should be sent to multiple receiver, use a comma separator (some@email.com, someOther@email.com).

View File

@@ -1,5 +1,5 @@
### Mattermost Adapter ### 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. 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. As a result, you get the webhook URL for configuration in fredy. In addition, the target channel must be defined.

View File

@@ -1,32 +1,41 @@
import { markdown2Html } from '../../services/markdown.js'; import { markdown2Html } from '../../services/markdown.js';
import { getJob } from '../../services/storage/jobStorage.js'; import { getJob } from '../../services/storage/jobStorage.js';
import fetch from 'node-fetch'; import fetch from 'node-fetch';
import { normalizeImageUrl } from '../../utils.js';
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => { export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
const { priority, server, topic } = notificationConfig.find((adapter) => adapter.id === config.id).fields; const { priority, server, topic } = notificationConfig.find((adapter) => adapter.id === config.id).fields;
const job = getJob(jobKey); const job = getJob(jobKey);
const jobName = job == null ? jobKey : job.name; const jobName = job == null ? jobKey : job.name;
const promises = newListings.map((newListing) => { const promises = newListings.map((newListing) => {
const message = ` const message = `
Address: ${newListing.address} Address: ${newListing.address}
Size: ${newListing.size.replace(/2m/g, '$m^2$')} Size: ${newListing.size == null ? 'N/A' : newListing.size.replace(/2m/g, '$m^2$')}
Price: ${newListing.price} Price: ${newListing.price}
Link: ${newListing.link}`; Link: ${newListing.link}`;
return fetch(server, {
const headers = {
Title: newListing.title,
Priority: String(priority),
Tags: `${serviceName},${jobName}`,
Click: newListing.link,
};
if (newListing.image && typeof newListing.image === 'string') {
headers.Attach = normalizeImageUrl(newListing.image);
}
return fetch(`${server}/${topic}`, {
method: 'POST', method: 'POST',
body: JSON.stringify({ headers,
topic: topic, body: message,
message: message,
title: newListing.title,
tags: [serviceName, jobName],
priority: parseInt(priority),
click: newListing.link,
}),
}); });
}); });
return Promise.all(promises); return Promise.all(promises);
}; };
export const config = { export const config = {
id: 'ntfy', id: 'ntfy',
name: 'ntfy', name: 'ntfy',

View File

@@ -1,5 +1,5 @@
### ntfy Adapter ### 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. 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. As a result, you get the URL for configuration in fredy. In addition, the priority must be defined.

View File

@@ -1,73 +1,79 @@
import {markdown2Html} from '../../services/markdown.js'; import { markdown2Html } from '../../services/markdown.js';
import {getJob} from '../../services/storage/jobStorage.js'; import { getJob } from '../../services/storage/jobStorage.js';
import fetch from 'node-fetch'; import fetch from 'node-fetch';
export const send = ({serviceName, newListings, notificationConfig, jobKey}) => { export const send = async ({ serviceName, newListings, notificationConfig, jobKey }) => {
const {token, user, device} = notificationConfig.find((adapter) => adapter.id === config.id).fields; const { token, user, device } = notificationConfig.find((adapter) => adapter.id === config.id).fields;
const job = getJob(jobKey); const job = getJob(jobKey);
const jobName = job == null ? jobKey : job.name; const jobName = job == null ? jobKey : job.name;
const promises = newListings.map((newListing) => {
const title = `${jobName} at ${serviceName}: ${newListing.title}`;
const message = `Address: ${newListing.address}\nSize: ${newListing.size}\nPrice: ${newListing.price}\nLink: ${newListing.link}`;
return fetch('https://api.pushover.net/1/messages.json', {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
token: token,
user: user,
message: message,
device: device,
title: title,
}),
});
});
return Promise.all(promises) const results = await Promise.all(
.then((responses) => { newListings.map(async (newListing) => {
// Convert all responses to JSON const title = `${jobName} at ${serviceName}: ${newListing.title}`;
return Promise.all(responses.map((response) => response.json())); const message = `Address: ${newListing.address}\nSize: ${newListing.size}\nPrice: ${newListing.price}\nLink: ${newListing.link}`;
})
.then((data) => {
// Check for errors in the data
const error = data
.map((item) => (item.errors != null && item.errors.length > 0 ? item.errors.join(', ') : null))
.filter((err) => err !== null);
if (error.length > 0) { const form = new FormData();
// Reject with the combined error messages form.append('token', token);
return Promise.reject(error.join('; ')); form.append('user', user);
} form.append('title', title);
form.append('message', message);
if (device) form.append('device', device);
return data; // Try to attach image if available
}) if (newListing.image && typeof newListing.image === 'string') {
.then(() => { try {
return Promise.resolve(); const imgRes = await fetch(newListing.image);
}) if (imgRes.ok) {
.catch((error) => { const ab = await imgRes.arrayBuffer();
return Promise.reject(error); form.append('attachment', new Blob([ab]), 'image.jpg');
}); }
} catch {
// fail silently, just skip the image
}
}
const res = await fetch('https://api.pushover.net/1/messages.json', {
method: 'POST',
body: form,
});
return res.json();
}),
);
// Collect errors
const errors = results
.map((r) => (r.errors && r.errors.length > 0 ? r.errors.join(', ') : null))
.filter((e) => e !== null);
if (errors.length > 0) {
return Promise.reject(errors.join('; '));
}
return results;
}; };
export const config = { export const config = {
id: 'pushover', id: 'pushover',
name: 'Pushover', name: 'Pushover',
readme: markdown2Html('lib/notification/adapter/pushover.md'), readme: markdown2Html('lib/notification/adapter/pushover.md'),
description: 'Fredy will send new listings to your mobile using Pushover.', description: 'Fredy will send new listings to your mobile using Pushover.',
fields: { fields: {
token: { token: {
type: 'text', type: 'text',
label: 'API token', label: 'API token',
description: 'Your application\'s API token.', description: "Your application's API token.",
},
user: {
type: 'text',
label: 'User key',
description: 'Your user/group key.',
},
device: {
type: 'text',
label: 'Device name',
description: 'The device name to send your notification to. Messages may be addressed to multiple specific devices by joining them with a comma.',
},
}, },
user: {
type: 'text',
label: 'User key',
description: 'Your user/group key.',
},
device: {
type: 'text',
label: 'Device name',
description:
'The device name to send your notification to. Messages may be addressed to multiple specific devices by joining them with a comma.',
},
},
}; };

View File

@@ -2,4 +2,4 @@
Refer to the [instructions](https://support.pushover.net/i7-what-is-pushover-and-how-do-i-use-it) to set up your Pushover application. Refer to the [instructions](https://support.pushover.net/i7-what-is-pushover-and-how-do-i-use-it) to set up your Pushover application.
After setting up the application, please enter both your newly created User key and API token. After setting up the application, please enter both your newly created User key and API token.

View File

@@ -1,24 +1,53 @@
import sgMail from '@sendgrid/mail'; import sgMail from '@sendgrid/mail';
import { markdown2Html } from '../../services/markdown.js'; import { markdown2Html } from '../../services/markdown.js';
import { normalizeImageUrl } from '../../utils.js';
const mapListings = (serviceName, jobKey, listings) =>
listings.map((l) => {
const image = normalizeImageUrl(l.image);
return {
title: l.title || '',
link: l.link || '',
address: l.address || '',
size: l.size || '',
price: l.price || '',
image,
hasImage: Boolean(image),
// optional plain text snippet
snippet: [l.address, l.price, l.size].filter(Boolean).join(' | '),
serviceName,
jobKey,
};
});
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => { export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
const { apiKey, receiver, from, templateId } = notificationConfig.find((adapter) => adapter.id === config.id).fields; const { apiKey, receiver, from, templateId } = notificationConfig.find((adapter) => adapter.id === config.id).fields;
sgMail.setApiKey(apiKey); sgMail.setApiKey(apiKey);
const to = receiver
.trim()
.split(',')
.map((r) => r.trim())
.filter(Boolean);
const listings = mapListings(serviceName, jobKey, newListings);
const msg = { const msg = {
templateId, templateId,
to: receiver to,
.trim()
.split(',')
.map((r) => r.trim()),
from, from,
subject: `Job ${jobKey} | Service ${serviceName} found ${newListings.length} new listing(s)`, subject: `Job ${jobKey} | Service ${serviceName} found ${newListings.length} new listing(s)`,
dynamic_template_data: { dynamic_template_data: {
serviceName: `Job: (${jobKey}) | Service: ${serviceName}`, serviceName: `Job: (${jobKey}) | Service: ${serviceName}`,
numberOfListings: newListings.length, numberOfListings: newListings.length,
listings: newListings, listings,
}, },
}; };
return sgMail.send(msg); return sgMail.send(msg);
}; };
export const config = { export const config = {
id: 'sendgrid', id: 'sendgrid',
name: 'SendGrid', name: 'SendGrid',

View File

@@ -1,9 +1,8 @@
### SendGrid Adapter ### SendGrid Adapter
SendGrid is a free email service (free as in "you cannot send more than 100(Sendgrid) and 200(Mailjet) emails a day"), which is more than enough for Fredy. SendGrid is a free email service (free as in "you cannot send more than 100(Sendgrid) and 200(Mailjet) emails a day"), which is more than enough for Fredy.
To use [SendGrid](https://sendgrid.com/), you need to create an account. You'll need to decided from which email address you want Fredy to send from. E.g. if you use yourGmailAccount@gmail.com, you have to add this to sendgrid and verify it as well. To use [SendGrid](https://sendgrid.com/), you need to create an account. You'll need to decided from which email address you want Fredy to send from. E.g. if you use yourGmailAccount@gmail.com, you have to add this to sendgrid and verify it as well.
Lastly you have to create an api-key and feed it into Fredy's config, as well as creating a new dynamic template. For this new template, I recommend copying and pasting the code from the one I have provided under `/lib/notification/emailTemplate/template.hbs`. Lastly you have to create an api-key and feed it into Fredy's config, as well as creating a new dynamic template. For this new template, I recommend copying and pasting the code from the one I have provided under `/lib/notification/emailTemplate/template.hbs`.

View File

@@ -1,43 +1,61 @@
import Slack from 'slack'; import Slack from 'slack';
import { markdown2Html } from '../../services/markdown.js'; import { markdown2Html } from '../../services/markdown.js';
const msg = Slack.chat.postMessage; import { normalizeImageUrl } from '../../utils.js';
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
const { token, channel } = notificationConfig.find((adapter) => adapter.id === config.id).fields; const buildBlocks = (serviceName, jobKey, p) => {
return newListings.map((payload) => const blocks = [
msg({ {
token, type: 'header',
channel, text: { type: 'plain_text', text: `New Listing from ${serviceName} (${jobKey})`, emoji: false },
text: `*(${serviceName} - ${jobKey})* - ${payload.title}`, },
attachments: [ {
{ type: 'section',
fallback: payload.title, text: { type: 'mrkdwn', text: `*<${p.link}|${p.title}>*` },
color: '#36a64f', },
title: 'Link to Exposé', {
title_link: payload.link, type: 'section',
fields: [ fields: [
{ { type: 'mrkdwn', text: `*Price*\n${p.price ?? 'n/a'}` },
title: 'Price', { type: 'mrkdwn', text: `*Size*\n${p.size ?? 'n/a'}` },
value: payload.price, { type: 'mrkdwn', text: `*Address*\n${p.address ?? 'n/a'}` },
short: false,
},
{
title: 'Size',
value: payload.size,
short: false,
},
{
title: 'Address',
value: payload.address,
short: false,
},
],
footer: 'Powered by Fredy',
ts: new Date().getTime() / 1000,
},
], ],
}), },
];
const img = normalizeImageUrl(p.image);
if (img) {
blocks.push({
type: 'image',
image_url: img,
alt_text: p.title || 'listing image',
});
}
blocks.push({
type: 'context',
elements: [{ type: 'mrkdwn', text: 'Powered by Fredy' }],
});
return blocks;
};
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
const { token, channel } = notificationConfig.find((a) => a.id === config.id).fields;
return Promise.allSettled(
newListings.map((p) =>
Slack.chat.postMessage({
token,
channel,
text: `${serviceName} ${jobKey}: ${p.title}`,
blocks: buildBlocks(serviceName, jobKey, p),
unfurl_links: false,
unfurl_media: false,
}),
),
); );
}; };
export const config = { export const config = {
id: 'slack', id: 'slack',
name: 'Slack', name: 'Slack',

View File

@@ -1,6 +1,4 @@
### Slack Adapter ### Slack Adapter
IMPORTANT:
Don't use this adapter anymore, it is outdated and only here for backwards compatability reasons. Use the new Slack Adapter with webhooks!
In order to use [Slack](https://slack.com), you need to create an account. When done, you need to create a new App in your workspace. Give it the permission `chat:write:bot` and `chat:write:user`.
Now you need to create a user token and a channel. Make sure the bot is installed to this channel.

View File

@@ -0,0 +1,79 @@
import fetch from 'node-fetch';
import { markdown2Html } from '../../services/markdown.js';
import { normalizeImageUrl } from '../../utils.js';
const buildBlocks = (serviceName, jobKey, p) => {
const blocks = [
{
type: 'header',
text: { type: 'plain_text', text: `New Listing from ${serviceName} (${jobKey})`, emoji: false },
},
{
type: 'section',
text: { type: 'mrkdwn', text: `*<${p.link}|${p.title}>*` },
},
{
type: 'section',
fields: [
{ type: 'mrkdwn', text: `*Price*\n${p.price ?? 'n/a'}` },
{ type: 'mrkdwn', text: `*Size*\n${p.size ?? 'n/a'}` },
{ type: 'mrkdwn', text: `*Address*\n${p.address ?? 'n/a'}` },
],
},
];
const img = normalizeImageUrl(p.image);
if (img) {
blocks.push({
type: 'image',
image_url: img,
alt_text: p.title || 'listing image',
});
}
blocks.push({
type: 'context',
elements: [{ type: 'mrkdwn', text: 'Powered by Fredy' }],
});
return blocks;
};
const postJson = (url, body) =>
fetch(url, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body,
});
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
const adapter = notificationConfig.find((a) => a.id === config.id);
const webhookUrl = adapter?.fields?.webhookUrl;
if (!webhookUrl) return Promise.resolve([]);
const promises = newListings.map((p) => {
const body = JSON.stringify({
text: `${serviceName} ${jobKey}: ${p.title}`,
blocks: buildBlocks(serviceName, jobKey, p),
unfurl_links: false,
unfurl_media: false,
});
return postJson(webhookUrl, body);
});
return Promise.allSettled(promises);
};
export const config = {
id: 'slack_with_webhooks',
name: 'Slack with Webhooks',
readme: markdown2Html('lib/notification/adapter/slack_with_webhooks.md'),
description: 'Fredy will send new listings to the slack channel of your choice..',
fields: {
webhookUrl: {
type: 'text',
label: 'Webhook-Url',
description: 'The Url of the Webhook to send messages to.',
},
},
};

View File

@@ -0,0 +1,6 @@
### Slack Adapter
IMPORTANT:
This is the new version of the Slack adapter. I strongly encourage you to use it, the old version is now unmaintained and only kept due to backwards compatability reasons.
In order to use [Slack](https://slack.com), you need to create an account. When done, create a new channel and add the Webhook integration to that channel. Copy the webhook url. That's it.

View File

@@ -2,7 +2,19 @@ import { markdown2Html } from '../../services/markdown.js';
import Database from 'better-sqlite3'; import Database from 'better-sqlite3';
export const send = ({ serviceName, newListings, jobKey }) => { export const send = ({ serviceName, newListings, jobKey }) => {
const db = new Database('db/listings.db'); const db = new Database('db/listings.db');
const fields = ['serviceName', 'jobKey', 'id', 'size', 'rooms', 'price', 'address', 'title', 'link', 'description']; const fields = [
'serviceName',
'jobKey',
'id',
'size',
'rooms',
'price',
'address',
'title',
'link',
'description',
'image',
];
db.prepare(`CREATE TABLE IF NOT EXISTS listing (${fields.join(' TEXT, ')} TEXT);`).run(); 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(', @')})`); const insert = db.prepare(`INSERT INTO listing (${fields.join(', ')}) VALUES (@${fields.join(', @')})`);
newListings.map((listing) => { newListings.map((listing) => {

View File

@@ -1,7 +1,9 @@
### Sqlite Adapter ### Sqlite Adapter
This adapter stores search results in a sqlite database located in db/listings.db. This file can be used for further analysis later on.
This adapter stores search results in a sqlite database located in db/listings.db. This file can be used for further analysis later on.
Fields are: Fields are:
``` ```
['serviceName', 'jobKey', 'id', 'size', 'rooms', 'price', 'address', 'title', 'link', 'description'] ['serviceName', 'jobKey', 'id', 'size', 'rooms', 'price', 'address', 'title', 'link', 'description']
``` ```

View File

@@ -1,63 +1,98 @@
import { markdown2Html } from '../../services/markdown.js'; import { markdown2Html } from '../../services/markdown.js';
import { getJob } from '../../services/storage/jobStorage.js'; import { getJob } from '../../services/storage/jobStorage.js';
import fetch from 'node-fetch'; import fetch from 'node-fetch';
const MAX_ENTITIES_PER_CHUNK = 8; import pThrottle from 'p-throttle';
const RATE_LIMIT_INTERVAL = 1010; import { normalizeImageUrl } from '../../utils.js';
/**
* splitting an array into chunks because Telegram only allows for messages up to const RATE_LIMIT_INTERVAL = 1000;
* 4096 chars, thus we have to split messages into chunks const chatThrottleMap = new Map();
* @param inputArray
* @param perChunk function cleanupOldThrottles() {
*/ const now = Date.now();
const arrayChunks = (inputArray, perChunk) => const maxAge = RATE_LIMIT_INTERVAL + 1000;
inputArray.reduce((all, one, i) => { const toBeDeleted = [];
const ch = Math.floor(i / perChunk); for (const [chatId, chatThrottle] of chatThrottleMap.entries()) {
all[ch] = [].concat(all[ch] || [], one); if (now - chatThrottle.lastUsedAt > maxAge) toBeDeleted.push(chatId);
return all; }
}, []); for (const chatId of toBeDeleted) chatThrottleMap.delete(chatId);
function shorten(str, len = 30) {
return str.length > len ? str.substring(0, len) + '...' : str;
} }
function getThrottled(chatId, call) {
cleanupOldThrottles();
const now = Date.now();
const chatThrottle = chatThrottleMap.get(chatId);
if (chatThrottle) {
chatThrottle.lastUsedAt = now;
return chatThrottle.throttled;
}
const throttled = pThrottle({ limit: 1, interval: RATE_LIMIT_INTERVAL })(call);
chatThrottleMap.set(chatId, { lastUsedAt: now, throttled });
return throttled;
}
function shorten(str, len = 90) {
if (!str) return '';
return str.length > len ? str.substring(0, len).trim() + '...' : str;
}
function escapeHtml(s = '') {
return s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
}
function buildCaption(jobName, serviceName, o) {
const title = shorten((o.title || '').replace(/\*/g, ''), 90);
const meta = [o.address, o.price, o.size].filter(Boolean).join(' | ');
return `<i>${escapeHtml(jobName)}</i> (${escapeHtml(serviceName)})\n<a href='${escapeHtml(
o.link || '',
)}'><b>${escapeHtml(title)}</b></a>\n${escapeHtml(meta)}`.slice(0, 1024);
}
function buildText(jobName, serviceName, o) {
const title = shorten((o.title || '').replace(/\*/g, ''), 90);
const meta = [o.address, o.price, o.size].filter(Boolean).join(' | ');
return (
`<i>${escapeHtml(jobName)}</i> (${escapeHtml(serviceName)})\n` +
`<a href='${escapeHtml(o.link || '')}'><b>${escapeHtml(title)}</b></a>\n` +
`${escapeHtml(meta)}`
);
}
export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => { export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
const { token, chatId } = notificationConfig.find((adapter) => adapter.id === config.id).fields; const { token, chatId } = notificationConfig.find((adapter) => adapter.id === config.id).fields;
const job = getJob(jobKey); const job = getJob(jobKey);
const jobName = job == null ? jobKey : job.name; 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); const throttledCall = getThrottled(chatId, async function (endpoint, body) {
const promises = chunks.map((chunk) => { await fetch(`https://api.telegram.org/bot${token}/${endpoint}`, {
let message = `<i>${jobName}</i> (${serviceName}) found <b>${newListings.length}</b> new listings:\n\n`; method: 'post',
message += chunk.map( body: JSON.stringify(body),
(o) => headers: { 'Content-Type': 'application/json' },
`<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);
}); });
}); });
const promises = newListings.map(async (o) => {
const img = normalizeImageUrl(o.image);
if (img) {
return throttledCall('sendPhoto', {
chat_id: chatId,
photo: img,
caption: buildCaption(jobName, serviceName, o),
parse_mode: 'HTML',
});
}
return throttledCall('sendMessage', {
chat_id: chatId,
text: buildText(jobName, serviceName, o),
parse_mode: 'HTML',
disable_web_page_preview: true,
});
});
return Promise.all(promises); return Promise.all(promises);
}; };
export const config = { export const config = {
id: 'telegram', id: 'telegram',
name: 'Telegram', name: 'Telegram',

View File

@@ -1,13 +1,12 @@
### Telegram Adapter ### Telegram Adapter
For Telegram, you need to create a Bot. This is pretty easy. Open [this](https://telegram.me/BotFather) url on your smartphone and follow the instructions. For Telegram, you need to create a Bot. This is pretty easy. Open [this](https://telegram.me/BotFather) url on your smartphone and follow the instructions.
A telegram bot is not allowed to send messages directly to a user, you as a user need to first contact the bot to get a chatId.
After the user has send a message to your bot the first time, you can gather the chatId like this:
``` A telegram bot is not allowed to send messages directly to a user, you as a user need to first contact the bot to get a chatId.
curl -X GET https://api.telegram.org/bot{YOUR_TELEGRAM_TOKEN}/getUpdates After the user has send a message to your bot the first time, you can gather the chatId like this:
```
```
curl -X GET https://api.telegram.org/bot{YOUR_TELEGRAM_TOKEN}/getUpdates
```
A more detailed list of instructions can be found here [https://core.telegram.org/bots#botfather](https://core.telegram.org/bots#botfather) A more detailed list of instructions can be found here [https://core.telegram.org/bots#botfather](https://core.telegram.org/bots#botfather)

View File

@@ -0,0 +1,123 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Listings</title>
<style type="text/css">
body { margin:0; padding:0; background:#000000; }
table { border-collapse:collapse; }
img { border:0; outline:none; text-decoration:none; display:block; }
a { text-decoration:none; }
.container { width:100%; max-width:640px; margin:0 auto; }
.card { background:#111111; border:1px solid #222222; border-radius:8px; overflow:hidden; }
.divider { height:2px; line-height:2px; font-size:0; background:#00dc73; }
.h1 { font:700 18px/1.4 Arial, Helvetica, sans-serif; color:#ffffff; margin:0; }
.h2 { font:700 16px/1.4 Arial, Helvetica, sans-serif; color:#ffffff; margin:0; }
.p { font:400 14px/1.6 Arial, Helvetica, sans-serif; color:#d9d9d9; margin:0; }
.meta { font:400 13px/1.5 Arial, Helvetica, sans-serif; color:#bfbfbf; }
.btn { background:#00dc73; color:#0b0b0b; font:700 14px/1 Arial, Helvetica, sans-serif; padding:12px 18px; border-radius:6px; display:inline-block; }
.sp-8 { height:8px; line-height:8px; font-size:0; }
.sp-12 { height:12px; line-height:12px; font-size:0; }
.sp-16 { height:16px; line-height:16px; font-size:0; }
.sp-20 { height:20px; line-height:20px; font-size:0; }
.sp-24 { height:24px; line-height:24px; font-size:0; }
@media screen and (max-width:480px){
.container { width:100% !important; }
.stack { display:block !important; width:100% !important; }
}
</style>
</head>
<body style="background:#000000;">
<table role="presentation" width="100%" bgcolor="#000000">
<tr>
<td align="center">
<table role="presentation" class="container" width="640">
<tr><td class="sp-20"></td></tr>
<tr>
<td align="center">
<h1 class="h1" style="text-align:center;">
Service {{serviceName}} found {{numberOfListings}} new listings
</h1>
</td>
</tr>
<tr><td class="sp-12"></td></tr>
<tr><td class="divider"></td></tr>
<tr><td class="sp-16"></td></tr>
{{#each listings}}
<tr>
<td>
<table role="presentation" class="card" width="100%">
{{#if this.hasImage}}
<tr>
<td>
<a href="{{this.link}}" target="_blank">
<img src="cid:{{this.imageCid}}" alt="{{this.title}}" width="640"
style="width:100%; height:auto; background:#1a1a1a;" />
</a>
</td>
</tr>
{{/if}}
<tr>
<td style="padding:16px 18px 0 18px;">
<a href="{{this.link}}" target="_blank" style="color:#ffffff;">
<h2 class="h2">{{this.title}}</h2>
</a>
</td>
</tr>
<tr><td class="sp-8"></td></tr>
<tr>
<td style="padding:0 18px;">
<table role="presentation" width="100%">
<tr>
<td class="stack" style="vertical-align:top; width:50%; padding-right:8px;">
<p class="meta"><strong>Price</strong><br/>{{#if this.price}}{{this.price}}{{else}}unknown{{/if}}</p>
</td>
<td class="stack" style="vertical-align:top; width:50%; padding-left:8px;">
<p class="meta"><strong>Size</strong><br/>{{#if this.size}}{{this.size}}{{else}}unknown{{/if}}</p>
</td>
</tr>
<tr><td class="sp-8"></td><td class="sp-8"></td></tr>
<tr>
<td colspan="2">
<p class="meta"><strong>Address</strong><br/>{{#if this.address}}{{this.address}}{{else}}unknown{{/if}}</p>
</td>
</tr>
</table>
</td>
</tr>
<tr><td class="sp-16"></td></tr>
<tr>
<td align="left" style="padding:0 18px 18px 18px;">
<a href="{{this.link}}" class="btn" target="_blank">View Listing</a>
</td>
</tr>
</table>
</td>
</tr>
<tr><td class="sp-24"></td></tr>
{{/each}}
<tr><td class="divider"></td></tr>
<tr><td class="sp-16"></td></tr>
<tr>
<td align="center">
<p class="p" style="color:#9f9f9f;">Powered by Fredy</p>
</td>
</tr>
<tr><td class="sp-20"></td></tr>
</table>
</td>
</tr>
</table>
</body>
</html>

View File

@@ -1,237 +1,131 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html data-editor-version="2" class="sg-campaigns" xmlns="http://www.w3.org/1999/xhtml"><head> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1"> <head>
<!--[if !mso]><!--> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=Edge"> <meta name="viewport" content="width=device-width, initial-scale=1" />
<!--<![endif]--> <meta http-equiv="X-UA-Compatible" content="IE=edge" />
<!--[if (gte mso 9)|(IE)]> <title>Fredy found some new listings</title>
<xml>
<o:OfficeDocumentSettings>
<o:AllowPNG/>
<o:PixelsPerInch>96</o:PixelsPerInch>
</o:OfficeDocumentSettings>
</xml>
<![endif]-->
<!--[if (gte mso 9)|(IE)]>
<style type="text/css"> <style type="text/css">
body {width: 600px;margin: 0 auto;} body { margin:0; padding:0; background:#000000; }
table {border-collapse: collapse;} table { border-collapse:collapse; }
table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;} img { border:0; outline:none; text-decoration:none; display:block; }
img {-ms-interpolation-mode: bicubic;} a { text-decoration:none; }
</style> .container { width:100%; max-width:640px; margin:0 auto; }
<![endif]--> .card { background:#111111; border:1px solid #222222; border-radius:8px; overflow:hidden; }
<style type="text/css"> .divider { height:2px; line-height:2px; font-size:0; background:#00dc73; }
body, p, div { .h1 { font:700 18px/1.4 Arial, Helvetica, sans-serif; color:#ffffff; margin:0; }
font-family: arial,helvetica,sans-serif; .h2 { font:700 16px/1.4 Arial, Helvetica, sans-serif; color:#ffffff; margin:0; }
font-size: 14px; .p { font:400 14px/1.6 Arial, Helvetica, sans-serif; color:#d9d9d9; margin:0; }
} .meta { font:400 13px/1.5 Arial, Helvetica, sans-serif; color:#bfbfbf; }
body { .btn { background:#00dc73; color:#0b0b0b; font:700 14px/1 Arial, Helvetica, sans-serif; padding:12px 18px; border-radius:6px; display:inline-block; }
color: #000000; .sp-8 { height:8px; line-height:8px; font-size:0; }
} .sp-12 { height:12px; line-height:12px; font-size:0; }
body a { .sp-16 { height:16px; line-height:16px; font-size:0; }
color: #42ee99; .sp-20 { height:20px; line-height:20px; font-size:0; }
text-decoration: none; .sp-24 { height:24px; line-height:24px; font-size:0; }
} @media screen and (max-width:480px){
p { margin: 0; padding: 0; } .container { width:100% !important; }
table.wrapper { .stack { display:block !important; width:100% !important; }
width:100% !important;
table-layout: fixed;
-webkit-font-smoothing: antialiased;
-webkit-text-size-adjust: 100%;
-moz-text-size-adjust: 100%;
-ms-text-size-adjust: 100%;
}
img.max-width {
max-width: 100% !important;
}
.column.of-2 {
width: 50%;
}
.column.of-3 {
width: 33.333%;
}
.column.of-4 {
width: 25%;
}
@media screen and (max-width:480px) {
.preheader .rightColumnContent,
.footer .rightColumnContent {
text-align: left !important;
}
.preheader .rightColumnContent div,
.preheader .rightColumnContent span,
.footer .rightColumnContent div,
.footer .rightColumnContent span {
text-align: left !important;
}
.preheader .rightColumnContent,
.preheader .leftColumnContent {
font-size: 80% !important;
padding: 5px 0;
}
table.wrapper-mobile {
width: 100% !important;
table-layout: fixed;
}
img.max-width {
height: auto !important;
max-width: 100% !important;
}
a.bulletproof-button {
display: block !important;
width: auto !important;
font-size: 80%;
padding-left: 0 !important;
padding-right: 0 !important;
}
.columns {
width: 100% !important;
}
.column {
display: block !important;
width: 100% !important;
padding-left: 0 !important;
padding-right: 0 !important;
margin-left: 0 !important;
margin-right: 0 !important;
}
} }
</style> </style>
<!--user entered Head Start-->
<!--End Head user entered-->
</head> </head>
<body> <body style="background:#000000;">
<center class="wrapper" data-link-color="#42ee99" data-body-style="font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#000000;"> <table role="presentation" width="100%" bgcolor="#000000">
<div class="webkit"> <tr>
<table cellpadding="0" cellspacing="0" border="0" width="100%" class="wrapper" bgcolor="#000000"> <td align="center">
<tbody><tr> <table role="presentation" class="container" width="640">
<td valign="top" bgcolor="#000000" width="100%"> <tr><td class="sp-20"></td></tr>
<table width="100%" role="content-container" class="outer" align="center" cellpadding="0" cellspacing="0" border="0"> <tr>
<tbody><tr> <td align="center">
<td width="100%"> <table role="presentation" width="100%">
<table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr>
<tbody><tr> <td align="center">
<h1 class="h1" style="text-align:center;">
Service {{serviceName}} found {{numberOfListings}} new listings
</h1>
</td>
</tr>
<tr><td class="sp-12"></td></tr>
<tr><td class="divider"></td></tr>
<tr><td class="sp-16"></td></tr>
</table>
</td>
</tr>
{{#each listings}}
<tr>
<td>
<table role="presentation" class="card" width="100%">
{{#if this.hasImage}}
<tr>
<td> <td>
<!--[if mso]> <a href="{{this.link}}" target="_blank">
<center> <img src="{{this.image}}" alt="{{this.title}}" width="640" style="width:100%;height:auto;background:#1a1a1a;" />
<table><tr><td width="600"> </a>
<![endif]--> </td>
<table width="100%" cellpadding="0" cellspacing="0" border="0" style="width:100%; max-width:600px;" align="center"> </tr>
<tbody><tr> {{/if}}
<td role="modules-container" style="padding:0px 0px 0px 0px; color:#000000; text-align:left;" bgcolor="#FFFFFF" width="100%" align="left"><table class="module preheader preheader-hide" role="module" data-type="preheader" border="0" cellpadding="0" cellspacing="0" width="100%" style="display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;"> <tr>
</table><table class="module" role="module" data-type="spacer" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="vB9TDziyvx65CC2nx3oyRH"> <td style="padding:16px 18px 0 18px;">
<tbody><tr> <a href="{{this.link}}" target="_blank" style="color:#ffffff;">
<td style="padding:0px 0px 20px 0px;" role="module-content" bgcolor="#000000"> <h2 class="h2">{{this.title}}</h2>
</td> </a>
</tr>
</tbody></table><table class="wrapper" role="module" data-type="image" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="uXsDxMnn1bRMmDcX8NB6rW">
</table><table class="module" role="module" data-type="text" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="hL6wjQ2qknNd5qDwT1p7Up">
<tbody><tr>
<td style="background-color:#000000; padding:10px 20px 10px 20px; line-height:40px; text-align:justify;" height="100%" valign="top" bgcolor="#000000"><div><h1 style="text-align: center"><span style="color: #ffffff; font-size: 14px; font-family: verdana,geneva,sans-serif"><strong>Service {{serviceName}} found {{numberOfListings}} new listing(s)!</strong></span></h1><div></div></div></td>
</tr>
</tbody></table>
<table border="0" cellpadding="0" cellspacing="0" align="center" width="100%" height="1px" style="line-height:3px; font-size:3px;">
<tbody><tr>
<td style="padding:0px 0px 1px 0px;" bgcolor="#42ee99"></td>
</tr>
</tbody></table>
</td>
</tr>
</tbody>
</table>
<table class="module" role="module" data-type="text" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="qk51Jjn4bm3rn2Yb31Dxzb">
<tbody>
{{#each listings}}
<tr>
<td style="padding:50px 50px 10px 50px; line-height:22px; text-align:center; color:white" bgcolor="#000000" height="100%" valign="top">
<div>
<span style="font-size: 12px; font-family: verdana,geneva,sans-serif; color: white;"><b>{{this.title}}</b></span>
<br/>
<span style="font-size: 12px; font-family: verdana,geneva,sans-serif; color: white;">Size: {{#if this.size}}{{this.size}}{{else}}unknown{{/if}}</span>
<br/>
<span style="font-size: 12px; font-family: verdana,geneva,sans-serif; color: white;">Price: {{#if this.price}}{{this.price}}{{else}}unknown{{/if}}</span>
<br/>
<span style="font-size: 12px; font-family: verdana,geneva,sans-serif; color: white;">{{#if this.address}}{{this.address}}{{else}}unknown{{/if}}</span>
<br/>
<a href="{{this.link}}" target="_blank" style="color:#00dc73; font-size:13px">{{this.link}}</a>
<br/>
<span style="color: white;">---------------------------</span>
</div>
</td>
</tr>
{{/each}}
</tbody>
</table>
<table class="module" role="module" data-type="spacer" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="2ga5f7koD5ApvUfnqUK6aT">
<tbody><tr>
<td style="padding:0px 0px 30px 0px;" role="module-content" bgcolor="#000000">
</td>
</tr>
</tbody></table>
<table class="module" role="module" data-type="divider" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="c3nRrjMndqXf1snYDFPSF9">
<tbody><tr>
<td style="padding:0px 0px 0px 0px;" role="module-content" height="100%" valign="top" bgcolor="#000000">
<table border="0" cellpadding="0" cellspacing="0" align="center" width="100%" height="2px" style="line-height:1px; font-size:2px;">
<tbody><tr>
<td style="padding:0px 0px 2px 0px;" bgcolor="#42ee99"></td>
</tr>
</tbody></table>
</td>
</tr>
</tbody>
</table>
<table class="module" role="module" data-type="spacer" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="pa9PeYjCEFyByuP5878Sd2">
<tbody><tr>
<td style="padding:0px 0px 30px 0px;" role="module-content" bgcolor="#000000">
</td>
</tr>
</tbody></table>
<table class="module" role="module" data-type="social" align="center" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="n7FceQWVnLmounEt32B1gj">
<tbody>
<tr>
<td valign="top" style="padding:0px 0px 0px 0px; font-size:6px; line-height:10px; background-color:#000000;" align="center">
<table align="center">
<tbody>
<tr><td style="padding: 0px 5px;">
<a href="https://github.com/orangecoding/fredy" target="_blank" alt="Fredy" title="Powered by Fredy" style="color:#00dc73; font-size:17px">
Powered by Fredy
</a>
</td></tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table></table><table class="module" role="module" data-type="spacer" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="35xFa9abxGTBYt9yR9BeQ2">
<tbody><tr>
<td style="padding:0px 0px 30px 0px;" role="module-content" bgcolor="#000000">
</td> </td>
</tr> </tr>
</tbody></table></td> <tr><td class="sp-8"></td></tr>
</tr> <tr>
</tbody></table> <td style="padding:0 18px;">
<!--[if mso]> <table role="presentation" width="100%">
</td> <tr>
</tr> <td class="stack" style="vertical-align:top; width:50%; padding-right:8px;">
</table> <p class="meta"><strong>Price</strong><br/>{{#if this.price}}{{this.price}}{{else}}unknown{{/if}}</p>
</center> </td>
<td class="stack" style="vertical-align:top; width:50%; padding-left:8px;">
<p class="meta"><strong>Size</strong><br/>{{#if this.size}}{{this.size}}{{else}}unknown{{/if}}</p>
</td>
</tr>
<tr><td class="sp-8"></td><td class="sp-8"></td></tr>
<tr>
<td colspan="2">
<p class="meta"><strong>Address</strong><br/>{{#if this.address}}{{this.address}}{{else}}unknown{{/if}}</p>
</td>
</tr>
</table>
</td>
</tr>
<tr><td class="sp-16"></td></tr>
<tr>
<td align="left" style="padding:0 18px 18px 18px;">
<!--[if mso]>
<v:roundrect xmlns:v="urn:schemas-microsoft-com:vml" href="{{this.link}}" arcsize="8%" strokecolor="#00dc73" strokeweight="0" fillcolor="#00dc73" style="height:40px;v-text-anchor:middle;width:180px;">
<w:anchorlock/>
<center style="color:#0b0b0b;font-family:Arial;font-size:14px;font-weight:bold;">
View Listing
</center>
</v:roundrect>
<![endif]--> <![endif]-->
</td> <!--[if !mso]><!-- -->
</tr> <a href="{{this.link}}" class="btn" target="_blank">View Listing</a>
</tbody></table> <!--<![endif]-->
</td> </td>
</tr> </tr>
</tbody></table> </table>
</td> </td>
</tr> </tr>
</tbody></table> <tr><td class="sp-24"></td></tr>
</div> {{/each}}
</center>
<tr><td class="divider"></td></tr>
</body></html> <tr><td class="sp-16"></td></tr>
<tr>
<td align="center">
<p class="p" style="color:#9f9f9f;">Powered by Fredy</p>
</td>
</tr>
<tr><td class="sp-20"></td></tr>
</table>
</td>
</tr>
</table>
</body>
</html>

View File

@@ -6,7 +6,7 @@ const adapter = await Promise.all(
fs fs
.readdirSync('./lib/notification/adapter') .readdirSync('./lib/notification/adapter')
.filter((file) => file.endsWith('.js')) .filter((file) => file.endsWith('.js'))
.map(async (integPath) => await import(`${path}/${integPath}`)) .map(async (integPath) => await import(`${path}/${integPath}`)),
); );
if (adapter.length === 0) { if (adapter.length === 0) {

View File

@@ -2,10 +2,12 @@ import utils, { buildHash } from '../utils.js';
let appliedBlackList = []; let appliedBlackList = [];
function normalize(o) { function normalize(o) {
const link = `https://www.1a-immobilienmarkt.de/expose/${o.id}.html`; const baseUrl = 'https://www.1a-immobilienmarkt.de';
const link = `${baseUrl}/expose/${o.id}.html`;
const price = normalizePrice(o.price); const price = normalizePrice(o.price);
const id = buildHash(o.id, price); const id = buildHash(o.id, price);
return Object.assign(o, { id, price, link }); const image = baseUrl + o.image;
return Object.assign(o, { id, price, link, image });
} }
/** /**
@@ -41,6 +43,7 @@ const config = {
price: '.inner_object_data .single_data_price | removeNewline | trim', price: '.inner_object_data .single_data_price | removeNewline | trim',
size: '.tabelle .tabelle_inhalt_infos .single_data_box | removeNewline | trim', size: '.tabelle .tabelle_inhalt_infos .single_data_box | removeNewline | trim',
title: '.inner_object_data .tabelle_inhalt_titel_black | removeNewline | trim', title: '.inner_object_data .tabelle_inhalt_titel_black | removeNewline | trim',
image: '.inner_object_pic img@src',
}, },
normalize: normalize, normalize: normalize,
filter: applyBlacklist, filter: applyBlacklist,

View File

@@ -1,26 +1,34 @@
import utils, {buildHash} from '../utils.js'; import utils, { buildHash } from '../utils.js';
let appliedBlackList = []; let appliedBlackList = [];
function shortenLink(link) { function shortenLink(link) {
return link.substring(0, link.indexOf('?')); return link.substring(0, link.indexOf('?'));
} }
function parseId(shortenedLink) { function parseId(shortenedLink) {
return shortenedLink.substring(shortenedLink.lastIndexOf('/') + 1); return shortenedLink.substring(shortenedLink.lastIndexOf('/') + 1);
} }
function normalize(o) { function normalize(o) {
const baseUrl = 'https://www.immobilien.de';
const size = o.size || 'N/A m²'; const size = o.size || 'N/A m²';
const price = o.price || 'N/A €'; const price = o.price || 'N/A €';
const title = o.title || 'No title available'; const title = o.title || 'No title available';
const address = o.address || 'No address available'; const address = o.address || 'No address available';
const shortLink = shortenLink(o.link); const shortLink = shortenLink(o.link);
const link = `https://www.immobilien.de/${shortLink}`; const link = `${baseUrl}/${shortLink}`;
const image = baseUrl + o.image;
const id = buildHash(parseId(shortLink), o.price); const id = buildHash(parseId(shortLink), o.price);
return Object.assign(o, { id, price, size, title, address, link }); return Object.assign(o, { id, price, size, title, address, link, image });
} }
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: '._ref', crawlContainer: '._ref',
@@ -34,6 +42,7 @@ const config = {
description: '.list_entry .description | trim', description: '.list_entry .description | trim',
link: '@href', link: '@href',
address: '.list_entry .place', address: '.list_entry .place',
image: '.list_entry img@src',
}, },
normalize: normalize, normalize: normalize,
filter: applyBlacklist, filter: applyBlacklist,

View File

@@ -33,6 +33,7 @@ const config = {
price: 'div[data-testid="cardmfe-price-testid"] | trim', price: 'div[data-testid="cardmfe-price-testid"] | trim',
size: 'div[data-testid="cardmfe-keyfacts-testid"] | trim', size: 'div[data-testid="cardmfe-keyfacts-testid"] | trim',
address: 'div[data-testid="cardmfe-description-box-address"] | trim', address: 'div[data-testid="cardmfe-description-box-address"] | trim',
image: 'div[data-testid="cardmfe-picture-box-test-id"] img@src',
}, },
normalize: normalize, normalize: normalize,
filter: applyBlacklist, filter: applyBlacklist,

View File

@@ -36,7 +36,7 @@
*/ */
import utils, { buildHash } from '../utils.js'; import utils, { buildHash } from '../utils.js';
import { convertWebToMobile } from '../services/immoscout/immoscout-web-translater.js'; import { convertWebToMobile } from '../services/immoscout/immoscout-web-translator.js';
let appliedBlackList = []; let appliedBlackList = [];
async function getListings(url) { async function getListings(url) {
@@ -62,6 +62,7 @@ async function getListings(url) {
.map((expose) => { .map((expose) => {
const item = expose.item; const item = expose.item;
const [price, size] = item.attributes; const [price, size] = item.attributes;
const { preview: image } = item.titlePicture;
return { return {
id: item.id, id: item.id,
price: price?.value, price: price?.value,
@@ -69,6 +70,7 @@ async function getListings(url) {
title: item.title, title: item.title,
link: `${metaInformation.baseUrl}expose/${item.id}`, link: `${metaInformation.baseUrl}expose/${item.id}`,
address: item.address?.line, address: item.address?.line,
image,
}; };
}); });
} }

View File

@@ -31,6 +31,7 @@ const config = {
title: '.js-item-title-link@title | trim', title: '.js-item-title-link@title | trim',
link: '.ci-search-result__link@href', link: '.ci-search-result__link@href',
description: '.js-show-more-item-sm | removeNewline | trim', description: '.js-show-more-item-sm | removeNewline | trim',
image: 'img@src',
}, },
normalize: normalize, normalize: normalize,
filter: applyBlacklist, filter: applyBlacklist,

View File

@@ -26,6 +26,7 @@ const config = {
title: 'div[data-testid="cardmfe-description-box-text-test-id"] > div:nth-of-type(2)', title: 'div[data-testid="cardmfe-description-box-text-test-id"] > div:nth-of-type(2)',
link: 'a@href', link: 'a@href',
address: 'div[data-testid="cardmfe-description-box-address"] | removeNewline | trim', address: 'div[data-testid="cardmfe-description-box-address"] | removeNewline | trim',
image: 'div[data-testid="cardMfe-card-pictureBox-opacity"] img@src',
}, },
normalize: normalize, normalize: normalize,
filter: applyBlacklist, filter: applyBlacklist,

View File

@@ -1,50 +1,51 @@
import utils, {buildHash} from '../utils.js'; import utils, { buildHash } 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²';
const id = buildHash(o.id, o.price); const id = buildHash(o.id, o.price);
const link = `https://www.kleinanzeigen.de${o.link}`; const link = `https://www.kleinanzeigen.de${o.link}`;
return Object.assign(o, {id, size, link}); return Object.assign(o, { id, 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);
const isBlacklistedDistrict = const isBlacklistedDistrict =
appliedBlacklistedDistricts.length === 0 ? false : utils.isOneOf(o.description, appliedBlacklistedDistricts); appliedBlacklistedDistricts.length === 0 ? false : utils.isOneOf(o.description, appliedBlacklistedDistricts);
return o.title != null && !isBlacklistedDistrict && titleNotBlacklisted && descNotBlacklisted; return o.title != null && !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 //sort by date is standard oO
sortByDateParam: null, sortByDateParam: null,
waitForSelector: 'body', waitForSelector: 'body',
crawlFields: { crawlFields: {
id: '.aditem@data-adid | int', id: '.aditem@data-adid | int',
price: '.aditem-main--middle--price-shipping--price | removeNewline | trim', price: '.aditem-main--middle--price-shipping--price | removeNewline | trim',
size: '.aditem-main .text-module-end | removeNewline | trim', size: '.aditem-main .text-module-end | removeNewline | trim',
title: '.aditem-main .text-module-begin a | removeNewline | trim', title: '.aditem-main .text-module-begin a | removeNewline | trim',
link: '.aditem-main .text-module-begin a@href | removeNewline | trim', link: '.aditem-main .text-module-begin a@href | removeNewline | trim',
description: '.aditem-main .aditem-main--middle--description | removeNewline | trim', description: '.aditem-main .aditem-main--middle--description | removeNewline | trim',
address: '.aditem-main--top--left | trim | removeNewline', address: '.aditem-main--top--left | trim | removeNewline',
}, image: 'img@src',
normalize: normalize, },
filter: applyBlacklist, normalize: normalize,
filter: applyBlacklist,
}; };
export const metaInformation = { export const metaInformation = {
name: 'Ebay Kleinanzeigen', name: 'Ebay Kleinanzeigen',
baseUrl: 'https://www.kleinanzeigen.de/', baseUrl: 'https://www.kleinanzeigen.de/',
id: 'kleinanzeigen', id: 'kleinanzeigen',
}; };
export const init = (sourceConfig, blacklist, blacklistedDistricts) => { export const 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}; export { config };

View File

@@ -1,44 +1,47 @@
import utils, {buildHash} from '../utils.js'; import utils, { buildHash } 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 link = nullOrEmpty(o.link) ? 'NO LINK' : `https://www.neubaukompass.de${o.link.substring(o.link.indexOf('/neubau'))}`; const link = nullOrEmpty(o.link)
const id = buildHash(o.link, o.price); ? 'NO LINK'
return Object.assign(o, {id, link}); : `https://www.neubaukompass.de${o.link.substring(o.link.indexOf('/neubau'))}`;
const id = buildHash(o.link, o.price);
return Object.assign(o, { id, 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: '.col-12.mb-4', crawlContainer: '.col-12.mb-4',
sortByDateParam: 'Sortierung=Id&Richtung=DESC', sortByDateParam: 'Sortierung=Id&Richtung=DESC',
waitForSelector: '.nbk-section', waitForSelector: '.nbk-section',
crawlFields: { crawlFields: {
id: 'a@href', id: 'a@href',
title: 'a@title | removeNewline | trim', title: 'a@title | removeNewline | trim',
link: 'a@href', link: 'a@href',
address: '.nbk-project-card__description | removeNewline | trim', address: '.nbk-project-card__description | removeNewline | trim',
price: '.nbk-project-card__spec-item .nbk-project-card__spec-value | removeNewline | trim', price: '.nbk-project-card__spec-item .nbk-project-card__spec-value | removeNewline | trim',
}, image: '.nbk-project-card__image@src',
normalize: normalize, },
filter: applyBlacklist, normalize: normalize,
filter: applyBlacklist,
}; };
export const init = (sourceConfig, blacklist) => { export const 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 = { export const metaInformation = {
name: 'Neubau Kompass', name: 'Neubau Kompass',
baseUrl: 'https://www.neubaukompass.de/', baseUrl: 'https://www.neubaukompass.de/',
id: 'neubauKompass', id: 'neubauKompass',
}; };
export {config}; export { config };

View File

@@ -1,43 +1,45 @@
import utils, {buildHash} from '../utils.js'; import utils, { buildHash } from '../utils.js';
let appliedBlackList = []; let appliedBlackList = [];
function normalize(o) { function normalize(o) {
const id = buildHash(o.id, o.price); const id = buildHash(o.id, o.price);
const link = `https://www.wg-gesucht.de${o.link}`; const link = `https://www.wg-gesucht.de${o.link}`;
return Object.assign(o, { id, link }); const image = o.image != null ? o.image.replace('small', 'large') : null;
return Object.assign(o, { id, link, image });
} }
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', sortByDateParam: 'sort_column=0&sort_order=0',
waitForSelector: 'body', waitForSelector: 'body',
crawlFields: { crawlFields: {
id: '@data-id', id: '@data-id',
details: '.row .noprint .col-xs-11 |removeNewline |trim', details: '.row .noprint .col-xs-11 |removeNewline |trim',
price: '.middle .col-xs-3 |removeNewline |trim', price: '.middle .col-xs-3 |removeNewline |trim',
size: '.middle .text-right |removeNewline |trim', size: '.middle .text-right |removeNewline |trim',
title: '.truncate_title a |removeNewline |trim', title: '.truncate_title a |removeNewline |trim',
link: '.truncate_title a@href', link: '.truncate_title a@href',
}, image: '.img-responsive@src',
normalize: normalize, },
filter: applyBlacklist, normalize: normalize,
filter: applyBlacklist,
}; };
export const init = (sourceConfig, blacklist) => { export const 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 = { export const metaInformation = {
name: 'Wg gesucht', name: 'Wg gesucht',
baseUrl: 'https://www.wg-gesucht.de/', baseUrl: 'https://www.wg-gesucht.de/',
id: 'wgGesucht', id: 'wgGesucht',
}; };
export {config}; export { config };

View File

@@ -8,7 +8,7 @@ export function loadParser(text) {
export function parse(crawlContainer, crawlFields, text, url) { export function parse(crawlContainer, crawlFields, text, url) {
if (!text) { if (!text) {
console.warn('Cannot parse, text was empty for url ', url); console.warn('No content found for ', url);
return null; return null;
} }

View File

@@ -1,5 +1,5 @@
import { JSONFileSync } from 'lowdb/node'; import { JSONFileSync } from 'lowdb/node';
import {config, getDirName} from '../../utils.js'; import { config, getDirName } from '../../utils.js';
import * as hasher from '../security/hash.js'; import * as hasher from '../security/hash.js';
import { nanoid } from 'nanoid'; import { nanoid } from 'nanoid';
import * as jobStorage from './jobStorage.js'; import * as jobStorage from './jobStorage.js';
@@ -7,23 +7,23 @@ import path from 'path';
import LowdashAdapter from './LowDashAdapter.js'; import LowdashAdapter from './LowDashAdapter.js';
const defaultData = { 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,
}, },
{ {
id: nanoid(), id: nanoid(),
lastLogin: Date.now(), lastLogin: Date.now(),
username: 'demo', username: 'demo',
password: hasher.hash('demo'), password: hasher.hash('demo'),
isAdmin: true, isAdmin: true,
}, },
], ],
}; };
const file = path.join(getDirName(), '../', 'db/users.json'); const file = path.join(getDirName(), '../', 'db/users.json');
@@ -86,34 +86,38 @@ export const removeUser = (userId) => {
db.chain db.chain
.set( .set(
'user', 'user',
user.filter((u) => u.id !== userId) user.filter((u) => u.id !== userId),
) )
.value(); .value();
db.write(); db.write();
}; };
export const handleDemoUser = () => { export const handleDemoUser = () => {
if(!config.demoMode){ if (!config.demoMode) {
const user = db.chain.get('user').value(); const user = db.chain.get('user').value();
db.chain.get('user').value(); db.chain
db.chain.set('user', user.filter((u) => u.username !== 'demo')).value(); .set(
db.write(); 'user',
}else { user.filter((u) => u.username !== 'demo'),
const demoUser = db.chain )
.get('user') .value();
.filter((u) => u.username === 'demo') db.write();
.value(); } else {
if (demoUser == null || demoUser.length === 0) { const demoUser = db.chain
db.chain.get('user') .get('user')
.value() .filter((u) => u.username === 'demo')
.push({ .value();
id: nanoid(), if (demoUser == null || demoUser.length === 0) {
username: 'demo', db.chain
password: hasher.hash('demo'), .get('user')
isAdmin: true, .value()
}); .push({
db.write(); id: nanoid(),
} username: 'demo',
password: hasher.hash('demo'),
isAdmin: true,
});
db.write();
} }
}
}; };

View File

@@ -1,90 +1,90 @@
import Mixpanel from 'mixpanel'; import Mixpanel from 'mixpanel';
import {getJobs} from '../storage/jobStorage.js'; import { getJobs } from '../storage/jobStorage.js';
import {getUniqueId} from './uniqueId.js'; import { getUniqueId } from './uniqueId.js';
import {config, inDevMode} from '../../utils.js'; import { config, inDevMode } from '../../utils.js';
import os from 'os'; import os from 'os';
import {readFileSync} from 'fs'; import { readFileSync } from 'fs';
import {packageUp} from 'package-up'; import { packageUp } from 'package-up';
const mixpanelTracker = Mixpanel.init('718670ef1c58c0208256c1e408a3d75e'); const mixpanelTracker = Mixpanel.init('718670ef1c58c0208256c1e408a3d75e');
const distinct_id = getUniqueId() || 'N/A'; const distinct_id = getUniqueId() || 'N/A';
const version = await getPackageVersion(); const version = await getPackageVersion();
export const track = function () { export const track = function () {
//only send tracking information if the user allowed to do so. //only send tracking information if the user allowed to do so.
if (config.analyticsEnabled && !inDevMode()) { if (config.analyticsEnabled && !inDevMode()) {
const activeProvider = new Set(); const activeProvider = new Set();
const activeAdapter = new Set(); const activeAdapter = new Set();
const jobs = getJobs(); const jobs = getJobs();
if (jobs != null && jobs.length > 0) { if (jobs != null && jobs.length > 0) {
jobs.forEach((job) => { jobs.forEach((job) => {
job.provider.forEach((provider) => { job.provider.forEach((provider) => {
activeProvider.add(provider.id); activeProvider.add(provider.id);
}); });
job.notificationAdapter.forEach((adapter) => { job.notificationAdapter.forEach((adapter) => {
activeAdapter.add(adapter.id); activeAdapter.add(adapter.id);
}); });
}); });
mixpanelTracker.track( mixpanelTracker.track(
'fredy_tracking', 'fredy_tracking',
enrichTrackingObject({ enrichTrackingObject({
adapter: Array.from(activeAdapter), adapter: Array.from(activeAdapter),
provider: Array.from(activeProvider), provider: Array.from(activeProvider),
}), }),
); );
}
} }
}
}; };
/** /**
* Note, this will only be used when Fredy runs in demo mode * Note, this will only be used when Fredy runs in demo mode
*/ */
export function trackDemoJobCreated(jobData) { export function trackDemoJobCreated(jobData) {
if (config.analyticsEnabled && !inDevMode() && config.demoMode) { if (config.analyticsEnabled && !inDevMode() && config.demoMode) {
mixpanelTracker.track('demoJobCreated', enrichTrackingObject(jobData)); mixpanelTracker.track('demoJobCreated', enrichTrackingObject(jobData));
} }
} }
/** /**
* Note, this will only be used when Fredy runs in demo mode * Note, this will only be used when Fredy runs in demo mode
*/ */
export function trackDemoAccessed() { export function trackDemoAccessed() {
if (config.analyticsEnabled && !inDevMode() && config.demoMode) { if (config.analyticsEnabled && !inDevMode() && config.demoMode) {
mixpanelTracker.track('demoAccessed', enrichTrackingObject({})); mixpanelTracker.track('demoAccessed', enrichTrackingObject({}));
} }
} }
function enrichTrackingObject(trackingObject) { function enrichTrackingObject(trackingObject) {
const operating_system = os.platform(); const operating_system = os.platform();
const os_version = os.release(); const os_version = os.release();
const arch = process.arch; const arch = process.arch;
const language = process.env.LANG || 'en'; const language = process.env.LANG || 'en';
const nodeVersion = process.version || 'N/A'; const nodeVersion = process.version || 'N/A';
return { return {
...trackingObject, ...trackingObject,
isDemo: config.demoMode, isDemo: config.demoMode,
operating_system, operating_system,
os_version, os_version,
arch, arch,
nodeVersion, nodeVersion,
language, language,
distinct_id, distinct_id,
fredy_version: version fredy_version: version,
}; };
} }
async function getPackageVersion() { async function getPackageVersion() {
try { try {
const packagePath = await packageUp(); const packagePath = await packageUp();
const packageJson = readFileSync(packagePath, 'utf8'); const packageJson = readFileSync(packagePath, 'utf8');
const json = JSON.parse(packageJson); const json = JSON.parse(packageJson);
return json.version; return json.version;
} catch (error) { } catch (error) {
console.error('Error reading version from package.json', error); console.error('Error reading version from package.json', error);
} }
return 'N/A'; return 'N/A';
} }

View File

@@ -1,91 +1,106 @@
import {dirname} from 'node:path'; import { dirname } from 'node:path';
import {fileURLToPath} from 'node:url'; import { fileURLToPath } from 'node:url';
import {readFile} from 'fs/promises'; import { readFile } from 'fs/promises';
import {createHash} from 'crypto'; import { createHash } from 'crypto';
import {DEFAULT_CONFIG} from './defaultConfig.js'; import { DEFAULT_CONFIG } from './defaultConfig.js';
function inDevMode(){ function inDevMode() {
return process.env.NODE_ENV == null || process.env.NODE_ENV !== 'production'; return process.env.NODE_ENV == null || process.env.NODE_ENV !== 'production';
} }
function isOneOf(word, arr) { function isOneOf(word, arr) {
if (arr == null || arr.length === 0) { if (!arr || arr.length === 0 || word == null) return false;
return false; const lowerWord = word.toLowerCase();
} return arr.some((item) => lowerWord.indexOf(item.toLowerCase()) !== -1);
const expression = String.raw`\b(${arr.join('|')})\b`;
const blacklist = new RegExp(expression, 'ig');
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(':');
d.setHours(parts[0]); d.setHours(parts[0]);
d.setMinutes(parts[1]); d.setMinutes(parts[1]);
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;
} }
function getDirName() { function getDirName() {
return dirname(fileURLToPath(import.meta.url)); return dirname(fileURLToPath(import.meta.url));
} }
function buildHash(...inputs) { function buildHash(...inputs) {
if (inputs == null) { if (inputs == null) {
return null; return null;
} }
const cleaned = inputs.filter(i => i != null && i.length > 0); const cleaned = inputs.filter((i) => i != null && i.length > 0);
if (cleaned.length === 0) { if (cleaned.length === 0) {
return null; return null;
} }
return createHash('sha256') return createHash('sha256').update(cleaned.join(',')).digest('hex');
.update(cleaned.join(','))
.digest('hex');
} }
let config = {}; let config = {};
export async function readConfigFromStorage(){ export async function readConfigFromStorage() {
return JSON.parse(await readFile(new URL('../conf/config.json', import.meta.url))); return JSON.parse(await readFile(new URL('../conf/config.json', import.meta.url)));
} }
export async function refreshConfig(){ export async function refreshConfig() {
try { try {
config = await readConfigFromStorage(); config = await readConfigFromStorage();
//backwards compatability... //backwards compatability...
config.analyticsEnabled ??= null; config.analyticsEnabled ??= null;
config.demoMode ??= false; config.demoMode ??= false;
} catch (error) { } catch (error) {
config = {...DEFAULT_CONFIG}; config = { ...DEFAULT_CONFIG };
console.error('Error reading config file', error); console.error('Error reading config file', error);
} }
} }
const RE_GT = />/g;
const RE_WEBP = /\/format\/webp/gi;
const RE_EXT = /\.(jpe?g|png|gif)(\?.*)?$/i;
const HTTPS_PREFIX = 'https://';
const normalizeImageUrl = (url) => {
if (typeof url !== 'string' || url.length === 0) return null;
let u = url.trim().replace(RE_GT, '');
if (RE_WEBP.test(u)) u = u.replace(RE_WEBP, '/format/jpg');
if (!u.startsWith(HTTPS_PREFIX)) return null;
if (!RE_EXT.test(u)) {
const jpgIdx = u.toLowerCase().lastIndexOf('.jpg');
if (jpgIdx > -1) u = u.slice(0, jpgIdx + 4);
}
return u;
};
await refreshConfig(); await refreshConfig();
export {isOneOf}; export { isOneOf };
export {inDevMode}; export { normalizeImageUrl };
export {nullOrEmpty}; export { inDevMode };
export {duringWorkingHoursOrNotSet}; export { nullOrEmpty };
export {getDirName}; export { duringWorkingHoursOrNotSet };
export {config}; export { getDirName };
export {buildHash}; export { config };
export { buildHash };
export default { export default {
isOneOf, isOneOf,
nullOrEmpty, nullOrEmpty,
duringWorkingHoursOrNotSet, duringWorkingHoursOrNotSet,
getDirName, getDirName,
config, config,
}; };

View File

@@ -1,21 +1,25 @@
{ {
"name": "fredy", "name": "fredy",
"version": "11.2.2", "version": "11.4.0",
"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 prod.js", "prepare": "husky",
"dev": "yarn && rm -rf ./ui/public/* && vite", "start:backend": "x-var NODE_ENV=production node index.js",
"ui": "rm -rf ./ui/public/* && vite", "start:backend:dev": "nodemon --watch index.js --watch lib",
"prod": "yarn && vite build --emptyOutDir", "start:frontend": "vite -m production",
"format": "prettier --write lib/**/*.js ui/src/**/*.jsx test/**/*.js *.js --single-quote --print-width 120", "start:frontend:dev": "vite",
"build:frontend": "vite build",
"format": "prettier --write \"**/*.js\"",
"format:check": "prettier --check \"**/*.js\"",
"test": "mocha --loader=esmock --timeout 3000000 test/**/*.test.js", "test": "mocha --loader=esmock --timeout 3000000 test/**/*.test.js",
"lint": "eslint ./index.js ./lib/**/*.js ./test/**/*.js ./ui/src/**/*.jsx" "lint": "eslint .",
"lint:fix": "yarn lint --fix"
}, },
"type": "module", "type": "module",
"lint-staged": { "lint-staged": {
"*.js": [ "*.{js,jsx}": [
"eslint ./index.js ./lib/**/*.js ./test/**/*.js", "yarn lint",
"prettier --single-quote --print-width 120 --write" "yarn format"
] ]
}, },
"main": "index.js", "main": "index.js",
@@ -50,17 +54,17 @@
"Firefox ESR" "Firefox ESR"
], ],
"dependencies": { "dependencies": {
"@douyinfe/semi-ui": "2.79.0", "@douyinfe/semi-ui": "2.85.0",
"@rematch/core": "2.2.0", "@rematch/core": "2.2.0",
"@rematch/loading": "2.1.2", "@rematch/loading": "2.1.2",
"@sendgrid/mail": "8.1.5", "@sendgrid/mail": "8.1.5",
"@vitejs/plugin-react": "4.4.1", "@vitejs/plugin-react": "4.7.0",
"better-sqlite3": "^11.10.0", "better-sqlite3": "^11.10.0",
"body-parser": "2.2.0", "body-parser": "2.2.0",
"cheerio": "^1.0.0", "cheerio": "^1.1.2",
"cookie-session": "2.1.0", "cookie-session": "2.1.1",
"handlebars": "4.7.8", "handlebars": "4.7.8",
"highcharts": "12.2.0", "highcharts": "12.3.0",
"highcharts-react-official": "3.2.2", "highcharts-react-official": "3.2.2",
"lodash": "4.17.21", "lodash": "4.17.21",
"lowdb": "6.0.1", "lowdb": "6.0.1",
@@ -68,12 +72,13 @@
"mixpanel": "^0.18.1", "mixpanel": "^0.18.1",
"nanoid": "5.1.5", "nanoid": "5.1.5",
"node-fetch": "3.3.2", "node-fetch": "3.3.2",
"node-mailjet": "6.0.8", "node-mailjet": "6.0.9",
"p-throttle": "^7.0.0",
"package-up": "^5.0.0", "package-up": "^5.0.0",
"puppeteer": "^24.8.2", "puppeteer": "^24.17.0",
"puppeteer-extra": "^3.3.6", "puppeteer-extra": "^3.3.6",
"puppeteer-extra-plugin-stealth": "^2.11.2", "puppeteer-extra-plugin-stealth": "^2.11.2",
"query-string": "9.1.2", "query-string": "9.2.2",
"react": "18.3.1", "react": "18.3.1",
"react-dom": "18.3.1", "react-dom": "18.3.1",
"react-redux": "9.2.0", "react-redux": "9.2.0",
@@ -81,28 +86,30 @@
"react-router-dom": "5.3.0", "react-router-dom": "5.3.0",
"redux": "5.0.1", "redux": "5.0.1",
"redux-thunk": "3.1.0", "redux-thunk": "3.1.0",
"restana": "4.9.9", "restana": "5.1.0",
"serve-static": "1.16.2", "serve-static": "2.2.0",
"slack": "11.0.2", "slack": "11.0.2",
"string-similarity": "^4.0.4", "string-similarity": "^4.0.4",
"vite": "5.4.11" "vite": "7.1.3",
"x-var": "^2.1.0"
}, },
"devDependencies": { "devDependencies": {
"@babel/core": "7.27.1", "@babel/core": "7.28.3",
"@babel/eslint-parser": "7.27.1", "@babel/eslint-parser": "7.28.0",
"@babel/preset-env": "7.27.2", "@babel/preset-env": "7.28.3",
"@babel/preset-react": "7.27.1", "@babel/preset-react": "7.27.1",
"chai": "5.2.0", "chai": "5.2.1",
"eslint": "8.56.0", "eslint": "8.56.0",
"eslint-config-prettier": "8.8.0", "eslint-config-prettier": "8.8.0",
"eslint-plugin-react": "7.37.4", "eslint-plugin-react": "7.37.5",
"esmock": "2.7.0", "esmock": "2.7.1",
"history": "5.3.0", "history": "5.3.0",
"husky": "9.1.7", "husky": "9.1.7",
"less": "4.3.0", "less": "4.4.1",
"lint-staged": "15.5.2", "lint-staged": "15.5.2",
"mocha": "10.8.2", "mocha": "10.8.2",
"prettier": "3.5.3", "nodemon": "^3.1.10",
"prettier": "3.6.2",
"redux-logger": "3.0.6" "redux-logger": "3.0.6"
} }
} }

View File

@@ -1,2 +0,0 @@
process.env.NODE_ENV = 'production';
import('./index.js');

View File

@@ -22,22 +22,24 @@ These protections make it extremely difficult to reliably extract data from Immo
To work around these limitations, we are in the progress of reverse-engineering Immoscout24's mobile API. The mobile applications need to communicate with Immoscout's servers to retrieve listing data, and these API endpoints typically have fewer anti-bot protections than the web interface. To work around these limitations, we are in the progress of reverse-engineering Immoscout24's mobile API. The mobile applications need to communicate with Immoscout's servers to retrieve listing data, and these API endpoints typically have fewer anti-bot protections than the web interface.
The mobile API provides several key endpoints: The mobile API provides several key endpoints:
- Search total endpoint: Returns the total number of listings for a given query - Search total endpoint: Returns the total number of listings for a given query
- Search list endpoint: Retrieves the actual listings with details - Search list endpoint: Retrieves the actual listings with details
- Expose endpoint: Returns detailed information about a specific listing - Expose endpoint: Returns detailed information about a specific listing
Challenges: Challenges:
1. Identifying the necessary endpoints and parameters required to perform searches 1. Identifying the necessary endpoints and parameters required to perform searches
2. Mapping the mobile API parameters to their web counterparts to maintain compatibility with existing search URLs 2. Mapping the mobile API parameters to their web counterparts to maintain compatibility with existing search URLs
## Api Specs ## Api Specs
#### Search for Listings #### Search for Listings
`GET /search/total?{search parameters}` `GET /search/total?{search parameters}`
*Returns the total number of listings for the given query.* _Returns the total number of listings for the given query._
``` ```
curl -H "User-Agent: ImmoScout24_1410_30_._" \ curl -H "User-Agent: ImmoScout24_1410_30_._" \
-H "Accept: application/json" \ -H "Accept: application/json" \
@@ -47,14 +49,17 @@ curl -H "User-Agent: ImmoScout24_1410_30_._" \
--- ---
#### Retrieve the listings #### Retrieve the listings
`POST /search/list?{search parameters}`
*The body is json encoded and contains data specifying additional results (advertisements) to return. The format is as follows (It is not necessary to provide data for the specified keys.)* `POST /search/list?{search parameters}`
``` _The body is json encoded and contains data specifying additional results (advertisements) to return. The format is as follows (It is not necessary to provide data for the specified keys.)_
{
"supportedResultListTypes": [], ```
"userData": {} {
} "supportedResultListTypes": [],
``` "userData": {}
}
```
``` ```
curl -X POST 'https://api.mobile.immobilienscout24.de/search/list?pricetype=calculatedtotalrent&realestatetype=apartmentrent&searchType=region&geocodes=%2Fde%2Fberlin%2Fberlin&pagenumber=1' \ curl -X POST 'https://api.mobile.immobilienscout24.de/search/list?pricetype=calculatedtotalrent&realestatetype=apartmentrent&searchType=region&geocodes=%2Fde%2Fberlin%2Fberlin&pagenumber=1' \
-H "Connection: keep-alive" \ -H "Connection: keep-alive" \
@@ -66,15 +71,18 @@ curl -X POST 'https://api.mobile.immobilienscout24.de/search/list?pricetype=calc
``` ```
--- ---
#### Get details of listings #### Get details of listings
`GET /expose/{id}` `GET /expose/{id}`
The response contains additional details not included in the listing response. The response contains additional details not included in the listing response.
``` ```
curl -H "User-Agent: ImmoScout24_1410_30_._" \ curl -H "User-Agent: ImmoScout24_1410_30_._" \
-H "Accept: application/json" \ -H "Accept: application/json" \
"https://api.mobile.immobilienscout24.de/expose/158382494" "https://api.mobile.immobilienscout24.de/expose/158382494"
``` ```
## Parameters
## Parameters The parameters between web and mobile are very different which is why we have to translate them. Please see [/lib/services/immoscout/immoscout-web-translator.js](https://github.com/orangecoding/fredy/blob/master/lib/services/immoscout/immoscout-web-translator.js).
The parameters between web and mobile are very different which is why we have to translate them. Please see `immoscout-web-translator.js`.

View File

@@ -1,38 +1,38 @@
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js'; import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
import {get} from '../mocks/mockNotification.js'; import { get } from '../mocks/mockNotification.js';
import {mockFredy, providerConfig} from '../utils.js'; import { mockFredy, providerConfig } from '../utils.js';
import {expect} from 'chai'; import { expect } from 'chai';
import * as provider from '../../lib/provider/immonet.js'; import * as provider from '../../lib/provider/immonet.js';
describe('#immonet testsuite()', () => { describe('#immonet testsuite()', () => {
after(() => { after(() => {
similarityCache.stopCacheCleanup(); similarityCache.stopCacheCleanup();
}); });
provider.init(providerConfig.immonet, [], []); provider.init(providerConfig.immonet, [], []);
it('should test immonet provider', async () => { it('should test immonet provider', async () => {
const Fredy = await mockFredy(); const Fredy = await mockFredy();
return await new Promise((resolve) => { return await new Promise((resolve) => {
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'immonet', similarityCache); 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 = 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('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.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');
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.address).to.be.not.empty; expect(notify.address).to.be.not.empty;
});
resolve();
});
}); });
resolve();
});
}); });
});
}); });

View File

@@ -1,36 +1,36 @@
import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js'; import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
import {get} from '../mocks/mockNotification.js'; import { get } from '../mocks/mockNotification.js';
import {mockFredy, providerConfig} from '../utils.js'; import { mockFredy, providerConfig } from '../utils.js';
import {expect} from 'chai'; import { expect } from 'chai';
import * as provider from '../../lib/provider/neubauKompass.js'; import * as provider from '../../lib/provider/neubauKompass.js';
describe('#neubauKompass testsuite()', () => { describe('#neubauKompass testsuite()', () => {
after(() => { after(() => {
similarityCache.stopCacheCleanup(); similarityCache.stopCacheCleanup();
}); });
provider.init(providerConfig.neubauKompass, [], []); provider.init(providerConfig.neubauKompass, [], []);
it('should test neubauKompass provider', async () => { it('should test neubauKompass provider', async () => {
const Fredy = await mockFredy(); const Fredy = await mockFredy();
return await new Promise((resolve) => { return await new Promise((resolve) => {
const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'neubauKompass', 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 = 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');
expect(notify.address).to.be.not.empty; expect(notify.address).to.be.not.empty;
});
resolve();
});
}); });
resolve();
});
}); });
});
}); });

View File

@@ -24,10 +24,6 @@
"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=", "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 "enabled": true
}, },
"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",
"enabled": true
},
"kleinanzeigen": { "kleinanzeigen": {
"url": "https://www.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

View File

@@ -30,4 +30,4 @@
"shouldBecome": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/wohnung-mieten?numberofrooms=1.5-&price=1.0-1000000.0&livingspace=1.0-10000.0&pricetype=rentpermonth&enteredFrom=result_list&sorting=-firstactivation", "shouldBecome": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/wohnung-mieten?numberofrooms=1.5-&price=1.0-1000000.0&livingspace=1.0-10000.0&pricetype=rentpermonth&enteredFrom=result_list&sorting=-firstactivation",
"id": "immoscout" "id": "immoscout"
} }
] ]

View File

@@ -1,4 +1,4 @@
import { convertWebToMobile } from '../../../lib/services/immoscout/immoscout-web-translater.js'; import { convertWebToMobile } from '../../../lib/services/immoscout/immoscout-web-translator.js';
import { expect } from 'chai'; import { expect } from 'chai';
import { readFile } from 'fs/promises'; import { readFile } from 'fs/promises';

View File

@@ -19,4 +19,4 @@
"url": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/haus-mieten?enteredFrom=one_step_search", "url": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/haus-mieten?enteredFrom=one_step_search",
"type": "houserent" "type": "houserent"
} }
} }

View File

@@ -34,6 +34,7 @@ describe('similarityCheck', () => {
check.setCacheEntry( check.setCacheEntry(
'where |X| and |Y| are the cardinalities of the two sets (i.e. the number of elements in each set). The Sørensen index equals twice the number of elements common to both sets divided by the sum of the number of elements in each set.', 'where |X| and |Y| are the cardinalities of the two sets (i.e. the number of elements in each set). The Sørensen index equals twice the number of elements common to both sets divided by the sum of the number of elements in each set.',
); );
expect(check.hasSimilarEntries('unrelated text')).to.be.false;
}); });
}); });
}); });

View File

@@ -1,16 +1,16 @@
import { expect } from 'chai'; import { expect } from 'chai';
import {buildHash} from '../../lib/utils.js'; import { buildHash } from '../../lib/utils.js';
describe('utilsCheck', () => { describe('utilsCheck', () => {
describe('#utilsCheck()', () => { describe('#utilsCheck()', () => {
it('should be null when null input', () => { it('should be null when null input', () => {
expect(buildHash(null)).to.be.null; expect(buildHash(null)).to.be.null;
}); });
it('should be null when null empty', () => { it('should be null when null empty', () => {
expect(buildHash('')).to.be.null; expect(buildHash('')).to.be.null;
}); });
it('should return a value', () => { it('should return a value', () => {
expect(buildHash('bla', '', null)).to.be.a.string; expect(buildHash('bla', '', null)).to.be.a.string;
}); });
}); });
}); });

View File

@@ -1,4 +1,4 @@
import React, {useEffect} from 'react'; import React, { useEffect } from 'react';
import InsufficientPermission from './components/permission/InsufficientPermission'; import InsufficientPermission from './components/permission/InsufficientPermission';
import PermissionAwareRoute from './components/permission/PermissionAwareRoute'; import PermissionAwareRoute from './components/permission/PermissionAwareRoute';
@@ -6,106 +6,108 @@ import GeneralSettings from './views/generalSettings/GeneralSettings';
import JobMutation from './views/jobs/mutation/JobMutation'; import JobMutation from './views/jobs/mutation/JobMutation';
import UserMutator from './views/user/mutation/UserMutator'; import UserMutator from './views/user/mutation/UserMutator';
import JobInsight from './views/jobs/insights/JobInsight.jsx'; import JobInsight from './views/jobs/insights/JobInsight.jsx';
import {useDispatch, useSelector} from 'react-redux'; import { useDispatch, useSelector } from 'react-redux';
import {Switch, Redirect} from 'react-router-dom'; import { Switch, Redirect } from 'react-router-dom';
import Logout from './components/logout/Logout'; import Logout from './components/logout/Logout';
import Logo from './components/logo/Logo'; import Logo from './components/logo/Logo';
import Menu from './components/menu/Menu'; import Menu from './components/menu/Menu';
import Login from './views/login/Login'; import Login from './views/login/Login';
import Users from './views/user/Users'; import Users from './views/user/Users';
import Jobs from './views/jobs/Jobs'; import Jobs from './views/jobs/Jobs';
import {Route} from 'react-router'; import { Route } from 'react-router';
import './App.less'; import './App.less';
import TrackingModal from './components/tracking/TrackingModal.jsx'; import TrackingModal from './components/tracking/TrackingModal.jsx';
import {Banner} from '@douyinfe/semi-ui'; import { Banner } from '@douyinfe/semi-ui';
export default function FredyApp() { export default function FredyApp() {
const dispatch = useDispatch(); const dispatch = useDispatch();
const [loading, setLoading] = React.useState(true); const [loading, setLoading] = React.useState(true);
const currentUser = useSelector((state) => state.user.currentUser); const currentUser = useSelector((state) => state.user.currentUser);
const settings = useSelector((state) => state.generalSettings.settings); const settings = useSelector((state) => state.generalSettings.settings);
useEffect(() => { useEffect(() => {
async function init() { async function init() {
await dispatch.user.getCurrentUser(); await dispatch.user.getCurrentUser();
if (!needsLogin()) { if (!needsLogin()) {
await dispatch.provider.getProvider(); await dispatch.provider.getProvider();
await dispatch.jobs.getJobs(); await dispatch.jobs.getJobs();
await dispatch.jobs.getProcessingTimes(); await dispatch.jobs.getProcessingTimes();
await dispatch.notificationAdapter.getAdapter(); await dispatch.notificationAdapter.getAdapter();
await dispatch.generalSettings.getGeneralSettings(); await dispatch.generalSettings.getGeneralSettings();
} }
setLoading(false); setLoading(false);
} }
init(); init();
}, [currentUser?.userId]); }, [currentUser?.userId]);
const needsLogin = () => { const needsLogin = () => {
return currentUser == null || Object.keys(currentUser).length === 0; return currentUser == null || Object.keys(currentUser).length === 0;
}; };
const isAdmin = () => currentUser != null && currentUser.isAdmin; const isAdmin = () => currentUser != null && currentUser.isAdmin;
const login = () => ( 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()} />
{settings.demoMode && (
<>
<Banner
fullMode={true}
type="info"
bordered
closeIcon={null}
description="You're currently viewing the demo version of Fredy. Jobs won't scrape websites, and any changes you make will be reverted at midnight."
/>
<br />
</>
)}
{settings.analyticsEnabled === null && !settings.demoMode && <TrackingModal />}
<Switch> <Switch>
<Route name="Login" path={'/login'} component={Login}/> <Route name="Insufficient Permission" path={'/403'} component={InsufficientPermission} />
<Redirect from="*" to={'/login'}/> <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> </Switch>
); </div>
</div>
return loading ? null : needsLogin() ? ( );
login()
) : (
<div className="app">
<div className="app__container">
<Logout/>
<Logo width={190} white/>
<Menu isAdmin={isAdmin()}/>
{settings.demoMode && (
<>
<Banner fullMode={true}
type="info"
bordered
closeIcon={null}
description="You're currently viewing the demo version of Fredy. Jobs won't scrape websites, and any changes you make will be reverted at midnight."
/>
<br/>
</>)}
{(settings.analyticsEnabled === null && !settings.demoMode) && <TrackingModal/>}
<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'; FredyApp.displayName = 'FredyApp';

View File

@@ -1,7 +1,7 @@
.app { .app {
display:flex; display: flex;
flex-direction: column; flex-direction: column;
width:100%; width: 100%;
&__container { &__container {
padding: 1rem 1rem; padding: 1rem 1rem;
@@ -10,12 +10,13 @@
} }
} }
.ui.inverted.segment{ .ui.inverted.segment {
background: #31303078!important; background: #31303078 !important;
} }
.ui.black.label, .ui.black.labels .label { .ui.black.label,
background-color: #31303078!important; .ui.black.labels .label {
background-color: #31303078 !important;
} }
a:link { a:link {
@@ -40,4 +41,8 @@ a:active {
color: #54a9ff; color: #54a9ff;
background-color: transparent; background-color: transparent;
text-decoration: underline; text-decoration: underline;
} }
.semi-icon:not(.semi-tabs-bar .semi-tabs-tab .semi-icon) {
vertical-align: middle;
}

View File

@@ -23,5 +23,5 @@ root.render(
<App /> <App />
</LocaleProvider> </LocaleProvider>
</HashRouter> </HashRouter>
</Provider> </Provider>,
); );

View File

@@ -1,15 +1,16 @@
body, html { body,
html {
margin: 0; margin: 0;
height: 100%; height: 100%;
width: 100%; width: 100%;
background-color: #232429; background-color: #232429;
} }
.semi-table-row-head{ .semi-table-row-head {
background-color: #2b2b2b !important; background-color: #2b2b2b !important;
color: #fff !important; color: #fff !important;
} }
.semi-table-row-cell { .semi-table-row-cell {
background-color: #333333 !important; background-color: #333333 !important;
} }

View File

@@ -1,5 +1,5 @@
.logo { .logo {
position: absolute; position: absolute;
top: .1rem; top: 0.1rem;
right: 2rem; right: 2rem;
} }

View File

@@ -4,6 +4,7 @@ import { Tabs, TabPane } from '@douyinfe/semi-ui';
import { useLocation } from 'react-router'; import { useLocation } from 'react-router';
import { IconUser, IconTerminal, IconSetting } from '@douyinfe/semi-icons'; import { IconUser, IconTerminal, IconSetting } from '@douyinfe/semi-icons';
import './Menu.less';
function parsePathName(name) { function parsePathName(name) {
const split = name.split('/').filter((s) => s.length !== 0); const split = name.split('/').filter((s) => s.length !== 0);
@@ -14,7 +15,12 @@ const TopMenu = function TopMenu({ isAdmin }) {
const history = useHistory(); const history = useHistory();
const location = useLocation(); const location = useLocation();
return ( return (
<Tabs type="line" activeKey={parsePathName(location.pathname)} onTabClick={(key) => history.push(key)}> <Tabs
className="menu"
type="line"
activeKey={parsePathName(location.pathname)}
onTabClick={(key) => history.push(key)}
>
<TabPane <TabPane
itemKey="/jobs" itemKey="/jobs"
tab={ tab={

View File

@@ -0,0 +1,3 @@
.menu {
margin-top: 3rem;
}

View File

@@ -1,10 +1,10 @@
.place { .place {
height: 100%; height: 100%;
width: 100%; width: 100%;
display:flex; display: flex;
&__place_lines_wrapper{ &__place_lines_wrapper {
width:100%; width: 100%;
} }
&__line { &__line {
@@ -20,17 +20,16 @@
border-radius: 360px; border-radius: 360px;
animation: pulse 1s infinite ease-in-out; animation: pulse 1s infinite ease-in-out;
} }
} }
@keyframes pulse { @keyframes pulse {
0% { 0% {
background-color: rgba(165, 165, 165, 0.1) background-color: rgba(165, 165, 165, 0.1);
} }
50% { 50% {
background-color: rgba(165, 165, 165, 0.3) background-color: rgba(165, 165, 165, 0.3);
} }
100% { 100% {
background-color: rgba(165, 165, 165, 0.1) background-color: rgba(165, 165, 165, 0.1);
} }
} }

View File

@@ -1,4 +1,4 @@
.segmentParts { .segmentParts {
border: 1px solid #323232 !important; border: 1px solid #323232 !important;
border-radius: 5px !important; border-radius: 5px !important;
} }

View File

@@ -3,11 +3,14 @@ import React from 'react';
import { Button, Empty, Table, Switch } from '@douyinfe/semi-ui'; import { Button, Empty, Table, Switch } from '@douyinfe/semi-ui';
import { IconDelete, IconEdit, IconHistogram } from '@douyinfe/semi-icons'; import { IconDelete, IconEdit, IconHistogram } from '@douyinfe/semi-icons';
import { IllustrationNoResult, IllustrationNoResultDark } from '@douyinfe/semi-illustrations'; import { IllustrationNoResult, IllustrationNoResultDark } from '@douyinfe/semi-illustrations';
import './JobTable.less';
const empty = ( const empty = (
<Empty <Empty
image={<IllustrationNoResult />} image={<IllustrationNoResult />}
darkModeImage={<IllustrationNoResultDark />} darkModeImage={<IllustrationNoResultDark />}
description={'No jobs available'} description={'No jobs available.'}
/> />
); );
@@ -25,25 +28,25 @@ export default function JobTable({ jobs = {}, onJobRemoval, onJobStatusChanged,
}, },
}, },
{ {
title: 'Job Name', title: 'Name',
dataIndex: 'name', dataIndex: 'name',
}, },
{ {
title: 'Number of findings', title: 'Findings',
dataIndex: 'numberOfFoundListings', dataIndex: 'numberOfFoundListings',
render: (value) => { render: (value) => {
return value || 0; return value || 0;
}, },
}, },
{ {
title: 'Active provider', title: 'Providers',
dataIndex: 'provider', dataIndex: 'provider',
render: (value) => { render: (value) => {
return value.length || 0; return value.length || 0;
}, },
}, },
{ {
title: 'Active notification adapter', title: 'Notification adapters',
dataIndex: 'notificationAdapter', dataIndex: 'notificationAdapter',
render: (value) => { render: (value) => {
return value.length || 0; return value.length || 0;
@@ -54,19 +57,9 @@ export default function JobTable({ jobs = {}, onJobRemoval, onJobStatusChanged,
dataIndex: 'tools', dataIndex: 'tools',
render: (_, job) => { render: (_, job) => {
return ( return (
<div style={{ float: 'right' }}> <div className="interactions">
<Button <Button type="primary" icon={<IconHistogram />} onClick={() => onJobInsight(job.id)} />
type="primary" <Button type="secondary" icon={<IconEdit />} onClick={() => onJobEdit(job.id)} />
icon={<IconHistogram />}
onClick={() => onJobInsight(job.id)}
style={{ marginRight: '1rem' }}
/>
<Button
type="secondary"
icon={<IconEdit />}
onClick={() => onJobEdit(job.id)}
style={{ marginRight: '1rem' }}
/>
<Button type="danger" icon={<IconDelete />} onClick={() => onJobRemoval(job.id)} /> <Button type="danger" icon={<IconDelete />} onClick={() => onJobRemoval(job.id)} />
</div> </div>
); );

View File

@@ -0,0 +1,12 @@
.interactions {
float: right;
display: flex;
flex-direction: column;
gap: 1rem;
}
@media (min-width: 768px) {
.interactions {
flex-direction: initial;
}
}

View File

@@ -7,10 +7,10 @@ export default function NotificationAdapterTable({ notificationAdapter = [], onR
return ( return (
<Table <Table
pagination={false} pagination={false}
empty={<Empty description="No Data" />} empty={<Empty description="No notification adapters found." />}
columns={[ columns={[
{ {
title: 'Notification Adapter Name', title: 'Name',
dataIndex: 'name', dataIndex: 'name',
}, },

View File

@@ -7,14 +7,14 @@ export default function ProviderTable({ providerData = [], onRemove } = {}) {
return ( return (
<Table <Table
pagination={false} pagination={false}
empty={<Empty description="No Provider available" />} empty={<Empty description="No providers found." />}
columns={[ columns={[
{ {
title: 'Provider Name', title: 'Name',
dataIndex: 'name', dataIndex: 'name',
}, },
{ {
title: 'Provider Url', title: 'URL',
dataIndex: 'url', dataIndex: 'url',
render: (_, data) => { render: (_, data) => {
return ( return (
@@ -30,7 +30,7 @@ export default function ProviderTable({ providerData = [], onRemove } = {}) {
render: (_, record) => { render: (_, record) => {
return ( return (
<div style={{ float: 'right' }}> <div style={{ float: 'right' }}>
<Button type="danger" icon={<IconDelete />} onClick={() => onRemove(record.id)} /> <Button type="danger" icon={<IconDelete />} onClick={() => onRemove(record.url)} />
</div> </div>
); );
}, },

View File

@@ -9,7 +9,7 @@ const empty = (
<Empty <Empty
image={<IllustrationNoResult />} image={<IllustrationNoResult />}
darkModeImage={<IllustrationNoResultDark />} darkModeImage={<IllustrationNoResultDark />}
description={'No user available'} description={'No users found.'}
/> />
); );

View File

@@ -1,48 +1,56 @@
import React from 'react'; import React from 'react';
import {Modal} from '@douyinfe/semi-ui'; import { Modal } from '@douyinfe/semi-ui';
import Logo from '../logo/Logo.jsx'; import Logo from '../logo/Logo.jsx';
import {xhrPost} from '../../services/xhr.js'; import { xhrPost } from '../../services/xhr.js';
import './TrackingModal.less'; import './TrackingModal.less';
import inDevelopment from '../../services/developmentMode.js';
const saveResponse = async (analyticsEnabled) => { const saveResponse = async (analyticsEnabled) => {
await xhrPost('/api/admin/generalSettings', { await xhrPost('/api/admin/generalSettings', {
analyticsEnabled analyticsEnabled,
}); });
}; };
export default function TrackingModal() { export default function TrackingModal() {
if (inDevelopment()) {
return null;
}
return <Modal return (
visible={true} <Modal
onOk={async () => { visible={true}
await saveResponse(true); onOk={async () => {
location.reload(); await saveResponse(true);
}} location.reload();
onCancel={async () => { }}
await saveResponse(false); onCancel={async () => {
location.reload(); await saveResponse(false);
}} location.reload();
maskClosable={false} }}
closable={false} maskClosable={false}
okText="Yes! I want to help" closable={false}
cancelText="No, thanks" okText="Yes! I want to help"
cancelText="No, thanks"
> >
<Logo white/> <Logo white />
<div className="trackingModal__description"> <div className="trackingModal__description">
<p>Hey 👋</p> <p>Hey 👋</p>
<p>Fed up with popups? Yeah, me too. But this ones important, and I promise it will only appear once ;)</p> <p>Fed up with popups? Yeah, me too. But this ones important, and I promise it will only appear once ;)</p>
<p>Fredy is completely free (and will always remain free). If youd like, you can support me by donating <p>
through my GitHub, but theres absolutely no obligation to do so.</p> Fredy is completely free (and will always remain free). If youd like, you can support me by donating through
<p>However, it would be a huge my GitHub, but theres absolutely no obligation to do so.
help if youd allow me to collect some analytical data. Wait, before you click "no", let me explain. If </p>
you <p>
agree, Fredy will send a ping to my Mixpanel project each time it runs.</p> However, it would be a huge help if youd allow me to collect some analytical data. Wait, before you click
<p>The data includes: names of "no", let me explain. If you agree, Fredy will send a ping to my Mixpanel project each time it runs.
active adapters/providers, OS, architecture, Node version, and language. The information is entirely </p>
anonymous and helps me understand which adapters/providers are most frequently used.</p> <p>
<p>Thanks🤘</p> The data includes: names of active adapters/providers, OS, architecture, Node version, and language. The
</div> information is entirely anonymous and helps me understand which adapters/providers are most frequently used.
</Modal>; </p>
<p>Thanks🤘</p>
} </div>
</Modal>
);
}

View File

@@ -1,5 +1,5 @@
.trackingModal { .trackingModal {
&__description { &__description {
margin-top:10rem; margin-top: 10rem;
} }
} }

View File

@@ -0,0 +1,4 @@
export default function isDevelopmentMode() {
const inDevMode = import.meta.env.MODE;
return inDevMode != null && inDevMode === 'development';
}

View File

@@ -129,6 +129,6 @@ function parseJSON(response) {
}); });
} }
}) })
.catch((error) => reject('Error while trying to parse json.', error)) .catch((error) => reject('Error while trying to parse json.', error)),
); );
} }

View File

@@ -1,261 +1,243 @@
import React from 'react'; import React from 'react';
import {useDispatch, useSelector} from 'react-redux'; import { useDispatch, useSelector } from 'react-redux';
import {Divider, TimePicker, Button, Checkbox} from '@douyinfe/semi-ui'; import { Divider, TimePicker, Button, Checkbox } from '@douyinfe/semi-ui';
import {InputNumber} from '@douyinfe/semi-ui'; import { InputNumber } from '@douyinfe/semi-ui';
import Headline from '../../components/headline/Headline'; import Headline from '../../components/headline/Headline';
import {xhrPost} from '../../services/xhr'; import { xhrPost } from '../../services/xhr';
import {SegmentPart} from '../../components/segment/SegmentPart'; import { SegmentPart } from '../../components/segment/SegmentPart';
import {Banner, Toast} from '@douyinfe/semi-ui'; import { Banner, Toast } from '@douyinfe/semi-ui';
import {IconSave, IconCalendar, IconRefresh, IconSignal, IconLineChartStroked, IconSearch} from '@douyinfe/semi-icons'; import {
IconSave,
IconCalendar,
IconRefresh,
IconSignal,
IconLineChartStroked,
IconSearch,
} from '@douyinfe/semi-icons';
import './GeneralSettings.less'; import './GeneralSettings.less';
function formatFromTimestamp(ts) { function formatFromTimestamp(ts) {
const date = new Date(ts); const date = new Date(ts);
return `${date.getHours()}:${date.getMinutes() > 9 ? date.getMinutes() : '0' + date.getMinutes()}`; return `${date.getHours()}:${date.getMinutes() > 9 ? date.getMinutes() : '0' + date.getMinutes()}`;
} }
function formatFromTBackend(time) { function formatFromTBackend(time) {
if (time == null || time.length === 0) { if (time == null || time.length === 0) {
return null; return null;
} }
const date = new Date(); const date = new Date();
const split = time.split(':'); const split = time.split(':');
date.setHours(split[0]); date.setHours(split[0]);
date.setMinutes(split[1]); date.setMinutes(split[1]);
return date.getTime(); return date.getTime();
} }
const GeneralSettings = function GeneralSettings() { const GeneralSettings = function GeneralSettings() {
const dispatch = useDispatch(); const dispatch = useDispatch();
const [loading, setLoading] = React.useState(true); const [loading, setLoading] = React.useState(true);
const settings = useSelector((state) => state.generalSettings.settings); const settings = useSelector((state) => state.generalSettings.settings);
const [interval, setInterval] = React.useState(''); const [interval, setInterval] = React.useState('');
const [port, setPort] = React.useState(''); const [port, setPort] = React.useState('');
const [workingHourFrom, setWorkingHourFrom] = React.useState(null); const [workingHourFrom, setWorkingHourFrom] = React.useState(null);
const [workingHourTo, setWorkingHourTo] = React.useState(null); const [workingHourTo, setWorkingHourTo] = React.useState(null);
const [demoMode, setDemoMode] = React.useState(null); const [demoMode, setDemoMode] = React.useState(null);
const [analyticsEnabled, setAnalyticsEnabled] = React.useState(null); const [analyticsEnabled, setAnalyticsEnabled] = React.useState(null);
React.useEffect(() => { React.useEffect(() => {
async function init() { async function init() {
await dispatch.generalSettings.getGeneralSettings(); await dispatch.generalSettings.getGeneralSettings();
setLoading(false); setLoading(false);
} }
init(); init();
}, []); }, []);
React.useEffect(() => { React.useEffect(() => {
async function init() { async function init() {
setInterval(settings?.interval); setInterval(settings?.interval);
setPort(settings?.port); setPort(settings?.port);
setWorkingHourFrom(settings?.workingHours?.from); setWorkingHourFrom(settings?.workingHours?.from);
setWorkingHourTo(settings?.workingHours?.to); setWorkingHourTo(settings?.workingHours?.to);
setAnalyticsEnabled(settings?.analyticsEnabled || false); setAnalyticsEnabled(settings?.analyticsEnabled || false);
setDemoMode(settings?.demoMode || false); setDemoMode(settings?.demoMode || false);
} }
init(); init();
}, [settings]); }, [settings]);
const nullOrEmpty = (val) => val == null || val.length === 0; const nullOrEmpty = (val) => val == null || val.length === 0;
const throwMessage = (message, type) => { const onStore = async () => {
if (type === 'error') { if (nullOrEmpty(interval)) {
Toast.error(message); Toast.error('Interval may not be empty.');
} else { return;
Toast.success(message); }
} if (nullOrEmpty(port)) {
}; Toast.error('Port may not be empty.');
return;
}
if (
(!nullOrEmpty(workingHourFrom) && nullOrEmpty(workingHourTo)) ||
(nullOrEmpty(workingHourFrom) && !nullOrEmpty(workingHourTo))
) {
Toast.error('Working hours to and from must be set if either to or from has been set before.');
return;
}
try {
await xhrPost('/api/admin/generalSettings', {
interval,
port,
workingHours: {
from: workingHourFrom,
to: workingHourTo,
},
demoMode,
analyticsEnabled,
});
} catch (exception) {
console.error(exception);
if (exception?.json?.message != null) {
Toast.error(exception.json.message);
} else {
Toast.error('Error while trying to store settings.');
}
return;
}
Toast.success('Settings stored successfully. We will reload your browser in 3 seconds.');
setTimeout(() => {
location.reload();
}, 3000);
};
const onStore = async () => { return (
if (nullOrEmpty(interval)) { <div>
throwMessage('Interval may not be empty.', 'error'); {!loading && (
return; <React.Fragment>
} <Headline text="General Settings" />
if (nullOrEmpty(port)) { <div>
throwMessage('Port may not be empty.', 'error'); <SegmentPart
return; name="Interval"
} helpText="Interval in minutes for running queries against the configured services."
if ( Icon={IconRefresh}
(!nullOrEmpty(workingHourFrom) && nullOrEmpty(workingHourTo)) || >
(nullOrEmpty(workingHourFrom) && !nullOrEmpty(workingHourTo)) <InputNumber
) { min={0}
throwMessage('Working hours to and from must be set if either to or from has been set before.', 'error'); max={1440}
return; placeholder="Interval in minutes"
} value={interval}
try { formatter={(value) => `${value}`.replace(/\D/g, '')}
await xhrPost('/api/admin/generalSettings', { onChange={(value) => setInterval(value)}
interval, suffix={'minutes'}
port, />
workingHours: { </SegmentPart>
from: workingHourFrom, <Divider margin="1rem" />
to: workingHourTo, <SegmentPart name="Port" helpText="Port on which Fredy is running." Icon={IconSignal}>
}, <InputNumber
demoMode, min={0}
analyticsEnabled max={99999}
}); placeholder="Port"
} catch (exception) { value={port}
console.error(exception); formatter={(value) => `${value}`.replace(/\D/g, '')}
if(exception?.json?.message != null){ onChange={(value) => setPort(value)}
throwMessage(exception.json.message, 'error'); />
}else { </SegmentPart>
throwMessage('Error while trying to store settings.', 'error'); <Divider margin="1rem" />
} <SegmentPart
return; name="Working hours"
} helpText="During this hours, Fredy will search for new apartments. If nothing is configured, Fredy will search around the clock."
throwMessage('Settings stored successfully. We will reload your browser in 3 seconds.', 'success'); Icon={IconCalendar}
setTimeout(()=>{ >
location.reload(); <div className="generalSettings__timePickerContainer">
}, 3000); <TimePicker
}; format={'HH:mm'}
insetLabel="From"
value={formatFromTBackend(workingHourFrom)}
placeholder=""
onChange={(val) => {
setWorkingHourFrom(val == null ? null : formatFromTimestamp(val));
}}
/>
<TimePicker
format={'HH:mm'}
insetLabel="Until"
value={formatFromTBackend(workingHourTo)}
placeholder=""
onChange={(val) => {
setWorkingHourTo(val == null ? null : formatFromTimestamp(val));
}}
/>
</div>
</SegmentPart>
<Divider margin="1rem" />
return ( <SegmentPart name="Analytics" helpText="Insights into the usage of Fredy." Icon={IconLineChartStroked}>
<div> <Banner
{!loading && ( fullMode={false}
<React.Fragment> type="info"
<Headline text="General Settings"/> closeIcon={null}
<div> title={<div style={{ fontWeight: 600, fontSize: '14px', lineHeight: '20px' }}>Explanation</div>}
<SegmentPart style={{ marginBottom: '1rem' }}
name="Interval" description={
helpText="Interval in minutes for running queries against the configured services." <div>
Icon={IconRefresh} Analytics are disabled by default. If you choose to enable them, we will begin tracking the
> following:
<InputNumber <br />
min={0} <ul>
max={1440} <li>Name of active provider (e.g. Immoscout)</li>
placeholder="Interval in minutes" <li>Name of active adapter (e.g. Console)</li>
value={interval} <li>language</li>
formatter={(value) => `${value}`.replace(/\D/g, '')} <li>os</li>
onChange={(value) => setInterval(value)} <li>node version</li>
suffix={'minutes'} <li>arch</li>
/> </ul>
</SegmentPart> The data is sent anonymously and helps me understand which providers or adapters are being used the
<Divider margin="1rem"/> most. In the end it helps me to improve fredy.
<SegmentPart name="Port" helpText="Port on which Fredy is running." Icon={IconSignal}> </div>
<InputNumber }
min={0} />
max={99999}
placeholder="Port"
value={port}
formatter={(value) => `${value}`.replace(/\D/g, '')}
onChange={(value) => setPort(value)}
/>
</SegmentPart>
<Divider margin="1rem"/>
<SegmentPart
name="Working hours"
helpText="During this hours, Fredy will search for new apartments. If nothing is configured, Fredy will search around the clock."
Icon={IconCalendar}
>
<div className="generalSettings__timePickerContainer">
<TimePicker
format={'HH:mm'}
insetLabel="From"
value={formatFromTBackend(workingHourFrom)}
placeholder=""
onChange={(val) => {
setWorkingHourFrom(val == null ? null : formatFromTimestamp(val));
}}
/>
<TimePicker
format={'HH:mm'}
insetLabel="Until"
value={formatFromTBackend(workingHourTo)}
placeholder=""
onChange={(val) => {
setWorkingHourTo(val == null ? null : formatFromTimestamp(val));
}}
/>
</div>
</SegmentPart>
<Divider margin="1rem"/>
<SegmentPart <Checkbox checked={analyticsEnabled} onChange={(e) => setAnalyticsEnabled(e.target.checked)}>
name="Analytics" {' '}
helpText="Insights into the usage of Fredy." Enabled
Icon={IconLineChartStroked} </Checkbox>
> </SegmentPart>
<Banner
fullMode={false}
type="info"
closeIcon={null}
title={
<div style={{fontWeight: 600, fontSize: '14px', lineHeight: '20px'}}>
Explanation
</div>
}
style={{marginBottom: '1rem'}}
description={
<div>
Analytics are disabled by default. If you choose to enable them, we will begin tracking the following:<br/>
<ul>
<li>Name of active provider (e.g. Immoscout)</li>
<li>Name of active adapter (e.g. Console)</li>
<li>language</li>
<li>os</li>
<li>node version</li>
<li>arch</li>
</ul>
The data is sent anonymously and helps me understand which providers or adapters are being used the most. In the end it helps me to improve fredy.
</div>
}
/>
<Checkbox <Divider margin="1rem" />
checked={analyticsEnabled}
onChange={(e) => setAnalyticsEnabled(e.target.checked)}
> Enabled
</Checkbox>
</SegmentPart> <SegmentPart name="Demo Mode" helpText="If enabled, Fredy runs in demo mode." Icon={IconSearch}>
<Banner
fullMode={false}
type="info"
closeIcon={null}
title={<div style={{ fontWeight: 600, fontSize: '14px', lineHeight: '20px' }}>Explanation</div>}
style={{ marginBottom: '1rem' }}
description={
<div>
In demo mode, Fredy will not (really) search for any real estates. Fredy is in a lockdown mode. Also
all database files will be set back to the default values at midnight.
</div>
}
/>
<Divider margin="1rem"/> <Checkbox checked={demoMode} onChange={(e) => setDemoMode(e.target.checked)}>
{' '}
Enabled
</Checkbox>
</SegmentPart>
<SegmentPart <Divider margin="1rem" />
name="Demo Mode" <Button type="primary" theme="solid" onClick={onStore} icon={<IconSave />}>
helpText="If enabled, Fredy runs in demo mode." Save
Icon={IconSearch} </Button>
> </div>
<Banner </React.Fragment>
fullMode={false} )}
type="info" </div>
closeIcon={null} );
title={
<div style={{fontWeight: 600, fontSize: '14px', lineHeight: '20px'}}>
Explanation
</div>
}
style={{marginBottom: '1rem'}}
description={
<div>
In demo mode, Fredy will not (really) search for any real estates. Fredy is in a lockdown mode. Also
all database files will be set back to the default values at midnight.
</div>
}
/>
<Checkbox
checked={demoMode}
onChange={(e) => setDemoMode(e.target.checked)}
> Enabled
</Checkbox>
</SegmentPart>
<Divider margin="1rem"/>
<Button type="primary" theme="solid" onClick={onStore} icon={<IconSave/>}>
Save
</Button>
</div>
</React.Fragment>
)}
</div>
);
}; };
export default GeneralSettings; export default GeneralSettings;

View File

@@ -5,9 +5,8 @@
gap: 1rem; gap: 1rem;
} }
&__help{ &__help {
font-size: 11px; font-size: 11px;
margin-left: 1rem; margin-left: 1rem;
} }
} }

View File

@@ -1,7 +1,7 @@
.jobs { .jobs {
&__newButton{ &__newButton {
margin-top:1rem !important; margin-top: 1rem !important;
float: right; float: right;
margin-bottom: 1rem !important; margin-bottom: 1rem !important;
} }
} }

Some files were not shown because too many files have changed in this diff Show More