genability 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.yardopts

@@ -0,0 +1,10 @@
+--no-private
+--protected
+--tag format:"Supported formats"
+--tag authenticated:"Requires Authentication"
+--tag rate_limited:"Rate Limited"
+--markup markdown
+-
+HISTORY.md
+LICENSE.md
+

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem "faraday", "~> 0.6"
+gem "faraday_middleware", "~> 0.6"
+gem "hashie", "~> 1.0.0"
+gem "multi_json", "~> 1.0.0"
+gem "chronic", "~> 0.4.0"
+
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "yard", "~> 0.7.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "simplecov", "~> 0.4"
+  gem "vcr", "~> 1.10.0"
+  gem "webmock", "~> 1.6.0"
+end
+

data/HISTORY.md

@@ -0,0 +1,7 @@
+HISTORY
+=======
+
+0.1.0 - July 1, 2011
+----------------------
+* Initial Release
+

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Matthew Solt
+
+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,79 @@
+The Genability Ruby Gem
+====================
+A Ruby wrapper for the Genability power pricing and related APIs - learn more at [https://developer.genability.com](https://developer.genability.com)
+
+Installation
+------------
+    gem install genability
+
+Documentation
+-------------
+[http://rdoc.info/gems/genability](http://rdoc.info/gems/genability)
+
+Usage Examples
+--------------
+    require "rubygems"
+    require "genability"
+
+    # Configure during client initialization
+    client = Genability::Client.new(:application_id = 'ValidAppId', :application_key => 'ValidAppKey')
+
+    # Or use the block configuration method
+    # register an app at https://developer.genability.com
+    Genability.configure do |config|
+      config.application_id = 'ValidAppId'
+      config.application_key = 'ValidAppKey'
+    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(2756, 1)
+
+    # Get information about a zipcode
+    Genability.zipcode('48322')
+
+    # 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](https://github.com/activefx/genability/blob/master/LICENSE.md) for details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "genability"
+  gem.homepage = "http://github.com/activefx/genability"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby client for the Genability API}
+  gem.description = %Q{Ruby client for the Genability power pricing and related APIs - learn more at https://developer.genability.com}
+  gem.email = "mattsolt@gmail.com"
+  gem.authors = ["Matthew Solt"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/genability.gemspec

@@ -0,0 +1,123 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{genability}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Matthew Solt}]
+  s.date = %q{2011-07-01}
+  s.description = %q{Ruby client for the Genability power pricing and related APIs - learn more at https://developer.genability.com}
+  s.email = %q{mattsolt@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.md",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".yardopts",
+    "Gemfile",
+    "HISTORY.md",
+    "LICENSE.md",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "genability.gemspec",
+    "lib/faraday/request/url_encoding_fix.rb",
+    "lib/faraday/response/raise_http_4xx.rb",
+    "lib/faraday/response/raise_http_5xx.rb",
+    "lib/genability.rb",
+    "lib/genability/api.rb",
+    "lib/genability/client.rb",
+    "lib/genability/client/helpers.rb",
+    "lib/genability/client/load_serving_entity.rb",
+    "lib/genability/client/price.rb",
+    "lib/genability/client/season.rb",
+    "lib/genability/client/tariff.rb",
+    "lib/genability/client/territory.rb",
+    "lib/genability/client/time_of_use.rb",
+    "lib/genability/client/zip_code.rb",
+    "lib/genability/configuration.rb",
+    "lib/genability/connection.rb",
+    "lib/genability/error.rb",
+    "lib/genability/request.rb",
+    "lib/mashie_extensions.rb",
+    "spec/cassettes/load_serving_entities.yml",
+    "spec/cassettes/load_serving_entity.yml",
+    "spec/cassettes/prices.yml",
+    "spec/cassettes/seasons.yml",
+    "spec/cassettes/tariff.yml",
+    "spec/cassettes/tariffs.yml",
+    "spec/cassettes/territories.yml",
+    "spec/cassettes/territory.yml",
+    "spec/cassettes/time_of_use.yml",
+    "spec/cassettes/time_of_uses.yml",
+    "spec/cassettes/zipcode.yml",
+    "spec/client/load_serving_entity_spec.rb",
+    "spec/client/price_spec.rb",
+    "spec/client/season_spec.rb",
+    "spec/client/tariff_spec.rb",
+    "spec/client/territory_spec.rb",
+    "spec/client/time_of_use_spec.rb",
+    "spec/client/zip_code_spec.rb",
+    "spec/configuration.yml.sample",
+    "spec/faraday/response_spec.rb",
+    "spec/genability_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/activefx/genability}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Ruby client for the Genability API}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<faraday>, ["~> 0.6"])
+      s.add_runtime_dependency(%q<faraday_middleware>, ["~> 0.6"])
+      s.add_runtime_dependency(%q<hashie>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<multi_json>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<chronic>, ["~> 0.4.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.4"])
+      s.add_development_dependency(%q<vcr>, ["~> 1.10.0"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.6.0"])
+    else
+      s.add_dependency(%q<faraday>, ["~> 0.6"])
+      s.add_dependency(%q<faraday_middleware>, ["~> 0.6"])
+      s.add_dependency(%q<hashie>, ["~> 1.0.0"])
+      s.add_dependency(%q<multi_json>, ["~> 1.0.0"])
+      s.add_dependency(%q<chronic>, ["~> 0.4.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<simplecov>, ["~> 0.4"])
+      s.add_dependency(%q<vcr>, ["~> 1.10.0"])
+      s.add_dependency(%q<webmock>, ["~> 1.6.0"])
+    end
+  else
+    s.add_dependency(%q<faraday>, ["~> 0.6"])
+    s.add_dependency(%q<faraday_middleware>, ["~> 0.6"])
+    s.add_dependency(%q<hashie>, ["~> 1.0.0"])
+    s.add_dependency(%q<multi_json>, ["~> 1.0.0"])
+    s.add_dependency(%q<chronic>, ["~> 0.4.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<simplecov>, ["~> 0.4"])
+    s.add_dependency(%q<vcr>, ["~> 1.10.0"])
+    s.add_dependency(%q<webmock>, ["~> 1.6.0"])
+  end
+end
+

data/lib/faraday/request/url_encoding_fix.rb

@@ -0,0 +1,19 @@
+require 'faraday'
+require 'addressable/uri'
+
+# @private
+module Faraday
+  # @private
+  class Request::UrlEncodingFix < Faraday::Middleware
+
+    def call(env)
+      url = env[:url].to_s
+      url.gsub!(/%3A/, ':')
+      env[:url] = Addressable::URI.parse(url)
+      @app.call(env)
+    end
+
+
+  end
+end
+

data/lib/faraday/response/raise_http_4xx.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp4xx < Response::Middleware
+
+    def on_complete(env)
+      case env[:status].to_i
+      when 400
+        raise Genability::BadRequest, error_message(env)
+      when 403
+        raise Genability::Forbidden, error_message(env)
+      when 404
+        raise Genability::NotFound, error_message(env)
+      end
+    end
+
+    private
+
+    def error_message(env)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s} STATUS:#{env[:status]} #{error_body(env[:body])}"
+    end
+
+    def error_body(body)
+      if body.nil?
+        nil
+      else
+        "ERRORS:#{body.count}#{error_details(body)}"
+      end
+    end
+
+    def error_details(body)
+      msg = ""
+      body.results.each_with_index do |result, i|
+        msg << " #{i+1}[code:#{result.code} object_name:#{result.objectName} property_name:#{result.propertyName} message:#{result.message}]"
+      end
+      msg
+    end
+
+
+  end
+end
+

data/lib/faraday/response/raise_http_5xx.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp5xx < Response::Middleware
+
+    def on_complete(env)
+      case env[:status].to_i
+      when 500
+        raise Genability::ServerError, error_message(env, "Something is wrong on our end. If the problem persists please file a bug report or contact support.")
+      when 503
+        raise Genability::ServiceUnavailable, error_message(env, "The Genability API is down, please try again later.")
+      end
+    end
+
+    private
+
+    def error_message(env, body=nil)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{[env[:status].to_s + ':', body].compact.join(' ')}"
+    end
+
+  end
+end
+

data/lib/genability.rb

@@ -0,0 +1,29 @@
+require 'genability/api'
+require 'genability/client'
+require 'genability/configuration'
+require 'genability/error'
+require 'mashie_extensions'
+
+module Genability
+  extend Configuration
+
+  # Alias for Genability::Client.new
+  #
+  # @return [Genability::Client]
+  def self.client(options={})
+    Genability::Client.new(options)
+  end
+
+  # Delegate to Genability::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Genability::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+
+end
+

data/lib/genability/api.rb

@@ -0,0 +1,26 @@
+require 'genability/configuration'
+require 'genability/connection'
+require 'genability/request'
+#require File.expand_path('../oauth', __FILE__)
+
+module Genability
+  # @private
+  class API
+    include Connection
+    include Request
+    #include OAuth
+
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Genability.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+  end
+end
+