本文介绍如何安装OSS Ruby SDK。

前提条件

  • 已开通阿里云对象存储OSS服务

    如果您还没有开通或者还不了解OSS服务,请查看对象存储OSS产品详情页。

  • 已创建AccessKey

    如果还没有创建AccessKey(AccessKey Id和AccessKey Secret),请参见创建AccessKey

安装

您可以通过以下两种方式安装Ruby SDK。

  • 方式一

    执行gem install aliyun-sdk 命令安装SDK。

    如果无法访问https://rubygems.org,建议直接使用淘宝的镜像源。

    gem install aliyun-sdk --clear-sources --source https://gems.ruby-china.org
  • 方式二

    通过bundler安装。

    1. 在应用程序的Gemfile中添加gem 'aliyun-sdk', '~> 0.6.0'
    2. 选择淘宝镜像源进行安装。
      # 选择淘宝镜像源。
      bundle config mirror.https://rubygems.org https://ruby.taobao.org
      bundle install                        
      说明 https://ruby.taobao.org是完整的rubygems.org镜像,并与官方源自动同步。不方便访问rubygems.org的用户可以使用此镜像源。

依赖

  • Ruby版本 >= 1.9.3
  • 支持Ruby运行环境的Linux/Windows/OS X系统
注意
  • SDK依赖的某些gem是本地扩展的形式,因此需要安装ruby-dev以支持编译本地扩展的gem。
  • SDK依赖处理XML的gem(nokogiri)环境中要求包含zlib库。
在Linux、Windows和OS X系统中安装依赖的步骤如下。
  • Linux

    以Ubuntu为例,执行如下命令安装上述依赖。

    sudo apt-get install ruby ruby-dev zlib1g-dev
                            

    各个Linux发行版都有自身的包管理工具,且安装方法类似。

  • Windows
    1. 前往RubyInstaller下载RubyInstaller,双击安装,在安装时选择Add Ruby executables to your PATH
      说明 请下载2.1及以下版本。现因某些原因还无法安装2.2版本,详情请参见GitHub
    2. 前往RubyInstaller下载DEVELOPMENT KIT,注意选择相应的版本。下载后是一个压缩包,在解压前首先在C盘根目录建立一个文件夹 C:\RubyDev,然后将压缩包解压到此文件夹。
    3. 同时按下Windows + R键,并输入cmd后回车进入到命令行窗口,输入以下命令。
       cd C:\RubyDev
       ruby dk.rb init
       ruby dk.rb install                                

      如果install时显示config.yml配置错误,建议用文本编辑器打开C:\RubyDev\config.yml,将其内容改为:

       ---
       - C:/Ruby21
                                      

      保存config.yml。然后继续使用命令ruby dk.rb install完成安装。其中,Ruby21是Ruby的安装目录,可根据具体的名字填写。安装完成后关闭此命令行窗口。

    4. 输入命令gem install aliyun-sdk

      安装完成后,输入irb进入Ruby交互式命令行。在交互式命令行中输入require 'aliyun/oss',如果显示true,则表明SDK已完成安装。

  • OS X

    OS X系统默认已安装Ruby。为了方便使用和管理,建议您再安装一个供开发使用的Ruby版本。

    1. 在终端输入xcode-select --install安装Xcode command line tools。 如果安装失败,建议手动下载并安装。
      说明 使用您的Apple ID登录后从苹果开发者网站下载Xcode command line tools。注意选择与您的系统匹配的版本。下载完成后双击加载dmg文件,然后在打开的窗口中双击安装程序进行安装,在安装的过程中需要输入您的系统密码。
    2. 在终端输入以下命令安装brew。
       ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
                                      
    3. 在终端输入以下命令安装Ruby。
       brew install ruby
       exec $SHELL -l
                                      
    4. 在终端输入以下命令安装SDK。
       gem install aliyun-sdk
                                      
    5. 在终端输入以下命令验证SDK是否已安装成功。如果显式true,则表明SDK已完成安装。
       irb
       > require 'aliyun/oss'
       => true
                                      

相关文档