sunscout 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 644c483147167e8f1ef8cdfb1523410f0f573db2
-  data.tar.gz: db5cd8d9fa95c7e639d8709462c6b384f30552c5
+  metadata.gz: 5f45706ac844935afe862c622ae4c429e11df56f
+  data.tar.gz: a0370ee2d6c1d12308ffde2e89c850a50521780e
 SHA512:
-  metadata.gz: 086a705e56e0537293fef631e8e7e363547b9b35864a86887d32bbe230ab612da11585b66e04bec7035cf3c5cd921720565381d62a970c33726132dd85613438
-  data.tar.gz: 800a75d24883102b32a6549235f685958c0040c59f4c0ca00cd5adcd9763b3fcdebdeddf8094ae62abcf706808b79a74e50d566166f5e8959317f7073439a4d7
+  metadata.gz: 906d6627928f2519e448079efb0a2f20c8bc3c51093176005fcc1fa261df4b94d7d9ee39d6fae76f7946c10df7cfd5514393b544b849027d4a61edac39f64d9f
+  data.tar.gz: 0a437e0385cbef5a53428a5189b15c913e68008bb37e1d95a2e7462f13e379c708c22bae3bce75e0b3a9149eb711cb8b0970585fce349d610a8512861cbd7797

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Change log
+
+This document represents a high-level overview of changes made to this project.
+It will not list every miniscule change, but will allow you to view - at a
+glance - what to expact from upgrading to a new version.
+
+## [unpublished]
+
+### Added
+
+### Changed
+
+### Fixed
+
+### Security
+
+### Deprecated
+
+### Removed
+
+## [0.3.0] - 2016-09-08
+
+### Added
+
+- [Net::SSH::Gateway](https://net-ssh.github.io/) support, to allow proxying
+  API requests via an SSH gateway.
+- Changelog :)
+
+## [0.2.0] - 2016-08-31
+
+### Added
+
+- Timezone support to Sunscout::SolarLog::SolarLog.
+
+
+## [0.1.0] - 2016-08-16
+
+### Added
+
+- Bindings to [SolarLog](http://www.solar-log.com) controllers via
+  Sunscout::SolarLog::SolarLog and Sunscout::SolarLog::Client.

data/lib/sunscout/solar_log/client.rb

@@ -15,28 +15,55 @@ module Sunscout
     #   c = Sunscout::SolarLog::Client.new('http://10.60.1.10')
     #   data = c.get_data()
     #   puts "Current power output: #{ data[:power_ac] }W"
+    #
+    # @example Proxying via SSH host
+    #   require 'sunscout'
+    #   require 'net/ssh/gateway'
+    #   gateway = Net::SSH::Gateway.new('jump.example.com', 'johndoe', password: 'hidden')
+    #   c = Sunscout::SolarLog::Client.new('http://192.168.1.10', ssh_gateway: gateway)
     class Client
       # Initialize a new instance of the class.
       # @param host [String] URI of the SolarLog web interface. 
-      def initialize(host)
+      # @param opts [Hash] Additional options
+      # @option opts [Net::SSH::Gateway] :ssh_gateway SSH gateway through which to proxy the request.
+      def initialize(host, opts = {})
         @host = host
+
+        @ssh_gateway = opts.fetch(:ssh_gateway, nil)
       end
 
       # Retrieve data from the HTTP API.
       # @return [Hash<Symbol, String|Integer>] Hash containing retrieved data
       def get_data
+        if @ssh_gateway
+          get_data_ssh
+        else
+          get_data_direct
+        end
+      end
+
+      private
+      def get_data_direct
         uri = build_uri
         req = build_request(uri)
-        data = send_request(req, uri)
+        send_request(req, uri)
+      end
 
-        data
+      def get_data_ssh
+        uri = build_uri
+        @ssh_gateway.open(uri.hostname, uri.port) do |port|
+          uri.hostname = '127.0.0.1'
+          uri.port     = port
+
+          req = build_request(uri)
+          send_request(req, uri)
+        end
       end
 
-      private
       # Create URI of HTTP endpoint
       def build_uri
         URI("#{ @host }/#{ REQUEST_QUERY }")
-      end 
+      end
 
       # Build HTTP POST request
       # @param uri [URI] URI of HTTP endpoint
@@ -56,7 +83,7 @@ module Sunscout
           http.request(req)
         end
 
-        # Todo: Exception handling:
+        # TODO: Exception handling:
         #   - catching in case of failure (DNS, timeout, ...)
         #   - throwing in case of API failure
         case res

data/lib/sunscout/solar_log/solar_log.rb

@@ -72,10 +72,15 @@ module Sunscout
       # This also immediately queries data from the SolarLog API.
       #
       # @param host [String] URI of the SolarLog web interface
-      # @param timezone [String] Timezone (or offset) which the SolarLog station resides in.
+      # @param opts [Hash] Additional options. 
+      #   If not consumed by this class itself, they are passed to {Client#initialize}
+      #   Be sure to check there for all possibilities!
+      # @option opts [String] :timezone Timezone (or offset) which the SolarLog station resides in.
       #   If none is specified, assume UTC.
-      def initialize(host, timezone: '+0000')
-        client = Sunscout::SolarLog::Client.new(host)
+      def initialize(host, opts = {})
+        timezone = opts.delete('timezone') || '+0000'
+
+        client = Sunscout::SolarLog::Client.new(host, opts)
         data = client.get_data
 
         # SolarLog returns the time a) without a timezone indicator and b) as whatever the station is configured.

data/sunscout.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "sunscout"
-  spec.version       = '0.2'
+  spec.version       = '0.3'
   spec.authors       = ["Michael Senn"]
   spec.email         = ["michael@morrolan.ch"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sunscout
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Michael Senn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md