add code

Author: kmaehashi

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+branch = True
+source = atwiki
+omit =
+    atwiki/test/*

.gitignore

@@ -0,0 +1,6 @@
+*.pyc
+/dist/
+/build/
+/*.egg-info
+/.tox/
+.coverage

.travis.yml

@@ -0,0 +1,28 @@
+language: python
+
+python:
+    - 2.6
+    - 2.7
+    - 3.3
+    - 3.4
+    - 3.5
+
+before_install:
+    - env
+    - uname -a
+
+install:
+    # Show current environment
+    - python -V
+    - pip --version
+
+    # Install Coveralls
+    - pip install coveralls
+
+script:
+    # Unit Test
+    - coverage run -p setup.py test
+
+after_success:
+    - coverage combine
+    - coveralls

LICENSE

@@ -0,0 +1,7 @@
+Copyright (C) 2016 Preferred Networks and Nippon Telegraph and Telephone Corporation
+
+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.

README.rst

@@ -0,0 +1,41 @@
+atwiki-python
+=============
+
+``atwiki-python`` is a client library to access [@wiki](https://atwiki.jp) from Python.
+
+Install
+-------
+
+..
+
+  pip install .
+
+Requirements
+------------
+
+* Python 2.6, 2.7, 3.3, 3.4 or 3.5.
+
+Usage
+-----
+
+.. code:: python
+
+  from atwiki import *
+
+  api = AtWikiAPI(AtWikiURI('http://www65.atwiki.jp/python-client/'))
+
+  # List of pages.
+  for page in api.get_list():
+    print(page['name'])
+
+  # List of pages tagged with 'tag01'.
+  for page in api.get_list('tag01'):
+    print(page['name'])
+
+  # Source of page ID 14
+  print(api.get_source(14))
+
+License
+-------
+
+MIT License

atwiki/__init__.py

@@ -0,0 +1,8 @@
+from ._version import VERSION
+
+from .core import AtWikiAPI
+from .uri import AtWikiURI
+
+__version__ = '.'.join(map(str, VERSION))
+
+__all__ = ['AtWikiAPI', 'AtWikiURI']

atwiki/_version.py

@@ -0,0 +1 @@
+VERSION = (0, 0, 1)

atwiki/core.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+try:
+  # Python 3
+  from urllib.request import urlopen, Request
+except ImportError:
+  # Python 2
+  from urllib2 import urlopen, Request
+
+import re
+import time
+from collections import namedtuple
+
+import bs4
+import bs4.element
+from bs4 import BeautifulSoup
+
+from .uri import AtWikiURI
+
+class AtWikiAPI(object):
+  _PAGER_PATTERN = re.compile(r'.+?(\d+).+?(\d+).+?(\d+).+?')  # "計 110 ページ / 1 から 100 を表示"
+
+  def __init__(self, uri, **kwargs):
+    self._uri = uri
+    self._user_agent = kwargs.get('user_agent', 'Mozilla/5.0')
+    self._sleep = kwargs.get('sleep', 1)
+
+  def get_list(self, tag=None):
+    index = 0
+    while True:
+      count = 0
+      is_end = True
+      if tag:
+        soup = self._request(self._uri.tag(tag, index))
+        links = soup.find('div', attrs={'class': 'cmd_tag'}).findAll('a', href=True)
+        is_end = False
+      else:
+        soup = self._request(self._uri.list('create', index))
+        links = soup.find('table', attrs={'class': 'pagelist'}).findAll('a', href=True, title=True)
+        pager = soup.find('div', attrs={'class': 'pagelist'}).findAll('p')[2].text
+        m = self._PAGER_PATTERN.search(pager)
+        if m:
+          (total, cursor_begin, cursor_end) = (int(m.group(1)), int(m.group(2)), int(m.group(3)))
+          is_end = (total == cursor_end)
+      for link in links:
+        page_id = self._uri.get_page_id_from_uri(link.attrs['href'])
+        page_name = link.text.strip()
+        if page_id:
+          count += 1
+          yield {'id': page_id, 'name': page_name}
+      if count == 0 or is_end: break
+      index += 1
+      time.sleep(self._sleep)
+
+  def get_source(self, page_id, generation=0):
+    soup = self._request(self._uri.backup_source(page_id, generation))
+    return soup.find('pre', attrs={'class': 'cmd_backup'}).text.replace('\r', '')
+
+  def search(self, keyword, is_and=True):
+    soup = self._request(self._uri.search(keyword, is_and))
+    lis = soup.find('div', id='wikibody').findAll('li')[:-1]  # drop last item (link to http://atwiki.jp/wiki/keyword)
+    for li in lis:
+      a = li.find('a')
+      name = a.text
+      snippet = None
+      for sib in a.next_siblings:
+        if snippet is None:
+          if sib.name == 'br': snippet = ''
+          continue
+        if isinstance(sib, bs4.element.Tag):
+          snippet += sib.text
+        else:
+          snippet += str(sib)
+      snippet = '' if snippet is None else snippet.strip()
+      yield {'name': name, 'snippet': snippet}
+
+  def _request(self, url, data=None):
+    req = Request(url, headers={'User-Agent': self._user_agent}, data=data)
+    return BeautifulSoup(urlopen(req).read(), 'html.parser')

atwiki/test/__init__.py

@@ -0,0 +1 @@
+TEST_BASE_URI = 'http://www65.atwiki.jp/python-client'

atwiki/test/test_core.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from unittest import TestCase
+
+from atwiki.core import AtWikiAPI
+from atwiki.uri import AtWikiURI
+
+from . import TEST_BASE_URI
+
+class AtWikiAPITest(TestCase):
+  def setUp(self):
+    self._api = AtWikiAPI(AtWikiURI(TEST_BASE_URI))
+
+  def test_get_list(self):
+    results = list(self._api.get_list())
+    self.assertTrue(1 < len(results))
+
+  def test_get_list_tag(self):
+    results = list(self._api.get_list('tag01'))
+    self.assertEqual(len(results), 1)
+    self.assertEqual(results[0]['id'], 18)
+    self.assertEqual(results[0]['name'], 'Test_atwiki.test.test_core:AtWikiAPITest:test_get_list_tag')
+
+  def test_get_source(self):
+    self.assertEqual(self._api.get_source(14, 0),
+                     'テスト1\nテスト2\n\nテスト3\nテスト4\n\n\nテスト5')
+    self.assertEqual(self._api.get_source(14, 1),
+                     'テスト1\nテスト2\n\nテスト3\nテスト4')
+
+  def test_get_source_special(self):
+    self.assertEqual(self._api.get_source(15, 0),
+                     '"テスト1"<br>&\n"テスト2"<br>&')
+
+  def test_search(self):
+    results = list(self._api.search('SearchKeyword01 SearchKeyword02'))
+    self.assertEqual(len(results), 1)
+    self.assertEqual(results[0]['name'], 'Test_atwiki.test.test_core:AtWikiAPITest:test_search')
+    self.assertEqual(results[0]['snippet'], 'SearchKeyword01\nSearchKeyword02')
+
+  def test_search_or(self):
+    results = list(self._api.search('SearchKeyword01 SearchKeyword02', False))
+    self.assertEqual(len(results), 2)
+    self.assertEqual(results[0]['name'], 'Test_atwiki.test.test_core:AtWikiAPITest:test_search')
+    self.assertEqual(results[0]['snippet'], 'SearchKeyword01\nSearchKeyword02')
+    self.assertEqual(results[1]['name'], 'Test_atwiki.test.test_core:AtWikiAPITest:test_search_or')
+    self.assertEqual(results[1]['snippet'], 'SearchKeyword02')