genability 0.1.0

data/spec/client/season_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Genability::Client do
+
+  Genability::Configuration::VALID_FORMATS.each do |format|
+
+    context ".new(:format => '#{format}')" do
+
+      before(:all) do
+        @options = {:format => format}.merge(configuration_defaults)
+        @client = Genability::Client.new(@options)
+      end
+
+      context ".seasons" do
+
+        use_vcr_cassette "seasons"
+
+        it "should return a list of season groups" do
+          seasons = @client.seasons(734)
+          seasons.should be_an Array
+          seasons.first.seasons.count.should == 2
+        end
+
+      end
+
+    end
+
+  end
+end
+

data/spec/client/tariff_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Genability::Client do
+
+  Genability::Configuration::VALID_FORMATS.each do |format|
+
+    context ".new(:format => '#{format}')" do
+
+      before(:all) do
+        @options = {:format => format}.merge(configuration_defaults)
+        @client = Genability::Client.new(@options)
+      end
+
+      context ".tariffs" do
+
+        use_vcr_cassette "tariffs"
+
+        it "should return an array of tariffs" do
+          tariffs = @client.tariffs
+          tariffs.should be_an Array
+          tariffs.first.tariff_id.should == 79
+        end
+
+        it "should accept a string for customerClasses and tariffTypes parameters" do
+          @client.tariffs(:customer_classes => 'residential').each do |tariff|
+            tariff.customer_class.should =~ /RESIDENTIAL/
+          end
+        end
+
+        it "should accept an array for customerClasses and tariffTypes parameters" do
+          @client.tariffs(:tariff_types => ['default', 'alternative']).each do |tariff|
+            tariff.tariff_type.should =~ /(DEFAULT)|(ALTERNATIVE)/
+          end
+        end
+
+      end
+
+      context ".tariff" do
+
+        use_vcr_cassette "tariff"
+
+        it "should return a tariff" do
+          @client.tariff(512).tariff_id.should == 512
+        end
+
+      end
+
+    end
+
+  end
+end
+

data/spec/client/territory_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Genability::Client do
+
+  Genability::Configuration::VALID_FORMATS.each do |format|
+
+    context ".new(:format => '#{format}')" do
+
+      before(:all) do
+        @options = {:format => format}.merge(configuration_defaults)
+        @client = Genability::Client.new(@options)
+      end
+
+      context ".territories" do
+
+        use_vcr_cassette "territories"
+
+        it "should return an array of territories" do
+          territories = @client.territories(:lse_id => 734)
+          territories.should be_an Array
+          territories.first.territory_id.should == 807
+        end
+
+      end
+
+      context ".territory" do
+
+        use_vcr_cassette "territory"
+
+        it "should return a territory" do
+          @client.territory(3539).lse_id.should == 734
+        end
+
+      end
+
+    end
+
+  end
+end
+

data/spec/client/time_of_use_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Genability::Client do
+
+  Genability::Configuration::VALID_FORMATS.each do |format|
+
+    context ".new(:format => '#{format}')" do
+
+      before(:all) do
+        @options = {:format => format}.merge(configuration_defaults)
+        @client = Genability::Client.new(@options)
+      end
+
+      context ".time_of_uses" do
+
+        use_vcr_cassette "time_of_uses"
+
+        it "should return an the time of uses for a given LSE and touGroupId" do
+          time_of_uses = @client.time_of_uses(2756, 1)
+          time_of_uses.should be_an Hashie::Mash
+          time_of_uses.time_of_uses.count.should == 2
+        end
+
+      end
+
+      context ".time_of_use" do
+
+        use_vcr_cassette "time_of_use"
+
+        it "should return a territory" do
+          intervals = @client.time_of_use_intervals(2756, 1)
+          intervals.should be_an Array
+          intervals.first.tou_group_id.should == 1
+        end
+
+      end
+
+    end
+
+  end
+end
+

data/spec/client/zip_code_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Genability::Client do
+
+  Genability::Configuration::VALID_FORMATS.each do |format|
+
+    context ".new(:format => '#{format}')" do
+
+      before(:all) do
+        @options = {:format => format}.merge(configuration_defaults)
+        @client = Genability::Client.new(@options)
+      end
+
+      context ".zipcode" do
+
+        use_vcr_cassette "zipcode"
+
+        it "should return details for a given zipcode" do
+          zipcode = @client.zipcode('48322')
+          zipcode.should be_an Hashie::Mash
+          zipcode.city.should == "WEST BLOOMFIELD"
+        end
+
+      end
+
+    end
+
+  end
+end
+

data/spec/configuration.yml.sample

@@ -0,0 +1,3 @@
+application_id: ValidAppID
+application_key: ValidAppKey
+

data/spec/faraday/response_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Faraday::Response do
+
+  before do
+    @client = Genability::Client.new({:application_id => 'ValidAppID', :application_key => 'ValidAppKey'})
+  end
+
+  {
+    400 => Genability::BadRequest,
+    403 => Genability::Forbidden,
+    404 => Genability::NotFound,
+    500 => Genability::ServerError,
+    503 => Genability::ServiceUnavailable
+  }.each do |status, exception|
+    context "when HTTP status is #{status}" do
+
+      before do
+        stub_get('lses.json?appId=ValidAppID&appKey=ValidAppKey').
+          to_return(:status => status)
+      end
+
+      it "should raise #{exception.name} error" do
+        lambda do
+          @client.load_serving_entities()
+        end.should raise_error(exception)
+      end
+    end
+  end
+end
+

data/spec/genability_spec.rb

@@ -0,0 +1,138 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Genability" do
+
+  context "default values" do
+    it { Genability::Configuration::DEFAULT_ADAPTER.should == :net_http }
+    it { Genability::Configuration::DEFAULT_APPLICATION_ID.should be_nil }
+    it { Genability::Configuration::DEFAULT_APPLICATION_KEY.should be_nil }
+    it { Genability::Configuration::DEFAULT_ENDPOINT.should == 'http://api.genability.com/rest/public/' }
+    it { Genability::Configuration::DEFAULT_FORMAT.should == :json }
+    it { Genability::Configuration::DEFAULT_USER_AGENT.should == 'Genability API Ruby Gem' }
+    it { Genability::Configuration::DEFAULT_PROXY.should be_nil }
+  end
+
+  context ".client" do
+    it "should be a Genability::Client" do
+      Genability.client.should be_a Genability::Client
+    end
+  end
+
+  context ".adapter" do
+    it "should return the default adapter" do
+       Genability.adapter.should == Genability::Configuration::DEFAULT_ADAPTER
+    end
+  end
+
+  context ".adapter=" do
+    it "should set the adapter" do
+      Genability.adapter = :typhoeus
+      Genability.adapter.should == :typhoeus
+    end
+  end
+
+  context ".application_id" do
+    it "should return the default application id" do
+      Genability.application_id.should == Genability::Configuration::DEFAULT_APPLICATION_ID
+    end
+  end
+
+  context ".application_id=" do
+    it "should set the application id" do
+      Genability.application_id = '1234'
+      Genability.application_id.should == '1234'
+    end
+  end
+
+  context ".application_key" do
+    it "should return the default application key" do
+      Genability.application_key.should == Genability::Configuration::DEFAULT_APPLICATION_KEY
+    end
+  end
+
+  context ".application_key=" do
+    it "should set the application key" do
+      Genability.application_key = '5678'
+      Genability.application_key.should == '5678'
+    end
+  end
+
+  context ".endpoint" do
+    it "should return the default endpoint" do
+      Genability.endpoint.should == Genability::Configuration::DEFAULT_ENDPOINT
+    end
+  end
+
+  context ".endpoint=" do
+    it "should set the endpoint" do
+      Genability.endpoint = 'http://tumblr.com'
+      Genability.endpoint.should == 'http://tumblr.com'
+    end
+  end
+
+  context ".format" do
+    it "should return the default format" do
+      Genability.format.should == Genability::Configuration::DEFAULT_FORMAT
+    end
+  end
+
+  context ".format=" do
+    it "should set the format" do
+      Genability.format = 'xml'
+      Genability.format.should == 'xml'
+    end
+  end
+
+  context ".user_agent" do
+    it "should return the default user agent" do
+      Genability.user_agent.should == Genability::Configuration::DEFAULT_USER_AGENT
+    end
+  end
+
+  context ".user_agent=" do
+    it "should set the user_agent" do
+      Genability.user_agent = 'Custom User Agent'
+      Genability.user_agent.should == 'Custom User Agent'
+    end
+  end
+
+  context ".proxy" do
+    it "should return the default proxy" do
+      Genability.proxy.should == Genability::Configuration::DEFAULT_PROXY
+    end
+  end
+
+  context ".proxy=" do
+    it "should set the proxy" do
+      Genability.proxy = 'http://127.0.0.1'
+      Genability.proxy.should == 'http://127.0.0.1'
+    end
+  end
+
+  context ".options" do
+    it "should retreive a hash of options and their values" do
+      Genability.options.keys.should == Genability::Configuration::VALID_OPTIONS_KEYS
+    end
+  end
+
+  context ".reset" do
+    it "should restore the options to their default values" do
+      Genability.adapter = :typhoeus
+      Genability.reset
+      Genability.adapter.should == Genability::Configuration::DEFAULT_ADAPTER
+    end
+  end
+
+  context ".configure" do
+    Genability::Configuration::VALID_OPTIONS_KEYS.each do |key|
+      it "should set the #{key}" do
+        Genability.configure do |config|
+          config.send("#{key}=", key)
+          Genability.send(key).should == key
+        end
+      end
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'webmock/rspec'
+require 'genability'
+require 'vcr'
+
+CONFIGURATION_DEFAULTS = begin
+  YAML::load_file("#{File.dirname(__FILE__)}/configuration.yml").inject({}) do |options, (key, value)|
+    options[(key.to_sym rescue key) || key] = value
+    options
+  end
+rescue
+  {:application_id => 'ValidAppID', :application_key => 'ValidAppKey'}
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.extend VCR::RSpec::Macros
+end
+
+VCR.config do |c|
+  c.ignore_localhost = true
+  c.cassette_library_dir = 'spec/cassettes'
+  c.stub_with :webmock #:typhoeus, :faraday, :fakeweb, or :webmock
+  c.default_cassette_options = { :record => :new_episodes }
+  c.filter_sensitive_data('ValidAppID') { CONFIGURATION_DEFAULTS[:application_id] }
+  c.filter_sensitive_data('ValidAppKey') { CONFIGURATION_DEFAULTS[:application_key] }
+end
+
+def configuration_defaults
+  CONFIGURATION_DEFAULTS
+end
+
+def a_delete(path)
+  a_request(:delete, Genability.endpoint + path)
+end
+
+def a_get(path)
+  a_request(:get, Genability.endpoint + path)
+end
+
+def a_post(path)
+  a_request(:post, Genability.endpoint + path)
+end
+
+def a_put(path)
+  a_request(:put, Genability.endpoint + path)
+end
+
+def stub_delete(path)
+  stub_request(:delete, Genability.endpoint + path)
+end
+
+def stub_get(path)
+  stub_request(:get, Genability.endpoint + path)
+end
+
+def stub_post(path)
+  stub_request(:post, Genability.endpoint + path)
+end
+
+def stub_put(path)
+  stub_request(:put, Genability.endpoint + path)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+