twitter 5.0.0 → 5.4.1

data/.yardopts

@@ -8,3 +8,7 @@ CHANGELOG.md
 CONTRIBUTING.md
 LICENSE.md
 README.md
+examples/AllTweets.md
+examples/Configuration.md
+examples/RateLimiting.md
+examples/Update.md

data/CHANGELOG.md

@@ -1,3 +1,50 @@
+5.4.1
+-----
+* [Default to maximum number of tweets per request](https://github.com/sferik/twitter/commit/1e41b5d4dde8678f5968b57dafe9da63b092646c)
+
+5.4.0
+-----
+* [Fix enumerable search interface](https://github.com/sferik/twitter/commit/e14cc3391ebe8229184e9e83806c870df3baa24c)
+
+5.3.1
+-----
+* [Add `Twitter::Utils` module](https://github.com/sferik/twitter/commit/a1f47fbf19b859c8e680a0a92eff5e225a015090) ([@charliesome](https://twitter.com/charliesome))
+* [Remove `Enumerable` monkey patch](https://github.com/sferik/twitter/commit/818b28d1621e843c0c6f9ef471076f4125623e52) ([@charliesome](https://twitter.com/charliesome))
+* [Don't spawning a new thread if there's only one element](https://github.com/sferik/twitter/commit/c01ea8309c16eb77eeb368452df1dadd1e405532)
+* [Introduce meaningful constant names](https://github.com/sferik/twitter/commit/215c80890d702535de83d8f849885a95ec153920) ([@futuresanta](https://twitter.com/futuresanta))
+* [Automatically flatten `Twitter::Arguments`](https://github.com/sferik/twitter/commit/a556028ace04cb00c3c2b9cb8f72f792a86f04d6)
+
+5.3.0
+-----
+* [Add `UNABLE_TO_VERIFY_CREDENTIALS` error code](https://github.com/sferik/twitter/commit/6a47e715ef7935cd36a2f78ed877deb3c09af162)
+* [Don't suppress `Twitter::Error::Forbidden` in #follow and #follow!](https://github.com/sferik/twitter/commit/b949c0400dabc6774419025e7b131d0a18447c3a)
+* [Update memoizable dependency to ~> 0.3.1](https://github.com/sferik/twitter/pull/501)
+
+5.2.0
+-----
+* [Replace `URI` with `adressable`](https://github.com/sferik/twitter/commit/7ea2f5390dc7456950f55c90aa4e48f29dcd4604)
+* [Make `Twitter::Streaming::FriendList` an array](https://github.com/sferik/twitter/commit/1a38e5e8182823c3060fc59c270ef754bd49a179)
+* [Add `Twitter::Streaming::DeletedTweet`](https://github.com/sferik/twitter/commit/084025b5e348bd33b4c29c6b9e40565c0e77319c)
+* [Add `Twitter::Streaming::StallWarning`](https://github.com/sferik/twitter/commit/b07ac50552f5063ee43a490fa40da8b6889df772)
+* [Add error code for "User is over daily status update limit"](https://github.com/sferik/twitter/commit/76c088d38e594703ee391f2a524142aa357b0972)
+* [`Twitter::Streaming::Client#site` can take a `String` or `Twitter::User`](https://github.com/sferik/twitter/commit/e3ad4f2da1f8fc82e1d3febbc2602f626bced8a8)
+* [Update `http_parser.rb` dependency to `~> 0.6.0`](https://github.com/sferik/twitter/commit/6d2f81bfc5bd469d558868a0f65356f30ca9f5e7)
+
+5.1.1
+-----
+* [Custom equalizer for `Twitter::Place`](https://github.com/sferik/twitter/commit/79c76a9bed4f0170c8c09fe38ad4f0ee6aa4505e)
+
+5.1.0
+-----
+* [Use `Addressable::URI` everywhere](https://github.com/sferik/twitter/commit/97d7c68900c9974a1f6841f6eed2706df9030d64) ([@matthewrudy](https://twitter.com/matthewrudy))
+* [Allow use of `Twitter::Place` instead of `place_id`](https://github.com/sferik/twitter/commit/c2b31dd2385fefa30a9ddccf15415a713cf5953a)
+* [Allow use of `Twitter::Tweet` instead of `in_reply_to_status_id`](https://github.com/sferik/twitter/commit/6b7d6c2b637a074c348a56a51fb1e02252482fb2)
+
+5.0.1
+-----
+* [Fix `buftok` delimiter handling](https://github.com/sferik/twitter/pull/484)
+* [Started handling streaming deletes](https://github.com/sferik/twitter/commit/8860b97bce4bc36086116f380a2771af3c199ea2)
+
 5.0.0
 -----
 * [Remove `Twitter::API::Undocumented#status_activity` and `#statuses_activity`](https://github.com/sferik/twitter/commit/7f970810af251b2fe80c38b30c54485c55bd2034)

data/CONTRIBUTING.md

@@ -14,10 +14,10 @@ improve this project. Here are some ways *you* can contribute:
 * Refactor code.
 * Fix [issues][].
 * Review patches.
-* Financially pledge using [Pledgie][].
+* Financially pledge using [gittip][].
 
 [issues]: https://github.com/sferik/twitter/issues
-[Pledgie]: http://pledgie.com/campaigns/18388
+[gittip]: https://www.gittip.com/sferik/
 
 ## Submitting an Issue
 We use the [GitHub issue tracker][issues] to track bugs and features. Before
@@ -35,13 +35,13 @@ Ideally, a bug report should include a pull request with failing specs.
 3. Add specs for your unimplemented feature or bug fix.
 4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
 5. Implement your feature or bug fix.
-6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+6. Run `bundle exec rake default`. If your specs fail, return to step 5.
 7. Run `open coverage/index.html`. If your changes are not completely covered
    by your tests, return to step 3.
-8.  Run `RUBYOPT=W2 bundle exec rake spec 2>&1 | grep twitter`. If your changes
+8. Run `RUBYOPT=W2 bundle exec rake spec 2>&1 | grep twitter`. If your changes
    produce any warnings, return to step 5.
 9. Add documentation for your feature or bug fix.
-10. Run `bundle exec rake yard`. If your changes are not 100% documented, go
+10. Run `bundle exec rake verify_measurements`. If your changes are not 100% documented, go
     back to step 9.
 11. Commit and push your changes.
 12. [Submit a pull request.][pr]

data/README.md

@@ -5,30 +5,20 @@
 [![Dependency Status](https://gemnasium.com/sferik/twitter.png?travis)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/sferik/twitter.png)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/sferik/twitter/badge.png?branch=master)][coveralls]
-[![Click here to make a donation](http://www.pledgie.com/campaigns/18388.png)][pledgie]
+[![Gittip](http://img.shields.io/gittip/sferik.png)][gittip]
 
 [gem]: https://rubygems.org/gems/twitter
 [travis]: http://travis-ci.org/sferik/twitter
 [gemnasium]: https://gemnasium.com/sferik/twitter
 [codeclimate]: https://codeclimate.com/github/sferik/twitter
 [coveralls]: https://coveralls.io/r/sferik/twitter
-[pledgie]: http://pledgie.com/campaigns/18388
+[gittip]: https://www.gittip.com/sferik/
 
 A Ruby interface to the Twitter API.
 
 ## Installation
     gem install twitter
 
-To ensure the code you're installing hasn't been tampered with, it's
-recommended that you verify the signature. To do this, you need to add my
-public key as a trusted certificate (you only need to do this once):
-
-    gem cert --add <(curl -Ls https://raw.github.com/sferik/twitter/master/certs/sferik.pem)
-
-Then, install the gem with the high security trust policy:
-
-    gem install twitter -P HighSecurity
-
 ## CLI
 
 Looking for the Twitter command-line interface? It was [removed][] from this
@@ -42,6 +32,11 @@ gem in version 0.5.0 and now exists as a [separate project][t].
 
 [documentation]: http://rdoc.info/gems/twitter
 
+## Examples
+[https://github.com/sferik/twitter/tree/master/examples][examples]
+
+[examples]: https://github.com/sferik/twitter/tree/master/examples
+
 ## Announcements
 You should [follow @gem][follow] on Twitter for announcements and updates about
 this library.
@@ -120,55 +115,60 @@ end
 
 ```ruby
 topics = ["coffee", "tea"]
-client.filter(:track => topics.join(",")) do |tweet|
-  puts tweet.text
+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 |tweet|
-  puts tweet.text
+client.sample do |object|
+  puts object.text if object.is_a?(Twitter::Tweet)
 end
 ```
 
-**Stream tweets, events and direct messages for the authenticated user**
+**Stream tweets, events, and direct messages for the authenticated user**
 
 ```ruby
-client.user do |message|
-  puts message 
+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
 ```
 
-`message` can be one of
- + Twitter::Tweet
- + Twitter::DirectMessage
- + Twitter::Streaming::Event
- + Twitter::Streaming::FriendList
-
-[messages]: https://dev.twitter.com/docs/streaming-apis/messages
+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.
 
-[cursors]: https://dev.twitter.com/docs/misc/cursoring
-
 <table>
   <thead>
     <tr>
       <th>Notes</th>
       <th colspan="2">Version 4</th>
       <th colspan="2">Version 5</th>
-    </th>
+    </tr>
     <tr>
       <th></th>
       <th>Code</th>
       <th>HTTP GETs</th>
       <th>Code</th>
       <th>HTTP GETs</th>
-    </th>
+    </tr>
   </thead>
   <tbody>
     <tr>
@@ -176,13 +176,13 @@ simplicity and performance.
         Are you at the start of the cursor?
       </td>
       <td>
-        <pre><code lang="ruby">client.friends.first</code></pre>
+        <pre><code>client.friends.first</code></pre>
       </td>
       <td>
         <em>Θ(1)</em>
       </td>
       <td>
-        <pre><code lang="ruby">client.friends.first?</code></pre>
+        <pre><code>client.friends.first?</code></pre>
       </td>
       <td>
         <em>Θ(1)</em>
@@ -193,13 +193,13 @@ simplicity and performance.
         Return your most recent follower.
       </td>
       <td>
-        <pre><code lang="ruby">client.friends.users.first</code></pre>
+        <pre><code>client.friends.users.first</code></pre>
       </td>
       <td>
         <em>Θ(1)</em>
       </td>
       <td>
-        <pre><code lang="ruby">client.friends.first</code></pre>
+        <pre><code>client.friends.first</code></pre>
       </td>
       <td>
         <em>Θ(1)</em>
@@ -210,13 +210,13 @@ simplicity and performance.
         Return an array of all your friends.
       </td>
       <td>
-        <pre><code lang="ruby">client.friends.all</code></pre>
+        <pre><code>client.friends.all</code></pre>
       </td>
       <td>
         <em>Θ(n+1)</em>
       </td>
       <td>
-        <pre><code lang="ruby">client.friends.to_a</code></pre>
+        <pre><code>client.friends.to_a</code></pre>
       </td>
       <td>
         <em>Θ(n)</em>
@@ -227,13 +227,13 @@ simplicity and performance.
         Collect your 20 most recent friends.
       </td>
       <td>
-        <pre><code lang="ruby">client.friends.take(20)</code></pre>
+        <pre><code>client.friends.take(20)</code></pre>
       </td>
       <td>
         <em>Θ(n+1)</em>
       </td>
       <td>
-        <pre><code lang="ruby">client.friends.take(20)</code></pre>
+        <pre><code>client.friends.take(20)</code></pre>
       </td>
       <td>
         <em>Θ(1)</em>
@@ -244,7 +244,7 @@ simplicity and performance.
         Collect your 20 most recent friends twice.
       </td>
       <td>
-        <pre><code lang="ruby">friends = client.friends
+        <pre><code>friends = client.friends
 2.times.collect do
   friends.take(20)
 end</code></pre>
@@ -253,7 +253,7 @@ end</code></pre>
         <em>Θ(2n+2)</em>
       </td>
       <td>
-        <pre><code lang="ruby">friends = client.friends
+        <pre><code>friends = client.friends
 2.times.collect do
   friends.take(20)
 end</code></pre>
@@ -423,8 +423,8 @@ 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 `URI` objects instead of strings. To convert a
-`URI` object to a string, call `#to_s` on it.
+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
@@ -500,14 +500,14 @@ client.follow(213747670)
 client.user("gem")
 client.user(213747670)
 ```
-**Fetch a cursored list of followers with profile details (by screen name or user ID, or by implict authenticated user)**
+**Fetch a cursored list of followers with profile details (by screen name or user ID, or by implicit authenticated user)**
 
 ```ruby
 client.followers("gem")
 client.followers(213747670)
 client.followers
 ```
-**Fetch a cursored list of friends with profile details (by screen name or user ID, or by implict authenticated user)**
+**Fetch a cursored list of friends with profile details (by screen name or user ID, or by implicit authenticated user)**
 
 ```ruby
 client.friends("gem")
@@ -569,26 +569,27 @@ command:
     bundle exec rake erd
 
 ## Supported Ruby Versions
+
 This library aims to support and is [tested against][travis] the following Ruby
-implementations:
+versions:
 
 * Ruby 1.8.7
 * Ruby 1.9.2
 * Ruby 1.9.3
 * Ruby 2.0.0
 
-If something doesn't work on one of these interpreters, it's a bug.
+If something doesn't work on one of these versions, it's a bug.
 
-This library may inadvertently work (or seem to work) on other Ruby
-implementations, however support will only be provided for the versions listed
-above.
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
 
-If you would like this library to support another Ruby version, you may
-volunteer to be a maintainer. Being a maintainer entails making sure all tests
-run and pass on that implementation. When something breaks on your
-implementation, you will be responsible for providing patches in a timely
-fashion. If critical issues for a particular implementation exist at the time
-of a major release, support for that Ruby version may be dropped.
+If you would like this library to support another Ruby version or
+implementation, you may volunteer to be a maintainer. Being a maintainer
+entails making sure all tests run and pass on that implementation. When
+something breaks on your implementation, you will be responsible for providing
+patches in a timely fashion. If critical issues for a particular implementation
+exist at the time of a major release, support for that Ruby version may be
+dropped.
 
 ## Versioning
 This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
@@ -600,7 +601,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', '~> 4.0'
+    spec.add_dependency 'twitter', '~> 5.0'
 
 [semver]: http://semver.org/
 [pvc]: http://docs.rubygems.org/read/chapter/16#page74

data/Rakefile

@@ -1,17 +1,38 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
+task :erd do
+  `bundle exec ruby ./etc/erd.rb > ./etc/erd.dot`
+  `dot -Tpng ./etc/erd.dot -o ./etc/erd.png`
+  `open ./etc/erd.png`
+end
+
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task :test => :spec
-task :default => :spec
 
-task :erd do
-  `bundle exec ruby ./etc/erd.rb > ./etc/erd.dot`
-  `dot -Tpng ./etc/erd.dot -o ./etc/erd.png`
-  `open ./etc/erd.png`
+begin
+  require 'rubocop/rake_task'
+  Rubocop::RakeTask.new
+rescue LoadError
+  desc 'Run RuboCop'
+  task :rubocop do
+    $stderr.puts 'Rubocop is disabled'
+  end
 end
 
 require 'yard'
 YARD::Rake::YardocTask.new
+
+require 'yardstick/rake/measurement'
+Yardstick::Rake::Measurement.new do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+require 'yardstick/rake/verify'
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 59.9
+end
+
+task :default => [:spec, :rubocop, :verify_measurements]

data/lib/twitter/arguments.rb

@@ -7,8 +7,7 @@ module Twitter
     # @return [Twitter::Arguments]
     def initialize(args)
       @options = args.last.is_a?(::Hash) ? args.pop : {}
-      super(args)
+      super(args.flatten)
     end
-
   end
 end

data/lib/twitter/base.rb

@@ -1,24 +1,23 @@
+require 'addressable/uri'
 require 'forwardable'
 require 'memoizable'
 require 'twitter/null_object'
-require 'uri'
 
 module Twitter
   class Base
     extend Forwardable
     include Memoizable
     attr_reader :attrs
-    alias to_h attrs
-    alias to_hash attrs
-    alias to_hsh attrs
+    alias_method :to_h, :attrs
+    alias_method :to_hash, :attrs
+    alias_method :to_hsh, :attrs
 
     class << self
-
       # Construct an object from a response hash
       #
       # @param response [Hash]
       # @return [Twitter::Base]
-      def from_response(response={})
+      def from_response(response = {})
         new(response[:body])
       end
 
@@ -37,7 +36,7 @@ module Twitter
       # @param klass [Symbol]
       # @param key1 [Symbol]
       # @param key2 [Symbol]
-      def object_attr_reader(klass, key1, key2=nil)
+      def object_attr_reader(klass, key1, key2 = nil)
         define_attribute_method(key1, klass, key2)
         define_predicate_method(key1)
       end
@@ -47,10 +46,10 @@ module Twitter
       # @param attrs [Array, Symbol]
       def uri_attr_reader(*attrs)
         attrs.each do |uri_key|
-          array = uri_key.to_s.split("_")
-          index = array.index("uri")
-          array[index] = "url"
-          url_key = array.join("_").to_sym
+          array = uri_key.to_s.split('_')
+          index = array.index('uri')
+          array[index] = 'url'
+          url_key = array.join('_').to_sym
           define_uri_method(uri_key, url_key)
           alias_method(url_key, uri_key)
           define_predicate_method(uri_key, url_key)
@@ -74,7 +73,7 @@ module Twitter
       # @param key2 [Symbol]
       def define_uri_method(key1, key2)
         define_method(key1) do ||
-          URI.parse(@attrs[key2]) if @attrs[key2]
+          Addressable::URI.parse(@attrs[key2]) if @attrs[key2]
         end
         memoize(key1)
       end
@@ -84,7 +83,7 @@ module Twitter
       # @param key1 [Symbol]
       # @param klass [Symbol]
       # @param key2 [Symbol]
-      def define_attribute_method(key1, klass=nil, key2=nil)
+      def define_attribute_method(key1, klass = nil, key2 = nil)
         define_method(key1) do ||
           if klass.nil?
             @attrs[key1]
@@ -104,20 +103,19 @@ module Twitter
       #
       # @param key1 [Symbol]
       # @param key2 [Symbol]
-      def define_predicate_method(key1, key2=key1)
+      def define_predicate_method(key1, key2 = key1)
         define_method(:"#{key1}?") do ||
           !!@attrs[key2]
         end
         memoize(:"#{key1}?")
       end
-
     end
 
     # Initializes a new object
     #
     # @param attrs [Hash]
     # @return [Twitter::Base]
-    def initialize(attrs={})
+    def initialize(attrs = {})
       @attrs = attrs || {}
     end
 
@@ -132,7 +130,7 @@ module Twitter
 
   private
 
-    def attrs_for_object(key1, key2=nil)
+    def attrs_for_object(key1, key2 = nil)
       if key2.nil?
         @attrs[key1]
       else
@@ -140,6 +138,5 @@ module Twitter
         attrs.delete(key1).merge(key2 => attrs)
       end
     end
-
   end
 end

data/lib/twitter/basic_user.rb

@@ -3,8 +3,8 @@ require 'twitter/identity'
 module Twitter
   class BasicUser < Twitter::Identity
     attr_reader :following, :screen_name
-    alias handle screen_name
-    alias username screen_name
-    alias user_name screen_name
+    alias_method :handle, :screen_name
+    alias_method :username, :screen_name
+    alias_method :user_name, :screen_name
   end
 end

data/lib/twitter/client.rb

@@ -1,20 +1,20 @@
+require 'addressable/uri'
 require 'simple_oauth'
 require 'twitter/version'
-require 'uri'
 
 module Twitter
   class Client
     attr_accessor :access_token, :access_token_secret, :consumer_key, :consumer_secret
-    alias oauth_token access_token
-    alias oauth_token= access_token=
-    alias oauth_token_secret access_token_secret
-    alias oauth_token_secret= access_token_secret=
+    alias_method :oauth_token, :access_token
+    alias_method :oauth_token=, :access_token=
+    alias_method :oauth_token_secret, :access_token_secret
+    alias_method :oauth_token_secret=, :access_token_secret=
 
     # Initializes a new Client object
     #
     # @param options [Hash]
     # @return [Twitter::Client]
-    def initialize(options={})
+    def initialize(options = {})
       options.each do |key, value|
         send(:"#{key}=", value)
       end
@@ -57,14 +57,13 @@ module Twitter
     def validate_credential_type!
       credentials.each do |credential, value|
         next if value.nil?
-        raise(Error::ConfigurationError, "Invalid #{credential} specified: #{value.inspect} must be a string or symbol.") unless value.is_a?(String) || value.is_a?(Symbol)
+        fail(Error::ConfigurationError, "Invalid #{credential} specified: #{value.inspect} must be a string or symbol.") unless value.is_a?(String) || value.is_a?(Symbol)
       end
     end
 
-    def oauth_auth_header(method, uri, params={})
-      uri = URI.parse(uri)
+    def oauth_auth_header(method, uri, params = {})
+      uri = Addressable::URI.parse(uri)
       SimpleOAuth::Header.new(method, uri, params, credentials)
     end
-
   end
 end

data/lib/twitter/configuration.rb

@@ -3,20 +3,20 @@ require 'twitter/base'
 module Twitter
   class Configuration < Twitter::Base
     attr_reader :characters_reserved_per_media, :max_media_per_upload,
-      :non_username_paths, :photo_size_limit, :short_url_length, :short_url_length_https
-    alias short_uri_length short_url_length
-    alias short_uri_length_https short_url_length_https
+                :non_username_paths, :photo_size_limit, :short_url_length,
+                :short_url_length_https
+    alias_method :short_uri_length, :short_url_length
+    alias_method :short_uri_length_https, :short_url_length_https
 
     # Returns an array of photo sizes
     #
     # @return [Array<Twitter::Size>]
     def photo_sizes
-      Array(@attrs[:photo_sizes]).inject({}) do |object, (key, value)|
+      Array(@attrs[:photo_sizes]).reduce({}) do |object, (key, value)|
         object[key] = Size.new(value)
         object
       end
     end
     memoize :photo_sizes
-
   end
 end

data/lib/twitter/creatable.rb

@@ -18,6 +18,5 @@ module Twitter
       !!@attrs[:created_at]
     end
     memoize :created?
-
   end
 end