green-button-data 0.1.0

data/spec/green-button-data/parser/application_information_spec.rb

@@ -0,0 +1,154 @@
+require "spec_helper"
+
+describe GreenButtonData::Parser::ApplicationInformation do
+  context "espi namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :application_information do
+      feed.parse(espi_application_information)
+          .entries
+          .first
+          .content
+          .application_information
+    end
+
+    subject { application_information }
+
+    it "should parse data custodian id" do
+      expect(subject.data_custodian_id).to eq "data_custodian"
+    end
+
+    it "should parse data custodian application status" do
+      expect(subject.data_custodian_application_status).to eq 1
+    end
+
+    it "should parse data custodian scope selection URI" do
+      expect(subject.data_custodian_scope_selection_screen_uri).to eq "https://services.greenbuttondata.org//DataCustodian/RetailCustomer/ScopeSelectionList?ThirdPartyID=third_party"
+    end
+
+    it "should parse data custodian bulk request URI" do
+      expect(subject.data_custodian_bulk_request_uri).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/Batch/Bulk"
+    end
+
+    it "should parse data custodian resource endpoint" do
+      expect(subject.data_custodian_resource_endpoint).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource"
+    end
+
+    it "should parse third party application type" do
+      expect(subject.third_party_application_type).to eq 1
+    end
+
+    it "should parse third party application use" do
+      expect(subject.third_party_application_use).to eq 1
+    end
+
+    it "should parse third party application description" do
+      expect(subject.third_party_application_description).to eq "EnergyOS OpenESPI Example Third Party"
+    end
+
+    it "should parse third party scope selection URI" do
+      expect(subject.third_party_scope_selection_screen_uri).to eq "https://services.greenbuttondata.org/ThirdParty/RetailCustomer/ScopeSelection"
+    end
+
+    it "should parse third party user portal URI" do
+      expect(subject.third_party_user_portal_screen_uri).to eq "https://services.greenbuttondata.org/ThirdParty"
+    end
+
+    it "should parse third party notify URI" do
+      expect(subject.third_party_notify_uri).to eq "https://services.greenbuttondata.org/ThirdParty/espi/1_1/Notification"
+    end
+
+    it "should parse authorization server URI" do
+      expect(subject.authorization_server_uri).to eq "https://services.greenbuttondata.org//DataCustodian/"
+    end
+
+    it "should parse authorization server's authorization endpoint" do
+      expect(subject.authorization_server_authorization_endpoint).to eq "https://services.greenbuttondata.org//DataCustodian/oauth/authorize"
+    end
+
+    it "should parse authorization server's registration endpoint" do
+      expect(subject.authorization_server_registration_endpoint).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/register"
+    end
+
+    it "should parse authorization server's token endpoint" do
+      expect(subject.authorization_server_token_endpoint).to eq "https://services.greenbuttondata.org//DataCustodian/oauth/token"
+    end
+
+    it "should parse token endpoint's authentication method" do
+      expect(subject.token_endpoint_auth_method).to eq "client_secret_basic"
+    end
+
+    it "should parse client name" do
+      expect(subject.client_name).to eq "Green Button Third Party"
+    end
+
+    it "should parse client id" do
+      expect(subject.client_id).to eq "third_party"
+    end
+
+    it "should parse client secret" do
+      expect(subject.client_secret).to eq "secret"
+    end
+
+    it "should parse date when client ID was issued" do
+      expect(subject.client_id_issued_at).to eq DateTime.new 2014, 6, 19, 15
+    end
+
+    it "should parse when client secret expires" do
+      expect(subject.client_secret_expires_at).to eq DateTime.new 9999, 12, 31, 23, 59, 59
+    end
+
+    it "should parse redirect URI" do
+      expect(subject.redirect_uri).to eq "https://services.greenbuttondata.org/ThirdParty/espi/1_1/OAuthCallBack"
+    end
+
+    it "should parse software id" do
+      expect(subject.software_id).to eq "EnergyOS OpenESPI Example Third Party"
+    end
+
+    it "should parse software version" do
+      expect(subject.software_version).to eq "1.2"
+    end
+
+    it "should parse scopes" do
+      expect(subject.scopes.size).to eq 3
+      expect(subject.scopes.first).to eq "FB=1_3_4_5_13_14_39;IntervalDuration=3600;BlockDuration=monthly;HistoryLength=13"
+      expect(subject.scopes.last).to eq "FB=1_3_4_5_6_7_8_9_10_11_29_12_13_14_15_16_17_18_19_27_28_32_33_34_35_37_38_39_40_41_44;IntervalDuration=3600;BlockDuration=monthly;HistoryLength=13"
+    end
+
+    it "should parse grant types" do
+      expect(subject.grant_types.size).to eq 3
+      expect(subject.grant_types.first).to eq "authorization_code"
+    end
+
+    it "should parse response types" do
+      expect(subject.response_types.size).to eq 1
+      expect(subject.response_types.first).to eq "token"
+    end
+
+    it "should parse registration_client_uri" do
+      expect(subject.registration_client_uri).to eq "https://services.greenbuttondata.org//DataCustodian/espi/1_1/resource/ApplicationInformation/2"
+    end
+
+    it "should parse registration_access_token" do
+      expect(subject.registration_access_token).to eq "d89bb056-0f02-4d47-9fd2-ec6a19ba8d0c"
+    end
+
+    describe "#application_status" do
+      it "should return application status as a symbol" do
+        expect(subject.application_status).to eq :review
+      end
+    end
+
+    describe "#application_type" do
+      it "should return application type as a symbol" do
+        expect(subject.application_type).to eq :web
+      end
+    end
+
+    describe "#application_use" do
+      it "should return application use as a symbol" do
+        expect(subject.application_use).to eq :energy_management
+      end
+    end
+  end
+end

