pvoutput 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: addc07d68f5896b569e08c0fff56515de4989add
-  data.tar.gz: 1b857c2cb71269917d2b6636a32c2cfb19e02e16
+SHA256:
+  metadata.gz: 5bae86d84185da437949075808498e10411e593feef84554670f6910b1136dd9
+  data.tar.gz: 0e8bdf41526686570b06714902f18ab63ab8f809a5d41c081f8e5299b1f380d5
 SHA512:
-  metadata.gz: 369b0064aeacf2f2ed869298d33d1460177d3a76e130562d3ff069a87115d49782a62fce7d62952f591b2983508651deaf3b3f4ee81cc37eddec0d41de3a3d8c
-  data.tar.gz: 246ad5582773fd4cc6b691b6ce9bbda18c1ec06d4fcd739733aabd4139d6cb30c8843128ce24e7dc45a326201d2bce5f520b7632e4bd3e150128ea3f528f026c
+  metadata.gz: 4a479f681ca96f0c22c5627f8c19d65ea285aa0ff6407af03a1e03cad6407e6ec3a00e5487b9068b41b065f4157fe49f86776cb2b26aa2eb55afc9db90091baa
+  data.tar.gz: 809acd85b1f998651ee3f669130a88d7e4b09c4245aa7bdf88006a6dc5e2f257c6791c0a1dc9935fc50ce7e65e9f0645323945da1dd73f588b8d8da4e2e44d4b

data/.gitignore

@@ -4,3 +4,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/bundle

data/.rubocop.yml

@@ -9,12 +9,18 @@ Style/Documentation:
 Style/Lambda:
   Enabled: false
 
-Style/TrailingComma:
+Style/TrailingCommaInLiteral:
   EnforcedStyleForMultiline: comma
 
+Metrics/MethodLength:
+  Max: 20
+
 Metrics/LineLength:
   Max: 120
 
+RSpec/ExampleLength:
+  Max: 15
+
 Style/ModuleFunction:
   Enabled: false
 

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+# 0.5.0 (2020-09-20)
+
+* Add more detail to error messages (@jwillemsen)
+* Support debugging (@johnf)
+
+# 0.4.0 (20160911)
+
+* Add retries to batch_output (@jwillemsen)
+
+# 0.3.0 (20160229)
+
+* Add donation mode (@jwillemsen)
+* Add batch_output support (@jwillemsen)
+
+# 0.2.0 (20160227)
+
+* Fix typo in temperature (@jwillemsen)
+* Add usage documentation (@jwillemsen)
+* Add the add_ouput method for end of day reporting (@jwillemsen)
+* Use latest bundler in CircleCI (@johnf)
+
+# 0.1.1 (20151122)
+
+* Convert the system id to a string (@johnf)
+
+# 0.1.0 (20151122)
+
+* Initial Release (@johnf)

data/README.md

