smart_energy_group 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66afda4f4241fb3cf1a7b1f9e3e8f83da0f26de7
+  data.tar.gz: 6a01347689a74c65829b01a44a2c32e1bacd3eef
+SHA512:
+  metadata.gz: 61f7bf4e66367770773b86e3d94ff0607ec46b6273d256f095fe75894ccde511e32e1b0f645491b794adf8e9e9b0a5cde55572bb81b9caa45b347055f78ca707
+  data.tar.gz: ad3a612446cb9ffb903bad1886051b4093cec4c66f3af0858bc903d95318364ba36e787df673c7f537f8e6aa7bd5c5c4e7f94964714277290c158bd8c473e607

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle/
+/Gemfile.lock
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require: rubocop-rspec
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Metrics/LineLength:
+  Max: 120
+
+Style/ModuleFunction:
+  Enabled: false
+
+AlignHash:
+  EnforcedHashRocketStyle: table

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1 (2016-05-14)
+
+* Initial Release (@johnf)

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 behaviour 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 behaviour 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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Ferlito
+
+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,80 @@
+# Smart Energy Group
+
+[![Circle CI](https://circleci.com/gh/johnf/smart_energy_group.svg?style=svg)](https://circleci.com/gh/johnf/smart_energy_group)
+[![Coverage Status](https://coveralls.io/repos/johnf/smart_energy_group/badge.svg?branch=master&service=github)](https://coveralls.io/github/johnf/smart_energy_group?branch=master)
+
+Ruby library for talking to the Smart Energy Group API.
+
+Documentation for the API can be found at https://smartenergygroups.com/api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'smart_energy_group'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart_energy_group
+
+## Usage
+
+In order to use smart_energy_group in your application you need to use
+
+``` ruby
+require 'smart_energy_group/client'
+```
+
+First step is to create a Smart Energy Group client using your Smart Energy Group assigned site_token
+
+``` ruby
+seg = SmartEnergyGroup::Client.new(site_token)
+```
+
+You can then push data points
+
+``` ruby
+seg.send_data(
+  'home',
+  :temperature => [20.5, 60.0],
+  :power       => [1023.6, 500.9]
+)
+```
+
+The send_data operation accepts the following options
+
+| Option      | Description |
+| ----------- | ----------- |
+| power       | Power stream with the unit of watts |
+| energy      | Energy stream with the unit prefixed to kilowatt hours |
+| amps        | Current stream with the unit of amps |
+| channel     | Power stream identified with the Phase based on the channel number, with the same settings as a normal power stream |
+| temperature | Temperature stream with default units of Celcius |
+| voltage     | Voltage stream with the units being volts |
+| state       | Switch state stream to determine if a switch is on or off |
+| seconds     | Seconds stream representitive of an elapsed time in seconds |
+| heartbeat   | Boot Event stream to determine if your device has booted and also records a heartbeat to check things are still ticking |
+| pule        | Count of pulses output from a device |
+
+**Note::** The above will raise an error until you put the site into Discovery mode on the SEG website.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/johnf/pvoutput. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'smart_energy_group/client'
+
+puts '# Example'
+puts
+puts 'site_token = \'1234\''
+puts 'seg = SmartEnergyGroup::Client.new(site_token)'
+puts 'seg.send_data(\'home\', :temperature => [1, 2, 3, 4])'
+puts
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/circle.yml

@@ -0,0 +1,9 @@
+test:
+  post:
+    - bundle exec rubocop
+machine:
+  ruby:
+    version: 2.3.1
+dependencies:
+  pre:
+    - gem install bundler --pre

data/lib/smart_energy_group/client.rb

@@ -0,0 +1,49 @@
+require 'httparty'
+
+module SmartEnergyGroup
+  class Client
+    include HTTParty
+    base_uri 'api.smartenergygroups.com'
+    format :plain
+    # debug_output $stdout
+
+    def initialize(site_token)
+      @site_token = site_token
+    end
+
+    DATA_TYPES = {
+      :power       => 'p',
+      :energy      => 'e',
+      :amps        => 'a',
+      :channel     => 'c',
+      :temperature => 'temperature',
+      :voltage     => 'v',
+      :state       => 'state',
+      :seconds     => 'seconds',
+      :heartbeat   => 'heartbeat',
+      :pulse       => 'pulse',
+    }.freeze
+
+    def send_data(node_name, options)
+      time = options[:when] || Time.now
+      time = time.strftime('%FT%T')
+
+      data = generate_data(options)
+      msg = "(site #{@site_token} (node #{node_name} #{time} #{data}))"
+
+      response = self.class.put('/api_sites/stream', :body => msg)
+
+      raise("Bad Post: #{response.body}") unless response.code == 200 && response.body == "(status ok)\n"
+    end
+
+    def generate_data(options)
+      data = []
+      DATA_TYPES.keys.each do |type|
+        next unless options[type]
+        data += options[type].map.with_index(1) { |value, i| "(#{DATA_TYPES[type]}_#{i} #{value})" }
+      end
+
+      data.join('')
+    end
+  end
+end

data/lib/smart_energy_group/version.rb

@@ -0,0 +1,3 @@
+module SmartEnergyGroup
+  VERSION = '0.0.1'.freeze
+end

data/lib/smart_energy_group.rb

@@ -0,0 +1,4 @@
+require 'smart_energy_group/version'
+
+module SmartEnergyGroup
+end

data/smart_energy_group.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart_energy_group/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'smart_energy_group'
+  spec.version       = SmartEnergyGroup::VERSION
+  spec.authors       = ['John Ferlito']
+  spec.email         = ['johnf@inodes.org']
+
+  spec.summary       = 'Library to speak to the Smart Energy Group API'
+  spec.homepage      = 'https://github.com/johnf/smart_energy_group'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.require_paths = ['lib']
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.add_dependency 'httparty'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: smart_energy_group
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Ferlito
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: pry
+  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: 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'
+- !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: timecop
+  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: rubocop
+  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: rubocop-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'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: coveralls
+  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: 
+email:
+- johnf@inodes.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/smart_energy_group.rb
+- lib/smart_energy_group/client.rb
+- lib/smart_energy_group/version.rb
+- smart_energy_group.gemspec
+homepage: https://github.com/johnf/smart_energy_group
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Library to speak to the Smart Energy Group API
+test_files: []