SatusehatClient
TODO: Delete this and the text below, and describe your gem
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/satusehat_client
. To experiment with that code, run bin/console
for an interactive prompt.
Set Enviroment
You must set the enviroment before applying in this gem to your app.
SATUSEHAT_CLIENT_ID
for set Client IdSATUSEHAT_CLIENT_SECRET
for set Client SecretSATUSEHAT_ID_ORGANIZATION
for set Id OrganizationSATUSEHAT_BASE_URL
for set Base UrlSATUSEHAT_AUTH_URL
for set Auth UrlSATUSEHAT_REDIS_URL
AND SATUSEHAT_REDIS_PORT
- this gem using redis for save cache. You can insall redis with docker like this :
docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
to more documentation for redis, please read this redis-stack-install-with-docker.
Step by step for that, you can set with teriminal or with Gem for Enviroment management such as gem figaro
or gem env
Installation
TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
Install the gem and add to the application's Gemfile by executing:
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
How to Use
Usage
TODO: Write usage instructions here
Development
After checking out the repo, run bin/setup
to install dependencies. 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 the created tag, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/patti8/satusehat_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the SatusehatClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
satusehat_client