# DesignHuddle

An unofficial (and incomplete) Ruby gem for the [Design Huddle API](https://api.designhuddle.com/). As of now only the admin API is supported.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'design_huddle'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install design_huddle

## Set Up

### Using environment variables

Set the following environment variables and `DesignHuddle.client` will automatically authenticate on its first call.

```
DESIGN_HUDDLE_SUBDOMAIN='your_subdomain'
DESIGN_HUDDLE_CLIENT_ID='your_client_id'
DESIGN_HUDDLE_CLIENT_SECRET='your_client_secret'
```

### Using credentials at instantiation

```
DesignHuddle.client = DesignHuddle::Client.new(subdomain: 'your_subdomain', client_id: 'your_client_id', client_secret: 'your_client_secret')
```

## Usage


### Fonts

### Projects

### Templates

### Users

## Development

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.

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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/design_huddle. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/design_huddle/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the DesignHuddle project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/design_huddle/blob/master/CODE_OF_CONDUCT.md).