tibber 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64eba9e3ecaabcac3c6fa77b2d93bdd0a4808b9399a2094987aebfef332586c2
-  data.tar.gz: eca76b85e9d6d79961c27048046ebe4c6d3d42a5d2432367188b50a9ec1bc10c
+  metadata.gz: ad415b5607dc399b32cbeca2414445c8aa5c13945d7e831168b61be8ba4c5680
+  data.tar.gz: c07a1c65eecbb6afb61d1c08bfa8c0b3980b1690a30a246a6033422327b3ad30
 SHA512:
-  metadata.gz: fe85a0c01428961c7eb6f8ef27192ac4b49877b67d6031f37c9d850886fa5e6919bc9313d994dd9aa37fe733f77200a5be42070f015ec12245d2e4c9847e4839
-  data.tar.gz: 9a35eb84167e0f37606ccdce5f8340ed8e4332d856c190643c5a2c5018b6c0ef0a338b272efd1881e8c8923ffd9587ce13aac8990bd6c058e911e853dbed25d6
+  metadata.gz: afa6b65748b4cf01c1d524cbce1c1dea093460f9b9de63dde564a723ec754ce4d66071661317fa1d96d5d889b61b967dd600be252e77f9a57ac0b958e05ec2bb
+  data.tar.gz: 682d3a9280953ec497e506a769447864a5053c8188843020f335f37166754736e5a3891b16a092e790fff61ee62e32cbd920576df38cb9f84a680c8030fb4d99

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## [Unreleased]
+## Changelog
 
 ## [0.1.0] - 2024-02-25
 - Initial release
+
+## [0.1.1] - 2025-03-20
+- update tests, simplify some code, add docs

data/Gemfile

@@ -2,5 +2,5 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in hudu.gemspec
+# Specify your gem's dependencies in tibber.gemspec
 gemspec

data/README.md

@@ -1,9 +1,9 @@
 # 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:
@@ -14,11 +14,15 @@ gem 'tibber'
 
 And then execute:
 
-    $ bundle install
+```console
+> bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install tibber
+```console
+> gem install tibber
+```
 
 ## Usage
 
@@ -41,7 +45,9 @@ client.login
 ```
 
 ## Resources
+
 ### Authentication
+
 ```ruby
 # setup
 #
@@ -54,9 +60,8 @@ rescue Tibber::AuthenticationError => e
 end
 ```
 
-
-
 ### Graph QL Data resources
+
 Endpoint for data related requests
 
 ```ruby
@@ -85,13 +90,16 @@ end
 2. Add release to [CHANGELOG.md](CHANGELOG.md)
 3. Commit.
 4. Test build.
-```
-> rake build
 
+```console
+> rake test
+> rake build
 ```
 5. Release
-```
+
+```console
 > rake release
