pvoutput 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aabffd834f87c5ca43ed5d0c04c952fe4969b99c
-  data.tar.gz: d52c7cb268ad9608ce3c6503dd2e3b5cb38ff244
+SHA256:
+  metadata.gz: 12f23ce00da08b8c11d608678814059ea944ceb96690cf9472d10bc4c28cc9bf
+  data.tar.gz: be107b5aa1b8b11fd0a7fb728a5c8ee8cd0b71ca7b57b59a3c4330d42fd5da29
 SHA512:
-  metadata.gz: 25b9b1b49b10ca564cb9d23233a16505a17d7703d40a01ca0c48d25f1f0cd8f5328aeff11273aa777b358d20bf453ceaf0f5b91bee36063f7ef46fb820c1d411
-  data.tar.gz: 0a8fa6e7d7841d52a0657489d5ac5b9aedcd4b2105201f63fd5cebef3dfcc92b8664a52b19a8cc129dcf3a7213b26754c77817dfa0eca6596d6987289e814a33
+  metadata.gz: 9f7fb19d50a77f73aea7d86f323a8f8c6c55ebba5e02fb5c79248f6821da91e4046f94f40e3032cf682d8a5a258200ace172dad73e7bd70bae089c52c95ebba3
+  data.tar.gz: 4c22868b8b80f8202a8cde10ff1b131dd3e4f2de66a83ebd8c68c25ec466a3e5819021fbaa6bfd86323a1ae5dcda960c35e6e17ea342d55aa30053ee372645d8

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,25 @@
+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.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+
+    - name: Install dependencies
+      run: bundle install
+    - name: Publish to RubyGems
+      run: |
+        rake release
+      env:
+        GEM_HOST_API_KEY: "${{secrets.GEM_HOST_API_KEY}}"

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,17 +12,29 @@ Style/Documentation:
 Style/Lambda:
   Enabled: false
 
-Style/TrailingCommaInLiteral:
-  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
+
+RSpec/MultipleExpectations:
+  Max: 2

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+# 1.1.0 (2021-07-12)
+
+* add_batch_output is now using addoutput with a batch size of 1 in regular mode and 100 in donation mode (@jwillemsen)
+
+# Changelog
+
+# 1.0.0 (2021-02-14)
+
+* Require a minimum of Ruby 2.5 (@jwillemsen)
+* Clean up ruby gem publish GitHub Action (@jwillemsen)
+
+# 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)

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.
 
@@ -147,11 +149,28 @@ client.add_output(
 )
 ```
 
+## Debugging
+
+You can enable HTTParty debugging to see the requests by setting `PVOUTPUT_DEBUG=true`
+
 ## 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Release
+
+To release a new version:
+  * Create a branch for the release
+  * Update the version number in `version.rb`
+  * Update CHANGELOG.md
+  * git commit -pm 'Release 1.x.x'
+  * git tag v1.x.x
+  * git push
+  * git push --tags
+  * In GitHub add the Change Log section to the release and save it
+  * Check everything looks OK in GitHub Actions
 
 ## Contributing
 

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,22 +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, 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
+
+      # The add_batch_output operation has a default limit of 1 sets of data in one
+      # request, when you are using the donation mode the limit is 100 sets
+      @batch_size = 1
       @batch_size = 100 if donation_mode
 
       self.class.headers 'X-Pvoutput-Apikey' => @api_key, 'X-Pvoutput-SystemId' => @system_id
     end
 
+    # 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
@@ -66,29 +87,25 @@ module PVOutput
     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)
+      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(',') + ';'
+          data += "#{date},#{keys.map { |key| values[key] }.join(',')};"
         end
 
         params = {
           :data => data.chop,
         }
 
-        response = self.class.post('/service/r2/addbatchoutput.jsp', :body => params)
-
-        raise('Bad Post') unless response.code == 200
+        post_request('/service/r2/addoutput.jsp', :body => params)
       end
     end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/pvoutput/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PVOutput
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.1.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.5'
+
   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.3.0
+  version: 1.1.0
 platform: ruby
 authors:
 - John Ferlito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2021-07-11 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.5'
 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.1.6
 signing_key: 
 specification_version: 4
 summary: Library to speak to the PVOutput API

data/circle.yml

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