egauge-rb 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62c4a2fc2d4b598158af977fef23b0358f8b3aef93c8ff67c244fc4496a5273f
-  data.tar.gz: 64de5a4c83da20b04103b9b1dd6c81892d34947b7f43740fd6b7b2e6760aaaa4
+  metadata.gz: 870ff3fbd68b41a31cbe2f5569747a9bad1548f6155916eb7e8b6fae6e14c908
+  data.tar.gz: 83f121d4b91772be8f06b6df1a7ae86636bef65d86ccc1eebecf0b6220f1ea12
 SHA512:
-  metadata.gz: 849514cd5fd5d144d472f961b5467cd7abfa62f483f2d702e6b7366afaf4bc492e423d007f2b2f9c54b9acafc7dc929ff314c40fe090c8eb8381432571dcc919
-  data.tar.gz: 9180bb1e396cc44b844d3703ad3e79bdfb9dcebd80cd38ed67915615858d3059ae287903f43a0ef509b10704d28361393f54520d67426f5e3980e707396f2071
+  metadata.gz: a24cfeee85d4adf9c3e77a9d5afff9d99cdb3f187e914a5d1e1ce3f55ae96a9a99c8f6f069230e43ec0dd0dd8ce352b129c2bac2c654256e42b844837f9b8076
+  data.tar.gz: 0063d5d9e63410339c912630930d07fed8bb154ae67e84dadfdc03f4e4242473cb16b33b009321d6561f6253cfe6eb1bd8e372046c2490a6f942863513c7f8db

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    egauge-rb (0.1.0)
-      activesupport
+    egauge-rb (1.0.0)
+      activesupport (= 5.2.1)
       httpclient
-      nokogiri
+      nokogiri (= 1.8.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.6)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -18,12 +18,12 @@ GEM
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     httpclient (2.8.3)
-    i18n (1.0.0)
+    i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    nokogiri (1.8.2)
+    nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
@@ -57,4 +57,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.0
+   1.16.2

data/README.md

@@ -21,46 +21,50 @@ Or install it yourself as:
 ## Usage
 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(:h => nil, :n => 24, :f => 1522800000)
+client = Egauge::Client.new('http://<device_name>.egaug.es')
 ```
-### Helper query
-There are helpers to query data for you without having to craft queries. These also return response objects.
+The Client object implements a `fetch` method which takes hash that needs these keys set:
+ - `:timestamp` [Timestamp] - This is the point in time
+ from which to fetch past readings. The "latest" reading
+ will be the beginning of the current period breakdown.
+ For instance, if the timestamp is `2018-10-20 13:06` and
+ the breakdown is hourly, the latest reading will be
+ from `2018-10-20 13:00`.
+ - `:breakdown` [Symbol] - This defines the time period
+ between the readings. This can be `:hour`, `:day` or `:month`.
+ - `:count` [Integer] - Number of past readings to fetch.
+
 ```ruby
-require 'egauge'
-client = Egauge::Client.new('http://egaugeurl.egaug.es/12345')
-client.full_day_kwh
+options = {
+            :timestamp => 2018-10-26 21:47:23 -0400,
+            :breakdown => :hour,
+            :count => 3
+          }
+client.fetch(options)
+[
+  {"Date & Time"=>"1540602000", "Usage [kWh]"=>"0.000000000", "Generation [kWh]"=>"155625.220777500", "Solar [kWh]"=>"155625.220777500", "Solar+ [kWh]"=>"155707.304512778"},
+  {"Date & Time"=>"1540598400", "Usage [kWh]"=>"0.000000000", "Generation [kWh]"=>"155625.240751111", "Solar [kWh]"=>"155625.240751111", "Solar+ [kWh]"=>"155707.304512778"},
+  {"Date & Time"=>"1540594800", "Usage [kWh]"=>"0.000000000", "Generation [kWh]"=>"155625.262013333", "Solar [kWh]"=>"155625.262013333", "Solar+ [kWh]"=>"155707.304512778"}
+]
 ```
 
-### Egauge response object
-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!
+## Development
 
-```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)
+After checking out the repo, run `bin/setup` to install dependencies.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-respones.headers
-=> ["solar", "solar2"]
+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).
 
-response.solar
-=> [123412341234, 123412341234, 123412341234]
+## Testing
 
+`Rspec` is used as the testing framework. To test the whole suite, just run the following command.
+```ruby
+rake spec
 ```
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ArcadiaPower/egauge-rb. 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.

data/egauge-rb.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "httpclient"
-  spec.add_dependency "nokogiri"
-  spec.add_dependency "activesupport"
+  spec.add_dependency "nokogiri", "1.8.5"
+  spec.add_dependency "activesupport", "5.2.1"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/egauge.rb

