Merge pull request #1 from FireTail-io/test-branch

Rebranding pointsecio to firetail

Author: rileyfiretail

.github/ISSUE_TEMPLATE.md

@@ -19,4 +19,4 @@
 Output of the commands:
 
 - `python --version`
-- `pip show pointsecio | grep "^Version\:"`
+- `pip show firetail | grep "^Version\:"`

.gitignore

@@ -1,6 +1,6 @@
 build
 dist
-pointsecio.egg-info
+firetail.egg-info
 __pycache__
 .coverage
 *.egg

MANIFEST.in

@@ -1,3 +1,3 @@
 include *.txt
 include *.rst
-recursive-include pointsecio/resources *.json
+recursive-include firetail/resources *.json

README.rst

@@ -85,17 +85,17 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PointSecIO.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Firetail.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PointSecIO.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Firetail.qhc"
 
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/PointSecIO"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PointSecIO"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Firetail"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Firetail"
 	@echo "# devhelp"
 
 epub:

docs/Makefile

@@ -1,30 +1,30 @@
 Command-Line Interface
 ======================
-For convenience PointSecIO provides a command-line interface
+For convenience Firetail provides a command-line interface
 (CLI). This interface aims to be a starting point in developing or
-testing OpenAPI specifications with PointSecIO.
+testing OpenAPI specifications with Firetail.
 
 The available commands are:
 
-- ``pointsecio run``
+- ``firetail run``
 
 All commands can run with -h or --help to list more information.
 
 Running an OpenAPI specification
 --------------------------------
 
-The subcommand ``run`` of PointSecIO's CLI makes it easy to run OpenAPI
+The subcommand ``run`` of Firetail's CLI makes it easy to run OpenAPI
 specifications directly even before any operation handler function gets
 implemented. This allows you to verify and inspect how your API will
-work with PointSecIO.
+work with Firetail.
 
 To run your specification, execute in your shell:
 
 .. code-block:: bash
 
-     $ pointsecio run your_api.yaml --stub --debug
+     $ firetail run your_api.yaml --stub --debug
 
-This command will tell PointSecIO to run the ``your_api.yaml``
+This command will tell Firetail to run the ``your_api.yaml``
 specification file attaching a stub operation (``--stub``) to the
 unavailable operations/functions of your API and in debug mode
 (``--debug``).
@@ -33,7 +33,7 @@ The basic usage of this command is:
 
 .. code-block:: bash
 
-    $ pointsecio run [OPTIONS] SPEC_FILE [BASE_MODULE_PATH]
+    $ firetail run [OPTIONS] SPEC_FILE [BASE_MODULE_PATH]
 
 Where:
 
@@ -47,7 +47,7 @@ list run:
 
 .. code-block:: bash
 
-     $ pointsecio run --help
+     $ firetail run --help
 
 Running a mock server
 ---------------------
@@ -58,4 +58,4 @@ Your API specification file is not required to have any ``operationId``.
 
 .. code-block:: bash
 
-    $ pointsecio run your_api.yaml --mock=all -v
+    $ firetail run your_api.yaml --mock=all -v

docs/cli.rst

@@ -1,5 +1,5 @@
 #
-# PointSecIO documentation build configuration file, created by
+# Firetail documentation build configuration file, created by
 # sphinx-quickstart on Wed Jun 17 12:09:55 2015.
 #
 # This file is execfile()d with the current directory set to its
@@ -27,7 +27,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-import pointsecio
+import firetail
 extensions = ['autoapi.extension']
 
 autoapi_type = 'python'
@@ -40,7 +40,7 @@
                    'imported-members']
 autoapi_python_class_content = 'both'
 autoapi_dirs = [
-    '../pointsecio'
+    '../firetail'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -56,17 +56,17 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'PointSecIO'
+project = 'Firetail'
 copyright = '2022, point security inc'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = pointsecio.__version__.rsplit('.', 1)[0]
+version = firetail.__version__.rsplit('.', 1)[0]
 # The full version, including alpha/beta/rc tags.
-release = pointsecio.__version__
+release = firetail.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -196,7 +196,7 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'PointSecIOdoc'
+htmlhelp_basename = 'Firetaildoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -216,7 +216,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('index', 'PointSecIO.tex', 'PointSecIO Documentation',
+    ('index', 'Firetail.tex', 'Firetail Documentation',
      'point security inc', 'manual'),
 ]
 
