diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..2d210e5 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,10 @@ +[run] +omit = + */tests* + +[report] +exclude_lines = + pragma: no cover + raise NotImplementedError + if __name__ == .__main__.: + diff --git a/.coveralls.yml b/.coveralls.yml new file mode 100644 index 0000000..621116b --- /dev/null +++ b/.coveralls.yml @@ -0,0 +1 @@ +repo_token: g8aTr3DozufDVSviVP2GzDBoBKnzUchzw diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..220fb5a --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +*.egg-info +.cache/ +.coverage +build/ +dist/ +htmlcov/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..242dc7c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,21 @@ +branches: + only: + - master + +language: python +python: + - "2.7" + - "3.4" +# TBD after fix https://bitbucket.org/pytest-dev/pytest/pull-request/296/astcall-signature-changed-on-35/diff +# - "nightly" + +install: + - pip install -U -r test_requirements.txt + +before_script: + - pip install -U -e . +script: + - py.test tests --doctest-modules --pep8 freshmail -v --cov freshmail --cov-report term-missing +after_success: + - coveralls + diff --git a/LICENSE b/LICENSE index 3d6e869..4ddbc80 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,7 @@ The MIT License (MIT) Copyright (c) 2013 Dariusz Stępniak +Copyleft (-) 2015 soutys 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 diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..d32fbd5 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,8 @@ +global-exclude *.py[cod] +graft tests +include *.py +include *.txt +include README.* +include setup.py +include VERSION +prune tests/__pycache__ diff --git a/README.md b/README.md deleted file mode 100644 index 1788f7d..0000000 --- a/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# FreshMail-Python - -A Python class for FreshMail REST API. - -## Installation - -Copy freshmail.py into your app directory and import class: - - from freshmail.py import Frashmail - -Initialize FM object with: - - fm = FreshMail('API_KEY','API_SECRET') - -## Examples - -All samples included in samples directory. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b0d47b9 --- /dev/null +++ b/README.rst @@ -0,0 +1,10 @@ +FreshMail for Python +==================== + +.. image:: https://api.travis-ci.org/soutys/freshmail-python.png?branch=master + :target: http://travis-ci.org/soutys/freshmail-python +.. image:: https://coveralls.io/repos/soutys/freshmail-python/badge.png?branch=master + :target: https://coveralls.io/r/soutys/freshmail-python + +A Python module for FreshMail REST API. + diff --git a/VERSION b/VERSION new file mode 120000 index 0000000..8bc7fde --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +freshmail/VERSION \ No newline at end of file diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..c0bf3c3 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,192 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FreshMailAPI.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FreshMailAPI.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/FreshMailAPI" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FreshMailAPI" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..8fc5c2c --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,291 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# FreshMail API documentation build configuration file, created by +# sphinx-quickstart on Sun Sep 13 17:01:53 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = [] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'FreshMail API' +copyright = '2015, soutys' +author = 'soutys' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.2' +# The full version, including alpha/beta/rc tags. +release = '1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = [] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'FreshMailAPIdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'FreshMailAPI.tex', 'FreshMail API Documentation', + 'soutys', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'freshmailapi', 'FreshMail API Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'FreshMailAPI', 'FreshMail API Documentation', + author, 'FreshMailAPI', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/doc/source/freshmail_module.rst b/doc/source/freshmail_module.rst new file mode 100644 index 0000000..289cb05 --- /dev/null +++ b/doc/source/freshmail_module.rst @@ -0,0 +1,8 @@ +FreshMail module +================ + +.. automodule:: freshmail.freshmail + :members: + :undoc-members: + :inherited-members: + diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..fc453e9 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,15 @@ +.. FreshMail API documentation master file, created by + sphinx-quickstart on Sun Sep 13 17:01:53 2015. + +Welcome to FreshMail API's documentation! +========================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + installation + usage + freshmail_module + diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 0000000..6b3b951 --- /dev/null +++ b/doc/source/installation.rst @@ -0,0 +1,13 @@ +Installation +============ + +.. code:: bash + + pip install freshmail + +or: + +.. code:: bash + + python ./setup.py install + diff --git a/doc/source/usage.rst b/doc/source/usage.rst new file mode 100644 index 0000000..644e18a --- /dev/null +++ b/doc/source/usage.rst @@ -0,0 +1,9 @@ +Usage +===== + +.. code :: python + + from freshmail.freshmail import FreshMail + fm_obj = FreshMail('your_API_key', 'your_API_secret') + fm_obj.ping() + diff --git a/freshmail.py b/freshmail.py deleted file mode 100644 index b49b858..0000000 --- a/freshmail.py +++ /dev/null @@ -1,205 +0,0 @@ -import requests -import json -import hashlib - -""" -subscriber status codes for use with API: (undocumented in API) -1 active -2 activation pending -3 not activated -4 resigned -5 soft bouncing -8 hard bouncing -""" - -class FreshMail(object): - """ - Custom class for Freshmail REST API - author: Dariusz Stepniak - - requires Requests module: - http://www.python-requests.org/en/latest/ - """ - - response = '' - rawResponse = '' - httpCode = '' - contentType = 'application/json' - - host = 'https://api.freshmail.com/' - prefix = 'rest/' - - - def __init__(self, api_key, api_secret): - """ - Create class instance, requires api_key and api_secret - :param api_key: - :param api_secret: - :return: FreshMail Instance - """ - self.api_key = api_key - self.api_secret = api_secret - - def setContentType(self, contentType): - self.contentType = contentType - - def setHost(self, host): - self.host = host - - def setPrefix(self, prefix): - self.prefix = prefix - - def getResponse(self): - return self.response - - def getHttpCode(self): - return self.httpCode - - def request(self, url, payload=None, raw_response=False, method='POST'): - """ - Makes request to REST API. Add payload data for POST request. - :param url: API endpoint - :param payload: POST data dict - """ - if payload is None: - post_data = '' - else: - post_data = json.dumps(payload) - - full_url = '%s%s%s' % (self.host, self.prefix, url,) - - strSign = "%s/%s%s%s%s" % (self.api_key, - self.prefix, - url, - post_data, - self.api_secret,) - m = hashlib.sha1() - m.update(strSign) - headers = { - 'content-type': self.contentType, - 'X-Rest-ApiKey': self.api_key, - 'X-Rest-ApiSign': m.hexdigest() - } - if method is 'POST': - r = requests.post(full_url, data=post_data, headers=headers) - elif method is 'GET': - r = requests.get(full_url, data=post_data, headers=headers) - else: - raise FreshMailException({'message':'GET or POST required methods. Got {}'.format(method)}) - - self.httpCode = r.status_code - - if self.httpCode != 200 and r.json()['status'] == 'ERROR': - # get errors - self.errors = r.json()['errors'] - for error in r.json()['errors']: - raise FreshMailException({'message':error['message'],'code':error['code']}) - - self.response = r.json() - self.rawResponse = r.content - - if raw_response: - return self.rawResponse - else: - return self.response - - def addSubscriber(self, email, list_hash, state=3, confirm=1, custom_fields=None): - #self, url, payload=None, raw_response=False - payload = { - 'email' : email, - 'list' : list_hash, - 'state' : state, - 'confirm' : confirm - } - - if custom_fields is not None and isinstance(custom_fields, dict): - # custom fields need to be a dict - payload['custom_fields'] = custom_fields - else: - raise FreshMailException({'message':'Custom fields must be a dict. Got {}'.format(custom_fields)}) - - url = 'subscriber/add' - response = self.request(url, payload) - print response - return - - def deleteSubscriber(self, email, list_hash): - #self, url, payload=None, raw_response=False - payload = { - 'email' : email, - 'list' : list_hash - } - url = 'subscriber/delete' - response = self.request(url, payload) - print response - return - - def getLists(self): - #self, url, payload=None, raw_response=False - url = 'subscribers_list/lists' - response = self.request(url) - if response.get('status') and response.get('status') == 'OK': - return response.get('lists') - else: - return None - - def getSubscriber(self, email, list_hash): - #self, url, payload=None, raw_response=False - url = 'subscriber/get/{}/{}'.format(list_hash, email) - response = self.request(url,method='GET') - return response - - def findSubscriber(self, email): - #slow with large number of lists - lists = self.getLists() - if len(lists) > 0: - subscribed_lists = [] - for list in lists: - list_hash = list['subscriberListHash'] - try: - result = self.getSubscriber(email, list_hash) - subscribed_list = { 'list_hash' : list_hash, 'name': list['name'], 'subscriber':result} - subscribed_lists.append(subscribed_list) - except: - #ignore not found errors - pass - - return subscribed_lists - - else: - raise FreshMailException({'message':'No lists found'}) - - def findSubscriberInLists(self, email, lists): - #slow with large number of lists - if len(lists) > 0: - subscribed_lists = [] - for list in lists: - list_hash = list['subscriberListHash'] - try: - result = self.getSubscriber(email, list_hash) - subscribed_list = { 'list_hash' : list_hash, 'name': list['name'], 'subscriber':result} - subscribed_lists.append(subscribed_list) - except: - #ignore not found errors - pass - - return subscribed_lists - - else: - raise FreshMailException({'message':'No lists found'}) - - def addCustomFieldtoList(self, list, field_name, tag=None, type=0): - url = 'subscribers_list/addField' - payload = { - 'hash': list, - 'name' : field_name, - 'type' : type - } - if tag is not None: - payload['tag'] = tag - - response = self.request(url,payload,method='POST') - return response - -class FreshMailException(Exception): - pass \ No newline at end of file diff --git a/freshmail/VERSION b/freshmail/VERSION new file mode 100644 index 0000000..ee1372d --- /dev/null +++ b/freshmail/VERSION @@ -0,0 +1 @@ +0.2.2 diff --git a/freshmail/__init__.py b/freshmail/__init__.py new file mode 100644 index 0000000..e031bba --- /dev/null +++ b/freshmail/__init__.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- + +'''Package info module +''' + +from __future__ import ( + absolute_import, + division, + print_function, + unicode_literals, + with_statement, +) + +import os + + +WORK_DIR = os.path.dirname(os.path.abspath(__file__)) + +__author__ = 'soutys ' +__version__ = open(os.path.join(WORK_DIR, 'VERSION'), 'r').read().strip() +__classifiers__ = [ + # 'Development Status :: 1 - Planning', + # 'Development Status :: 2 - Pre-Alpha', + 'Development Status :: 3 - Alpha', + # 'Development Status :: 4 - Beta', + # 'Development Status :: 5 - Production/Stable', + # 'Development Status :: 6 - Mature', + # 'Development Status :: 7 - Inactive', + 'Environment :: Other Environment', + 'Intended Audience :: Developers', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: MIT License', + 'Operating System :: OS Independent', + 'Programming Language :: Python', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3.4', + 'Topic :: Communications', + 'Topic :: Communications :: Email', + 'Topic :: Utilities', +] + + +# vim: ts=4:sw=4:et:fdm=indent:ff=unix diff --git a/freshmail/freshmail.py b/freshmail/freshmail.py new file mode 100644 index 0000000..a63b9c0 --- /dev/null +++ b/freshmail/freshmail.py @@ -0,0 +1,345 @@ +# -*- coding: utf-8 -*- + +'''FreshMail (freshmail.pl) API module +''' + +from __future__ import ( + absolute_import, + division, + print_function, + unicode_literals, + with_statement, +) + +from copy import deepcopy +from functools import partial +from hashlib import sha1 + +import requests +try: + import simplejson as json +except ImportError: + import json + + +HOST = 'https://api.freshmail.com' +PREFIX = '/rest/' + +SUB_STATUS_ACTIVE = 1 +SUB_STATUS_NOT_ACTIVATED = 3 +SUB_STATUS_RESIGNED = 4 +SUB_STATUS = { + SUB_STATUS_ACTIVE: 'active', + 2: 'activation pending', + SUB_STATUS_NOT_ACTIVATED: 'not activated', + SUB_STATUS_RESIGNED: 'resigned', + 5: 'soft bouncing', + 8: 'hard bouncing', +} + +FIELD_TYPE_STR = 0 +FIELD_TYPE_NUM = 1 + + +class FreshMail(object): + '''Freshmail REST API class + Sends JSON requests to the FreshMail's API end-points + ''' + + def __init__(self, api_key, api_secret, proxies=None, timeout=3.0): + '''Initiates communication object + ''' + #: API's key (32 chars) + self.api_key = api_key + #: API's secret (40 chars) + self.api_secret = api_secret + #: last call API's raw response string (HTTP response body) + self.raw_response = '' + #: last call API's response (parsed JSON) + self.response = '' + #: last call errors table + self.errors = None + #: last call HTTP code + self.http_code = 200 + #: request session object + self.request_sess = requests.Session() + # HTTP/HTTPS/... proxies + self.proxies = proxies + # request(s) timeout + self.timeout = timeout + + + def get_raw_response(self): + '''Returns raw response data (string) from last call + ''' + return self.raw_response + + + def get_response(self): + '''Returns parsed response data (JSON) from last call + ''' + return self.response + + + def get_errors(self): + '''Returns all errors from last call + ''' + return self.errors + + + def get_http_code(self): + '''Returns HTTP code from last call + ''' + return self.http_code + + + def request( + self, url, payload=None, raw_response=False, method='POST'): + '''Makes request to REST API. Adds payload data for POST request. + :param url: API's controller[/action[/param1[/param2...]]] + :param payload: POST data dict + ''' + if payload is None: + _data = '' + else: + _data = json.dumps(payload) + + access_path = PREFIX + url + full_url = HOST + access_path + sign_str = self.api_key + access_path + _data + self.api_secret + api_sign = sha1(sign_str.encode('utf-8')).hexdigest() + headers = { + 'Content-Type': 'application/json', + 'X-Rest-ApiKey': self.api_key, + 'X-Rest-ApiSign': api_sign, + } + if method == 'POST': + fn_obj = partial(self.request_sess.post) + elif method == 'GET': + fn_obj = partial(self.request_sess.get) + else: + raise FreshMailException({ + 'message': 'GET or POST required methods. Got {}'.format( + method)}) + + try: + res = fn_obj( + full_url, data=_data, headers=headers, timeout=self.timeout, + proxies=self.proxies) + except requests.exceptions.RequestException as exc: + raise FreshMailException({ + 'message': repr(exc), + 'url': full_url, + 'code': -1}) + + self.http_code = res.status_code + self.raw_response = res.content + if not self.raw_response: + raise FreshMailException({ + 'message': 'no_content', + 'http_code': self.http_code, + 'code': -1}) + + try: + self.response = dict(res.json()) + except ValueError: + raise FreshMailException({ + 'message': repr(self.raw_response), + 'http_code': self.http_code, + 'code': -1}) + + self.errors = self.response.get('errors') + if self.http_code != 200 and self.response.get('status') == 'ERROR': + for error in self.errors: + raise FreshMailException({ + 'message': error['message'], + 'code': error['code'], + }) + + if raw_response: + return self.raw_response + + return self.response + + + def ping(self, payload=None, method='GET'): + '''Pings service, returns ``"pong"`` for ``method="GET"`` or sends back + payload for ``method="POST"`` + ''' + url = 'ping' + return self.request(url, payload=payload, method=method) + + + def subscriber_add(self, list_hash, subscriber_params, custom_fields=None): + '''Adds a subscriber to the list + ''' + payload = { + 'email': subscriber_params['email'], + 'list': list_hash, + 'state': subscriber_params.get('state', SUB_STATUS_NOT_ACTIVATED), + 'confirm': 1 if subscriber_params.get('confirm') else 0, + } + + if custom_fields is not None: + # custom_fields needs to be a dict + if not isinstance(custom_fields, dict): + raise FreshMailException({ + 'message': 'Custom fields must be a dict. Got {}'.format( + custom_fields)}) + payload['custom_fields'] = custom_fields + + url = 'subscriber/add' + return self.request(url, payload) + + + def subscriber_edit(self, list_hash, subscriber_params, custom_fields=None): + '''Edits a subscriber + ''' + payload = { + 'email': subscriber_params['email'], + 'list': list_hash, + 'state': subscriber_params.get('state', SUB_STATUS_NOT_ACTIVATED), + } + + if custom_fields is not None: + # custom_fields needs to be a dict + if not isinstance(custom_fields, dict): + raise FreshMailException({ + 'message': 'Custom fields must be a dict. Got {}'.format( + custom_fields)}) + payload['custom_fields'] = custom_fields + + url = 'subscriber/edit' + return self.request(url, payload) + + + def subscribers_add(self, list_hash, subscribers_lst, state, confirm): + '''Adds multiple subscribers to the list + ''' + payload = { + 'list': list_hash, + 'subscribers': subscribers_lst, + 'state': state, + 'confirm': confirm, + } + + url = 'subscriber/addMultiple' + return self.request(url, payload) + + + def subscriber_get(self, email, list_hash): + '''Gets a subscriber from the list + ''' + url = 'subscriber/get/' + '/'.join([list_hash, email]) + return self.request(url, method='GET') + + + def subscriber_delete(self, email, list_hash): + '''Removes a subscriber from the list + ''' + payload = { + 'email': email, + 'list': list_hash, + } + + url = 'subscriber/delete' + return self.request(url, payload) + + + def subscribers_list_fields(self, list_hash): + '''Gets subscription list fields + ''' + url = 'subscribers_list/getFields' + return self.request(url, {'hash': list_hash}) + + + def subscribers_lists(self): + '''Gets subscription lists + ''' + url = 'subscribers_list/lists' + response = dict(self.request(url, raw_response=False)) + if response.get('status') == 'OK': + return response.get('lists') + return None + + + def subscriber_find_in_lists(self, email, lists): + '''Finds subscriber at given lists + NOTE: slow with large number of lists + ''' + if not lists: + raise FreshMailException({'message': 'No lists found'}) + subscribed_lists = [] + for one_list in lists: + list_hash = one_list['subscriberListHash'] + try: + result = self.subscriber_get(email, list_hash) + subscribed_list = { + 'list_hash': list_hash, + 'name': one_list['name'], + 'subscriber': result, + } + subscribed_lists.append(subscribed_list) + except (FreshMailException, requests.exceptions.RequestException): + pass + + return subscribed_lists + + + def subscriber_find(self, email): + '''Finds subscriber at available lists + NOTE: slow with large number of lists + ''' + lists = self.subscribers_lists() + return self.subscriber_find_in_lists(email, lists) + + + def subscribers_list_add_field(self, list_hash, field_name, tag=None, + field_type=FIELD_TYPE_STR): + '''Adds a custom field (text or numeric) to the list + ''' + payload = { + 'hash': list_hash, + 'name': field_name, + 'type': field_type, + } + if tag is not None: + payload['tag'] = tag + + url = 'subscribers_list/addField' + return self.request(url, payload, method='POST') + + + def transactional_mail(self, email, subject, extra_dc=None): + '''Sends transactional email + ''' + payload = { + 'subscriber': email, + 'subject': subject, + } + payload.update(extra_dc or {}) + + url = 'mail' + return self.request(url, payload) + + + def mail_text(self, email, subject, text, extra_dc=None): + '''Sends transactional plain text email + ''' + extra_dc = deepcopy(extra_dc or {}) + extra_dc['text'] = text + return self.transactional_mail(email, subject, extra_dc) + + + def mail_html(self, email, subject, html, extra_dc=None): + '''Sends transactional HTML email + ''' + extra_dc = deepcopy(extra_dc or {}) + extra_dc['html'] = html + return self.transactional_mail(email, subject, extra_dc) + + +class FreshMailException(Exception): + '''Generic exception class for FreshMail REST API's operations + ''' + pass diff --git a/freshmail_list_field_updates.py b/freshmail_list_field_updates.py deleted file mode 100644 index 04fe42e..0000000 --- a/freshmail_list_field_updates.py +++ /dev/null @@ -1,15 +0,0 @@ -from freshmail import FreshMail -from freshmail_config import * - - -fm = FreshMail(FRESHMAIL_API_KEY,FRESHMAIL_API_SECRET) -custom_fields = ['name','first_name'] - -lists = fm.getLists() -for list in lists: - list_hash = list['subscriberListHash'] - for field in custom_fields: - added = fm.addCustomFieldtoList(list_hash, field) - print added - -print 'done' \ No newline at end of file diff --git a/freshmailtest.py b/freshmailtest.py deleted file mode 100644 index bf55a5e..0000000 --- a/freshmailtest.py +++ /dev/null @@ -1,12 +0,0 @@ -from freshmail import FreshMail -from freshmail_config import * - -email = TEST_EMAIL - -fm = FreshMail(FRESHMAIL_API_KEY,FRESHMAIL_API_SECRET) -list = '16ll8gurkq' -state = 1 #Active -confirm = 0 #Do not send confirmation email -custom_fields = {'name':'Full Name', 'first_name': 'FirstName'} -fm.addSubscriber(email,list,state,confirm,custom_fields); - diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..9d954ca --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +requests>=2.5.0,<3.0 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..cffa0b9 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,10 @@ +[wheel] +universal = 1 + +[tool:pytest] +pep8ignore = E128 E303 E303 +pep8maxlinelength = 80 + +[pep8] +ignore = E128,E303,E303 +max-line-length = 80 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..27c61fc --- /dev/null +++ b/setup.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- + +'''Setup script +''' + +import os + +from setuptools import setup, find_packages + + +WORK_DIR = os.path.dirname(os.path.abspath(__file__)) +os.chdir(WORK_DIR) +os.sys.path.insert(1, WORK_DIR) + +PKG_NAME = 'freshmail-python' +PKG_MOD = __import__('freshmail') + +PKG_AUTHOR_NAME, PKG_AUTHOR_EMAIL = PKG_MOD.__author__.rsplit(' ', 1) +PKG_AUTHOR_EMAIL = PKG_AUTHOR_EMAIL.strip('<>') + +PKG_VERSION = PKG_MOD.__version__ +PKG_CLASSIFIERS = PKG_MOD.__classifiers__ + +PKG_INFO = open(os.path.join(WORK_DIR, 'README.rst'), 'r').readlines() +PKG_DESC_SHORT = PKG_INFO[0] +PKG_DESC_LONG = ''.join(PKG_INFO) + +PKG_LICENSE_FULL = open(os.path.join(WORK_DIR, 'LICENSE'), 'r').readlines() +PKG_LICENSE_NAME = PKG_LICENSE_FULL[0].strip() + +PKG_REQS = open(os.path.join(WORK_DIR, 'requirements.txt')).readlines() + + +setup( + name=PKG_NAME, + version=PKG_VERSION, + author=PKG_AUTHOR_NAME, + author_email=PKG_AUTHOR_EMAIL, + url='http://github.com/soutys/freshmail-python', + maintainer=PKG_AUTHOR_NAME, + maintainer_email=PKG_AUTHOR_EMAIL, + description=PKG_DESC_SHORT, + long_description=PKG_DESC_LONG, + classifiers=PKG_CLASSIFIERS, + install_requires=PKG_REQS, + packages=find_packages(), + license=PKG_LICENSE_NAME, + zip_safe=False, + include_package_data=True, + package_data = { + '': ['VERSION'], + }, + keywords='freshmail mailing', + test_suite='tests', +) + + +# vim: ts=4:sw=4:et:fdm=indent:ff=unix diff --git a/test_requirements.txt b/test_requirements.txt new file mode 100644 index 0000000..df70119 --- /dev/null +++ b/test_requirements.txt @@ -0,0 +1,5 @@ +-r requirements.txt +coveralls +pytest +pytest-pep8 +pytest-cov diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_freshmail.py b/tests/test_freshmail.py new file mode 100644 index 0000000..b9a5169 --- /dev/null +++ b/tests/test_freshmail.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- + +'''Sup-module tests +''' + +from __future__ import ( + absolute_import, + division, + print_function, + unicode_literals, + with_statement, +) + +from freshmail.freshmail import FreshMail, FreshMailException + + +def test_init(): + fm_obj = FreshMail('any_key', 'any_secret') + assert fm_obj.get_raw_response() == '' + assert fm_obj.get_response() == '' + assert fm_obj.get_errors() is None + assert fm_obj.get_http_code() == 200 + + +def test_bad_method(): + fm_obj = FreshMail('any_key', 'any_secret') + try: + fm_obj.ping(method='PUT') + assert False + except FreshMailException: + pass + + +def test_ping_no_auth(): + fm_obj = FreshMail('any_key', 'any_secret') + try: + res = fm_obj.ping() + assert False + except FreshMailException: + pass + + +# vim: ts=4:sw=4:et:fdm=indent:ff=unix diff --git a/tests/test_version.py b/tests/test_version.py new file mode 100644 index 0000000..4b5a434 --- /dev/null +++ b/tests/test_version.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- + +'''Sup-module tests +''' + +from __future__ import ( + absolute_import, + division, + print_function, + unicode_literals, + with_statement, +) + +import freshmail + + +def test_version(): + assert freshmail.__version__ + + +# vim: ts=4:sw=4:et:fdm=indent:ff=unix