pvoutput-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f3ba42b630f858030befe5c6df7d2f109ec11bf
+  data.tar.gz: 3e2bb121c03d456c14a68e33700d07fbe1429a68
+SHA512:
+  metadata.gz: b4eb760a8e74b2c1b6be795c97ad9ef7518a3fd618fa70edb559defdc30870a297a9f90123ee527c031526973213f602285788991d254af3d417081c24c24e6b
+  data.tar.gz: 14c12c4394068cc2f55c3181af0e3596d873011d5a549bc9cf5ac04fffa0b62f4c9681e1b3460dfd030300f29f5e046075a5690fb7ad7af9e51159be94dcde77

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pvoutput-api.gemspec
+gemspec
+

data/Guardfile

@@ -0,0 +1,72 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories %w(lib test)
+
+## Uncomment to clear the screen before every task
+clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { 'test' }
+#  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end
+
+# Notifications 
+#   via tmux https://github.com/guard/guard/wiki/System-notifications#tmux
+notification :tmux,
+  display_message: true,
+  timeout: 5, # in seconds
+  default_message_format: '%s >> %s',
+  # the first %s will show the title, the second the message
+  # Alternately you can also configure *success_message_format*,
+  #  *pending_message_format*, *failed_message_format*
+  line_separator: ' > ', # since we are single line we need a separator
+  color_location: 'status-left-bg', # to customize which tmux element will change color
+  
+  # Other options:
+  default_message_color: 'black',
+  success: 'colour150',
+  failure: 'colour174',
+  pending: 'colour179',
+  
+  # Notify on all tmux clients
+  display_on_all_clients: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jon Bartlett
+
+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,102 @@
+# pvoutput-api
+
+A Ruby wrapper around PVOutput [API](http://pvoutput.org/help.html#api).
+
+Update 30/06/2016: Since working on this over a year ago another similar project has sprung up (see [https://github.com/johnf/pvoutput](https://github.com/johnf/pvoutput)). There is currently no overlap in functionality so I decided to publish the Gem anyway. In the longterm these projects should probably merge.
+
+See also related project [pvoutput-qif](https://github.com/jonbartlett/pvoutput-qif).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pvoutput-api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pvoutput-api
+
+## Usage
+
+```
+require 'pvoutput-api'
+
+pvo_auth = PVOutput::Auth.new('8313', 'secret')
+stat_data = PVOutput::Statistic.fetch("20150622", "20150622", pvo_auth)
+puts stat_data.debit_amount
+puts stat_data.energy_consumed
+```
+
+## Service Capability
+
+At the time of writing, the PVOutput API consists of the following services.
+
+| Service Name | URL | Implemented |
+| ------------ | --- | ----------- |
+| [Add Output](http://pvoutput.org/help.html#api-addoutput) | http://pvoutput.org/service/r2/addoutput.jsp | no | 
+| [Add Status](http://pvoutput.org/help.html#api-addstatus) | http://pvoutput.org/service/r2/addstatus.jsp | no |
+| [Add Batch Output](http://pvoutput.org/help.html#api-addbatchoutput) | http://pvoutput.org/service/r2/addbatchoutput.jsp | no |
+| [Add Batch Status](http://pvoutput.org/help.html#api-addbatchstatus) | http://pvoutput.org/service/r2/addbatchstatus.jsp | no |
+| [Get Status](http://pvoutput.org/help.html#api-getstatus) | http://pvoutput.org/service/r2/getstatus.jsp | no |
+| [Get Statistic](http://pvoutput.org/help.html#api-getstatistic) | http://pvoutput.org/service/r2/getstatistic.jsp | yes |
+| [Get System](http://pvoutput.org/help.html#api-getsystem) | http://pvoutput.org/service/r2/getsystem.jsp | no |
+| [Get Output](http://pvoutput.org/help.html#api-getoutput) | http://pvoutput.org/service/r2/getoutput.jsp | no |
+| [Get Extended](http://pvoutput.org/help.html#api-getextended) | http://pvoutput.org/service/r2/getextended.jsp | no |
+| [Get Favourite](http://pvoutput.org/help.html#api-getfavourite) | http://pvoutput.org/service/r2/getfavourite.jsp | no |
+| [Get Missing](http://pvoutput.org/help.html#api-getmissing) | http://pvoutput.org/service/r2/getmissing.jsp | no |
+| [Get Insolation](http://pvoutput.org/help.html#api-getinsolation) | http://pvoutput.org/service/r2/getinsolation.jsp | no |
+| [Delete Status](http://pvoutput.org/help.html#api-deletestatus) | http://pvoutput.org/service/r2/deletestatus.jsp | no |
+| [Search](http://pvoutput.org/help.html#api-search) | http://pvoutput.org/service/r2/search.jsp | no |
+| [Get Team](http://pvoutput.org/help.html#api-getteam) | http://pvoutput.org/service/r2/getteam.jsp | no |
+| [Join Team](http://pvoutput.org/help.html#api-jointeam) | http://pvoutput.org/service/r2/jointeam.jsp | no |
+| [Leave Team](http://pvoutput.org/help.html#api-leaveteam) | http://pvoutput.org/service/r2/leaveteam.jsp | no |
+| [Get Supply](http://pvoutput.org/help.html#api-getsupply) | http://pvoutput.org/service/r2/getsupply.jsp | no |
+| [Register Notification](http://pvoutput.org/help.html#api-registernotification) | http://pvoutput.org/service/r2/registernotification.jsp | no |
+| [Deregister Notification](http://pvoutput.org/help.html#api-registernotification) | http://pvoutput.org/service/r2/deregisternotification.jsp | no |
+
+## Rate Limits
+
+The following rate limits applies per API key for all request types -
+
+* 60 requests per hour.
+* 300 requests per hour in donation mode.
+
+It is recommended to make requests at least 10 seconds apart.
+
+**via [PVOutput API Documentaion](http://pvoutput.org/help.html#api)**
+
+## Links
+
+* [PVOutput API](http://pvoutput.org/help.html#api)
+
+## Unit Tests
+
+Tests can be run using:
+
+```rake test```
+
+or with [Guard](https://github.com/guard/guard)
+
+```bundle exec guard```
+
+## Debugging Issue
+
+Raise an issue via [Github](https://github.com/jonbartlett/pvoutput-api/issues). If the issue is related to the PVOutput API call, enable logging with the following environment variable:
+
+```RESTCLIENT_LOG=stdout```
+
+Copy and paste the exact output into the Issue.
+
+## Contributing
+
+1. Fork it ( https://github.com/jonbartlett/pvoutput-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+ t.libs << "test"
+ t.test_files = FileList['test/pvoutput-api/test*.rb']
+# t.verbose = true
+end

data/lib/pvoutput-api.rb

@@ -0,0 +1,3 @@
+require_relative 'pvoutput-api/auth'
+require_relative 'pvoutput-api/statistic'
+require_relative 'pvoutput-api/version'

data/lib/pvoutput-api/auth.rb

@@ -0,0 +1,13 @@
+module PVOutput
+
+  class Auth
+    attr_accessor :system_id, :api_key
+
+    def initialize(system_id, api_key)
+      @system_id = system_id
+      @api_key = api_key
+    end
+  end
+
+end
+

data/lib/pvoutput-api/statistic.rb

@@ -0,0 +1,89 @@
+require 'csv'
+require 'rest-client'
+
+module PVOutput
+
+  class Statistic
+
+    attr_reader :energy_generated            # number watt hours 246800
+    attr_reader :energy_exported             # number watt hours 246800
+    attr_reader :average_generation          # number watt hours 8226
+    attr_reader :minimum_generation          # number watt hours 2000
+    attr_reader :maximum_generation          # number watt hours 11400
+    attr_reader :average_efficiency          # number kWh/kW 3.358
+    attr_reader :outputs                     # number - 27
+    attr_reader :actual_date_from            # yyyymmdd 2015-06-2420100901
+    attr_reader :actual_date_to              # yyyymmdd 2015-06-2420100927
+    attr_reader :record_efficiency           # number kWh/kW 4.653
+    attr_reader :record_date                 # yyyymmdd 2015-06-2420100916
+    attr_reader :energy_consumed             # number watt hours 10800
+    attr_reader :peak_energy_import          # number watt hours 5000
+    attr_reader :off_peak_energy_import      # number watt hours 1000
+    attr_reader :shoulder_energy_import      # number watt hours 4000
+    attr_reader :high_shoulder_energy_import # number watt hours 800
+    attr_reader :average_consumption         # number watt hours 1392
+    attr_reader :minimum_consumption         # number watt hours 10
+    attr_reader :maximum_consumption         # number watt hours 2890
+    attr_reader :credit_amount               # decimal currency 37.29
+    attr_reader :debit_amount                # decimal currency 37.29
+
+    API_URL = "http://pvoutput.org/service/r2/getstatistic.jsp"
+
+    def initialize(statistics)
+      @energy_generated = statistics[:energy_generated]
+      @energy_exported = statistics[:energy_exported]
+      @average_generation = statistics[:average_generation]
+      @minimum_generation = statistics[:minimum_generation]
+      @maximum_generation = statistics[:maximum_generation]
+      @average_efficiency = statistics[:average_efficiency]
+      @outputs = statistics[:outputs]
+      @actual_date_from = statistics[:actual_date_from]
+      @actual_date_to = statistics[:actual_date_to]
+      @record_efficiency = statistics[:record_efficiency]
+      @record_date = statistics[:record_date]
+      @energy_consumed = statistics[:energy_consumed]
+      @peak_energy_import = statistics[:peak_energy_import]
+      @off_peak_energy_import = statistics[:off_peak_energy_import]
+      @shoulder_energy_import = statistics[:shoulder_energy_import]
+      @high_shoulder_energy_import =statistics[:high_shoulder_energy_import]
+      @average_consumption = statistics[:average_consumption]
+      @minimum_consumption = statistics[:minimum_consumption]
+      @maximum_consumption = statistics[:maximum_consumption]
+      @credit_amount = statistics[:credit_amount]
+      @debit_amount = statistics[:debit_amount]
+    end
+
+    def self.fetch (date_from, date_to, auth_details)
+
+      # hit api and return csv data in array
+      data = RestClient.get(API_URL, {:params => {:sid => auth_details.system_id, :key => auth_details.api_key, :df => date_from, :dt => date_to, :c => '1', :crdr => '1'}})
+      results = CSV.new(data).to_a
+
+      # array to hash
+      statistics = { energy_generated: results[0][0],
+                     energy_exported: results[0][1],
+                     average_generation: results[0][2],
+                     minimum_generation: results[0][3],
+                     maximum_generation: results[0][4],
+                     average_efficiency: results[0][5],
+                     outputs: results[0][6],
+                     actual_date_from: results[0][7],
+                     actual_date_to: results[0][8],
+                     record_efficiency: results[0][9],
+                     record_date: results[0][10],
+                     energy_consumed: results[0][11],
+                     peak_energy_import: results[0][12],
+                     off_peak_energy_import: results[0][13],
+                     shoulder_energy_import: results[0][14],
+                     high_shoulder_energy_import: results[0][15],
+                     average_consumption: results[0][16],
+                     minimum_consumption: results[0][17],
+                     maximum_consumption: results[0][18],
+                     credit_amount: results[0][19],
+                     debit_amount: results[0][20]}
+      new(statistics)
+    end
+
+  end
+
+end

data/lib/pvoutput-api/version.rb

@@ -0,0 +1,3 @@
+module PVOutput
+  VERSION = "0.0.2"
+end

data/pvoutput-api.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pvoutput-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pvoutput-api"
+  spec.version       = PVOutput::VERSION
+  spec.authors       = ["Jon Bartlett"]
+  spec.email         = ["mail@jaybe.net <mailto:mail@jaybe.net>"]
+
+  spec.summary       = %q{pvoutput-api}
+  spec.description   = %q{Gem to wrap PVOutput.org API}
+  spec.homepage      = "https://github.com/jonbartlett/pvoutput-api"
+  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.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-minitest", "~> 2.4"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1"
+
+  spec.add_runtime_dependency "rest-client", "~> 1.8"
+
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: pvoutput-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jon Bartlett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Gem to wrap PVOutput.org API
+email:
+- mail@jaybe.net <mailto:mail@jaybe.net>
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pvoutput-api.rb
+- lib/pvoutput-api/auth.rb
+- lib/pvoutput-api/statistic.rb
+- lib/pvoutput-api/version.rb
+- pvoutput-api.gemspec
+homepage: https://github.com/jonbartlett/pvoutput-api
+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: pvoutput-api
+test_files: []