portfolio_manager 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 177b5b07384c5f9c24b5cb9ef69cb1517af02f1f76d9af1cc74eab9654dfe477
-  data.tar.gz: 87ae59aa73df92530ae4c6ea1feb139a4e8b964c6a6ca3ad39fc6249cf3acd9f
+  metadata.gz: c11e10b4cc1d39ef7786f32cb008592026541cf755281d8cbdccf24158c7241d
+  data.tar.gz: 9e85f566088fcd0ef283e4d11a6fbea65c1c15c7ecb705ff7b55cbf0a13e1978
 SHA512:
-  metadata.gz: a85026346412c4a627b41518f0b7967e113f7f6679738ff153e8953b3a1c5da587f499c4a5b635d867121d0f0fffc6e0fe9bcbdcf6f5700caf184234da16381d
-  data.tar.gz: 4ccfa27318accc589869fe8676f749c64a8a59e02f29cf02cb7a5f5e77622c3decb5faf4d3b14721ded9013481a7003a44e2afa49204fdcf96da17f263b66634
+  metadata.gz: 174a443420fd097fb6df1aebd5cf6468795619c5afc2f4ebc0bb4e00517490c152d2297d38ff7bac8810a8b15b42b90e5cf1717b6b6522790ab6662e8b7e14bf
+  data.tar.gz: 8201b5eb4197ed16def24025a4e5d13599ba46c89234f7ba47911fd6e2e92b08d06c6dbc2808280f931eb51a063d49ac52fdbe3bb3f5f5edb4ca29035bffab62

data/README.md

@@ -66,7 +66,14 @@ HTTP | Path | Method | Description
 ---- | ---- | ------ | -----------
 GET | /meter/(meterId) | `meter(meter_id)` | 	Returns information for a specified meter.
 GET | /property/(propertyId)/meter/list	| `meter_list(property_id)` | Returns a list of meters for a specified property.
-GET | /meter/(meterId)/consumptionData?page=(page)&startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD) | `metrics(property_id, year, month, measurement_system, metric)` | Returns the consumption data for a specified meter in sets of 20.
+GET | /meter/(meterId)/consumptionData?page=(page)&startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD) | `consumption_data(meter_id, page: nil, start_date: nil, end_date: nil)` | Returns the consumption data for a specified meter in sets of 120.
+
+#### Reporting Services
+https://portfoliomanager.energystar.gov/webservices/home/api/reporting
+
+HTTP | Path | Method | Description
+---- | ---- | ------ | -----------
+GET | /property/(propertyId)/metrics | `property_metrics(property_id, year, month, measurement_system, metric)` | Returns the values for a specified set of metrics and units for a specific property and period ending date. The property must already be shared with you.
 
 #### Connection/Share Services
 https://portfoliomanager.energystar.gov/webservices/home/api/connection

data/lib/portfolio_manager/rest/api.rb

@@ -5,6 +5,7 @@ require 'portfolio_manager/rest/building'
 require 'portfolio_manager/rest/data_exchange_settings'
 require 'portfolio_manager/rest/meter'
 require 'portfolio_manager/rest/property'
+require 'portfolio_manager/rest/reporting'
 require 'portfolio_manager/rest/customer'
 require 'portfolio_manager/rest/connection'
 require 'portfolio_manager/rest/share'
@@ -20,6 +21,7 @@ module PortfolioManager
       include PortfolioManager::REST::DataExchangeSettings
       include PortfolioManager::REST::Meter
       include PortfolioManager::REST::Property
+      include PortfolioManager::REST::Reporting
       include PortfolioManager::REST::Customer
       include PortfolioManager::REST::Connection
       include PortfolioManager::REST::Share

data/lib/portfolio_manager/rest/meter.rb

@@ -29,16 +29,18 @@ module PortfolioManager
         perform_get_request("/property/#{property_id}/meter/list")
       end
 
-      def metrics(property_id, year, month, measurement_system, metric)
-        perform_get_request(
-          "/property/#{property_id}/metrics",
-          query: {
-            year: year, month: month, measurementSystem: measurement_system
-          },
-          header: {
-            'PM-Metrics' => metric
-          }
-        )
+      ##
+      # This web service retrieves a list of consumption data for a specific
+      # meter. The meter must already be shared with you.
+      #
+      # @see https://portfoliomanager.energystar.gov/webservices/home/api/meter/consumptionData/get
+      # page_link template:
+      # "/meter/#{meter_id}/consumptionData/?page=#{page}&startDate=#{start_date}&endDate=#{end_date}"
+      def consumption_data(meter_id, page: nil, start_date: nil, end_date: nil)
+        query_string = URI.encode_www_form({ page: page, startDate: start_date, endDate: end_date }.reject! {|k,v| v.nil?})
+        resource_path = "/meter/#{meter_id}/consumptionData"
+        link = query_string.empty? ? resource_path : "#{resource_path}?#{query_string}"
+        perform_get_request(link)
       end
     end
   end

data/lib/portfolio_manager/rest/reporting.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'portfolio_manager/rest/utils'
+
+module PortfolioManager
+  module REST
+    module Reporting
+      include PortfolioManager::REST::Utils
+
+      def property_metrics(property_id, year, month, measurement_system, metric)
+        perform_get_request(
+          "/property/#{property_id}/metrics",
+          query: {
+            year: year, month: month, measurementSystem: measurement_system
+          },
+          header: {
+            'PM-Metrics' => metric
+          }
+        )
+      end
+    end
+  end
+end

data/lib/portfolio_manager/rest/utils.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'portfolio_manager/rest/request'
-require 'nokogiri'
 
 module PortfolioManager
   module REST

data/lib/portfolio_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PortfolioManager
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portfolio_manager
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jack Reed
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -134,6 +134,7 @@ files:
 - lib/portfolio_manager/rest/data_exchange_settings.rb
 - lib/portfolio_manager/rest/meter.rb
 - lib/portfolio_manager/rest/property.rb
+- lib/portfolio_manager/rest/reporting.rb
 - lib/portfolio_manager/rest/request.rb
 - lib/portfolio_manager/rest/share.rb
 - lib/portfolio_manager/rest/utils.rb