Merge remote-tracking branch 'origin/v2x_maintenance'

Author: pombredanne

.gitignore

@@ -1,4 +1,5 @@
 *.py[cod]
+.Python
 
 /build
 /bin

README.rst

@@ -187,11 +187,10 @@ as an input.
                             with the generated .ABOUT file using data fetched from a DejaCode License Library.
                             The following additional options are required:
                             --api_url - URL to the DejaCode License Library API endpoint
-                            --api_username - DejaCode username
-                            --api_key - DejaCode API key for this username
-    
+                            --api_key - DejaCode API key
+
                             Example syntax:
-                            python about_code_tool/genabout.py --extract_license --api_url='api_url' --api_username='api_username' --api_key='api_key'
+                            python about_code_tool/genabout.py --extract_license --api_url='api_url' --api_key='api_key'
 
 
 Example::

USAGE.rst

@@ -83,12 +83,11 @@ genabout.py
                             Extract License text and create <license_key>.LICENSE side-by-side
                                 with the .ABOUT from DJE License Library.
                             api_url - URL to the DJE License Library
-                            api_username - The regular DJE username
-                            api_key - Hash attached to your username which is used to authenticate
-                                        yourself in the API. Contact us to get the hash key.
+                            api_key - Hash which is used to authenticate yourself in the API.
+                                      Contact us to get the hash key.
 
                             Example syntax:
-                            genabout.py --extract_license --api_url='api_url' --api_username='api_username' --api_key='api_key'
+                            genabout.py --extract_license --api_url='api_url' --api_key='api_key'
 
 Purpose
 -------
@@ -177,12 +176,11 @@ Options
 
         This option requires 3 parameters:
             api_url - URL to the DJE License Library
-            api_username - The regular DJE username
-            api_key - Hash attached to your username which is used to authenticate
-                        yourself in the API.
+            api_key - Hash which is used to authenticate yourself in the API.
+                      Contact us to get the hash key.
         (Please contact us to get the api_* value to use this feature)
 
-    $ python genabout.py --extract_license --api_url='api_url' --api_username='api_username' --api_key='api_key' <input path> <output path>
+    $ python genabout.py --extract_license --api_url='api_url' --api_key='api_key' <input path> <output path>
 
 
 genattrib.py

about_code_tool/about.py

@@ -2,7 +2,7 @@
 # -*- coding: utf8 -*-
 
 # ============================================================================
-#  Copyright (c) 2013-2015 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2016 nexB Inc. http://www.nexb.com/ - All rights reserved.
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
 #  You may obtain a copy of the License at
@@ -428,9 +428,14 @@ def validate_field_values_are_not_empty(self):
                 continue
 
             if field_name in MANDATORY_FIELDS:
-                err = Error(VALUE, field_name, None,
-                            'This mandatory field has no value.')
-                self.errors.append(err)
+                if field_name == 'version':
+                    err = Warn(VALUE, field_name, None,
+                           'This mandatory field has no value.')
+                    self.warnings.append(err)
+                else:
+                    err = Error(VALUE, field_name, None,
+                                'This mandatory field has no value.')
+                    self.errors.append(err)
             elif field_name in OPTIONAL_FIELDS:
                 err = Warn(VALUE, field_name, None,
                            'This optional field has no value.')
@@ -517,8 +522,12 @@ def validate_mandatory_fields_are_present(self):
         """
         for field_name in MANDATORY_FIELDS:
             if field_name not in self.validated_fields:
-                self.errors.append(Error(VALUE, field_name, None,
+                if field_name == 'version' :
+                    self.warnings.append(Error(VALUE, field_name, None,
                                          'Mandatory field missing'))
+                else:
+                    self.errors.append(Error(VALUE, field_name, None,
+                                             'Mandatory field missing'))
 
     def validate_known_optional_fields(self, field_name):
         """

about_code_tool/genabout.py

@@ -2,7 +2,7 @@
 # -*- coding: utf8 -*-
 
 # ============================================================================
-#  Copyright (c) 2013-2015 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2016 nexB Inc. http://www.nexb.com/ - All rights reserved.
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
 #  You may obtain a copy of the License at
