portfolio_manager 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e73d6df7977436db99c3ba6c5d24328d71277f4
-  data.tar.gz: 8851befec3c8da7cd756bc70a1db701f7c36957d
+  metadata.gz: d1af332f66597bbac4ea7ef5e86f9e8218ad5347
+  data.tar.gz: '00294142f3d3f47e8c275357c8392ac8e79e6b9d'
 SHA512:
-  metadata.gz: 98f0605bd91c41974d843379c0ae1816c479b68c48a42a6a7084fb500309b532b96df464e8578379446d8755933b116f30ed6ca26f3e24d56d5aab7aadf19a0b
-  data.tar.gz: 2f3b7d75360623a9f7baee86f621b032ea615e9ca8e49c6f08c8d9520775830af570b302efceb512e32c47e5d7f51b31f583fd7707a4cc7542123cd07b8a3b07
+  metadata.gz: c2054b5c323b280f07a373827b152f747f0de31e74f6e8c5e7523c46eee8a8d39c10dbfd031392db7b3f0b282f10e2025c4a7e8e15325931cd37f2718f90814a
+  data.tar.gz: 9a963132c4eed65d85ab5de8790253165c48f907d9cb9b6a4630a2adee4a185c1f0c936f70b48b091ec69a6b036788258e1e11d64f7102d2663de048710d01b7

data/lib/portfolio_manager/rest/api.rb

@@ -4,6 +4,8 @@ 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 +19,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/connection.rb

@@ -0,0 +1,44 @@
+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.'.freeze
+      ACCEPT_NOTE = 'Your connection request has been verified and accepted.'.freeze
+      
+      ##
+      # 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

@@ -21,7 +21,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/request.rb

@@ -9,6 +9,7 @@ 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
@@ -19,7 +20,7 @@ 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)
@@ -38,7 +39,14 @@ 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], CONTENT_TYPE).body
+        else
+          raise ArgumentError, '#{request_method} is not yet implemented'
+        end
       end
 
       def setup_client

data/lib/portfolio_manager/rest/share.rb

@@ -0,0 +1,62 @@
+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

@@ -14,6 +14,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 +33,15 @@ module PortfolioManager
           options
         ).perform
       end
+
+      def request_response_xml(action, note)
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.sharingResponse {
+            xml.action action
+            xml.note note
+          }
+        end.to_xml
+      end
     end
   end
 end

data/lib/portfolio_manager/version.rb

@@ -1,3 +1,3 @@
 module PortfolioManager
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portfolio_manager
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jack Reed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hurley
@@ -115,11 +115,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