CDG::Services

Codigo - Ruby on Rails Team's common services.

We adopted a microservice architecture in devising the approach of usage of this gem.

These services are functions that are expected to be commonly used among our projects.

This library serves to accumulate all this knowledge and speed up development without compromising quality and accuracy.

Add this line to your application's Gemfile:

gem 'cdg-services'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cdg-services

Get the latest app version of any iOS app; app_id is the id of the app in the form of numerics, eg. 12345678.

CDG::Services.get_ios_version(app_id: app_id) # returns `1.1.5`

Use Gem::Version.new(app_store_version) > Gem::Version.new(app_version) to compare versions

Get the latest app version of any Android app; app_id is the id of the app in the form of com.package.name.

CDG::Services.get_android_version(app_id: app_id) # returns `1.1.5`

Use Gem::Version.new(play_store_version) > Gem::Version.new(app_version) to compare versions

Send a message as an attachment to any slack channel via a Slack webhook, eg. https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX. See how to set up a Slack webhook and send message as attachment.

Set the webhook in your application's environment variable with the name SLACK_URL. This gem access the webhook using ENV['SLACK_URL'].

CDG::Services.ping_slack!(
  text: "test", # only this is mandatory
  channel: "#pings-tests",
  username: "test",
  color: ["good", "warning", "danger", "#af3131", "af3131"].sample,
  title: "test title",
  title_link: "https://www.codigo.co/",
  pretext: "test pretext",
  fields: [
    {
      title: "field 1 title",
      value: "field 1 value",
      short: true,
    },
    {
      title: "field 2 title",
      value: "field 2 value",
      short: true,
    },
    {
      title: "field 3 title",
      value: "This field 3 value is super loooooo oooooooooooooo ooooooooooooooo oooooooooooooong",
      short: false,
    },
  ]
)

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.

For collaborators, to publish gem, run gem build cdg-services.gemspec && gem push cdg-services-x.x.x.gem after version bump.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cdg-services. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the CDG::Services project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.