portfolio_manager 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9e73d6df7977436db99c3ba6c5d24328d71277f4
-  data.tar.gz: 8851befec3c8da7cd756bc70a1db701f7c36957d
+SHA256:
+  metadata.gz: 177b5b07384c5f9c24b5cb9ef69cb1517af02f1f76d9af1cc74eab9654dfe477
+  data.tar.gz: 87ae59aa73df92530ae4c6ea1feb139a4e8b964c6a6ca3ad39fc6249cf3acd9f
 SHA512:
-  metadata.gz: 98f0605bd91c41974d843379c0ae1816c479b68c48a42a6a7084fb500309b532b96df464e8578379446d8755933b116f30ed6ca26f3e24d56d5aab7aadf19a0b
-  data.tar.gz: 2f3b7d75360623a9f7baee86f621b032ea615e9ca8e49c6f08c8d9520775830af570b302efceb512e32c47e5d7f51b31f583fd7707a4cc7542123cd07b8a3b07
+  metadata.gz: a85026346412c4a627b41518f0b7967e113f7f6679738ff153e8953b3a1c5da587f499c4a5b635d867121d0f0fffc6e0fe9bcbdcf6f5700caf184234da16381d
+  data.tar.gz: 4ccfa27318accc589869fe8676f749c64a8a59e02f29cf02cb7a5f5e77622c3decb5faf4d3b14721ded9013481a7003a44e2afa49204fdcf96da17f263b66634

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
@@ -66,6 +68,17 @@ GET | /meter/(meterId) | `meter(meter_id)` | 	Returns information for a specifie
 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.
 
+#### 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,9 +1,13 @@
+# 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/customer'
+require 'portfolio_manager/rest/connection'
+require 'portfolio_manager/rest/share'
 
 module PortfolioManager
   module REST
@@ -17,6 +21,8 @@ module PortfolioManager
       include PortfolioManager::REST::Meter
       include PortfolioManager::REST::Property
       include PortfolioManager::REST::Customer
+      include PortfolioManager::REST::Connection
+      include PortfolioManager::REST::Share
     end
   end
 end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'portfolio_manager/rest/utils'
+
+module PortfolioManager
+  module REST
+    ##
+    # Connection services
+    # @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.'
+      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.
+      # The list of pending customer connection requests is returned in sets of 20.
+      #
+      # @see https://portfoliomanager.energystar.gov/webservices/home/api/connection/pendingAccountList/get
+      def pending_connections(link = nil)
+        link ||= '/connect/account/pending/list'
+        perform_get_request(link)
+      end
+
+      ##
+      # Accepts/rejects a pending connection request from a specific customer.
+      #
+      # @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)
+        )
+      end
+
+      private
+
+      def connection_response_body(accept)
+        action = accept ? 'Accept' : 'Reject'
+        note = accept ? ACCEPT_NOTE : REJECT_NOTE
+        request_response_xml(action, note)
+      end
+    end
+  end
+end

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
 
       ##
@@ -21,7 +23,7 @@ module PortfolioManager
       #
       # https://portfoliomanager.energystar.gov/webservices/home/api/account/customer/get
       def customer(customer_id)
-        perform_get_request("/cutomer/#{customer_id}")
+        perform_get_request("/customer/#{customer_id}")
       end
     end
   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

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

@@ -1,4 +1,7 @@
-require 'hurley'
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/xml'
 require 'nori'
 
 module PortfolioManager
@@ -9,9 +12,11 @@ module PortfolioManager
       BASE_URL  = 'https://portfoliomanager.energystar.gov'
       LIVE_PATH = '/ws'
       TEST_PATH = '/wstest'
+      CONTENT_TYPE = 'application/xml'
 
       attr_reader :client, :path, :request_method, :parser
       attr_accessor :options
+
       ##
       # @param [PortfolioManager::Client] client
       # @param [Symbol, String] request_method
@@ -19,10 +24,13 @@ module PortfolioManager
       # @param [Hash] options used for creating query params and headers
       def initialize(client, request_method, path, options)
         @client = client
