ruby_pvwatts 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5025823033db0fc76671192bd83c345e82e97bb8
-  data.tar.gz: 2b9db1bb8921b25ca4f555625cbc3aceaa93ef4e
+  metadata.gz: 9356566afb36fd17a971eb4903b8fdfd508ed544
+  data.tar.gz: a5f4743b17aeaa78ad1b950160ba794053cd4ee8
 SHA512:
-  metadata.gz: 99ab82a616ab970768edc5beebe1e10a7347b49b9e2867b038b59767e85be4dfebed55a503d00cea0ea0fd8616618b3f38d51b49378a0106648537aa4824df81
-  data.tar.gz: b2929e579a0a5bf18d56aaddb51a1912b43ba259fb00f88296a9162d4d296f48e0949e7a224b36ac6c704c7d35973f28a7692a2cdcd6e9556ddfba75654572bc
+  metadata.gz: efeaa1e85c7c7c53a4463e814ca8820387c1fd4221c6e82e4a5a542595f79f4152821d1ad40938adb9b7c61902088fc2162a4a8a79b49957fc8f2b997174b869
+  data.tar.gz: 99e1299c6cfa31dd8abdcfb4344ae1145d3b46bf07da91e1056955ec554afb33fec1e92b381fb01cd87f05f39d7f03fb1de74878e63324be789298fb602c1230

data/README.md

@@ -6,6 +6,23 @@ 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.
+Usage:
+
+    require 'ruby_pvwatts'
+
+    result = RubyPvWatts.new(
+      api_key: 'YOUR_API_KEY',
+      system_capacity: 5,
+      module_type: 1,
+      losses: 14,
+      array_type: 1,
+      tilt: 22,
+      azimuth: 143,
+      address: '123 Fake Street Anytown CO, 12345',
+      dataset: 'tmy3',
+      radius: 0
+    )
+
+    result.solrad_annual # => 5.63514852538037
 
 [Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)

data/lib/ruby_pvwatts.rb

@@ -64,6 +64,54 @@ class RubyPvWatts
     @response = self.class.get('/api/pvwatts/v5.json', options)
   end
 
+  def version
+    @response['version']
+  end
+
+  def errors
+    @response['errors']
+  end
+
+  def warnings
+    @response['warnings']
+  end
+
+  def city
+    @response['station_info']['city']
+  end
+
+  def lat
+    @response['station_info']['lat']
+  end
+
+  def long
+    @response['station_info']['lon']
+  end
+
+  def elev
+    @response['station_info']['elev']
+  end
+
+  def timezone
+    @response['station_info']['tz']
+  end
+
+  def location
+    @response['station_info']['location']
+  end
+
+  def state
+    @response['station_info']['state']
+  end
+
+  def solar_resource_file
+    @response['station_info']['solar_resource_file']
+  end
+
+  def meters_from_station
+    @response['station_info']['distance']
+  end
+
   def poa_monthly
     @response['outputs']['poa_monthly']
   end
@@ -131,6 +179,7 @@ class RubyPvWatts
   alias_method :hourly_ambient_temperature, :tamb
   alias_method :hourly_module_temperature, :tcell
   alias_method :hourly_windspeed, :wspd
+  alias_method :distance, :meters_from_station
 
   private
 

data/lib/ruby_pvwatts/version.rb

@@ -1,3 +1,3 @@
 class RubyPvWatts
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/spec/ruby_pvwatts_spec.rb

@@ -107,6 +107,20 @@ describe RubyPvWatts do
 
     subject { @ruby_pvwatts }
 
+    it { should respond_to :version }
+    it { should respond_to :errors }
+    it { should respond_to :warnings }
+    it { should respond_to :city }
+    it { should respond_to :state }
+    it { should respond_to :lat }
+    it { should respond_to :long }
+    it { should respond_to :elev }
+    it { should respond_to :location }
+    it { should respond_to :timezone }
+    it { should respond_to :solar_resource_file }
+    it { should respond_to :distance }
+    it { should respond_to :meters_from_station }
+
     it { should respond_to :poa_monthly }
     it { should respond_to :solrad_monthly }
     it { should respond_to :solrad_annual }
@@ -144,6 +158,14 @@ describe RubyPvWatts do
     it 'should not report hourly values' do
       expect(@ruby_pvwatts.wspd).to be_nil
     end
+
+    it 'should report the correct version' do
+      expect(@ruby_pvwatts.version).to eq('1.0.2')
+    end
+
+    it 'should have the right city' do
+      expect(@ruby_pvwatts.city).to eq('HONOLULU')
+    end
   end
 
   describe 'Invalid input' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_pvwatts
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Shad Self