Sha256: ef94354f0a7986b9ad561bbd45de2c45cf7ce4c29e4c6bc970a80714d661a6cc

Contents?: true

Size: 1.51 KB

Versions: 1

Compression:

Stored size: 1.51 KB

Contents

# Intro

MsRestAzure is a library which supports the Azure clients (SDKs) generated with Autorest tool. It contains core logic and helper classes for error handling and authentication. Also it includes azure specific logic like long polling functionality and Azure application authentication. Usually it is not supposed to be used as a standalone gem but only as a dependency for generated client gems.

# Supported Ruby Versions

* Ruby 1.9.3
* Ruby 2.0
* Ruby 2.1
* Ruby 2.2

Note: x64 Ruby for Windows is known to have some compatibility issues.

# Installation

install the appropriate gem:

```
gem install ms_rest_azure
```

and reference it in your code:

```Ruby
require 'ms_rest_azure'
```

# Running tests

MsRestAzure has only unit tests which doesn't require any preparation, just run 'rspec' command from the gem directory.

# Contribution

To start working on the gem the only additional dev dependecy is required - rspec. After you've added a new feature and all specs pass - you're good to go with PR. But before starting any bug/feature - please make sure you've thoroughly discussed it with repository maintainers. This gem already powers a few SDKs and backward compatibility should taken in account.

# Adding gem to you generated SDK

Reference it in the gemfile and also add this line to your client's gemspec file:

```ruby
spec.add_runtime_dependency 'ms_rest_azure', '~> 0.4.0'
```

Don't forget to correct the version.

# Provide feedback

Send email to the azsdkteam@microsoft.com or file new issue in this repository.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
ms_rest_azure-0.4.0 README.md