consumer_test.rb 14.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
require File.expand_path('../../test_helper', __FILE__)

module Integration
  class ConsumerTest < Test::Unit::TestCase
    def setup
      @consumer=OAuth::Consumer.new(
          'consumer_key_86cad9', '5888bf0345e5d237',
          {
          :site=>"http://blabla.bla",
          :proxy=>"http://user:password@proxy.bla:8080",
          :request_token_path=>"/oauth/example/request_token.php",
          :access_token_path=>"/oauth/example/access_token.php",
          :authorize_path=>"/oauth/example/authorize.php",
          :scheme=>:header,
          :http_method=>:get
          })
      @token = OAuth::ConsumerToken.new(@consumer,'token_411a7f', '3196ffd991c8ebdb')
      @request_uri = URI.parse('http://example.com/test?key=value')
      @request_parameters = { 'key' => 'value' }
      @nonce = 225579211881198842005988698334675835446
      @timestamp = "1199645624"
      @consumer.http=Net::HTTP.new(@request_uri.host, @request_uri.port)
    end

    def test_that_signing_auth_headers_on_get_requests_works
      request = Net::HTTP::Get.new(@request_uri.path + "?" + request_parameters_to_s)
      @token.sign!(request, {:nonce => @nonce, :timestamp => @timestamp})

      assert_equal 'GET', request.method
      assert_equal '/test?key=value', request.path
      assert_equal "OAuth oauth_nonce=\"225579211881198842005988698334675835446\", oauth_signature_method=\"HMAC-SHA1\", oauth_token=\"token_411a7f\", oauth_timestamp=\"1199645624\", oauth_consumer_key=\"consumer_key_86cad9\", oauth_signature=\"1oO2izFav1GP4kEH2EskwXkCRFg%3D\", oauth_version=\"1.0\"".delete(',').split.sort, request['authorization'].delete(',').split.sort
    end

    def test_that_setting_signature_method_on_consumer_effects_signing
      require 'oauth/signature/plaintext'
      request = Net::HTTP::Get.new(@request_uri.path)
      consumer = @consumer.dup
      consumer.options[:signature_method] = 'PLAINTEXT'
      token = OAuth::ConsumerToken.new(consumer, 'token_411a7f', '3196ffd991c8ebdb')
      token.sign!(request, {:nonce => @nonce, :timestamp => @timestamp})

      assert_no_match( /oauth_signature_method="HMAC-SHA1"/, request['authorization'])
      assert_match(    /oauth_signature_method="PLAINTEXT"/, request['authorization'])
    end

    def test_that_setting_signature_method_on_consumer_effects_signature_base_string
      require 'oauth/signature/plaintext'
      request = Net::HTTP::Get.new(@request_uri.path)
      consumer = @consumer.dup
      consumer.options[:signature_method] = 'PLAINTEXT'

      request = Net::HTTP::Get.new('/')
      signature_base_string = consumer.signature_base_string(request)

      assert_no_match( /HMAC-SHA1/, signature_base_string)
      assert_equal( "#{consumer.secret}&", signature_base_string)
    end

    def test_that_plaintext_signature_works
      # Invalid test because server expects double-escaped signature
      require 'oauth/signature/plaintext'
      # consumer = OAuth::Consumer.new("key", "secret",
      #   :site => "http://term.ie", :signature_method => 'PLAINTEXT')
      # access_token = OAuth::AccessToken.new(consumer, 'accesskey', 'accesssecret')
      # response = access_token.get("/oauth/example/echo_api.php?echo=hello")

      # assert_equal 'echo=hello', response.body
    end

    def test_that_signing_auth_headers_on_post_requests_works
      request = Net::HTTP::Post.new(@request_uri.path)
      request.set_form_data( @request_parameters )
      @token.sign!(request, {:nonce => @nonce, :timestamp => @timestamp})
  #    assert_equal "",request.oauth_helper.signature_base_string

      assert_equal 'POST', request.method
      assert_equal '/test', request.path
      assert_equal 'key=value', request.body
      assert_equal "OAuth oauth_nonce=\"225579211881198842005988698334675835446\", oauth_signature_method=\"HMAC-SHA1\", oauth_token=\"token_411a7f\", oauth_timestamp=\"1199645624\", oauth_consumer_key=\"consumer_key_86cad9\", oauth_signature=\"26g7wHTtNO6ZWJaLltcueppHYiI%3D\", oauth_version=\"1.0\"".delete(',').split.sort, request['authorization'].delete(',').split.sort
    end

    def test_that_signing_post_params_works
      request = Net::HTTP::Post.new(@request_uri.path)
      request.set_form_data( @request_parameters )
      @token.sign!(request, {:scheme => 'body', :nonce => @nonce, :timestamp => @timestamp})

      assert_equal 'POST', request.method
      assert_equal '/test', request.path
