ruby_pvwatts 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cb8e30db5df3dcdaf71aed6368e9379d3fd3442
-  data.tar.gz: cbc44c6f9c44e2365cd5a02a9b4f21aaf0cc7d45
+  metadata.gz: 784ed2168be668e37e0c0791d02901836bc31886
+  data.tar.gz: de3ee6d244ee83ed7611b4e27b401871f6bdd082
 SHA512:
-  metadata.gz: 8d5b5a78b3125306f1367e4c2a7b0a6f7e93c5dcb4a17eaad36e51b98bad427d14909bb2c89d9bcd24d3aa70aa20c9278f4dc7600438708e26efd32085f06479
-  data.tar.gz: 373542ac62e583db1534333ef1eea2551ffd3a11d8df6fa4ee7ff26d3a82de3aa896176d182f1c3e70d45b5734bd1278448739e05431fdbbc0371052510db0fa
+  metadata.gz: 9d3d074442d8ad27b2c83962a022cec50fbb9f292e122905527808a9a9903cd58ed5fdf78d8f11a295aa8d0399ab163c8931d3e2dcff68e85a8d10994635384a
+  data.tar.gz: 1b8d87c0a2def0420b439d600320b0c92c1947c7b49c773a5f2526756d769e55543755981b8a33f34d8a67b0a00029c3bd89743331cc1cb24b71a83071bbff17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Shad Self
+
+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,11 @@
+# ruby_pvwatts
+
+Provides a wrapper for NREL PVWatts v5 API. Currently only supports JSON format.
+Usage:
+You need to pass in an API Key, which is obtained from the NREL.
+Additionally, you'll need to include a hash of at least the required parameters.
+See http://developer.nrel.gov/docs/solar/pvwatts-v5/ for more information.
+
+This is a work in progress and will have multiple updates coming soon.
+
+[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)

data/Rakefile

@@ -1 +1,3 @@
-Dir.glob('tasks/**/*.rake').each(&method(:import))
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/ruby_pvwatts/version.rb

@@ -1,3 +1,3 @@
 class RubyPvWatts
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/ruby_pvwatts.rb

@@ -57,8 +57,10 @@ class RubyPvWatts
   # [:+gcr+:] Ground coverage ratio
   # [:+inv_eff+:] Inverter efficiency at rated power.
   #
-  def initialize(api_key, opts)
-    options = { query: { api_key: api_key }.merge(opts) }
+  def initialize(opts)
+    error_message = check_required_params(opts)
+    raise ArgumentError.new(error_message) if error_message
+    options = { query: opts }
     @response = self.class.get('/api/pvwatts/v5.json', options)
   end
 
@@ -83,42 +85,42 @@ class RubyPvWatts
   end
 
   def ac
-    return nil unless @response['inputs']['timeframe'] == 'hourly'
+    return nil unless hourly
     @response['outputs']['ac']
   end
 
   def poa
-    return nil unless @response['inputs']['timeframe'] == 'hourly'
+    return nil unless hourly
     @response['outputs']['poa']
   end
 
   def dn
-    return nil unless @response['inputs']['timeframe'] == 'hourly'
+    return nil unless hourly
     @response['outputs']['dn']
   end
 
   def dc
-    return nil unless @response['inputs']['timeframe'] == 'hourly'
+    return nil unless hourly
     @response['outputs']['dc']
   end
 
   def df
-    return nil unless @response['inputs']['timeframe'] == 'hourly'
+    return nil unless hourly
     @response['outputs']['df']
   end
 
   def tamb
-    return nil unless @response['inputs']['timeframe'] == 'hourly'
+    return nil unless hourly
     @response['outputs']['tamb']
   end
 
   def tcell
-    return nil unless @response['inputs']['timeframe'] == 'hourly'
+    return nil unless hourly
     @response['outputs']['tcell']
   end
 
   def wspd
-    return nil unless @response['inputs']['timeframe'] == 'hourly'
+    return nil unless hourly
     @response['outputs']['wspd']
   end
 
@@ -129,4 +131,22 @@ class RubyPvWatts
   alias_method :hourly_ambient_temperature, :tamb
   alias_method :hourly_module_temperature, :tcell
   alias_method :hourly_windspeed, :wspd
+
+  private
+
+  def check_required_params(opts)
+    missing = []
+    missing << :api_key unless opts[:api_key]
+    missing << :system_capacity unless opts[:system_capacity]
+    missing << :losses unless opts[:losses]
+    missing << :module_type unless opts[:module_type]
+    missing << :array_type unless opts[:array_type]
+    missing << :tilt unless opts[:tilt]
+    missing << :azimuth unless opts[:azimuth]
+    "Required parameters missing: #{missing.join(', ')}" unless missing.empty?
+  end
+
+  def hourly
+    @response['inputs']['timeframe'] == 'hourly'
+  end
 end

data/spec/ruby_pvwatts_spec.rb

@@ -1,11 +1,19 @@
 require 'spec_helper'
 
 describe RubyPvWatts do
