https://github.com/larevanchedessites/yooda-api-ruby-client
💎 Gem to wrap Yooda.com API
https://github.com/larevanchedessites/yooda-api-ruby-client
ruby ruby-gem ruby-library ruby-on-rails rubygem yooda-client
Last synced: 10 months ago
JSON representation
💎 Gem to wrap Yooda.com API
- Host: GitHub
- URL: https://github.com/larevanchedessites/yooda-api-ruby-client
- Owner: larevanchedessites
- License: mit
- Created: 2017-11-16T10:30:18.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-15T15:00:53.000Z (almost 8 years ago)
- Last Synced: 2025-02-25T09:42:46.305Z (11 months ago)
- Topics: ruby, ruby-gem, ruby-library, ruby-on-rails, rubygem, yooda-client
- Language: Ruby
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# A Ruby wrapper for the Yooda API
A simple and lightweight ruby module for working with Yooda via the Yooda API. Learn about the Yooda API at https://api.yooda.com/doc.
[La revanche des sites](http://www.la-revanche-des-sites.fr) ❤️ [Yooda](https://www.yooda.com), so if you have problems using the gem or would like to see support for new endpoints, please open an issue. We'll get it resolved as quick as we can.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'yooda-client'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install yooda-client
## Usage
```ruby
client = Yooda::Client.new(apikey: "ok")
client.credits
client.histories
client.histories(request_date: Date.today.strftime("%Y-%m-%d"))
client.histories(return_max: 2, return_initial_position: 2)
client.domain_informations("www.la-revanche-des-sites.fr")
client.domain_market_kpi(1484887)
client.keywords_market_by_domain(1484887, return_max: 2, return_initial_position: 2)
client.keyword_informations("SEO")
client.keyword_market_kpi(124)
client.keywords_market_by_keyword(124, return_max: 2, return_initial_position: 2)
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/larevanchedessites/yooda-api-ruby-client. 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.
## History
View the [changelog](https://github.com/larevanchedessites/yooda-api-ruby-client/blob/master/CHANGELOG.md). This gem follows [Semantic Versioning](http://semver.org/).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
See [LICENSE](https://github.com/larevanchedessites/yooda-api-ruby-client/blob/master/LICENSE.txt) for details.
## Code of Conduct
Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/larevanchedessites/yooda-api-ruby-client/blob/master/CODE_OF_CONDUCT.md).