twitter 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e958fdeea560a9ce78c044d026a4a9aaf9c5fab
-  data.tar.gz: 42e63cf78c08bbba893c962839e716b68c9131eb
+SHA256:
+  metadata.gz: 6c1797367fcb91dca015c7a77acd6273beb4c49e929c98d2d3a913ea37009496
+  data.tar.gz: 3c4a9f1fca5d3e99b9be0cb8993c4f274cb309b8fc19b2f3cf45838622484bce
 SHA512:
-  metadata.gz: ea08743dba187f71a9a19b1ab2ef8718b86ee94ed39d4c9b1367fd304d46012c640350185b87d45ec13b544594698f21a56d22d2e45d644ceea92949922af586
-  data.tar.gz: a9b84b50a9b18a25503799a71c2aa85b7b16bff5a243576eea2372251fc71afe6c69261d4f7d17547da1dffe178a6b84798cb1127f4244a58a3fad61e298bec7
+  metadata.gz: 887f6a6acfb58cd602fe1507c66e12fcb53c5b7479054a91e0ca68ee0c2a227c620b8bab614d256e4dfb31015cdc5c85fe8bdf9f05e9f48b8c38c8d945fbbf1e
+  data.tar.gz: 631417a20ae3bca7970e05f6a63c6049af3c613b0f078a6d178d81f13750ff4a885514aa882be050a94f3909dc24df8df084fbc816bec280a9e7963fb7ab3750

data/CHANGELOG.md

@@ -1,24 +1,31 @@
+6.2.0
+------
+
+Not yet documented, sorry. For now, please use git to compare tags:
+https://github.com/sferik/twitter/compare/v6.1.0...v6.2.0
+
 6.1.0