@@ -279,50 +279,51 @@ def verify_files_existence(self, input_list, project_dir, file_in_project):
                         self.warnings.append(Warn(FILE, file_key, path, 'File does not exist.'))
         return files_list
 
-    def request_license_data(self, url, username, api_key, license_key):
+    def request_license_data(self, url, api_key, license_key):
         """
-        Return a dictionary of license data. 
-
+        Return a dictionary of license data.
         Send a request to a given API URL to gather license data for
-        license_key, authenticating through an api_key and username.
+        license_key, authenticating through an api_key.
         """
         payload = {
-            'username': username,
             'api_key': api_key,
+            'key': license_key,
             'format': 'json'
         }
 
         url = url.rstrip('/')
         encoded_payload = urllib.urlencode(payload)
-        full_url = '%(url)s/%(license_key)s/?%(encoded_payload)s' % locals()
+        full_url = '%(url)s/?%(encoded_payload)s' % locals()
         # handle special characters in URL such as space etc.
         full_url = urllib.quote(full_url, safe="%/:=&?~#+!$,;'@()*[]")
+        headers = {'Authorization': 'Token %s' % api_key}
         license_data = {}
         try:
             # The 'self.extract_license_api_error' is True if any of the
-            # api_url/api_username/api_key/network status have problem.
+            # api_url/api_key/network status have problem.
             if not self.extract_license_api_error:
-                request = urllib2.Request(full_url)
+                request = urllib2.Request(full_url, headers=headers)
                 response = urllib2.urlopen(request)
                 response_content = response.read()
                 license_data = json.loads(response_content)
         except urllib2.HTTPError, http_e:
             # some auth problem
             if http_e.code == 401:
-                error_msg = ("Authorization denied. Invalid '--api_username' or '--api_key'. License generation is skipped.")
+                error_msg = ("Authorization denied. Invalid '--api_key'. License generation is skipped.")
                 print('\n%(error_msg)s\n' % locals())
                 self.extract_license_api_error = True
-                self.errors.append(Error(VALUE, 'username/api_key', username + '/' + api_key, error_msg))
+                self.errors.append(Error(VALUE, 'api_key', api_key, error_msg))
             else:
-                # Since no api_url/api_username/api_key/network status have
+                # Since no api_url/api_key/network status have
                 # problem detected, it yields 'dje_license_key' is the cause of
-                # this exception. 
+                # this exception.
                 self.errors.append(Error(VALUE, 'dje_license_key', license_key, "Invalid 'dje_license_key'"))
         except ValueError as e:
             # FIXME: when does this happen?
             pass
         finally:
-            return license_data
+            license_data = license_data.get('results')[0] if license_data.get('count') == 1 else {}
+        return license_data
 
     @staticmethod
     def copy_files(gen_location, files_list):
@@ -348,12 +349,12 @@ def write_licenses(self, license_context_list):
                             'Something is wrong.')
                 self.errors.append(err)
 
-    def get_license_details_from_api(self, url, username, api_key, license_key):
+    def get_license_details_from_api(self, url, api_key, license_key):
         """
         Returns the license_text of a given license_key using an API request.
         Returns an empty string if the text is not available.
         """
-        license_data = self.request_license_data(url, username, api_key, license_key)
+        license_data = self.request_license_data(url, api_key, license_key)
         license_name = license_data.get('name', '')
         license_text = license_data.get('full_text', '')
         license_key = license_data.get('key', '')
@@ -398,7 +399,7 @@ def get_dje_license_list(self, gen_location, input_list, gen_license, dje_licens
                                                   "Missing 'dje_license_key' for " + line['about_file']))
         return license_output_list
 
