Merge pull request #106 from ChuckWoodraska/ID-1476

ID-1476 Added new method so that Iris Enrich can be used in the cli

Author: ChuckWoodraska

domaintools/api.py

@@ -292,6 +292,35 @@ def iris_enrich(self, *domains, **kwargs):
         return self._results('iris-enrich', '/v1/iris-enrich/', domain=domains, data_updated_after=data_updated_after,
                              items_path=('results',), **kwargs)
 
+    def iris_enrich_cli(self, domains=None, **kwargs):
+        """Returns back enriched data related to the specified domains using our Iris Enrich service.
+            This is a CLI version of the iris_enrich method to help maintain backwards compatibility.
+
+           api.iris_enrich(['domaintools.com', 'google.com'])
+
+           api.iris_enrich(DOMAIN_LIST)['results_count'] Returns the number of results
+           api.iris_enrich(DOMAIN_LIST)['missing_domains'] Returns any domains that we were unable to
+                                                           retrieve enrichment data for
+           api.iris_enrich(DOMAIN_LIST)['limit_exceeded'] Returns True if you've exceeded your API usage
+
+           for enrichment in api.iris_enrich(DOMAIN_LIST):  # Enables looping over all returned enriched domains
+
+           for example:
+               enrich_domains = ['google.com', 'amazon.com']
+               assert api.iris_enrich(*enrich_domains)['missing_domains'] == []
+        """
+        if not domains:
+            raise ValueError('One or more domains to enrich must be provided')
+
+        if isinstance(domains, (list, tuple)):
+            domains = ','.join(domains)
+        data_updated_after = kwargs.get('data_updated_after', None)
+        if hasattr(data_updated_after, 'strftime'):
+            data_updated_after = data_updated_after.strftime('%Y-%m-%d')
+
+        return self._results('iris-enrich', '/v1/iris-enrich/', domain=domains, data_updated_after=data_updated_after,
+                             items_path=('results',), **kwargs)
+
     def iris_investigate(self, domains=None, data_updated_after=None, expiration_date=None,
                          create_date=None, active=None, search_hash=None, **kwargs):
         """Returns back a list of domains based on the provided filters.

tests/fixtures/vcr/test_iris_enrich_cli.yaml

@@ -0,0 +1,45 @@
+interactions:
+- request:
+    body: app_name=python_wrapper&app_version=0.6.2&domain=google.com
+    headers:
+      accept:
+      - '*/*'
+      accept-encoding:
+      - gzip, deflate
+      connection:
+      - keep-alive
+      content-length:
+      - '203'
+      content-type:
+      - application/x-www-form-urlencoded
+      host:
+      - api.domaintools.com
+      user-agent:
+      - python-httpx/0.22.0
+    method: POST
+    uri: https://api.domaintools.com/v1/iris-enrich/
+  response:
+    content: '{"response":{"limit_exceeded":false,"message":"Enjoy your data.","results_count":1,"results":[{"domain":"google.com","whois_url":"https:\/\/whois.domaintools.com\/google.com","adsense":{"value":""},"alexa":1,"popularity_rank":1,"active":true,"google_analytics":{"value":""},"admin_contact":{"name":{"value":""},"org":{"value":"Google
+      LLC"},"street":{"value":""},"city":{"value":""},"state":{"value":"CA"},"postal":{"value":""},"country":{"value":"us"},"phone":{"value":""},"fax":{"value":""},"email":[{"value":"select
+      request email form at https:\/\/domains.markmonitor.com\/whois\/google.com"}]},"billing_contact":{"name":{"value":""},"org":{"value":""},"street":{"value":""},"city":{"value":""},"state":{"value":""},"postal":{"value":""},"country":{"value":""},"phone":{"value":""},"fax":{"value":""},"email":[]},"registrant_contact":{"name":{"value":""},"org":{"value":"Google
+      LLC"},"street":{"value":""},"city":{"value":""},"state":{"value":"CA"},"postal":{"value":""},"country":{"value":"us"},"phone":{"value":""},"fax":{"value":""},"email":[{"value":"select
+      request email form at https:\/\/domains.markmonitor.com\/whois\/google.com"}]},"technical_contact":{"name":{"value":""},"org":{"value":"Google
+      LLC"},"street":{"value":""},"city":{"value":""},"state":{"value":"CA"},"postal":{"value":""},"country":{"value":"us"},"phone":{"value":""},"fax":{"value":""},"email":[{"value":"select
+      request email form at https:\/\/domains.markmonitor.com\/whois\/google.com"}]},"create_date":{"value":"1997-09-15"},"expiration_date":{"value":"2028-09-14"},"email_domain":[{"value":"markmonitor.com"},{"value":"google.com"}],"soa_email":[{"value":"[email protected]"}],"ssl_email":[],"additional_whois_email":[{"value":"[email protected]"},{"value":"[email protected]"}],"ip":[{"address":{"value":"142.250.217.78"},"asn":[{"value":15169}],"country_code":{"value":"US"},"isp":{"value":"Google"}},{"address":{"value":"142.250.69.196"},"asn":[{"value":15169}],"country_code":{"value":"US"},"isp":{"value":"Google"}}],"mx":[{"host":{"value":"smtp.google.com"},"domain":{"value":"google.com"},"ip":[{"value":"74.125.195.27"},{"value":"74.125.135.26"},{"value":"74.125.195.26"},{"value":"74.125.142.26"},{"value":"74.125.142.27"}],"priority":10}],"name_server":[{"host":{"value":"ns4.google.com"},"domain":{"value":"google.com"},"ip":[{"value":"216.239.38.10"}]},{"host":{"value":"ns2.google.com"},"domain":{"value":"google.com"},"ip":[{"value":"216.239.34.10"}]},{"host":{"value":"ns1.google.com"},"domain":{"value":"google.com"},"ip":[{"value":"216.239.32.10"}]},{"host":{"value":"ns3.google.com"},"domain":{"value":"google.com"},"ip":[{"value":"216.239.36.10"}]}],"domain_risk":{"risk_score":0,"components":[{"name":"zerolist","risk_score":0},{"name":"threat_profile","risk_score":0},{"name":"threat_profile_malware","risk_score":0},{"name":"threat_profile_phishing","risk_score":0},{"name":"threat_profile_spam","risk_score":0}]},"redirect":{"value":""},"redirect_domain":{"value":""},"registrant_name":{"value":""},"registrant_org":{"value":"Google
+      LLC"},"registrar":{"value":"MarkMonitor, Inc."},"registrar_status":["clientdeleteprohibited","clienttransferprohibited","clientupdateprohibited","serverdeleteprohibited","servertransferprohibited","serverupdateprohibited"],"spf_info":"","ssl_info":[{"hash":{"value":"fcebe5bb73f9541e544eb1a784ada0b35060412b"},"subject":{"value":"CN=www.google.com"},"organization":{"value":""},"email":[]}],"tld":"com","website_response":200,"data_updated_timestamp":"2022-06-15T08:44:07.327000","tags":[]}],"missing_domains":[]}}'
+    headers:
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Wed, 15 Jun 2022 15:03:07 GMT
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-TIME:
+      - '68140'
+    http_version: HTTP/1.1
+    status_code: 200
+version: 1

tests/test_api.py

@@ -408,6 +408,17 @@ def test_iris_enrich():
         assert result['domain'] == 'google.com'
 
 
+@vcr.use_cassette
+def test_iris_enrich_cli():
+    with pytest.raises(ValueError):
+        api.iris_enrich()
+
+    enriched_data = api.iris_enrich('google.com')
+    assert enriched_data['results_count']
+    for result in enriched_data:
+        assert result['domain'] == 'google.com'
+
+
 @vcr.use_cassette
 def test_iris_investigate():
     with pytest.raises(ValueError):