-        @path = path
+        @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
@@ -38,31 +46,42 @@ module PortfolioManager
       ##
       # @return [String]
       def response_body
-        @conn.public_send(request_method, api_environment + path).body
+        case request_method
+        when :get
+          @conn.get(path).body
+        when :post
+          @conn.post(path, options[:body]).body
+        else
+          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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'portfolio_manager/rest/utils'
+
+module PortfolioManager
+  module REST
+    ##
+    # Share services
+    # @see https://portfoliomanager.energystar.gov/webservices/home/api/connection
+    module Share
+      include PortfolioManager::REST::Utils
+
+      ##
+      # 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.
+      #
+      # @see https://portfoliomanager.energystar.gov/webservices/home/api/connection/pendingPropertyList/get
+      # @see https://portfoliomanager.energystar.gov/webservices/home/api/connection/pendingMeterList/get
+      def pending_meter_shares(link = nil)
+        pending_shares(:meter, link)
+      end
+
+      def pending_property_shares(link = nil)
+        pending_shares(:property, link)
+      end
+
+      ##
+      # Accepts/rejects a pending share request for a specific property or meter.
+      #
+      # @see https://portfoliomanager.energystar.gov/webservices/home/api/connection/shareProperty/post
+      # @see https://portfoliomanager.energystar.gov/webservices/home/api/connection/shareMeter/post
+      def meter_share_request(meter_id, accept = true)
+        share_request(meter_id, :meter, accept)
+      end
+
+      def property_share_request(property_id, accept = true)
+        share_request(property_id, :property, accept)
+      end
+
+      private
+
+      def pending_shares(resource_name, link)
+        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)
+        )
+      end
+
+      def share_response_body(accept, resource_name)
+        accept_note = "Your #{resource_name} sharing request has been verified and accepted."
+        reject_note = "Your #{resource_name} sharing request has been rejected."
+        action = accept ? 'Accept' : 'Reject'
+        note = accept ? accept_note : reject_note
+        request_response_xml(action, note)
+      end
+    end
+  end
+end

data/lib/portfolio_manager/rest/utils.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'portfolio_manager/rest/request'
+require 'nokogiri'
 
 module PortfolioManager
   module REST
@@ -14,6 +17,13 @@ module PortfolioManager
         perform_request(:get, path, options)
       end
 
+      ##
+      # @param [String] path
+      # @param [Hash] options
+      def perform_post_request(path, options = {})
+        perform_request(:post, path, options)
+      end
+
       ##
       # @param [Symbol, String] request_method
       # @param [String] path
@@ -26,6 +36,15 @@ module PortfolioManager
           options
         ).perform
       end
+
+      def request_response_xml(action, note)
+        Nokogiri::XML::Builder.new do |xml|
+          xml.sharingResponse do
+            xml.action action
+            xml.note note
+          end
+        end.to_xml
+      end
     end
   end
 end

data/lib/portfolio_manager/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PortfolioManager
-  VERSION = '0.2.0'
+  VERSION = '0.4.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.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jack Reed
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2023-03-14 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
@@ -115,11 +129,13 @@ files:
 - lib/portfolio_manager/rest/api.rb
 - lib/portfolio_manager/rest/building.rb
 - lib/portfolio_manager/rest/client.rb
+- lib/portfolio_manager/rest/connection.rb
 - lib/portfolio_manager/rest/customer.rb
 - lib/portfolio_manager/rest/data_exchange_settings.rb
 - lib/portfolio_manager/rest/meter.rb
 - lib/portfolio_manager/rest/property.rb
 - lib/portfolio_manager/rest/request.rb
+- lib/portfolio_manager/rest/share.rb
 - lib/portfolio_manager/rest/utils.rb
 - lib/portfolio_manager/version.rb
 - portfolio_manager.gemspec
@@ -127,7 +143,7 @@ homepage: https://github.com/mejackreed/portfolio_manager
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,9 +158,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: []