Rename extension

.github/workflows/test.yml

@@ -55,8 +55,8 @@ jobs:
         sed -i -e 's/use = config:.*/use = config:\/srv\/app\/src\/ckan\/test-core.ini/' test.ini
 
         ckan -c test.ini db init
-        ckan -c test.ini db upgrade -p tracking
+        ckan -c test.ini db upgrade -p api_tracking
 
     - name: Run tests
-      run: pytest --ckan-ini=test.ini -v --disable-warnings ckanext/tracking
+      run: pytest --ckan-ini=test.ini -v --disable-warnings ckanext/api_tracking
 

MANIFEST.in

@@ -1,5 +1,5 @@
 include README.md
 include LICENSE
 include requirements.txt
-recursive-include ckanext/tracking *.html *.json *.js *.less *.css *.mo *.yml
-recursive-include ckanext/tracking/migration *.ini *.py *.mako
+recursive-include ckanext/api_tracking *.html *.json *.js *.less *.css *.mo *.yml
+recursive-include ckanext/api_tracking/migration *.ini *.py *.mako

ckanext/api_tracking/__init__.py

@@ -0,0 +1 @@
+__VERSION__ = '0.4.0'

ckanext/tracking/actions/queries.py → ckanext/api_tracking/actions/queries.py

@@ -1,5 +1,5 @@
 from ckan.plugins import toolkit