data/spec/green-button-data/parser/authorization_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe GreenButtonData::Parser::Authorization do
+  context "espi namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :authorization do
+      feed.parse(espi_authorization)
+          .entries
+          .first
+          .content
+          .authorization
+    end
+
+    subject { authorization }
+
+    it "should parse authorized period" do
+      expect(subject.authorized_period.start).to eq 0
+      expect(subject.authorized_period.duration).to eq 0
+    end
+
+    it "should parse published period" do
+      expect(subject.published_period.start).to eq 0
+      expect(subject.published_period.duration).to eq 0
+    end
+
+    it "should parse expiry date" do
+      expect(subject.expires_at).to eq DateTime.new 2025, 5, 12, 19, 3, 1
+    end
+
+    it "should parse status" do
+      expect(subject.status).to eq 1
+    end
+
+    it "should parse scope" do
+      expect(subject.scope).to eq "FB=36_40"
+    end
+
+    it "should parse resource URI" do
+      expect(subject.resource_uri).to eq "https://services.greenbuttondata.org/DataCustodian/espi/1_1/resource/ApplicationInformation/2"
+    end
+
+    it "should parse authorization URI" do
+      expect(subject.authorization_uri).to eq "https://services.greenbuttondata.org/DataCustodian/espi/1_1/resource/Authorization/4"
+    end
+
+    describe "#active?" do
+      it "should return true if status is not 0" do
+        expect(subject.active?).to eq true
+      end
+    end
+  end
+end

data/spec/green-button-data/parser/interval_block_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe GreenButtonData::Parser::IntervalBlock do
+  context "espi namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :interval_block do
+      feed.parse(espi_interval_block).entries.first.content.interval_block
+    end
+
+    subject { interval_block }
+
+    it "should parse interval" do
+      expect(subject.interval).to be_an_instance_of GreenButtonData::Parser::Interval
+    end
+
+    it "should parse interval readings" do
+      expect(subject.interval_readings.size).to eq 31
+      expect(subject.interval_readings.first).to be_an_instance_of GreenButtonData::Parser::IntervalReading
+    end
+
+    describe "#duration" do
+      it "should return the duration of the current interval block" do
+        expect(subject.duration).to eq 2678400
+      end
+    end
+
+    describe "#starts_at" do
+      it "should return the start datetime" do
+        expect(subject.starts_at).to eq DateTime.new 2013, 1, 1, 5
+      end
+    end
+
+    describe "#ends_at" do
+      it "should return the end datetime" do
+        expect(subject.ends_at).to eq DateTime.new 2013, 2, 1, 5
+      end
+    end
+  end
+end

