Sha256: 250e6c1afcb9b78077d9898963aa53ab6cfe317731cd46d5b106ff9a2c7d029e

Contents?: true

Size: 1018 Bytes

Versions: 1

Compression:

Stored size: 1018 Bytes

Contents

# zenhub_ruby

Ruby client of [ZenHub API](https://github.com/ZenHubIO/API)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'zenhub_ruby'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install zenhub_ruby

## Usage

### Setup

```ruby
require 'zenhub_ruby'

client = ZenhubRuby::Client.new('ZENHUB_ACCESS_TOKEN', 'GITHUB_ACCESS_TOKEN')
```

or

```ruby
client = ZenhubRuby.new('ZENHUB_ACCESS_TOKEN', 'GITHUB_ACCESS_TOKEN')
```

### Get issue data

```ruby
client.issue_data('REPO_NAME(ex: "tkm-kj/zenhub_ruby")', ISSUE_NUMBER)
```

### Get issue events

```ruby
client.issue_events('REPO_NAME', ISSUE_NUMBER)
```

### Get the ZenHub Board data for a repository

```ruby
client.board_data('REPO_NAME')
```

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

## License

MIT

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
zenhub_ruby-0.2.1 README.md