oauth_twitter 0.2.2 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWRkMTExYThmN2UzMzI3NTQ1MTk3YTRmZTExNDA2ODRlZTE3MzkzNQ==
-  data.tar.gz: !binary |-
-    ODdmNDdlNzYyNWFjOWM2MDliYjUxMGQ0NzNmY2ZlYzExZTIxOWRhOQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MWE1YmY5MWI1NjdjZjQ0NmExOTMxMGE0ZGI0N2ZkMWQxNmI2OWRmOTM0MGU0
-    NzdlNDdhNDNkNGUyMzJmYzBmNDdhZDQ0YzI0NDY0MDJkYTYzZGZkNmE3OTA1
-    YmFjMWE3NjFmNjVlZDNhYWMyZmFjMTI3ZWUxYzBhNTIzYTE3NDQ=
-  data.tar.gz: !binary |-
-    YjIxNWE4Zjc3ZTM2N2ViODRmYWE0MDIzODEwZjI2YTdlNGQ0Yjc5YzdmNWU3
-    YzYyMDJhZDZiNDFjZDQ5ZTc0ODgxYTkyNDk1YWNkZjE5OTYyOTJmZDc2ZjYy
-    MjVhYzdiYTNkYzY2OGZlZTljOWY2YzRiODk4MjFhYmEyMDljODg=
+SHA1:
+  metadata.gz: b1b8c63a971cd6a4d61293f511956d2057300e45
+  data.tar.gz: 1cb8fb868660669faa0d3b8793bed7ed18d31fe5
+SHA512:
+  metadata.gz: 939af0a3d243ba9afc19631e7f557c17a3a8b0ed13d535c0e8020d0daa55bc976aebce63c600705b97b0ecf8f73ff77a8d9c8a3e5055bc52c5eeb7766017d528
+  data.tar.gz: c82ef4319da355a0633bbef4abe4ae31aeb28467de35b5b233fa1cb2992e913fc8b9ddceb7976a59a423e75a007c1614397d3fcd23d74b6f80604358529129b6

data/lib/oauth_twitter/api/application.rb

@@ -6,10 +6,7 @@ module OauthTwitter
       }
 
       def rate_limit_status(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:rate_limit_status], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:rate_limit_status], params, true, options)
       end
 
     end

data/lib/oauth_twitter/api/friends.rb

@@ -17,87 +17,51 @@ module OauthTwitter
       }
 
       def friendships_no_retweets_ids(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:friendships_no_retweets_ids], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friendships_no_retweets_ids], params, true, options)
       end
 
       def friends_ids(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:friends_ids], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friends_ids], params, true, options)
       end
 
       def followers_ids(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:followers_ids], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:followers_ids], params, true, options)
       end
 
       def friendships_lookup(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:friendships_lookup], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friendships_lookup], params, true, options)
       end
 
       def friendships_incoming(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:friendships_incoming], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friendships_incoming], params, true, options)
       end
 
       def friendships_outgoing(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:friendships_outgoing], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friendships_outgoing], params, true, options)
       end
 
       def friendships_create(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:POST, PATH[:friendships_create], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friendships_create], params, true, options)
       end
 
       def friendships_destroy(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:POST, PATH[:friendships_destroy], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friendships_destroy], params, true, options)
       end
 
       def friendships_update(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:POST, PATH[:friendships_update], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friendships_update], params, true, options)
       end
 
       def friendships_show(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:friendships_show], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friendships_show], params, true, options)
       end
 
       def friends_list(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:friends_list], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:friends_list], params, true, options)
       end
 
       def followers_list(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:followers_list], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:followers_list], params, true, options)
       end
 
     end

data/lib/oauth_twitter/api/oauth.rb

@@ -9,31 +9,20 @@ module OauthTwitter
       }
 
       def oauth_authenticate(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:oauth_authenticate], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:oauth_authenticate], params, true, options)
       end
 
       def oauth_authorize(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:oauth_authorize], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:oauth_authorize], params, true, options)
       end
 
       def oauth_access_token(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:POST, PATH[:oauth_access_token], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:POST, PATH[:oauth_access_token], params, true, options)
       end
 
       def oauth_request_token(params={}, options={})
         callback_url = params[:oauth_callback] || Config.oauth_callback
