https://github.com/raihan2006i/iubenda_api
Iubenda Ruby Client
https://github.com/raihan2006i/iubenda_api
iubenda iubenda-api iubenda-policy iubenda-privacy ruby-client
Last synced: 4 months ago
JSON representation
Iubenda Ruby Client
- Host: GitHub
- URL: https://github.com/raihan2006i/iubenda_api
- Owner: raihan2006i
- License: mit
- Created: 2019-11-05T16:02:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-06T07:51:01.000Z (over 2 years ago)
- Last Synced: 2024-04-25T09:43:57.048Z (about 1 year ago)
- Topics: iubenda, iubenda-api, iubenda-policy, iubenda-privacy, ruby-client
- Language: Ruby
- Size: 46.9 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ruby Client for Iubenda HTTP APIs
This ruby client is an unofficial client
[](https://badge.fury.io/rb/iubenda_api) [](https://codeclimate.com/github/raihan2006i/iubenda_api/maintainability) [](https://circleci.com/gh/raihan2006i/iubenda_api)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'iubenda_api'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install iubenda_api
## Usage
This gem expects that you have already set `IUBENDA_API_KEY` environment variable. Use your Iubenda `Private key`
```ruby
# Subject
subject_id = 'testsubject'
IubendaApi::ConsentSolution::Subject.create(
id: subject_id,
email: "[email protected]",
first_name: "John",
last_name: "Doe",
full_name: "John Doe",
verified: false
) # -> #
IubendaApi::ConsentSolution::Subject.show(id) # -> #
IubendaApi::ConsentSolution::Subject.list # -> [#, ...]
IubendaApi::ConsentSolution::Subject.update(id, email: "[email protected]", first_name: "John", last_name: "Snow", full_name: 'John Snow') # -> #
# Consent
IubendaApi::ConsentSolution::Consent.create(
subject: {
id: 'testsubject',
email: '[email protected]',
first_name: "John",
last_name: "Doe",
verified: false
},
preferences: {
newsletter: false,
privacy_policy: true
}
) # -> #
IubendaApi::ConsentSolution::Consent.show('00b654b3-ce4d-45c9-a8aa-9450551579c0') # -> #
IubendaApi::ConsentSolution::Consent.list(limit: 1) # -> [#, ...]
# Legal Notice
# Single legal notice without multi-language content:
IubendaApi::ConsentSolution::LegalNotice.create(
identifier: "privacy_policy",
content: "privacy policy content"
) # -> #
# Single legal notice with multi-language content:
IubendaApi::ConsentSolution::LegalNotice.create(
identifier: "privacy_policy",
content: {
en: "privacy policy content",
it: "contenuto della privacy policy"
}
) # -> #
# Multiple legal notice without multi-language content:
IubendaApi::ConsentSolution::LegalNotice.create_multiple([
{
identifier: "privacy_policy",
content: "privacy policy content"
},
{
identifier: "cookie_policy",
content: "cookie policy content"
}
]) # -> [#, #]
# Multiple legal notice with multi-language content:
IubendaApi::ConsentSolution::LegalNotice.create_multiple([
{
identifier: "privacy_policy",
content: {
en: "privacy policy content",
it: "contenuto della privacy policy"
}
},
{
identifier: "cookie_policy",
content: {
en: "cookie policy content",
it: "contenuto della cookie policy"
}
},
]) # -> [#, #]
IubendaApi::ConsentSolution::LegalNotice.versions('privacy_policy') # -> [#, ...]
IubendaApi::ConsentSolution::LegalNotice.version('privacy_policy', 1) # -> #
IubendaApi::ConsentSolution::LegalNotice.list(limit: 1) # -> [# id="10298_privacy_policy" identifier="privacy_policy" owner_id="1000" timestamp="2019-11-22T14:12:06+00:00" version=1>, ...]
```
## 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/raihan2006i/iubenda_api. 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 IubendaApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/iubenda_api/blob/master/CODE_OF_CONDUCT.md).