-from ckanext.tracking.queries.api import (
+from ckanext.api_tracking.queries.api import (
     get_all_token_usage,
     get_most_accessed_dataset_with_token,
     get_most_accessed_token,

ckanext/api_tracking/blueprints/__init__.py

@@ -0,0 +1,4 @@
+# flake8: noqa: F401
+
+from ckanext.api_tracking.blueprints.csv import tracking_csv_blueprint
+from ckanext.api_tracking.blueprints.dashboard import tracking_dashboard_blueprint

ckanext/tracking/blueprints/csv.py → ckanext/api_tracking/blueprints/csv.py

@@ -6,7 +6,7 @@
 from ckan.common import current_user
 from ckan.plugins import toolkit
 
-from ckanext.tracking.queries.data import (
+from ckanext.api_tracking.queries.data import (
     all_token_usage_data,
     most_accessed_token_data,
     most_accessed_dataset_with_token_data,

ckanext/tracking/blueprints/dashboard.py → ckanext/api_tracking/blueprints/dashboard.py

@@ -2,9 +2,9 @@
 from flask import Blueprint
 from ckan.plugins.toolkit import render, h
 from ckanext.stats import stats as stats_lib
-from ckanext.tracking.dashboard.stats import get_dataset_views, get_unique_dataset_views, get_resource_downloads
-from ckanext.tracking.dashboard.stats_api import get_api_token_usage_aggregated, get_latest_api_token_usage
-from ckanext.tracking.decorators import require_sysadmin_user
+from ckanext.api_tracking.dashboard.stats import get_dataset_views, get_unique_dataset_views, get_resource_downloads
+from ckanext.api_tracking.dashboard.stats_api import get_api_token_usage_aggregated, get_latest_api_token_usage
+from ckanext.api_tracking.decorators import require_sysadmin_user
 
 
 log = logging.getLogger(__name__)

ckanext/tracking/dashboard/sql/viewed-datasets-unique.sql → ckanext/api_tracking/dashboard/sql/viewed-datasets-unique.sql

@@ -4,7 +4,7 @@ If a user views a dataset multiple times in a period, it will only be counted on
 
 Based on the tracking_raw table because the tracking_summary table does not allow to count unique views in a period.
 
-This query is used in ckanext/tracking/dashboard/stats.py module to collect views statistics.
+This query is used in ckanext/api_tracking/dashboard/stats.py module to collect views statistics.
 */
 
 SELECT 

ckanext/tracking/dashboard/stats.py → ckanext/api_tracking/dashboard/stats.py

@@ -4,7 +4,7 @@
 import logging
 from datetime import datetime, timedelta
 from ckan import model
-from ckanext.tracking.dashboard import query_results
+from ckanext.api_tracking.dashboard import query_results
 
 
 log = logging.getLogger(__name__)

ckanext/tracking/dashboard/stats_api.py → ckanext/api_tracking/dashboard/stats_api.py

@@ -3,7 +3,7 @@
 """
 import logging
 from ckan.plugins import toolkit
-from ckanext.tracking.queries.data import (
+from ckanext.api_tracking.queries.data import (
     all_token_usage_data,
     most_accessed_token_data,
     most_accessed_dataset_with_token_data,

ckanext/tracking/interfaces.py → ckanext/api_tracking/interfaces.py

@@ -1,7 +1,7 @@
 import logging
 from ckan import plugins
 from ckan.plugins.interfaces import Interface
-from ckanext.tracking.models import TrackingUsage, CKANURL
+from ckanext.api_tracking.models import TrackingUsage, CKANURL
 
 
 log = logging.getLogger(__name__)

ckanext/tracking/middleware.py → ckanext/api_tracking/middleware.py

@@ -7,7 +7,7 @@
 from ckan.model import ApiToken
 from ckan.types import CKANApp
 
-from ckanext.tracking.interfaces import IUsage
+from ckanext.api_tracking.interfaces import IUsage
 
 
 log = logging.getLogger(__name__)

ckanext/api_tracking/models/__init__.py

@@ -0,0 +1,4 @@
+# flake8: noqa: F401
+
+from ckanext.api_tracking.models.tracking import TrackingUsage
+from ckanext.api_tracking.models.url import CKANURL

ckanext/tracking/plugin.py → ckanext/api_tracking/plugin.py

@@ -2,12 +2,12 @@
 from ckan import plugins
 from ckan.plugins import toolkit
 
-from ckanext.tracking import blueprints
-from ckanext.tracking.interfaces import IUsage
-from ckanext.tracking.middleware import TrackingUsageMiddleware
-from ckanext.tracking.auth import csv as auth_csv
-from ckanext.tracking.auth import queries as auth_queries
-from ckanext.tracking.actions import queries as action_queries
+from ckanext.api_tracking import blueprints
+from ckanext.api_tracking.interfaces import IUsage
+from ckanext.api_tracking.middleware import TrackingUsageMiddleware
+from ckanext.api_tracking.auth import csv as auth_csv
+from ckanext.api_tracking.auth import queries as auth_queries
+from ckanext.api_tracking.actions import queries as action_queries
 
 
 log = logging.getLogger(__name__)

ckanext/tracking/queries/api.py → ckanext/api_tracking/queries/api.py

@@ -1,6 +1,6 @@
 from ckan import model
 from sqlalchemy import func, desc
-from ckanext.tracking.models import TrackingUsage
+from ckanext.api_tracking.models import TrackingUsage
 
 
 def get_most_accessed_dataset_with_token(limit=10):

ckanext/api_tracking/queries/data/__init__.py

@@ -0,0 +1,5 @@
+# flake8: noqa: F401
+
+from ckanext.api_tracking.queries.data.all import all_token_usage_data
+from ckanext.api_tracking.queries.data.dataset import most_accessed_dataset_with_token_data
+from ckanext.api_tracking.queries.data.token import most_accessed_token_data

ckanext/tracking/queries/data/all.py → ckanext/api_tracking/queries/data/all.py

@@ -6,7 +6,7 @@
 from ckan import model
 from ckan.plugins import toolkit
 
-from ckanext.tracking.queries.api import get_all_token_usage
+from ckanext.api_tracking.queries.api import get_all_token_usage
 
 
 log = logging.getLogger(__name__)

ckanext/tracking/queries/data/dataset.py → ckanext/api_tracking/queries/data/dataset.py

@@ -6,7 +6,7 @@
 from ckan import model
 from ckan.plugins import toolkit
 
-from ckanext.tracking.queries.api import get_most_accessed_dataset_with_token
+from ckanext.api_tracking.queries.api import get_most_accessed_dataset_with_token
 
 
 log = logging.getLogger(__name__)

ckanext/tracking/queries/data/token.py → ckanext/api_tracking/queries/data/token.py

@@ -6,7 +6,7 @@
 from ckan import model
 from ckan.plugins import toolkit
 
-from ckanext.tracking.queries.api import get_most_accessed_token
+from ckanext.api_tracking.queries.api import get_most_accessed_token
 
 
 log = logging.getLogger(__name__)

ckanext/tracking/tests/factories.py → ckanext/api_tracking/tests/factories.py

@@ -2,7 +2,7 @@
 from ckan import model
 from ckan.plugins import toolkit
 from ckantoolkit.tests import factories
-from ckanext.tracking.models import TrackingUsage
+from ckanext.api_tracking.models import TrackingUsage
 
 
 class TrackingUsageF(factory.Factory):

ckanext/api_tracking/tests/fixtures.py

@@ -0,0 +1,7 @@
+import pytest
+
+
+@pytest.fixture
+def api_tracking_migrate(migrate_db_for):
+    """ Apply the tracking migrations """
+    migrate_db_for('api_tracking')

ckanext/tracking/tests/test_csv.py → ckanext/api_tracking/tests/test_csv.py

@@ -4,7 +4,7 @@
 from ckan.lib.helpers import url_for
 from ckan.tests import factories
 
-from ckanext.tracking.tests import factories as tf
+from ckanext.api_tracking.tests import factories as tf
 
 
 @pytest.fixture
@@ -24,7 +24,7 @@ def base_data():
     return obj
 
 
-@pytest.mark.usefixtures('clean_db', 'tracking_migrate')
+@pytest.mark.usefixtures('clean_db', 'api_tracking_migrate')
 class TestTrackingCSVView:
     """ Test basic tracking from requests """
     def test_dataset_with_token_csv_no_user(self, app):

ckanext/tracking/tests/test_dashboard_tab.py → ckanext/api_tracking/tests/test_dashboard_tab.py

@@ -18,7 +18,7 @@ def setup_data():
     return obj
 
 
-@pytest.mark.usefixtures('clean_db', 'clean_index', 'tracking_migrate')
+@pytest.mark.usefixtures('clean_db', 'clean_index', 'api_tracking_migrate')
 class TestDashboardTab:
     """ Test who can see the dashboard tab """
     def test_member_admin_cant_see(self, app, setup_data):

ckanext/tracking/tests/test_dashboard_tabs.py → ckanext/api_tracking/tests/test_dashboard_tabs.py

@@ -30,7 +30,7 @@ def setup_data():
     return obj
 
 
-@pytest.mark.usefixtures('clean_db', 'clean_index', 'tracking_migrate')
+@pytest.mark.usefixtures('clean_db', 'clean_index', 'api_tracking_migrate')
 class TestDashboardTabs:
     """ Test dashboard tabks """
     def _test_dashboard_tab(self, app, user, fn, status):

ckanext/tracking/tests/test_plugin.py → ckanext/api_tracking/tests/test_plugin.py

@@ -51,7 +51,7 @@ def test_some_action():
 from ckan import plugins
 
 
-@pytest.mark.ckan_config("ckan.plugins", "tracking")
+@pytest.mark.ckan_config("ckan.plugins", "api_tracking")
 @pytest.mark.usefixtures("with_plugins")
 def test_plugin():
-    assert plugins.plugin_loaded("tracking")
+    assert plugins.plugin_loaded("api_tracking")

ckanext/tracking/tests/test_tracking_basic.py → ckanext/api_tracking/tests/test_tracking_basic.py

@@ -3,7 +3,7 @@
 from ckan.lib.helpers import url_for
 from ckan.tests import factories
 
-from ckanext.tracking.models.tracking import TrackingUsage
+from ckanext.api_tracking.models.tracking import TrackingUsage
 
 
 class TestTrackingUsageBasic:

conftest.py

@@ -1,3 +1,3 @@
 pytest_plugins = [
-    u'ckanext.tracking.tests.fixtures',
+    u'ckanext.api_tracking.tests.fixtures',
 ]

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "ckanext-tracking"
+name = "ckanext-api-tracking"
 # see tool.setuptools.dynamic in this file
 dynamic = ["version"]
 description = "CKAN extension to track users activity"
@@ -29,8 +29,8 @@ classifiers = [
 ]
 
 [project.urls]
-"Homepage" = "https://github.com/NorwegianRefugeeCouncil/ckanext-tracking"
-"Issues" = "https://github.com/NorwegianRefugeeCouncil/ckanext-tracking/issues"
+"Homepage" = "https://github.com/NorwegianRefugeeCouncil/ckanext-api-tracking"
+"Issues" = "https://github.com/NorwegianRefugeeCouncil/ckanext-api-tracking/issues"
 
 # [project.dependencies]
 # Dependencies should be listed in requirements.txt as per CKAN extension best practices
@@ -54,7 +54,7 @@ namespaces = true
 include = ["*"]
 
 [tool.setuptools.dynamic]
-version = {attr = "ckanext.tracking.__VERSION__"}
+version = {attr = "ckanext.api_tracking.__VERSION__"}
 
 [tool.setuptools.data-files]
 # Data files can be listed here
@@ -67,7 +67,7 @@ version = {attr = "ckanext.tracking.__VERSION__"}
 # your_command = "your_module:main"
 
 [project.entry-points."ckan.plugins"]
-tracking = "ckanext.tracking.plugin:TrackingPlugin"
+api_tracking = "ckanext.api_tracking.plugin:TrackingPlugin"
 
 [project.entry-points."babel.extractors"]
 ckan = "ckan.lib.extract:extract_ckan"

test.ini

@@ -4,16 +4,11 @@ smtp_server = localhost
 error_email_from = ckan@localhost
 
 [app:main]
-ckan.datastore.read_url = postgresql://datastore_read:pass@postgresql_nrc/datastore_test
-ckan.datastore.write_url = postgresql://datastore_write:pass@postgresql_nrc/datastore_test
-solr_url = http://solr_nrc:8983/solr/ckan
-ckan.redis.url = redis://redis_nrc:6379/0
-sqlalchemy.url = postgresql://ckan_default:pass@postgresql_nrc/ckan_test
 use = config:../../ckan/test-core.ini
 
 # Insert any custom config settings to be used when running your extension's
 # tests here. These will override the one defined in CKAN core's test-core.ini
-ckan.plugins = tracking
+ckan.plugins = api_tracking
 
 
 # Logging configuration