@@ -1,5 +1,3 @@
 require "egauge/version"
-require "egauge/power_helpers"
 require "egauge/client"
-require "egauge/response"
 require "active_support/all"

data/lib/egauge/client.rb

@@ -1,24 +1,65 @@
 require 'httpclient'
+require 'csv'
 
 module Egauge
   class Client
-    include Egauge::PowerHelpers
-
     EGAUGE_PATH = '/cgi-bin/egauge-show?'.freeze
 
+    # The base_url should look something like
+    # this: 'http://egauge12345.egaug.es'
     def initialize(base_url)
       @client = HTTPClient.new(base_url: base_url)
     end
 
-    def query(options = {})
-      Egauge::Response.new(client.get(EGAUGE_PATH + query_string(options)).body)
+    # The options hash should have 3 keys defined:
+    # 1. :timestamp [Timestamp] - This is the point in time
+    #    from which to fetch past readings. The "latest" reading
+    #    will be the beginning of the current period breakdown.
+    #    For instance if the timestamp is 2018-10-20 13:06 and
+    #    the breakdown is hourly, the latest reading will be
+    #    from 2018-10-20 13:00
+    # 2. :breakdown [Symbol] - This defines the time period
+    #    between the readings. This can be :hour, :day or :month
+    # 3. :count [Integer] - Number of past readings to fetch
+    #
+    # This method returns an array of hashes with these values
+    #   - "Date & Time" (An integer representing time since epoch)
+    #   - "Usage [kWh]"
+    #   - "Generation [kWh]"
+    #   - "Solar [kWh]"
+    #   - "Solar+ [kWh]"
+    def fetch(options)
+      timestamps = build_timestamps(options)
+      params = { T: timestamps.join(","), c: nil }
+      query(params)
     end
 
     private
       attr_reader :client
 
-      def query_string(options)
-        options.stringify_keys.map do |key, value|
+      def build_timestamps(options)
+        timestamp = options[:timestamp]
+        breakdown = options[:breakdown]
+        count     = options[:count]
+
+        end_time = timestamp.send("beginning_of_#{breakdown}".to_sym)
+        time_method = "#{breakdown}s"
+        timestamps = []
+        count.times do |i|
+          timestamps << (end_time - i.send(time_method)).to_i
+        end
+        timestamps
+      end
+
+      def query(params)
+        csv_str = client.get(EGAUGE_PATH + query_string(params)).body
+        records = []
+        CSV.parse(csv_str, headers: true){|l| records << l.to_h }
+        records
+      end
+
+      def query_string(params)
+        params.stringify_keys.map do |key, value|
           query_parameter = key.dup
           query_parameter << "=#{value.to_s}" unless value.nil?
           query_parameter

data/lib/egauge/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: egauge-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Joey Ferguson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -28,30 +28,30 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.5
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -129,8 +129,6 @@ files:
 - egauge-rb.gemspec
 - lib/egauge.rb
 - lib/egauge/client.rb
-- lib/egauge/power_helpers.rb
-- lib/egauge/response.rb
 - lib/egauge/version.rb
 homepage: https://github.com/ArcadiaPower/egauge-rb
 licenses:

data/lib/egauge/power_helpers.rb

@@ -1,21 +0,0 @@
-module Egauge
-  module PowerHelpers
-    KWH_DIVIDER = 3600000
-
-    def full_day_kwh(day = Time.zone.now.end_of_day.to_i)
-      query(:C => nil, :h => nil, :n => 24, :f => day)
-    end
-
-    def monthly_kwh(number_of_months = 12)
-      query(:C => nil, :T => months(number_of_months))
-    end
-
-    private
-
-      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,34 +0,0 @@
-require 'nokogiri'
-
-module Egauge
-  class Response
-    KWH_DIVIDER = 3600000
-
-    def initialize(body)
-      @body = Nokogiri.parse(body)
-      load_power_output
-    end
-
-    def headers
-      @_headers ||= body.css("cname").map { |header| header.text.downcase.gsub(/\W/,"_") }
-    end
-
-    private
-
-      attr_reader :body
-
-      def column_content(header_index)
-        rows.map { |row| (row.css("c").children[header_index].text.to_i / KWH_DIVIDER).abs }
-      end
-
-      def rows
-        @_rows ||= body.css("r")
-      end
-
-      def load_power_output
-        headers.each_with_index do |header, index|
-          self.class.send(:define_method, header) { column_content(index) }
-        end
-      end
-  end
-end