Refactor API module and add server health check (#25)

* Refactored API module to be separate modules

* Added new health check method

* Small changes to session

* Made health check private

* Updated getting started docs

Author: mattmanley

docs/usage/functionality.rst

@@ -1,14 +1,30 @@
 Functionality
 =====================================================
 
-Module: api
+Module: project
 -----------------------------------------------------
 
-.. automodule:: maproulette.api.api
+.. automodule:: maproulette.api.project
     :members:
+    :show-inheritance:
+
+Module: challenge
+-----------------------------------------------------
+
+.. automodule:: maproulette.api.challenge
+    :members:
+    :show-inheritance:
+
+Module: task
+-----------------------------------------------------
+
+.. automodule:: maproulette.api.task
+    :members:
+    :show-inheritance:
 
 Module: configuration
 -----------------------------------------------------
 
 .. automodule:: maproulette.api.configuration
     :members:
+    :show-inheritance:

docs/usage/getting_started.rst

@@ -22,16 +22,17 @@ that when you create your configuration. For example:
     config = maproulette.Configuration(api_key='{YOUR_API_KEY}')
 
 
-Once you have your configuration object, we can create our API object. This gives us access to all of the functionality
-in the MapRoulette package.
+Once you have your configuration object we can create an API object using one of several modules depending on the
+functionality that the user is looking for. For example, creating a Project object allows the user to interact with all
+of the project-related functionality in the MapRoulette package.
 
 .. code-block:: python
 
-    api = maproulette.Api(config)
+    api = maproulette.Project(config)
 
 
-Now we have access to the MapRoulette API methods. In the example below, I want to find a project by name using a search
-string:
+Now we have access to the MapRoulette Project API methods. In the example below, I want to find a project by name using
+a search string:
 
 .. code-block:: python
 

examples/add_tasks_to_challenge.py

@@ -5,7 +5,7 @@
 config = maproulette.Configuration(api_key="API_KEY")
 
 # Create an API objects with the above config object:
-api = maproulette.Api(config)
+api = maproulette.Challenge(config)
 
 # Specify the ID of the challenge you want to add tasks to:
 challenge_id = 'TEST_ID'

examples/create_challenge_from_model.py

@@ -5,7 +5,7 @@
 config = maproulette.Configuration(api_key="API_KEY")
 
 # Create an API objects with the above config object:
-api = maproulette.Api(config)
+api = maproulette.Challenge(config)
 
 # Creating a test challenge model with name and child task
 challenge_data = maproulette.ChallengeModel(name='Test_Challenge_Name')

examples/create_project_from_model.py

@@ -5,7 +5,7 @@
 configuration = maproulette.Configuration(api_key='{YOUR_API_KEY}')
 
 # Create an API object using your config object
-api = maproulette.Api(configuration)
+api = maproulette.Project(configuration)
 
 # Initialize a project model using the project name
 my_project = maproulette.ProjectModel(name='my_new_project_name_20200120_abc')

examples/find_project.py

@@ -5,7 +5,7 @@
 config = maproulette.Configuration(api_key='{YOUR_API_KEY}')
 
 # Create an API object using your config object
-api = maproulette.Api(config)
+api = maproulette.Project(config)
 
 # We want to fetch a project with name 'Health Facilities in India'
 my_project_name = 'Health Facilities in India'

examples/get_challenge_by_id.py

@@ -5,7 +5,7 @@
 config = maproulette.Configuration(api_key="API_KEY")
 
 # Create an API objects with the above config object:
-api = maproulette.Api(config)
+api = maproulette.Challenge(config)
 
 # Specify the ID of the challenge you want up add tasks to:
 challenge_id = '12974'

examples/get_challenge_statistics_by_id.py

@@ -5,10 +5,10 @@
 config = maproulette.Configuration(api_key="API_KEY")
 
 # Create an API objects with the above config object:
-api = maproulette.Api(config)
+api = maproulette.Challenge(config)
 
 # Specify the ID of the challenge you want up add tasks to:
 challenge_id = 'TEST_ID'
 
 # Printing response
-print(json.dumps(api.get_challenge_metadata_by_id(challenge_id)))
+print(json.dumps(api.get_challenge_statistics_by_id(challenge_id)))

examples/get_challenge_tasks.py

@@ -5,7 +5,7 @@
 config = maproulette.Configuration(api_key="API_KEY")
 
 # Create an API objects with the above config object:
-api = maproulette.Api(config)
+api = maproulette.Challenge(config)
 
 # Specify the ID of the challenge you want up add tasks to:
 challenge_id = '12978'

examples/get_project_by_id.py

@@ -5,7 +5,7 @@
 config = maproulette.Configuration(api_key='{YOUR_API_KEY}')
 
 # Create an API object using your config object
-api = maproulette.Api(config)
+api = maproulette.Project(config)
 
 # We want to fetch a project with ID '4719'
 my_project_id = '4719'