suez_mon_eau 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bb0b63f4f8e9e1da600d92123d83c4cd4998674d160e94ddd2ac238542d5c3b
+  data.tar.gz: e449685d94f7a73e1e46a86979164c91640ca3fdfb2d23b05e5df50142eca8f2
+SHA512:
+  metadata.gz: 7769f819f65e6e9ef84827a50d40c7c8e7c1bd601859345b3aebc220ab4154522cb88e06257b2e89e99dddc4c30d4a3d93783783bcb26d253e29ce5a34b9324b
+  data.tar.gz: 684487bd9e82fb073377fdcb2eaec9dee4dc2568acbc61b2b5cc3d544e05c0ec1b946a7e9fdc8e718fdb930e85ec9ee7831d1f9d2b4dcb7be4e0da887c768a25

data/bin/suez_mon_eau

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby -Ilib
+# frozen_string_literal: true
+
+require 'suez_mon_eau'
+require 'date'
+require 'optparse'
+
+options = {}
+opt_parser=OptionParser.new do |p|
+  p.banner = "Usage: #{$PROGRAM_NAME} [options]"
+  p.on('-u', '--username USER', 'Portal username', String){|v|options[:username] = v}
+  p.on('-p', '--password PASS', 'Portal password', String){|v|options[:password] = v}
+  p.on('-P', '--provider PROVIDER', 'Water Provider (Default: Suez)', String){|v|options[:provider] = v}
+  p.on('-i', '--id ID', 'Counter identifier', String){|v|options[:id] = v}
+  p.on('-d', '--debug', 'Turn on Rest trace', String){RestClient.log=$stderr}
+end
+opt_parser.parse!
+if %i[username password].any?{|i|options[i].nil?}
+  puts opt_parser
+  exit 1
+end
+suez = SuezMonEau.new(**options)
+puts('Contracts:')
+pp suez.contracts
+puts('Recent:')
+pp suez.monthly_recent
+puts('This Month:')
+pp suez.daily_for_month(DateTime.now)
+puts('Current:')
+pp suez.total_volume