-        oauth = oauth_params(false, {oauth_callback: callback_url})
-        response = send_request(:POST, PATH[:oauth_request_token], nil, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:POST, PATH[:oauth_request_token], {}, [false, {:oauth_callback => callback_url}], options)
       end
 
     end

data/lib/oauth_twitter/api/statuses.rb

@@ -43,13 +43,9 @@ module OauthTwitter
       #   if count = 5, pages = 3, then it will return 5 * 3 = 15 tweets
       #   from the user's timeline. Cursor stops if response no more reponse.
       #
-      #   :explain_error => [Bool] if true, will return a HTTP Code indicate
-      #   the error
+      #   :detailed => [Bool] if false, will return just the data
       #
       # @return [Array] hash structured the same as Twitter's JSON response.
-      #
-      #   if :explain_error => true, will return array like:
-      #   [json, response.body, response.code]
       def home_timeline(params={}, options={})
         query = params.clone
         return send_status_request(:home_timeline, query, options)
@@ -70,14 +66,13 @@ module OauthTwitter
         response = nil
         options[:pages] ||= 1
         options[:pages].times do |page_num|
-          oauth = oauth_params(true)
-          response = send_request(:GET, PATH[api_symbol], query, oauth)
-          break unless response[0]
-          break if response[1].empty?
-          full_response += response[1]
-          query[:max_id] = response[1].last['id'] - 1
+          response = send_request(:GET, PATH[api_symbol], query, true, options)
+          break unless response[:valid]
+          break if response[:data].empty?
+          full_response += response[:data]
+          query[:max_id] = response[:data].last['id'] - 1
         end
-        return results_with_error_explained(response, options, full_response)
+        return assemble_multi_page_response(full_response, response, options)
       end
 
     end

data/lib/oauth_twitter/api/users.rb

@@ -17,62 +17,48 @@ module OauthTwitter
         query = params.clone
         users_array = query[:screen_name] || query[:user_id]
         users_array_type = (query[:screen_name]) ? :screen_name : :user_id
+
         # slice id_array for multiple request
         num_of_set = users_array.size / 100
         num_of_set += 1 if users_array.size % 100 > 0
         id_sets = num_of_set.times.map {|i| users_array.slice(i*100, (i+1)*100)}
+
         # send request
         full_response = []
         response = nil
         id_sets.each do |set|
-          oauth = oauth_params(true)
           query[users_array_type] = set.join(',')
           method = set.size <= 10 ? :GET : :POST
-          response = send_request(method, PATH[:users_lookup], query, oauth)
-          if response[0]
-            full_response += response[1]
+          response = send_request(method, PATH[:users_lookup], query, true)
+          if response[:valid]
+            full_response += response[:data]
           else
             break
           end
         end
-        return results_with_error_explained(response, options, full_response)
+
+        # return
+        return assemble_multi_page_response(full_response, response, options)
       end
 
       def users_show(params, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:users_show], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:users_show], params, true, options)
       end
 
       def users_search(params, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:users_search], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:users_search], params, true, options)
       end
 
       def users_contributees(params, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:users_contributees], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:users_contributees], params, true, options)
       end
 
       def users_contributors(params, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:users_contributors], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:users_contributors], params, true, options)
       end
 
-      ##
-      #
       def users_profile_banner(params={}, options={})
-        query = params.clone
-        oauth = oauth_params(true)
-        response = send_request(:GET, PATH[:users_profile_banner], query, oauth)
-        return results_with_error_explained(response, options)
+        return send_request(:GET, PATH[:users_profile_banner], params, true, options)
       end
 
     end

data/lib/oauth_twitter/helper.rb

@@ -7,10 +7,69 @@ require "multi_json"
 
 module OauthTwitter
   module Helper
