Merge pull request #1 from polidog/v0.2.0

V0.2.0を作りました。

Author: polidog

.coveralls.yml

@@ -1,4 +1,4 @@
 # for php-coveralls
-src_dir: lib
+src_dir: src 
 coverage_clover: build/logs/clover.xml
 json_path: build/logs/coveralls-upload.json

.scrutinizer.yml

@@ -0,0 +1,34 @@
+filter:
+    paths: 
+        - 'src/*'
+tools:
+    php_cpd:
+        enabled: true
+        excluded_dirs: {  }
+        names:
+            - '*.php'
+        min_lines: 5
+        min_tokens: 70
+        filter:
+            paths:
+                - 'src/*'
+    php_pdepend:
+        excluded_dirs:
+            - vendor
+        enabled: true
+        configuration_file: null
+        suffixes:
+            - php
+        filter:
+            paths:
+                - 'src/*'
+    php_changetracking:
+        enabled: true
+        bug_patterns:
+            - '\bfix(?:es|ed)?\b'
+        feature_patterns:
+            - '\badd(?:s|ed)?\b'
+            - '\bimplement(?:s|ed)?\b'
+        filter:
+            paths:
+                - 'src/*'

.travis.yml

@@ -1,8 +1,8 @@
 language: php
 
 php:
-  - 5.4
   - 5.5
+  - 5.6
 before_script:
   - composer install --prefer-source
 
@@ -12,10 +12,9 @@ before_script:
 
 script:
   - mkdir -p build/logs
+  - mkdir -p build/cov
   - php vendor/bin/phpunit -c phpunit.xml.dist
 
 after_script:
-  - php vendor/bin/coveralls
-  # or enable logging
   - php vendor/bin/coveralls -v
 

README.md

