├── .circleci └── config.yml ├── .gitignore ├── AUTHORS ├── CONTRIBUTING.md ├── LICENSE ├── MANIFEST.in ├── README.md ├── circle.yml ├── django_seo_js ├── __init__.py ├── backends │ ├── __init__.py │ ├── base.py │ ├── prerender.py │ └── test.py ├── helpers.py ├── middleware │ ├── __init__.py │ ├── escaped_fragment.py │ ├── hashbang.py │ └── useragent.py ├── settings.py ├── templatetags │ ├── __init__.py │ └── django_seo_js.py └── tests │ ├── __init__.py │ ├── backends │ ├── __init__.py │ ├── test_base.py │ ├── test_prerender_hosted.py │ └── test_prerender_io.py │ ├── test_helpers.py │ ├── test_middlewares.py │ ├── test_pep8.py │ ├── test_templatetags.py │ └── utils.py ├── fabfile.py ├── manage.py ├── requirements.dev.txt ├── requirements.tests.txt ├── requirements.txt ├── runtime.txt ├── settings.py ├── setup.py └── tox.ini /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | # Use the latest 2.1 version of CircleCI pipeline process engine. 2 | # See: https://circleci.com/docs/2.0/configuration-reference 3 | version: 2.1 4 | 5 | # Orbs are reusable packages of CircleCI configuration that you may share across projects, enabling you to create encapsulated, parameterized commands, jobs, and executors that can be used across multiple projects. 6 | # See: https://circleci.com/docs/2.0/orb-intro/ 7 | orbs: 8 | # The python orb contains a set of prepackaged CircleCI configuration you can use repeatedly in your configuration files 9 | # Orb commands and jobs help you with common scripting around a language/tool 10 | # so you dont have to copy and paste it everywhere. 11 | # See the orb documentation here: https://circleci.com/developer/orbs/orb/circleci/python 12 | python: circleci/python@1.2 13 | 14 | # Define a job to be invoked later in a workflow. 15 | # See: https://circleci.com/docs/2.0/configuration-reference/#jobs 16 | jobs: 17 | build-and-test: # This is the name of the job, feel free to change it to better match what you're trying to do! 18 | # These next lines defines a Docker executors: https://circleci.com/docs/2.0/executor-types/ 19 | # You can specify an image from Dockerhub or use one of the convenience images from CircleCI's Developer Hub 20 | # A list of available CircleCI Docker convenience images are available here: https://circleci.com/developer/images/image/cimg/python 21 | # The executor is the environment in which the steps below will be executed - below will use a python 3.8 container 22 | # Change the version below to your required version of python 23 | docker: 24 | - image: cimg/python:3.8 25 | # Checkout the code as the first step. This is a dedicated CircleCI step. 26 | # The python orb's install-packages step will install the dependencies from a Pipfile via Pipenv by default. 27 | # Here we're making sure we use just use the system-wide pip. By default it uses the project root's requirements.txt. 28 | # Then run your tests! 29 | # CircleCI will report the results back to your VCS provider. 30 | steps: 31 | - checkout 32 | - python/install-packages: 33 | pkg-manager: pip 34 | # app-dir: ~/project/package-directory/ # If you're requirements.txt isn't in the root directory. 35 | pip-dependency-file: requirements.tests.txt # if you have a different name for your requirements file, maybe one that combines your runtime and test requirements. 36 | - run: 37 | name: Run tests 38 | # This assumes pytest is installed via the install-package step above 39 | command: tox 40 | 41 | # Invoke jobs via workflows 42 | # See: https://circleci.com/docs/2.0/configuration-reference/#workflows 43 | workflows: 44 | sample: # This is the name of the workflow, feel free to change it to better match your workflow. 45 | # Inside the workflow, you define the jobs you want to run. 46 | jobs: 47 | - build-and-test 48 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | 3 | # C extensions 4 | *.so 5 | 6 | # Packages 7 | *.egg 8 | *.egg-info 9 | dist 10 | build 11 | eggs 12 | parts 13 | bin 14 | var 15 | sdist 16 | develop-eggs 17 | .installed.cfg 18 | lib 19 | lib64 20 | __pycache__ 21 | 22 | # Installer logs 23 | pip-log.txt 24 | 25 | # Unit test / coverage reports 26 | .coverage 27 | .tox 28 | nosetests.xml 29 | .mr.developer.cfg 30 | .project 31 | .pydevproject 32 | .dewey_autocomplete.sh 33 | 34 | README.html 35 | 36 | shelf.db 37 | .idea/* 38 | venv 39 | 40 | django_seo_js/.DS_Store 41 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Steven Skoczen - https://github.com/skoczen 2 | alex-mcleod - https://github.com/alex-mcleod 3 | andrewebdev - https://github.com/andrewebdev 4 | denisvlr - https://github.com/denisvlr 5 | mattrobenolt - https://github.com/mattrobenolt 6 | thoop - https://github.com/thoop 7 | rchrd2 - https://github.com/rchrd2 8 | chazcb - https://github.com/chazcb 9 | Pi Delport - https://github.com/pjdelport 10 | Paul Craciunoiu - https://github.com/pcraciunoiu 11 | jdotjdot - https://github.com/jdotjdot 12 | zekzekus - https://github.com/zekzekus 13 | bhoop77 - https://github.com/bhoop77 14 | varrocs - https://github.com/varrocs 15 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | This is a first pass at a contribution doc, and will change, but for starters: 2 | 3 | - Incoming code should follow PEP8 (there's a test to help out on this.) 4 | - If you add new core-level features, write some quick docs in the README. If you're not sure if they're needed, just ask! 5 | - Add your name and attribution to the AUTHORS file. 6 | - Know you have our thanks for helping to make django-seo-js even better! 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2014 GreenKahuna 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md AUTHORS LICENSE 2 | include *.txt 3 | include *.md 4 | include *.py 5 | recursive-include django_seo_js/templates * 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | django-seo-js 2 | ============= 3 | 4 | [![Build Status](https://circleci.com/gh/skoczen/django-seo-js/tree/master.svg?style=svg&circle-token=90ca5d5cbeb2af20bc378faf1b196e6c03e69f26)](https://circleci.com/gh/skoczen/django-seo-js/tree/master) ![Pypi Badge](https://badge.fury.io/py/django-seo-js.png) ![Downloads Badge](https://img.shields.io/pypi/dm/django-seo-js.svg) 5 | 6 | django-seo-js is a drop-in app that provides full SEO support for angular, backbone, ember, famo.us, and other SPA apps built with django. 7 | 8 | It's simple to set up, configurable to use multiple services, and easy to customize. 9 | 10 | Quick-links: 11 | - [Installation](#installation) 12 | - [Options](#options) 13 | - [General Settings](#General-Settings) 14 | - [Backend settings](#Backend-settings) 15 | - [Prerender.io](#Prerender-io) 16 | - [Custom-hosted prerender](#custom-hosted-prerender) 17 | - [Advanced Usage](#advanced-usage) 18 | - [Updating the render cache](#updating-the-render-cache) 19 | - [How it all works](#how-it-all-works) 20 | - [Contributing](#contributing) 21 | - [Code](#code) 22 | - [Culture](#culture) 23 | - [Authors](#authors) 24 | - [Releases](#releases) 25 | 26 | 27 | # Installation 28 | 29 | 1. Pip install: 30 | 31 | ```bash 32 | pip install django-seo-js 33 | ``` 34 | 35 | 36 | 2. Add to your `settings.py`: 37 | 38 | ```python 39 | # If in doubt, just include both. Details below. 40 | MIDDLEWARE_CLASSES = ( 41 | 'django_seo_js.middleware.EscapedFragmentMiddleware', # If you're using #! 42 | 'django_seo_js.middleware.UserAgentMiddleware', # If you want to detect by user agent 43 | ) + MIDDLEWARE_CLASSES 44 | 45 | INSTALLED_APPS += ('django_seo_js',) 46 | 47 | # If you're using prerender.io (the default backend): 48 | SEO_JS_PRERENDER_TOKEN = "123456789abcdefghijkl" # Really, put this in your env, not your codebase. 49 | ``` 50 | 51 | 3. Add to your `base.html` 52 | 53 | ```twig 54 | {% load django_seo_js %} 55 | 56 | {% seo_js_head %} 57 | ... 58 | 59 | ``` 60 | 61 | 4. **That's it. :)** Your js-heavy pages are now rendered properly to the search engines. Have a lovely day. 62 | 63 | Want more advanced control? Keep reading. 64 | 65 | 66 | # Options 67 | 68 | ## General settings 69 | 70 | For the most part, you shouldn't need to override these - we've aimed for sensible defaults. 71 | 72 | ```python 73 | # Backend to use 74 | SEO_JS_BACKEND = "django_seo_js.backends.PrerenderIO" # Default 75 | 76 | # Whether to run the middlewares and update_cache_for_url. Useful to set False for unit testing. 77 | SEO_JS_ENABLED = True # Defaults to *not* DEBUG. 78 | 79 | # User-agents to render for, if you're using the UserAgentMiddleware 80 | # Defaults to the most popular. If you have custom needs, pull from the full list: 81 | # http://www.useragentstring.com/pages/Crawlerlist/ 82 | SEO_JS_USER_AGENTS = [ 83 | "Googlebot", 84 | "Yahoo", 85 | "bingbot", 86 | "Badiu", 87 | "Ask Jeeves", 88 | ] 89 | 90 | # Urls to skip the rendering backend, and always render in-app. 91 | # Defaults to excluding sitemap.xml. 92 | SEO_JS_IGNORE_URLS = [ 93 | "/sitemap.xml", 94 | ] 95 | SEO_JS_IGNORE_EXTENSIONS = [ 96 | ".xml", 97 | ".txt", 98 | # See helpers.py for full list of extensions ignored by default. 99 | ] 100 | 101 | # Whether or not to pass along the original request's user agent to the prerender service. 102 | # Useful for analytics, understanding where requests are coming from. 103 | SEO_JS_SEND_USER_AGENT = True 104 | ``` 105 | 106 | ## Backend settings 107 | 108 | ### Prerender.io 109 | django-seo-js defaults to using prerender.io because it's both [open-source](https://github.com/prerender/prerender) if you want to run it yourself, *and* really reasonably priced if you don't. 110 | 111 | 112 | To use [prerender.io](http://prerender.io), 113 | 114 | ```python 115 | # Prerender.io token 116 | SEO_JS_PRERENDER_TOKEN = "123456789abcdefghijkl" 117 | ``` 118 | 119 | You don't need to set `SEO_JS_BACKEND`, since it defaults to `"django_seo_js.backends.PrerenderIO"`. 120 | 121 | 122 | ### Custom-hosted prerender 123 | 124 | If you're hosting your own instance of [prerender](https://github.com/prerender/prerender), (there are [docker images](https://github.com/cerisier/docker-prerender/), for those inclined,) configuration is similar 125 | 126 | ```python 127 | SEO_JS_BACKEND = "django_seo_js.backends.PrerenderHosted" 128 | SEO_JS_PRERENDER_URL = "http://my-prerenderapp.com/" # Note trailing slash. 129 | SEO_JS_PRERENDER_RECACHE_URL = "http://my-prerenderapp.com/recache" 130 | ``` 131 | 132 | ### Writing your own backend 133 | 134 | If it's a backend for a public service, please consider submitting your backend as a PR, so everyone can benefit! 135 | 136 | Backends must implement the following methods: 137 | 138 | ```python 139 | 140 | class MyBackend(SEOBackendBase): 141 | 142 | def get_response_for_url(self, url, request=None): 143 | """ 144 | Accepts a fully-qualified url. 145 | Optionally accepts the django request object, so that headers, etc. may be passed along to the prerenderer. 146 | Returns an HttpResponse, passing through all headers and the status code. 147 | """ 148 | raise NotImplementedError 149 | 150 | def update_url(self, url): 151 | """ 152 | Force an update of the cache for a particular URL. 153 | Returns True on success, False on fail. 154 | """ 155 | raise NotImplementedError 156 | ``` 157 | 158 | If you're hitting an http endpoint, there's also the helpful `RequestsBasedBackend`, which has a `build_django_response_from_requests_response` method that transforms a [python-requests](http://docs.python-requests.org/) response to a django HttpResponse, including headers, status codes, etc. 159 | 160 | # Advanced Usage 161 | 162 | ## Updating the render cache 163 | 164 | If you know a page's contents have changed, some backends allow you to manually update the page cache. `django-seo-js` provides helpers to make that easy. 165 | 166 | ```python 167 | from django_seo_js.helpers import update_cache_for_url 168 | 169 | update_cache_for_url("/my-url") 170 | ``` 171 | 172 | So, for instance, you might want something like: 173 | 174 | ```python 175 | def listing_changed(sender, instance, created, **kwargs): 176 | update_cache_for_url("%s%s" % ("http://example.com/", reverse("listing_detail", instance.pk)) 177 | 178 | post_save.connect(listing_changed, sender=Listing) 179 | ``` 180 | 181 | ## Building your own URLs for prerendering 182 | 183 | If you need to customize the fully-qualified URL, you can subclass any backend and override the `build_absolute_uri()` method. 184 | 185 | ```python 186 | class MyBackend(SEOBackendBase): 187 | def build_absolute_uri(self, request): 188 | """Strip out all query params:""" 189 | return '{scheme}://{host}{path}'.format( 190 | scheme=self.scheme, 191 | host=self.get_host(), 192 | path=self.path, 193 | ) 194 | ``` 195 | 196 | 197 | # How it all works 198 | 199 | If you're looking for a big-picture explanation of how SEO for JS-heavy apps is handled, the clearest explanation I've seen is [this StackOverflow answer](http://stackoverflow.com/a/20766253). 200 | 201 | If even that's TL;DR for you, here's a bullet-point summary: 202 | 203 | - If requests come in with an `_escaped_fragment_` querystring or a particular user agent, a pre-rendered HTML response is served, instead of your app. 204 | - That pre-rendered HTML is generated by a service with a headless browser that runs your js then caches the rendered page. 205 | - Said service is generally a third party (there are many: [prerender.io](https://prerender.io/), [Brombone](http://www.brombone.com/), [seo.js](http://getseojs.com/), [seo4ajax](http://www.seo4ajax.com/).) You can also run such a service yourself, using [prerender](https://github.com/prerender/prerender), or re-invent your own wheel for fun. 206 | 207 | 208 | # Contributing 209 | 210 | ## Code 211 | 212 | PRs with additional backends, bug-fixes, documentation and more are definitely welcome! 213 | 214 | Here's some guidelines on new code: 215 | - Incoming code should follow PEP8 (there's a test to help out on this.) 216 | - If you add new core-level features, write some quick docs in the README. If you're not sure if they're needed, just ask! 217 | - Add your name and attribution to the AUTHORS file. 218 | - Know you have everyone's thanks for helping to make django-seo-js even better! 219 | 220 | ## Culture 221 | 222 | Anyone is welcome to contribute to django-seo-js, regardless of skill level or experience. To make django-seo-js the best it can be, we have one big, overriding cultural principle: 223 | 224 | **Be kind.** 225 | 226 | Simple. Easy, right? 227 | 228 | We've all been newbie coders, we've all had bad days, we've all been frustrated with libraries, we've all spoken a language we learned later in life. In discussions with other coders, PRs, and CRs, we just give each the benefit of the doubt, listen well, and assume best intentions. It's worked out fantastically. 229 | 230 | This doesn't mean we don't have honest, spirited discussions about the direction to move django-seo-js forward, or how to implement a feature. We do. We just respect one other while we do it. Not so bad, right? :) 231 | 232 | 233 | # Authors 234 | 235 | django-seo-js was originally written and is maintained by [Steven Skoczen](https://stevenskoczen.com). Since then, it's been improved by lots of people, including (alphabetically): 236 | 237 | - [alex-mcleod](https://github.com/alex-mcleod) brought you the idea of ignoring certain urls via `SEO_JS_IGNORE_URLS`. 238 | - [andrewebdev](https://github.com/andrewebdev) improved the user-agent list to be more comprehensive. 239 | - [chazcb](https://github.com/chazcb) added the `build_absolute_uri` method, for subclassing in complex, generated setups. 240 | - [denisvlr](https://github.com/denisvlr) fixed the `update_url` method. 241 | - [mattrobenolt](https://github.com/mattrobenolt) mad things faster, better, and stronger. 242 | - [rchrd2](https://github.com/rchrd2) fixed a breaking bug with the user agent middleware. 243 | - [thoop](https://github.com/thoop) gave you `SEO_JS_IGNORE_EXTENSIONS`, allowing you to ignore by extension. 244 | - [bhoop77](https://github.com/bhoop77) fixed the defaults to work wiht Googlebot's new setup. 245 | - [varrocs](https://github.com/varrocs) updated the list of user agents to match prerender.io's current list. 246 | - [sarahboyce](https://github.com/sarahboyce) added support for Django 4.1. 247 | 248 | 249 | 250 | Original development was at GreenKahuna (now defunct.) 251 | 252 | # Releases 253 | 254 | ### 0.4.1 - Sep 27, 2022 255 | Patch middleware for Django 4.1. [PR](https://github.com/skoczen/django-seo-js/pull/44). 256 | 257 | ### 0.4.0 - Sep 26, 2022 258 | Adds support for Django 4.1. [PR](https://github.com/skoczen/django-seo-js/pull/42). 259 | 260 | ### 0.3.5 - Nov 26, 2021 261 | Adds more default user agents to bring things into the present day. [issue](https://github.com/skoczen/django-seo-js/pull/41). 262 | 263 | ### 0.3.4 - Jan 8, 2020 264 | Fixes googlebot defaults [issue](https://github.com/skoczen/django-seo-js/issues/39). 265 | 266 | ### 0.3.3 - Jan 8, 2020 267 | 268 | Add `SEO_JS_SEND_USER_AGENT` setting. 269 | 270 | ### 0.3.2 - March 6, 2019 271 | 272 | See [releases](https://github.com/skoczen/django-seo-js/releases) 273 | 274 | ### 0.3.1 - March 3, 2015 275 | 276 | * **Deprecation**: `django_seo_js.middleware.HashBangMiddleware` is now called `django_seo_js.middleware.EscapedFragmentMiddleware`, to fix confusion. `HashBangMiddleware` will be removed in 0.5. Which I would bet is probably late 2015, early 2016. You'll see a log warning from now on. Thanks to [thoop](https://github.com/thoop) for the report. 277 | * Bugfix to user agent middleware not respecting `ENABLED`, thanks to [rchrd2](https://github.com/rchrd2). Also reported by [denisvlr](https://github.com/denisvlr). 278 | * New (backwards-compatible) `build_absolute_uri` method that can be overridden, thanks to [chazcb](https://github.com/chazcb). 279 | * Removed Google, Yahoo, and Bing from the default `USER_AGENTS`, since they now support the escaped fragment protocol (and leaving them in can cause a cloaking penalty.) Thanks to [thoop](https://github.com/thoop) for pointing this out. 280 | 281 | ### 0.3.0 - Feb 5, 2015 282 | 283 | * Fixes to the `update_url` method, thanks to [denisvlr](https://github.com/denisvlr). 284 | * Optimizations in lookups, thanks to [mattrobenolt](https://github.com/mattrobenolt). 285 | * Changes behavior to more sanely not follow redirects, per [#9](https://github.com/skoczen/django-seo-js/issues/9), thanks to [denisvlr](https://github.com/denisvlr) and [mattrobenolt](https://github.com/mattrobenolt). 286 | 287 | ### 0.2.4 - August 12, 2014 288 | 289 | * Adds a few more user agents to the defaults, per #7, and the suggestion of [andrewebdev](https://github.com/andrewebdev) 290 | 291 | ### 0.2.3 - May 28, 2014 292 | 293 | * Adds an optional `SEO_JS_IGNORE_EXTENSIONS` setting that contains a list of extensions to ignore, thanks to the suggestion by [thoop](https://github.com/thoop). 294 | 295 | ### 0.2.2 - May 22, 2014 296 | 297 | * Adds an optional `SEO_JS_IGNORE_URLS` setting, that contains a list of urls to ignore, thanks to the sitemap.xml prerender bug reported by [alex-mcleod](https://github.com/alex-mcleod). 298 | 299 | ### 0.2.1 - May 19, 2014 300 | 301 | * **Backwards incompatible** changes to `SEOBackendBase` - all backends are now expected to return an `HttpResponse` for their `get_response_for_url` methods. If you have custom backends, they'll need to be updated. All included backends have been updated, so if you're using an included backend, you can just pip install the new version, and go. 302 | * Returns pages that come back from the cache with anything besides a `5xx` status code. 303 | * Passes on headers, content type, and status code from the cache response. 304 | * If the backend return a `5xx` status, just returns the normal app and hopes for the best. 305 | 306 | 307 | ### 0.1.3 - May 13, 2014 308 | 309 | * Adds a `SEO_JS_ENABLED` setting, so you can disable hooks and middlewares during tests. 310 | 311 | 312 | ### 0.1.2 - May 9, 2014 313 | 314 | * Handles cases where a request didn't come with a User-agent. 315 | 316 | 317 | ### 0.1.1 - May 9, 2014 318 | 319 | * Improvements to unit tests. 320 | 321 | 322 | ### 0.1 - May 8, 2014 323 | 324 | * Includes `PrerenderIO` and `PrerenderHosted` backends. 325 | * First release - we're using this in production at [GreenKahuna ScrapBin](http://scrapbin.com). 326 | 327 | -------------------------------------------------------------------------------- /circle.yml: -------------------------------------------------------------------------------- 1 | dependencies: 2 | override: 3 | - pip install -r requirements.tests.txt 4 | 5 | test: 6 | override: 7 | - python manage.py test 8 | -------------------------------------------------------------------------------- /django_seo_js/__init__.py: -------------------------------------------------------------------------------- 1 | VERSION = "0.4.1" 2 | -------------------------------------------------------------------------------- /django_seo_js/backends/__init__.py: -------------------------------------------------------------------------------- 1 | from .base import SelectedBackend, SelectedBackendMixin, SEOBackendBase 2 | from .prerender import PrerenderHosted, PrerenderIO 3 | from .test import TestBackend, TestServiceDownBackend 4 | -------------------------------------------------------------------------------- /django_seo_js/backends/base.py: -------------------------------------------------------------------------------- 1 | import importlib 2 | import requests 3 | from django.http import HttpResponse 4 | from django_seo_js import settings 5 | 6 | try: 7 | from django.utils.deprecation import MiddlewareMixin 8 | except ImportError: 9 | MiddlewareMixin = object 10 | 11 | 12 | IGNORED_HEADERS = frozenset(( 13 | 'connection', 'keep-alive', 'proxy-authenticate', 14 | 'proxy-authorization', 'te', 'trailers', 'transfer-encoding', 15 | 'upgrade', 'content-length', 'content-encoding' 16 | )) 17 | 18 | 19 | class SelectedBackendMixin: 20 | def __init__(self, *args, **kwargs): 21 | super().__init__(*args, **kwargs) 22 | module_path = settings.BACKEND 23 | backend_module = importlib.import_module(".".join(module_path.split(".")[:-1])) 24 | self.backend = getattr(backend_module, module_path.split(".")[-1])() 25 | 26 | 27 | class SelectedBackend(MiddlewareMixin, SelectedBackendMixin): 28 | pass 29 | 30 | 31 | class SEOBackendBase: 32 | """The base class to inherit for SEO_JS backends""" 33 | 34 | def build_absolute_uri(self, request): 35 | """ 36 | Return the fully-qualified url that will be pre-rendered. 37 | 38 | Override to customize how your URIs are built. 39 | 40 | e.g. to strip out all query params: 41 | ``` 42 | return '{scheme}://{host}{path}'.format( 43 | scheme=self.scheme, 44 | host=self.get_host(), 45 | path=self.path, 46 | ) 47 | ``` 48 | """ 49 | return request.build_absolute_uri() 50 | 51 | def get_response_for_url(self, url, request=None): 52 | """ 53 | Accepts a fully-qualified url. 54 | Returns an HttpResponse, passing through all headers and the status code. 55 | """ 56 | raise NotImplementedError 57 | 58 | def update_url(self, url): 59 | """ 60 | Force an update of the cache for a particular URL. 61 | Returns True on success, False on fail. 62 | """ 63 | raise NotImplementedError 64 | 65 | 66 | class RequestsBasedBackend(object): 67 | 68 | def __init__(self, *args, **kwargs): 69 | super(RequestsBasedBackend, self).__init__(*args, **kwargs) 70 | self.session = requests.Session() 71 | 72 | def build_django_response_from_requests_response(self, response): 73 | r = HttpResponse(response.content) 74 | for k, v in response.headers.items(): 75 | if k.lower() not in IGNORED_HEADERS: 76 | r[k] = v 77 | r['content-length'] = len(response.content) 78 | r.status_code = response.status_code 79 | return r 80 | -------------------------------------------------------------------------------- /django_seo_js/backends/prerender.py: -------------------------------------------------------------------------------- 1 | from django_seo_js import settings 2 | from .base import SEOBackendBase, RequestsBasedBackend 3 | 4 | 5 | class PrerenderIO(SEOBackendBase, RequestsBasedBackend): 6 | """Implements the backend for prerender.io""" 7 | BASE_URL = "https://service.prerender.io/" 8 | RECACHE_URL = "https://api.prerender.io/recache" 9 | 10 | def __init__(self, *args, **kwargs): 11 | super(SEOBackendBase, self).__init__(*args, **kwargs) 12 | self.token = self._get_token() 13 | 14 | def _get_token(self): 15 | if settings.PRERENDER_TOKEN is None: 16 | raise ValueError("Missing SEO_JS_PRERENDER_TOKEN in settings.") 17 | return settings.PRERENDER_TOKEN 18 | 19 | def get_response_for_url(self, url, request=None): 20 | """ 21 | Accepts a fully-qualified url. 22 | Returns an HttpResponse, passing through all headers and the status code. 23 | """ 24 | 25 | if not url or "//" not in url: 26 | raise ValueError("Missing or invalid url: %s" % url) 27 | 28 | render_url = self.BASE_URL + url 29 | headers = { 30 | 'X-Prerender-Token': self.token, 31 | } 32 | if request and settings.SEND_USER_AGENT: 33 | headers.update({'User-Agent': request.META.get('HTTP_USER_AGENT')}) 34 | 35 | r = self.session.get(render_url, headers=headers, allow_redirects=False) 36 | assert r.status_code < 500 37 | 38 | return self.build_django_response_from_requests_response(r) 39 | 40 | def update_url(self, url=None, regex=None): 41 | """ 42 | Accepts a fully-qualified url, or regex. 43 | Returns True if successful, False if not successful. 44 | """ 45 | 46 | if not url and not regex: 47 | raise ValueError("Neither a url or regex was provided to update_url.") 48 | 49 | headers = { 50 | 'X-Prerender-Token': self.token, 51 | 'Content-Type': 'application/json', 52 | } 53 | data = { 54 | 'prerenderToken': settings.PRERENDER_TOKEN, 55 | } 56 | if url: 57 | data["url"] = url 58 | if regex: 59 | data["regex"] = regex 60 | 61 | r = self.session.post(self.RECACHE_URL, headers=headers, data=data) 62 | return r.status_code < 500 63 | 64 | 65 | class PrerenderHosted(PrerenderIO): 66 | """Implements the backend for an arbitrary prerender service 67 | specified in settings.SEO_JS_PRERENDER_URL""" 68 | 69 | def __init__(self, *args, **kwargs): 70 | super(SEOBackendBase, self).__init__(*args, **kwargs) 71 | self.token = "" 72 | if not settings.PRERENDER_URL: 73 | raise ValueError("Missing SEO_JS_PRERENDER_URL in settings.") 74 | if not settings.PRERENDER_RECACHE_URL: 75 | raise ValueError("Missing SEO_JS_PRERENDER_RECACHE_URL in settings.") 76 | 77 | self.BASE_URL = settings.PRERENDER_URL 78 | self.RECACHE_URL = settings.PRERENDER_RECACHE_URL 79 | 80 | def _get_token(self): 81 | pass 82 | 83 | def update_url(self, url=None): 84 | """ 85 | Accepts a fully-qualified url. 86 | Returns True if successful, False if not successful. 87 | """ 88 | if not url: 89 | raise ValueError("Neither a url or regex was provided to update_url.") 90 | post_url = "%s%s" % (self.BASE_URL, url) 91 | r = self.session.post(post_url) 92 | return int(r.status_code) < 500 93 | -------------------------------------------------------------------------------- /django_seo_js/backends/test.py: -------------------------------------------------------------------------------- 1 | from django.http import HttpResponse 2 | 3 | from .base import SEOBackendBase 4 | 5 | 6 | class TestBackend(SEOBackendBase): 7 | """Implements a test backend""" 8 | 9 | def get_response_for_url(self, url, request=None): 10 | r = HttpResponse("Test") 11 | r["test rendered"] = "headers" 12 | r.status_code = 200 13 | r.content_type = "text/html" 14 | return r 15 | 16 | def update_url(self, url): 17 | return True 18 | 19 | 20 | class TestServiceDownBackend(SEOBackendBase): 21 | """Implements a test backend""" 22 | 23 | def get_response_for_url(self, url, request=None): 24 | r = HttpResponse("Service Down") 25 | r["test rendered"] = "headers" 26 | r.status_code = 503 27 | r.content_type = "text/html" 28 | assert r.status_code < 500 29 | 30 | def update_url(self, url): 31 | return False 32 | -------------------------------------------------------------------------------- /django_seo_js/helpers.py: -------------------------------------------------------------------------------- 1 | from django_seo_js import settings 2 | from django_seo_js.backends import SelectedBackendMixin 3 | 4 | 5 | def update_cache_for_url(url): 6 | if settings.ENABLED: 7 | selector = SelectedBackendMixin() 8 | return selector.backend.update_url(url) 9 | return False 10 | 11 | 12 | def request_should_be_ignored(request): 13 | for url in settings.IGNORE_URLS: 14 | if url in request.path: 15 | return True 16 | 17 | extension = None 18 | last_dot = request.path.rfind(".") 19 | if last_dot == -1: 20 | # No extension found 21 | return False 22 | 23 | extension = request.path[last_dot:] 24 | return extension and extension in settings.IGNORE_EXTENSIONS 25 | -------------------------------------------------------------------------------- /django_seo_js/middleware/__init__.py: -------------------------------------------------------------------------------- 1 | from .escaped_fragment import EscapedFragmentMiddleware 2 | from .hashbang import HashBangMiddleware 3 | from .useragent import UserAgentMiddleware 4 | -------------------------------------------------------------------------------- /django_seo_js/middleware/escaped_fragment.py: -------------------------------------------------------------------------------- 1 | from django_seo_js import settings 2 | from django_seo_js.backends import SelectedBackend 3 | from django_seo_js.helpers import request_should_be_ignored 4 | 5 | import logging 6 | logger = logging.getLogger(__name__) 7 | 8 | 9 | class EscapedFragmentMiddleware(SelectedBackend): 10 | def process_request(self, request): 11 | if not settings.ENABLED: 12 | return 13 | 14 | if request_should_be_ignored(request): 15 | return 16 | 17 | if "_escaped_fragment_" not in request.GET: 18 | return 19 | 20 | url = self.backend.build_absolute_uri(request) 21 | try: 22 | return self.backend.get_response_for_url(url, request) 23 | except Exception as e: 24 | logger.exception(e) 25 | 26 | 27 | class HashBangMiddleware(EscapedFragmentMiddleware): 28 | 29 | def __init__(self, *args, **kwargs): 30 | logging.info( 31 | "Deprecation note: HashBangMiddleware has been renamed EscapedFragmentMiddleware," 32 | " for more clarity. Upgrade your MIDDLEWARE_CLASSES to \n" 33 | " 'django_seo_js.middleware.EscapedFragmentMiddleware'" 34 | " when you get a chance. HashBangMiddleware will be removed in v0.5" 35 | ) 36 | super(HashBangMiddleware, self).__init__(*args, **kwargs) 37 | -------------------------------------------------------------------------------- /django_seo_js/middleware/hashbang.py: -------------------------------------------------------------------------------- 1 | from .escaped_fragment import HashBangMiddleware 2 | 3 | import logging 4 | logger = logging.getLogger(__name__) 5 | -------------------------------------------------------------------------------- /django_seo_js/middleware/useragent.py: -------------------------------------------------------------------------------- 1 | import re 2 | from django_seo_js import settings 3 | from django_seo_js.backends import SelectedBackend 4 | from django_seo_js.helpers import request_should_be_ignored 5 | 6 | import logging 7 | logger = logging.getLogger(__name__) 8 | 9 | 10 | class UserAgentMiddleware(SelectedBackend): 11 | def __init__(self, *args, **kwargs): 12 | super(UserAgentMiddleware, self).__init__(*args, **kwargs) 13 | regex_str = "|".join(settings.USER_AGENTS) 14 | regex_str = ".*?(%s)" % regex_str 15 | self.USER_AGENT_REGEX = re.compile(regex_str, re.IGNORECASE) 16 | 17 | def process_request(self, request): 18 | if not settings.ENABLED: 19 | return 20 | 21 | if request_should_be_ignored(request): 22 | return 23 | 24 | if "HTTP_USER_AGENT" not in request.META: 25 | return 26 | 27 | if not self.USER_AGENT_REGEX.match(request.META["HTTP_USER_AGENT"]): 28 | return 29 | 30 | url = self.backend.build_absolute_uri(request) 31 | try: 32 | return self.backend.get_response_for_url(url, request) 33 | except Exception as e: 34 | logger.exception(e) 35 | -------------------------------------------------------------------------------- /django_seo_js/settings.py: -------------------------------------------------------------------------------- 1 | from django.conf import settings as django_settings 2 | 3 | ENABLED = getattr(django_settings, 'SEO_JS_ENABLED', not django_settings.DEBUG) 4 | 5 | IGNORE_URLS = frozenset(getattr(django_settings, 'SEO_JS_IGNORE_URLS', ['/sitemap.xml'])) 6 | 7 | IGNORE_EXTENSIONS = frozenset(getattr(django_settings, 'SEO_JS_IGNORE_EXTENSIONS', ( 8 | ".js", 9 | ".css", 10 | ".xml", 11 | ".less", 12 | ".png", 13 | ".jpg", 14 | ".jpeg", 15 | ".gif", 16 | ".pdf", 17 | ".doc", 18 | ".txt", 19 | ".ico", 20 | ".rss", 21 | ".zip", 22 | ".mp3", 23 | ".rar", 24 | ".exe", 25 | ".wmv", 26 | ".doc", 27 | ".avi", 28 | ".ppt", 29 | ".mpg", 30 | ".mpeg", 31 | ".tif", 32 | ".wav", 33 | ".mov", 34 | ".psd", 35 | ".ai", 36 | ".xls", 37 | ".mp4", 38 | ".m4a", 39 | ".swf", 40 | ".dat", 41 | ".dmg", 42 | ".iso", 43 | ".flv", 44 | ".m4v", 45 | ".torrent", 46 | ))) 47 | 48 | USER_AGENTS = frozenset(getattr(django_settings, 'SEO_JS_USER_AGENTS', ( 49 | "Googlebot", 50 | "Yahoo", 51 | "bingbot", 52 | "Ask Jeeves", 53 | "baiduspider", 54 | "facebookexternalhit", 55 | "twitterbot", 56 | "rogerbot", 57 | "linkedinbot", 58 | "embedly", 59 | "quoralink preview'", 60 | "quora link preview", 61 | "showyoubot", 62 | "outbrain", 63 | "pinterest", 64 | "developersgoogle.com/+/web/snippet", 65 | "yandex", 66 | "slackbot", 67 | "vkshare", 68 | "w3c_validator", 69 | "redditbot", 70 | "applebot", 71 | "whatsapp", 72 | "flipboard", 73 | "tumblr", 74 | "bitlybot", 75 | "skypeuripreview", 76 | "nuzzel", 77 | "discordbot", 78 | "google page speed", 79 | "qwantify", 80 | "pinterestbot", 81 | "bitrix link preview", 82 | "xing-contenttabreceiver", 83 | "chrome-lighthouse", 84 | "telegrambot", 85 | ))) 86 | 87 | BACKEND = getattr(django_settings, 'SEO_JS_BACKEND', 'django_seo_js.backends.PrerenderIO') 88 | 89 | PRERENDER_TOKEN = getattr(django_settings, 'SEO_JS_PRERENDER_TOKEN', None) 90 | PRERENDER_URL = getattr(django_settings, 'SEO_JS_PRERENDER_URL', None) 91 | PRERENDER_RECACHE_URL = getattr(django_settings, 'SEO_JS_PRERENDER_RECACHE_URL', None) 92 | 93 | SEND_USER_AGENT = getattr(django_settings, 'SEO_JS_SEND_USER_AGENT', True) 94 | -------------------------------------------------------------------------------- /django_seo_js/templatetags/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/skoczen/django-seo-js/fb2cf050abf7f38dfc67f325d7b448f8fef0b2e2/django_seo_js/templatetags/__init__.py -------------------------------------------------------------------------------- /django_seo_js/templatetags/django_seo_js.py: -------------------------------------------------------------------------------- 1 | from django import template 2 | from django.utils.safestring import mark_safe 3 | 4 | register = template.Library() 5 | 6 | 7 | @register.simple_tag 8 | def seo_js_head(*args): 9 | return mark_safe("""""") 10 | -------------------------------------------------------------------------------- /django_seo_js/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/skoczen/django-seo-js/fb2cf050abf7f38dfc67f325d7b448f8fef0b2e2/django_seo_js/tests/__init__.py -------------------------------------------------------------------------------- /django_seo_js/tests/backends/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/skoczen/django-seo-js/fb2cf050abf7f38dfc67f325d7b448f8fef0b2e2/django_seo_js/tests/backends/__init__.py -------------------------------------------------------------------------------- /django_seo_js/tests/backends/test_base.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | from django_seo_js.tests.utils import override_settings, get_response_empty 4 | from django_seo_js.backends import PrerenderIO, SelectedBackend, SelectedBackendMixin, SEOBackendBase, TestBackend 5 | 6 | 7 | class SEOBackendBaseTest(TestCase): 8 | def setUp(self): 9 | self.backend = SEOBackendBase() 10 | 11 | def test_get_response_for_url(self): 12 | self.assertRaises(NotImplementedError, self.backend.get_response_for_url, "http://www.example.com") 13 | 14 | def test_update_url(self): 15 | self.assertRaises(NotImplementedError, self.backend.update_url, "http://www.example.com") 16 | 17 | 18 | class SelectedBackendTest(TestCase): 19 | 20 | def test_default_backend(self): 21 | s_mixin = SelectedBackendMixin() 22 | s = SelectedBackend(get_response_empty) 23 | self.assertTrue(isinstance(s_mixin.backend, PrerenderIO)) 24 | self.assertTrue(isinstance(s.backend, PrerenderIO)) 25 | 26 | @override_settings(BACKEND='django_seo_js.backends.TestBackend') 27 | def test_override_backend(self): 28 | s_mixin = SelectedBackendMixin() 29 | s = SelectedBackend(get_response_empty) 30 | self.assertTrue(isinstance(s_mixin.backend, TestBackend)) 31 | self.assertTrue(isinstance(s.backend, TestBackend)) 32 | -------------------------------------------------------------------------------- /django_seo_js/tests/backends/test_prerender_hosted.py: -------------------------------------------------------------------------------- 1 | from __future__ import unicode_literals 2 | 3 | import random 4 | import string 5 | 6 | from django.test import TestCase 7 | from httmock import all_requests, HTTMock 8 | 9 | from django_seo_js.tests.utils import override_settings 10 | from django_seo_js.backends import PrerenderHosted 11 | 12 | MOCK_RESPONSE = b"

