No release in over 3 years
Low commit activity in last 3 years
salesforce-bulkapi-notifier notify to slack when failed jobs. e.g. When job state is Failed or Error is higher than Error rate.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.1
~> 10.0
~> 3.0

Runtime

 Project Readme

salesforce-bulkapi-notifier

Docker Repository on Quay Gem Version

Description

salesforce-bulkapi-notifier notify to slack when failed jobs. e.g. When job state is Failed or Error is higher than Error rate.

Table of Contents

  • salesforce-bulkapi-notifier
    • Description
    • Table of Contents
    • Requirements
    • Installation
      • Run in a Docker container
    • Usage
    • Options
    • Development
    • Contribution
    • Author
    • License
    • Code of Conduct

Created by gh-md-toc

Requirements

Installation

Add this line to your application's Gemfile:

gem 'salesforce-bulkapi-notifier'

And then execute:

$ bundle

Or install it yourself as:

$ gem install salesforce-bulkapi-notifier

Run in a Docker container

TBD

Usage

Please check example code

require 'salesforce-bulkapi-notifier'

SalesforceBulkAPINotifier.configure do |c|
  c.slack_api_token = ENV['SLACK_API_TOKEN'] # e.g. xxx-your-token-here
  c.slack_channel_name = ENV['SLACK_CHANNEL_NAME'] # Supported multi channel by using `,`. e,g #general,@kou
  c.salesforce_host = ENV['SALESFORCE_HOST'] # e.g. example.com
  c.salesforce_user_id = ENV['SALESFORCE_USER_ID'] # e.g. your@example.com
  c.salesforce_password = ENV['SALESFORCE_PASSWORD'] # e.g. your-password
  c.salesforce_client_id = ENV['SALESFORCE_CLIENT_ID'] # e.g. your-client-id
  c.salesforce_client_secret = ENV['SALESFORCE_CLIENT_SECRET'] # e.g. your-client-secret
end

SalesforceBulkAPINotifier.execute

Options

  • error_rate # default 10
  • interval_seconds # default 60
  • logger.level # default debug

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.

Contribution

Bug reports and pull requests are welcome on GitHub at https://github.com/koudaiii/salesforce-bulkapi-notifier. 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.

  1. Fork (https://github.com/koudaiii/salesforce-bulkapi-notifier/fork)
  2. Create a feature branch
  3. Commit your changes
  4. Rebase your local changes against the master branch
  5. Run test suite with the bundle exec rspec command and confirm that it passes
  6. Create a new Pull Request

Author

koudaiii

License

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

Code of Conduct

Everyone interacting in the Salesforce-bulkapi-notifier project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.