cimis-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d654c3ea5da027d3f1d68a10d149b3bb82297086
+  data.tar.gz: 1a3898f53dd9defb65bcd9444490a0cc07746642
+SHA512:
+  metadata.gz: 0f8a7abbc7c654149023916b05aecee4b3937f3e7d7f6ac4c817b5b5bf2b700e6c91ccef8eefc41ded9d6e985068ad64807d3c4da8ee5996d3d6d27b41382d59
+  data.tar.gz: bb684643a7c775ee91162ffff8e9d95e4eb749763d94f37fd27832abceba6ef10b6d8a2b5eeefcdae50bd318933d940e89131188de5853de5c64d3073ff723ba

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cimis-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 dphaener
+
+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,85 @@
+# Cimis Ruby
+
+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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cimis-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cimis-ruby
+
+## Usage
+
+### Setup
+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.
+
+You need to configure the wrapper to use your app key:
+```ruby
+Cimis.configure { |c| c.app_key = <your_app_key> }
+```
+
+### Stations
+
+Get a list of CIMIS stations:
+```ruby
+Cimis::Station.all
+```
+
+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"})
+```
+
+### 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 
+[CIMIS API reference](http://et.water.ca.gov/Rest/Index) for more details.
+```ruby
+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 
+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 
+[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 
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the 
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cimis"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cimis-ruby.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cimis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cimis-ruby"
+  spec.version       = Cimis::VERSION
+  spec.authors       = ["dphaener"]
+  spec.email         = ["dphaener@gmail.com"]
+
+  spec.summary       = %q{A Ruby wrapper for the CIMIS data API}
+  spec.description   = %q{A Ruby wrapper for the CIMIS data API}
+  spec.homepage      = "https://github.com/EditLLC/cimis-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "shoulda-context", "~> 1.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+  
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "virtus", "~> 1.0"
+end

data/lib/cimis.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'cimis/version'
+require 'cimis/station'
+require 'cimis/station_data'
+require 'cimis/data_point'
+
+module Cimis
+  class MissingAttributeError < StandardError; end;
+
+  class << self
+    attr_accessor :app_key
+
+    def configure
+      yield self
+      raise MissingAttributeError, "You must include the app key" unless app_key
+    end
+
+    def connection
+      @connect ||= Faraday.new do |f|
+        f.adapter :net_http
+        f.url_prefix = "http://et.water.ca.gov/api"
+        f.headers["User-Agent"] = "Cimis Ruby v#{Cimis::VERSION}"
+        f.headers["Content-Type"] = "application/json"
+        f.headers["Accept"] = "*/*"
+        f.response :json, content_type: /\bjson$/
+      end
+    end
+
+    def data(options = {})
+      options.merge!({app_key: app_key})
+      response = connection.get("data?#{to_query(options)}")
+      response.body["Data"]["Providers"].first["Records"].map do |record|
+        StationData.new(record)
+      end
+    end
+
+    def to_query(params = {})
+      params.collect do |key, value|
+        "#{camel_case_lower(key.to_s)}=#{value}"
+      end.sort * "&" 
+    end
+
+    def camel_case_lower(str)
+      str.split('_').inject([]) do |buffer,e| 
+        buffer.push(buffer.empty? ? e : e.capitalize)
+      end.join
+    end
+
+    def underscore(str)
+      word = str.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+
+    def symbolize_keys(params)
+      {}.tap do |hsh|
+        params.keys.each { |k| hsh[underscore(k).to_sym] = params[k] }
+      end
+    end
+  end
+end

data/lib/cimis/data_point.rb

@@ -0,0 +1,15 @@
+require 'virtus'
+
+module Cimis
+  class DataPoint
+    include Virtus.model
+
+    attribute :value, Float
+    attribute :qc, String
+    attribute :unit, String
+
+    def initialize(params)
+      super(Cimis.symbolize_keys(params)) 
+    end
+  end
+end

data/lib/cimis/station.rb

@@ -0,0 +1,61 @@
+require 'virtus'
+
+module Cimis
+  class Station
+    include Virtus.model
+
+    attribute :station_nbr, Integer
+    attribute :name, String
+    attribute :city, String
+    attribute :regional_office, String
+    attribute :county, String
+    attribute :connect_date, DateTime
+    attribute :disconnect_date, DateTime
+    attribute :is_active, Boolean
+    attribute :is_eto_station, Boolean
+    attribute :elevation, Integer
+    attribute :ground_cover, String
+    attribute :hms_latitude, Float
+    attribute :hms_longitude, Float
+    attribute :zip_codes, Array[String]
+
+    def initialize(params)
+      processed_params = process_params(params)
+      super(processed_params)
+    end
+
+    def self.all
+      response = Cimis.connection.get("station")
+      response.body["Stations"].map do |station|
+        new(station)
+      end 
+    end
+
+    def process_params(params)
+      symbolized = Cimis.symbolize_keys(params)
+      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
+    end
+
+    def extract_coordinate(str)
+      word = str.dup
+      word = word.split("/").last
+      word.strip!
+    end
+
+    def parse_date(date_str)
+      DateTime.strptime(date_str, "%m/%d/%Y")
+    end
+
+    def data(options = {})
+      options.merge!({app_key: Cimis.app_key, targets: station_nbr})
+      response = Cimis.connection.get("data?#{Cimis.to_query(options)}") 
+      response.body["Data"]["Providers"].first["Records"].map do |record|
+        StationData.new(record)
+      end
+    end
+  end
+end

data/lib/cimis/station_data.rb

@@ -0,0 +1,32 @@
+require 'virtus'
+require 'cimis/data_point'
+
+module Cimis
+  class StationData
+    include Virtus.model
+
+    attribute :julian, Integer
+    attribute :station, Integer
+    attribute :standard, String
+    attribute :zip_codes, Array[String]
+    attribute :scope, String
+    attribute :day_air_tmp_avg, Cimis::DataPoint
+    attribute :day_air_tmp_max, Cimis::DataPoint
+    attribute :day_air_tmp_min, Cimis::DataPoint
+    attribute :day_dew_pnt, Cimis::DataPoint
+    attribute :day_asce_eto, Cimis::DataPoint
+    attribute :day_precip, Cimis::DataPoint
+    attribute :day_rel_hum_avg, Cimis::DataPoint
+    attribute :day_rel_hum_max, Cimis::DataPoint
+    attribute :day_rel_hum_min, Cimis::DataPoint
+    attribute :day_soil_tmp_avg, Cimis::DataPoint
+    attribute :day_sol_rad_avg, Cimis::DataPoint
+    attribute :day_vap_pres_avg, Cimis::DataPoint
+    attribute :day_wind_run, Cimis::DataPoint
+    attribute :day_wind_spd_avg, Cimis::DataPoint
+
+    def initialize(params)
+      super(Cimis.symbolize_keys(params))    
+    end
+  end
+end

data/lib/cimis/version.rb

@@ -0,0 +1,3 @@
+module Cimis
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: cimis-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dphaener
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Ruby wrapper for the CIMIS data API
+email:
+- dphaener@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cimis-ruby.gemspec
+- lib/cimis.rb
+- lib/cimis/data_point.rb
+- lib/cimis/station.rb
+- lib/cimis/station_data.rb
+- lib/cimis/version.rb
+homepage: https://github.com/EditLLC/cimis-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the CIMIS data API
+test_files: []