pvoutput 0.1.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c675f86a314a18eff21610c99ab24c182b0e17a4
-  data.tar.gz: a19c6c6e50ed4772bd2e8246e8dfb052047e97b0
+SHA256:
+  metadata.gz: 335a39d8597c2d72545424953282c5325c677ba7c8c8529ef58a66157088e9b1
+  data.tar.gz: a7eb5913ea1960036f4c8bdb3f3c4523674c69e1bccb23756c4b037d48a866ac
 SHA512:
-  metadata.gz: 52c869a01e3d2b121137433db0c3c1bba8fdde9c4f03e7ac29a4c7b54cfec56560730fdddde34cb18f4963bdf7cf753ab81bcb8bf189b9b05aa3680bd3e9bd60
-  data.tar.gz: be043beee3755051fdfbcc5be663f5befd333b5be520d7e8add364ca0670ce6e7f13b84e9d8e032940fef9b20edf9dc7a9293246e88b397a2101fa57cb840c3c
+  metadata.gz: 5d5a1e4180ba44bec0fb0e3aed3facf13d40d959a55b13104852b9b070336935228e7dec82bded26ac0989abb72b35d6798325dc99fdc884d6e35920290aa444
+  data.tar.gz: e93c15e6e04f3421b4bc50b47e2ee2e30b846b5f11f333ff2b4d2866b811c2d06de83434ab9daaac25db764be7bbc00a5c09c4a7c5139131074db29a8f109864

data/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# Set update schedule for GitHub Actions
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "saturday"
+
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "saturday"

data/.github/workflows/gem-push.yaml

@@ -0,0 +1,29 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Install dependencies
+      run: bundle install
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        rake release
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  schedule:
+    - cron: '0 1 * * SUN'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '2.5', '2.6', '2.7', '3.0', 'ruby-head' ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Lint files
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

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

data/.rubocop.yml

@@ -1,6 +1,9 @@
 require: rubocop-rspec
 
-HashSyntax:
+AllCops:
+  NewCops: enable
+
+Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
 Style/Documentation:
@@ -9,14 +12,26 @@ Style/Documentation:
 Style/Lambda:
   Enabled: false
 
-Style/TrailingComma:
-  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Metrics/MethodLength:
+  Max: 20
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
+RSpec/ExampleLength:
+  Max: 15
+
 Style/ModuleFunction:
   Enabled: false
 
-AlignHash:
+Layout/HashAlignment:
   EnforcedHashRocketStyle: table
+
+Style/OptionalBooleanParameter:
+  Enabled: false

data/CHANGELOG.md

@@ -1,7 +1,38 @@
+# Changelog
+
+# 0.6.0 (2021-02-06)
+
+This test has no code changes but tests the new release process.
+
+* Move tests from CircleCI to GitHub Actions (@johnf)
+* Keep an eye on dependencies with Dependabot (@jwillemsen)
+* Schedule regular tests against multiple rubys (@jwillemsen)
+
+# 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
+* Convert the system id to a string (@johnf)
 
 # 0.1.0 (20151122)
 
-* Initial Release
+* Initial Release (@johnf)

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,7 +1,9 @@
 # PVOutput
 
-[![Circle CI](https://circleci.com/gh/johnf/pvoutput.svg?style=svg)](https://circleci.com/gh/johnf/pvoutput)
+[![Actions Status](https://github.com/johnf/pvoutput/workflows/Test/badge.svg)](https://github.com/johnf/pvoutput/actions)
 [![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 enable 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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/bin/console

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

data/lib/pvoutput.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pvoutput/version'
 
 module PVOutput

data/lib/pvoutput/client.rb

@@ -1,19 +1,43 @@
+# frozen_string_literal: true
+
 require 'httparty'
 
 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)
+    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 +50,61 @@ 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
+
+    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
   end
 end

data/lib/pvoutput/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PVOutput
-  VERSION = '0.1.1'
+  VERSION = '0.6.0'
 end

data/pvoutput.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pvoutput/version'
 
@@ -18,16 +19,18 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 
+  spec.required_ruby_version = '>= 2.4'
+
   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 'coveralls'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'rspec_junit_formatter'
-  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pvoutput
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.6.0
 platform: ruby
 authors:
 - John Ferlito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2021-02-06 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
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -67,21 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -171,6 +171,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/gem-push.yaml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -182,7 +185,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- circle.yml
 - lib/pvoutput.rb
 - lib/pvoutput/client.rb
 - lib/pvoutput/version.rb
@@ -199,15 +201,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Library to speak to the PVOutput API

data/circle.yml

@@ -1,6 +0,0 @@
-test:
-  post:
-    - bundle exec rubocop
-machine:
-  ruby:
-    version: 2.2.3