------
-* [Update faraday dependency to ~> 0.11.0](https://github.com/sferik/twitter/commit/6eb494d7c4ac1b06730d22bc9183e6a9035e3643)
+------
+
+Not yet documented, sorry. For now, please use git to compare tags:
+https://github.com/sferik/twitter/compare/v6.0.0...v6.1.0
 
-6.0.0
------
-* [Drop support for Ruby 1.8.7 and Ruby 1.9.3](https://github.com/sferik/twitter/commit/27980f45fb357e34b86e46cb9134d86ed29b3ce3)
 
-5.17.0
+6.0.0
 ------
-* [Add `email` to `Twitter::User`](https://github.com/sferik/twitter/commit/1d3aebcd0186d36c7c657ec913ac73bfa802d6ff)
-* [Add `current_user_retweet` attribute to `Twitter::Tweet`](https://github.com/sferik/twitter/pull/819) ([@ysr227](https://twitter.com/ysr227))
-* [Add `quoted_tweet` Twitter::Streaming::Event](https://github.com/sferik/twitter/pull/800)
-* [Dump `Twitter::NullObject` as JSON properly](https://github.com/sferik/twitter/pull/815) ([@okkez](https://twitter.com/okkez))
+
+Not yet documented, sorry. For now, please use git to compare tags:
+https://github.com/sferik/twitter/compare/v5.16.0...v6.0.0
 
 5.16.0
 ------
-* [Add new settings to `Twitter::Settings`](https://github.com/sferik/twitter/commit/d047ce00034d26a99927076c28679ce08fd69308)
-* [Add `Twitter::Trend#tweet_volume`](https://github.com/sferik/twitter/commit/e797b62e5e6a768e8aeafde6186e1f5310e6bfc6)
-* [Remove the encoding of profile urls](https://github.com/sferik/twitter/commit/6d46bd689ab4a4f119d1d692488aab37e4e99893) ([@TimHaines](https://twitter.com/TimHaines))
-* [Fix issue with port number in streaming connection](https://github.com/sferik/twitter/issues/709)
+
+* [Add Twitter::Trend#tweet_volume](https://github.com/sferik/twitter/commit/e797b62e5e6a768e8aeafde6186e1f5310e6bfc6)
+* [Add new settings to Twitter::Settings](https://github.com/sferik/twitter/commit/d047ce00034d26a99927076c28679ce08fd69308)
+* [Fix `Version.to_a`](https://github.com/sferik/twitter/commit/0cd119abf64e6c2b7fd861b0df65b7cb41d892b4)
+* [Remove the encoding of profile urls](https://github.com/sferik/twitter/commit/6d46bd689ab4a4f119d1d692488aab37e4e99893)
+* [Update http dependency to ~> 1.0](https://github.com/sferik/twitter/commit/8d379a45be6948a9d9264aa2e91ef5f7bdbe1db8)
+* [Fetch host and port directly from the request object](https://github.com/sferik/twitter/commit/f9f1bbdabde2ec96dcdd8900fe7bca072f9bea6b)
 
 5.15.0
 ------
@@ -67,7 +74,7 @@
 5.9.0
 -----
 * [Use expanded URIs when available](https://github.com/sferik/twitter/commit/f1d5d1f4c0ea75ebeaf9e7eb760b9efd245a5df2)
-* [Deprecate `Twitter::REST::Client#middleware=` and `#connection_options`](https://github.com/sferik/twitter/commit/71b0a38670102841fda9642de586e6cb67d33083)
+* [Deprecate `Twitter::REST::Client#middleware=` and `#connection_options`](https://github.com/sferik/twitter/commit/2ec17d8d43a87766dd4b89fcc6d5a2433530bf7c)
 * [Ensure predicate methods return `false` for `Twitter::NullObject`](https://github.com/sferik/twitter/commit/f1b42bf82440f2dc0ba61761fc8f12460e20aadf)
 * [Make `Twitter::Place#id` attribute accessible](https://github.com/sferik/twitter/commit/a4fa4739283a325886d44f97b2648e3b00f933b1)
 * [Enable injection of custom TCP/SSL socket classes](https://github.com/sferik/twitter/commit/3629a1edfbc6b35099d4b0fc165b938a67c02d86) ([@neektza](https://twitter.com/neektza))

data/README.md

@@ -20,7 +20,6 @@ A Ruby interface to the Twitter API.
     gem install twitter
 
 ## CLI
-
 Looking for the Twitter command-line interface? It was [removed][] from this
 gem in version 0.5.0 and now exists as a [separate project][t].
 
@@ -54,376 +53,6 @@ wiki][apps]!
 
 [apps]: https://github.com/sferik/twitter/wiki/apps
 
-## What's New in Version 5?
-### Configuration
-Global configuration has been removed, as it was not threadsafe. Instead, you
-can configure a `Twitter::REST::Client` by passing it a block when it's
-initialized.
-
-```ruby
-client = Twitter::REST::Client.new do |config|
-  config.consumer_key        = "YOUR_CONSUMER_KEY"
-  config.consumer_secret     = "YOUR_CONSUMER_SECRET"
-  config.access_token        = "YOUR_ACCESS_TOKEN"
-  config.access_token_secret = "YOUR_ACCESS_SECRET"
-end
-```
-
-Note: `oauth_token` has been renamed to `access_token` and `oauth_token_secret`
-is now `access_token_secret` to conform to the terminology used in Twitter's
-developer documentation.
-
-### Streaming (Experimental)
-This library now offers support for the [Twitter Streaming API][streaming].
-
-[streaming]: https://dev.twitter.com/streaming/overview
-[tweetstream]: http://rubygems.org/gems/tweetstream
-
-Site Streams are restricted to whitelisted accounts. To apply for access,
-[follow the steps in the Site Streams documentation][site-streams]. [User
-Streams][user-streams] do not require prior approval.
-
-[site-streams]: https://dev.twitter.com/streaming/sitestreams#applyingforaccess
-[user-streams]: https://dev.twitter.com/streaming/userstreams
-
-Unlike the rest of this library, this feature is not well tested and not
-recommended for production applications. I've decided to ship it as an
-experimental feature and make it more robust over time. Patches in this area are
-particularly welcome.
-
-Hopefully, by the time version 6 is released, this gem can fully replace
-[TweetStream][], [em-twitter][], [twitterstream][], and [twitter-stream].
-Special thanks to [Steve Agalloco][spagalloco], [Tim Carey-Smith][halorgium],
-and [Tony Arcieri][tarcieri] for helping to develop this feature.
-
-[em-twitter]: http://rubygems.org/gems/em-twitter
-[twitterstream]: http://rubygems.org/gems/twitterstream
-[twitter-stream]: http://rubygems.org/gems/twitter-stream
-[spagalloco]: https://github.com/spagalloco
-[halorgium]: https://github.com/halorgium
-[tarcieri]: https://github.com/tarcieri
-
-**Configuration works just like `Twitter::REST::Client`**
-
-```ruby
-client = Twitter::Streaming::Client.new do |config|
-  config.consumer_key        = "YOUR_CONSUMER_KEY"
-  config.consumer_secret     = "YOUR_CONSUMER_SECRET"
-  config.access_token        = "YOUR_ACCESS_TOKEN"
-  config.access_token_secret = "YOUR_ACCESS_SECRET"
-end
-```
-
-**Stream mentions of coffee or tea**
-
-```ruby
-topics = ["coffee", "tea"]
-client.filter(:track => topics.join(",")) do |object|
-  puts object.text if object.is_a?(Twitter::Tweet)
-end
-```
-
-**Stream a random sample of all tweets**
-
-```ruby
-client.sample do |object|
-  puts object.text if object.is_a?(Twitter::Tweet)
-end
-```
-
-**Stream tweets, events, and direct messages for the authenticated user**
-
-```ruby
-client.user do |object|
-  case object
-  when Twitter::Tweet
-    puts "It's a tweet!"
-  when Twitter::DirectMessage
-    puts "It's a direct message!"
-  when Twitter::Streaming::StallWarning
-    warn "Falling behind!"
-  end
-end
-```
-
-An `object` may be one of the following:
-* `Twitter::DirectMessage`
-* `Twitter::Streaming::DeletedTweet`
-* `Twitter::Streaming::Event`
-* `Twitter::Streaming::FriendList`
-* `Twitter::Streaming::StallWarning`
-* `Twitter::Tweet`
-
-### Cursors
-The `Twitter::Cursor` class has been completely redesigned with a focus on
-simplicity and performance.
-
-<table>
-  <thead>
-    <tr>
-      <th>Notes</th>
-      <th colspan="2">Version 4</th>
-      <th colspan="2">Version 5</th>
-    </tr>
-    <tr>
-      <th></th>
-      <th>Code</th>
-      <th>HTTP GETs</th>
-      <th>Code</th>
-      <th>HTTP GETs</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td>
-        Are you at the start of the cursor?
-      </td>
-      <td>
-        <pre><code>client.friends.first</code></pre>
-      </td>
-      <td>
-        <em>Θ(1)</em>
-      </td>
-      <td>
-        <pre><code>client.friends.first?</code></pre>
-      </td>
-      <td>
-        <em>Θ(1)</em>
-      </td>
-    </tr>
-    <tr>
-      <td>
-        Return your most recent friend.
-      </td>
-      <td>
-        <pre><code>client.friends.users.first</code></pre>
-      </td>
-      <td>
-        <em>Θ(1)</em>
-      </td>
-      <td>
-        <pre><code>client.friends.first</code></pre>
-      </td>
-      <td>
-        <em>Θ(1)</em>
-      </td>
-    </tr>
-    <tr>
-      <td>
-        Return an array of all your friends.
-      </td>
-      <td>
-        <pre><code>client.friends.all</code></pre>
-      </td>
-      <td>
-        <em>Θ(n+1)</em>
-      </td>
-      <td>
-        <pre><code>client.friends.to_a</code></pre>
-      </td>
-      <td>
-        <em>Θ(n)</em>
-      </td>
-    </tr>
-    <tr>
-      <td>
-        Collect your 20 most recent friends.
-      </td>
-      <td>
-        <pre><code>client.friends.take(20)</code></pre>
-      </td>
-      <td>
-        <em>Θ(n+1)</em>
-      </td>
-      <td>
-        <pre><code>client.friends.take(20)</code></pre>
-      </td>
-      <td>
-        <em>Θ(1)</em>
-      </td>
-    </tr>
-    <tr>
-      <td>
-        Collect your 20 most recent friends twice.
-      </td>
-      <td>
-        <pre><code>friends = client.friends
-2.times.collect do
-  friends.take(20)
-end</code></pre>
-      </td>
-      <td>
-        <em>Θ(2n+2)</em>
-      </td>
-      <td>
-        <pre><code>friends = client.friends
-2.times.collect do
-  friends.take(20)
-end</code></pre>
-      </td>
-      <td>
-        <em>Θ(1)</em>
-      </td>
-    </tr>
-  </tbody>
-</table>
-
-In the examples above, *n* varies with the number of people the authenticated
-user follows on Twitter. This resource returns up to 20 friends per HTTP GET,
-so if the authenticated user follows 200 people, calling
-`client.friends.take(20)` would make 11 HTTP requests in version 4. In version
-5, it makes just 1 HTTP request. Keep in mind, eliminating a single HTTP
-request to the Twitter API will reduce the latency of your application by
-[about 500 ms][status].
-
-[status]: https://dev.twitter.com/overview/status
-
-The last example might seem contrived ("Why would I call
-`client.friends.take(20)` twice?") but it applies to any
-[`Enumerable`][enumerable] method you might call on a cursor, including:
-`#all?`, `#collect`, `#count`, `#each`, `#inject`, `#max`, `#min`, `#reject`,
-`#reverse_each`, `#select`, `#sort`, `#sort_by`, and `#to_a`. In version 4,
-each time you called one of those methods, it would perform *n+1* HTTP
-requests. In version 5, it only performs those HTTP requests the first time any
-one of those methods is called. Each subsequent call fetches data from a
-[cache][].
-
-[enumerable]: http://ruby-doc.org/core-2.0/Enumerable.html
-[cache]: https://github.com/sferik/twitter/commit/7d8b2727af9400643ac397207185fd54e3f6387b
-
-The performance improvements are actually even **better** than the table above
-indicates. In version 5, calling `Twitter::Cursor#each` (or any
-[`Enumerable`][enumerable] method) starts yielding results immediately and
-continues yielding as each response comes back from the server. In version 4,
-`#each` made a series of requests and waited for the last one to complete
-before yielding any data.
-
-Here is a list of the interface changes to `Twitter::Cursor`:
-
-* `#all` has been replaced by `#to_a`.
-* `#last` has been replaced by `#last?`.
-* `#first` has been replaced by `#first?`.
-* `#first` now returns the first element in the collection, as prescribed by `Enumerable`.
-* `#collection` and its aliases have been removed.
-
-### Search Results
-The `Twitter::SearchResults` class has also been redesigned to have an
-[`Enumerable`][enumerable] interface. The `#statuses` method and its aliases
-(`#collection` and `#results`) have been replaced by `#to_a`. Additionally,
-this class no longer inherits from `Twitter::Base`. As a result, the `#[]`
-method has been removed.
-
-### Trend Results
-The `#trends` method now returns an [`Enumerable`][enumerable]
-`Twitter::TrendResults` object instead of an array. This object provides
-methods to determine the recency of the trend (`#as_of`), when the trend
-started (`#created_at`), and the location of the trend (`#location`). This data
-was previously unavailable.
-
-### Geo Results
-Similarly, the `#reverse_geocode`, `#geo_search`, and `#similar_places` methods
-now return an [`Enumerable`][enumerable] `Twitter::GeoResults` object instead
-of an array. This object provides access to the token to create a new place
-(`#token`), which was previously unavailable.
-
-### Tweets
-The `Twitter::Tweet` object has been cleaned up. The following methods have been
-removed:
-
-* `#from_user`
-* `#from_user_id`
-* `#from_user_name`
-* `#to_user`
-* `#to_user_id`
-* `#to_user_name`
-* `#profile_image_url`
-* `#profile_image_url_https`
-
-These attributes can be accessed via the `Twitter::User` object, returned
-through the `#user` method.
-
-### Users
-The `Twitter::User` object has also been cleaned up. The following aliases have
-been removed:
-
-* `#favorite_count` (use `#favorites_count`)
-* `#favoriters_count` (use `#favorites_count`)
-* `#favourite_count` (use `#favorites_count`)
-* `#favouriters_count` (use `#favorites_count`)
-* `#follower_count` (use `#followers_count`)
-* `#friend_count` (use `#friends_count`)
-* `#status_count` (use `#statuses_count`)
-* `#tweet_count` (use `#tweets_count`)
-* `#update_count` (use `#tweets_count`)
-* `#updates_count` (use `#tweets_count`)
-* `#translator` (use `#translator?`)
-
-### Remove British English aliases
-Earlier versions of this library aliased `favourites` to `favorites`. These
-aliases have been removed. Ruby is implemented in American English. The
-`initialize` method is spelled with a "z", not an "s", and Ruby provides no
-alias. Likewise, this library does not provide aliases for Commonwealthers.
-Merica. :us:
-
-### More natural method names
-All create, destroy, add, and remove methods have been renamed to put the verb
-at the beginning:
-
-* `#direct_message_create` is now `#create_direct_message`
-* `#direct_message_destroy` is now `#destroy_direct_message`
-* `#list_create` is now `#create_list`
-* `#list_destroy` is now `#destroy_list`
-* `#list_remove_member` is now `#remove_list_member`
-* `#list_remove_members` is now `#remove_list_members`
-* `#list_add_member` is now `#add_list_member`
-* `#list_add_members` is now `#add_list_members`
-* `#lists_owned` is now `#owned_lists`
-* `#saved_search_create` is now `#create_saved_search`
-* `#saved_search_destroy` is now `#destroy_saved_search`
-* `#status_destroy` is now `#destroy_status`
-
-### Null Objects
-In version 4, methods you would expect to return a `Twitter` object would
-return `nil` if that object was missing. This may have resulted in a
-`NoMethodError`. To prevent such errors, you may have introduced checks for the
-truthiness of the response, for example:
-
-```ruby
-status = client.status(55709764298092545)
-if status.place
-  # Do something with the Twitter::Place object
-elsif status.geo
-  # Do something with the Twitter::Geo object
-end
-```
-In version 5, all such methods will return a `Twitter::NullObject` instead of
-`nil`. This should prevent `NoMethodError` but may result in unexpected
-behavior if you have truthiness checks in place, since everything is truthy in
-Ruby except `false` and `nil`. For these cases, there are now predicate
-methods:
-
-```ruby
-status = client.status(55709764298092545)
-if status.place?
-  # Do something with the Twitter::Place object
-elsif status.geo?
-  # Do something with the Twitter::Geo object
-end
-```
-
-### URI Methods
-The `Twitter::List`, `Twitter::Tweet`, and `Twitter::User` objects all have a
-`#uri` method, which returns an HTTPS URI to twitter.com. This clobbers the
-`Twitter::List#uri` method, which previously returned the list URI's path (not
-a URI).
-
-These methods are aliased to `#url` for users who prefer that nomenclature.
-`Twitter::User` previously had a `#url` method, which returned the user's
-website. This URI is now available via the `#website` method.
-
-All `#uri` methods now return `Addressable::URI` objects instead of strings. To convert an
-`Addressable::URI` object to a string, call `#to_s` on it.
-
 ## Configuration
 Twitter API v1.1 requires you to authenticate via OAuth, so you'll need to
 [register your application with Twitter][register]. Once you've registered an
@@ -452,19 +81,8 @@ client = Twitter::REST::Client.new do |config|
 end
 ```
 
-After configuration, requests can be made like so:
-
-```ruby
-client.update("I'm tweeting with @gem!")
-```
-
-**Performance/DNS settings issue**
-
-When you are using the gem in production (running for example in a DigitalOcean VPS) be aware that DNS settings on the server can affect outbound traffic performance with `Twitter::Error::RequestTimeout` as a result. Don't use the public Google DNS services (4.4.4.4 / 8.8.8.8) they are rate-limited and have very bad response times. Use a DNS service close to your data-center.
-
 ## Usage Examples
-All examples require an authenticated Twitter client. See the section on <a
-href="#configuration">configuration</a>.
+After configuring a `client`, you can do the following things.
 
 **Tweet (as the authenticated user)**
 
@@ -498,12 +116,6 @@ client.friends(213747670)
 client.friends
 ```
 
-**Fetch a collection of user_ids that the currently authenticated user does not want to receive retweets from**
-
-```ruby
-client.no_retweet_ids
-````
-
 **Fetch the timeline of Tweets by a user**
 
 ```ruby
@@ -528,19 +140,83 @@ client.status(27558893223)
 **Collect the three most recent marriage proposals to @justinbieber**
 
 ```ruby
-client.search("to:justinbieber marry me", :result_type => "recent").take(3).collect do |tweet|
+client.search("to:justinbieber marry me", result_type: "recent").take(3).collect do |tweet|
   "#{tweet.user.screen_name}: #{tweet.text}"
 end
 ```
 **Find a Japanese-language Tweet tagged #ruby (excluding retweets)**
 
 ```ruby
-client.search("#ruby -rt", :lang => "ja").first.text
+client.search("#ruby -rt", lang: "ja").first.text
 ```
 For more usage examples, please see the full [documentation][].
 
-## Object Graph
+## Streaming
+Site Streams are restricted to whitelisted accounts. To apply for access,
+[follow the steps in the Site Streams documentation][site-streams]. [User
+Streams][user-streams] do not require prior approval.
+
+[site-streams]: https://dev.twitter.com/streaming/sitestreams#applyingforaccess
+[user-streams]: https://dev.twitter.com/streaming/userstreams
+
+**Configuration works just like `Twitter::REST::Client`**
+
+```ruby
+client = Twitter::Streaming::Client.new do |config|
+  config.consumer_key        = "YOUR_CONSUMER_KEY"
+  config.consumer_secret     = "YOUR_CONSUMER_SECRET"
+  config.access_token        = "YOUR_ACCESS_TOKEN"
+  config.access_token_secret = "YOUR_ACCESS_SECRET"
+end
+```
 
+**Stream a random sample of all tweets**
+
+```ruby
+client.sample do |object|
+  puts object.text if object.is_a?(Twitter::Tweet)
+end
+```
+
+**Stream mentions of coffee or tea**
+
+```ruby
+topics = ["coffee", "tea"]
+client.filter(track: topics.join(",")) do |object|
+  puts object.text if object.is_a?(Twitter::Tweet)
+end
+```
+
+**Stream tweets, events, and direct messages for the authenticated user**
+
+```ruby
+client.user do |object|
+  case object
+  when Twitter::Tweet
+    puts "It's a tweet!"
+  when Twitter::DirectMessage
+    puts "It's a direct message!"
+  when Twitter::Streaming::StallWarning
+    warn "Falling behind!"
+  end
+end
+```
+
+An `object` may be one of the following:
+* `Twitter::Tweet`
+* `Twitter::DirectMessage`
+* `Twitter::Streaming::DeletedTweet`
+* `Twitter::Streaming::Event`
+* `Twitter::Streaming::FriendList`
+* `Twitter::Streaming::StallWarning`
+
+## Ads
+
+We recommend using the [Twitter Ads SDK for Ruby][ads] to interact with the Twitter Ads API.
+
+[ads]: http://twitterdev.github.io/twitter-ruby-ads-sdk/
+
+## Object Graph
 ![Entity-relationship diagram][erd]
 
 [erd]: https://cdn.rawgit.com/sferik/twitter/master/etc/erd.svg "Entity-relationship diagram"
@@ -552,7 +228,6 @@ command:
     bundle exec rake erd
 
 ## Supported Ruby Versions
-
 This library aims to support and is [tested against][travis] the following Ruby
 versions:
 
@@ -585,7 +260,7 @@ introduced with new major versions. As a result of this policy, you can (and
 should) specify a dependency on this gem using the [Pessimistic Version
 Constraint][pvc] with two digits of precision. For example:
 
-    spec.add_dependency 'twitter', '~> 5.0'
+    spec.add_dependency 'twitter', '~> 6.0'
 
 [semver]: http://semver.org/
 [pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint