portfolio_manager 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1af332f66597bbac4ea7ef5e86f9e8218ad5347
-  data.tar.gz: '00294142f3d3f47e8c275357c8392ac8e79e6b9d'
+SHA256:
+  metadata.gz: c11e10b4cc1d39ef7786f32cb008592026541cf755281d8cbdccf24158c7241d
+  data.tar.gz: 9e85f566088fcd0ef283e4d11a6fbea65c1c15c7ecb705ff7b55cbf0a13e1978
 SHA512:
-  metadata.gz: c2054b5c323b280f07a373827b152f747f0de31e74f6e8c5e7523c46eee8a8d39c10dbfd031392db7b3f0b282f10e2025c4a7e8e15325931cd37f2718f90814a
-  data.tar.gz: 9a963132c4eed65d85ab5de8790253165c48f907d9cb9b6a4630a2adee4a185c1f0c936f70b48b091ec69a6b036788258e1e11d64f7102d2663de048710d01b7
+  metadata.gz: 174a443420fd097fb6df1aebd5cf6468795619c5afc2f4ebc0bb4e00517490c152d2297d38ff7bac8810a8b15b42b90e5cf1717b6b6522790ab6662e8b7e14bf
+  data.tar.gz: 8201b5eb4197ed16def24025a4e5d13599ba46c89234f7ba47911fd6e2e92b08d06c6dbc2808280f931eb51a063d49ac52fdbe3bb3f5f5edb4ca29035bffab62

data/Gemfile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in portfolio_manager.gemspec
 gemspec
 
 group :test do
-  gem 'webmock'
   gem 'coveralls', require: false
+  gem 'webmock'
 end

data/README.md

@@ -40,6 +40,8 @@ HTTP | Path | Method | Description
 GET | /account | `account` | Returns general information for your account.
 GET | /dataExchangeSettings | `data_exchange_settings` | Returns the settings that define your data exchange service offerings.
 GET | /dataExchangeSettings/customField/list | `data_exchange_custom_field_list` | Returns a list of custom fields that you have defined for your account.
+GET | /customer/list | `customer_list` | Returns a list of customers that you are connected to.
+GET | /customer/(customerId) | `customer(customer_id)` | Returns general account information for a specific customer that you are connected to.
 
 #### Property Services
 http://portfoliomanager.energystar.gov/webservices/home/api/property
@@ -64,8 +66,26 @@ 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
+
+HTTP | Path | Method | Description
+---- | ---- | ------ | -----------
+GET | /connect/account/pending/list | `pending_connections(link = nil)` | Returns a list of customer connection requests that are pending.
+POST | /connect/account/(accountId) | `connection_request(customer_id, accept = true)` | Accepts/rejects a pending connection request from a specific customer.
+GET | /share/property/pending/list | `pending_property_shares(link = nil)` | Returns a list of property share requests that are pending. These property share requests belong to customers that you are already connected to.
+POST | /share/property/(propertyId) | `property_share_request(property_id, accept = true)` | Accepts/rejects a pending share request for a specific property.
+GET | /share/meter/pending/list | `pending_meter_shares(link = nil)` | Returns a list of meter share requests that are pending. These meter share requests belong to customers that you are already connected to.
+POST | /share/meter/(meterId) | `meter_share_request(meter_id, accept = true)` | Accepts/rejects a pending share request for a specific meter.
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "portfolio_manager"
+require 'bundler/setup'
+require 'portfolio_manager'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "portfolio_manager"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/portfolio_manager/rest/account.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/utils'
 
 module PortfolioManager

data/lib/portfolio_manager/rest/api.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/account'
 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'
@@ -18,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/building.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/utils'
 
 module PortfolioManager

data/lib/portfolio_manager/rest/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/api'
 require 'portfolio_manager/rest/utils'
 

data/lib/portfolio_manager/rest/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/utils'
 
 module PortfolioManager
@@ -7,9 +9,9 @@ module PortfolioManager
     # @see https://portfoliomanager.energystar.gov/webservices/home/api/connection
     module Connection
       include PortfolioManager::REST::Utils
-      REJECT_NOTE = 'Unfortunately we cannot provide services for you at this time.'.freeze
-      ACCEPT_NOTE = 'Your connection request has been verified and accepted.'.freeze
-      
+      REJECT_NOTE = 'Unfortunately we cannot provide services for you at this time.'
+      ACCEPT_NOTE = 'Your connection request has been verified and accepted.'
+
       ##
       # This web service returns a list of pending customer connection requests.
       # A connection to the customer must be established first before any properties and meters can be shared with you.
@@ -27,9 +29,9 @@ module PortfolioManager
       # @see https://portfoliomanager.energystar.gov/webservices/home/api/connection/connect/post
       def connection_request(customer_id, accept = true)
         perform_post_request(
-            "/connect/account/#{customer_id}",
-            body: connection_response_body(accept)
-          )
+          "/connect/account/#{customer_id}",
+          body: connection_response_body(accept)
+        )
       end
 
       private

data/lib/portfolio_manager/rest/customer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/utils'
 
 module PortfolioManager
@@ -13,7 +15,7 @@ module PortfolioManager
       #
       # @see https://portfoliomanager.energystar.gov/webservices/home/api/account/customerList/get
       def customer_list
