cimis-ruby 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e96b1c1ccf6fb1e044e7f0c4bd64f8965e401fb
-  data.tar.gz: d7eb695328c975817dd15d6ff5199164590f88dd
+  metadata.gz: dcb7f255c2565a3cc934607b6a222b1786ede27e
+  data.tar.gz: 9f1a2af4b7d7a81bab898585952bc94ae88300c5
 SHA512:
-  metadata.gz: b8cbf4718c8bd773b1af06916911b32c2bb42d4a5d837637e5f06181ae56e33167f6104ef985a60d14ad776a7c0d515232b9d27f8c4856abd5e3701636f7edba
-  data.tar.gz: db3ffa8621aa0290dcfe6019ef5f92cfc2bda1ac81d895407d051b9f779a619ca555cbb3c56fe7c8a46028381737cb9e996c263acc527de025c85844b625fb64
+  metadata.gz: e2d5623aed0522ff6a6bac689c72c0ca6253e7f71479516c4e01d7d10a55d478e9a9f10be2ae0bce3184928afb1eb16836357dbd170d187023152de35beee69e
+  data.tar.gz: 2e8e0c2395fd609136336b688b5896d47003d7d2e4d6e167e0719cbec3fc1268f65ecec565bcad28ad19a6b8d1e9309944b6ee556c5a9b800368f8a4d96b913c

data/README.md

@@ -1,6 +1,6 @@
 # Cimis Ruby
 
-This is a slim wrapper around the Department of Water Resources CIMIS REST API. 
+This is a slim wrapper around the Department of Water Resources CIMIS REST API.
 It allows you to easily query the API and get easy to handle responses.
 
 ## Installation
@@ -22,7 +22,7 @@ Or install it yourself as:
 ## Usage
 
 ### Setup
-The first thing you need to do is setup your app key. If you haven't yet 
+The first thing you need to do is setup your app key. If you haven't yet
 registered, go to the [CIMIS website](http://wwwcimis.water.ca.gov/) and
 register. You can then go to your account page and retrieve the app key.
 
@@ -42,44 +42,50 @@ This will return an array of station objects. Each station can then be used
 to query for data from that station on the object itself:
 ```ruby
 station = Cimis::Station.all.first
-station.data({start_date: "2015-10-10", end_date: "2015-10-12"})
+station.data(start_date: "2015-10-10", end_date: "2015-10-12")
+```
+
+This will return daily stats by default, if you would instead like to get
+hourly stats, just add the hourly option:
+```ruby
+station.data(start_date: "2015-10-10", end_date: "2015-10-12", hourly: true)
 ```
 
 ### General Querying
 
 Aside from getting data for a station, you can also query the api using a
-variety of location targets (lat, lng, zip, address). See the 
+variety of location targets (lat, lng, zip, address). See the
 [CIMIS API reference](http://et.water.ca.gov/Rest/Index) for more details.
 ```ruby
-Cimis.data({
+Cimis.data(
   targets: "lat=34.99,lng=-119.34",
   start_date: "2015-10-10",
   end_date: "2015-10-12"
-})
+)
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, 
-run `rake test` to run the tests. You can also run `bin/console` for an 
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake test` to run the tests. You can also run `bin/console` for an
 interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. 
-To release a new version, update the version number in `version.rb`, and then 
-run `bundle exec rake release`, which will create a git tag for the version, 
-push git commits and tags, and push the `.gem` file to 
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at 
-https://github.com/[USERNAME]/cimis-ruby. This project is intended to be a 
-safe, welcoming space for collaboration, and contributors are expected to 
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/cimis-ruby. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
 adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License
 
-The gem is available as open source under the terms of the 
+The gem is available as open source under the terms of the
 [MIT License](http://opensource.org/licenses/MIT).
 

data/lib/cimis/station.rb

@@ -28,7 +28,7 @@ module Cimis
       response = Cimis.connection.get("station")
       response.body["Stations"].map do |station|
         new(station)
-      end 
+      end
     end
 
     def process_params(params)
@@ -36,7 +36,7 @@ module Cimis
       symbolized[:hms_latitude] = extract_coordinate(symbolized[:hms_latitude])
       symbolized[:hms_longitude] = extract_coordinate(symbolized[:hms_longitude])
       symbolized[:connect_date] = parse_date(symbolized[:connect_date])
-      symbolized[:disconnect_date] = parse_date(symbolized[:disconnect_date]) 
+      symbolized[:disconnect_date] = parse_date(symbolized[:disconnect_date])
       symbolized
     end
 
@@ -50,9 +50,29 @@ module Cimis
       DateTime.strptime(date_str, "%m/%d/%Y")
     end
 
+    def hourly_options
+      %w(
+        hly-air-tmp
+        hly-dew-pnt
+        hly-eto
+        hly-net-rad
+        hly-asce-eto
+        hly-asce-etr
+        hly-precip
+        hly-rel-hum
+        hly-res-wind
+        hly-soil-tmp
+        hly-sol-rad
+        hly-vap-pres
+        hly-wind-dir
+        hly-wind-spd
+      ).join(',')
+    end
+
     def data(options = {})
+      options.merge!(dataItems: hourly_options) if options.delete(:hourly)
       options.merge!({app_key: Cimis.app_key, targets: station_nbr})
-      response = Cimis.connection.get("data?#{Cimis.to_query(options)}") 
+      response = Cimis.connection.get("data?#{Cimis.to_query(options)}")
       response.body["Data"]["Providers"].first["Records"].map do |record|
         StationData.new(record)
       end

data/lib/cimis/station_data.rb

@@ -6,10 +6,13 @@ module Cimis
     include Virtus.model
 
     attribute :julian, Integer, default: 0
+    attribute :hour, Integer
     attribute :station, Integer, default: 0
     attribute :standard, String
     attribute :zip_codes, Array[String]
     attribute :scope, String
+
+    # Daily Data Points
     attribute :day_air_tmp_avg, Cimis::DataPoint
     attribute :day_air_tmp_max, Cimis::DataPoint
     attribute :day_air_tmp_min, Cimis::DataPoint
@@ -25,8 +28,24 @@ module Cimis
     attribute :day_wind_run, Cimis::DataPoint
     attribute :day_wind_spd_avg, Cimis::DataPoint
 
+    # Hourly Data Points
+    attribute :hly_air_tmp, Cimis::DataPoint
+    attribute :hly_dew_pnt, Cimis::DataPoint
+    attribute :hly_eto, Cimis::DataPoint
+    attribute :hly_net_rad, Cimis::DataPoint
+    attribute :hly_asce_eto, Cimis::DataPoint
+    attribute :hly_asce_etr, Cimis::DataPoint
+    attribute :hly_precip, Cimis::DataPoint
+    attribute :hly_rel_hum, Cimis::DataPoint
+    attribute :hly_res_wind, Cimis::DataPoint
+    attribute :hly_soil_temp, Cimis::DataPoint
+    attribute :hly_sol_rad, Cimis::DataPoint
+    attribute :hly_vap_pres, Cimis::DataPoint
+    attribute :hly_wind_dir, Cimis::DataPoint
+    attribute :hly_wind_spd, Cimis::DataPoint
+
     def initialize(params)
-      super(Cimis.symbolize_keys(params))    
+      super(Cimis.symbolize_keys(params))
     end
   end
 end

data/lib/cimis/version.rb

@@ -1,3 +1,3 @@
 module Cimis
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cimis-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - dphaener
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2016-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the CIMIS data API