Merge branch 'release/0.2.0'

Author: mjohnson9

.pyup.yaml

@@ -0,0 +1,37 @@
+# configure updates globally, default is all
+update: all # allowed [all, insecure, False]
+
+# configure dependency pinning globally, default is True
+pin: True # allowed [True, False]
+
+# set the default branch, default is the default branch on GitHub
+branch: develop
+
+# update schedule, default is not set
+# the bot will visit the repo once and bundle all updates in a single PR for the given
+# day/week/month
+schedule: "every day" # allowed ["every day", "every week", "every two weeks", "every month"]
+
+# configure requirement files search, default is True
+# the bot will search for files ending with .txt/.pip with a requirements in their file paths
+search: False # allowed [True, False]
+
+# adding requirements files manually, default is empty
+requirements:
+  - requirements.txt:
+  - requirements_dev.txt:
+
+# add a label to pull requests, default is not set
+# requires private repo permissions, even on public repos
+label_prs: requirement-update
+
+# assign users to pull requests, default is not set
+# requires private repo permissions, even on public repos
+assignees:
+ - nightexcessive
+
+# configure the branch prefix the bot is using, default is pyup-
+branch_prefix: pyup/
+
+# allow to close stale PRs, default is True
+close_prs: True

.travis.yml

@@ -1,19 +1,20 @@
 deploy:
-  true:
-    python: 2.7
-    repo: nightexcessive/modemscraper
-    tags: true
-  distributions: sdist bdist_wheel
-  password:
-    secure: FOums9R8tT7ASMIz1PLfiHFWYsPqOxJ0mm4DQaD6tfIJheW3isIWxVg0s1SC+r9iGGGMvhYVkY+OPA+i+YxsQIixdetnCZ1XtUS28XZhJYTBY1HIl5KpV2j8qDfI3CHOsv4wgbMDav/3F/cZEDf6Vn6hzKmfAeBMAddDk+bBmAfCr/unybfN+JAjDEd4ixEe5LM8ppUSr62XemFGNSnOw1QHlKa2Tq8udCQf+zmgdyys8Po0QT4wb/OB5oevddF6jwuqPw8i22RQyHDU+Q8ApsjU14m9KFMAPiwBx8+Uh9dkpVk+sGYJ6epFmLQcBkAwgee5T0sn0GHVQX5BwHI8jk0TPzEBANHHGIoHdU87OZ0rwJuj/fA86t7OPFgwp1iQ0ElxRHYvAI67e15IEZujDLZgV5BOFmXASMQck5t8K4CXCTEui9puUL3Pv7U53avdlXMPkrXlJN2sENfWXUzXjhLhnEagrOuUTiZGdwYc35C4Knh4iQbvRdN85FtqZVWvnEkSC94S4G5HWcds18djpm8JtKcSketgaBalrmOOjurcbA9JUGzZhCsU4RiOsKD6hDkQ/r4eDM/p59yXavWBKKXncqLeueyGmzdWMwb+J8P9zuDZDSGkPnwiJ/T/lW3xWwtqaKw2u3COmzgtIWJJZAsrfFjyw2e9LIwpZWrFdp4=
   provider: pypi
   user: nightexcessive
-install: pip install -U tox-travis
+  password:
+    secure: FOums9R8tT7ASMIz1PLfiHFWYsPqOxJ0mm4DQaD6tfIJheW3isIWxVg0s1SC+r9iGGGMvhYVkY+OPA+i+YxsQIixdetnCZ1XtUS28XZhJYTBY1HIl5KpV2j8qDfI3CHOsv4wgbMDav/3F/cZEDf6Vn6hzKmfAeBMAddDk+bBmAfCr/unybfN+JAjDEd4ixEe5LM8ppUSr62XemFGNSnOw1QHlKa2Tq8udCQf+zmgdyys8Po0QT4wb/OB5oevddF6jwuqPw8i22RQyHDU+Q8ApsjU14m9KFMAPiwBx8+Uh9dkpVk+sGYJ6epFmLQcBkAwgee5T0sn0GHVQX5BwHI8jk0TPzEBANHHGIoHdU87OZ0rwJuj/fA86t7OPFgwp1iQ0ElxRHYvAI67e15IEZujDLZgV5BOFmXASMQck5t8K4CXCTEui9puUL3Pv7U53avdlXMPkrXlJN2sENfWXUzXjhLhnEagrOuUTiZGdwYc35C4Knh4iQbvRdN85FtqZVWvnEkSC94S4G5HWcds18djpm8JtKcSketgaBalrmOOjurcbA9JUGzZhCsU4RiOsKD6hDkQ/r4eDM/p59yXavWBKKXncqLeueyGmzdWMwb+J8P9zuDZDSGkPnwiJ/T/lW3xWwtqaKw2u3COmzgtIWJJZAsrfFjyw2e9LIwpZWrFdp4=
+  distributions: sdist bdist_wheel
+  on:
+    tags: true
+
+install: pip install -U tox-travis coveralls
 language: python
 python:
+- 3.6
 - 3.5
 - 3.4
 - 3.3
 - 2.7
-- 2.6
 script: tox
+after_success:
+    - coveralls

HISTORY.rst

@@ -2,6 +2,12 @@
 History
 =======
 
+0.2.0 (2017-06-30)
+------------------
+
+* Added parser module supported by Pint
+* Added CI support + coverage information with Coveralls
+
 0.1.0 (2017-06-29)
 ------------------
 

README.rst

