green-button-data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a24bc8d778aad1694ad3eb8be0bebcd066cfbd6
+  data.tar.gz: 4b4e442ebd295efc472eed20d4f0144184980739
+SHA512:
+  metadata.gz: e7e9c0506c26dddce65132206f8855bc994d3636abdf4b0c5f88ec02b947a00a40bfb971be82b05e2c587c40cf1023b883d29c5d003d20cbd1d5927ef1f9dba4
+  data.tar.gz: 75ae8319f7b1ed2969107dc13aaf2664d287c9ffb0338274342cfb6fc6b9a772f7fa41a4de724503e46d0da27db72c9f2dd1f2bd67a34dcf879809f2a2d48084

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle
+.ruby-gemset
+.ruby-version
+Gemfile.lock
+doc/
+pkg/
+rdoc/
+coverage/

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org/'
+
+gemspec
+
+group :deveopment do
+  gem 'guard-rspec', require: false
+end
+
+group :test do
+  gem 'codecov', require: false
+end

data/Guardfile

@@ -0,0 +1,50 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories %w(lib spec)
+
+## Uncomment to clear the screen before every task
+clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2015, Verdigris Technologies Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of the FreeBSD Project.

data/README.md

@@ -0,0 +1,72 @@
+# Green Button Data
+
+[![CI Results](https://img.shields.io/circleci/project/VerdigrisTech/green-button-data.svg)](https://circleci.com/gh/VerdigrisTech/green-button-data)
+[![Dependencies](https://img.shields.io/gemnasium/VerdigrisTech/green-button-data.svg)](https://gemnasium.com/VerdigrisTech/green-button-data)
+[![Code Coverage](https://img.shields.io/codecov/c/github/VerdigrisTech/green-button-data.svg)](https://codecov.io/github/VerdigrisTech/green-button-data)
+[![Code Climate](https://img.shields.io/codeclimate/github/VerdigrisTech/green-button-data.svg)](https://codeclimate.com/github/VerdigrisTech/green-button-data)
+
+Green Button Data is a Ruby gem that can quickly parse the Green Button data
+standard. It uses an event-driven <abbr title="Simple API for XML">SAX</abbr>
+parser which does not build the entire <abbr title="Document Object Model">DOM</abbr>
+in memory.
+
+## Getting Started
+
+Add the Green Button Data gem to your Gemfile:
+
+```ruby
+gem 'green-button-data'
+```
+
+Then run Bundler:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+Almost all of the functionality for parsing data is wrapped in the
+`GreenButtonData::Feed` class.
+
+To parse a Green Button Atom feed, simply call the `parse` method and pass in
+the entire XML document:
+
+```ruby
+require 'green-button-data'
+
+xml_text = File.read "#{File.dirname __FILE__}/gb_example_interval_block.xml"
+data = GreenButtonData::Feed.parse xml_text
+```
+
+You can then access the data like this:
+
+```ruby
+# Print all the interval readings from the feed
+data.entries.each do |entry|
+  p "Entry: #{entry.title}"
+  entry.content.interval_block.interval_readings.each do |reading|
+    time_period = reading.time_period
+    p "[#{time_period.starts_at} - #{time_period.ends_at}]: #{reading.value}"
+  end
+end
+```
+
+## Contributing
+
+1. Fork this project
+2. Create a feature branch: `git checkout -b my-awesome-feature`
+3. Make changes and commit: `git commit -am "Add awesome feature"`
+4. Push the branch: `git push origin my-awesome-feature`
+5. Submit a pull request
+
+## License
+
+This software is distributed AS IS WITHOUT WARRANTY under [Simplified BSD](https://raw.githubusercontent.com/VerdigrisTech/green-button-data/master/LICENSE.txt)
+license.
+
+Verdigris Technologies Inc. assumes NO RESPONSIBILITY OR LIABILITY
+UNDER ANY CIRCUMSTANCES for usage of this software. See the [LICENSE.txt](https://raw.githubusercontent.com/VerdigrisTech/green-button-data/master/LICENSE.txt)
+file for detailed legal information.
+
+Copyright © 2015, Verdigris Technologies Inc. All rights reserved.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/green-button-data.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/green-button-data/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'green-button-data'
+  s.version     = GreenButtonData::VERSION
+
+  s.authors     = ['Andrew Jo']
+  s.email       = 'engineering@verdigris.co'
+  s.homepage    = 'http://verdigris.co'
+
+  s.summary     = 'Parser for Green Button data format'
+  s.description = 'A library to parse large Green Button feed quickly'
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+
+  s.platform    = Gem::Platform::RUBY
+
+  s.add_dependency 'nokogiri', '~> 1.6'
+  s.add_dependency 'sax-machine', '~> 1.3'
+
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'guard'
+end

data/lib/green-button-data/core_ext/date.rb

@@ -0,0 +1,9 @@
+class Date
+  def utc
+    self.new_offset(0)
+  end
+
+  def local
+    new_offset(DateTime.now.offset - offset)
+  end
+end

data/lib/green-button-data/core_ext/fixnum.rb

@@ -0,0 +1,10 @@
+class Fixnum
+  def digits(base = 10)
+    num = self.abs
+    if num == 0
+      1
+    else
+      Math.log10(num).floor + 1
+    end
+  end
+end

data/lib/green-button-data/core_ext.rb

@@ -0,0 +1,2 @@
+require 'green-button-data/core_ext/date'
+require 'green-button-data/core_ext/fixnum'

data/lib/green-button-data/dst.rb

@@ -0,0 +1,49 @@
+module GreenButtonData
+  module Dst
+    # From ESPI XML schema:
+    # [extension] Bit map encoded rule from which is calculated the start or
+    # end time, within the current year, to which daylight savings time offset
+    # must be applied.
+    #
+    # The rule encoding:
+    # Bits  0 - 11: seconds 0 - 3599
+    # Bits 12 - 16: hours 0 - 23
+    # Bits 17 - 19: day of the week 0 = not applicable, 1 - 7 (Monday = 1)
+    # Bits:20 - 24: day of the month 0 = not applicable, 1 - 31
+    # Bits: 25 - 27: operator  (detailed below)
+    # Bits: 28 - 31: month 1 - 12
+    #
+    # Rule value of 0xFFFFFFFF means rule processing/DST correction is disabled.
+    #
+    # The operators:
+    #
+    # 0: DST starts/ends on the Day of the Month
+    # 1: DST starts/ends on the Day of the Week that is on or after the Day of the Month
+    # 2: DST starts/ends on the first occurrence of the Day of the Week in a month
+    # 3: DST starts/ends on the second occurrence of the Day of the Week in a month
+    # 4: DST starts/ends on the third occurrence of the Day of the Week in a month
+    # 5: DST starts/ends on the forth occurrence of the Day of the Week in a month
+    # 6: DST starts/ends on the fifth occurrence of the Day of the Week in a month
+    # 7: DST starts/ends on the last occurrence of the Day of the Week in a month
+    #
+    # An example: DST starts on third Friday in March at 1:45 AM.  The rule...
+    # Seconds: 2700
+    # Hours: 1
+    # Day of Week: 5
+    # Day of Month: 0
+    # Operator: 4
+    # Month: 3
+    BITMASK_SECOND = 0x00000fff
+    BITMASK_HOUR = 0x0001f000
+    BITMASK_DAY_OF_WEEK = 0x000e0000
+    BITMASK_DAY_OF_MONTH = 0x01f00000
+    BITMASK_DST_RULE = 0x0e000000
+    BITMASK_MONTH = 0xf0000000
+
+    BITSHIFT_HOUR = 12
+    BITSHIFT_DAY_OF_WEEK = 17
+    BITSHIFT_DAY_OF_MONTH = 20
+    BITSHIFT_DST_RULE = 25
+    BITSHIFT_MONTH = 28
+  end
+end