qingstor-sdk 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9bddf910cc0a1f585831e00757753c56f596ea6
+  data.tar.gz: 1ece8de87816d8b48286a5c3d7e16411a14482fe
+SHA512:
+  metadata.gz: 0750a39b2d69a4bbe46d92cf1983026f8f05c77e0106ecaede87f5982c39a8efbbec2fee96f26283b4f2180bb879f3d5bf4f091385a7ec30fc1055ad6355becf
+  data.tar.gz: a04c1ab9024436abebc1ea0560784e35a65b59368d3e98e4c4ff92a327166565c45f110217df447e935cb36bac64a97f56cd6683e7efb07ebaaeafcca71d49c0

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+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

@@ -0,0 +1,191 @@
+# QingStor::SDK
+
+<span style="display: inline-block">
+[![Build Status](https://travis-ci.org/yunify/qingstor-sdk-ruby.svg?branch=master)](https://travis-ci.org/yunify/qingstor-sdk-ruby)
+[![Gem Version](https://badge.fury.io/rb/qingstor-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/qingstor-sdk-ruby/blob/master/LICENSE)
+</span>
+
+The official QingStor SDK for Ruby programming language.
+
+## Installation
+
+The current code branch is intended to be compatible with Ruby v1.9.x. If you are using Ruby v2.1 or higher, please checkout the [master][master] branch.
+
+### Install from RubyGems
+
+``` bash
+$ gem install qingstor-sdk
+```
+
+### Install with Bundler
+
+Specify `qingstor-sdk` as dependency in your application's Gemfile:
+
+``` ruby
+gem 'qingstor-sdk'
+```
+
+Ensure `qingstor-sdk` is installed as dependency with `bundle-install`:
+
+``` bash
+$ bundle install
+```
+
+### Install from Source Code
+
+Get code from GitHub:
+
+``` bash
+$ git clone git@github.com:yunify/qingstor-sdk-ruby.git
+```
+
+Build and install with bundler:
+
+``` bash
+$ cd qingstor-sdk-ruby
+$ bundle install
+$ bundle exec rake install
+```
+
+### Uninstall
+
+``` bash
+$ gem uninstall qingstor-sdk
+```
+
+## Usage
+
+Before using the SDK, please make sure you already have QingCloud API access key,
+apply one from [QingCloud Console](https://console.qingcloud.com/access_keys/)
+otherwise.
+
+___API Access Key Example:___
+
+``` yaml
+access_key_id: 'ACCESS_KEY_ID_EXAMPLE'
+secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE'
+```
+
+### Code Example
+
+```ruby
+require 'qingstor/sdk'
+require 'digest/md5'
+
+# Create a config object with access_key_id and secret_access_key defined as
+# environment variables.
+config = QingStor::SDK::Config.init ENV['ENV_ACCESS_KEY_ID'],
+                                    ENV['ENV_SECRET_ACCESS_KEY']
+
+# Initialize QingStor service with the config object.
+qs_service = QingStor::SDK::Service.new config
+
+# List buckets
+result = qs_service.list_buckets
+# Print HTTP status code
+puts result[:status_code]
+# Print bucket count
+puts result[:buckets].length
+# Print the first bucket name
+puts result[:buckets][0][:name]
+
+# Initialize a QingStor bucket
+bucket = qs_service.bucket 'test-bucket', 'pek3a'
+
+# List objects
+result = bucket.list_objects
+# Print HTTP status code
+puts result[:status_code]
+# Print keys count
+puts result[:keys].length
+
+
+# Upload an object
+file_path = File.expand_path '~/Desktop/Screenshot.jpg'
+md5_string = Digest::MD5.file(file_path).to_s
+result = bucket.put_object 'Screenshot.jpg',
+                           content_md5: md5_string,
+                           body:        File.open(file_path)
+# Print HTTP status code.
+puts result[:status_code]
+```
+
+### More Configuration
+
+Except access_key_id and secret_access_key, you can also configure the API
+server (in case of QingStor is deployed in private environment, thus has
+different endpoint with public QingStor) either in the config file, or in
+the program dynamically.
+
+___Code Example:___
+
+``` ruby
+require 'qingstor/sdk'
+
+# Load default configuration
+config = QingStor::SDK::Config.new.load_default_config
+
+# Create with default value
+config = QingStor::SDK::Config.new({
+  host:      'qingstor.dev',
+  log_level: 'debug',
+})
+
+# Create a configuration from AccessKeyID and SecretAccessKey
+config = QingStor::SDK::Config.init ENV['ENV_ACCESS_KEY_ID'],
+                                    ENV['ENV_SECRET_ACCESS_KEY']
+
+# Load configuration from config file
+config = QingStor::SDK::Config.new
+config = config.load_config_from_file '~/qingstor/config.yaml'
+
+# Change API server
+config.update({host: 'test.qingstor.com'})
+```
+
+___Default Configuration File:___
+
+``` yaml
+# QingStor services configuration
+
+access_key_id: 'ACCESS_KEY_ID'
+secret_access_key: 'SECRET_ACCESS_KEY'
+
+host: 'qingstor.com'
+port: 443
+protocol: 'https'
+connection_retries: 3
+
+# Valid log levels are "debug", "info", "warn", "error", and "fatal".
+log_level: 'warn'
+```
+
+## Change Log
+All notable changes to QingStor SDK for Ruby will be documented here.
+
+### v1.9.0 - 2017-01-13
+
+#### Changed
+- Be compatible with Ruby v1.9.x.
+
+## Reference Documentations
+
+- [QingStor Documentation](https://docs.qingcloud.com/qingstor/index.html)
+- [QingStor Guide](https://docs.qingcloud.com/qingstor/guide/index.html)
+- [QingStor APIs](https://docs.qingcloud.com/qingstor/api/index.html)
+
+## Contributing
+
+1. Fork it ( https://github.com/yunify/qingstor-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 Apache License (Version 2.0, January 2004).
+
+[master]: https://github.com/yunify/qingstor-sdk-ruby/tree/master

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'qingstor/sdk'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/qingstor/sdk.rb

@@ -0,0 +1,17 @@
+#  +-------------------------------------------------------------------------
+#  | Copyright (C) 2016 Yunify, Inc.
+#  +-------------------------------------------------------------------------
+#  | Licensed under the Apache License, Version 2.0 (the "License");
+#  | you may not use this work except in compliance with the License.
+#  | You may obtain a copy of the License in the LICENSE file, or 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.
+#  +-------------------------------------------------------------------------
+
+Dir[File.dirname(__FILE__) + '/sdk/**/*.rb'].each { |file| require file }