-    def pre_process_and_dje_license_dict(self, input_list, api_url, api_username, api_key):
+    def pre_process_and_dje_license_dict(self, input_list, api_url, api_key):
         """
         Modify a list of About data dictionaries by adding license information
         fetched from the DejaCode API.
@@ -427,9 +428,9 @@ def pre_process_and_dje_license_dict(self, input_list, api_url, api_username, ap
                         self.errors.append(Error(VALUE, 'dje_license_key', line['dje_license_key'], "No multiple licenses or newline character are accepted."))
                         continue
                     lic = line['dje_license_key']
-                    if not lic in license_dict:
+                    if lic not in license_dict:
                         detail_list = []
-                        license_name, license_key, license_text = self.get_license_details_from_api(api_url, api_username, api_key, lic)
+                        license_name, license_key, license_text = self.get_license_details_from_api(api_url, api_key, lic)
                         line['dje_license_key'] = license_key
                         license_dict[license_key] = license_name
                         line['dje_license_name'] = license_name
@@ -448,13 +449,13 @@ def pre_process_and_dje_license_dict(self, input_list, api_url, api_username, ap
     def valid_api_url(self, api_url):
         try:
             request = urllib2.Request(api_url)
-            # This will always goes to exception as no username/key are provided.
+            # This will always goes to exception as no key are provided.
             # The purpose of this code is to validate the provided api_url is correct
             response = urllib2.urlopen(request)
         except urllib2.HTTPError, http_e:
-            # The 405 error code is refer to "Method not allowed".
-            # This is correct as no username and key are provided.
-            if http_e.code == 405:
+            # The 403 error code is refer to "Authentication credentials were not provided.".
+            # This is correct as no key are provided.
+            if http_e.code == 403:
                 return True
         except:
             # All other exceptions yield to invalid api_url
@@ -481,7 +482,7 @@ def process_dje_licenses(self, dje_license_list, dje_license_dict, output_path):
 
     def pre_generation(self, gen_location, input_list, action_num):
         """
-        Perfom some pre-generation.
+        Perform some pre-generation.
         TODO: document me
         """
         output_list = []
@@ -500,6 +501,18 @@ def pre_generation(self, gen_location, input_list, action_num):
                     file_location = dirname(file_location)
                     file_location = join(file_location, basename(file_location))
                 file_location += '.ABOUT'
+            # The following code is to check if there is any directory ends with spaces
+            split_path = file_location.split('/')
+            dir_endswith_space = False
+            for segment in split_path:
+                if segment.endswith(' '):
+                    msg = 'File path contains directory name ends with spaces which is not allowed. Generation skipped.'
+                    self.errors.append(Error(VALUE, 'about_file_path',
+                                             file_location, msg))
+                    dir_endswith_space = True
+                    break
+            if dir_endswith_space:
+                continue
 
             about_file_location = join(gen_location, file_location)
             about_file_dir = dirname(about_file_location)
@@ -670,12 +683,11 @@ def filter_dicts_of_empty_values(abouts):
 Fetch and save license texts in <license_key>.LICENSE files side-by-side with the
 .ABOUT files using the DejaCode License Library API.
 api_url - URL to the DejaCode License Library.
-api_username - The DejaCode username.
-api_key - Key attached to your username and used to authenticate
-          yourself in the API. Contact us to get an API key.
+api_key - Key used to authenticate yourself in the API.
+          Contact us to get an API key.
 
 Example syntax:
-genabout.py --extract_license --api_url='api_url' --api_username='api_username' --api_key='api_key'
+genabout.py --extract_license --api_url='api_url' --api_key='api_key'
 """
 
 
@@ -692,7 +704,6 @@ def main(parser, options, args):
 
     action_num = 0
     api_url = ''
-    api_username = ''
     api_key = ''
     gen_license = False
     dje_license_dict = {}
@@ -734,12 +745,11 @@ def main(parser, options, args):
 
     if extract_license:
         api_url = extract_license[0].partition('--api_url=')[2]
-        api_username = extract_license[1].partition('--api_username=')[2]
-        api_key = extract_license[2].partition('--api_key=')[2]
+        api_key = extract_license[1].partition('--api_key=')[2]
         gen_license = True
 
     if not len(args) == 2:
-        print('ERROR: <input_path> and <utput_path> are required.')
+        print('ERROR: <input_path> and <output_path> are required.')
         print()
         parser.print_help()
         sys.exit(errno.EEXIST)
@@ -800,13 +810,15 @@ def main(parser, options, args):
     if mapping_config:
         mappings = get_mappings(location=None)
         input_data = apply_mappings(input_data, mappings)
