The Genability Ruby Gem

A Ruby wrapper for the Genability power pricing and related APIs - learn more at https://developer.genability.com

Installation

gem install genability

Documentation

http://rdoc.info/gems/genability

Usage Examples

require "genability"

# Configure during client initialization
client = Genability::Client.new(:application_id = 'ValidAppId', :application_key => 'ValidAppKey')

# Or use the block configuration method
# Useful for using in a Rails initializer
# register an app at https://developer.genability.com
Genability.configure do |config|
  config.application_id   = 'ValidAppId'
  config.application_key  = 'ValidAppKey'
end

# Advanced Configuration Options
Genability.configure do |config|
  config.application_id   = 'ValidAppId'
  config.application_key  = 'ValidAppKey'
  config.adapter          = :typhoeus
  config.endpoint         = "http://api.genability.com/rest/"
  config.format           = :json
  config.user_agent       = "Genability API Ruby Gem"
  config.proxy            = "http://127.0.0.1"
end

# Get a list of load serving entities
Genability.load_serving_entities

# Get one load serving entity
Genability.load_serving_entity(2756)

# Get a list of tariffs
Genability.tariffs

# Get one tariff
Genability.tariff(512)

# Get the prices for a specified tariff
Genability.prices(520)

# Get the territories for a load serving entity
Genability.territories(:lse_id => 734)

# Get the details of one territory
Genability.territory(3539)

# Get a list of seasons for a load serving entity
Genability.seasons(734)

# Get a particular time of use group for a given load serving entity
Genability.time_of_uses(2756, 1)

# Get the intervals for the particular time of use group of a given load serving entity
Genability.time_of_use_intervals(734, 1)

# Get information about a zipcode
Genability.zipcode('48322')

# Add an account
Genability.add_account(:account_name => 'New Account')

# Show account
Genability.account("account_id")

# Get a list of accounts
Genability.accounts

# Delete account
Genability.delete_account("account_id")

# Add a usage profile
Genability.add_usage_profile(:account_id => "account_id")

# Show a usage profile
Genability.usage_profile("usage_profile_id")

# List usage profile
Genability.usage_profiles

# Add a reading(s) to a usage profile
Genability.add_readings("usage_profile_id", :readings =>
  [
    {
      :from => "2011-08-01T22:30:00.000-0700",
      :to => "2011-08-01T22:45:00.000-0700",
      :quantity_unit => "kWh",
      :quantity_value => 220
    }
  ]
)

# Calculate the cost of electricity for a given rate plan
#
# First, get the caculation metadata necessary to run the calculation
metadata = Genability.calculate_metadata(
             512,                                         # Master Tariff ID
             "Monday, September 1st, 2011",               # From DateTime
             "Monday, September 10th, 2011",              # To DateTime
             :additional_values => {                      # Metadata Options
               "connectionType" => "Primary Connection",
               "cityLimits" => "Inside"
             }
           )

# Then, run the calculation with the metadata you just received
result = Genability.calculate(
           512,                                           # Master Tariff ID
           "Monday, September 1st, 2011",                 # From DateTime
           "Monday, September 10th, 2011",                # To DateTime
           metadata,                                      # Metadata from previous call
           {}                                             # Additional options
         )
result.total_cost # => 10.837

Please see the documentation for available options and the tests for additional examples

Contributing to Genability

• Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
• Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
• Fork the project
• Start a feature/bugfix branch
• Commit and push until you are happy with your contribution
• Make sure to add documentation
• Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
• Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2011 Matthew Solt. See LICENSE for details.