Ruby


インストール

対応バージョン:Ruby >= 2.0

RubyでUnirestを使用するには、unirest gemをインストールしてください。

Shell
gem install unirest

インストール完了後は、Unirestを使用して簡単にリクエストを行うことができるようになります。

Ruby
require 'unirest'

response = Unirest.post API_URL,
  headers:{
    "X-RapidAPI-Key" => API_KEY,
    "Content-Type" => "application/x-www-form-urlencoded"
  },
  parameters:{
    "parameter" => "value"
  }

response.code # Status code
response.headers # Response headers
response.body # Parsed body
response.raw_body # Unparsed body
非同期リクエスト

Unirest-Rubyは、ブロック内で指定されたコールバック関数を使用した非同期リクエストもサポートしています。

Ruby
require 'unirest'

response = Unirest.post API_URL,
  headers:{
    "X-RapidAPI-Key" => API_KEY,
    "Content-Type" => "application/x-www-form-urlencoded"
  },
  parameters:{
    "parameter" => "value"
  } {|response|
    response.code # Status code
    response.headers # Response headers
    response.body # Parsed body
    response.raw_body # Unparsed body
  }
ファイルのアップロード
Ruby
require 'unirest'

response = Unirest.post API_URL,
  headers:{
    "X-RapidAPI-Key" => API_KEY
  },
  parameters:{
    "content" => File.new("/path/to/file", "rb")
  }

高度な設定

Unirest-Rubyを使用する際の高度な設定についてご案内します。

タイムアウトの設定

タイムアウト値(秒単位)を設定することができます。

Ruby
Unirest.timeout(5) # 5s timeout
デフォルトのリクエストヘッダーの設定

リクエストにデフォルトのヘッダーを設定することができます。

Ruby
Unirest.default_header('Header1','Value1')
Unirest.default_header('Header2','Value2')

デフォルトヘッダーはいつでも無効にすることができます。

Ruby
Unirest.clear_default_headers()
ユーザーエージェント

デフォルトのユーザーエージェント文字列はunirest-ruby/1.1となっています。以下の方法で変更することができます。

Ruby
Unirest.user_agent("custom_user_agent")