Sha256: 80bd34c99daeb8668920bbd0540755b23e9d2938c46fde2d60e197da6a7b4f60

Contents?: true

Size: 1.78 KB

Versions: 2

Compression:

Stored size: 1.78 KB

Contents

# Velocity Client

Interact with Velocity Teams API

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'velocity_client_ruby'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install velocity_client_ruby

## Usage

```ruby
Velocity.configure do |config|
  config.api_token = "token"
end

CSV.parse(File.read("contributors.csv"), headers: true).each do |contributor|
  contributor = Velocity::Contributor.find(contributor.id)

  if contributor.nil?
    Velocity::Invite.create(email: contributor.email)
  end
end
```

## 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 tags, 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/codeclimate/velocity-client-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## 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 velocity-client-ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/velocity_client_ruby/blob/master/CODE_OF_CONDUCT.md).

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
velocity_client_ruby-0.1.1 README.md
velocity_client_ruby-0.1.0 README.md