portfolio_manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2aeb3c620711b489a8f03cf237698161934f2a5a
+  data.tar.gz: cfcd57981280ce251febb6dba5efd75bfe078d9a
+SHA512:
+  metadata.gz: 9c77942c67014ce52b7d254c78809d7451ae47804f43d321bc103a66273298d84d6013ea94cd97716b09e82399a1d6131016f5cf2bcd04877a42abafa66397b4
+  data.tar.gz: 2d228dd9e3f87786e865f22eb91b4561bf4af4acadd7bed82ecb166ba2c70cfcded47b21878b00b86511e5ac78cc0c928a6362fcfa5051090f9657f1990d6c99

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+sudo: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jack Reed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# PortfolioManager
+[![Build Status](https://travis-ci.org/mejackreed/portfolio_manager.svg?branch=master)](https://travis-ci.org/mejackreed/portfolio_manager) | [![Coverage Status](https://coveralls.io/repos/mejackreed/portfolio_manager/badge.svg?branch=master&service=github)](https://coveralls.io/github/mejackreed/portfolio_manager?branch=master)
+
+A Ruby client for the [EnergyStar Portfolio Manager web services](http://portfoliomanager.energystar.gov/webservices/home). Inspired by the [Twitter Ruby Gem](https://github.com/sferik/twitter).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'portfolio_manager'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Configuration
+
+```ruby
+client = PortfolioManager::REST::Client.new do |config|
+  config.username = 'user'
+  config.password = 'secret password'
+  # Use the "live" site
+  config.live     = true #defaults to false
+end
+```
+
+### API
+
+API calls implemented from http://portfoliomanager.energystar.gov/webservices/home/api
+
+#### Basic Account Services
+http://portfoliomanager.energystar.gov/webservices/home/api/account
+
+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.
+
+#### Property Services
+http://portfoliomanager.energystar.gov/webservices/home/api/property
+
+HTTP | Path | Method | Description
+---- | ---- | -----------
+GET | /property/(propertyId) | `property(property_id)` | Returns information for a specific property.
+GET | /account/(accountId)/property/list | `property_list(account_id)` | Returns a list of properties for a specified user.
+
+#### Building Services
+http://portfoliomanager.energystar.gov/webservices/home/api/building
+
+HTTP | Path | Method | Description
+---- | ---- | -----------
+GET | /building/(buildingId) | `building` | Returns information for a specific building.
+GET | /property/(propertyId)/building/list | `building_list(property_id)` | Returns a list of buildings that belong to a specified property.
+
+#### Meter Services
+http://portfoliomanager.energystar.gov/webservices/home/api/meter
+
+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.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mejackreed/portfolio_manager.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/portfolio_manager.rb

@@ -0,0 +1,2 @@
+require 'portfolio_manager/rest/client'
+require 'portfolio_manager/version'

data/lib/portfolio_manager/rest/account.rb

@@ -0,0 +1,21 @@
+require 'portfolio_manager/rest/utils'
+
+module PortfolioManager
+  module REST
+    ##
+    # Basic account
+    # @see http://portfoliomanager.energystar.gov/webservices/home/api/account
+    module Account
+      include PortfolioManager::REST::Utils
+
+      ##
+      # This web service retrieves your account information that includes your
+      # username, password, contact information, & security questions/answers.
+      #
+      # @see http://portfoliomanager.energystar.gov/webservices/home/api/account/account/get
+      def account
+        perform_get_request('/account')
+      end
+    end
+  end
+end

data/lib/portfolio_manager/rest/api.rb

@@ -0,0 +1,20 @@
+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'
+
+module PortfolioManager
+  module REST
+    ##
+    # Web services included from PortfolioManager
+    # @see http://portfoliomanager.energystar.gov/webservices/home/api
+    module API
+      include PortfolioManager::REST::Account
+      include PortfolioManager::REST::Building
+      include PortfolioManager::REST::DataExchangeSettings
+      include PortfolioManager::REST::Meter
+      include PortfolioManager::REST::Property
+    end
+  end
+end

data/lib/portfolio_manager/rest/building.rb

@@ -0,0 +1,31 @@
+require 'portfolio_manager/rest/utils'
+
+module PortfolioManager
+  module REST
+    ##
+    # Building services
+    # @see http://portfoliomanager.energystar.gov/webservices/home/api/building
+    module Building
+      include PortfolioManager::REST::Utils
+
+      ##
+      # This web service retrieves information for a specific building. The
+      # building must already be shared with you.
+      #
+      # @see http://portfoliomanager.energystar.gov/webservices/home/api/building/building/get
+      # @param [String, Integer] building_id
+      def building(building_id)
+        perform_get_request("/building/#{building_id}")
+      end
+
+      ##
+      # This web service returns a list of buildings for a specific property
+      # that is shared with you.
+      #
+      # @see http://portfoliomanager.energystar.gov/webservices/home/api/building/buildingList/get
+      def building_list(property_id)
+        perform_get_request("/property/#{property_id}/building/list")
+      end
+    end
+  end
+end

data/lib/portfolio_manager/rest/client.rb

@@ -0,0 +1,21 @@
+require 'portfolio_manager/rest/api'
+require 'portfolio_manager/rest/utils'
+
+module PortfolioManager
+  module REST
+    ##
+    # REST client configuration for PortfolioManager gem.
+    class Client
+      include PortfolioManager::REST::API
+      attr_accessor :username, :password, :live
+
+      def initialize(options = {})
+        @live = false
+        options.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+        yield self if block_given?
+      end
+    end
+  end
+end

data/lib/portfolio_manager/rest/data_exchange_settings.rb

@@ -0,0 +1,31 @@
+require 'portfolio_manager/rest/utils'
+
+module PortfolioManager
+  module REST
+    ##
+    # Advanced Settings for Organizations Exchanging Data
+    # @see http://portfoliomanager.energystar.gov/webservices/home/api/account
+    module DataExchangeSettings
+      include PortfolioManager::REST::Utils
+      ##
+      # This web service retrieves the various settings that describes your data
+      # exchange service offerings such as terms and conditions, supported fuel
+      # types, etc.
+      #
+      # @see http://portfoliomanager.energystar.gov/webservices/home/api/account/settings/get
+      def data_exchange_settings
+        perform_get_request('/dataExchangeSettings')
+      end
+
+      ##
+      # This web service returns a list of custom fields that are used by your
+      # account. These custom fields allow you to gather more data from your
+      # customers as they send connection and share requests to you.
+      #
+      # @see http://portfoliomanager.energystar.gov/webservices/home/api/account/customFieldList/get
+      def data_exchange_custom_field_list
+        perform_get_request('/dataExchangeSettings/customField/list')
+      end
+    end
+  end
+end

data/lib/portfolio_manager/rest/meter.rb

@@ -0,0 +1,43 @@
+require 'portfolio_manager/rest/utils'
+
+module PortfolioManager
+  module REST
+    ##
+    # Meter services
+    # @see http://portfoliomanager.energystar.gov/webservices/home/api/meter
+    module Meter
+      include PortfolioManager::REST::Utils
+
+      ##
+      # This web service retrieves information for a specific meter. The meter
+      # must already be shared with you.
+      #
+      # @see http://portfoliomanager.energystar.gov/webservices/home/api/meter/meter/get
+      # @param [String, Integer] meter_id
+      def meter(meter_id)
+        perform_get_request("/meter/#{meter_id}")
+      end
+
+      ##
+      # This web service retrieves a list of all the meters for a specific
+      # property. The property must already be shared with you.
+      #
+      # @see http://portfoliomanager.energystar.gov/webservices/home/api/meter/meterList/get
+      def meter_list(property_id)
+        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
+          }
+        )
+      end
+    end
+  end
+end

data/lib/portfolio_manager/rest/property.rb

@@ -0,0 +1,32 @@
+require 'portfolio_manager/rest/utils'
+
+module PortfolioManager
+  module REST
+    ##
+    # Property services
+    # @see http://portfoliomanager.energystar.gov/webservices/home/api/property
+    module Property
+      include PortfolioManager::REST::Utils
+
+      ##
+      # This web service returns a list of properties for a specific customer
+      # that are shared with you.
+      #
+      # @see http://portfoliomanager.energystar.gov/webservices/home/api/property/propertyList/get
+      # @param [String, Integer] account_id
+      def property_list(account_id)
+        perform_get_request("/account/#{account_id}/property/list")
+      end
+
+      ##
+      # This web service retrieves information for a specific property. The
+      # property must already be shared with you. This service can also be used
+      # for to retrieve information on a building.
+      #
+      # @see http://portfoliomanager.energystar.gov/webservices/home/api/property/property/get
+      def property(property_id)
+        perform_get_request("/property/#{property_id}")
+      end
+    end
+  end
+end

data/lib/portfolio_manager/rest/request.rb

@@ -0,0 +1,77 @@
+require 'hurley'
+require 'nori'
+
+module PortfolioManager
+  module REST
+    ##
+    # Manage HTTP requests
+    class Request
+      BASE_URL  = 'https://portfoliomanager.energystar.gov'
+      LIVE_PATH = '/ws'
+      TEST_PATH = '/wstest'
+
+      attr_reader :client, :path, :request_method, :parser
+      attr_accessor :options
+      ##
+      # @param [PortfolioManager::Client] client
+      # @param [Symbol, String] request_method
+      # @param [String] path
+      # @param [Hash] options used for creating query params and headers
+      def initialize(client, request_method, path, options)
+        @client = client
+        @path = path
+        @options = options
+        @request_method = request_method
+        @conn = Hurley::Client.new(BASE_URL)
+        @parser = Nori.new
+        setup_client
+      end
+
+      ##
+      # @return [Hash]
+      def perform
+        parser.parse(response_body)
+      end
+
+      private
+
+      ##
+      # @return [String]
+      def response_body
+        @conn.public_send(request_method, api_environment + path).body
+      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?
+      end
+
+      def set_query
+        options[:query].each do |key, value|
+          @conn.query[key] = value
+        end unless options[:query].nil?
+      end
+
+      def set_basic_authentication
+        @conn.url.user = client.username
+        @conn.url.password = client.password
+      end
+
+      def api_environment
+        if client.live
+          LIVE_PATH
+        else
+          TEST_PATH
+        end
+      end
+    end
+  end
+end

data/lib/portfolio_manager/rest/utils.rb

@@ -0,0 +1,31 @@
+require 'portfolio_manager/rest/request'
+
+module PortfolioManager
+  module REST
+    ##
+    # Utilities used throughout REST Client
+    module Utils
+      private
+
+      ##
+      # @param [String] path
+      # @param [Hash] options
+      def perform_get_request(path, options = {})
+        perform_request(:get, path, options)
+      end
+
+      ##
+      # @param [Symbol, String] request_method
+      # @param [String] path
+      # @param [Hash] options
+      def perform_request(request_method, path, options = {})
+        PortfolioManager::REST::Request.new(
+          self,
+          request_method,
+          path,
+          options
+        ).perform
+      end
+    end
+  end
+end

data/lib/portfolio_manager/version.rb

@@ -0,0 +1,3 @@
+module PortfolioManager
+  VERSION = '0.1.0'
+end

data/portfolio_manager.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'portfolio_manager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'portfolio_manager'
+  spec.version       = PortfolioManager::VERSION
+  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.homepage      = 'https://github.com/mejackreed/portfolio_manager'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hurley'
+  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 'rspec'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: portfolio_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Reed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hurley
+  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: nokogiri
+  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: nori
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client for the EnergyStar Portfolio Manager web services.
+email:
+- phillipjreed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/portfolio_manager.rb
+- lib/portfolio_manager/rest/account.rb
+- lib/portfolio_manager/rest/api.rb
+- lib/portfolio_manager/rest/building.rb
+- lib/portfolio_manager/rest/client.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/utils.rb
+- lib/portfolio_manager/version.rb
+- portfolio_manager.gemspec
+homepage: https://github.com/mejackreed/portfolio_manager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby client for the EnergyStar Portfolio Manager web services.
+test_files: []