aliyun_ruby_api 0.0.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>aliyun_ruby_api</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.rubypeople.rdt.core.rubybuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.rubypeople.rdt.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aliyun_ruby_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 cheyang
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# 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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/aliyun_ruby_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aliyun_ruby_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aliyun_ruby_api"
+  spec.version       = AliyunRubyApi::VERSION
+  spec.authors       = ["cheyang"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "ruby-hmac"
+end

data/example/ecs.conf

@@ -0,0 +1,4 @@
+Format=JSON
+Version=2013-01-10
+AccessKeyId=key
+SignatureVersion=1.0

data/lib/aliyun_ruby_api.rb

@@ -0,0 +1,3 @@
+require "aliyun_ruby_api/version"
+require "aliyun_ruby_api/base"
+require "aliyun_ruby_api/service"

data/lib/aliyun_ruby_api/base.rb

@@ -0,0 +1,23 @@
+module Aliyun
+ 
+    ALIYUN_API_ENDPOINT='https://ecs.aliyuncs.com/'
+    
+    SEPARATOR = "&"
+    
+    HTTP_METHOD = "GET"
+    
+    $ENDPOINT_URL = nil
+    
+    
+    $ACCESS_KEY_ID = nil
+    
+    
+    $ACCESS_KEY_SECRET = nil
+    
+    
+    DEFAULT_PARAMETERS = {:Format=>"JSON",
+        :Version=>"2013-01-10", 
+        :SignatureMethod=>"HMAC-SHA1", 
+        :SignatureVersion=>"1.0"}
+  
+end

data/lib/aliyun_ruby_api/service.rb

@@ -0,0 +1,151 @@
+require 'net/http'
+require 'time'
+require 'securerandom'
+require 'uri'
+require 'base64'
+require 'hmac-sha1'
+require 'json'
+
+module Aliyun
+  
+  class AliyunAPIException < RuntimeError
+  end
+  
+  class Service
+    
+    
+    
+    attr_accessor :options
+    
+    attr_accessor :access_key_id
+    
+    attr_accessor :access_key_secret
+    
+    attr_accessor :endpoint_url
+    
+    def initialize(options={})
+      
+      self.access_key_id = options[:access_key_id] || $ACCESS_KEY_ID || ""
+      
+      self.access_key_secret = options[:access_key_secret] || $ACCESS_KEY_SECRET || ""
+      
+      self.endpoint_url = options[:endpoint_url] || $ENDPOINT_URL || ALIYUN_API_ENDPOINT
+      
+      self.options = {:AccessKeyId => self.access_key_id}
+    end
+    
+    #The method entry to call ECS url method
+    def method_missing(method_name, *args)
+      if $DEBUG
+        puts "Not Found Method: #{method_name}"
+      end
+      
+      if args[0].nil?
+        raise AliyunAPIException.new "No such  method  #{method_name}!"
+      end
+      
+      call_aliyun_with_parameter(method_name, args[0])
+    end
+    
+    #Dispatch the request with parameter
+    private
+    def call_aliyun_with_parameter(method_name, params)
+      
+      params = gen_request_parameters method_name, params
+      
+      uri = URI(endpoint_url)
+      
+      uri.query = URI.encode_www_form(params)
+      
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if (uri.scheme == "https")
+      
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE 
+      if $DEBUG
+        puts "request url: #{uri.request_uri}"
+      end
+      
+      request = Net::HTTP::Get.new(uri.request_uri)
+      
+      response = http.request(request)
+      
+      case response
+        when Net::HTTPSuccess
+        
+        return JSON.parse(response.body)
+      else
+        raise AliyunAPIException.new "response error code: #{response.code} and details #{response.body}"
+      end
+      
+    end
+    
+    #generate the parameters
+    def gen_request_parameters method_name, params
+      #add common parameters
+      params.merge! DEFAULT_PARAMETERS
+      
+      params.merge! self.options
+      
+      params[:Action] = method_name.to_s
+      
+      params[:TimeStamp] = Time.now.utc.iso8601
+      
+      params[:SignatureNonce] = SecureRandom.uuid
+      
+      params[:Signature] = compute_signature params
+      
+      params
+    end
+    
+    #compute the signature of the parameters String
+    def compute_signature params
+      if $DEBUG 
+        puts "keys before sorted: #{params.keys}"
+      end
+      
+      sorted_keys = params.keys.sort
+      
+      if $DEBUG 
+        puts "keys after sorted: #{sorted_keys}"
+      end
+      
+      canonicalized_query_string = ""
+      
+      sorted_keys.each {|key| canonicalized_query_string << SEPARATOR
+        canonicalized_query_string << percent_encode(key.to_s)
+        canonicalized_query_string << '='
+        canonicalized_query_string << percent_encode(params[key])
+      }
+      
+      length = canonicalized_query_string.length
+      
+      string_to_sign = HTTP_METHOD + SEPARATOR + percent_encode('/') + SEPARATOR + percent_encode(canonicalized_query_string[1,length])
+      
+      if $DEBUG 
+        puts "string_to_sign is  #{string_to_sign}"
+      end
+      
+      signature = calculate_signature access_key_secret+"&", string_to_sign
+      
+    end
+    
+    #calculate the signature
+    def calculate_signature key, string_to_sign
+      hmac = HMAC::SHA1.new(key)
+      hmac.update(string_to_sign)
+      signature = Base64.encode64(hmac.digest).gsub("\n", '')
+      if $DEBUG 
+        puts "signature #{signature}"
+      end
+      signature
+    end
+    
+    #encode the value to aliyun's requirement
+    def percent_encode value
+      
+      value = URI.encode_www_form_component(value).gsub(/\+/,'%20').gsub(/\*/,'%2A').gsub(/%7E/,'~')
+      
+    end
+    
+  end
+end

data/lib/aliyun_ruby_api/version.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: aliyun_ruby_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- cheyang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  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: ruby-hmac
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby API client for using Aliyun ECS
+email:
+- cheyang@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .project
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aliyun_ruby_api.gemspec
+- example/ecs.conf
+- lib/aliyun_ruby_api.rb
+- lib/aliyun_ruby_api/base.rb
+- lib/aliyun_ruby_api/service.rb
+- lib/aliyun_ruby_api/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby API client for accessing Aliyun ECS
+test_files: []