Merge pull request #1 from PokaInc/feat-initial-impl

Initial impl

Author: spg

.gitignore

@@ -0,0 +1,32 @@
+MANIFEST
+.idea
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# tests artifacts
+.cache
+.pytest_cache

.travis.yml

@@ -0,0 +1,20 @@
+language: python
+python:
+  - "2.6"
+  - "2.7"
+  - "3.3"
+  - "3.4"
+  - "3.5"
+  - "3.5-dev" # 3.5 development branch
+  - "3.6"
+  - "3.6-dev" # 3.6 development branch
+  - "3.7-dev" # 3.7 development branch
+  - "nightly" # currently points to 3.7-dev
+before_install:
+  - pip install --upgrade pytest
+# command to install dependencies
+install:
+  - "pip install e ."
+  - "pip install -r requirements_test.txt"
+# command to run tests
+script: py.test

LICENSE.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Poka Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1,17 @@
+.PHONY: build publish-test
+
+clean:
+	-@rm -dr build dist
+
+check-tools-versions:
+	python check_tools_version.py
+
+build: check-tools-versions
+	@python setup.py sdist
+	@python setup.py bdist_wheel
+
+publish-test: clean build
+	@twine upload --repository testpypi dist/*
+
+publish: clean build
+	@twine upload --repository pypi dist/*

README.md

@@ -0,0 +1,99 @@
+arnparse
+========
+
+Parse ARNs using Python
+
+[![Build Status](https://travis-ci.org/PokaInc/arnparse.svg?branch=master)](https://travis-ci.org/PokaInc/arnparse)
+
+Motivation
+----------
+
+Sometimes, you want to parse an Amazon Resource Name (ARN) into its
+components to get some useful information from the ARN (e.g. AWS region,
+account ID, etc).
+
+You can find documentation on ARNs and their components here:
+https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+
+Installation
+------------
+
+`pip install arnparse`
+
+Examples
+--------
+
+### S3 Object
+
+```python
+from arnparse import arnparse
+
+arn = arnparse('arn:aws:s3:::my_corporate_bucket/exampleobject.png')
+
+assert arn.partition == 'aws'
+assert arn.service == 's3'
+assert arn.region is None
+assert arn.account_id is None
+assert arn.resource_type is None
+assert arn.resource == 'my_corporate_bucket/exampleobject.png'
+```
+
+### VPC
+
+```python
+from arnparse import arnparse
+
+arn = arnparse('arn:aws:ec2:us-east-1:123456789012:vpc/vpc-fd580e98')
+
+assert arn.partition == 'aws'
+assert arn.service == 'ec2'
+assert arn.region == 'us-east-1'
+assert arn.account_id == '123456789012'
+assert arn.resource_type == 'vpc'
+assert arn.resource == 'vpc-fd580e98'
+```
+
+### CloudWatch Alarm
+
+```python
+from arnparse import arnparse
+
+arn = arnparse('arn:aws:cloudwatch:us-east-1:123456789012:alarm:MyAlarmName')
+
+assert arn.partition == 'aws'
+assert arn.service == 'cloudwatch'
+assert arn.region == 'us-east-1'
+assert arn.account_id == '123456789012'
+assert arn.resource_type == 'alarm'
+assert arn.resource == 'MyAlarmName'
+```
+
+### SNS Topic
+
+```python
+from arnparse import arnparse
+
+arn = arnparse('arn:aws:sns:*:123456789012:my_corporate_topic')
+
+assert arn.partition == 'aws'
+assert arn.service == 'sns'
+assert arn.region == '*'
+assert arn.account_id == '123456789012'
+assert arn.resource_type is None
+assert arn.resource == 'my_corporate_topic'
+```
+
+### API Gateway
+
+```python
+from arnparse import arnparse
+
+arn = arnparse('arn:aws:apigateway:us-east-1::a123456789012bc3de45678901f23a45:/test/mydemoresource/*')
+
+assert arn.partition == 'aws'
+assert arn.service == 'apigateway'
+assert arn.region == 'us-east-1'
+assert arn.account_id is None
+assert arn.resource_type is None
+assert arn.resource == 'a123456789012bc3de45678901f23a45:/test/mydemoresource/*'
+```

arnparse/__init__.py

@@ -0,0 +1 @@
+from .arnparse import arnparse

arnparse/arnparse.py

@@ -0,0 +1,47 @@
+from __future__ import absolute_import
+
+from arnparse.str_utils import empty_str_to_none
+
+
+class MalformedArnError(Exception):
+    def __init__(self, arn_str):
+        self.arn_str = arn_str
+
+    def __str__(self):
+        return 'arn_str: {arn_str}'.format(arn_str=self.arn_str)
+
+
+class Arn(object):
+    def __init__(self, partition, service, region, account_id, resource_type, resource):
+        self.partition = partition
+        self.service = service
+        self.region = region
+        self.account_id = account_id
+        self.resource_type = resource_type
+        self.resource = resource
+
+
+def arnparse(arn_str):
+    if not arn_str.startswith('arn:'):
+        raise MalformedArnError(arn_str)
+
+    elements = arn_str.split(':', 5)
+
+    resource = elements[5]
+    resource_type = None
+
+    service = elements[2]
+    if service not in ['s3', 'sns', 'apigateway', 'execute-api']:
+        if '/' in resource:
+            resource_type, resource = resource.split('/', 1)
+        elif ':' in resource:
+            resource_type, resource = resource.split(':', 1)
+
+    return Arn(
+        partition=elements[1],
+        service=service,
+        region=empty_str_to_none(elements[3]),
+        account_id=empty_str_to_none(elements[4]),
+        resource_type=resource_type,
+        resource=resource,
+    )

arnparse/str_utils.py

@@ -0,0 +1,5 @@
+def empty_str_to_none(str_):
+    if str_ == '':
+        return None
+
+    return str_

check_tools_version.py

@@ -0,0 +1,16 @@
+from distutils.version import StrictVersion
+
+import setuptools
+import twine
+import wheel
+
+if __name__ == '__main__':
+    """
+    Ensure that all tools are correctly installed. See https://stackoverflow.com/a/26737258
+    """
+    assert StrictVersion(setuptools.__version__) >= StrictVersion('38.6.0'), 'Please upgrade setuptools. ' \
+                                                                             'See https://stackoverflow.com/a/26737258'
+    assert StrictVersion(twine.__version__) >= StrictVersion('1.11.0'), 'Please upgrade twine. ' \
+                                                                        'See https://stackoverflow.com/a/26737258'
+    assert StrictVersion(wheel.__version__) >= StrictVersion('0.31.0'), 'Please upgrade wheel. ' \
+                                                                        'See https://stackoverflow.com/a/26737258'

requirements_test.txt

@@ -0,0 +1,2 @@
+pytest
+pytest-mock