amber_electric 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0080d683e3ce298401efef6dd5831929119e83b44d96dbd73efbcbae4625ae0e'
+  data.tar.gz: f30a5a064c78a23fdc23f9572d4fadba441eb5a2bc1f314488f1ae05bc4c60fe
+SHA512:
+  metadata.gz: '0739e12b7e0131c2c4bbcc6a682cf83eb0bd1928add7b1fb8e0bca394012044c87e748562f1b7ccb0ef9f744e7cc5b158aa40827e769fa9d7d43bc74482916d6'
+  data.tar.gz: e5bfa07bcddab84e4b1932778a9f0b9fcd03c8983136590476ca785e9abcaa58ebf6a89b8c3a6293b32d6baeb379fe6691b1ec3eafda94511a88324ef1f7a65d

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.0.1
+- Initial Release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021 James Healy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+# Amber Electric
+
+A ruby API client for https://amberelectric.com.au, and Australian Electricity Retailer.
+
+Currently Amber only provides an unauthenticated API for pricing, so no credentials are required.
+
+## Installation
+
+    gem install amber_electric
+
+... or add it to your Gemfile:
+
+    gem "amber_electric"
+
+## Usage
+
+    require "amber_electric"
+    
+    puts AmberElectric::Prices.for(postcode: 3000).inspect

data/lib/amber_electric.rb

@@ -0,0 +1,84 @@
+require "net/http"
+require "json"
+require "tzinfo"
+require "bigdecimal"
+require "time"
+
+module AmberElectric
+  
+  class Client
+    def self.prices_for(postcode: )
+      self.new.prices_for(postcode: postcode)
+    end
+
+    # curl -X POST "https://api.amberelectric.com.au/prices/listprices"   -H 'Content-Type: application/json'   -d '{ "postcode": "3058" }'
+    def prices_for(postcode: )
+      http = Net::HTTP.new("api.amberelectric.com.au", 443)
+      http.use_ssl = true
+
+      request = Net::HTTP::Post.new("/prices/listprices")
+      request["Content-Type"] = "application/json"
+      request.body = {postcode: postcode.to_s}.to_json
+
+      response = http.request(request)
+
+      if response.code.to_i == 200
+        data = JSON.parse(response.body)
+        
+        Prices.new(
+          market_period_end: current_period_end,
+          static_import_cents_per_kwh: per_kwh(data, "E1"),
+          controlled_load_cents_per_kwh: per_kwh(data, "E2"),
+          export_cents_per_kwh: per_kwh(data, "B1")
+        )
+      else
+        raise "Error fetching prices: #{response.inspect}"
+      end
+    end
+
+    private
+
+    def current_period_end
+      tz = TZInfo::Timezone.get('Australia/Brisbane')
+      market_time = tz.now
+      if market_time.min >= 0 and market_time.min <= 30
+        market_period_end = tz.local_time(market_time.year, market_time.month, market_time.day, market_time.hour, 30)
+      else
+        market_period_end = tz.local_time(market_time.year, market_time.month, market_time.day, market_time.hour+1)
+      end
+    end
+
+    def per_kwh(data, type)
+      total_fixed_kwh_price = BigDecimal(data.fetch("data", {}).fetch("staticPrices", {}).fetch(type, {}).fetch("totalfixedKWHPrice", "0"))
+      loss_factor = BigDecimal(data.fetch("data", {}).fetch("staticPrices", {}).fetch("E1", {}).fetch("lossFactor", "0"))
+      market_period_end_iso8601 = current_period_end.strftime("%Y-%m-%dT%H:%M:%S")
+      
+      current_actual = data.fetch("data", {}).fetch("variablePricesAndRenewables", []).select { |row|
+        row["periodType"] == "ACTUAL"
+      }.select { |row|
+        row["period"] == market_period_end_iso8601 
+      }.first
+
+      if current_actual
+        (total_fixed_kwh_price + (loss_factor * BigDecimal(current_actual.fetch("wholesaleKWHPrice", "0")))).round(3)
+      end
+    end
+  end
+  class Prices
+
+    attr_reader :market_period_end
+    attr_reader :static_import_cents_per_kwh, :controlled_load_cents_per_kwh, :export_cents_per_kwh
+
+    def initialize(market_period_end:, static_import_cents_per_kwh: , controlled_load_cents_per_kwh: , export_cents_per_kwh: )
+      @market_period_end = market_period_end
+      @static_import_cents_per_kwh = static_import_cents_per_kwh
+      @controlled_load_cents_per_kwh = controlled_load_cents_per_kwh
+      @export_cents_per_kwh = export_cents_per_kwh
+    end
+
+    def self.for(postcode: )
+      AmberElectric::Client.prices_for(postcode: postcode)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: amber_electric
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Healy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: an API client for Amber Electric (https://amberelectric.com.au)
+email:
+- james@yob.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.md
+- lib/amber_electric.rb
+homepage: http://github.com/yob/amber_electric
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: an API client for Amber Electric (https://amberelectric.com.au)
+test_files: []