ifttt-twitter 2.1.1

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011 John Nunemaker, Wynn Netherland, Erik Michaels-Ober, Steve Richert
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,251 @@
+# The Twitter Ruby Gem [![Build Status](https://secure.travis-ci.org/jnunemaker/twitter.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/jnunemaker/twitter.png?travis)][gemnasium]
+A Ruby wrapper for the Twitter API.
+
+[travis]: http://travis-ci.org/jnunemaker/twitter
+[gemnasium]: https://gemnasium.com/jnunemaker/twitter
+
+## <a name="installation"></a>Installation
+    gem install twitter
+
+Looking for the Twitter command-line interface? It was [removed] from this gem
+in version 0.5.0 and now is [maintained][] as a separate project called `t`.
+
+    gem install t
+
+[removed]: https://github.com/jnunemaker/twitter/commit/dd2445e3e2c97f38b28a3f32ea902536b3897adf
+[maintained]: https://github.com/sferik/t
+
+## <a name="documentation"></a>Documentation
+[http://rdoc.info/gems/twitter][documentation]
+
+[documentation]: http://rdoc.info/gems/twitter
+
+## <a name="follow"></a>Follow @gem on Twitter
+You should [follow @gem][follow] on Twitter for announcements and updates about
+the gem.
+
+[follow]: https://twitter.com/gem
+
+## <a name="mailing_list"></a>Mailing List
+Please direct any questions about the library to the [mailing list].
+
+[mailing list]: https://groups.google.com/group/ruby-twitter-gem
+
+## <a name="apps"></a>Apps Wiki
+Does your project or organization use this gem? Add it to the [apps
+wiki][apps]!
+
+[apps]: https://github.com/jnunemaker/twitter/wiki/apps
+
+## <a name="2.0"></a>What's new in version 2?
+This version introduces a number of new classes, notably:
+
+    Twitter::Configuration	Twitter::List		Twitter::Polygon			Twitter::Settings
+    Twitter::Cursor			Twitter::Metadata	Twitter::RateLimitStatus	Twitter::Size
+    Twitter::DirectMessage	Twitter::Mention	Twitter::Relationship		Twitter::Status
+    Twitter::Favorite		Twitter::Photo		Twitter::Reply				Twitter::Suggestion
+    Twitter::Follow			Twitter::Place		Twitter::Retweet			Twitter::Trend
+    Twitter::Language		Twitter::Point		Twitter::SavedSearch		Twitter::User
+
+These classes (plus Ruby primitives) have replaced all instances of
+`Hashie::Mash`. This allows us to remove the gem's dependency on [hashie][] and
+eliminate a layer in the middleware stack.
+
+[hashie]: https://github.com/intridea/hashie
+
+This should have the effect of making object instantiation and method
+invocation faster and less susceptible to typos. For example, if you typed
+`Twitter.user("sferik").loctaion`, a `Hashie::Mash` would return `nil` instead
+of raising a `NoMethodError`.
+
+Another benefit of these new objects is instance methods like `created_at` now
+return a `Time` instead of a `String`. This should make the objects easier to
+work with and better fulfills the promise of this library as a Ruby wrapper for
+the Twitter API.
+
+Any instance method that returns a boolean can now be called with a trailing
+question mark, for example:
+
+    Twitter.user("sferik").protected?
+
+The `Twitter::Search` class has been replaced by the `Twitter::Client#search`
+method. This unifies the library's interfaces and will make the code easier to
+maintain over time. As a result, you can no longer build queries by chaining
+methods (ARel-style). The new syntax is more consistent and concise.
+
+This version also introduces object equivalence, so objects that are logically
+equivalent are considered equal, even if they don't occupy the same address in
+memory, for example:
+
+    Twitter.user("sferik") == Twitter.user("sferik") #=> true
+    Twitter.user("sferik") == Twitter.user(7505382) #=> true
+
+In previous versions of this gem, both of the above statements would have
+returned false. We've stopped short of implementing a true identity map, such
+that:
+
+    Twitter.user("sferik").object_id == Twitter.user("sferik").object_id
+
+A true identity map may be implemented in future versions of this library.
+
+### Additional Notes
+* All deprecated methods have been removed.
+* `Twitter::Client#totals` has been removed. Use `Twitter::Client#user`
+  instead.
+* `Twitter.faraday_options` has been renamed to `Twitter.connection_options`.
+* `Twitter::Client#friendships` now takes up to 3 arguments instead of 1.
+* Support for the XML response format has been removed. This decision was
+  guided largely by Twitter, which has started removing XML responses available
+  for [some resources][trends]. This allows us to remove the gem's dependency
+  on [multi_xml][]. Using JSON is faster than XML, both in terms of parsing
+  speed and time over the wire.
+* All error classes have been moved inside the `Twitter::Error` namespace. If
+  you were previously rescuing `Twitter::NotFound` you'll need to change that
+  to `Twitter::Error::NotFound`.
+
+[trends]: https://dev.twitter.com/blog/changing-trends-api
+[multi_xml]: https://github.com/sferik/multi_xml
+
+## <a href="performance"></a>Performance
+You can improve performance by preloading a faster JSON parsing library. By
+default, JSON will be parsed with [okjson][]. For faster JSON parsing, we
+recommend [yajl][].
+
+[okjson]: https://github.com/ddollar/okjson
+[yajl]: https://github.com/brianmario/yajl-ruby
+
+## <a name="examples"></a>Usage Examples
+Return [@sferik][sferik]'s location
+
+    Twitter.user("sferik").location
+Return [@sferik][sferik]'s most recent Tweet
+
+    Twitter.user_timeline("sferik").first.text
+Return the text of the Tweet at https://twitter.com/sferik/statuses/27558893223
+
+    Twitter.status(27558893223).text
+Find the 3 most recent marriage proposals to [@justinbieber][justinbieber]
+
+    Twitter.search("to:justinbieber marry me", :rpp => 3, :result_type => "recent").map do |status|
+      "#{status.from_user}: #{status.text}"
+    end
+
+Let's find a Japanese-language Tweet tagged #ruby (no retweets)
+
+    Twitter.search("#ruby -rt", :lang => "ja", :rpp => 1).first.text
+
+Certain methods require authentication. To get your Twitter OAuth credentials,
+register an app at http://dev.twitter.com/apps
+
+    Twitter.configure do |config|
+      config.consumer_key = YOUR_CONSUMER_KEY
+      config.consumer_secret = YOUR_CONSUMER_SECRET
+      config.oauth_token = YOUR_OAUTH_TOKEN
+      config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
+    end
+Update your status
+
+    Twitter.update("I'm tweeting with @gem!")
+Read the most recent Tweet in your timeline
+
+    Twitter.home_timeline.first.text
+Get your rate limit status
+
+    Twitter.rate_limit_status.remaining_hits.to_s + " Twitter API request(s) remaining this hour"
+
+[sferik]: https://twitter.com/sferik
+[justinbieber]: https://twitter.com/justinbieber
+
+## <a name="proxy"></a>Configuration for API Proxy Services
+Use of API proxy services, like [Apigee](http://apigee.com), can be used to
+attain higher rate limits to the Twitter API.
+
+    Twitter.gateway = YOUR_GATEWAY_HOSTNAME # e.g 'twitter.apigee.com'
+
+## <a name="contributing"></a>Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help improve
+this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+* [financially][]
+
+[issues]: https://github.com/jnunemaker/twitter/issues
+[financially]: http://pledgie.com/campaigns/1193
+
+All contributors will be added to the [history][] and will receive the respect
+and gratitude of the community.
+
+[history]: https://github.com/jnunemaker/twitter/blob/master/HISTORY.md
+
+## <a name="issues"></a>Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. You can indicate support for an existing issue by
+voting it up. When submitting a bug report, please include a [gist][] that
+includes a stack trace and any details that may be necessary to reproduce the
+bug, including your gem version, Ruby version, and operating system. Ideally, a
+bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## <a name="pulls"></a>Submitting a Pull Request
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run `bundle exec rake yard`. If your changes are not 100% documented, go
+   back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run `bundle exec rake spec`. If your changes are not 100% covered, go back
+   to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec,
+   version, or history file. (If you want to create your own version for some
+   reason, please do so in a separate commit.)
+
+## <a name="versions"></a>Supported Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby
+implementations:
+
+* Ruby 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+* [JRuby][]
+* [Rubinius][]
+* [Ruby Enterprise Edition][ree]
+
+[jruby]: http://www.jruby.org/
+[rubinius]: http://rubini.us/
+[ree]: http://www.rubyenterpriseedition.com/
+
+If something doesn't work on one of these interpreters, it should be considered
+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.
+
+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 personally 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.
+
+## <a name="copyright"></a>Copyright
+Copyright (c) 2011 John Nunemaker, Wynn Netherland, Erik Michaels-Ober, Steve Richert.
+See [LICENSE][] for details.
+
+[license]: https://github.com/jnunemaker/twitter/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/twitter.rb

@@ -0,0 +1,24 @@
+require 'twitter/client'
+require 'twitter/config'
+
+module Twitter
+  extend Config
+  class << self
+    # Alias for Twitter::Client.new
+    #
+    # @return [Twitter::Client]
+    def new(options={})
+      Twitter::Client.new(options)
+    end
+
+    # Delegate to Twitter::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/twitter/action.rb

@@ -0,0 +1,9 @@
+require 'twitter/base'
+require 'twitter/creatable'
+
+module Twitter
+  class Action < Twitter::Base
+    include Twitter::Creatable
+    lazy_attr_reader :max_position, :min_position
+  end
+end

data/lib/twitter/action_factory.rb

@@ -0,0 +1,28 @@
+require 'twitter/favorite'
+require 'twitter/follow'
+require 'twitter/list_member_added'
+require 'twitter/mention'
+require 'twitter/reply'
+require 'twitter/retweet'
+
+require 'active_support/core_ext/string/inflections'
+
+module Twitter
+  class ActionFactory
+
+    # Instantiates a new action object
+    #
+    # @param attrs [Hash]
+    # @raise [ArgumentError] Error raised when supplied argument is missing an 'action' key.
+    # @return [Twitter::Favorite, Twitter::Follow, Twitter::ListMemberAdded, Twitter::Mention, Twitter::Reply, Twitter::Retweet]
+    def self.new(action={})
+      type = action.delete('action')
+      if type
+        Twitter.const_get(type.camelize.to_sym).new(action)
+      else
+        raise ArgumentError, "argument must have an 'action' key"
+      end
+    end
+
+  end
+end

data/lib/twitter/authenticatable.rb

@@ -0,0 +1,24 @@
+module Twitter
+  module Authenticatable
+
+    # Credentials hash
+    #
+    # @return [Hash]
+    def credentials
+      {
+        :consumer_key => consumer_key,
+        :consumer_secret => consumer_secret,
+        :token => oauth_token,
+        :token_secret => oauth_token_secret,
+      }
+    end
+
+    # Check whether credentials are present
+    #
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+  end
+end

data/lib/twitter/base.rb

@@ -0,0 +1,40 @@
+module Twitter
+  class Base
+    attr_accessor :attrs
+    alias :to_hash :attrs
+
+    # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
+    #
+    # @overload self.lazy_attr_reader(attr)
+    #   @param attr [Symbol]
+    # @overload self.lazy_attr_reader(attrs)
+    #   @param attrs [Array<Symbol>]
+    def self.lazy_attr_reader(*attrs)
+      attrs.each do |attribute|
+        class_eval do
+          define_method attribute do
+            @attrs[attribute.to_s]
+          end
+        end
+      end
+    end
+
+    # Initializes a new Base object
+    #
+    # @param attrs [Hash]
+    # @return [Twitter::Base]
+    def initialize(attrs={})
+      @attrs = attrs.dup
+    end
+
+    # Initializes a new Base object
+    #
+    # @param method [String, Symbol] Message to send to the object
+    def [](method)
+      self.__send__(method.to_sym)
+    rescue NoMethodError
+      nil
+    end
+
+  end
+end

data/lib/twitter/client.rb

@@ -0,0 +1,126 @@
+require 'twitter/authenticatable'
+require 'twitter/config'
+require 'twitter/configuration'
+require 'twitter/connection'
+require 'twitter/cursor'
+require 'twitter/direct_message'
+require 'twitter/language'
+require 'twitter/list'
+require 'twitter/favorite'
+require 'twitter/follow'
+require 'twitter/mention'
+require 'twitter/metadata'
+require 'twitter/oembed'
+require 'twitter/photo'
+require 'twitter/place'
+require 'twitter/point'
+require 'twitter/polygon'
+require 'twitter/rate_limit_status'
+require 'twitter/relationship'
+require 'twitter/reply'
+require 'twitter/request'
+require 'twitter/retweet'
+require 'twitter/saved_search'
+require 'twitter/settings'
+require 'twitter/size'
+require 'twitter/status'
+require 'twitter/suggestion'
+require 'twitter/trend'
+require 'twitter/user'
+
+module Twitter
+  # Wrapper for the Twitter REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in {http://dev.twitter.com/doc the Twitter API Documentation}.
+  # @see http://dev.twitter.com/pages/every_developer
+  class Client
+
+    include Twitter::Authenticatable
+    include Twitter::Connection
+    include Twitter::Request
+
+    require 'twitter/client/accounts'
+    include Twitter::Client::Accounts
+
+    require 'twitter/client/activity'
+    include Twitter::Client::Activity
+
+    require 'twitter/client/block'
+    include Twitter::Client::Block
+
+    require 'twitter/client/direct_messages'
+    include Twitter::Client::DirectMessages
+
+    require 'twitter/client/favorites'
+    include Twitter::Client::Favorites
+
+    require 'twitter/client/friends_and_followers'
+    include Twitter::Client::FriendsAndFollowers
+
+    require 'twitter/client/help'
+    include Twitter::Client::Help
+
+    require 'twitter/client/legal'
+    include Twitter::Client::Legal
+
+    require 'twitter/client/lists'
+    include Twitter::Client::Lists
+
+    require 'twitter/client/local_trends'
+    include Twitter::Client::LocalTrends
+
+    require 'twitter/client/notification'
+    include Twitter::Client::Notification
+
+    require 'twitter/client/places_and_geo'
+    include Twitter::Client::PlacesAndGeo
+
+    require 'twitter/client/saved_searches'
+    include Twitter::Client::SavedSearches
+
+    require 'twitter/client/search'
+    include Twitter::Client::Search
+
+    require 'twitter/client/spam_reporting'
+    include Twitter::Client::SpamReporting
+
+    require 'twitter/client/suggested_users'
+    include Twitter::Client::SuggestedUsers
+
+    require 'twitter/client/timelines'
+    include Twitter::Client::Timelines
+
+    require 'twitter/client/trends'
+    include Twitter::Client::Trends
+
+    require 'twitter/client/tweets'
+    include Twitter::Client::Tweets
+
+    require 'twitter/client/urls'
+    include Twitter::Client::Urls
+
+    require 'twitter/client/users'
+    include Twitter::Client::Users
+
+    attr_accessor *Config::VALID_OPTIONS_KEYS
+
+    # Initializes a new API object
+    #
+    # @param attrs [Hash]
+    # @return [Twitter::Client]
+    def initialize(attrs={})
+      attrs = Twitter.options.merge(attrs)
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        instance_variable_set("@#{key}".to_sym, attrs[key])
+      end
+    end
+
+    # Returns the configured screen name or the screen name of the authenticated user
+    #
+    # @return [Twitter::User]
+    def current_user
+      @current_user ||= Twitter::User.new(self.verify_credentials)
+    end
+
+  end
+end