jp3cki/docomo-dialogue

Wrapper for dialogue API by NTT docomo.

v1.2.2 2016-09-17 20:19 UTC

This package is auto-updated.

Last update: 2020-11-18 21:45:31 UTC


README

License Build Status Latest Stable Version Scrutinizer Code Quality Code Climate Test Coverage Dependency Status

NTT docomo から提供されている、 雑談対話APIのラッパーです。

このライブラリは NTT docomo 公式ではありません。

このソースコードの作者は NTT docomo とは一切関係がありません。

※現時点では、docomo ID を送信するタイプの API (2015-02-24 公開)には対応していません

インストール

Composer経由でのインストールと利用をおすすめします。

Composer を使える状態になったら、次のコマンドを実行します。

php composer.phar require jp3cki/docomo-dialogue

あるいは、手動で composer.json を編集します。 妥当な JSON となるように注意してください。 また、既に require が存在する場合には中身だけを書き加えてください。

    "require": {
        "jp3cki/docomo-dialogue": "~1.0"
    }

その後、php composer.phar install とすると使えるようになります。

※依存関係のインストールでかなり時間がかかる可能性があります。

使用する前に

雑談対話APIを利用するには、docomoの開発者登録とアプリケーション登録が必要になります。

docomo Developer support を覗いてみてください。

動作サンプル

sample/sample.php で簡単なチャットができます。

環境によっては日本語をBackSpaceで消そうとするとひどい目に遭うかもしれませんがあくまでサンプルなのでご容赦ください。

動作の前に sample.php を開いて API キーを書き換えてください。

動作に関する問い合わせ等

  • このライブラリを使用することで発生する問題についてはこのプロジェクトの issue に報告してください。
  • API 自体の動作に関する問題については、このプロジェクトの issue で相談するか、直接 NTT docomo のサポートへ問い合わせてください。
    • このライブラリは NTT docomo 様から見ると「公式のライブラリではない」「再現できる最小のコードではない」ものです。このコードを利用したサンプルは報告には適しません。(が、ソースコード自体は docomo 様からも見えますので何かの参考にはなるかもしれません)

API等

  • このライブラリのディレクトリ(おそらく vendor/jp3cki/docomo-dialogue)に移動して、make doc と実行すると doc ディレクトリに自動生成された API ドキュメントが出力されます。

  • ソースコードを追う際は、Dialogue クラスを起点にします。

  • ちゃんとしたドキュメントを書いてくれる方を募集しています。

スペシャルサンクス

ライセンス

MIT License で提供します。

ざっくり言うと著作権表示だけあれば ok です。 使用したことに伴う何らかの責任は負いません。

The MIT License (MIT)

Copyright (c) 2015 AIZAWA Hina <hina@bouhime.com>

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.