-        user_keys = mappings.values()
+        user_keys = mappings.keys()
 
     gen.validate(input_data)
 
     ignored_fields_list = get_unknown_fields(input_data, user_keys)
     if ignored_fields_list:
         input_list = gen.get_only_supported_fields(input_data, ignored_fields_list)
+    else:
+        input_list = input_data
 
     if copy_files_path:
         if not isdir(copy_files_path):
@@ -837,8 +849,8 @@ def main(parser, options, args):
                 gen.copy_files(output_path, license_list)
 
     if extract_license:
-        if not api_url or not api_username or not api_key:
-            print("ERROR: Missing argument for --extract_license")
+        if not api_url or not api_key:
+            print("Missing argument for --extract_license")
             sys.exit(errno.EINVAL)
         for line in input_list:
             try:
@@ -850,11 +862,10 @@ def main(parser, options, args):
                 sys.exit(errno.EINVAL)
 
     if gen_license:
-        # Strip the ' and " for api_url, api_username and api_key from input
+        # Strip the ' and " for api_url, and api_key from input
         api_url = api_url.strip("'").strip("\"")
-        api_username = api_username.strip("'").strip("\"")
         api_key = api_key.strip("'").strip("\"")
-        dje_license_dict = gen.pre_process_and_dje_license_dict(input_list, api_url, api_username, api_key)
+        dje_license_dict = gen.pre_process_and_dje_license_dict(input_list, api_url, api_key)
 
     dje_license_list = gen.get_dje_license_list(output_path, input_list, gen_license, dje_license_dict)
     components_list = gen.pre_generation(output_path, input_list, action_num)
@@ -888,7 +899,7 @@ def get_parser():
     parser.add_option('--copy_files', type='string', help=COPY_FILES_HELP)
     parser.add_option('--license_text_location', type='string', help=LICENSE_TEXT_LOCATION_HELP)
     parser.add_option('--mapping', action='store_true', help=MAPPING_HELP)
-    parser.add_option('--extract_license', type='string', nargs=3, help=EXTRACT_LICENSE_HELP)
+    parser.add_option('--extract_license', type='string', nargs=2, help=EXTRACT_LICENSE_HELP)
     return parser
 
 

about_code_tool/genattrib.py

@@ -2,7 +2,7 @@
 # -*- coding: utf8 -*-
 
 # ============================================================================
-#  Copyright (c) 2013-2015 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2016 nexB Inc. http://www.nexb.com/ - All rights reserved.
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
 #  You may obtain a copy of the License at
@@ -200,15 +200,17 @@ def main(parser, options, args):
         input_path = extract_zip(input_path)
 
     if isdir(output_path):
-        print('ERROR: <output_path> must be an HTML file, not a directory')
+        print('ERROR: <output_path> cannot be a directory')
         parser.print_help()
         sys.exit(errno.EISDIR)
 
+    """
     # We only support HTML currently
     if not output_path.endswith('.html'):
         print('ERROR: <output_path> must be an HTML file.')
         parser.print_help()
         sys.exit(errno.EINVAL)
+    """
 
     if exists(output_path) and not overwrite:
         print('ERROR: A file at <output_path> already exists. Select a different file name or use the --overwrite option.')

about_code_tool/help.py

@@ -2,7 +2,7 @@
 # -*- coding: utf8 -*-
 
 # ============================================================================
-#  Copyright (c) 2013-2015 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2016 nexB Inc. http://www.nexb.com/ - All rights reserved.
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
 #  You may obtain a copy of the License at
@@ -19,10 +19,10 @@
 
 __about_spec_version__ = '1.0'
 
-__version__ = '2.2.0'
+__version__ = '2.2.1'
 
 __copyright__ = """
-Copyright (c) 2013-2015 nexB Inc. All rights reserved.
+Copyright (c) 2013-2016 nexB Inc. All rights reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

about_code_tool/licenses.py

@@ -2,7 +2,7 @@
 # -*- coding: utf8 -*-
 
 # ============================================================================
-#  Copyright (c) 2013-2015 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2016 nexB Inc. http://www.nexb.com/ - All rights reserved.
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
 #  You may obtain a copy of the License at