egauge-rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 38d34c0ab7c558f82841f348e0135d3ba9120678
-  data.tar.gz: 528d77d916ffffe031a2be9b02157e893d70786a
+SHA256:
+  metadata.gz: 62c4a2fc2d4b598158af977fef23b0358f8b3aef93c8ff67c244fc4496a5273f
+  data.tar.gz: 64de5a4c83da20b04103b9b1dd6c81892d34947b7f43740fd6b7b2e6760aaaa4
 SHA512:
-  metadata.gz: 62964f6afeec1cfb09c298c50f468ffeaf96d2bbce43ecd39f4a0a56a693b04ef3d705db0cb236f5b0718a4aa3d393bdea6257beac4d9ebcf39aa3c5eeff43f6
-  data.tar.gz: f49fdd271da951848b7190aca2497d097b9b7d1cb54d5055d2d0580604735132624a819a2f931b3f2479667d35e66ac0a6ea722957a95e8a0958a180267373e7
+  metadata.gz: 849514cd5fd5d144d472f961b5467cd7abfa62f483f2d702e6b7366afaf4bc492e423d007f2b2f9c54b9acafc7dc929ff314c40fe090c8eb8381432571dcc919
+  data.tar.gz: 9180bb1e396cc44b844d3703ad3e79bdfb9dcebd80cd38ed67915615858d3059ae287903f43a0ef509b10704d28361393f54520d67426f5e3980e707396f2071

data/README.md

@@ -22,29 +22,28 @@ Or install it yourself as:
 Using this gem requires some understanding of the [Egauge API](https://www.egauge.net/docs/egauge-xml-api.pdf).
 
 ### Basic Query
-
-
-
+Queries return response objects that can be interacted with. More details on the response object are found below.
 ```ruby
+require 'egauge'
 client = Egauge::Client.new('http://egaugeurl.egaug.es/12345')
 # This nil is necessary because the query structure is 'h&n=24'
-client.query('cgi-bin/egauge-show', :h => nil, :n => 24, :f => 1522800000)
+client.query(:h => nil, :n => 24, :f => 1522800000)
 ```
 ### Helper query
-There are helpers to query data for you without having to craft queries
-
+There are helpers to query data for you without having to craft queries. These also return response objects.
 ```ruby
+require 'egauge'
 client = Egauge::Client.new('http://egaugeurl.egaug.es/12345')
 client.full_day_kwh
-{:solar => 432, :solar2 => 486}
 ```
 
 ### Egauge response object
-Basic queries will return a response object. That object will have reader methods for each header that will return the rows of that header.
+Queries will return a response object. That object will have reader methods for each header that will return the rows of that header.
 
 If you're unsure what your headers are, there is a method you can use to find out!
 
 ```ruby
+require 'egauge'
 client = Egauge::Client.new('http://egaugeurl.egaug.es/12345')
 response = client.query('cgi-bin/egauge-show', :h => nil, :n => 24, :f => 1522800000)
 

data/lib/egauge/client.rb

@@ -1,19 +1,28 @@
 require 'httpclient'
-require 'uri'
 
 module Egauge
   class Client
     include Egauge::PowerHelpers
 
+    EGAUGE_PATH = '/cgi-bin/egauge-show?'.freeze
+
     def initialize(base_url)
       @client = HTTPClient.new(base_url: base_url)
     end
 
-    def query(endpoint, options = {})
-      Egauge::Response.new(client.get(endpoint, options).body)
+    def query(options = {})
+      Egauge::Response.new(client.get(EGAUGE_PATH + query_string(options)).body)
     end
 
     private
       attr_reader :client
+
+      def query_string(options)
+        options.stringify_keys.map do |key, value|
+          query_parameter = key.dup
+          query_parameter << "=#{value.to_s}" unless value.nil?
+          query_parameter
+        end.join('&')
+      end
   end
 end

data/lib/egauge/power_helpers.rb

@@ -2,23 +2,20 @@ module Egauge
   module PowerHelpers
     KWH_DIVIDER = 3600000
 
-    def full_day_kwh
-      full_day_kwh = {}
-      response = query("/cgi-bin/egauge-show?#{yesterday_query}")
-      response.headers.each do |header|
-        full_day_kwh[header] = calculate_kwh(response.send(header))
-      end
-      full_day_kwh
+    def full_day_kwh(day = Time.zone.now.end_of_day.to_i)
+      query(:C => nil, :h => nil, :n => 24, :f => day)
     end
 
-    private
+    def monthly_kwh(number_of_months = 12)
+      query(:C => nil, :T => months(number_of_months))
+    end
 
-      def calculate_kwh(power_output)
-        (power_output.first - power_output.last) / KWH_DIVIDER
-      end
+    private
 
-      def yesterday_query
-        "h&n=24&f=#{Date.yesterday.end_of_day.to_i}"
+      def months(number_of_months)
+        number_of_months.times.map do |number|
+          number.months.ago.beginning_of_month.to_i
+        end.unshift(Time.current.to_i).join(',')
       end
   end
 end

data/lib/egauge/response.rb

@@ -1,8 +1,9 @@
 require 'nokogiri'
-require 'ostruct'
 
 module Egauge
   class Response
+    KWH_DIVIDER = 3600000
+
     def initialize(body)
       @body = Nokogiri.parse(body)
       load_power_output
@@ -17,7 +18,7 @@ module Egauge
       attr_reader :body
 
       def column_content(header_index)
-        rows.map { |row| row.css("c").children[header_index].text.to_i }
+        rows.map { |row| (row.css("c").children[header_index].text.to_i / KWH_DIVIDER).abs }
       end
 
       def rows

data/lib/egauge/version.rb

@@ -1,3 +1,3 @@
 module Egauge
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: egauge-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joey Ferguson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby client for egauge inverter