+    ##
+    # Twitter API root url
+    HOST = "https://api.twitter.com"
+
+    ##
+    # Package data and send oauth request
+    #
+    # oauth = true : true - include oauth token
+    #                false - do not include oauth token
+    #                [false, {hash}] - include additional params
+    #
+    # options = {} : :detailed => fasle - return false if request failed,
+    #                    otherwise return just data
+    # --------------------------------------------------
+    def send_request(method, path, original_query, oauth=true, options={})
+      # generate signing key
+      signing_key_array = [ Config.consumer_secret ]
+
+      # generate oauth params
+      if !!oauth === oauth # boolean
+        oauth_params = generate_oauth_params(oauth)
+        signing_key_array.push((oauth ? self.oauth_token_secret : '' ))
+      else
+        oauth_params = generate_oauth_params(oauth[0], oauth[1])
+        signing_key_array.push((oauth[0] ? self.oauth_token_secret : '' ))
+      end
+
+      # filter out value == nil
+      query = original_query.select {|key, value| !value.nil?}
+
+      # generate base string
+      base_array = [ method.to_s.upcase, URI.encode_www_form_component(HOST + path), URI.encode_www_form_component(URI.encode_www_form((query ? oauth_params.merge(query) : oauth_params).sort)) ]
+
+      # generate signature
+      oauth_params[:oauth_signature] = sign(base_array, signing_key_array)
+
+      # generate HTTP request
+      uri = URI.parse(HOST + path)
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      if method.to_s.upcase === 'GET'
+        uri.query = URI.encode_www_form(query) if query
+        request = Net::HTTP::Get.new(uri.request_uri)
+      elsif method.to_s.upcase === 'POST'
+        request = Net::HTTP::Post.new(uri.request_uri)
+        request.set_form_data(query) if query
+      end
+      request["Authorization"] = generate_oauth_header(oauth_params)
+
+      # retrive response
+      return parse_response(https.request(request), options)
+    end
+
+
+    # Protected
+    # ==================================================
+    protected
 
     ##
     # Generate oauth params
-    def oauth_params(include_oauth_token=true, addional_oauth_params={})
+    #
+    # --------------------------------------------------
+    def generate_oauth_params(include_oauth_token=true, addional_oauth_params={})
       oauth = {
         :oauth_consumer_key     => Config.consumer_key,
         :oauth_nonce            => SecureRandom.hex(21),
@@ -18,101 +77,71 @@ module OauthTwitter
         :oauth_timestamp        => Time.now.to_i,
         :oauth_version          => "1.0"
       }
-      oauth[:oauth_token] = self.oauth_token if include_oauth_token == true
+      oauth[:oauth_token] = self.oauth_token if include_oauth_token === true
       return oauth.merge(addional_oauth_params)
     end
 
     ##
-    # percent_encode disallowed char
-    RESERVED_CHARS = /[^a-zA-Z0-9\-\.\_\~]/
-
-    ##
-    # percent_encode strigns
-    def self.percent_encode(raw)
-      return URI.escape(raw.to_s, RESERVED_CHARS)
+    # Sign oauth params
+    #
+    # --------------------------------------------------
+    def sign(base_array, signing_key_array)
+      hex_str = OpenSSL::HMAC.hexdigest( OpenSSL::Digest::Digest.new('sha1'), signing_key_array.join('&'), base_array.join('&') )
+      binary_str = Base64.encode64( [hex_str].pack("H*") ).gsub(/\n/, "")
+      return URI.encode_www_form_component(binary_str)
     end
 
     ##
-    # Twitter API root url
-    HOST = "https://api.twitter.com"
+    # Generate header message for HTTP request
+    #
+    # --------------------------------------------------
+    def generate_oauth_header(signed_oauth)
+      return "OAuth " << signed_oauth.map {|key, val| "#{key}=\"#{val}\""}.join(",")
+    end
 
     ##
-    # Helper method to send request to Twitter API
-    # @param method [Symbol] HTTP method, support :GET or :POST
-    # @param path [String] request url path
-    # @param query [Hash] request parameters
-    # @param oauth [Hash] oauth request header
+    # Parse response for cleaner outputs
     #
