dal

Dal

This is the DAL client gem created by the Sulu team for making queries to the DAL.

Installation

Add this line to your application's Gemfile:

gem 'dal', git: 'https://[e-mail]/3DSoftware/dal.git', :tag => 'tag-version'

And then execute:

$ bundle

Usage

To use this gem in your Rails project it will need some configuration.

Inside an initializer:

 Dal.configure do |config|
    config.logger = Rails.logger

    config.dal_api_key = DAL_API_KEY
    config.dal_api_secret = DAL_API_SECRET
    config.dal_api_service = DAL_API_SERVICE
    config.dal_api_base_url = DAL_API_BASE_URL
    config.dal_api_region = DAL_API_REGION
 end

UsageClient:

UsageClient.get_usage([aaa_device_ids], start_day, end_day, unit)

JobClient

JobClient.get_jobs([aaa_device_id], start_day, end_day)
JobClient.get_job_by_id(job_id)
JobClient.get_jobs_by_id([job_id])

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dal. 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.

Code of Conduct

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