my_tado 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 015430353e51fc1f2a947573f6f59536a1a221ca027d2c6c48b9b5e578a860bf
-  data.tar.gz: 580a0498666d8efdf55aa1d262cc85c8611bdf091fcd6c7934a99736da62e9ac
+  metadata.gz: 6f975cc9f1cace37124934514f0f40d6c3e2bcf775c6fca9a31581dfb06bfc7b
+  data.tar.gz: 1cb76dadc5a24ce68e0f849aca4a0a1f2dd7bfac6197c86a54f9b913c2b330a8
 SHA512:
-  metadata.gz: 9641dec73aaf5244769a4760dabb6edb536fc8fc6b8ba0d64773af9b5775b0d8416147967401c9614d56e5df64023aabc0fb1e3a305c7d7846ef7a26a88cb87e
-  data.tar.gz: 9db05b3bb6bdde2faec471378c9a19d5257745b58c8bbf5bcd32cc9b2ccc7d5e46a88b1c66fc85bbfdd5cc263879336559b4e84217046bd53f46b94dc114bbfa
+  metadata.gz: be1ca88c32e3b4bdacae421c8263fc6874670851dbb44211692f672d6b3f9f2ba8aef0925f01ed4fb36fa4c7845a48e936405994574c3f88046803bedd2d820a
+  data.tar.gz: d854ba9699a3b2255a08ee9c245f27cd25e867cf8f30ea36c5eab443edea61c79a4b4e393dec7f6252293cabe1a72bd666f1b23f3b97d74a555b9145afa01943

data/CHANGELOG.md

@@ -1,3 +1,6 @@
-## [Releases]
-
+## [Releases]
+
+- 0.2 - 30th Jul 2022
+  - Added dayReport endpoint - detailed data from a zone for a specific day
+  - Fixed the code that automatically converts date to DateTime objects
 - 0.1 - 25th Jul 2022 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_tado (0.1.0)
+    my_tado (0.2.0)
       httparty (~> 0.17.3)
 
 GEM
@@ -14,7 +14,7 @@ GEM
       multi_xml (>= 0.5.2)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.1115)
+    mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
     parallel (1.21.0)
     parser (3.0.2.0)

data/README.md