89
      assert_match /key=value&oauth_consumer_key=consumer_key_86cad9&oauth_nonce=225579211881198842005988698334675835446&oauth_signature=26g7wHTtNO6ZWJaLltcueppHYiI%3[Dd]&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1199645624&oauth_token=token_411a7f&oauth_version=1.0/, request.body.split("&").sort.join("&")
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
      assert_equal nil, request['authorization']
    end

    def test_that_using_auth_headers_on_get_on_create_signed_requests_works
      request=@consumer.create_signed_request(:get,@request_uri.path+ "?" + request_parameters_to_s,@token,{:nonce => @nonce, :timestamp => @timestamp},@request_parameters)

      assert_equal 'GET', request.method
      assert_equal '/test?key=value', request.path
      assert_equal "OAuth oauth_nonce=\"225579211881198842005988698334675835446\", oauth_signature_method=\"HMAC-SHA1\", oauth_token=\"token_411a7f\", oauth_timestamp=\"1199645624\", oauth_consumer_key=\"consumer_key_86cad9\", oauth_signature=\"1oO2izFav1GP4kEH2EskwXkCRFg%3D\", oauth_version=\"1.0\"".delete(',').split.sort, request['authorization'].delete(',').split.sort
    end

    def test_that_using_auth_headers_on_post_on_create_signed_requests_works
      request=@consumer.create_signed_request(:post,@request_uri.path,@token,{:nonce => @nonce, :timestamp => @timestamp},@request_parameters,{})
      assert_equal 'POST', request.method
      assert_equal '/test', request.path
      assert_equal 'key=value', request.body
      assert_equal "OAuth oauth_nonce=\"225579211881198842005988698334675835446\", oauth_signature_method=\"HMAC-SHA1\", oauth_token=\"token_411a7f\", oauth_timestamp=\"1199645624\", oauth_consumer_key=\"consumer_key_86cad9\", oauth_signature=\"26g7wHTtNO6ZWJaLltcueppHYiI%3D\", oauth_version=\"1.0\"".delete(',').split.sort, request['authorization'].delete(',').split.sort
    end

    def test_that_signing_post_params_works_2
      request=@consumer.create_signed_request(:post,@request_uri.path,@token,{:scheme => 'body', :nonce => @nonce, :timestamp => @timestamp},@request_parameters,{})

      assert_equal 'POST', request.method
      assert_equal '/test', request.path
