moomerman-twitter_oauth 0.1.4 → 0.1.5

data/README.textile

@@ -0,0 +1,48 @@
+h1. Twitter OAuth client library for Ruby
+
+To make authorized requests with the client library you'll need to [create a Twitter OAuth Application](http://twitter.com/oauth_clients/new).
+
+See [sinitter](http://github.com/moomerman/sinitter/tree/master) for a full website integration example.
+
+h2. Unauthorized request example
+
+<pre><code>client = TwitterOAuth::Client.new  
+
+puts client.show('twitter')
+=> => {"status"=>{"truncated"=>false, "favorited"=>false, "text"=>"Update on service issues http://tinyurl.com/ca872j", "id"=>1357776683, "in_reply_to_user_id"=>nil, "in_reply_to_status_id"=>nil, "source"=>"<a href=\"http://twitterfeed.com\">twitterfeed</a>", "created_at"=>"Fri Mar 20 01:17:35 +0000 2009"}, "name"=>"Twitter", "profile_sidebar_fill_color"=>"CDFFFF", "profile_sidebar_border_color"=>"8a6447", "profile_background_tile"=>false, "profile_link_color"=>"0000ff", "url"=>"http://twitter.com", "favourites_count"=>0, "id"=>783214, "description"=>"Always wondering what everyone's doing.", "profile_text_color"=>"000000", "protected"=>false, "utc_offset"=>-28800, "screen_name"=>"twitter", "profile_background_color"=>"9ae4e8", "time_zone"=>"Pacific Time (US & Canada)", "followers_count"=>469150, "profile_background_image_url"=>"http://static.twitter.com/images/themes/theme1/bg.gif", "friends_count"=>30, "statuses_count"=>290, "location"=>"San Francisco, CA", "profile_image_url"=>"http://s3.amazonaws.com/twitter_production/profile_images/75075164/twitter_bird_profile_normal.png", "created_at"=>"Tue Feb 20 14:35:54 +0000 2007"}
+</code></pre>
+
+h2. Authorized request example
+
+<pre><code>TwitterOAuth::Client::CLIENT_KEY = 'YOUR-CONSUMER-KEY'  
+TwitterOAuth::Client::CLIENT_SECRET = 'YOUR-CONSUMER-SECRET'  
+
+client = TwitterOAuth::Client.new  
+request_token = client.request_token
+
+request_token.authorize_url
+=> http://twitter.com/oauth/authorize?oauth_token=TOKEN
+</code></pre>
+
+In your application your user would be redirected to Twitter to authorize the application at this point.  You'll need to store
+the request token (usually in the session) for later.
+
+<pre><code>access_token = client.authorize(
+  request_token.token,
+  request_token.secret
+)
+
+client.authorized?
+=> true
+
+client.update('checking out the twitter_oauth library') # sends a twitter status update
+</code></pre>
+
+Now if you keep hold of the access_token (usually in the database) for this user you won't need to re-authorize them next time.
+
+<pre><code>access_token = @user.access_token # assuming user ivar
+client = TwitterOAuth::Client.new(:token => access_token.token, :secret => access_token.secret)
+
+client.authorized?
+=> true
+</code></pre>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: moomerman-twitter_oauth
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Richard Taylor
@@ -41,10 +41,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README.md
+- README.textile
 - lib/twitter_oauth
 - lib/twitter_oauth.rb
-- lib/twitter_oauth/client.rb
 has_rdoc: false
 homepage: http://github.com/moomerman/twitter_oauth
 post_install_message: 

data/README.md

@@ -1,7 +0,0 @@
-= Twitter OAuth Client for Ruby
-
-TwitterOAuth::Client::CLIENT_KEY = 'xxxx'
-TwitterOAuth::Client::CLIENT_SECRET = 'xxxx'
-
-client = TwitterOAuth::Client.new
-puts client.show('moomerman')

data/lib/twitter_oauth/client.rb

@@ -1,63 +0,0 @@
-module TwitterOAuth
-  class Client
-  
-    def initialize(options = {})
-      @username = options[:username]
-      @token = options[:token]
-      @secret = options[:secret]
-    end
-  
-    def login(token, secret)
-      request_token = OAuth::RequestToken.new(
-        consumer, token, secret
-      )
-      @access_token = request_token.get_access_token
-      @token = @access_token.token
-      @secret = @access_token.secret
-      @access_token
-    end
-  
-    def show(username = @username)
-      oauth_response = access_token.get("/users/show/#{username}.json")
-      JSON.parse(oauth_response.body)
-    end
-  
-    def authorized?
-      oauth_response = access_token.get('/account/verify_credentials.json')
-      return oauth_response.class == Net::HTTPOK
-    end
-  
-    def friends
-      oauth_response = access_token.get('/statuses/friends_timeline.json')
-      JSON.parse(oauth_response.body)
-    end
-  
-    def update(message)
-      oauth_response = access_token.post('/statuses/update.json', :status => message)
-      JSON.parse(oauth_response.body)
-    end
-  
-    def message(user, text)
-      oauth_response = access_token.post('/direct_messages/new.format', :user => user, :text => text)
-      JSON.parse(oauth_response.body)
-    end
-    
-    def request_token
-      consumer.get_request_token
-    end
-    
-    private
-      def consumer
-        @consumer ||= OAuth::Consumer.new(
-          CLIENT_KEY,
-          CLIENT_SECRET,
-          { :site=>"http://twitter.com" }
-        )
-      end
-
-      def access_token
-        @access_token ||= OAuth::AccessToken.new(consumer, @token, @secret)
-      end
-  end
-end
-