Contents

# AccessTokenWrapper

Provides a wrapper for an OAuth2::Token to automatically refresh the expiry token when required.

## Installation

Add this line to your application's Gemfile:

    gem 'access_token_wrapper'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install access_token_wrapper

## Usage

`AccessTokenWrapper::Base`
```ruby
def access_token
  @access_token ||= begin
    token = OAuth2::AccessToken.new(oauth_client, @user.access_token,
            refresh_token: @user.refresh_token,
            expires_at:    @user.expires_at
    )
    AccessTokenWrapper::Base.new(token) do |new_token, exception|
      update_user_from_access_token(new_token)
    end
  end
end

def oauth_client 
  @oauth_client ||= OAuth2::Client.new(ENV["OAUTH_ID"], ENV["OAUTH_SECRET"], site: "https://api.tradegecko.com")
end

def update_user_from_access_token(new_token)
  @user.access_token  = new_token.token
  @user.refresh_token = new_token.refresh_token
  @user.expires_at    = new_token.expires_at
  @user.save
end
```

or the more advanced `AccessTokenWrapper::FromRecord` that automatically locks the record on refresh to help ensure concurrency.

```ruby
def access_token
  @access_token ||= begin
    token = OAuth2::AccessToken.new(oauth_client, @user.access_token,
            refresh_token: @user.refresh_token,
            expires_at:    @user.expires_at
    )
    AccessTokenWrapper::FromRecord.new(client: oauth_client, record: @user) do |new_token, exception|
      update_user_from_access_token(new_token)
    end
  end
end
```

## Configuration
```ruby
AccessTokenWrapper.configure do |config|
  config.skip_statuses << 520
  config.skip_refresh do |response|
    response.parsed['message'].start_with?('Duplicate Idempotency')
  end
end
```

## 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

1 entries across 1 versions & 1 rubygems

Version	Path
access_token_wrapper-0.5.0	README.md