westernmilling/agris.rb

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![Code Climate](https://codeclimate.com/github/westernmilling/agris.rb/badges/gpa.svg)](https://codeclimate.com/github/westernmilling/agris.rb)
[![Test Coverage](https://codeclimate.com/github/westernmilling/agris.rb/badges/coverage.svg)](https://codeclimate.com/github/westernmilling/agris.rb/coverage)

# Agris

Agris Web Services client library.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'agris'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install agris

## Usage

```ruby
Agris.configure do |config|
  config.credentials = Agris::Credentials::Anonymous.new
  config.context = Agris::Context.new(
    'http://localhost:3000',
    '001',
    '\\host\apps\Agris\datasets',
    'AgrisDB',
    'bob',
    'fred'
  )
  config.request_type = Agris::SavonRequest
  config.logger = Logger.new(STDOUT)
  config.user_agent = 'Otis'
end
```

elsewhere

```ruby
client = Agris::Client.new
```

Enjoy!

## 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/westernmilling/agris.