data/lib/suez_mon_eau.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+
+# Volumes in m³
+class SuezMonEau
+  VERSION='0.1'
+  GEM_NAME='suez_mon_eau'
+  SRC_URL='https://github.com/laurent-martin/ruby-suez-mon-eau'
+  DOC_URL='https://github.com/laurent-martin/ruby-suez-mon-eau'
+  GEM_URL='https://github.com/laurent-martin/ruby-suez-mon-eau'
+  BASE_URIS = {
+    'Suez'       => 'https://www.toutsurmoneau.fr/mon-compte-en-ligne',
+    'Eau Olivet' => 'https://www.eau-olivet.fr/mon-compte-en-ligne'
+  }.freeze
+  API_ENDPOINT_LOGIN = 'je-me-connecte'
+  # daily (Jours) : /Y/m/counterid : Array(JJMMYYY, daily volume, cumulative volume). Volumes: .xxx
+  API_ENDPOINT_DAILY = 'statJData'
+  # monthly (Mois) : /counterid : Array(mmm. yy, monthly volume, cumulative voume, Mmmmm YYYY)
+  API_ENDPOINT_MONTHLY = 'statMData'
+  API_ENDPOINT_CONTRAT = 'donnees-contrats'
+  PAGE_CONSO = 'historique-de-consommation-tr'
+  SESSION_ID = 'eZSESSID'
+  MONTHS = %w[Janvier Février Mars Avril Mai Juin Juillet Août Septembre Octobre Novembre Décembre].freeze
+  private_constant :BASE_URIS,:API_ENDPOINT_LOGIN,:API_ENDPOINT_DAILY,:API_ENDPOINT_MONTHLY,:API_ENDPOINT_CONTRAT,:PAGE_CONSO,:SESSION_ID,:MONTHS
+
+  # @param provider optional, one of supported providers or base url
+  def initialize(username:, password:, id: nil, provider: 'Suez')
+    @base_uri = BASE_URIS[provider] || provider
+    raise 'Not a valid provider' if @base_uri.nil?
+    @username = username
+    @password = password
+    @id = id
+    @id=nil if @id.is_a?(String) && @id.empty?
+    @cookies = nil
+    return unless @id.nil?
+    update_access_cookie
+    conso_page=RestClient.get("#{@base_uri}/#{PAGE_CONSO}",cookies: @cookies)
+    # get counter id from page
+    raise 'Could not retrieve counter id' unless (token_match = conso_page.body.match(%r{/month/([0-9]+)}))
+    @id=token_match[1]
+  end
+
+  def update_access_cookie
+    initial_response = RestClient.get("#{@base_uri}/#{API_ENDPOINT_LOGIN}")
+    raise 'Could not get token' unless (token_match = initial_response.body.match(%r{_csrf_token" value="(.*)"/>}))
+    data = {
+      '_csrf_token'                => token_match[1],
+      '_username'                  => @username,
+      '_password'                  => @password,
+      'signin[username]'           => @username,
+      'signin[password]'           => nil,
+      'tsme_user_login[_username]' => @username,
+      'tsme_user_login[_password]' => @password
+    }
+    # There is a redirect (302) on POST
+    response = RestClient.post("#{@base_uri}/#{API_ENDPOINT_LOGIN}", data,
+      { cookies: initial_response.cookies }) do |resp, _req, _res|
+      case resp.code
+      when 301, 302, 307
+        begin
+          resp.follow_redirection
+        rescue RestClient::Found
+          raise 'Check username and password'
+        end
+      else resp.return!
+      end
+    end
+    raise StandardError, 'Login error: Please check your username/password.' unless response.cookies.key?(SESSION_ID)
+    @cookies = { SESSION_ID => response.cookies[SESSION_ID] }
+  end
+
+  def call_api(method:, endpoint:)
+    retried = false
+    loop do
+      update_access_cookie if @cookies.nil?
+      resp = RestClient::Request.execute(method: method, url: "#{@base_uri}/#{endpoint}", cookies: @cookies)
+      return JSON.parse(resp.body) if resp.headers[:content_type].include?('application/json')
+      raise 'Failed refreshing cookie' if retried
+      retried = true
+      @cookies = nil
+    end
+  end
+
+  def contracts
+    call_api(method: :get, endpoint: API_ENDPOINT_CONTRAT)
+  end
+
+  # @param thedate [Date] use year and month, built with Date.new(year,month,1)
+  # @return Hash [day_in_month]={day:, total:}
+  def daily_for_month(thedate)
+    r = call_api(method: :get, endpoint: "#{API_ENDPOINT_DAILY}/#{thedate.year}/#{thedate.month}/#{@id}")
+    # since the month is known, keep only day
+    r.each_with_object({}) do |i, m|
+      m[i[0].split('-').last.to_i] = { day: i[1], total: i[2] } unless i[2].eql?(0)
+    end
+  end
+
+  # @returns [Hash]
+  def monthly_recent
+    resp = call_api(method: :get, endpoint: "#{API_ENDPOINT_MONTHLY}/#{@id}")
+    h = {}
+    result = {
+      history:                h,
+      total_volume:           nil,
+      highest_monthly_volume: resp.pop,
+      last_year_volume:       resp.pop,
+      this_year_volume:       resp.pop
+    }
+    # fill history by hear and month
+    resp.each do |i|
+      # skip futures
+      next if i[2].eql?(0)
+      # date is Month Year
+      d = i[3].split(' ')
+      year = d.last.to_i
+      month = 1 + MONTHS.find_index(d.first)
+      h[year] ||= {}
+      h[year][month] = { month: i[1], total: result[:total_volume] = i[2] }
+    end
+    result
+  end
+
+  def total_volume
+    monthly_recent[:total_volume]
+  end
+end

data.tar.gz.sig

@@ -0,0 +1,2 @@
+�ȶ7�E��l�R1�^O[W�ӈ��^�*����0�>��D�͜��țB��>PҩI]τ�8�'���JK
[`�X͂��ȋWT*�U�J@�<9Xk���w_s+�St{�3�v���jC:�Z������?�V2e]ܯ4��
+_�{b7��jnC�%�cK.n9o��Z�0!���HHuQ��P�ƍ��x�P�XUm���gJ"qxX�,87Y�=�#$�I���(��]֝��b�'�>�&d�k�x9p�C���Ūp��F��?Z����&��40���4����ut�l���e����P,�"BT����7�ͺyi&7!X�C�"����_����E&�wtw�sh5^��d�����JX��_�e����K@W6շa�

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: suez_mon_eau
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Laurent Martin
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEkjCCAvqgAwIBAgIBATANBgkqhkiG9w0BAQsFADBHMRkwFwYDVQQDDBBsYXVy
+  ZW50Lm1hcnRpbi5sMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/Is
+  ZAEZFgNjb20wHhcNMjIxMjMwMTAyNjM0WhcNMjMxMjMwMTAyNjM0WjBHMRkwFwYD
+  VQQDDBBsYXVyZW50Lm1hcnRpbi5sMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzAR
+  BgoJkiaJk/IsZAEZFgNjb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIB
+  gQDZloSHnbKkBEh6fW03mhvaNkUsiyO3iPbXnE7cosW3VUIzXvDeNTMVkeDnqjA8
+  lW5jKb0MHaymJXjuybck0kGQNwtCPVl5m9e5lAqALVWYyI7K2XKfvl11/ai0tA5g
+  sZdcxJkCsBBeKrEUPAw/9pNEPwtWu+5MtYxK8gXvP5mNPQs+NZx42Wksgu+DO/tk
+  Ph/W9f4TWB6rrOq7xm7YzG8jYHRISV2fyW7NqpB6lB9y8444IosCz9RQ/fGcIdIg
+  LjnvX5rofI6IDfTbUq9fvkT3ZbrxgTzY09lG7heDrgL1L7a+U5G4FF1PNzmZxgqj
+  z+xU6mfaVVY1hgGK6EsDgsyM7QEcOGU5witL2yUkw3jYGm8jF3YdoSoZW+MKPfNf
+  v6yNTGJsJAVXlo//g+HRS6KGSfTx5M7cgRxGgud72h3PlOxgO/t8d7MTmRuo1oeU
+  pVmEUUsVtDSUJ3bdL5W85LCIV02VBPtw/rrg6AHFbrHRnp7FWcN1i20x+sk5ZBa4
+  C08CAwEAAaOBiDCBhTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU
+  IXrSEupwwYfE3a9f2jVz1wp4KGwwJQYDVR0RBB4wHIEabGF1cmVudC5tYXJ0aW4u
+  bEBnbWFpbC5jb20wJQYDVR0SBB4wHIEabGF1cmVudC5tYXJ0aW4ubEBnbWFpbC5j
+  b20wDQYJKoZIhvcNAQELBQADggGBAAhSXNutSwyrmpo/E/Fj3gNbMEL7uteveQ9J
+  jzsyp02PR6gaCkAIBWHigYTSI6+AW6vfFrCcRU7mVpGFDDTtYIZsthOU7G2mG0IY
+  uMXqZERShk+IjzpTDYQjvsmrQ7paQ7XYm1pS3cYzQqSwWP7unIcl0w13/JEcrQpz
+  w9Nk/JfICyOwnsNsGq/0SNSdrlNr1qUQQM/nmMEM6AvpKp7I4P2Ap4VJkDCu+0SK
+  x3mBvWB8GtmMOpto9ybr7El4xjfJpNu/kvKv2bbCQPs6Z/qfz0lYyK5JFqmhpQN7
+  E1Wj9oKIf+RH/1FYBdx2TaQ1ijkqpfwTa0QWRY4dU/GKGgBmMriGMIh8YAL9cmgd
+  HdwIbOaZ+pjC4nKKT38vsb2lNismhhaiAYq+Ekld50Rb0nbCPq7VfREn8uCJatpb
+  47kCk6UoPFdRvzdrQoOHQhkBuabk02iz6c35KbcKaogX8SDehA1/bO4F4VwLz4in
+  YmwAMTElT6RjOw71pAJ02LbhHG02SA==
+  -----END CERTIFICATE-----
+date: 2022-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.44'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.44'
+description: Retrieve water usage information from Suez in France
+email:
+- laurent.martin.l@gmail.com
+executables:
+- suez_mon_eau
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/suez_mon_eau
+- lib/suez_mon_eau.rb
+homepage: https://github.com/laurent-martin/ruby-suez-mon-eau
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/laurent-martin/ruby-suez-mon-eau
+  source_code_uri: https://github.com/laurent-martin/ruby-suez-mon-eau
+  changelog_uri: https://github.com/laurent-martin/ruby-suez-mon-eau
+  rubygems_uri: https://github.com/laurent-martin/ruby-suez-mon-eau
+  documentation_uri: https://github.com/laurent-martin/ruby-suez-mon-eau
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- No specific requirement
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Retrieve water usage information from Suez in France
+test_files: []