twitter 5.1.1 → 5.2.0

data/.yardopts

@@ -8,5 +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,13 @@
+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)
@@ -12,7 +22,6 @@
 -----
 * [Fix `buftok` delimiter handling](https://github.com/sferik/twitter/pull/484)
 * [Started handling streaming deletes](https://github.com/sferik/twitter/commit/8860b97bce4bc36086116f380a2771af3c199ea2)
-* [Replace `URI` with `adressable`](https://github.com/sferik/twitter/commit/7ea2f5390dc7456950f55c90aa4e48f29dcd4604)
 
 5.0.0
 -----

data/CONTRIBUTING.md

@@ -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
    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

@@ -25,9 +25,9 @@ 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:
+Then, install the gem with the medium security trust policy:
 
-    gem install twitter -P HighSecurity
+    gem install twitter -P MediumSecurity
 
 ## CLI
 
@@ -42,6 +42,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,41 +125,46 @@ 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>
@@ -500,14 +510,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")

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 = 60.1
+end
+
+task :default => [:spec, :rubocop, :verify_measurements]

data/lib/twitter/arguments.rb

@@ -9,6 +9,5 @@ module Twitter
       @options = args.last.is_a?(::Hash) ? args.pop : {}
       super(args)
     end
-
   end
 end

data/lib/twitter/base.rb

@@ -8,17 +8,16 @@ module Twitter
     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)
@@ -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

@@ -5,16 +5,16 @@ require 'twitter/version'
 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={})
+    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/core_ext/enumerable.rb

@@ -1,10 +1,8 @@
 module Enumerable
-
   def threaded_map
     threads = map do |object|
       Thread.new { yield object }
     end
     threads.map(&:value)
   end
-
 end

data/lib/twitter/core_ext/kernel.rb

@@ -1,10 +1,8 @@
 module Kernel
-
   # Returns the object's singleton class (exists in Ruby 1.9.2)
   def singleton_class
     class << self
       self
     end
   end unless method_defined?(:singleton_class)
-
 end

data/lib/twitter/creatable.rb

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

data/lib/twitter/cursor.rb

@@ -4,12 +4,11 @@ module Twitter
   class Cursor
     include Enumerable
     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 a new Cursor object from a response hash
       #
       # @param response [Hash]
@@ -20,10 +19,9 @@ module Twitter
       # @param path [String]
       # @param options [Hash]
       # @return [Twitter::Cursor]
-      def from_response(response, key, klass, client, request_method, path, options)
+      def from_response(response, key, klass, client, request_method, path, options) # rubocop:disable ParameterLists
         new(response[:body], key, klass, client, request_method, path, options)
       end
-
     end
 
     # Initializes a new Cursor
@@ -36,7 +34,7 @@ module Twitter
     # @param path [String]
     # @param options [Hash]
     # @return [Twitter::Cursor]
-    def initialize(attrs, key, klass, client, request_method, path, options)
+    def initialize(attrs, key, klass, client, request_method, path, options) # rubocop:disable ParameterLists
       @key = key.to_sym
       @klass = klass
       @client = client
@@ -64,12 +62,12 @@ module Twitter
     def next_cursor
       @attrs[:next_cursor] || -1
     end
-    alias next next_cursor
+    alias_method :next, :next_cursor
 
     def previous_cursor
       @attrs[:previous_cursor]
     end
-    alias previous previous_cursor
+    alias_method :previous, :previous_cursor
 
     # @return [Boolean]
     def first?
@@ -94,6 +92,5 @@ module Twitter
         @collection << (@klass ? @klass.new(element) : element)
       end
     end
-
   end
 end