https://github.com/jpalumickas/ivapi
Ruby gem which helps to communicate with iv.lt API
https://github.com/jpalumickas/ivapi
api dedikuoti-lt hacktoberfest iv-lt ruby serveriai-lt
Last synced: about 1 year ago
JSON representation
Ruby gem which helps to communicate with iv.lt API
- Host: GitHub
- URL: https://github.com/jpalumickas/ivapi
- Owner: jpalumickas
- License: mit
- Created: 2012-11-07T10:11:18.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2021-01-16T14:32:47.000Z (over 5 years ago)
- Last Synced: 2025-04-18T18:33:23.853Z (about 1 year ago)
- Topics: api, dedikuoti-lt, hacktoberfest, iv-lt, ruby, serveriai-lt
- Language: Ruby
- Homepage: https://jpalumickas.com/ivapi
- Size: 641 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Ivapi
Gem which helps to communicate with Interneto vizija [https://www.iv.lt][iv.lt] ([https://wwww.dedikuoti.lt][dedikuoti.lt]) API.
[][rubygems]
[][codecov]
## Installation
Add this line to your application's Gemfile:
```rb
gem 'ivapi'
```
And then execute:
```sh
$ bundle
```
Or install it yourself as:
```sh
$ gem install ivapi
```
## Usage
> The Ivapi Wiki has lots of additional information about this gem including many examples. Please browse the Wiki at:
https://github.com/jpalumickas/ivapi/wiki
Create a new account at https://klientams.iv.lt/users.php with description "API".
### Authentication
```rb
client = Ivapi::Client.new(username: 'foo', password: 'bar')
```
Or create file under `config/initializers/ivapi.rb`
```rb
Ivapi.configure do |config|
config.username = 'foo'
config.password = 'bar'
end
```
### Account information
Basic information
```rb
Ivapi.account.information
```
Orders
```rb
Ivapi.account.orders
```
### Server information
Basic information
```rb
Ivapi.server.information
```
## Supported Ruby Versions
This library aims to support and is [tested against][github_actions] the following Ruby
versions:
* Ruby 2.5.0
* Ruby 2.6.0
* Ruby 2.7.0
* Ruby 3.0.0
## License
The package is available as open source under the terms of the [MIT License][license].
[rubygems]: https://rubygems.org/gems/ivapi
[codecov]: https://codecov.io/gh/jpalumickas/ivapi
[github_actions]: https://github.com/jpalumickas/ivapi/actions
[iv.lt]: https://www.iv.lt
[dedikuoti.lt]: https://www.dedikuoti.lt
[license]: https://raw.githubusercontent.com/jpalumickas/ivapi/master/LICENSE