tibber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64eba9e3ecaabcac3c6fa77b2d93bdd0a4808b9399a2094987aebfef332586c2
+  data.tar.gz: eca76b85e9d6d79961c27048046ebe4c6d3d42a5d2432367188b50a9ec1bc10c
+SHA512:
+  metadata.gz: fe85a0c01428961c7eb6f8ef27192ac4b49877b67d6031f37c9d850886fa5e6919bc9313d994dd9aa37fe733f77200a5be42070f015ec12245d2e4c9847e4839
+  data.tar.gz: 9a35eb84167e0f37606ccdce5f8340ed8e4332d856c190643c5a2c5018b6c0ef0a338b272efd1881e8c8923ffd9587ce13aac8990bd6c058e911e853dbed25d6

data/.env.template

@@ -0,0 +1,2 @@
+# demo token used
+TIBBER_ACCESS_TOKEN=5K4MVS-OjfWhK_4yrjOlFe1F6kJXPVf7eQYggo8ebAE

data/.gitignore

@@ -0,0 +1,45 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/data/
+*.log
+*.txt
+*.json
+*.yml
+.DS_Store
+
+# Used by dotenv library to load environment variables.
+.env
+
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-25
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hudu.gemspec
+gemspec

data/README.md

@@ -0,0 +1,102 @@
+# Tibber API
+[![Version](https://img.shields.io/gem/v/tibber.svg)](https://rubygems.org/gems/tibber)
+
+This is a wrapper for the Tibber rest API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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.
+
+```ruby
+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
+client.login
+
+```
+
+## Resources
+### Authentication
+```ruby
+# 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
+
+```ruby
+# show todays prices
+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
+
+```
+
+|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](lib/tibber/version.rb).
+2. Add release to [CHANGELOG.md](CHANGELOG.md)
+3. Commit.
+4. Test build.
+```
+> rake build
+
+```
+5. Release
+```
+> rake release
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/tibber.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'dotenv'
+require 'rake/testtask'
+
+Dotenv.load
+
+#system './bin/cc-test-reporter before-build'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+task default: %i[test rubocop]
+#system './bin/cc-test-reporter after-build'

data/lib/tibber/api.rb

@@ -0,0 +1,35 @@
+require "wrapi"
+require File.expand_path('request', __dir__)
+require File.expand_path('authorization', __dir__)
+
+module Tibber
+  # @private
+  class API
+
+    # @private
+    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API and copies settings from singleton
+    def initialize(options = {})
+      options = Tibber.options.merge(options)
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include WrAPI::Connection
+    include WrAPI::Request
+    include Request::GraphQL
+    include WrAPI::Authentication
+    include Authentication
+
+  end
+end

data/lib/tibber/authorization.rb

@@ -0,0 +1,19 @@
+require File.expand_path('error', __dir__)
+
+module Tibber
+  # Deals with authentication flow and stores it within global configuration
+  module Authentication
+
+    # Authorize to the Tibber portal using the access_token
+    # @see https://developer.tibber.com/docs/guides/calling-api
+    def login(options = {})
+      raise ConfigurationError, "Accesstoken/api-key not set" unless access_token
+      # only bearer token needed
+      # will do sanity check if token if valid
+      graphql_call('{viewer{name}}')
+    rescue GraphQLError => e
+      raise AuthenticationError.new e
+    end
+
+  end
+end

data/lib/tibber/client.rb

@@ -0,0 +1,177 @@
+require File.expand_path('api', __dir__)
+require File.expand_path('const', __dir__)
+require File.expand_path('error', __dir__)
+
+module Tibber
+  # Wrapper for the Tibber REST API
+  #
+  # @see https://developer.tibber.com/docs/overview
+  class Client < API
+    attr_accessor :information
+
+    def initialize(options = {})
+      super(options)
+      login
+      @information = self.info
+    rescue GraphQLError => e
+      raise AuthenticationError.new e
+    end
+
+  private
+    def self.api_endpoint(method, query)
+
+      # all records
+      self.send(:define_method, method) do |params = {}|
+        r = graphql_call(query, params)
+      end
+    end
+
+  public
+    # return device information
+    # product_type
+    # product_name
+    # serial
+    # firmware_version
+    # api_version
+    # devices: HWE-P1, HWE-SKT,	HWE-WTR, HWE-KWH1 and SDM230-wifi,	HWE-KWH3 and SDM630-wifi
+    api_endpoint :info, '
+    {
+      viewer {
+        name
+        userId
+        login
+        accountType
+        websocketSubscriptionUrl
+        homes {
+          id
+          timeZone
+          appNickname
+          appAvatar
+          size
+          type
+          numberOfResidents
+          primaryHeatingSource
+          hasVentilationSystem
+          mainFuseSize
+          address {
+            address1
+            address2
+            address3
+            city
+            postalCode
+            country
+            latitude
+            longitude
+          }
+          meteringPointData {
+            consumptionEan
+            gridCompany
+            gridAreaCode
+            priceAreaCode
+            productionEan
+            energyTaxType
+            vatType
+            estimatedAnnualConsumption
+          }
+          features {
+            realTimeConsumptionEnabled
+          }
+          subscriptions {
+            id
+            validFrom
+            validTo
+            status
+            priceRating {
+              thresholdPercentages {
+                high low
+              }
+              hourly {
+                minEnergy maxEnergy
+                minTotal maxTotal
+                currency
+              }
+              daily {
+                minEnergy maxEnergy
+                minTotal maxTotal
+                currency
+              }
+              monthly {
+                minEnergy maxEnergy
+                minTotal maxTotal
+                currency
+              }
+            }
+          }
+        }
+      }
+    }'
+    api_endpoint :price_info, '
+      {
+        viewer {
+          homes {
+            id
+            currentSubscription{
+              priceInfo{
+                current{
+                  startsAt
+                  total
+                  energy
+                  tax
+                  currency
+                }
+                today {
+                  startsAt
+                  total
+                  energy
+                  tax
+                  currency
+                }
+                tomorrow {
+                  startsAt
+                  total
+                  energy
+                  tax
+                  currency
+                }
+              }
+            }
+          }
+        }
+      }'
+    api_endpoint:_send_push_notification, '
+    mutation {
+      sendPushNotification(input: {
+        title: "%{title}",
+        message: "%{message}",
+        screenToOpen: %{screen_to_open}
+      }){
+        successful
+        pushedToNumberOfDevices
+      }
+    }'
+    def send_push_notification(title, message, screen_to_open)
+      _send_push_notification({ title: title, message: message, screen_to_open: screen_to_open }).sendPushNotification
+    end
+    api_endpoint :_consumption, '
+      {
+        viewer {
+          home(id:"%{id}") {
+            consumption(resolution: %{resolution}, last: %{count}) {
+              nodes {
+                from
+                to
+                cost
+                unitPrice
+                unitPriceVAT
+                consumption
+                consumptionUnit
+              }
+            }
+          }
+        }
+      }'
+    def consumption(home_id, resolution, count)
+      _consumption({ id: home_id, resolution: resolution, count: count })
+    end
+  end
+end

data/lib/tibber/const.rb

@@ -0,0 +1,22 @@
+
+module Tibber
+  class Enum
+      def self.enum(array)
+        array.each do |c|
+          const_set c,c
+        end
+      end
+  end
+  class Screens < Enum
+    enum %w[HOME REPORTS CONSUMPTION COMPARISON DISAGGREGATION HOME_PROFILE CUSTOMER_PROFILE METER_READING NOTIFICATIONS INVOICES]
+  end
+  class Resolution < Enum
+    enum %w[HOURLY DAILY WEEKLY MONTHLY ANNUAL]
+  end
+  class HomeType < Enum
+    enum %w[APARTMENT ROWHOUSE HOUSE COTTAGE]
+  end
+  class Avatar < Enum
+    enum %w[APARTMENT ROWHOUSE FLOORHOUSE1 FLOORHOUSE2 FLOORHOUSE3 COTTAGE CASTLE]
+  end
+end

data/lib/tibber/error.rb

@@ -0,0 +1,15 @@
+module Tibber
+
+  # Generic error to be able to rescue all Hudu errors
+  class TibberError < StandardError; end
+
+  # GraphQL returns error
+  class GraphQLError < TibberError; end
+
+  # GraphQL returns error
+  class ConfigurationError < TibberError; end
+
+  # Issue authenticting
+  class AuthenticationError < TibberError; end
+
+end

data/lib/tibber/request.rb

@@ -0,0 +1,37 @@
+require 'faraday'
+
+module Tibber
+  # Deals with requests
+  module Request
+
+    # JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. Primarily this
+    # specification defines several data structures and the rules around their processing. It is
+    # transport agnostic in that the concepts can be used within the same process, over sockets, over
+    # http, or in many various message passing environments. It uses JSON (RFC 4627) as data format.
+    #
+    # https://www.jsonrpc.org/specification
+    module GraphQL
+
+      def graphql_call(query, params = nil)
+        query = (query % params) if params && params.size > 0
+        options = {
+          "query": query
+        }
+        result = post( '', options )
+        raise GraphQLError.new(result.body['errors']) if result.body['errors']
+        data = result.body['data']
+        WrAPI::Request::Entity.create(data['viewer'] ? data['viewer'] : data)
+
+      rescue Faraday::BadRequestError => e
+        body = e.response[:body]
+        if body && body['errors']
+          error = body['errors']
+        else
+          error = e.to_s
+        end
+        raise GraphQLError.new(error)
+      end
+
+    end
+  end
+end

data/lib/tibber/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Tibber
+  VERSION = '0.1.0'
+end

data/lib/tibber.rb

@@ -0,0 +1,23 @@
+require "wrapi"
+require File.expand_path('tibber/client', __dir__)
+require File.expand_path('tibber/version', __dir__)
+
+module Tibber
+  extend WrAPI::Configuration
+  extend WrAPI::RespondTo
+
+  DEFAULT_UA = "Ruby Tibber API client #{Tibber::VERSION}".freeze
+  DEFAULT_ENDPOINT = 'https://api.tibber.com/v1-beta/gql'.freeze
+  #
+  # @return [Hudu::Client]
+  def self.client(options = {})
+    Tibber::Client.new({ user_agent: DEFAULT_UA, endpoint: DEFAULT_ENDPOINT }.merge(options))
+  end
+
+  def self.reset
+    super
+    self.endpoint   = nil
+    self.user_agent = DEFAULT_UA
+    self.endpoint   = DEFAULT_ENDPOINT
+  end
+end

data/tibber.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/tibber/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'tibber'
+  s.version     = Tibber::VERSION
+  s.authors     = ['Janco Tanis']
+  s.email       = 'gems@jancology.com'
+  s.license     = 'MIT'
+
+  s.summary     = 'A Ruby wrapper for the Tibber APIs (readonly)'
+  s.homepage    = 'https://rubygems.org/gems/tibber'
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/jancotanis/tibber'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.platform = Gem::Platform::RUBY
+  s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'wrapi', ">= 0.3.0"
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: tibber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janco Tanis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wrapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: gems@jancology.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.template"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/tibber.rb
+- lib/tibber/api.rb
+- lib/tibber/authorization.rb
+- lib/tibber/client.rb
+- lib/tibber/const.rb
+- lib/tibber/error.rb
+- lib/tibber/request.rb
+- lib/tibber/version.rb
+- tibber.gemspec
+homepage: https://rubygems.org/gems/tibber
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/tibber
+  source_code_uri: https://github.com/jancotanis/tibber
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.12
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for the Tibber APIs (readonly)
+test_files: []