Skip to content

[WIP] Add all IBM Cloud services under one gem #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
/tmp/
/Gemfile.lock
/*.json
/openapi-generator-cli*
/openapi-sdkgen*

# rspec failure tracking
.rspec_status
48 changes: 2 additions & 46 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,2 @@
# Changelog
All notable changes to the gem ibm-cloud-sdk-ruby will be documented here.

## v0.1.11 - 2020-10-28
- Add start, stop, and reboot actions on VPC instances

## v0.1.10 - 2020-10-08
- Change VPC http provider to HTTParty
- Add Tags API and clean up VPC
- Log ResourceController and IAM calls

## v0.1.9 - 2020-10-02
- Fix PowerVS Volume Attach/Detach calls

## v0.1.8 - 2020-10-01
- Add second level instances

## v0.1.7 - 2020-09-28
- Added Logging in IBM Cloud
- Add VCR to vpc spec
- Add exception when status of response is not in 200 range or 404
- Power IaaS Update docstrings, VM actions volumes

## v0.1.6 - 2020-09-23
- Add PowerIaaS method to get instance info
- Return region specific PowerVS storage types
- Move VPC instance into instances and add initialization method.

## v0.1.5 - 2020-09-21
- Added Enumerable based pagination support
- Move instance profiles
- Improve resource lookup by GUID
- Add support to create a PowerIaas volume

## v0.1.4 - 2020-09-17
- Added support for the IBM Virtual Private Cloud (VPC) service

## v0.1.3 - 2020-08-31
### Added the following rest api calls for Power System Virtual Server service
- Add PowerIaas 'delete_volume' method
- Add PowerVS SAP API calls
- get list of available system pools within a particular data center
- get list of all storage type availble in the data center. There may be
update to the call once PowerVS service updates the storage type rest api
for Power System Virtual Server service .

= 0.0.1
* Initial release
File renamed without changes.
File renamed without changes.
4 changes: 1 addition & 3 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
source "https://rubygems.org"

# Specify your gem's dependencies in ibm-cloud-sdk.gemspec
# Specify your gem's dependencies in ibm_cloud.gemspec
gemspec

gem "rake", "~> 12.0"
gem "rspec", "~> 3.0"
gem 'vcr'
gem 'webmock'
File renamed without changes.
202 changes: 0 additions & 202 deletions LICENSE.txt

This file was deleted.

84 changes: 68 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,84 @@
# IBM::Cloud::SDK
[![Build Status](https://travis-ci.com/IBM-Cloud/ibm-cloud-sdk-ruby.svg?token=eW5FVD71iyte6tTby8gr&branch=master)](https://travis.ibm.com/IBM-Cloud/ibm-cloud-sdk-ruby)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
# IBM Cloud Ruby SDK

## Installation
Ruby client library to interact with various [IBM Cloud IBM Cloud APIs](https://cloud.ibm.com/apidocs?category=platform-services).

Add this line to your application's Gemfile:
Disclaimer: this SDK is being released initially as a **pre-release** version.
Changes might occur which impact applications that use this SDK.

```ruby
gem 'ibm-cloud-sdk'
```
## Table of Contents

<!--
The TOC below is generated using the `markdown-toc` node package.

https://github.com/jonschlinkert/markdown-toc

You should regenerate the TOC after making changes to this file.

npx markdown-toc -i README.md
-->

<!-- toc -->

- [Overview](#overview)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Using the SDK](#using-the-sdk)
- [Questions](#questions)
- [Issues](#issues)
- [Open source @ IBM](#open-source--ibm)
- [Contributing](#contributing)
- [License](#license)

And then execute:
<!-- tocstop -->

$ bundle install
## Overview

Or install it yourself as:
The IBM Cloud IBM Cloud Ruby SDK allows developers to programmatically interact with the following
IBM Cloud services:

$ gem install ibm-cloud-sdk
Service Name | Imported Class Name
--- | ---
<!-- [Example Service](https://cloud.ibm.com/apidocs/example-service) | exampleservicev1 -->

## Prerequisites

[ibm-cloud-onboarding]: https://cloud.ibm.com/registration

* An [IBM Cloud][ibm-cloud-onboarding] account.
* An IAM API key to allow the SDK to access your account. Create one [here](https://cloud.ibm.com/iam/apikeys).
* Ruby 2.3.0 or above.

## Installation

To install, use `gem`

```bash
gem install "ibm_cloud"
```

## Usage
## Using the SDK
For general SDK usage information, please see [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md)

TODO: Write usage instructions here
## Questions

## Development
If you are having difficulties using this SDK or have a question about the IBM Cloud services,
please ask a question
[Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud).

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Issues
If you encounter an issue with the project, you are welcome to submit a
[bug report](https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/issues).
Before that, please search for similar issues. It's possible that someone has already reported the problem.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Open source @ IBM
Find more open source projects on the [IBM Github Page](http://ibm.github.io/)

## Contributing
See [CONTRIBUTING.md](https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/master/CONTRIBUTING.md).

Bug reports and pull requests are welcome on GitHub at https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby.
## License

This SDK is released under the Apache 2.0 license.
The license's full text can be found in [LICENSE](https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/master/LICENSE).
Loading