aliyun_ruby_api 0.0.1 → 0.0.2

data/README.md

@@ -1,33 +1,33 @@
 # Aliyun ECS API Client for Ruby
 
 
-The Aliyun ECS API Client for Ruby is a library for connecting to and calling [The Aliyun ECS](http://help.aliyun.com/view/11108189_13730407.html?spm=5176.7376125.1997918129.6.k2vNso) from the [Ruby](http://www.ruby-lang.org programming language).
+The Aliyun ECS API Client for Ruby 是调用 [阿里云 ECS服务](http://help.aliyun.com/view/11108189_13730407.html) 的 [Ruby](http://www.ruby-lang.org programming language)客户端类库.
 
 
-## Installation
+## 安装
 
-Add this line to your application's Gemfile:
+可以将下面一行加入Ruby应用的Gemfile:
 
     gem 'aliyun_ruby_api'
 
-And then execute:
+之后执行:
 
     $ bundle
 
-Or install it yourself as:
+或者直接执行:
 
     $ gem install aliyun_ruby_api
 
-## Usage
+## 使用方法：
 
-First, you're probably gonna want to require it:
+首先，需要在代码中引入类库:
 
 ```
 require 'rubygems'
 require 'aliyun_ruby_api'
 ```
 
-Then, you need to set 
+然后利用自己阿里云账号下的access_key初始化service对象。如果没有access_key，可以通过[阿里云用户中心](https://i.aliyun.com/access_key/)申请access_key。
 
 ```
 options = {:access_key_id => "xxxxxx", 
@@ -37,15 +37,15 @@ options = {:access_key_id => "xxxxxx",
 service = Aliyun::Service.new options
 ```
 
-Now, you can call all the aliyun ECS API interface in the following way
+这样, 你就可以根据 [阿里云弹性计算服务API参考手册](http://help.aliyun.com/view/11108189_13730407.html)初始化业务参数（除Action参数之外）为一个hash对象，并且将其作为参数传给Action方法（Action参数）。
 
 ```
-parameters = {:[parameter_name] => :[parameter_value]}
+parameters = {:[parameter_name] => [parameter_value]}
 
 service.[Action] parameters
 ```
 
-(1) For example, if you want to use alyun ECS API to describe regions
+(1) 例如查询可用地域列表，其Action参数为DescribeRegions，而没有其他参数，代码如下
 
 ```
 parameters = {}
@@ -53,26 +53,24 @@ parameters = {}
 service.DescribeRegions parameters
 ```
 
-(2) For example, if you want to use alyun ECS API to describe images template of a specified region
+(2) 再比如查询可用镜像，代码如下
+
 ```
-parameters = {:RegionId => "id", :PageNumber => "2", :RageSize => "20"}
+parameters = {:RegionId => "cn-beijing", :PageNumber => 2, :RageSize => 20}
 
 service.DescribeImages parameters
 ```
 
-Notice:
+注意:
+
+如果想要输出更详细的debug信息，请将下面这行加入到阿里云API调用
 
-If you want to output the debug info, please add this line before you call the API
 ```
 $DEBUG = true
 
 ```
 
 
-## Contributing
+## 参考例子
 
-1. Fork it ( http://github.com/<my-github-username>/aliyun_ruby_api/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+可以参考example/test.rb来实现。

data/README_EN.md

@@ -0,0 +1,80 @@
+# Aliyun ECS API Client for Ruby
+
+
+The Aliyun ECS API Client for Ruby is a library for connecting to and calling [The Aliyun ECS](http://help.aliyun.com/view/11108189_13730407.html?spm=5176.7376125.1997918129.6.k2vNso) from the [Ruby](http://www.ruby-lang.org programming language).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aliyun_ruby_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aliyun_ruby_api
+
+## Usage
+
+First, you're probably gonna want to require it:
+
+```
+require 'rubygems'
+require 'aliyun_ruby_api'
+```
+
+Then, you need to set 
+
+```
+options = {:access_key_id => "xxxxxx", 
+           :access_key_secret => "yyyyyy", 
+           :endpoint_url => "https://ecs.aliyuncs.com/"}
+
+service = Aliyun::Service.new options
+```
+
+Now, you can call all the aliyun ECS API interface in the following way
+
+```
+parameters = {:[parameter_name] => :[parameter_value]}
+
+service.[Action] parameters
+```
+
+(1) For example, if you want to use alyun ECS API to describe regions
+
+```
+parameters = {}
+
+service.DescribeRegions parameters
+```
+
+(2) For example, if you want to use alyun ECS API to describe images template of a specified region
+
+```
+parameters = {:RegionId => "id", :PageNumber => "2", :RageSize => "20"}
+
+service.DescribeImages parameters
+```
+
+Notice:
+
+If you want to output the debug info, please add this line before you call the API
+
+```
+$DEBUG = true
+
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/aliyun_ruby_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/aliyun_ruby_api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["cheyang@163.com"]
   spec.summary       = %q{Ruby API client for accessing Aliyun ECS}
   spec.description   = %q{Ruby API client for using Aliyun ECS}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/cheyang/aliyun_ruby_api"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/example/test.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'aliyun_ruby_api'
+
+$DEBUG=true
+
+options = {:access_key_id => "xxxxxx",
+           :access_key_secret => "yyyyy",
+           :endpoint_url => "https://ecs.aliyuncs.com/"}
+
+
+service = Aliyun::Service.new options
+
+
+parameters = {}
+
+puts service.DescribeRegions parameters

data/lib/aliyun_ruby_api/version.rb

@@ -1,3 +1,3 @@
 module AliyunRubyApi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: aliyun_ruby_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - cheyang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,29 +30,33 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby API client for using Aliyun ECS
@@ -64,35 +71,38 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- README_EN.md
 - Rakefile
 - aliyun_ruby_api.gemspec
 - example/ecs.conf
+- example/test.rb
 - lib/aliyun_ruby_api.rb
 - lib/aliyun_ruby_api/base.rb
 - lib/aliyun_ruby_api/service.rb
 - lib/aliyun_ruby_api/version.rb
-homepage: ''
+homepage: https://github.com/cheyang/aliyun_ruby_api
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby API client for accessing Aliyun ECS
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 5f0b6ccede45089c9a08654fea2dffc15b9dd4f9
-  data.tar.gz: 2abb1b6d3b155a51133ea00dd11f8217396e55a8
-SHA512:
-  metadata.gz: 2b2ea31836e2beca06404e6f170f47e9292fcda291190a2eafebe622886ca3ac30f5f4b1d53893760240a22d05724e9835339c6f20d54a9ce37b65b8c28b1a07
-  data.tar.gz: 9172a34b3e3c6ddc8406d899586722de7e78c86c0a6e2e070d56118b91561417cbe70c368d36636a3c8822a7c8572e14bf7663bfe5baa5d799b10d8780d837f6