@@ -9,6 +9,10 @@ Modem Scraper
 .. image:: https://img.shields.io/travis/nightexcessive/modemscraper.svg
         :target: https://travis-ci.org/nightexcessive/modemscraper
 
+.. image:: https://coveralls.io/repos/github/nightexcessive/modemscraper/badge.svg?branch=develop
+        :target: https://coveralls.io/github/nightexcessive/modemscraper?branch=develop
+
+
 .. image:: https://readthedocs.org/projects/modemscraper/badge/?version=latest
         :target: https://modemscraper.readthedocs.io/en/latest/?badge=latest
         :alt: Documentation Status

modemscraper/__init__.py

@@ -4,4 +4,4 @@
 
 __author__ = """Michael Johnson"""
 __email__ = 'michael@johnson.computer'
-__version__ = '0.1.0'
+__version__ = '0.2.0'

modemscraper/parser.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+
+"""
+The parser module parses raw units from the modem's pages and converts them
+into machine-usable values.
+"""
+import pint
+
+
+_unit_registry = None  # scope the default unit registry
+
+
+def parse(to_parse):
+    """
+    parse parses unit values from Surfboard pages into a tuple.
+
+    Currently, parse supports:
+
+    * plain integers
+    * frequencies expressed in Hz
+    * power levels expressed in dB
+    * power levels expressed in dBmV
+    * symbol rates expressed in Sym/sec
+
+    Args:
+        to_parse (TYPE): Description
+
+    Returns:
+        tuple: A tuple containing ()
+
+    Raises:
+        TypeError: if the value given is not a string.
+        ValueError: if the value given is not known to the parser.
+    """
+
+    if not isinstance(to_parse, str):
+        raise TypeError("input must be a string")
+
+    parsed = None
+
+    try:
+        parsed = _unit_registry(to_parse)
+    except pint.errors.UndefinedUnitError as err:
+        raise ValueError(err)
+
+    if isinstance(parsed, int):
+        return (parsed, 'integer')
+
+    if format(parsed.units) != "hertz":
+        # we check that the unit isn't hertz because our spec calls for hertz
+        # being returned as such
+        parsed.ito_base_units()  # convert to base units in place
+
+    return (parsed.magnitude, '%s' % parsed.units)
+
+
+def _get_unit_registry():
+    # create an empty registry
+    _unit_registry = pint.UnitRegistry(filename=None)
+
+    # units from Pint's own defaults
+    _unit_registry.define("second = [time] = s = sec")
+    _unit_registry.define("[frequency] = 1 / [time]")
+    _unit_registry.define("hertz = 1 / second = Hz")
+
+    # our own units
+    _unit_registry.define("symbol = [] = sym")
+    _unit_registry.define("decibel = [] = dB")
+    _unit_registry.define("dBmV = []")
+
+    # our prefixes
+    _unit_registry.define("mega- = 1000000 = M-")
+
+    return _unit_registry
+
+
+_unit_registry = _get_unit_registry()  # setup our default unit registry

requirements.txt

@@ -0,0 +1,3 @@
+beautifulsoup4==4.6.0
+Pint==0.8.1
+requests==2.18.1

requirements_dev.txt

@@ -1,12 +1,14 @@
-pip==8.1.2
+pip==9.0.1
 bumpversion==0.5.3
 wheel==0.29.0
 watchdog==0.8.3
-flake8==2.6.0
-tox==2.3.1
-coverage==4.1
-Sphinx==1.4.8
-cryptography==1.7
-PyYAML==3.11
-pytest==2.9.2
+flake8==3.3.0
+tox==2.7.0
+coverage==4.4.1
+Sphinx==1.6.2
+cryptography==1.9
+PyYAML==3.12
+pytest==3.1.2
 pytest-runner==2.11.1
+pytest-cov==2.5.1
+httmock==1.2.6

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.0
+current_version = 0.2.0
 commit = True
 tag = True
 
@@ -19,4 +19,4 @@ exclude = docs
 
 [aliases]
 test = pytest
-# Define setup.py command aliases here
+

setup.py

@@ -12,7 +12,9 @@
     history = history_file.read()
 
 requirements = [
-    # TODO: put package requirements here
+    'beautifulsoup4',
+    'Pint',
+    'requests'
 ]
 
 setup_requirements = [
@@ -23,12 +25,13 @@
 
 test_requirements = [
     'pytest',
-    # TODO: put package test requirements here
+    'pytest-cov',
+    'httmock'
 ]
 
 setup(
     name='modemscraper',
-    version='0.1.0',
+    version='0.2.0',
     description="Modem scraper retrieves important information from Surfboard-like modem status pages.",
     long_description=readme + '\n\n' + history,
     author="Michael Johnson",

tests/__init__.py

@@ -1,3 +1,22 @@
 # -*- coding: utf-8 -*-
 
 """Unit test package for modemscraper."""
+
+import httmock
+import os.path
+
+
+# Mock all of the modem's pages that we use
+@httmock.urlmatch(netloc='192.168.100.1', path='/indexData.html')
+def index_page(url, request):
+    return open(os.path.join(os.path.dirname(__file__), 'example_pages/indexData.html')).read()
+
+
+@httmock.urlmatch(netloc='192.168.100.1', path='/cmLogsData.html')
+def logs_page(url, request):
+    return open(os.path.join(os.path.dirname(__file__), 'example_pages/cmLogsData.html')).read()
+
+
+@httmock.urlmatch(netloc='192.168.100.1', path='/cmSignalData.html')
+def signals_page(url, request):
+    return open(os.path.join(os.path.dirname(__file__), 'example_pages/cmSignalData.html')).read()