@@ -1,89 +1,95 @@
-# MyTado
-
-A Ruby wrapper for interacting with Tado's v2 API.
-
-The API is officially undocumented so there are no guarantees that this will work for you!
-
-## Installation
-
-`gem install my_tado`
-
-## Usage
-
-To connect to Tado's API, you need to have a username, password, and (optionally) client_secret.
-
-At time of writing, the client_secret that is widely used is `wZaRN7rpjn3FoNyF5IFuxg9uMzYJcvOoQ8QWiIqS3hfk6gLhVlG57j5YNoZL2Rtc`, so if you do not provide a client_secret of your own, MyTado will use that one. See https://shkspr.mobi/blog/2019/02/tado-api-guide-updated-for-2019/ for more information on this.
-
-Once you have all three, you can put them into MyTado either as a hash (using strings or symbols as keys), or a YML file (for example, see [secrets.example.yml](https://github.com/reedstonefood/my_tado/blob/master/lib/secrets.example.yml)), like so:
-
-```ruby
-# Using a hash
-credentials = { username: "foo@example.com", password: "terrible_password" }
-tado = MyTado.new(credentials)
-
-# Or, using a YML file
-tado = MyTado.new("secrets.yml")
-```
-
-Once initialized you can call other endpoints like so:
-
-```ruby
-tado.home # no extra parameters needed
-tado.zone_state({zone_id: 0}) # an example where a parameter is needed
-```
-
-## Endpoints
-
-- `me` - your account information - name, email etc.
-- `home` - information about your home, address, contact details
-- `presence` - returns whether tado thinks your presence is HOME or AWAY
-- `weather` - the external weather for your home
-- `zones` - a lot of information about your installation
-- `zone_state` (requires `zone_id`) - information about your hot water or heating
-
-## Responses
-
-The response object that MyTado returns from the endpoints has the following methods:
-
-- `raw_response` if you want the HTTParty response class
-- `["thing"]` for looking at the response
-- `ok?` - a convenience method for `raw_response.ok?` which lets you know if the response was an HTTP 200 or not.
-
-Differences between `raw_response["thing"]` and `["thing"]` are:
-- ~~`["thing"]` will have automatically converted dates into Ruby Date objects to make it easier to use.~~ doesn't work yet
-
-## Example usage
-
-```ruby
-credentials = { username: "foo@example.com", password: "terrible_password" }
-tado = MyTado.new(credentials)
-
-# Get the state of every zone
-zones_state = tado.zones.map { |zone| tado.zone_state(zone["id"]) }
-
-# Get the temperature in every zone, in celsius
-acutal_temperatures = zone_states.map do |zone_state|
-  zone_state.dig('sensorDataPoints', 'insideTemperature', 'celsius')
-end
-```
-
-## Running tests
-
-~~There is no known test environment, so if you want to run tests you have to use your own Tado username and password. Don't worry, the tests only read data, they do not make any changes to your tado setup.~~
-
-~~Put your username & password into spec/spec_helper, in the `test_username` and `test_password` methods. Then run `rspec spec`.~~
-None of the tests that have been written test the actual API, they only test internal aspects of the client.
-
-## Future development
-
-This gem does what I want to do for my own purposes. I may add to it in the future, or I may not.
-
-If you want to expand the functionality, feel free to fork it or raise a PR.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Helpful resources
-
-https://shkspr.mobi/blog/2019/02/tado-api-guide-updated-for-2019/
+# MyTado
+
+A Ruby wrapper for interacting with Tado's v2 API.
+
+The API is officially undocumented so there are no guarantees that this will work for you!
+
+## Installation
+
+`gem install my_tado`
+
+## Usage
+
+To connect to Tado's API, you need to have a username, password, and (optionally) client_secret.
+
+At time of writing, the client_secret that is widely used is `wZaRN7rpjn3FoNyF5IFuxg9uMzYJcvOoQ8QWiIqS3hfk6gLhVlG57j5YNoZL2Rtc`, so if you do not provide a client_secret of your own, MyTado will use that one. See https://shkspr.mobi/blog/2019/02/tado-api-guide-updated-for-2019/ for more information on this.
+
+Once you have all three, you can put them into MyTado either as a hash (using strings or symbols as keys), or a YML file (for example, see [secrets.example.yml](https://github.com/reedstonefood/my_tado/blob/master/lib/secrets.example.yml)), like so:
+
+```ruby
+# Using a hash
+credentials = { username: "foo@example.com", password: "terrible_password" }
+tado = MyTado.new(credentials)
+
+# Or, using a YML file
+tado = MyTado.new("secrets.yml")
+```
+
+Once initialized you can call other endpoints like so:
+
+```ruby
+tado.home # no extra parameters needed
+
+tado.zone_state(zone_id: 0) # an example where a parameter is needed
+
+# treat the output as an Array/Hash
+tado.zones.map { |zone| zone["name"] } # gives the names of all zones
+```
+
+## Endpoints
+
+- `day_report` - detailed data from a zone for a specific day
+- `me` - your account information - name, email etc.
+- `home` - information about your home, address, contact details
+- `presence` - returns whether tado thinks your presence is HOME or AWAY
+- `weather` - the external weather for your home
+- `zones` - a lot of information about your installation
+- `zone_state` (requires `zone_id`) - information about your hot water or heating
+
+## Responses
+
+The response object that MyTado returns from the endpoints has the following methods:
+
+- `raw_response` if you want the HTTParty response class
+- `["thing"]` for looking at the response
+- `ok?` - a convenience method for `raw_response.ok?` which lets you know if the response was an HTTP 200 or not.
+
+Differences between `raw_response["thing"]` and `["thing"]` are:
+- `["thing"]` will have automatically converted dates into Ruby Date objects to make it easier to use.
+- You can call regular Array/Hash methods on ["thing"] directly, eg `tado.zones.count`. Easy!
+
+## Example usage
+
+```ruby
+credentials = { username: "foo@example.com", password: "terrible_password" }
+tado = MyTado.new(credentials)
+
+# Get the state of every zone
+zones_state = tado.zones.map { |zone| tado.zone_state(zone["id"]) }
+
+# Get the temperature in every zone, in celsius
+acutal_temperatures = zone_states.map do |zone_state|
+  zone_state.dig('sensorDataPoints', 'insideTemperature', 'celsius')
+end
+```
+
+## Running tests
+
+~~There is no known test environment, so if you want to run tests you have to use your own Tado username and password. Don't worry, the tests only read data, they do not make any changes to your tado setup.~~
+
+~~Put your username & password into spec/spec_helper, in the `test_username` and `test_password` methods. Then run `rspec spec`.~~
+None of the tests that have been written test the actual API, they only test internal aspects of the client.
+
+## Future development
+
+This gem does what I want to do for my own purposes. I may add to it in the future, or I may not.
+
+If you want to expand the functionality, feel free to fork it or raise a PR.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Helpful resources
+
+https://shkspr.mobi/blog/2019/02/tado-api-guide-updated-for-2019/

data/lib/my_tado/client.rb

@@ -5,7 +5,7 @@ require 'httparty'
 module MyTado
   # The main object from where everything else happens
   class Client
-    IMPLEMENTED_ENDPOINTS = %i[me home presence weather zones zone_state].freeze
+    IMPLEMENTED_ENDPOINTS = %i[me day_report home presence weather zones zone_state].freeze
 
     def initialize(credentials_source)
       @credentials_source = credentials_source

data/lib/my_tado/request/day_report.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module MyTado
+  module Request
+    # Calls the /dayReport endpoint
+    class DayReport < AbstractRequest
+      def endpoint
+        "/v2/homes/#{options[:home_id]}/zones/#{options[:zone_id]}/dayReport?date=#{formatted_date}"
+      end
+
+      def formatted_date
+        Date.parse(options[:date]).strftime('%Y-%m-%d')
+      end
+    end
+  end
+end

data/lib/my_tado/response/abstract_response.rb

@@ -4,14 +4,11 @@ require 'forwardable'
 
 module MyTado
   module Response
-    # Make response a bit easier to deal with in Ruby
+    # Make response a bit easier to deal with in Ruby, largely by
+    # converting datetimes to Ruby DateTime objects
     class AbstractResponse
       attr_reader :raw_response
 
-      extend Forwardable
-
-      def_delegators :@parsed_response, :[]
-
       def initialize(raw_response)
         @raw_response = raw_response
         parse
@@ -22,23 +19,46 @@ module MyTado
       end
 
       def parse
-        @parsed_response = recursive_parse(raw_response)
+        @parsed_response = recursive_parse(raw_response.parsed_response)
+      end
+
+      def method_missing(method_name, *args, &block)
+        if @parsed_response.respond_to?(method_name)
+          @parsed_response.public_send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, *_args)
+        @parsed_response.respond_to?(method_name)
       end
 
       private
 
       def recursive_parse(original)
-        original.transform_values do |value|
-          if value.is_a?(Hash)
-            recursive_parse(value)
-          elsif iso8601_string?(value)
-            Date.parse(value)
-          else
-            value
+        case original
+        when Hash
+          original.transform_values do |value|
+            clever_parse(value)
+          end
+        when Array
+          original.map do |value|
+            clever_parse(value)
           end
         end
       end
 
+      def clever_parse(value)
+        if value.is_a?(Hash) || value.is_a?(Array)
+          recursive_parse(value)
+        elsif iso8601_string?(value)
+          DateTime.parse(value)
+        else
+          value
+        end
+      end
+
       # Try to identify dates, which Tado's API always sends in a consistent format
       def iso8601_string?(value)
         value.is_a?(String) &&

data/lib/my_tado/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module MyTado
-  VERSION = "0.1.0"
-end
+# frozen_string_literal: true
+
+module MyTado
+  VERSION = "0.2.0"
+end

data/lib/my_tado.rb

@@ -5,6 +5,7 @@ require_relative "my_tado/credential_getter"
 require_relative "my_tado/oauth_client"
 require_relative "my_tado/version"
 require_relative "my_tado/request/abstract_request"
+require_relative "my_tado/request/day_report"
 require_relative "my_tado/request/me"
 require_relative "my_tado/request/home"
 require_relative "my_tado/request/presence"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_tado
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - reedstonefood
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-25 00:00:00.000000000 Z
+date: 2022-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -48,6 +48,7 @@ files:
 - lib/my_tado/credential_getter.rb
 - lib/my_tado/oauth_client.rb
 - lib/my_tado/request/abstract_request.rb
+- lib/my_tado/request/day_report.rb
 - lib/my_tado/request/home.rb
 - lib/my_tado/request/me.rb
 - lib/my_tado/request/presence.rb