Hello, World!

" 13 | MOCK_RESPONSE_HEADERS = {"foo": "bar"} 14 | MOCK_RECACHE_RESPONSE = "OK" 15 | MOCK_RECACHE_HEADERS = {"ibbity": "ack"} 16 | _ascii = string.ascii_uppercase + string.digits 17 | MOCK_GIANT_RESPONSE = ''.join(random.choice(_ascii) for _ in range(200000)).encode('ascii') 18 | 19 | 20 | @all_requests 21 | def mock_prerender_recache_response(url, request): 22 | return { 23 | 'status_code': 200, 24 | 'content': MOCK_RECACHE_RESPONSE, 25 | 'headers': MOCK_RECACHE_HEADERS, 26 | } 27 | 28 | 29 | @all_requests 30 | def mock_prerender_response(url, request): 31 | return { 32 | 'status_code': 200, 33 | 'content': MOCK_RESPONSE, 34 | 'headers': MOCK_RESPONSE_HEADERS, 35 | } 36 | 37 | 38 | @all_requests 39 | def mock_prerender_giant_response(url, request): 40 | return { 41 | 'status_code': 200, 42 | 'content': MOCK_GIANT_RESPONSE, 43 | } 44 | 45 | 46 | class PrerenderHostedTestURLs(TestCase): 47 | 48 | @override_settings(PRERENDER_RECACHE_URL="http://example.com") 49 | def test_init_throws_exception_if_render_url_is_missing(self): 50 | self.assertRaises(ValueError, PrerenderHosted) 51 | 52 | @override_settings(PRERENDER_URL="http://example.com") 53 | def test_init_throws_exception_if_recache_url_is_missing(self): 54 | self.assertRaises(ValueError, PrerenderHosted) 55 | 56 | def test_init_throws_exception_if_both_urls_are_missing(self): 57 | self.assertRaises(ValueError, PrerenderHosted) 58 | 59 | @override_settings( 60 | PRERENDER_RECACHE_URL="http://example.com/recache", 61 | PRERENDER_URL="http://example.com" 62 | ) 63 | def test_no_exception_if_both_are_provided(self): 64 | self.backend = PrerenderHosted() 65 | 66 | 67 | class PrerenderHostedTestMethods(TestCase): 68 | 69 | @override_settings( 70 | PRERENDER_RECACHE_URL="http://example.com/recache", 71 | PRERENDER_URL="http://example.com" 72 | ) 73 | def setUp(self): 74 | self.backend = PrerenderHosted() 75 | 76 | def test_get_response_for_url_missing_url(self): 77 | self.assertRaises(TypeError, self.backend.get_response_for_url) 78 | self.assertRaises(ValueError, self.backend.get_response_for_url, None) 79 | 80 | def test_get_response_for_url_valid(self): 81 | with HTTMock(mock_prerender_response): 82 | resp = self.backend.get_response_for_url("http://www.example.com") 83 | self.assertEqual(MOCK_RESPONSE, resp.content) 84 | for k, v in MOCK_RESPONSE_HEADERS.items(): 85 | self.assertEqual(resp[k], v) 86 | 87 | def test_get_response_for_giant_response(self): 88 | with HTTMock(mock_prerender_giant_response): 89 | resp = self.backend.get_response_for_url("http://www.example.com") 90 | self.assertEqual(MOCK_GIANT_RESPONSE, resp.content) 91 | 92 | def test_update_url_with_url(self): 93 | with HTTMock(mock_prerender_recache_response): 94 | resp = self.backend.update_url(url="http://www.example.com") 95 | self.assertEqual(resp, True) 96 | 97 | def test_update_url_missing_url(self): 98 | with HTTMock(mock_prerender_recache_response): 99 | self.assertRaises(ValueError, self.backend.update_url) 100 | -------------------------------------------------------------------------------- /django_seo_js/tests/backends/test_prerender_io.py: -------------------------------------------------------------------------------- 1 | from __future__ import unicode_literals 2 | 3 | from django.test import TestCase 4 | from httmock import all_requests, HTTMock 5 | 6 | from django_seo_js.tests.utils import override_settings 7 | from django_seo_js.backends import PrerenderIO 8 | 9 | MOCK_RESPONSE = b"

Hello, World!

" 10 | MOCK_RESPONSE_HEADERS = {"foo": "bar"} 11 | MOCK_RECACHE_RESPONSE = "OK" 12 | MOCK_RECACHE_HEADERS = {"ibbity": "ack"} 13 | 14 | 15 | @all_requests 16 | def mock_prerender_recache_response(url, request): 17 | return { 18 | 'status_code': 200, 19 | 'content': MOCK_RECACHE_RESPONSE, 20 | 'headers': MOCK_RECACHE_HEADERS, 21 | } 22 | 23 | 24 | @all_requests 25 | def mock_prerender_response(url, request): 26 | return { 27 | 'status_code': 200, 28 | 'content': MOCK_RESPONSE, 29 | 'headers': MOCK_RESPONSE_HEADERS, 30 | } 31 | 32 | 33 | class PrerenderIOTestToken(TestCase): 34 | 35 | @override_settings(PRERENDER_TOKEN=None) 36 | def test_get_token_throws_exception_if_missing(self): 37 | self.assertRaises(ValueError, PrerenderIO) 38 | 39 | @override_settings(PRERENDER_TOKEN="123124341adfsaf") 40 | def test_get_token(self): 41 | self.backend = PrerenderIO() 42 | # Test function 43 | self.assertEqual(self.backend._get_token(), "123124341adfsaf") 44 | # Test __init__ 45 | self.assertEqual(self.backend.token, "123124341adfsaf") 46 | 47 | 48 | class PrerenderIOTestMethods(TestCase): 49 | 50 | def setUp(self): 51 | self.backend = PrerenderIO() 52 | 53 | def test_get_response_for_url_missing_url(self): 54 | self.assertRaises(TypeError, self.backend.get_response_for_url) 55 | self.assertRaises(ValueError, self.backend.get_response_for_url, None) 56 | 57 | def test_get_response_for_url_valid(self): 58 | with HTTMock(mock_prerender_response): 59 | resp = self.backend.get_response_for_url("http://www.example.com") 60 | self.assertEqual(MOCK_RESPONSE, resp.content) 61 | for k, v in MOCK_RESPONSE_HEADERS.items(): 62 | self.assertEqual(resp[k], v) 63 | 64 | def test_update_url_with_url_only(self): 65 | with HTTMock(mock_prerender_recache_response): 66 | resp = self.backend.update_url(url="http://www.example.com") 67 | self.assertEqual(resp, True) 68 | 69 | def test_update_url_with_regex_only(self): 70 | with HTTMock(mock_prerender_recache_response): 71 | resp = self.backend.update_url(regex="http://www.example.com/*") 72 | self.assertEqual(resp, True) 73 | 74 | def test_update_url_missing_url_and_regex(self): 75 | with HTTMock(mock_prerender_recache_response): 76 | self.assertRaises(ValueError, self.backend.update_url) 77 | -------------------------------------------------------------------------------- /django_seo_js/tests/test_helpers.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | from django_seo_js.tests.utils import override_settings, get_response_empty 4 | from django_seo_js.middleware import EscapedFragmentMiddleware 5 | 6 | 7 | class HelpersTest(TestCase): 8 | 9 | @override_settings(BACKEND='django_seo_js.backends.TestBackend') 10 | def test_update_the_render_cache(self): 11 | from django_seo_js.helpers import update_cache_for_url 12 | self.middleware = EscapedFragmentMiddleware(get_response_empty) 13 | self.assertEqual(update_cache_for_url("http://example.com"), True) 14 | 15 | @override_settings(BACKEND='django_seo_js.backends.TestBackend', ENABLED=False) 16 | def test_update_skips_if_disabled(self): 17 | from django_seo_js.helpers import update_cache_for_url 18 | self.middleware = EscapedFragmentMiddleware(get_response_empty) 19 | self.assertEqual(update_cache_for_url("http://example.com"), False) 20 | -------------------------------------------------------------------------------- /django_seo_js/tests/test_middlewares.py: -------------------------------------------------------------------------------- 1 | from __future__ import unicode_literals 2 | 3 | from mock import Mock 4 | from django.test import TestCase 5 | 6 | from django_seo_js.tests.utils import override_settings, get_response_empty 7 | from django_seo_js.middleware import EscapedFragmentMiddleware, UserAgentMiddleware, HashBangMiddleware 8 | 9 | print(override_settings) 10 | 11 | 12 | class BaseMiddlewareTest(TestCase): 13 | pass 14 | 15 | 16 | class EscapedFragmentMiddlewareTest(TestCase): 17 | 18 | @override_settings(BACKEND='django_seo_js.backends.TestBackend') 19 | def setUp(self): 20 | super(EscapedFragmentMiddlewareTest, self).setUp() 21 | self.middleware = EscapedFragmentMiddleware(get_response_empty) 22 | self.request = Mock() 23 | self.request.path = "/" 24 | self.request.GET = {} 25 | 26 | def test_has_escaped_fragment(self): 27 | self.request.GET = {"_escaped_fragment_": None} 28 | self.assertEqual(self.middleware.process_request(self.request).content, b"Test") 29 | 30 | def test_does_not_have_escaped_fragment(self): 31 | self.request.GET = {} 32 | self.assertEqual(self.middleware.process_request(self.request), None) 33 | 34 | @override_settings(BACKEND='django_seo_js.backends.TestBackend', ENABLED=False) 35 | def test_has_escaped_fragment_skips_if_disabled_via_enabled(self): 36 | self.middleware = EscapedFragmentMiddleware(get_response_empty) 37 | self.request.GET = {} 38 | self.assertEqual(self.middleware.process_request(self.request), None) 39 | 40 | @override_settings(BACKEND='django_seo_js.backends.TestServiceDownBackend') 41 | def test_has_escaped_fragment_skips_if_service_is_down(self): 42 | self.middleware = EscapedFragmentMiddleware(get_response_empty) 43 | self.request.GET = {"_escaped_fragment_": None} 44 | self.assertEqual(self.middleware.process_request(self.request), None) 45 | 46 | @override_settings(BACKEND='django_seo_js.backends.TestBackend') 47 | def test_overriding_skips_sitemap_xml_by_default(self): 48 | self.middleware = EscapedFragmentMiddleware(get_response_empty) 49 | self.request.path = "/sitemap.xml" 50 | self.request.GET = {"_escaped_fragment_": None} 51 | self.assertEqual(self.middleware.process_request(self.request), None) 52 | 53 | @override_settings( 54 | BACKEND='django_seo_js.backends.TestBackend', 55 | IGNORE_URLS=["/foo.html", "/bar/ibbity.html", ], 56 | IGNORE_EXTENSIONS=[], 57 | ) 58 | def test_overriding_skips_custom_overrides_xml_by_default(self): 59 | self.middleware = EscapedFragmentMiddleware(get_response_empty) 60 | self.request.path = "/sitemap.xml" 61 | self.request.GET = {"_escaped_fragment_": None} 62 | self.assertEqual(self.middleware.process_request(self.request).content, b"Test") 63 | 64 | self.request.path = "/foo.html" 65 | self.assertEqual(self.middleware.process_request(self.request), None) 66 | 67 | self.request.path = "/bar/ibbity.html" 68 | self.assertEqual(self.middleware.process_request(self.request), None) 69 | 70 | @override_settings(BACKEND='django_seo_js.backends.TestBackend') 71 | def test_overriding_skips_gifs_by_default(self): 72 | self.middleware = EscapedFragmentMiddleware(get_response_empty) 73 | self.request.path = "/sitemap.xml" 74 | self.request.GET = {"_escaped_fragment_": None} 75 | self.assertEqual(self.middleware.process_request(self.request), None) 76 | 77 | @override_settings( 78 | BACKEND='django_seo_js.backends.TestBackend', 79 | IGNORE_EXTENSIONS=[".html", ".txt", ] 80 | ) 81 | def test_overriding_skips_custom_overrides_gifs_by_default(self): 82 | self.middleware = EscapedFragmentMiddleware(get_response_empty) 83 | self.request.path = "/foo.gif" 84 | self.request.GET = {"_escaped_fragment_": None} 85 | self.assertEqual(self.middleware.process_request(self.request).content, b"Test") 86 | 87 | self.request.path = "/foo.html" 88 | self.assertEqual(self.middleware.process_request(self.request), None) 89 | 90 | self.request.path = "/bar/ibbity.txt" 91 | self.assertEqual(self.middleware.process_request(self.request), None) 92 | 93 | 94 | class HashBangMiddlewareTest(EscapedFragmentMiddlewareTest): 95 | 96 | @override_settings(BACKEND='django_seo_js.backends.TestBackend') 97 | def setUp(self): 98 | super(HashBangMiddlewareTest, self).setUp() 99 | self.middleware = HashBangMiddleware(get_response_empty) 100 | self.request = Mock() 101 | self.request.path = "/" 102 | self.request.GET = {} 103 | 104 | 105 | class UserAgentMiddlewareTest(TestCase): 106 | 107 | @override_settings(BACKEND='django_seo_js.backends.TestBackend') 108 | def setUp(self): 109 | super(UserAgentMiddlewareTest, self).setUp() 110 | self.middleware = UserAgentMiddleware(get_response_empty) 111 | self.request = Mock() 112 | self.request.path = "/" 113 | self.request.META = {} 114 | 115 | def test_matches_one_of_the_default_user_agents(self): 116 | self.request.META = { 117 | "HTTP_USER_AGENT": 118 | "Mozilla/2.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)" 119 | } 120 | self.assertEqual(self.middleware.process_request(self.request).content, b"Test") 121 | 122 | def test_does_not_match_one_of_the_default_user_agents(self): 123 | self.request.META = { 124 | "HTTP_USER_AGENT": "This user-agent is not a search engine." 125 | } 126 | self.assertEqual(self.middleware.process_request(self.request), None) 127 | 128 | @override_settings( 129 | USER_AGENTS=["TestUserAgent", ], 130 | BACKEND='django_seo_js.backends.TestBackend' 131 | ) 132 | def test_overriding_matches(self): 133 | self.middleware = UserAgentMiddleware(get_response_empty) 134 | self.request.META = { 135 | "HTTP_USER_AGENT": "The TestUserAgent v1.0" 136 | } 137 | self.assertEqual(self.middleware.process_request(self.request).content, b"Test") 138 | 139 | @override_settings( 140 | USER_AGENTS=["TestUserAgent", ], 141 | BACKEND='django_seo_js.backends.TestBackend' 142 | ) 143 | def test_overriding_does_not_match_properly(self): 144 | self.middleware = UserAgentMiddleware(get_response_empty) 145 | self.request.META = { 146 | "HTTP_USER_AGENT": 147 | "Mozilla/2.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)" 148 | } 149 | self.assertEqual(self.middleware.process_request(self.request), None) 150 | 151 | @override_settings( 152 | USER_AGENTS=["TestUserAgent", ], 153 | BACKEND='django_seo_js.backends.TestBackend' 154 | ) 155 | def test_missing_user_agent_still_works(self): 156 | self.middleware = UserAgentMiddleware(get_response_empty) 157 | self.request.META = {} 158 | self.assertEqual(self.middleware.process_request(self.request), None) 159 | 160 | @override_settings(BACKEND='django_seo_js.backends.TestBackend', ENABLED=False) 161 | def test_overriding_matches_skips_if_disabled_via_enabled(self): 162 | self.middleware = UserAgentMiddleware(get_response_empty) 163 | self.request.META = { 164 | "HTTP_USER_AGENT": "The TestUserAgent v1.0" 165 | } 166 | self.assertEqual(self.middleware.process_request(self.request), None) 167 | 168 | @override_settings(BACKEND='django_seo_js.backends.TestServiceDownBackend') 169 | def test_overriding_matches_skips_if_service_is_down(self): 170 | self.middleware = UserAgentMiddleware(get_response_empty) 171 | self.request.META = { 172 | "HTTP_USER_AGENT": 173 | "Mozilla/2.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)" 174 | } 175 | self.assertEqual(self.middleware.process_request(self.request), None) 176 | 177 | @override_settings(BACKEND='django_seo_js.backends.TestBackend') 178 | def test_overriding_skips_sitemap_xml_by_default(self): 179 | self.middleware = UserAgentMiddleware(get_response_empty) 180 | self.request.path = "/sitemap.xml" 181 | self.request.META = { 182 | "HTTP_USER_AGENT": 183 | "Mozilla/2.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)" 184 | } 185 | self.assertEqual(self.middleware.process_request(self.request), None) 186 | 187 | @override_settings( 188 | BACKEND='django_seo_js.backends.TestBackend', 189 | IGNORE_URLS=["/foo.html", "/bar/ibbity.html", ], 190 | IGNORE_EXTENSIONS=[], 191 | ) 192 | def test_overriding_skips_custom_overrides_xml_by_default(self): 193 | self.middleware = UserAgentMiddleware(get_response_empty) 194 | self.request.path = "/sitemap.xml" 195 | self.request.META = { 196 | "HTTP_USER_AGENT": 197 | "Mozilla/2.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)" 198 | } 199 | self.assertEqual(self.middleware.process_request(self.request).content, b"Test") 200 | 201 | self.request.path = "/foo.html" 202 | self.assertEqual(self.middleware.process_request(self.request), None) 203 | 204 | self.request.path = "/bar/ibbity.html" 205 | self.assertEqual(self.middleware.process_request(self.request), None) 206 | 207 | @override_settings(BACKEND='django_seo_js.backends.TestBackend') 208 | def test_overriding_skips_gifs_by_default(self): 209 | self.middleware = UserAgentMiddleware(get_response_empty) 210 | self.request.path = "/foo.gif" 211 | self.request.META = { 212 | "HTTP_USER_AGENT": 213 | "Mozilla/2.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)" 214 | } 215 | self.assertEqual(self.middleware.process_request(self.request), None) 216 | 217 | @override_settings( 218 | BACKEND='django_seo_js.backends.TestBackend', 219 | IGNORE_EXTENSIONS=[".html", ".txt", ] 220 | ) 221 | def test_overriding_skips_custom_overrides_gifs_by_default(self): 222 | self.middleware = UserAgentMiddleware(get_response_empty) 223 | self.request.path = "/foo.gif" 224 | self.request.META = { 225 | "HTTP_USER_AGENT": 226 | "Mozilla/2.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)" 227 | } 228 | self.assertEqual(self.middleware.process_request(self.request).content, b"Test") 229 | 230 | self.request.path = "/foo.html" 231 | self.assertEqual(self.middleware.process_request(self.request), None) 232 | 233 | self.request.path = "/bar/ibbity.txt" 234 | self.assertEqual(self.middleware.process_request(self.request), None) 235 | -------------------------------------------------------------------------------- /django_seo_js/tests/test_pep8.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import os 3 | import pep8 4 | 5 | 6 | class TestCodeFormat(unittest.TestCase): 7 | 8 | def test_pep8_conformance(self): 9 | """Test that we conform to PEP8.""" 10 | ALL_FILES = [] 11 | IGNORED_CODES = ["E501", "E226", "E302", "E41", "E128", "E127", ] 12 | 13 | project_root = os.path.abspath(os.path.join( 14 | os.path.dirname(os.path.realpath(__file__)), 15 | "..", 16 | "..", 17 | )) 18 | ignored_folders = [ 19 | ".git", 20 | "venv", 21 | ".tox", 22 | ] 23 | 24 | pep8style = pep8.StyleGuide( 25 | # quiet=True, 26 | report=pep8.StandardReport, 27 | show_source=True, 28 | max_line_length=120, 29 | ) 30 | for code in IGNORED_CODES: 31 | pep8style.ignore_code(code) 32 | 33 | for root, dirnames, filenames in os.walk(project_root): 34 | if not any(folder in root for folder in ignored_folders): 35 | for filename in filenames: 36 | if filename[-3:] == ".py": 37 | ALL_FILES.append(os.path.join(root, filename)) 38 | result = pep8style.check_files(ALL_FILES) 39 | 40 | self.assertEqual(result.total_errors, 0, "Found %s code style errors (and warnings)." % (result.total_errors,)) 41 | -------------------------------------------------------------------------------- /django_seo_js/tests/test_templatetags.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | from django.template import Template, Context 3 | 4 | 5 | class TagsTest(TestCase): 6 | 7 | def test_seo_js_head(self): 8 | t = Template("{% load django_seo_js %}{% seo_js_head %}") 9 | c = Context({}) 10 | rendered_html = t.render(c) 11 | self.assertEqual(rendered_html, """""") 12 | -------------------------------------------------------------------------------- /django_seo_js/tests/utils.py: -------------------------------------------------------------------------------- 1 | from functools import wraps 2 | from django.http.response import HttpResponse 3 | from django_seo_js import settings 4 | 5 | 6 | class override_settings(object): 7 | def __init__(self, **kwargs): 8 | self.options = kwargs 9 | self.originals = {} 10 | 11 | def __enter__(self): 12 | self.enable() 13 | 14 | def __exit__(self, exc_type, exc_value, traceback): 15 | self.disable() 16 | 17 | def __call__(self, test_func): 18 | @wraps(test_func) 19 | def inner(*args, **kwargs): 20 | with self: 21 | return test_func(*args, **kwargs) 22 | return inner 23 | 24 | def enable(self): 25 | for k, v in self.options.items(): 26 | self.originals[k] = getattr(settings, k) 27 | setattr(settings, k, v) 28 | 29 | def disable(self): 30 | for k, v in self.originals.items(): 31 | setattr(settings, k, v) 32 | 33 | 34 | def get_response_empty(request): 35 | return HttpResponse() 36 | -------------------------------------------------------------------------------- /fabfile.py: -------------------------------------------------------------------------------- 1 | import os 2 | import tempfile 3 | from django_seo_js import VERSION 4 | from fabric.api import * 5 | 6 | SITE_DIR = "site" 7 | WHITELIST_DIRS = [".git", ] 8 | WHITELIST_FILES = [".gitignore", ] 9 | 10 | SANITY_CHECK_PROJECT_FILES = ["fabfile.py", "setup.py", "mkdocs.yml"] 11 | SANITY_CHECK_BUILD_FILES = ["index.html", "js", "css"] 12 | 13 | 14 | def _splitpath(path): 15 | path = os.path.normpath(path) 16 | return path.split(os.sep) 17 | 18 | 19 | def tag_release(): 20 | # Tag the release: 21 | local("git tag %s" % VERSION) 22 | local("git push --tags") 23 | 24 | 25 | def upload_release(): 26 | local("python setup.py sdist") 27 | local("python setup.py bdist_wheel --universal") 28 | local("twine upload dist/*") 29 | local("rm dist/*") 30 | 31 | 32 | def release(): 33 | # deploy_docs() 34 | upload_release() 35 | tag_release() 36 | 37 | 38 | def deploy_docs(): 39 | # For someday move to mkdocs. Stolen verbatim from will. 40 | # Sanity check dir. 41 | root_dir = os.getcwd() 42 | assert all([os.path.exists(os.path.join(root_dir, f)) for f in SANITY_CHECK_PROJECT_FILES]) 43 | 44 | local("rm -rf %s" % SITE_DIR) 45 | local("mkdocs build") 46 | tempdir = tempfile.mkdtemp() 47 | 48 | local("mv %s/* %s" % (SITE_DIR, tempdir)) 49 | 50 | current_branch = local("git rev-parse --abbrev-ref HEAD", capture=True) 51 | last_commit = local("git log -1 --pretty=\%B", capture=True) 52 | 53 | # Add the new site to build 54 | local("git checkout gh-pages") 55 | 56 | # Sanity check dir. 57 | root_dir = os.getcwd() 58 | assert all([os.path.exists(os.path.join(root_dir, f)) for f in SANITY_CHECK_BUILD_FILES]) 59 | 60 | for root, dirs, files in os.walk(root_dir, topdown=False): 61 | for name in files: 62 | if name not in WHITELIST_FILES and not any([r in WHITELIST_DIRS for r in _splitpath(root)]): 63 | # print "removing %s" % (os.path.join(root, name)) 64 | os.remove(os.path.join(root, name)) 65 | for name in dirs: 66 | if name not in WHITELIST_DIRS and not any([r in WHITELIST_DIRS for r in _splitpath(root)]): 67 | # print "removing %s" % (os.path.join(root, name)) 68 | os.rmdir(os.path.join(root, name)) 69 | 70 | local("cp -rv %s/* ." % tempdir) 71 | with settings(warn_only=True): 72 | result = local("git diff --exit-code") 73 | 74 | if result.return_code != 0: 75 | local("git add -A .") 76 | local("git commit -m 'Auto-update of docs: %s'" % last_commit) 77 | local("git push") 78 | else: 79 | print("No changes to the docs.") 80 | local("git checkout %s" % current_branch) 81 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | import sys 4 | 5 | if __name__ == "__main__": 6 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings") 7 | 8 | from django.core.management import execute_from_command_line 9 | 10 | execute_from_command_line(sys.argv) 11 | -------------------------------------------------------------------------------- /requirements.dev.txt: -------------------------------------------------------------------------------- 1 | requests 2 | pep8 -------------------------------------------------------------------------------- /requirements.tests.txt: -------------------------------------------------------------------------------- 1 | fabric<2 2 | httmock 3 | mock 4 | nose 5 | pep8 6 | tox 7 | twine<2 -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests 2 | Django 3 | -------------------------------------------------------------------------------- /runtime.txt: -------------------------------------------------------------------------------- 1 | python-2.7.3 -------------------------------------------------------------------------------- /settings.py: -------------------------------------------------------------------------------- 1 | # Minimal django settings to run tests 2 | 3 | DEBUG = True 4 | TEMPLATE_DEBUG = DEBUG 5 | 6 | ADMINS = () 7 | MANAGERS = ADMINS 8 | 9 | DATABASES = { 10 | 'default': { 11 | 'ENGINE': 'django.db.backends.sqlite3', 12 | 'NAME': './sqlite3.db', 13 | } 14 | } 15 | 16 | SECRET_KEY = 'alksjdf93jqpijsdaklfjq;3lejqklejlakefjas' 17 | TEMPLATES = [ 18 | { 19 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 20 | 'APP_DIRS': True, 21 | }, 22 | ] 23 | 24 | MIDDLEWARE_CLASSES = ( 25 | 'django_seo_js.middleware.EscapedFragmentMiddleware', 26 | 'django_seo_js.middleware.UserAgentMiddleware', 27 | 'django.middleware.common.CommonMiddleware', 28 | 'django.contrib.sessions.middleware.SessionMiddleware', 29 | 'django.middleware.csrf.CsrfViewMiddleware', 30 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 31 | ) 32 | 33 | INSTALLED_APPS = ( 34 | 'django.contrib.auth', 35 | 'django.contrib.contenttypes', 36 | 'django.contrib.sessions', 37 | 'django.contrib.messages', 38 | 'django.contrib.staticfiles', 39 | ) 40 | INSTALLED_APPS += ('django_seo_js',) 41 | 42 | CACHES = { 43 | 'default': { 44 | 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', 45 | 'LOCATION': 'django_seo_js' 46 | } 47 | } 48 | 49 | SEO_JS_PRERENDER_TOKEN = "123456789" 50 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env python 2 | import os 3 | from setuptools import setup, find_packages 4 | from django_seo_js import VERSION 5 | 6 | ROOT_DIR = os.path.dirname(__file__) 7 | SOURCE_DIR = os.path.join(ROOT_DIR) 8 | 9 | 10 | reqs = [] 11 | with open("requirements.txt", "r+") as f: 12 | for line in f.readlines(): 13 | reqs.append(line.strip()) 14 | 15 | test_reqs = [] 16 | with open("requirements.tests.txt", "r+") as f: 17 | for line in f.readlines(): 18 | test_reqs.append(line.strip()) 19 | 20 | try: 21 | import pypandoc 22 | long_description = pypandoc.convert('README.md', 'rst') 23 | except (IOError, ImportError): 24 | long_description = '' 25 | 26 | setup( 27 | name="django-seo-js", 28 | description="SEO support for angular, backbone, " 29 | "ember, famo.us, and other SPA apps " 30 | "built with django.", 31 | long_description=long_description, 32 | author="Steven Skoczen", 33 | author_email="steven@greenkahuna.com", 34 | url="https://github.com/skoczen/django-seo-js", 35 | version=VERSION, 36 | install_requires=reqs, 37 | tests_require=test_reqs, 38 | packages=find_packages(), 39 | include_package_data=True, 40 | keywords=["seo", "django", "ajax", "angular", "backbone", 41 | "ember", "famous", "google", "bing", "yahoo"], 42 | classifiers=[ 43 | "Programming Language :: Python", 44 | "License :: OSI Approved :: BSD License", 45 | "Operating System :: OS Independent", 46 | "Development Status :: 4 - Beta", 47 | "Environment :: Web Environment", 48 | "Intended Audience :: Developers", 49 | "Topic :: Internet :: WWW/HTTP", 50 | "Topic :: Software Development :: Libraries :: Python Modules", 51 | ], 52 | 53 | ) 54 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | # Tox (http://tox.testrun.org/) is a tool for running tests 2 | # in multiple virtualenvs. This configuration file will run the 3 | # test suite on all supported python versions. To use it, "pip install tox" 4 | # and then run "tox" from this directory. 5 | 6 | [tox] 7 | envlist = python{37,38,39}-dj{2,3,4} 8 | 9 | [testenv] 10 | deps = 11 | -rrequirements.tests.txt 12 | 13 | dj2: Django ~=2.2 14 | dj3: Django ~=3.2.15 15 | dj4: Django ~=4.1.1 16 | 17 | commands = 18 | {envpython} manage.py test 19 | --------------------------------------------------------------------------------