Tibber API

This is a wrapper for the Tibber rest API.

Installation

Add this line to your application's Gemfile:

gem 'tibber'

And then execute:

> bundle install

Or install it yourself as:

> gem install tibber

Usage

Before you start making the requests to API provide the endpoint and api key using the configuration wrapping.

require 'tibber'
require 'logger'

# use do block
Tibber.configure do |config|
  config.access_token = ENV['TIBBER_ACCESS_TOKEN']
  config.logger = Logger.new(TEST_LOGGER)
end

# or configure with options hash
client = Tibber.client(access_token: ENV['TIBBER_ACCESS_TOKEN'], logger: Logger.new(TEST_LOGGER))
client.login

Resources

Authentication

# setup
#
begin
  client = Tibber.client
  client.login
rescue Tibber::AuthenticationError => e
  puts "Error logging in tibber api"
  puts e
end

Graph QL Data resources

Endpoint for data related requests

# show todays prices; by default prices are per hour
prices = client.price_info

prices.homes.each do |home|
  puts "Today's prices:"
  home.currentSubscription.priceInfo.today.each do |hour|
    puts "#{hour.startsAt} #{hour.total} #{hour.currency} (#{hour.energy} + #{hour.tax})"
  end
end

# but also possible per quarter
prices = client.price_info(Tibber::Resolution::QUARTER_HOURLY)

Resource	API endpoint
.information	returns name userId login accountType websocketSubscriptionUrl homes including homes meteringPointData, subscriptions and features
.price_info	price information for all homes[id,currentSubscription{priceInfo{current,today[],tomorrow[]}}]
.consumption(home_id, resolution, count)	Array of home.consumption.nodes[]: from to cost unitPrice unitPriceVAT consumption consumptionUnit
.send_push_notification(title, message, screen_to_open)	send notificartion ot devices and returns successful & pushedToNumberOfDevices

Publishing

1. Update version in version.rb.
2. Add release to CHANGELOG.md
3. Commit.
4. Test build.

> rake test
> rake build

1. Release

> rake release

Contributing

Bug reports and pull requests are welcome on GitHub.

License

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