@@ -3,46 +3,81 @@ php-chatwork-api
 
 [![Build Status](https://travis-ci.org/polidog/php-chatwork-api.png?branch=develop)](https://travis-ci.org/polidog/php-chatwork-api)
 [![Coverage Status](https://coveralls.io/repos/polidog/php-chatwork-api/badge.png)](https://coveralls.io/r/polidog/php-chatwork-api)
-[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/polidog/php-chatwork-api/badges/quality-score.png?s=56ea782f70ecfbe3de485e4be2a2c585455e44e3)](https://scrutinizer-ci.com/g/polidog/php-chatwork-api/)  
+[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/polidog/php-chatwork-api/badges/quality-score.png?s=56ea782f70ecfbe3de485e4be2a2c585455e44e3)](https://scrutinizer-ci.com/g/polidog/php-chatwork-api/)
+[![Latest Stable Version](https://poser.pugx.org/polidog/php-chatwork-api/v/stable.svg)](https://packagist.org/packages/polidog/php-chatwork-api)
+[![Total Downloads](https://poser.pugx.org/polidog/php-chatwork-api/downloads.svg)](https://packagist.org/packages/polidog/php-chatwork-api)
+[![License](https://poser.pugx.org/polidog/php-chatwork-api/license.svg)](https://packagist.org/packages/polidog/php-chatwork-api)
 
+[Chatwork](http://www.chatwork.com/ja/) APIをPHPから利用するためのライブラリです。
 
-みんな大好きChatWorkのAPIの限定プレビューが始まるということで、早速先走ってAPIラッパークラスをPHPで実装してみました。
-まだAPIの使えない僕は、妄想しながら実装したので、動くかどうかは責任とれませんw
+## 必要
+- PHP5.5+
 
 
-## インストール方法
+## Install
 
+composer.jsonに以下の記述を加えてください。
 
-1\. composer.pharを用意します。  
 ```
-$ curl -sS https://getcomposer.org/installer | php
+{
+  "require": {
+    "polidog/php-chatwork-api": "0.2.*@dev"
+  }
+}
 ```
-2\. comoposer.jsonを用意しましょう
+
+
+## Quick Example
+
+利用する前に必ずChatWorkのAPIキーを用意しておいてください。  
+[APIキーの確認方法](http://developer.chatwork.com/ja/authenticate.html)を確認してください。
+
+### オブジェクトを取得する
 
 ```
-{
-    "require": {
-        "polidog/php-chatwork-api": "dev-develop",
-        "kriswallsmith/buzz": "v0.10"
-    }
-}
+// ChatWork API Clientオブジェクトの初期化
+$client = new \Polidog\Chatwork\Client("chatwork api token");
+```
+
+### 自分自身の情報(APIキーの所有者)
 
 ```
-3\. インストール
+$user = $client->api('me')->show();
 
+// APIのレスポンスはすべてオブジェクトの形で取得できます
+var_dump($user);
 ```
-php composer.phar install
+
+### チャットルーム一覧を取得する
+
+```
+$rooms = $client->api('rooms')->show();
+var_dump($rooms);
 ```
 
-4\. 実際につかってみる
+### チャットルームを作成する
+ここちょっと面倒くさい感じになってしまってます。。
+
 ```
-<?php
-require './vendor/autoload.php';
+// まずはRoomクラスを用意する
+$room = new \Polidog\Chatwork\Entity\Room();
+$room->name = 'test chat';
 
-$client = new \Chatwork\Client();
-$client->authenticate('your api key');
-//var_dump($client->api('me')->show());
-//var_dump($client->api('my')->status());
-var_dump($client->api('my')->tasks());
+// 次にメンバー一覧を用意する
+$members = new \Polidog\Chatwork\Entity\Collection\MembersCollection();
+$member = new \Polidog\Chatwork\Entity\Member();
+$member->role = 'admin';
+$member->account = $user;
+$members->add($member);
+```
+
+### チャットルームのメンバー一覧を取得する
+```
+$members = $client->api('rooms')->members(123456/* roomidを指定します。*/);
+var_dump($members);
+
+```
 
 
+## 関連リンク
+- [ChatWork API](http://developer.chatwork.com/ja/)

composer.json

@@ -1,5 +1,6 @@
 {
   "name": "polidog/php-chatwork-api",
+  "version": "0.2.0",
   "description": "Chatwork api class",
   "keywords": ["chatwork","api"],
   "homepage": "https://github.com/polidog/php-chatwork-api",
@@ -11,14 +12,37 @@
       "homepage": "http://www.polidog.jp"
     }
   ],
+  "repositories":[{
+    "type": "package",
+    "package": {
+      "name": "sebastianbergmann/phpcov",
+      "version": "1.1.0",
+      "dist": {
+        "url": "https://github.com/sebastianbergmann/phpcov/archive/1.1.0.zip",
+        "type": "zip"
+      },
+      "source": {
+        "url": "https://github.com/sebastianbergmann/phpcov.git",
+        "type": "git",
+        "reference": "1.1.0"
+      },
+      "bin": [
+        "phpcov.php"
+      ]
+    }
+  }], 
   "require": {
-    "kriswallsmith/buzz": "v0.10"
+    "php": ">=5.5.0",
+    "guzzlehttp/guzzle": "5.1.0",
+    "cakephp/utility": "3.0.0-beta3"
   },
   "require-dev": {
-    "phpunit/phpunit": "3.7.*",
-    "satooshi/php-coveralls": "dev-master"
+    "phpunit/phpunit": "4.4.0",
+    "phake/phake": "2.0.*@dev",
+    "satooshi/php-coveralls": "dev-master",
+    "sebastianbergmann/phpcov": "1.1.0"
   },
   "autoload": {
-    "psr-0": {"Chatwork\\": "lib/"}
+    "psr-4": {"Polidog\\Chatwork\\": "src/"}
   }
 }

demo.php

@@ -0,0 +1,76 @@
+<?php
+require '../vendor/autoload.php';
+
+define('TOKEN', 'your api token');
+
+// create client
+$client = new \Polidog\Chatwork\Client(TOKEN);
+
+//// api/me
+//$meEntity = $client->api('me')->show();
+//var_dump($meEntity);
+//
+//
+//// api/contacts
+//$contacts = $client->api('contacts')->show();
+//var_dump($contacts);
+//
+//
+//// rooms
+//$rooms = $client->api('rooms')->show();
+//// room
+//$room = $client->api('rooms')->detail(1);
+
+// create room
+// $user = $client->api('me')->show();
+// $room = new \Polidog\Chatwork\Entity\Room();
+// $room->name = "test room name";
+// $members = new \Polidog\Chatwork\Entity\Collection\MembersCollection();
+// $member = new \Polidog\Chatwork\Entity\Member();
+// $member->account = $user;
+// $member->role = 'admin';
+// $members->add($member);
+//
+// $client->api('rooms')->create($room, $members);
+
+// room update
+//$room = $client->api('rooms')->detail(27161215);
+//$room->name = "update test2";
+//$room->description = "ディスクリプションだお";
+//
+//$client->api('rooms')->update($room);
+
+// get room messages
+//$messages = $client->api('rooms')->messages(27161215)->show();
+//var_dump($messages);
+
+// create message
+//$message = new \Polidog\Chatwork\Entity\Message();
+//$message->body = "test";
+//$client->api('rooms')->messages(27161215)->create($message);
+
+// get members
+//$members = $client->api('rooms')->members(27161215)->show();
+//var_dump($members);
+
+// update members
+//$members = $client->api('rooms')->members(27161215)->show();
+//$client->api('rooms')->members(27161215)->update($members);
+
+// get tasks
+//$tasks = $client->api('rooms')->tasks(27161215)->show();
+//var_dump($tasks);
+
+// get task detail 
+//$task = $client->api('rooms')->tasks(27161215)->detail(19255236);
+//var_dump($task);
+
+// file list
+//$files = $client->api('rooms')->files(27161215)->show();
+//var_dump($files);
+
+// file detail
+//$file = $client->api('rooms')->files(27161215)->detail(26652612);
+//var_dump($file);
+
+