Contents

# OmniAuth onShape OAuth2 Strategy

A onShape OAuth2 strategy for OmniAuth.

For more details, read the onShape documentation: (currently requires private API access to partner server)

## Installation

Add this line to your application's Gemfile:

    gem 'omniauth-onshape-oauth2'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install omniauth-onshape-oauth2

## Usage

Register your application with onShape to receive an API key: https://dev-portal.dev.onshape.com

This is an example that you might put into a Rails initializer at `config/initializers/omniauth.rb`:

```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
  provider :onshape, ENV['ONSHAPE_KEY'], ENV['ONSHAPE_SECRET']
end
```
You can now access the OmniAuth onShape OAuth2 URL: `/auth/onshape`.

You can also utilize the partner dev server, which has a different strategy, using the provider name :onshape_dev and URL /auth/onshape_dev

## Granting Member Permissions to Your Application

With the onShape API, you have the ability to specify which permissions you want users to grant your application.

By default, omniauth-onshape-oauth2 requests the default permissions registered with your app.

You can configure the scope option:

```ruby
provider :onshape, ENV['ONSHAPE_KEY'], ENV['ONSHAPE_SECRET'], :scope => 'r_emailaddress'
```

## Contributing

1. Fork it
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

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
omniauth-onshape-oauth2-0.1.3	README.md
omniauth-onshape-oauth2-0.1.2	README.md
omniauth-onshape-oauth2-0.1.1	README.md
omniauth-onshape-oauth2-0.1.0	README.md