114
      assert_match /key=value&oauth_consumer_key=consumer_key_86cad9&oauth_nonce=225579211881198842005988698334675835446&oauth_signature=26g7wHTtNO6ZWJaLltcueppHYiI%3[Dd]&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1199645624&oauth_token=token_411a7f&oauth_version=1.0/, request.body.split("&").sort.join("&")
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
      assert_equal nil, request['authorization']
    end

    def test_step_by_step_token_request
      stub_test_ie

      @consumer=OAuth::Consumer.new(
          "key",
          "secret",
          {
          :site=>"http://term.ie",
          :request_token_path=>"/oauth/example/request_token.php",
          :access_token_path=>"/oauth/example/access_token.php",
          :authorize_path=>"/oauth/example/authorize.php",
          :scheme=>:header
          })
      options={:nonce=>'nonce',:timestamp=>Time.now.to_i.to_s}

      request = Net::HTTP::Get.new("/oauth/example/request_token.php")
      signature_base_string=@consumer.signature_base_string(request,nil,options)
      assert_equal "GET&http%3A%2F%2Fterm.ie%2Foauth%2Fexample%2Frequest_token.php&oauth_consumer_key%3Dkey%26oauth_nonce%3D#{options[:nonce]}%26oauth_signature_method%3DHMAC-SHA1%26oauth_timestamp%3D#{options[:timestamp]}%26oauth_version%3D1.0",signature_base_string
      @consumer.sign!(request, nil,options)

      assert_equal 'GET', request.method
      assert_equal nil, request.body
      response=@consumer.http.request(request)
      assert_equal "200",response.code
      assert_equal "oauth_token=requestkey&oauth_token_secret=requestsecret",response.body
    end

    def test_get_token_sequence
      stub_test_ie

      @consumer=OAuth::Consumer.new(
          "key",
          "secret",
          {
          :site=>"http://term.ie",
          :request_token_path=>"/oauth/example/request_token.php",
          :access_token_path=>"/oauth/example/access_token.php",
          :authorize_path=>"/oauth/example/authorize.php"
          })
      assert_equal "http://term.ie/oauth/example/request_token.php",@consumer.request_token_url
      assert_equal "http://term.ie/oauth/example/access_token.php",@consumer.access_token_url

      assert !@consumer.request_token_url?, "Should not use fully qualified request token url"
      assert !@consumer.access_token_url?, "Should not use fully qualified access token url"
      assert !@consumer.authorize_url?, "Should not use fully qualified url"

      @request_token=@consumer.get_request_token
      assert_not_nil @request_token
      assert_equal "requestkey",@request_token.token
      assert_equal "requestsecret",@request_token.secret
      assert_equal "http://term.ie/oauth/example/authorize.php?oauth_token=requestkey",@request_token.authorize_url

      @access_token=@request_token.get_access_token
      assert_not_nil @access_token
      assert_equal "accesskey",@access_token.token
      assert_equal "accesssecret",@access_token.secret

      @response=@access_token.get("/oauth/example/echo_api.php?ok=hello&test=this")
      assert_not_nil @response
      assert_equal "200",@response.code
      assert_equal( "ok=hello&test=this",@response.body)

      @response=@access_token.post("/oauth/example/echo_api.php",{'ok'=>'hello','test'=>'this'})
      assert_not_nil @response
      assert_equal "200",@response.code
      assert_equal( "ok=hello&test=this",@response.body)
    end

    def test_get_token_sequence_using_fqdn
      stub_test_ie

      @consumer=OAuth::Consumer.new(
          "key",
          "secret",
          {
          :site=>"http://term.ie",
          :request_token_url=>"http://term.ie/oauth/example/request_token.php",
          :access_token_url=>"http://term.ie/oauth/example/access_token.php",
          :authorize_url=>"http://term.ie/oauth/example/authorize.php"
          })
      assert_equal "http://term.ie/oauth/example/request_token.php",@consumer.request_token_url
      assert_equal "http://term.ie/oauth/example/access_token.php",@consumer.access_token_url

      assert @consumer.request_token_url?, "Should use fully qualified request token url"
      assert @consumer.access_token_url?, "Should use fully qualified access token url"
      assert @consumer.authorize_url?, "Should use fully qualified url"

      @request_token=@consumer.get_request_token
      assert_not_nil @request_token
      assert_equal "requestkey",@request_token.token
      assert_equal "requestsecret",@request_token.secret
      assert_equal "http://term.ie/oauth/example/authorize.php?oauth_token=requestkey",@request_token.authorize_url

      @access_token=@request_token.get_access_token
      assert_not_nil @access_token
      assert_equal "accesskey",@access_token.token
      assert_equal "accesssecret",@access_token.secret

      @response=@access_token.get("/oauth/example/echo_api.php?ok=hello&test=this")
      assert_not_nil @response
      assert_equal "200",@response.code
      assert_equal( "ok=hello&test=this",@response.body)

      @response=@access_token.post("/oauth/example/echo_api.php",{'ok'=>'hello','test'=>'this'})
      assert_not_nil @response
      assert_equal "200",@response.code
      assert_equal( "ok=hello&test=this",@response.body)
    end


    # This test does an actual https request (the result doesn't matter)
    # to initialize the same way as get_request_token does. Can be any
    # site that supports https.
    #
    # It also generates "warning: using default DH parameters." which I
    # don't know how to get rid of
  #  def test_serialization_with_https
  #    consumer = OAuth::Consumer.new('token', 'secret', :site => 'https://plazes.net')
  #    consumer.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
  #    consumer.http.get('/')
  #
  #    assert_nothing_raised do
  #      # Specifically this should not raise TypeError: no marshal_dump
  #      # is defined for class OpenSSL::SSL::SSLContext
  #      Marshal.dump(consumer)
  #    end
  #  end
  #
    def test_get_request_token_with_custom_arguments
      stub_test_ie

      @consumer=OAuth::Consumer.new(
          "key",
          "secret",
          {
          :site=>"http://term.ie",
          :request_token_path=>"/oauth/example/request_token.php",
          :access_token_path=>"/oauth/example/access_token.php",
          :authorize_path=>"/oauth/example/authorize.php"
          })

      @consumer.get_request_token({}, {:scope => "http://www.google.com/calendar/feeds http://picasaweb.google.com/data"})

      # Because this is a POST request, create_http_request should take the first element of *arguments
      # and turn it into URL-encoded data in the body of the POST.
    end

    def test_post_with_body_stream
      stub_test_ie

      @consumer=OAuth::Consumer.new(
          "key",
          "secret",
          {
          :site=>"http://term.ie",
          :request_token_path=>"/oauth/example/request_token.php",
          :access_token_path=>"/oauth/example/access_token.php",
          :authorize_path=>"/oauth/example/authorize.php"
          })


      @request_token=@consumer.get_request_token
      @access_token=@request_token.get_access_token

      request_body_string = "Hello, hello, hello"
      request_body_stream = StringIO.new( request_body_string )

      @response=@access_token.post("/oauth/example/echo_api.php",request_body_stream)
      assert_not_nil @response
      assert_equal "200",@response.code

      request_body_file = File.open(__FILE__)

      @response=@access_token.post("/oauth/example/echo_api.php",request_body_file)
      assert_not_nil @response
      assert_equal "200",@response.code

      # unfortunately I don't know of a way to test that the body data was received correctly since the test server at http://term.ie
      # echos back any non-oauth parameters but not the body.  However, this does test that the request is still correctly signed
      # (including the Content-Length header) and that the server received Content-Length bytes of body since it won't process the
      # request & respond until the full body length is received.
    end

    private

    def request_parameters_to_s
      @request_parameters.map { |k,v| "#{k}=#{v}" }.join("&")
    end
  end
end