@@ -246,7 +246,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pointsecio', 'PointSecIO Documentation',
+    ('index', 'firetail', 'Firetail Documentation',
      ['point security inc'], 1)
 ]
 
@@ -260,8 +260,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'PointSecIO', 'PointSecIO Documentation',
-     'point security inc', 'PointSecIO', 'One line description of project.',
+    ('index', 'Firetail', 'Firetail Documentation',
+     'point security inc', 'Firetail', 'One line description of project.',
      'Miscellaneous'),
 ]
 

docs/conf.py

@@ -1,16 +1,16 @@
-PointSecIO Cookbook
+Firetail Cookbook
 ==================
 
 This section aims to be a cookbook of possible solutions for specific
-use cases of PointSecIO.
+use cases of Firetail.
 
 Wildcard path parameters
 ------------------------
 
 Path parameters cannot contain slashes by default, but sometimes it's useful
 to have a path parameter which takes the full remainder of the HTTP path
 including slashes, e.g. to allow parsing "my/deep/path" from
-"/pages/my/deep/path". PointSecIO supports parsing such path remainders
+"/pages/my/deep/path". Firetail supports parsing such path remainders
 by using ``format: path``:
 
 .. code-block:: yaml
@@ -32,7 +32,7 @@ Custom type format
 ------------------
 
 It is possible to define custom type formats that are going to be used
-by the PointSecIO payload validation on request parameters and response
+by the Firetail payload validation on request parameters and response
 payloads of your API.
 
 Let's say your API deals with Products and you want to define a field
@@ -87,7 +87,7 @@ draft4 format checker decorator.
         ...
 
 This is all you need to have validation for that format in your
-PointSecIO application. Keep in mind that the format checkers should be
+Firetail application. Keep in mind that the format checkers should be
 defined and registered before you run your application server. A full
 example can be found at
 https://gist.github.com/rafaelcaricio/6e67286a522f747405a7299e6843cd93
@@ -96,15 +96,15 @@ https://gist.github.com/rafaelcaricio/6e67286a522f747405a7299e6843cd93
 CORS Support
 ------------
 
-CORS_ (Cross-origin resource sharing) is not built into PointSecIO, but you can use the `flask-cors`_ library
+CORS_ (Cross-origin resource sharing) is not built into Firetail, but you can use the `flask-cors`_ library
 to set CORS headers:
 
 .. code-block:: python
 
-    import pointsecio
+    import firetail
     from flask_cors import CORS
 
-    app = pointsecio.FlaskApp(__name__)
+    app = firetail.FlaskApp(__name__)
     app.add_api('swagger.yaml')
 
     # add CORS support
@@ -127,7 +127,7 @@ as possible when the program starts or you'll get the default configuration.
 
 .. code-block:: python
 
-    import pointsecio
+    import firetail
     from logging.config import dictConfig
 
 
@@ -142,7 +142,7 @@ as possible when the program starts or you'll get the default configuration.
            'handlers': ['syslog']
         }
     })
-    app = pointsecio.FlaskApp(__name__)
+    app = firetail.FlaskApp(__name__)
     app.app.logger.warn("I configured the flask logger!")
     app.add_api('swagger.yaml')
     app.run(port=8080)

docs/cookbook.rst

@@ -2,12 +2,12 @@ Exception Handling
 ==================
 Rendering Exceptions through the Flask Handler
 ----------------------------------------------
-Flask by default contains an exception handler, which pointsecio's app can proxy
+Flask by default contains an exception handler, which firetail's app can proxy
 to with the ``add_error_handler`` method. You can hook either on status codes
 or on a specific exception type.
 
-PointSecIO is moving from returning flask responses on errors to throwing exceptions
-that are a subclass of ``pointsecio.problem``. So far exceptions thrown in the OAuth
+Firetail is moving from returning flask responses on errors to throwing exceptions
+that are a subclass of ``firetail.problem``. So far exceptions thrown in the OAuth
 decorator have been converted.
 
 Flask Error Handler Example
@@ -38,7 +38,7 @@ Firstly, it's possible to declare what Exception must be handled
 
 
     # init flask app
-    import pointsecio
+    import firetail
 
     def not_found_handler(error):
         return {
@@ -49,17 +49,17 @@ Firstly, it's possible to declare what Exception must be handled
 
     def create_app():
 
-        pointsecio_app = pointsecio.FlaskApp(
+        firetail_app = firetail.FlaskApp(
             __name__, specification_dir="../api/")
-        pointsecio_app.add_api(
+        firetail_app.add_api(
             "openapi.yaml", validate_responses=True,
             base_path="/")
 
         # Handle NotFoundException
-        pointsecio_app.add_error_handler(
+        firetail_app.add_error_handler(
             NotFoundException, not_found_handler)
 
-        app = pointsecio_app.app
+        app = firetail_app.app
         return app
 
 In this way, it's possible to raise anywhere the NotFoundException or its subclasses
@@ -88,12 +88,12 @@ and we know the API will return 404 status code.
 
 Default Exception Handling
 --------------------------
-By default pointsecio exceptions are JSON serialized according to
+By default firetail exceptions are JSON serialized according to
 `Problem Details for HTTP APIs`_
 
-Application can return errors using ``pointsecio.problem`` or exceptions that inherit from both
-``pointsecio.ProblemException`` and a ``werkzeug.exceptions.HttpException`` subclass (for example
-``werkzeug.exceptions.Forbidden``). An example of this is the ``pointsecio.exceptions.OAuthProblem``
+Application can return errors using ``firetail.problem`` or exceptions that inherit from both
+``firetail.ProblemException`` and a ``werkzeug.exceptions.HttpException`` subclass (for example
+``werkzeug.exceptions.Forbidden``). An example of this is the ``firetail.exceptions.OAuthProblem``
 exception
 
 .. code-block:: python
@@ -106,25 +106,25 @@ exception
 
 Examples of Custom Rendering Exceptions
 ---------------------------------------
-To custom render an exception when you boot your pointsecio application you can hook into a custom
+To custom render an exception when you boot your firetail application you can hook into a custom
 exception and render it in some sort of custom format. For example
 
 
 .. code-block:: python
 
     from flask import Response
-    import pointsecio
-    from pointsecio.exceptions import OAuthResponseProblem
+    import firetail
+    from firetail.exceptions import OAuthResponseProblem
 
     def render_unauthorized(exception):
         return Response(response=json.dumps({'error': 'There is an error in the oAuth token supplied'}), status=401, mimetype="application/json")
 
-    app = pointsecio.FlaskApp(__name__, specification_dir='./../swagger/', debug=False, swagger_ui=False)
+    app = firetail.FlaskApp(__name__, specification_dir='./../swagger/', debug=False, swagger_ui=False)
     app.add_error_handler(OAuthResponseProblem, render_unauthorized)
 
 Custom Exceptions
 -----------------
-There are several exception types in pointsecio that contain extra information to help you render appropriate
+There are several exception types in firetail that contain extra information to help you render appropriate
 messages to your user beyond the default description and status code:
 
 OAuthProblem

docs/exceptions.rst

@@ -1,21 +1,21 @@
-.. PointSecIO documentation master file, created by
+.. Firetail documentation master file, created by
    sphinx-quickstart on Wed Jun 17 12:09:55 2015.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to PointSecIO's documentation!
+Welcome to Firetail's documentation!
 =====================================
 
-PointSecIO is a framework on top of Flask_ that automagically handles
+Firetail is a framework on top of Flask_ that automagically handles
 HTTP requests defined using `OpenAPI`_ (formerly known
 as Swagger), supporting both `v2.0`_ and `v3.0`_ of the specification. 
 
-PointSecIO allows you to write these specifications, then maps the
+Firetail allows you to write these specifications, then maps the
 endpoints to your Python functions. This is what makes it unique from
 other tools that generate the specification based on your Python
 code. You are free to describe your REST API with as much detail as
-you want and then PointSecIO guarantees that it will work as
-you specified. We built PointSecIO this way in order to:
+you want and then Firetail guarantees that it will work as
+you specified. We built Firetail this way in order to:
 
 - Simplify the development process
 - Reduce misinterpretation about what an API is going to look like