@@ -2,6 +2,8 @@
 
 [![Circle CI](https://circleci.com/gh/johnf/pvoutput.svg?style=svg)](https://circleci.com/gh/johnf/pvoutput)
 [![Coverage Status](https://coveralls.io/repos/johnf/pvoutput/badge.svg?branch=master&service=github)](https://coveralls.io/github/johnf/pvoutput?branch=master)
+[![Gem Version](https://badge.fury.io/rb/pvoutput.svg)](http://badge.fury.io/rb/pvoutput)
+
 
 Ruby library for talking to the PVOutput API.
 
@@ -23,7 +25,133 @@ Or install it yourself as:
 
 ## Usage
 
-TODO
+In order to use pvoutput in your application you need to use
+
+```ruby
+require 'pvoutput/client'
+```
+
+First step is to create a PVOutput client using your PVOutput assigned system_id and api_key
+
+```ruby
+pvoutput = PVOutput::Client.new(system_id, api_key)
+```
+
+At the moment you [donate](http://pvoutput.org/donate.jsp) to PVOutput you can enable the donation mode by creating a PVOutput client using
+
+```ruby
+pvoutput = PVOutput::Client.new(system_id, api_key, true)
+```
+
+Now you can report your real time status to PVOutput using
+
+```ruby
+pvoutput.add_status(
+  options
+)
+```
+
+The add_status operation accepts the following options
+
+| Option           | PVOutput Parameter |
+| ---------------- | ------------------ |
+| energy_generated | v1 |
+| power_generated  | v2 |
+| energy_consumed  | v3 |
+| power_consumed   | v4 |
+| temperature      | v5 |
+| voltage          | v6 |
+| cumulative       | c1 |
+| net              | n |
+
+As example
+
+```ruby
+client.add_status(
+  :energy_generated => 100,
+  :power_generated  => 50,
+  :temperature      => 30,
+  :voltage          => 200,
+)
+```
+
+You can report your daily output to PVOutput using
+
+```ruby
+pvoutput.add_output(
+  options
+)
+```
+
+The add_output operation accepts the following options
+
+| Option                | PVOutput Parameter |
+| --------------------- | ------------------ |
+| output_date           | d |
+| energy_generated      | g |
+| peak_power            | pp |
+| peak_time             | pt |
+| condition             | cd |
+| min_temp              | tm |
+| max_temp              | tx |
+| comments              | cm |
+| import_peak           | ip |
+| import_off_peak       | io |
+| import_shoulder       | is |
+| import_high_shoulder  | ih |
+| consumption           | c |
+
+As example
+
+```ruby
+client.add_output(
+  :output_date      => '20160228'
+  :energy_generated  => 15000,
+  :max_temp      => 30
+)
+```
+
+You can report also a batch of daily output values to PVOutput using
+
+```ruby
+pvoutput.add_batch_output(
+  options
+)
+```
+
+The add_batch_output operation accepts a hash with the date as key and within that the following options
+
+| Option                | PVOutput Parameter |
+| --------------------- | ------------------ |
+| energy_generated      | g |
+| peak_power            | pp |
+| peak_time             | pt |
+| condition             | cd |
+| min_temp              | tm |
+| max_temp              | tx |
+| comments              | cm |
+| import_peak           | ip |
+| import_off_peak       | io |
+| import_shoulder       | is |
+| import_high_shoulder  | ih |
+| consumption           | c |
+
+As example
+
+```ruby
+client.add_output(
+  :'20150101' => {
+    :energy_generated => 1239, },
+  :'20150102' => {
+    :energy_generated => 1523 },
+  :'20150103' => {
+    :energy_generated => 2190 },
+)
+```
+
+## Debugging
+
+You can able HTTParty debugging to see the requests by setting `PVOUTPUT_DEBUG=true`
 
 ## Development
 
@@ -33,7 +161,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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](contributor-covenant.org) code of conduct.
+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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'jfy'
+require 'pvoutput/client'
 
 require 'pry'
 Pry.start

data/circle.yml

@@ -4,3 +4,6 @@ test:
 machine:
   ruby:
     version: 2.2.3
+dependencies:
+  pre:
+    - gem install bundler --pre

data/lib/pvoutput/client.rb

@@ -4,16 +4,38 @@ module PVOutput
   class Client
     include HTTParty
     base_uri 'pvoutput.org'
-    # debug_output $stdout
+    debug_output $stdout if ENV['PVOUTPUT_DEBUG']
 
-    def initialize(system_id, api_key)
-      @system_id = system_id
-      @api_key = api_key
+    def initialize(system_id, api_key, donation_mode = false)
+      @system_id = system_id.to_s
+      @api_key = api_key.to_s
+      # The batch operations have default limit of 30 sets of data in one request, when you
+      # are using the donation mode the limit is 100 sets
+      @batch_size = 30
+      @batch_size = 100 if donation_mode
 
       self.class.headers 'X-Pvoutput-Apikey' => @api_key, 'X-Pvoutput-SystemId' => @system_id
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    # Helper method to post batch request to pvoutput that retries at the moment we get
+    # a 400 error back with body containing 'Load in progress'
+    def post_request(path, options = {}, &block)
+      loop do
+        response = self.class.post(path, options, &block)
+
+        if response.code == 400 && response.body =~ /Load in progress/
+          # We can't send data too fast, when the previous request is still loaded we
+          # have to wait so sleep 10 seconds and try again
+          sleep(10)
+        elsif response.code == 200
+          return
+        else
+          raise("Bad Post: #{response.body}")
+        end
+      end
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def add_status(options)
       time = options[:when] || Time.now
 
@@ -26,15 +48,63 @@ module PVOutput
       params[:v2] = options[:power_generated] if options[:power_generated]
       params[:v3] = options[:energy_consumed] if options[:energy_consumed]
       params[:v4] = options[:power_consumed] if options[:power_consumed]
-      params[:v5] = options[:temperature] if options[:temparature]
+      params[:v5] = options[:temperature] if options[:temperature]
       params[:v6] = options[:voltage] if options[:voltage]
       params[:c1] = 1 if options[:cumulative] == true
       params[:n]  = 1 if options[:net] == true
 
       response = self.class.post('/service/r2/addstatus.jsp', :body => params)
 
-      fail('Bad Post') unless response.code == 200
+      raise('Bad Post') unless response.code == 200
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def add_output(options)
+      params = {
+      }
+
+      params[:d] = options[:output_date]
+      params[:g] = options[:energy_generated] if options[:energy_generated]
+      params[:pp] = options[:peak_power] if options[:peak_power]
+      params[:pt] = options[:peak_time] if options[:peak_time]
+      params[:cd] = options[:condition] if options[:condition]
+      params[:tm] = options[:min_temp] if options[:min_temp]
+      params[:tx] = options[:max_temp] if options[:max_temp]
+      params[:cm] = options[:comments] if options[:comments]
+      params[:ip] = options[:import_peak] if options[:import_peak]
+      params[:io] = options[:import_off_peak] if options[:import_off_peak]
+      params[:is] = options[:import_shoulder] if options[:import_shoulder]
+      params[:ih] = options[:import_high_shoulder] if options[:import_high_shoulder]
+      params[:c] = options[:consumption] if options[:consumption]
+
+      response = self.class.post('/service/r2/addoutput.jsp', :body => params)
+
+      raise('Bad Post') unless response.code == 200
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    # rubocop:disable Metrics/AbcSize
+    def add_batch_output(options)
+      keys = %i(energy_generated energy_export energy_used)
+      keys += %i(peak_power peak_time condition min_temp)
+      keys += %i(max_temp comments import_peak import_off_peak)
+      keys += %i(import_shoulder)
+
+      options.to_a.each_slice(@batch_size) do |slice|
+        data = ''
+        slice.each do |entry|
+          date, values = entry
+          data += "#{date}," + keys.map { |key| values[key] }.join(',') + ';'
+        end
+
+        params = {
+          :data => data.chop,
+        }
+
+        post_request('/service/r2/addbatchoutput.jsp', :body => params)
+      end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/pvoutput/version.rb

@@ -1,3 +1,3 @@
 module PVOutput
-  VERSION = '0.1.0'
+  VERSION = '0.5.0'.freeze
 end

data/pvoutput.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'httparty'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '>= 2.1'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pvoutput
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - John Ferlito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -28,30 +28,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -174,6 +174,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -205,8 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Library to speak to the PVOutput API