Implemented as per mark's review comments

fn_query_tor_network/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include fn_query_tor_network/util/*
+include fn_query_tor_network/LICENSE
+include fn_query_tor_network/doc/*

fn_query_tar_network/README.md → fn_query_tor_network/README.md

@@ -4,27 +4,27 @@ Replace this with your own readme.
 
 This template project was generated by
 
-    resilient-circuits codegen -p fn_query_tar_network [-f query_tor_network] [-w ]
+    resilient-circuits codegen -p fn_query_tor_network [-f fn_tor] [-w ]
 
 
 You must edit the `setup.py` before distribution;
 it should contain your actual contact and license information.
 
 To install in "development mode"
 
-    pip install -e ./fn_query_tar_network/
+    pip install -e ./fn_query_tor_network/
 
 After installation, the package will be loaded by `resilient-circuits run`.
 
 
 To uninstall,
 
-    pip uninstall fn_query_tar_network
+    pip uninstall fn_query_tor_network
 
 
 To package for distribution,
 
-    python ./fn_query_tar_network/setup.py sdist
+    python ./fn_query_tor_network/setup.py sdist
 
 The resulting .tar.gz file can be installed using
 

fn_query_tar_network/fn_query_tar_network/components/query_tor_network.py → fn_query_tor_network/fn_query_tor_network/components/fn_tor.py

@@ -5,43 +5,43 @@
 
 import logging
 from resilient_circuits import ResilientComponent, function, handler, StatusMessage, FunctionResult, FunctionError
-import fn_query_tar_network.util.selftest as selftest
+import fn_query_tor_network.util.selftest as selftest
 import requests
 
 class FunctionComponent(ResilientComponent):
-    """Component that implements Resilient function 'query_tor_network"""
+    """Component that implements Resilient function 'fn_tor"""
 
     def __init__(self, opts):
         """constructor provides access to the configuration options"""
         super(FunctionComponent, self).__init__(opts)
-        self.options = opts.get("fn_query_tar_network", {})
+        self.options = opts.get("fn_query_tor_network", {})
         selftest.selftest_function(opts)
 
     @handler("reload")
     def _reload(self, event, opts):
         """Configuration options have changed, save new values"""
-        self.options = opts.get("fn_query_tar_network", {})
+        self.options = opts.get("fn_query_tor_network", {})
 
-    @function("query_tor_network")
-    def _query_tor_network_function(self, event, *args, **kwargs):
-        """Function: This Function to Search for Given Parameter in TOR Relay Exit Node"""
+    @function("fn_tor")
+    def _fn_tor_function(self, event, *args, **kwargs):
+        """Function: This TOR function searches for the given IP Address or host names in TOR exit node Network by using RESTful API"""
         try:
             # Get the function parameters:
-            search_data = kwargs.get("search_data")  # text
+            tor_search_data = kwargs.get("tor_search_data")  # text
 
             log = logging.getLogger(__name__)
-            log.info("search_data: %s", search_data)
+            log.info("tor_search_data: %s", tor_search_data)
 
             # PUT YOUR FUNCTION IMPLEMENTATION CODE HERE
             yield StatusMessage("starting...")
 
             __params_data = {'flag': self.options.get('flag'), 'fields': self.options.get('data_fields'),
-                             'search': search_data}
+                             'search': tor_search_data}
 
             __response_data = requests.get(self.options.get('base_url'), params=__params_data)
 
             __response_data = __response_data.text
-            if __response_data.find(search_data) != -1:
+            if __response_data.find(tor_search_data) != -1:
                 results = {'status': 'success', 'data': __response_data, 'value': True}
             else:
                 log.info("No Data found for given search element...!")

fn_query_tar_network/fn_query_tar_network/util/config.py → fn_query_tor_network/fn_query_tor_network/util/config.py

@@ -1,7 +1,7 @@
 # (c) Copyright IBM Corp. 2010, 2018. All Rights Reserved.
 # -*- coding: utf-8 -*-
 
-"""Generate a default configuration-file section for fn_query_tar_network"""
+"""Generate a default configuration-file section for fn_query_tor_network"""
 
 from __future__ import print_function
 
@@ -10,9 +10,9 @@ def config_section_data():
     """Produce the default configuration section for app.config,
        when called by `resilient-circuits config [-c|-u]`
     """
-    config_data = u"""[fn_query_tar_network]
+    config_data = u"""[fn_query_tor_network]
 base_url = https://onionoo.torproject.org/details
 flag = Exit  
-data_fields = exit_addresses,or_addresses,host_name
-    """
+data_fields = exit_addresses,or_addresses,host_name"""
+
     return config_data

fn_query_tor_network/fn_query_tor_network/util/customize.py

@@ -0,0 +1,98 @@
+# (c) Copyright IBM Corp. 2010, 2018. All Rights Reserved.
+# -*- coding: utf-8 -*-
+
+"""Generate the Resilient customizations required for fn_query_tor_network"""
+
+from __future__ import print_function
+from resilient_circuits.util import *
+
+def codegen_reload_data():
+    """Parameters to codegen used to generate the fn_query_tor_network package"""
+    reload_params = {"package": u"fn_query_tor_network",
+                    "incident_fields": [], 
+                    "action_fields": [], 
+                    "function_params": [u"tor_search_data"], 
+                    "datatables": [], 
+                    "message_destinations": [u"fn_tor"], 
+                    "functions": [u"fn_tor"], 
+                    "phases": [], 
+                    "automatic_tasks": [], 
+                    "scripts": [], 
+                    "workflows": [],
+                    "actions": [] 
+                    }
+    return reload_params
+
+
+def customization_data(client=None):
+    """Produce any customization definitions (types, fields, message destinations, etc)
+       that should be installed by `resilient-circuits customize`
+    """
+
+    # This import data contains:
+    #   Function inputs:
+    #     tor_search_data
+    #   Message Destinations:
+    #     fn_tor
+    #   Functions:
+    #     fn_tor
+
+
+    yield ImportDefinition(u"""
+eyJ0YXNrX29yZGVyIjogW10sICJ3b3JrZmxvd3MiOiBbXSwgImFjdGlvbnMiOiBbXSwgImxheW91
+dHMiOiBbXSwgImV4cG9ydF9mb3JtYXRfdmVyc2lvbiI6IDIsICJpZCI6IDI1LCAiaW5kdXN0cmll
+cyI6IG51bGwsICJwaGFzZXMiOiBbXSwgImFjdGlvbl9vcmRlciI6IFtdLCAiZ2VvcyI6IG51bGws
+ICJzZXJ2ZXJfdmVyc2lvbiI6IHsibWFqb3IiOiAzMCwgInZlcnNpb24iOiAiMzAuNC4yMzciLCAi
+YnVpbGRfbnVtYmVyIjogMjM3LCAibWlub3IiOiA0fSwgInRpbWVmcmFtZXMiOiBudWxsLCAid29y
+a3NwYWNlcyI6IFtdLCAiYXV0b21hdGljX3Rhc2tzIjogW10sICJmdW5jdGlvbnMiOiBbeyJkaXNw
+bGF5X25hbWUiOiAiVE9SIiwgImRlc2NyaXB0aW9uIjogeyJjb250ZW50IjogIlRoaXMgVE9SIGZ1
+bmN0aW9uIHNlYXJjaGVzIGZvciB0aGUgZ2l2ZW4gSVAgQWRkcmVzcyBvciBob3N0IG5hbWVzIGlu
+IFRPUiBleGl0IG5vZGUgTmV0d29yayBieSB1c2luZyBSRVNUZnVsIEFQSSIsICJmb3JtYXQiOiAi
+dGV4dCJ9LCAiY3JlYXRvciI6IHsiZGlzcGxheV9uYW1lIjogIk5pdGluIEthbmRoYXJlICIsICJ0
+eXBlIjogInVzZXIiLCAiaWQiOiA2LCAibmFtZSI6ICJua2FuZGhhMUBpbi5pYm0uY29tIn0sICJ2
+aWV3X2l0ZW1zIjogW3sic2hvd19pZiI6IG51bGwsICJmaWVsZF90eXBlIjogIl9fZnVuY3Rpb24i
+LCAic2hvd19saW5rX2hlYWRlciI6IGZhbHNlLCAiZWxlbWVudCI6ICJmaWVsZF91dWlkIiwgImNv
+bnRlbnQiOiAiOWEyYWNlMTEtM2FkMC00YmI2LTkxZTMtZmQxMTcwNjk4YmZlIiwgInN0ZXBfbGFi
+ZWwiOiBudWxsfV0sICJleHBvcnRfa2V5IjogImZuX3RvciIsICJ1dWlkIjogIjBiNDcyOTQyLWY3
+MTgtNGEwYy04NTVlLWYxODBlMGZjNTViNiIsICJsYXN0X21vZGlmaWVkX2J5IjogeyJkaXNwbGF5
+X25hbWUiOiAiTml0aW4gS2FuZGhhcmUgIiwgInR5cGUiOiAidXNlciIsICJpZCI6IDYsICJuYW1l
+IjogIm5rYW5kaGExQGluLmlibS5jb20ifSwgInZlcnNpb24iOiA0LCAid29ya2Zsb3dzIjogW3si
+ZGVzY3JpcHRpb24iOiBudWxsLCAib2JqZWN0X3R5cGUiOiAiYXJ0aWZhY3QiLCAiYWN0aW9ucyI6
+IFtdLCAibmFtZSI6ICJFeGFtcGxlOiBRdWVyeSBUT1IgTmV0d29yayIsICJ3b3JrZmxvd19pZCI6
+IDI5LCAicHJvZ3JhbW1hdGljX25hbWUiOiAiZXhhbXBsZV9xdWVyeV90b3JfbmV0d29yayIsICJ1
+dWlkIjogbnVsbH1dLCAibGFzdF9tb2RpZmllZF90aW1lIjogMTU0NTMxNzYyMTA1NiwgImRlc3Rp
+bmF0aW9uX2hhbmRsZSI6ICJmbl90b3IiLCAiaWQiOiAyNywgIm5hbWUiOiAiZm5fdG9yIn1dLCAi
+bm90aWZpY2F0aW9ucyI6IG51bGwsICJyZWd1bGF0b3JzIjogbnVsbCwgImluY2lkZW50X3R5cGVz
+IjogW3siY3JlYXRlX2RhdGUiOiAxNTQ1MzE5MzMyNzA0LCAiZGVzY3JpcHRpb24iOiAiQ3VzdG9t
+aXphdGlvbiBQYWNrYWdlcyAoaW50ZXJuYWwpIiwgImV4cG9ydF9rZXkiOiAiQ3VzdG9taXphdGlv
+biBQYWNrYWdlcyAoaW50ZXJuYWwpIiwgImlkIjogMCwgIm5hbWUiOiAiQ3VzdG9taXphdGlvbiBQ
+YWNrYWdlcyAoaW50ZXJuYWwpIiwgInVwZGF0ZV9kYXRlIjogMTU0NTMxOTMzMjcwNCwgInV1aWQi
+OiAiYmZlZWMyZDQtMzc3MC0xMWU4LWFkMzktNGEwMDA0MDQ0YWEwIiwgImVuYWJsZWQiOiBmYWxz
+ZSwgInN5c3RlbSI6IGZhbHNlLCAicGFyZW50X2lkIjogbnVsbCwgImhpZGRlbiI6IGZhbHNlfV0s
+ICJzY3JpcHRzIjogW10sICJ0eXBlcyI6IFtdLCAibWVzc2FnZV9kZXN0aW5hdGlvbnMiOiBbeyJ1
+dWlkIjogIjI3MjE5YzM5LWQ5MzYtNDEzNy05NjJkLTY3ZGJhYTYzMDdmZCIsICJleHBvcnRfa2V5
+IjogImZuX3RvciIsICJuYW1lIjogImZuX3RvciIsICJkZXN0aW5hdGlvbl90eXBlIjogMCwgInBy
+b2dyYW1tYXRpY19uYW1lIjogImZuX3RvciIsICJleHBlY3RfYWNrIjogdHJ1ZSwgInVzZXJzIjog
+WyJua2FuZGhhMUBpbi5pYm0uY29tIl19XSwgImluY2lkZW50X2FydGlmYWN0X3R5cGVzIjogW10s
+ICJyb2xlcyI6IFtdLCAiZmllbGRzIjogW3sib3BlcmF0aW9ucyI6IFtdLCAicmVhZF9vbmx5Ijog
+dHJ1ZSwgIm5hbWUiOiAiaW5jX3RyYWluaW5nIiwgInRlbXBsYXRlcyI6IFtdLCAidHlwZV9pZCI6
+IDAsICJjaG9zZW4iOiBmYWxzZSwgInRleHQiOiAiU2ltdWxhdGlvbiIsICJkZWZhdWx0X2Nob3Nl
+bl9ieV9zZXJ2ZXIiOiBmYWxzZSwgImV4cG9ydF9rZXkiOiAiaW5jaWRlbnQvaW5jX3RyYWluaW5n
+IiwgInRvb2x0aXAiOiAiV2hldGhlciB0aGUgaW5jaWRlbnQgaXMgYSBzaW11bGF0aW9uIG9yIGEg
+cmVndWxhciBpbmNpZGVudC4gIFRoaXMgZmllbGQgaXMgcmVhZC1vbmx5LiIsICJyaWNoX3RleHQi
+OiBmYWxzZSwgIm9wZXJhdGlvbl9wZXJtcyI6IHt9LCAicHJlZml4IjogbnVsbCwgImludGVybmFs
+IjogZmFsc2UsICJ2YWx1ZXMiOiBbXSwgImJsYW5rX29wdGlvbiI6IGZhbHNlLCAiaW5wdXRfdHlw
+ZSI6ICJib29sZWFuIiwgImNoYW5nZWFibGUiOiB0cnVlLCAiaGlkZV9ub3RpZmljYXRpb24iOiBm
+YWxzZSwgImlkIjogNTEsICJ1dWlkIjogImMzZjBlM2VkLTIxZTEtNGQ1My1hZmZiLWZlNWNhMzMw
+OGNjYSJ9LCB7Im9wZXJhdGlvbnMiOiBbXSwgInR5cGVfaWQiOiAxMSwgIm9wZXJhdGlvbl9wZXJt
+cyI6IHt9LCAidGV4dCI6ICJ0b3Jfc2VhcmNoX2RhdGEiLCAiYmxhbmtfb3B0aW9uIjogZmFsc2Us
+ICJwcmVmaXgiOiBudWxsLCAiY2hhbmdlYWJsZSI6IHRydWUsICJpZCI6IDE0MCwgInJlYWRfb25s
+eSI6IGZhbHNlLCAidXVpZCI6ICI5YTJhY2UxMS0zYWQwLTRiYjYtOTFlMy1mZDExNzA2OThiZmUi
+LCAiY2hvc2VuIjogZmFsc2UsICJpbnB1dF90eXBlIjogInRleHQiLCAidG9vbHRpcCI6ICIiLCAi
+aW50ZXJuYWwiOiBmYWxzZSwgInJpY2hfdGV4dCI6IGZhbHNlLCAidGVtcGxhdGVzIjogW10sICJl
+eHBvcnRfa2V5IjogIl9fZnVuY3Rpb24vdG9yX3NlYXJjaF9kYXRhIiwgImhpZGVfbm90aWZpY2F0
+aW9uIjogZmFsc2UsICJwbGFjZWhvbGRlciI6ICIiLCAibmFtZSI6ICJ0b3Jfc2VhcmNoX2RhdGEi
+LCAiZGVmYXVsdF9jaG9zZW5fYnlfc2VydmVyIjogZmFsc2UsICJ2YWx1ZXMiOiBbXX1dLCAib3Zl
+cnJpZGVzIjogW10sICJleHBvcnRfZGF0ZSI6IDE1NDUzMTg4NjEzNjZ9
+"""
+    )

fn_query_tar_network/fn_query_tar_network/util/selftest.py → fn_query_tor_network/fn_query_tor_network/util/selftest.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 # pragma pylint: disable=unused-argument, no-self-use
 """Function implementation
-   test with: resilient-circuits selftest -l fn_query_tar_network
+   test with: resilient-circuits selftest -l fn_query_tor_network
 """
 
 import logging
@@ -18,7 +18,7 @@ def selftest_function(opts):
     Placeholder for selftest function. An example use would be to test package api connectivity.
     Suggested return values are be unimplemented, success, or failure.
     """
-    options = opts.get("fn_query_tar_network", {})
+    options = opts.get("fn_query_tor_network", {})
     try:
         connection_status = requests.get(options.get('base_url'))
         if not connection_status.status_code == 200:

fn_query_tar_network/setup.py → fn_query_tor_network/setup.py

@@ -5,17 +5,17 @@
 from setuptools import setup, find_packages
 
 setup(
-    name='fn_query_tar_network',
+    name='fn_query_tor_network',
     version='1.0.0',
     license='MIT',
     author='Resilient Labs',
     author_email='[email protected]',
     url='https://github.com/ibmresilient/resilient-community-apps',
     description="Resilient Circuits Components for 'fn_query_tar_network'",
     long_description="""The Query TOR Network API is RESTful web service allowing query tar network customer
-                        search for IP Addresses or host names in tor relay exit node database.and results
-                        will be updated on the Dashboard.
-                     """,
+                    search for IP Addresses or host names in tor relay exit node database.and results
+                    will be updated on the Incidents Notes Dashboard.
+                 """,
     install_requires=[
         'resilient_circuits>=30.0.0'
     ],
@@ -27,10 +27,10 @@
     ],
     entry_points={
         "resilient.circuits.components": [
-            "QueryTorNetworkFunctionComponent = fn_query_tar_network.components.query_tor_network:FunctionComponent"
+            "FnTorFunctionComponent = fn_query_tor_network.components.fn_tor:FunctionComponent"
         ],
-        "resilient.circuits.configsection": ["gen_config = fn_query_tar_network.util.config:config_section_data"],
-        "resilient.circuits.customize": ["customize = fn_query_tar_network.util.customize:customization_data"],
-        "resilient.circuits.selftest": ["selftest = fn_query_tar_network.util.selftest:selftest_function"]
+        "resilient.circuits.configsection": ["gen_config = fn_query_tor_network.util.config:config_section_data"],
+        "resilient.circuits.customize": ["customize = fn_query_tor_network.util.customize:customization_data"],
+        "resilient.circuits.selftest": ["selftest = fn_query_tor_network.util.selftest:selftest_function"]
     }
 )