-    # @return [Array] 0: indicate successful or not, 1: response content,
-    #   2: error messages if any
-    def send_request(method, path, query, oauth)
-      # Make base_str and signing_key
-      base_str = method.to_s.upcase << "&"
-      base_str << Helper.percent_encode(HOST + path) << "&"
-      hash = query ? oauth.merge(query) : oauth
-      array = hash.sort.map {|key, val| Helper.percent_encode(key) + "=" + Helper.percent_encode(val)}
-      base_str << Helper.percent_encode(array.join("&"))
-      # Sign
-      signing_key = String.new(Config.consumer_secret) << "&"
-      signing_key << self.oauth_token_secret if hash[:oauth_token]
-      signature = Helper.sign(base_str, signing_key)
-      signed_oauth = oauth.merge(:oauth_signature => signature)
-      # Header
-      auth_header = Helper.auth_header(signed_oauth)
-      # HTTP request
-      uri = URI.parse(HOST + path)
-      https = Net::HTTP.new(uri.host, uri.port)
-      https.use_ssl = true
-      case
-      when method.to_s.upcase == "POST"
-        request = Net::HTTP::Post.new(uri.request_uri)
-        request.set_form_data(query) if query
-      when method.to_s.upcase == "GET"
-        uri.query = URI.encode_www_form(query) if query
-        request = Net::HTTP::Get.new(uri.request_uri)
-      end
-      request["Authorization"] = auth_header
-      ##
-      # Might raise SocketError if no internet connection
-      response = https.request(request)
-      case response.code
-      when "200"
+    # --------------------------------------------------
+    def parse_response(response, options={})
+      result = {}
+      begin
+        result[:data] = MultiJson.load(response.body)
+      rescue MultiJson::LoadError
         begin
-          return true, MultiJson.load(response.body)
-        rescue MultiJson::LoadError
-          return true, Rack::Utils.parse_nested_query(response.body)
+          result[:data] = Hash[URI.decode_www_form(response.body)]
+        rescue ArgumentError
+          result[:data] = response.body
         end
+      end
+
+      if options[:detailed] === false
+        return result[:data] if response.code === '200'
+        return nil
       else
-        return false, MultiJson.load(response.body), response.code
+        result[:valid] = response.code === '200' ? true : false
+        result[:code] = response.code.to_i
+        return result
       end
     end
 
     ##
-    # Sign oauth params
-    def self.sign(base_str, signing_key)
-      hex_str = OpenSSL::HMAC.hexdigest(
-        OpenSSL::Digest::Digest.new('sha1'),
-        signing_key,
-        base_str)
-      binary_str = Base64.encode64( [hex_str].pack("H*") ).gsub(/\n/, "")
-      return Helper.percent_encode( binary_str )
-    end
-
-    def self.auth_header(signed_oauth)
-      params = signed_oauth.map { |key, val| "#{key}=\"#{val}\"" }
-      return "OAuth " << params.join(",")
-    end
-
-    def results_with_error_explained(response, options, full_response=nil)
-      if full_response && options[:explain_error] == true
-        return response[0] ? [response[0], full_response] : (response + [full_response])
-      elsif full_response
-        return full_response
-      elsif options[:explain_error] == true
-        return response
+    # Asseble multi page response
+    #
+    # --------------------------------------------------
+    def assemble_multi_page_response(full_response, last_response, options={})
+      if options[:detailed] === false
+        result = last_response[:valid] ? full_response : last_response[:data]
       else
-        return response[0] ? response[1] : false
+        result = {
+          :valid => last_response[:valid],
+          :code  => last_response[:code],
+          :data  => full_response
+        }
+        result[:message] = last_response[:data] unless last_response[:valid]
       end
+
+      return result
     end
 
   end

data/lib/oauth_twitter/version.rb

@@ -1,3 +1,3 @@
 module OauthTwitter
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth_twitter
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Daiwei Lu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-01 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,28 +28,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.5
 - !ruby/object:Gem::Dependency
@@ -99,12 +99,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -114,4 +114,3 @@ signing_key:
 specification_version: 4
 summary: Load data from Twitter API
 test_files: []
-has_rdoc: