2017 © Pedro Peláez
 

library twistoauth

Advanced PHP Twitter library.

image

mpyw/twistoauth

Advanced PHP Twitter library.

  • Sunday, August 28, 2016
  • by mpyw
  • Repository
  • 1 Watchers
  • 3 Stars
  • 7,887 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 2 Versions
  • 2 % Grown

The README.md

TwistOAuth

Warning: This package is abandoned and no longer maintained. Use mpyw/cowitter package instead., (*1)

Advanced PHP Twitter library.
Version 3.5.2, (*2)

Requirements

  • PHP version 5.3.2 or later
  • libcurl (Sorry, required version is unknown)

Features

Basic:, (*3)

  • Using GZIP compressed connections
  • Automatically decode responses
  • Automatically fix weird responses
  • Exception handling
  • Requests for REST API
  • Requests for Streaming API
  • Requests using OAuth Echo
  • Requests via Proxy
  • Multipart requests

Abusing:, (*4)

  • Asynchronous Multiple requests
  • Asynchronous Multiple streaming
  • Direct OAuth authentication

Preparation

1. Download this library

You can choose one of the following methods., (*5)

Direct Download

Click here to save TwistOAuth.phar in your working directory., (*6)

Composer

Modify require directive in composer.json., (*7)

{
    "require": {
        "mpyw/twistoauth": "~3.0"
    }
}

If you choose this, replace all, (*8)

require __DIR__ . '/TwistOAuth.phar';

into, (*9)

require __DIR__ . '/vendor/autoload.php';

in examples., (*10)

2. Register your application

You can manage your API keys in https://apps.twitter.com. Now, let's register your own application., (*11)

  1. Click Create New App
  2. Fill Name Description WebSite.
  3. Fill Callback URL. By default, users are redirected here after successfully authenticating.
  4. Read rules and check Yes, I agree.
  5. Click Create your Twitter application.

NOTE: localhost is not available for Callback URL. Use 127.0.0.1 instead., (*12)

3. Change application permissions

By default, you can only read tweets but cannot post tweets. You have to configure permission settings., (*13)

  1. Open detail page of your application.
  2. Click Permissions Tab.
  3. Select Read, Write and Access direct messages.
  4. Click Update settings.

4. Note your consumer_key and consumer_secret

These parameters are identifier for your application., (*14)

  1. Open detail page of your application.
  2. Click API Keys Tab.
  3. Note API key and API secret. They mean consumer_key and consumer_secret.

5. Generate your access_token and access_token_secret

These parameters are identifier for your account., (*15)

  1. Open detail page of your application.
  2. Click API Keys Tab.
  3. Click Generate my access token.
  4. Note Access token and Access token secret.

Contents

FAQ

How can I learn about Twitter API?

Learn from documentation., (*16)

Or watch actual response. The following tool is very very useful., (*17)

Aren't there any nice authentication tools for obtaining tokens?

Try the following commandline utility., (*18)

How do I use OAuth 2.0 authentication flow?

Sorry, it is not available with this library. Use OAuth 1.0a instead., (*19)

What is oauth_verifier ?

It is required for calling the following methods., (*20)

  • TwistOAuth::renewWithAccessToken()
  • TwistOAuth::curlPostAccessToken()

You can get it after user redirecting., (*21)

$oauth_verifier = filter_input(INPUT_GET, 'oauth_verifier');

What is oauth_callback ?

It is not required, but you can apply it for calling the following methods., (*22)

  • TwistOAuth::renewWithRequestToken()
  • TwistOAuth::curlPostRequestToken()

There are three value types., (*23)

Name Example Value Authentication Type
Empty String "" PIN or URL (Use default setting)
URL "http://example.com/callback.php" URL
Out-Of-Band "oob" PIN

WARNING:
You can only use URL if your application is configured as Browser Application.
This means Callback URL is not empty., (*24)

How do I use $to in callback closure?

Use use()., (*25)

$to->streaming('user', function ($status) use ($to) { ... });

How do I ignore TwistException thrown?

Now your code is:, (*26)

try {
    $to->post('statuses/update', array('status' => 'test'));
} catch (TwistException $e) { } // This is very lengthy!!!

To ignore all responses..., (*27)

curl_exec($to->curlPost('statuses/update', array('status' => 'test'))); // Wow, cool

Are all classes immutable?

Yes., (*28)

$a = new TwistOAuth('CK', 'CS');
$b = $a->renewWithRequestToken();
var_dump($a === $b); // false

However, you can change propety values by directly calling __construct()., (*29)

$obj = new TwistOAuth('a', 'b');
$obj->__construct('c', 'd'); // Break immutable rules

Why don't you use namespace?

This is because of the compatibility with previous versions of abraham/twitteroauth.
I believe that the prefix Twist- will never collide with any other libraries., (*30)

Tweets are already escaped... wtf!?

HTML special chars in texts of statuses are already escaped by Twitter like this., (*31)

$status->text = htmlspecialchars($status->text, ENT_NOQUOTES, 'UTF-8');

WARNING:
The flag is ENT_NOQUOTES, not ENT_QUOTES or ENT_COMPAT.
The following snippet may print broken HTML., (*32)

```html+php , (*33)


You should do like this. <ins>Do not forget to set **4th** parameter into `false`.</ins>

```html+php
<input type="text" name="text" value="<?=htmlspecialchars(status->text, ENT_QUOTES, 'UTF-8', false)?>">

User description contains unescaped &... wtf!?

HTML special chars in others are already sanitized by Twitter like this., (*34)

$user->name        = str_replace(array('<', '>'), '', $user->name);
$user->description = str_replace(array('<', '>'), '', $user->description);

WARNING:
& is not replaced into &amp;.
The following snippet may print broken HTML., (*35)

```html+php name: =$user->name?>
, (*36)


You should do like this.

```html+php
name: <?=htmlspecialchars($user->name, ENT_QUOTES, 'UTF-8')?><br>

cURL causes SSL certificate problem error in Windows!

In the past library, this problem was done with the following solution., (*37)

// You are saying, "Hey libcurl, do not certificate whether I'm really talking to Twitter."
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

However, it makes vulnerability for man-in-the-middle attack. Your connection can be hijacked even if using the protocol https://. This attack can be committed in the following case., (*38)

  • Some DNS servers' caches are poisoned. Refer to DNS spoofing
  • You are connecting a public access point that an attacker launched as a trap.

The right way is to download to add CA information to your computer., (*39)

1. Download ca-bundle.crt to save in the directory, which path should not contain multibyte characters., (*40)

# Good
C:\ca-bundles\ca-bundles.crt

# Bad
C:\Users\田所浩二\Documents\証明書\ca-bundles.crt

2. Add the following definition in php.ini., (*41)

curl.cainfo="C:\ca-bundles\ca-bundles.crt"

3. Restart Apache., (*42)

The Versions

28/08 2016

dev-master

9999999-dev

Advanced PHP Twitter library.

  Sources   Download

BSD-2-Clause

The Requires

  • php >=5.3.2
  • ext-hash *
  • ext-json *
  • ext-reflection *
  • lib-openssl *
  • lib-curl *
  • lib-libxml *
  • lib-pcre *

 

by Avatar mpyw

api oauth upload image asynchronous async multiple twitter streaming paralell userstream twitpic

24/01 2016

3.5.2

3.5.2.0

Advanced PHP Twitter library.

  Sources   Download

BSD-2-Clause

The Requires

  • php >=5.3.2
  • ext-hash *
  • ext-json *
  • ext-reflection *
  • lib-openssl *
  • lib-curl *
  • lib-libxml *
  • lib-pcre *

 

by Avatar mpyw

api oauth upload image asynchronous async multiple twitter streaming paralell userstream twitpic