qingcloud-sdk 0.4.1 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22d21985199ab18a398be991ddf31595d7b7b6c9
-  data.tar.gz: 35230ea46478a13dc96e94bc637560037fef9697
+  metadata.gz: 843b60cbd31b6f0085f98d7c1cb3094d6bf58f86
+  data.tar.gz: 9927951fe6b771121057647ac04a79b1bd0dca3d
 SHA512:
-  metadata.gz: f1b9c4018c8d10a387de40c493322eb3627a07464305d429be47dd9fb069c4c3e787741ec61675ac47d9ba6c4b52a97121e5bf70989ec044c4e936843006ac4e
-  data.tar.gz: 14f693ae1c1bab53276a551b7e2282ad137476276227b3628d1f54d0314df11c30ff9df427d06e8cd559ffc66e5e641dcd915444926a489b089a183aae3c04bb
+  metadata.gz: 33bebee999f88b64b1080a5b835c019cac81dd2b4f19663b020669fda2bb5795b983065b88c2d746a71f4715359a171684bec2d0f258c51356ebd84be4042bc7
+  data.tar.gz: 0fa3a023ce9f94231201fa35c2390a9692a6f5d5e79cb560cdae64e199f94192d2779f2118025662c04a41f064e15accc8abbfd416b0731a434883ce7485ff44

data/LICENSE

@@ -1,21 +1,201 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Peng Jingwen
-
-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.
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2012 Yunify Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,108 +1,188 @@
 # QingCloud::SDK
 