data/spec/green-button-data/parser/local_time_parameter_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe GreenButtonData::Parser::LocalTimeParameters do
+  context "espi namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :local_time_parameters do
+      feed.parse(espi_local_time_parameters)
+          .entries
+          .first
+          .content
+          .local_time_parameters
+    end
+
+    subject { local_time_parameters }
+
+    it "should parse DST start rule" do
+      expect(subject.dst_start_rule).to eq 0x360e2000
+    end
+
+    it "should parse DST end rule" do
+      expect(subject.dst_end_rule).to eq 0xb40e2000
+    end
+
+    it "should parse DST offset" do
+      expect(subject.dst_offset).to eq 3600
+    end
+
+    it "should parse timezone offset" do
+      expect(subject.tz_offset).to eq -18000
+    end
+
+    describe "#dst_starts_at" do
+      it "should return DateTime object representation of DST rule" do
+        expect(subject.dst_starts_at(2015)).to eq DateTime.new 2015, 3, 8, 2
+      end
+    end
+
+    describe "#dst_ends_at" do
+      it "should return DateTime object representation of DST rule" do
+        expect(subject.dst_ends_at(2015)).to eq DateTime.new 2015, 11, 1, 2
+      end
+    end
+
+    describe "#total_offset" do
+      it "should return total offset from DST and timezone offsets in seconds" do
+        expect(subject.total_offset).to eq -14400
+      end
+    end
+
+    describe "#total_offset_hours" do
+      it "should return total offset in hours" do
+        expect(subject.total_offset_hours).to eq -4
+      end
+    end
+  end
+end

data/spec/green-button-data/parser/reading_type_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe GreenButtonData::Parser::ReadingType do
+  context "espi namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :reading_type do
+      feed.parse(espi_reading_type).entries.first.content.reading_type
+    end
+
+    subject { reading_type }
+
+    it "should parse accumulation behavior" do
+      expect(subject.accumulation_behaviour).to eq :delta_data
+    end
+
+    it "should parse commodity" do
+      expect(subject.commodity).to eq :electricity_secondary_metered
+    end
+
+    it "should parse consumption tier" do
+      expect(subject.consumption_tier).to eq nil
+    end
+
+    it "should parse currency" do
+      expect(subject.currency).to eq :usd
+    end
+
+    it "should parse data qualifier" do
+      expect(subject.data_qualifier).to eq :normal
+    end
+
+    it "should parse flow direction" do
+      expect(subject.flow_direction).to eq :forward
+    end
+
+    it "should parse interval length" do
+      expect(subject.interval_length).to eq 300
+    end
+
+    it "should parse measurement kind" do
+      expect(subject.kind).to eq :energy
+    end
+
+    it "should parse phase" do
+      expect(subject.phase).to eq :s12_n
+    end
+
+    it "should parse power of ten multiplier" do
+      expect(subject.power_of_ten_multiplier).to eq 1
+    end
+
+    it "should parse time attribute" do
+      expect(subject.time_attribute).to eq :none
+    end
+
+    it "should parse unit of measurement" do
+      expect(subject.uom).to eq :Wh
+    end
+
+    it "should parse cpp" do
+      expect(subject.cpp).to eq nil
+    end
+
+    it "should parse interharmonic" do
+      expect(subject.interharmonic).to eq nil
+    end
+
+    it "should parse measuring period" do
+      expect(subject.measuring_period).to eq nil
+    end
+
+    it "should parse argument" do
+      expect(subject.argument).to eq nil
+    end
+  end
+end

data/spec/green-button-data/parser/usage_point_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe GreenButtonData::Parser::UsagePoint do
+  context "espi namespace" do
+    let(:feed) { GreenButtonData::Feed }
+    let :usage_point do
+      feed.parse(espi_usage_point).entries.first.content.usage_point
+    end
+
+    subject { usage_point }
+
+    it "should parse kind" do
+      expect(subject.kind).to eq 0
+    end
+
+    describe "#service_category" do
+      it "should return service category as a symbol" do
+        expect(subject.service_category).to eq :electricity
+      end
+    end
+  end
+end

data/spec/green-button-data/utilities_spec.rb

