moonito

Moonito - Traffic Filtering and Analytics Made Easy

Moonito is a Node.js and TypeScript module designed for traffic filtering and analytics. It helps protect your application by evaluating and blocking potentially malicious traffic based on IP, User-Agent, and visitor activity information. With Moonito, you can safeguard your website from bots, competitors, and unwanted traffic while gaining valuable insights about your visitors. To use Moonito, you need an API key and a subscription to the Moonito service. For more details, review our Moonito documentation.

Installation

Install Moonito using npm:

npm install moonito -s

Usage

Method 1: Using Express Middleware

import express from 'express';
import { VisitorTrafficFiltering } from 'moonito';

// Create an Express application
const app = express();
const port = 3000;

/**
 * Configuration object for VisitorTrafficFiltering
 * This configuration is used to set up the AnalyticsHandler instance for handling visitor requests.
 * To use the API, you need to set up your public and secret API keys.
 *
 * Visit https://moonito.net/api for more details.
 */
const config = {
    isProtected: true, // Enable protection for the site (true) or disable it (false)
    apiPublicKey: 'Your API Public Key', // Enter your API Public Key here
    apiSecretKey: 'Your API Secret Key', // Enter your API Secret Key here
    unwantedVisitorTo: 'https://google.com', // URL or HTTP error code for unwanted visitors based on `unwantedVisitorAction`
    unwantedVisitorAction: 1 // Action to take for unwanted visitors: 1 = Redirect, 2 = Iframe, 3 = Load content
};

// Create an instance of VisitorTrafficFiltering with the provided configuration
const filter = new VisitorTrafficFiltering(config);

// Middleware function to handle visitor requests.
app.use(async (req, res, next) => {
    try {
        await filter.evaluateVisitor(req, res);
    } catch (error) {
        return next(error);
    }
    next(!res.headersSent ? undefined : null);
});

// Route handler for the root URL
app.get('/', (req, res) => {
    res.send('Hello World!');
});

// Start the Express server and listen on the specified port
app.listen(port, () => {
    console.log(`Server running at http://localhost:${port}`);
});

Method 2: Manually Providing IP, User-Agent, Events, and Domain

const { VisitorTrafficFiltering } = require('moonito');

/**
 * Configuration object for VisitorTrafficFiltering
 * This configuration is used to set up the AnalyticsHandler instance for handling visitor requests.
 * To use the API, you need to set up your public and secret API keys.
 *
 * Visit https://moonito.net/api for more details.
 */
const config = {
    isProtected: true, // Enable protection for the site (true) or disable it (false)
    apiPublicKey: 'Your API Public Key', // Enter your API Public Key here
    apiSecretKey: 'Your API Secret Key', // Enter your API Secret Key here
    unwantedVisitorTo: 'https://google.com', // URL or HTTP error code for unwanted visitors based on `unwantedVisitorAction`
    unwantedVisitorAction: 1 // Action to take for unwanted visitors: 1 = Redirect, 2 = Iframe, 3 = Load content
};

// Create an instance of VisitorTrafficFiltering with the provided configuration
const filter = new VisitorTrafficFiltering(config);

// Example visitor data
const userIP = '1.1.1.1'; // Replace with the visitor's IP
const userAgent = 'Mozilla/5.0 ...'; // Replace with the visitor's User-Agent
const event = 'page-view'; // Example event
const domain = 'npm-test.dev'; // Example domain

// Manually evaluate visitor
filter.evaluateVisitorManually(userIP, userAgent, event, domain)
    .then(result => {
        console.log('Visitor evaluation result:', result);

        if (result.need_to_block) {
            // You can handle blocked content here, e.g., displaying it on the page or redirecting
            console.log('Blocked content:', result.content);
            return;
        }

        console.log('Visitor is not blocked.');
    })
    .catch(error => {
        console.error('Unexpected error:', error);
    });

Replace Your API Public Key and Your API Secret Key with your actual Moonito API credentials in both methods.

Contributing

We welcome contributions! For significant changes, please open an issue to discuss the proposed modifications. Make sure to update tests as necessary.

License

This project is licensed under the MIT license.