-  before :each do
-    stub_request(:get, 'https://developer.nrel.gov/api/pvwatts/v5.json?address=825%20Coolidge%20Street%20Honolulu,%20HI%2096826&api_key=FAKE_API_KEY&array_type=1&azimuth=143&dataset=tmy3&losses=14&module_type=1&radius=0&system_capacity=5&tilt=22').
-      with(headers: { 'Accept' => '*/*', 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent' => 'Ruby' }).
-      to_return(
-        status: 200, body: {
+  describe 'Valid input' do
+    before :each do
+      stub_request(
+        :get,
+        'https://developer.nrel.gov/api/pvwatts/v5.json?address=123%20Fake%20Street%20Honolulu,%20HI%2096826&api_key=FAKE_API_KEY&array_type=1&azimuth=143&dataset=tmy3&losses=14&module_type=1&radius=0&system_capacity=5&tilt=22'
+      ).with(
+        headers: {
+          'Accept' => '*/*',
+          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'User-Agent' => 'Ruby' }
+      ).to_return(
+        status: 200,
+        body: {
           'inputs' => {
             'system_capacity' => '5',
             'module_type' => '1',
@@ -86,17 +94,33 @@ describe RubyPvWatts do
             'solrad_annual'   => 5.6461567878723145
           }
         }.to_json,
-        headers: {})
+        headers: {}
+      )
 
-    @ruby_pvwatts = RubyPvWatts.new('FAKE_API_KEY',
-                                    system_capacity: 5, module_type: 1,
-                                    losses: 14, array_type: 1, tilt: 22,
-                                    azimuth: 143,
-                                    address: '825 Coolidge Street Honolulu, HI 96826',
-                                    dataset: 'tmy3', radius: 0)
-  end
+      @ruby_pvwatts = RubyPvWatts.new(api_key: 'FAKE_API_KEY',
+                                      system_capacity: 5, module_type: 1,
+                                      losses: 14, array_type: 1, tilt: 22,
+                                      azimuth: 143,
+                                      address: '123 Fake Street Honolulu, HI 96826',
+                                      dataset: 'tmy3', radius: 0)
+    end
+
+    subject { @ruby_pvwatts }
+
+    it { should respond_to :poa_monthly }
+    it { should respond_to :solrad_monthly }
+    it { should respond_to :solrad_annual }
+    it { should respond_to :dc_monthly }
+    it { should respond_to :ac_monthly }
+    it { should respond_to :ac }
+    it { should respond_to :poa }
+    it { should respond_to :dn }
+    it { should respond_to :dc }
+    it { should respond_to :df }
+    it { should respond_to :tamb }
+    it { should respond_to :tcell }
+    it { should respond_to :wspd }
 
-  describe 'Methods' do
     it 'should have the correct value for poa_monthly' do
       expect(@ruby_pvwatts.poa_monthly).to eq(
         [149.582763671875, 149.54965209960938, 179.41624450683594,
@@ -116,5 +140,15 @@ describe RubyPvWatts do
     it 'should have the correct value for solrad annual' do
       expect(@ruby_pvwatts.solrad_annual).to eq(5.6461567878723145)
     end
+
+    it 'should not report hourly values' do
+      expect(@ruby_pvwatts.wspd).to be_nil
+    end
+  end
+
+  describe 'Invalid input' do
+    it 'should raise an ArgumentError' do
+      expect { RubyPvWatts.new({}) }.to raise_error(ArgumentError)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_pvwatts
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Shad Self
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -147,9 +147,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- Gemfile.lock
 - Guardfile
-- LICENSE
+- LICENSE.txt
+- README.md
 - Rakefile
 - bin/_guard-core
 - bin/guard
@@ -158,7 +158,6 @@ files:
 - ruby_pvwatts.gemspec
 - spec/ruby_pvwatts_spec.rb
 - spec/spec_helper.rb
-- tasks/rspec.rake
 homepage: http://github.com/discypher/ruby_pvwatts
 licenses:
 - MIT

data/Gemfile.lock

@@ -1,96 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ruby_pvwatts (0.0.2)
-      httparty (~> 0.13.3)
-      json (~> 1.8)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.7)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    coderay (1.1.0)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    ffi (1.9.8)
-    formatador (0.2.5)
-    guard (2.12.5)
-      formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.5.0)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    hitimes (1.2.2)
-    httparty (0.13.3)
-      json (~> 1.8)
-      multi_xml (>= 0.5.2)
-    json (1.8.2)
-    listen (2.9.0)
-      celluloid (>= 0.15.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
-    method_source (0.8.2)
-    multi_json (1.11.0)
-    multi_xml (0.5.5)
-    nenv (0.2.0)
-    notiffany (0.0.6)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.2)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    safe_yaml (1.0.4)
-    shellany (0.0.1)
-    simplecov (0.9.2)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
-    slop (3.6.0)
-    thor (0.19.1)
-    timers (4.0.1)
-      hitimes
-    webmock (1.20.4)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  guard (~> 2.12, >= 2.12.5)
-  guard-rspec (~> 4.5, >= 4.5.0)
-  rspec (~> 3.2, >= 3.2.0)
-  ruby_pvwatts!
-  simplecov (~> 0.9, >= 0.9.2)
-  webmock (~> 1.20, >= 1.20.4)

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2015 Shad Self
-
-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/tasks/rspec.rake

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