+```
 
 ## Contributing
 

data/lib/tibber/api.rb

@@ -1,12 +1,11 @@
-require "wrapi"
+# frozen_string_literal: true
+
+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
@@ -30,6 +29,5 @@ module Tibber
     include Request::GraphQL
     include WrAPI::Authentication
     include Authentication
-
   end
 end

data/lib/tibber/authorization.rb

@@ -1,19 +1,19 @@
+# frozen_string_literal: true
+
 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
+    def login(_options = {})
+      raise ConfigurationError, 'Accesstoken/api-key not set' unless access_token
+
+      # only bearer token needed will do sanity check if token is valid by callig api
       graphql_call('{viewer{name}}')
     rescue GraphQLError => e
       raise AuthenticationError.new e
     end
-
   end
 end

data/lib/tibber/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('api', __dir__)
 require File.expand_path('const', __dir__)
 require File.expand_path('error', __dir__)
@@ -17,16 +19,13 @@ module Tibber
       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)
+        graphql_call(query, params)
       end
     end
 
-  public
     # return device information
     # product_type
     # product_name

data/lib/tibber/const.rb

@@ -1,22 +1,98 @@
+# frozen_string_literal: true
 
 module Tibber
+  # The `Enum` class provides a way to define constant-based enumerations dynamically.
   class Enum
-      def self.enum(array)
-        array.each do |c|
-          const_set c,c
-        end
+    # Defines constants from an array of symbols or strings.
+    #
+    # @param array [Array<Symbol, String>] List of values to be set as constants.
+    # @example
+    #   class Colors < Enum
+    #     enum %w[RED GREEN BLUE]
+    #   end
+    #
+    #   Colors::RED   # => "RED"
+    #   Colors::GREEN # => "GREEN"
+    #
+    # The above example dynamically defines constants `RED`, `GREEN`, and `BLUE` inside the `Colors` class.
+    def self.enum(array)
+      array.each do |cnst|
+        const_set cnst, cnst
       end
+    end
   end
+
+  # The `Screens` class defines a set of screen names as constants.
+  # It inherits from `Enum` and uses the `enum` method to define constants dynamically.
   class Screens < Enum
-    enum %w[HOME REPORTS CONSUMPTION COMPARISON DISAGGREGATION HOME_PROFILE CUSTOMER_PROFILE METER_READING NOTIFICATIONS INVOICES]
+    # Defines screen names as constants.
+    #
+    # @example Usage:
+    #   Screens::HOME            # => "HOME"
+    #   Screens::REPORTS         # => "REPORTS"
+    #   Screens::NOTIFICATIONS   # => "NOTIFICATIONS"
+    #
+    # This dynamically defines the following constants:
+    # - HOME
+    # - REPORTS
+    # - CONSUMPTION
+    # - COMPARISON
+    # - DISAGGREGATION
+    # - HOME_PROFILE
+    # - CUSTOMER_PROFILE
+    # - METER_READING
+    # - NOTIFICATIONS
+    # - INVOICES
+    enum %w[
+      HOME REPORTS CONSUMPTION COMPARISON DISAGGREGATION 
+      HOME_PROFILE CUSTOMER_PROFILE METER_READING NOTIFICATIONS INVOICES
+    ]
   end
+
+  # The `Resolution` class defines different time resolutions as constants.
+  # It inherits from `Enum` and dynamically sets constants using `enum`.
+  #
+  # @example Usage:
+  #   Resolution::HOURLY   # => "HOURLY"
+  #   Resolution::DAILY    # => "DAILY"
   class Resolution < Enum
+    # Defines time resolution constants:
+    # - HOURLY
+    # - DAILY
+    # - WEEKLY
+    # - MONTHLY
+    # - ANNUAL
     enum %w[HOURLY DAILY WEEKLY MONTHLY ANNUAL]
   end
+
+  # The `HomeType` class defines different types of homes as constants.
+  #
+  # @example Usage:
+  #   HomeType::APARTMENT   # => "APARTMENT"
+  #   HomeType::HOUSE       # => "HOUSE"
   class HomeType < Enum
+    # Defines home type constants:
+    # - APARTMENT
+    # - ROWHOUSE
+    # - HOUSE
+    # - COTTAGE
     enum %w[APARTMENT ROWHOUSE HOUSE COTTAGE]
   end
+
+  # The `Avatar` class defines different avatar types as constants.
+  #
+  # @example Usage:
+  #   Avatar::COTTAGE   # => "COTTAGE"
+  #   Avatar::CASTLE    # => "CASTLE"
   class Avatar < Enum
+    # Defines avatar type constants:
+    # - APARTMENT
+    # - ROWHOUSE
+    # - FLOORHOUSE1
+    # - FLOORHOUSE2
+    # - FLOORHOUSE3
+    # - COTTAGE
+    # - CASTLE
     enum %w[APARTMENT ROWHOUSE FLOORHOUSE1 FLOORHOUSE2 FLOORHOUSE3 COTTAGE CASTLE]
   end
 end

data/lib/tibber/error.rb

@@ -1,5 +1,6 @@
-module Tibber
+# frozen_string_literal: true
 
+module Tibber
   # Generic error to be able to rescue all Hudu errors
   class TibberError < StandardError; end
 
@@ -11,5 +12,4 @@ module Tibber
 
   # Issue authenticting
   class AuthenticationError < TibberError; end
-
 end

data/lib/tibber/request.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 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
@@ -11,27 +12,33 @@ module Tibber
     #
     # https://www.jsonrpc.org/specification
     module GraphQL
-
+      ##
+      # Executes a GraphQL query with optional parameters.
+      #
+      # @param query [String] The GraphQL query string.
+      # @param params [Hash, nil] (optional) Parameters to be interpolated into the query.
+      # @return [WrAPI::Request::Entity] The parsed response data.
+      # @raise [GraphQLError] If the response contains GraphQL errors.
+      #
+      # @example Basic GraphQL call
+      #   query = "{ user(id: %d) { name email } }"
+      #   graphql_call(query, { id: 123 })
+      #
       def graphql_call(query, params = nil)
-        query = (query % params) if params && params.size > 0
+        query = (query % params) if params&.any?
         options = {
           "query": query
         }
-        result = post( '', options )
+        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)
 
+        data = result.body['data']
+        WrAPI::Request::Entity.create(data['viewer'] || data)
       rescue Faraday::BadRequestError => e
         body = e.response[:body]
-        if body && body['errors']
-          error = body['errors']
-        else
-          error = e.to_s
-        end
+        error = body&.dig('errors') || e.to_s
         raise GraphQLError.new(error)
       end
-
     end
   end
 end

data/lib/tibber/version.rb

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

data/lib/tibber.rb

@@ -1,19 +1,51 @@
-require "wrapi"
+# frozen_string_literal: true
+
+require 'wrapi'
 require File.expand_path('tibber/client', __dir__)
 require File.expand_path('tibber/version', __dir__)
 
+# The `Tibber` module provides an API client for interacting with the Tibber GraphQL API.
+# It extends `WrAPI::Configuration` and `WrAPI::RespondTo`, enabling configuration handling.
+#
+# @example Creating a client instance:
+#   client = Tibber.client(api_key: "your-api-key")
+#
+# @example Resetting the client configuration:
+#   Tibber.reset
+#
 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
+  # Default User-Agent string for API requests.
+  DEFAULT_UA = "Ruby Tibber API client #{Tibber::VERSION}"
+
+  # Default API endpoint for Tibber.
+  DEFAULT_ENDPOINT = 'https://api.tibber.com/v1-beta/gql'
+
+  # Creates a new instance of the Tibber API client.
+  #
+  # @param options [Hash] Optional configuration overrides.
+  # @option options [String] :user_agent Custom user agent string.
+  # @option options [String] :endpoint Custom API endpoint.
   #
-  # @return [Hudu::Client]
+  # @return [Tibber::Client] The initialized API client.
+  #
+  # @example Creating a client with default settings:
+  #   client = Tibber.client
+  #
+  # @example Creating a client with a custom user agent:
+  #   client = Tibber.client(user_agent: "My Custom UA")
   def self.client(options = {})
     Tibber::Client.new({ user_agent: DEFAULT_UA, endpoint: DEFAULT_ENDPOINT }.merge(options))
   end
 
+  # Resets the Tibber module's configuration to default values.
+  #
+  # @example Resetting the configuration:
+  #   Tibber.reset
+  #
+  # @return [void]
   def self.reset
     super
     self.endpoint   = nil

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tibber
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Janco Tanis
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,7 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: gems@jancology.com
 executables: []
 extensions: []
@@ -121,7 +119,6 @@ licenses:
 metadata:
   homepage_uri: https://rubygems.org/gems/tibber
   source_code_uri: https://github.com/jancotanis/tibber
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.12
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby wrapper for the Tibber APIs (readonly)
 test_files: []