-        perform_get_request("/customer/list")
+        perform_get_request('/customer/list')
       end
 
       ##

data/lib/portfolio_manager/rest/data_exchange_settings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/utils'
 
 module PortfolioManager

data/lib/portfolio_manager/rest/meter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/utils'
 
 module PortfolioManager
@@ -27,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/property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/utils'
 
 module PortfolioManager

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/request.rb

@@ -1,4 +1,7 @@
-require 'hurley'
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/xml'
 require 'nori'
 
 module PortfolioManager
@@ -13,6 +16,7 @@ module PortfolioManager
 
       attr_reader :client, :path, :request_method, :parser
       attr_accessor :options
+
       ##
       # @param [PortfolioManager::Client] client
       # @param [Symbol, String] request_method
@@ -23,7 +27,10 @@ module PortfolioManager
         @path = api_environment + path
         @options = options
         @request_method = request_method
-        @conn = Hurley::Client.new(BASE_URL)
+        @conn = Faraday.new(url: BASE_URL) do |conn|
+          conn.request :authorization, :basic, client.username, client.password
+          conn.request :xml
+        end
         @parser = Nori.new
         setup_client
       end
@@ -43,34 +50,38 @@ module PortfolioManager
         when :get
           @conn.get(path).body
         when :post
-          @conn.post(path, options[:body], CONTENT_TYPE).body
+          @conn.post(path, options[:body]).body
         else
-          raise ArgumentError, '#{request_method} is not yet implemented'
+          raise ArgumentError, "#{request_method} is not yet implemented"
         end
       end
 
       def setup_client
         set_header
         set_query
-        set_basic_authentication
       end
 
       def set_header
-        @conn.header[:user_agent] = 'Ruby PortfolioManager API Client'
-        options[:header].each do |key, value|
-          @conn.header[key] = value
-        end unless options[:header].nil?
+        headers = {
+          'User-Agent' => 'Ruby PortfolioManager API Client',
+          'Accept' => 'application/xml',
+          'Content-Type' => 'application/xml;charset=UTF-8'
+        }
+
+        options[:header]&.each do |key, value|
+          headers[key] = value
+        end
+
+        @conn.headers = headers
       end
 
       def set_query
-        options[:query].each do |key, value|
-          @conn.query[key] = value
-        end unless options[:query].nil?
-      end
+        params = {}
+        options[:query]&.each do |key, value|
+          params[key] = value
+        end
 
-      def set_basic_authentication
-        @conn.url.user = client.username
-        @conn.url.password = client.password
+        @conn.params = params
       end
 
       def api_environment

data/lib/portfolio_manager/rest/share.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/utils'
 
 module PortfolioManager
@@ -9,7 +11,7 @@ module PortfolioManager
       include PortfolioManager::REST::Utils
 
       ##
-      # Returns a list of property or meter share requests that are pending. 
+      # Returns a list of property or meter share requests that are pending.
       # These property share requests belong to customers that you are already connected to.
       # The list of pending property share requests is returned in sets of 20.
       #
@@ -37,17 +39,17 @@ module PortfolioManager
       end
 
       private
-      
+
       def pending_shares(resource_name, link)
-        link ||= "/share/#{resource_name}/pending/list" 
+        link ||= "/share/#{resource_name}/pending/list"
         perform_get_request(link)
       end
 
       def share_request(resource_id, resource_name, accept = true)
         perform_post_request(
-            "/share/#{resource_name}/#{resource_id}",
-            body: share_response_body(accept, resource_name)
-          )
+          "/share/#{resource_name}/#{resource_id}",
+          body: share_response_body(accept, resource_name)
+        )
       end
 
       def share_response_body(accept, resource_name)

data/lib/portfolio_manager/rest/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/request'
 
 module PortfolioManager
@@ -35,11 +37,11 @@ module PortfolioManager
       end
 
       def request_response_xml(action, note)
-        builder = Nokogiri::XML::Builder.new do |xml|
-          xml.sharingResponse {
+        Nokogiri::XML::Builder.new do |xml|
+          xml.sharingResponse do
             xml.action action
             xml.note note
-          }
+          end
         end.to_xml
       end
     end

data/lib/portfolio_manager/version.rb

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

data/lib/portfolio_manager.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/client'
 require 'portfolio_manager/version'

data/portfolio_manager.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'portfolio_manager/version'
 
@@ -9,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jack Reed']
   spec.email         = ['phillipjreed@gmail.com']
 
-  spec.summary       = %q{A Ruby client for the EnergyStar Portfolio Manager web services.}
-  spec.description   = %q{A Ruby client for the EnergyStar Portfolio Manager web services.}
+  spec.summary       = 'A Ruby client for the EnergyStar Portfolio Manager web services.'
+  spec.description   = 'A Ruby client for the EnergyStar Portfolio Manager web services.'
   spec.homepage      = 'https://github.com/mejackreed/portfolio_manager'
   spec.license       = 'MIT'
 
@@ -19,11 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'hurley'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday-xml'
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'nori'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: portfolio_manager
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jack Reed
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hurley
+  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: faraday-xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,30 +70,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -120,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
@@ -129,7 +144,7 @@ homepage: https://github.com/mejackreed/portfolio_manager
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,9 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: A Ruby client for the EnergyStar Portfolio Manager web services.
 test_files: []