-SDK for QingCloud
+<span style="display: inline-block">
+[![Build Status](https://travis-ci.org/yunify/qingcloud-sdk-ruby.svg?branch=master)](https://travis-ci.org/yunify/qingcloud-sdk-ruby)
+[![Gem Version](https://badge.fury.io/rb/qingcloud-sdk.svg)](http://badge.fury.io/rb/qingstor-sdk)
+[![API Reference](http://img.shields.io/badge/api-reference-green.svg)](https://docs.qingcloud.com/qingstor/)
+[![License](http://img.shields.io/badge/license-apache%20v2-blue.svg)](https://github.com/yunify/qingcloud-sdk-ruby/blob/master/LICENSE)
+</span>
 
-[![Gem Version](https://badge.fury.io/rb/qingcloud-sdk.svg)](http://badge.fury.io/rb/qingcloud-sdk)
+The official QingCloud SDK for Ruby programming language.
 
-## Install from RubyGems
+## Installation
 
-	$ gem install qingcloud-sdk
+This Gem uses Ruby's _keyword arguments_ feature, thus Ruby v2.1.5 or higher is
+required.  See [this article](https://robots.thoughtbot.com/ruby-2-keyword-arguments)
+for more details about _keyword arguments_.
 
-## Install using Gemfile
+### Install with Bundler
 
-Add this line to your application's Gemfile:
+Specify `qingcloud-sdk` as dependency in your application's Gemfile:
 
-	gem 'qingcloud-sdk'
-
-or
-
-	gem 'qingcloud-sdk', git: 'https://github.com/prettyxw/qingcloud-sdk-ruby'
+``` ruby
+gem 'qingcloud-sdk'
+```
 
-And then execute:
+Ensure `qingcloud-sdk` is installed as dependency with `bundle install`:
 
-    $ bundle install
+``` bash
+$ bundle install
+```
 
-## Install from Source Code
+### Install from Source Code
 
-Get Code from Github:
+Get code from GitHub:
 
-	$ git clone git@github.com:prettyxw/qingcloud-sdk-ruby.git
+``` bash
+$ git clone git@github.com:yunify/qingcloud-sdk-ruby.git
+```
 
-Build and Install with Bundle:
+Build and install with bundler:
 
-    $ cd qingcloud-sdk-ruby
-    $ bundle install
-    $ bundle exec rake install
+``` bash
+$ cd qingcloud-sdk-ruby
+$ bundle install
+$ bundle exec rake install
+```
 
-## Uninstall
+### Uninstall
 
-Using gem to remove this package:
+``` bash
+$ gem uninstall qingcloud-sdk
+```
 
-    $ gem uninstall qingcloud-sdk
+## Usage
 
-## Notice
-* All QingCloud API actions are available now.
-* API action name is mapped to ruby method.
-* API parameter name is mapped to ruby method parameter.
+### Notice
+* API action name was mapped to ruby method.
+* API parameter name was mapped to ruby method parameter.
 * API optional parameter can be ignored when call ruby method.
 
-Example:
-	
-```ruby
+___Example:___
+
+``` ruby
 Action: "DescribeInstances" -> "describe_instances"
-Parameter: "zone" -> "zone"
-Array Parameter: "instances.n" -> "instances_N"
-Array Parameter: "statics.n.static_type" -> "statics_N_static_type"
+Parameter: "zone" -> "zone: 'pek3a'"
+Array Parameter: "instances.n" -> "instances: ['i-xxxxxxxx', ...]"
+Map Parameter: "statics.n.static_type" -> "statics: [{val1: '', ...}, ...]"
 ```
 
-## Getting Started
+### Prepare
 
 Before your start, please go to [QingCloud Console](https://console.qingcloud.com/access_keys/) to create a pair of QingCloud API keys.
 
-## Code Example
+___API AccessKey Example:___
+
+``` yaml
+qy_access_key_id: 'ACCESS_KEY_ID_EXAMPLE'
+qy_secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE'
+```
+
+### Code Example
 
 ```ruby
 require 'qingcloud/sdk'
 
-# Create Connection and Service
+# Create a configuration from AccessKeyID and SecretAccessKey
+config = QingCloud::SDK::Config.init ENV['ENV_ACCESS_KEY_ID'],
+                                     ENV['ENV_SECRET_ACCESS_KEY']
+
+# Initialize a QingCloud service with a configuration
+qingcloud_service = QingCloud::SDK::QingCloudService.new config
+
+# Initialize service of Instance
+instance = qingcloud_service.instance 'pek3a'
+
+# DescribeInstances
+result = instance.describe_instances verbose: 1,
+                                     limit:   5
+# Print instances count
+puts result[:total_count]
+
+# RunInstances
+result = instance.run_instances image_id:      'centos7x64b',
+                                cpu:           1,
+                                memory:        1024,
+                                login_mode:    'keypair',
+                                login_keypair: 'kp-xxxxxxxx'
+# Print the job ID
+puts result[:job_id]
+```
 
-connector = QingCloud::SDK::IaaS::Connector.init 'qy_access_key_id',
-                                                 'qy_secret_access_key'
+### More Configuration
 
-service = QingCloud::SDK::IaaS::Service.new connector
+Except for AccessKeyID and SecretAccessKey, you can also configure the API servers for private cloud usage.
 
-# Describe Instances
+___Code Example:___
 
-service.describe_instances zone: 'ap1'
+``` ruby
+require 'qingcloud/sdk'
 
-puts service.response
+# Load default configuration
+config = QingCloud::SDK::Config.new.load_default_config
 
-# Run Instances
+# Create with default value
+config = QingCloud::SDK::Config.new({
+  host:      'api.qingcloud.dev',
+  log_level: 'debug',
+})
 
-service.run_instances image_id: 'centos7x64b', 
-                      cpu: 1, 
-                      memory: 1024, 
-                      login_mode: 'keypair', 
-                      login_keypair: 'keypair-id', 
-                      zone: 'ap1'
-                     
-puts service.response
+# Create a configuration from AccessKeyID and SecretAccessKey
+config = QingCloud::SDK::Config.init ENV['ENV_ACCESS_KEY_ID'],
+                                     ENV['ENV_SECRET_ACCESS_KEY']
 
-# Terminate Instances
+# Load configuration from config file
+config = QingCloud::SDK::Config.new
+config = config.load_config_from_file '~/qingcloud/config.yaml'
 
-service.describe_instances instances_N: ['instance-id'], zone: 'ap1'
+# Create configuration from AccessKey
+config = QingCloud::SDK::Config.init 'ACCESS_KEY_ID',
+                                     'SECRET_ACCESS_KEY'
 
-puts service.response
+# Change API server
+config.update({host: 'api.qingcloud.dev'})
 ```
 
+___Default Configuration File:___
+
+``` yaml
+# QingCloud services configuration
+
+qy_access_key_id: 'ACCESS_KEY_ID'
+qy_secret_access_key: 'SECRET_ACCESS_KEY'
+
+host: 'api.qingcloud.com'
+port: 443
+protocol: 'https'
+uri: '/iaas'
+connection_retries: 3
+
+# Valid log levels are "debug", "info", "warn", "error", and "fatal".
+log_level: 'warn'
+```
+
+## Change Log
+All notable changes to QingCloud SDK for Ruby will be documented here.
+
+### v2.0.0 - 2017-03-05
+
+#### Added
+
+- QingCloud SDK for the Ruby programming language.
+
+## Reference Documentations
+
+- [QingCloud Documentation Overview](https://docs.qingcloud.com)
+- [QingCloud API](https://docs.qingcloud.com/api/index.html)
+
 ## Contributing
 
-1. Fork it ( https://github.com/prettyxw/qingcloud-sdk-ruby/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`)
+1. Fork it ( https://github.com/yunify/qingcloud-sdk-ruby/fork )
+2. Create your feature branch (`git checkout -b new-feature`)
+3. Commit your changes (`git commit -asm 'Add some feature'`)
+4. Push to the branch (`git push origin new-feature`)
 5. Create a new Pull Request
 
-LICENSE
--------
-The MIT License.
+## LICENSE
+
+The Apache License (Version 2.0, January 2004).