also_energy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27e68266a184519416063a4296d43c221e685b1d
+  data.tar.gz: 4fa3a253a82ccea0aa1f09dfecc0c048dde62ae2
+SHA512:
+  metadata.gz: faec045419682a0e9e8aa0f7362c11d504b825b78bcc736a64fc8d42d5daa48ee1b4887f2bcc29974a14f7ef1589ed9d1f1b6e933deb0aa06496d0803954d55d
+  data.tar.gz: 1976c2ba963fc6a8e10848c27d020b587eb635e3e5ba1a51a1021115ddd541237ebac014f3af59d947d8ef30eb18eca880c1b5c7bdd85c881e4d0a2d596ecda6

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+*.here
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in also_energy.gemspec
+gemspec
+
+gem "pry"
+gem 'virtus'

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    also_energy (0.1.0)
+      savon (~> 2.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.11)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    httpi (2.4.1)
+      rack
+    ice_nine (0.11.1)
+    macaddr (1.7.1)
+      systemu (~> 2.6.2)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    minitest (5.8.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    nori (2.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rake (10.4.2)
+    safe_yaml (1.0.4)
+    savon (2.10.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.4)
+      uuid (~> 2.3.7)
+      wasabi (~> 3.4)
+    slop (3.6.0)
+    systemu (2.6.5)
+    thread_safe (0.3.5)
+    uuid (2.3.8)
+      macaddr (~> 1.0)
+    vcr (2.9.3)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    wasabi (3.5.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  also_energy!
+  bundler (~> 1.10)
+  minitest
+  pry
+  rake (~> 10.0)
+  vcr
+  virtus
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Edit LLC
+
+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,31 @@
+# AlsoEnergy
+
+This is a Ruby wrapper for the Also Energy Production Data SOAP API Version 1.6.1
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'also_energy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install also_energy
+
+## Usage
+
+TBD
+
+## Development
+
+TBD
+
+## Contributing
+
+TBD

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/also_energy.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'also_energy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "also_energy"
+  spec.version       = AlsoEnergy::VERSION
+  spec.authors       = ["Tyler Whitsett", "Darin Haener"]
+  spec.email         = ["whitsett.tyler@gmail.com", "dphaener@gmail.com"]
+
+  spec.summary       = %q{A Ruby wrapper for the AlsoEnergy API}
+  spec.description   = %q{A Ruby wrapper for the AlsoEnergy API}
+  spec.homepage      = "https://github.com/EditLLC/also-energy-ruby"
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "savon", "~> 2.10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "also_energy"
+
+# 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/also_energy.rb

@@ -0,0 +1,5 @@
+require "also_energy/version"
+require 'also_energy/client'
+
+module AlsoEnergy
+end

data/lib/also_energy/client.rb

@@ -0,0 +1,53 @@
+require 'savon'
+require 'pry'
+require 'virtus'
+require './lib/also_energy/hash_wrangler'
+require './lib/also_energy/connection'
+require './lib/also_energy/site'
+require './lib/also_energy/hardware'
+
+module AlsoEnergy
+  class AuthError < StandardError; end
+  class QueryError < StandardError; end
+
+  class Client
+    include HashWrangler
+    include APIConnection
+
+    attr_accessor :username, :password, :session_id
+
+    def initialize
+      yield(self) if block_given?
+    end
+
+    def login
+      message = { 'als:username' => username, 'als:password' => password }
+      response = find_in_hash(:session_id, (connection.call(:login, message: message).body))
+      if response.nil?
+        fail AuthError, 'Login Failed!'
+      else
+        self.session_id = response
+      end
+    end
+
+    def get_sites
+      message = { 'als:sessionID' => session_id }
+      response = find_in_hash(:items, (connection.call(:get_site_list, message: message).body))
+      if response.nil?
+        fail QueryError, 'Query Failed!'
+      else
+        response.map { |site| AlsoEnergy::Site.new(site[1]) }
+      end
+    end
+
+    def get_site_hardware(site_id)
+      message = { 'als:sessionID' => session_id, 'als:siteID' => site_id }
+      response = find_in_hash(:hardware_complete, (connection.call(:get_site_hardware_list, message: message).body))
+      if response.nil?
+        fail QueryError, 'Query Failed!'
+      else
+        response.map { |hw| AlsoEnergy::HardWare.new(hw) }
+      end
+    end
+  end
+end

data/lib/also_energy/connection.rb

@@ -0,0 +1,13 @@
+module APIConnection
+  def connection
+    @connect = Savon.client do |globals|
+      globals.wsdl "http://www.alsoenergy.com/WebAPI/WebAPI.svc?wsdl"
+      globals.endpoint "https://www.alsoenergy.com/WebAPI/WebAPI.svc"
+      globals.env_namespace :soapenv
+      globals.namespaces("xmlns:als1" => "http://schemas.datacontract.org/2004/07/AlsoEnergyAPI.Data")
+      globals.namespace_identifier :als
+      globals.pretty_print_xml true
+      globals.log true
+    end
+  end
+end

data/lib/also_energy/hardware.rb

@@ -0,0 +1,34 @@
+module AlsoEnergy
+  class HardWare
+    include HashWrangler
+    include APIConnection
+    include Virtus.model
+
+    attribute :device_code, String
+    attribute :device_id, Integer
+    attribute :device_num, Integer
+    attribute :flags, String
+    attribute :gateway_id, String
+    attribute :hardware_id, Integer
+    attribute :name, String
+    attribute :site_id, Integer
+    attribute :field_list, Array
+    attribute :session_id, String
+
+    def initialize(params = {})
+      super(params)
+    end
+
+    def get_bin_data(period_start, period_end, bin_size, query_blob)
+      message = {
+                  'als:sessionID' => session_id,
+                  'als:fromLocal' => period_start,
+                  'als:toLocal' => period_end,
+                  'als:binSize' => bin_size,
+                  'als:Fields' => query_blob
+                }
+      response = find_in_hash(:data_set, (connection.call(:get_bin_data, message: message).body))
+      response.nil? ? (fail QueryError, 'Query Failed!') : response
+    end
+  end
+end

data/lib/also_energy/hash_wrangler.rb

@@ -0,0 +1,11 @@
+module HashWrangler
+  #credit to http://stackoverflow.com/questions/8301566/
+  def find_in_hash(key, object=self, found=nil)
+    if object.respond_to?(:key?) && object.key?(key)
+      return object[key]
+    elsif object.is_a? Enumerable
+      object.find { |*a| found = find_in_hash(key, a.last) }
+      return found
+    end
+  end
+end

data/lib/also_energy/site.rb

@@ -0,0 +1,21 @@
+module AlsoEnergy
+  class Site
+    include HashWrangler
+    include Virtus.model
+
+    attribute :id, Integer
+    attribute :name, String
+    attribute :latitude, Float
+    attribute :longitude, Float
+    attribute :city, String
+    attribute :state, String
+    attribute :time_zone, String
+    attribute :dst, Boolean
+    attribute :type, String
+
+    def initialize(params = {})
+      super(params)
+    end
+
+  end
+end

data/lib/also_energy/version.rb

@@ -0,0 +1,3 @@
+module AlsoEnergy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: also_energy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Whitsett
+- Darin Haener
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+description: A Ruby wrapper for the AlsoEnergy API
+email:
+- whitsett.tyler@gmail.com
+- dphaener@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- also_energy.gemspec
+- bin/console
+- bin/setup
+- lib/also_energy.rb
+- lib/also_energy/client.rb
+- lib/also_energy/connection.rb
+- lib/also_energy/hardware.rb
+- lib/also_energy/hash_wrangler.rb
+- lib/also_energy/site.rb
+- lib/also_energy/version.rb
+homepage: https://github.com/EditLLC/also-energy-ruby
+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
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the AlsoEnergy API
+test_files: []