@@ -0,0 +1,63 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe GreenButtonData::Utilities do
+  before(:each) { @klass = Class.new { include GreenButtonData::Utilities } }
+
+  describe "#parse_datetime" do
+    it "should parse an ISO 8601 formatted datetime into DateTime" do
+      datetime = @klass.new.parse_datetime "2015-10-21T16:21:00.0-07:00"
+      expect(datetime.class).to eq DateTime
+      expect(datetime).to eq DateTime.new 2015, 10, 21, 23, 21, 0
+    end
+
+    it "should warn and return nil when not a valid ISO 8601 format" do
+      # Ensure datetime is an instance of Object so we can properly test for nil
+      datetime = Object.new
+      expect {
+        datetime = @klass.new.parse_datetime "Hill Valley"
+      }.to warn("Parsing failed for string: \"Hill Valley\"")
+      expect(datetime).to be_nil
+    end
+  end
+
+  describe "#normalize_epoch" do
+    it "should normalize UNIX epoch in microseconds to seconds" do
+      epoch = @klass.new.normalize_epoch 144546968100000
+      expect(epoch).to eq 1445469681
+    end
+
+    it "should normalize UNIX epoch in milliseconds to seconds" do
+      epoch = @klass.new.normalize_epoch 1445469681000
+      expect(epoch).to eq 1445469681
+    end
+
+    it "should keep UNIX epoch in seconds" do
+      epoch = @klass.new.normalize_epoch 1445469681
+      expect(epoch).to eq 1445469681
+    end
+  end
+
+  describe "#first_sunday_of" do
+    it "should return the first Sunday of a given month" do
+      date = @klass.new.first_sunday_of 2015, 10
+      expect(date.day).to eq 4
+    end
+  end
+
+  describe "#nth_weekday_of" do
+    it "should return the Nth weekday of a given month" do
+      third_wednesday = @klass.new.nth_weekday_of 2015, 10, 3, 3
+      expect(third_wednesday.day).to eq 21
+    end
+  end
+
+  describe "#last_weekday_of" do
+    it "should return the last given day of the week of a given month" do
+      last_thursday = @klass.new.last_weekday_of 2015, 10, 4
+      last_friday = @klass.new.last_weekday_of 2015, 9, 5
+
+      expect(last_thursday.day).to eq 29
+      expect(last_friday.day).to eq 25
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/green-button-data')
+require 'fixtures'
+require 'support/custom_expectations/warn_expectation'
+
+SAXMachine.handler = ENV['HANDLER'].to_sym if ENV['HANDLER']
+
+RSpec.configure do |c|
+  c.include Fixtures
+end

data/spec/support/custom_expectations/warn_expectation.rb

@@ -0,0 +1,31 @@
+RSpec::Matchers.define :warn do |message|
+  match do |block|
+    output = fake_stderr(&block)
+    output.include? message
+  end
+
+  description do
+    "write \"#{message}\" to standard error"
+  end
+
+  failure_message do
+    "expected to #{description}"
+  end
+
+  failure_message_when_negated do
+    "expected to not #{description}"
+  end
+
+  def fake_stderr
+    original_stderr = $stderr
+    $stderr = StringIO.new
+    yield
+    $stderr.string
+  ensure
+    $stderr = original_stderr
+  end
+
+  def supports_block_expectations?
+    true
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: green-button-data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Jo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: sax-machine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+description: A library to parse large Green Button feed quickly
+email: engineering@verdigris.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- green-button-data.gemspec
+- lib/green-button-data.rb
+- lib/green-button-data/core_ext.rb
+- lib/green-button-data/core_ext/date.rb
+- lib/green-button-data/core_ext/fixnum.rb
+- lib/green-button-data/dst.rb
+- lib/green-button-data/enumerations.rb
+- lib/green-button-data/feed.rb
+- lib/green-button-data/parser.rb
+- lib/green-button-data/parser/application_information.rb
+- lib/green-button-data/parser/authorization.rb
+- lib/green-button-data/parser/content.rb
+- lib/green-button-data/parser/entry.rb
+- lib/green-button-data/parser/feed.rb
+- lib/green-button-data/parser/interval.rb
+- lib/green-button-data/parser/interval_block.rb
+- lib/green-button-data/parser/interval_reading.rb
+- lib/green-button-data/parser/local_time_parameters.rb
+- lib/green-button-data/parser/rational_number.rb
+- lib/green-button-data/parser/reading_type.rb
+- lib/green-button-data/parser/service_category.rb
+- lib/green-button-data/parser/usage_point.rb
+- lib/green-button-data/utilities.rb
+- lib/green-button-data/version.rb
+- spec/fixtures.rb
+- spec/fixtures/ESPIApplicationInformation.xml
+- spec/fixtures/ESPIAuthorization.xml
+- spec/fixtures/ESPIIntervalBlock.xml
+- spec/fixtures/ESPILocalTimeParameters.xml
+- spec/fixtures/ESPIReadingType.xml
+- spec/fixtures/ESPIUsagePoint.xml
+- spec/green-button-data/core_ext/date_spec.rb
+- spec/green-button-data/core_ext/fixnum_spec.rb
+- spec/green-button-data/parser/application_information_spec.rb
+- spec/green-button-data/parser/authorization_spec.rb
+- spec/green-button-data/parser/interval_block_spec.rb
+- spec/green-button-data/parser/local_time_parameter_spec.rb
+- spec/green-button-data/parser/reading_type_spec.rb
+- spec/green-button-data/parser/usage_point_spec.rb
+- spec/green-button-data/utilities_spec.rb
+- spec/spec_helper.rb
+- spec/support/custom_expectations/warn_expectation.rb
+homepage: http://verdigris.co
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Parser for Green Button data format
+test_files: []
+has_rdoc: