Commits

Antonio Alvarado Hernández committed 8d1cc73

* project creation

Comments (0)

Files changed (7)

+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Antonio Alvarado Hernández
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+
+# use glob syntax
+syntax: glob
+
+*.elc
+*.pyc
+*~
+
+.spyderproject
+
+# EOF
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Antonio Alvarado Hernández
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+"""
+TODO
+"""
+
+# EOF

wa/engines/__init__.py

+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Antonio Alvarado Hernández
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+"""
+TODO
+"""
+
+# EOF

wa/engines/coremetrics.py

+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Antonio Alvarado Hernández
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+"""
+TODO
+"""
+
+from __future__ import print_function
+
+import json
+
+
+class ParsingError(Exception):
+    """TODO"""
+
+
+class CmEngine(object):
+    """TODO"""
+
+    def __init__(self, config):
+        self._config = config
+
+class CmSource(object):
+    """TODO"""
+
+    def __init__(self, config):
+        pass
+
+class CmReader(object):
+    """TODO"""
+
+    def __init__(self, stream):
+        self._stream = stream
+
+    def __enter__(self):
+        print("Entering...")
+        if not isinstance(self._stream, file):
+            # TODO: Something usefull here!
+            raise Exception("Oops")
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        print("Exiting!!!")
+        if not self._stream.closed:
+            self._stream.close()
+        return
+
+class DataParser(object):
+    """TODO"""
+    def __init__(self):
+        pass
+
+    def parse(self, stream):
+        """TODO"""
+        try:
+            decoded = json.load(stream)
+            data = DataFeed(decoded)
+            feed = PanelFeed()
+
+            return data
+
+        except Exception as e:
+            raise ParsingError()
+
+class PanelHead(object):
+    """TODO"""
+
+class PanelBody(object):
+    """TODO"""
+
+class PanelFeed(object):
+    """TODO"""
+    def __init__(self):
+        self._head = PanelHead()
+        self._body = PanelBody()
+
+    @property
+    def head(self):
+        """Returns a reference to the internal body object."""
+        return self._head
+
+    @property
+    def body(self):
+        """Returns a reference to the internal body object."""
+        return self._body
+
+class PanelParser(object):
+    """TODO"""
+    def __init__(self):
+        pass
+
+    def parse(self, stream):
+        """Parses raw data retrieved from given stream object."""
+        return ParseFeed()
+
+class DataFeed(object):
+    """TODO"""
+
+    def __init__(self, decoded):
+        self._decoded = decoded
+        self._header = None
+        self._data = None
+
+    def __str__(self):
+        return str(self._decoded.keys())
+
+def parse_json_resource(resource):
+    """TODO"""
+    try:
+        with open(resource) as stream:
+            parser = DataParser()
+            feed = parser.parse(stream)
+            print(str(feed))
+
+    except Exception as e:
+        print("Oops: %s" % str(e))
+
+# EOF
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Antonio Alvarado Hernández
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+"""
+TODO
+"""
+
+from __future__ import print_function
+
+__all__ = ['main']
+
+
+from argparse import ArgumentParser, FileType
+
+import sys
+import json
+import os.path
+
+from wa.engines.coremetrics import CmEngine, CmSource
+
+
+E_NONE = 0
+E_BADARGS = 1
+E_BADCONFIG = 2
+
+
+class DuplicateItemError(ValueError):
+    """TODO"""
+
+
+class BasicShell(object):
+    """TODO"""
+
+    def __init__(self, program=r'washell'):
+        # sets up the program name
+        self._program = program
+
+        # bootstraps default config filename
+        home_path = os.path.expanduser(r'~')
+        config_name = r'.%src' % (self._program,)
+        config_file = os.path.normpath(os.path.join(home_path, config_name))
+
+        # initializes the argument parser
+        parser = ArgumentParser(prog=self._program,
+            description="A shell for web analysts 8-7")
+
+        parser.add_argument('-f', '--config-file', type=FileType('r+', 0),
+            dest='config_file', default=config_file,
+            help="use CONFIG_FILE as the configuration file name")
+
+        self._parser = parser
+
+    def run(self):
+        """Executes the program, then exits."""
+
+        self._args = self._parse_cmdline_arguments()
+        self._config = self._create_config_tree()
+        self._engines = self._create_engines_table()
+        self._sources = self._create_sources_table()
+        print("> engines:", self._engines)
+        print("> sources:", self._sources)
+
+    def _parse_cmdline_arguments(self):
+        """TODO"""
+
+        args = None
+        try:
+            args = self._parser.parse_args()
+        except ArgurmentError as e:
+            print("Oops: bad command line arguments", str(e))
+            sys.exit(E_BADARGS)
+
+        return args
+
+    def _create_config_tree(self):
+        """Creates and returns the global configuration tree."""
+
+        def _build_default_config():
+            return dict()
+
+        config = _build_default_config()
+        try:
+            tmpcfg = json.load(self._args.config_file)
+            config.update(tmpcfg)
+        except EnvironmentError as e:
+            print("Oops: configuration file not found", str(e))
+            sys.exit(E_BADCONFIG)
+        except StandardError as e:
+            print("Oops: invalid configuration file", str(e))
+            sys.exit(E_BADCONFIG)
+        except BaseException as e:
+            print("Oops: ????", str(e), e.__class__.__name__)
+            sys.exit(-1)
+
+        return config
+
+    def _create_engines_table(self):
+        """TODO"""
+        engines = dict()
+        for engine in self._config['engines']:
+            if engine['name'] in engines:
+                raise DuplicateItemError(engine['name'])
+            # TODO: to find right engine factory method!
+            engines[engine['name']] = CmEngine(engine['parameters'])
+        return engines
+
+    def _create_sources_table(self):
+        """TODO"""
+        sources = dict()
+        for source in self._config['sources']:
+            if source['name'] in sources:
+                raise DuplicateItemError(source['name'])
+            sources[source['name']] = CmSource(source['parameters'])
+        return sources
+
+
+def main():
+    """This is the shell's entry-point."""
+
+    sh = BasicShell()
+    sh.run()
+
+# EOF
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Antonio Alvarado Hernández
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+
+from wa import shell
+
+shell.main()
+
+# EOF