climate_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a7035bbeededc35f834eb46832332689bf98a55
+  data.tar.gz: 1c501c2116c33fa9ce2e6e353dd87c643e500d64
+SHA512:
+  metadata.gz: 4c1ac4b2319970014bbcd36ed241259e5afdcbcfbd12cbee1fe0c15b85fd5235c835bf116ddd7a3258c115479132a0c718dfecdb75aeb49182cf9958da19ba22
+  data.tar.gz: 90fd583263e3b85a5519a078b0ac8566fdae2b6e2e4819bfa26df99c83ad1c1575c7a1281904b872b9ef4ab149544b8222cf60568112938af4aad63ecc0531d8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at will.lynch91@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Will Lynch
+
+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,29 @@
+# ClimateTracker
+## Installation
+Execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install climate_tracker
+
+## Usage
+
+This gem uses NOAA Climate API to retrieve the temperature data for any state in the U.S. for any defined date or range. There are two functions of the gem: Start and Compare (not case dependent).  The Start function will retreive a list of the average monthly temperature in the desired state for a given date.  This is found by averaging the average monthly temperature of every NOAA Station in the given state.  The Compare function will provide a comparision of the average change in average monthly temperatures in a state between two user defined dates. Of note, NOAA only has published through 2015 so the datasets are limited to February 1, 1831 - November 1, 2015.  The most recent available date should improve overtime and this README will be updated at each major version to correct the most recent date of that time.  This gem is also set to try and limit the number of queries from NOAA Climate API through the use of a "pull_count".  The overall average from the prior search will save allowing the user to more quickly use the Compare function.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/climate_tracker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/climate_tracker

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "climate_tracker"
+
+ClimateTracker::CLI.new.call

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "climate_tracker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/climate_tracker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'climate_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "climate_tracker"
+  spec.version       = ClimateTracker::VERSION
+  spec.authors       = ["Will Lynch"]
+  spec.email         = ["will.lynch91@gmail.com"]
+
+  spec.summary       = %q{Access average monthly temperatures through data retrieved from the NOAA Cliamte API}
+  spec.description   = %q{Allows anyone to view the average monthly temperature for any state in the US between 1831 and 2015.  It also allows users to compare the averages across date ranges and display changes over time.}
+  spec.homepage      = "https://github.com/lynch16/climate-tracker-cli-gem"
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/climate_tracker/cli.rb

@@ -0,0 +1,152 @@
+class ClimateTracker::CLI
+	attr_accessor :std_stop_date, :start_date, :start_date_temp, :stop_date, :delta_temp, :data_set
+
+	def initialize
+		current_date = DateTime.now.to_date.strftime("%F")
+		date_array = current_date.split("-")
+		date_array[0] = date_array[0].to_i-1
+		@std_stop_date = date_array.join("-") #Dataset doesn't go to 2016 so need to use 2015 as maximum year.
+		@data_set = ClimateTracker::NOAA_Data.new
+	end
+
+	def call
+		puts ""
+		puts "Welcome to the Climate Tracker - New England"
+		puts ""
+		puts ""
+		puts "This Climate Tracker displays the average monthly temperature for any date the User requests for New England."
+		puts ""
+		puts "Before we begin, a target state must be entered (this can be changed later if desired)."
+		self.pick_state
+
+		@input = ""
+		until @input == "exit" do
+
+			puts "Please type 'list' to find average temperature for your chosen state at a selected date, 'compare' to find the change in temperature between two dates, 'exit' to exit."
+
+			@input = gets.strip.downcase
+			until self.input_valid? do
+				puts "Please enter either 'list' or 'compare':"
+				@input = gets.strip.downcase
+			end
+
+			if @input == "compare"
+				self.compare
+			elsif @input == "list"
+				self.list
+			elsif @input == "exit"
+				break
+			end
+		end
+	end
+
+	def list
+		puts "This function will return the average monthly temperature for a given date in your chosen state."
+		puts ""
+		puts "Would you still like to use the target state: #{@state}? (y/n)"
+		@input = gets.strip.downcase
+		if @input == "n"
+			@data_set.re_pull = true
+			puts "Please pick a target state:"
+			self.pick_state
+		end
+
+		puts "Great. Now please pick a date (DD/MM/YYY)"
+		date = self.pick_date
+		@start_date = self.standarize_date(date)
+
+		puts "Processing..."
+		#download avg monthly temp values for date & state, find average for year.
+		temp = @data_set.pull_data(@start_date, @state).gather_values
+		puts "#{@state}'s monthly average temperature on #{@start_date} was #{temp.round(2)}°F."
+		@input = ""
+		puts "Would you like to pick a new state or compare this result to another date? (list or compare)"
+	end 
+
+	def compare
+		puts "This is the temperature comparision calculator. To begin, please answer a couple questions:"
+		puts ""
+
+		puts "Would you still like to use the target state: #{@state}? (y/n)"
+		@input = gets.strip.downcase
+		if @input == "n"
+			@data_set.re_pull = true
+			self.pick_state
+		end
+
+		if @data_set.pull_count >= 1
+			puts "Would you like to pick a new target date? Current target is #{@start_date}? (y/n)"
+			@input = gets.strip.downcase
+			if @input == "y"
+				puts "What is your target date? (DD/MM/YYY)"
+				target_date = self.pick_date
+				@start_date = self.standarize_date(target_date)
+				@data_set.re_pull = true
+			end
+		else
+			puts "What is your target date? (DD/MM/YYY)"
+			target_date = self.pick_date
+			@start_date = self.standarize_date(target_date)
+		end
+
+		puts "Would you like to set a year to compare to? If not, will use one year ago today: #{@std_stop_date}. (y/n)"
+		decide = gets.strip
+		if decide == "y" || decide == "yes"
+			puts "Please pick a date: (DD/MM/YYY)"
+			stop_date = self.pick_date
+			@stop_date = self.standarize_date(stop_date)
+		else
+			@stop_date = @std_stop_date
+		end
+
+		puts "Processing..."
+		@delta_temp = @data_set.temp_difference(@start_date, @stop_date, @state)
+
+		puts "In #{@state}, #{@stop_date} was #{@delta_temp[0]}°F #{@delta_temp[2]} than #{@start_date} (#{(@delta_temp[1]-100).round(2)}% #{@delta_temp[3]})!"
+	end
+
+	def pick_state
+		puts "Please pick your desired state. To see a list of states, type 'states':"
+		state = gets.strip.upcase
+		if state == 'STATES' || state == 'STATE'
+			puts "Gathering states..."
+			puts "#{ClimateTracker::NOAA_Data.states}"
+			puts ""
+			self.pick_state
+		elsif @data_set.class.states.include?(state)
+			puts "Accepted."
+			@state = state
+		else
+			puts "State not recognized."
+			self.pick_state
+		end
+	end
+
+	def pick_date
+		new_date = gets.strip
+		until self.date_valid?(new_date)	
+			puts "Invalid date or date format.  Please enter your target date: (DD/MM/YYY)"
+			new_date = gets.strip
+		end
+		puts "Accepted."
+		new_date
+	end
+
+	def date_valid?(date)
+		date =~ /\A\d{2}\/\d{2}\/\d{4}\z/ ? true : (return false)
+		date_array = date.split("/")
+		date_array[0].to_i > 00 && date_array[0].to_i < 31 ? true : (return false)
+		date_array[1].to_i > 00 && date_array[1].to_i < 12 ? true : (return false)
+		date_array[2].to_i > 1775 && date_array[2].to_i < 2016 ? true : (return false)
+	end
+
+	def standarize_date(date)
+		date_array = date.split("/")
+		standard_date = date_array.reverse!.join("-")
+	end
+
+	def input_valid?
+		@input == "compare" || @input == "list" || @input == "exit" ? true : false
+	end
+end
+

data/lib/climate_tracker/noaa_data.rb

@@ -0,0 +1,92 @@
+class ClimateTracker::NOAA_Data
+	attr_accessor :data_type, :data_dump, :delta_temp, :pull_count, :re_pull, :data_avg, :year1_avgs, :year2_avgs
+
+	@@states = {}
+	@@header = { "token" => "JPhvnfSrGIAesNPlFwRxKFsZTwPuYoum" }
+
+	def initialize
+		@data_type = "MNTM"
+		@pull_count = 0
+		@re_pull = true
+		#Possible Data Types
+		# > MMNT, MMXT, MNTM (Min T, Max T, and Avg T monthly)
+		# > TCPC (Total Precip) TSNW (Total snowfall)
+	end
+
+	def self.states
+		if @@states.empty?
+			#populate available states
+			uri = URI.parse("http://www.ncdc.noaa.gov/cdo-web/api/v2/locations?locationcategoryid=ST&limit=52")
+			request = Net::HTTP::Get.new(uri.request_uri, initheader = @@header)
+			http = Net::HTTP.new(uri.host, uri.port).start 
+			response = http.request(request)
+			data = JSON.parse(response.body) 
+			data["results"].collect do |result|
+				st_name = result["name"].upcase
+				st_id = result["id"]
+				@@states[st_name] = st_id
+			end
+		end
+		@@states.keys
+	end
+
+	def pull_data(date, state)
+		#NOAA program requires range of 1 year for dataset ANNUAL. Create 1 year ago range from given date
+		date_array = date.split("-")
+		date_array[0] = date_array[0].to_i-1
+		last_year_date = date_array.join("-")
+		year_date = date
+
+		#retrieve appropriate state_code and download temperatures for above range
+		if @@states.empty?
+			self.class.states
+		end
+		state_code = @@states[state]
+		uri = URI.parse("http://www.ncdc.noaa.gov/cdo-web/api/v2/data?datasetid=ANNUAL&datatypeid=#{@data_type}&locationid=#{state_code}&startdate=#{last_year_date}&enddate=#{year_date}&units=metric&limit=1000")
+		request = Net::HTTP::Get.new(uri.request_uri, initheader = @@header)
+		http = Net::HTTP.new(uri.host, uri.port).start 
+		response = http.request(request)
+		@data_dump = JSON.parse(response.body) #returns are only for the month of the years in which this were called.  (ie. startdate XXXX-02-01 will only display February) ur
+		
+		@pull_count += 1
+		@re_pull = false
+		self
+	end
+
+	def gather_values
+		total_values = 0.000
+		@data_dump["results"].each do |result| 
+			total_values += result["value"].to_f
+		end
+
+		@data_avg = (((total_values / @data_dump["results"].size)*(9.0/5.0))+32.0)
+		
+		@data_avg #float
+	end
+
+	def temp_difference(year1, year2, state)
+		if self.re_pull == true 
+			@year1_avgs = self.pull_data(year1, state).gather_values 
+		elsif @year1_avgs == nil
+			@year1_avgs = @data_avg
+		elsif @year2_avgs != @data_avg
+			@year1_avgs = @data_avg
+		end
+
+		@year2_avgs = self.pull_data(year2, state).gather_values
+		binding.pry
+		delta_temp = (@year2_avgs - @year1_avgs).round(2) 
+		delta_percent = ((@year2_avgs/@year1_avgs)*100).round(2)
+		if delta_temp > 0 #if delta_temp is positive than temp went up
+			delta_descr = "warmer"
+			delta_descr_2 = "increase"
+		else 
+			delta_descr = "colder"
+			delta_descr_2 = "decrease"
+		end
+
+		@delta_temp = [delta_temp, delta_percent, delta_descr, delta_descr_2] #hash[state] = [temp change, %, warmer/colder, increase/decrease]
+
+		@delta_temp
+	end
+end

data/lib/climate_tracker/version.rb

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

data/lib/climate_tracker.rb

@@ -0,0 +1,12 @@
+require 'pry'
+require 'open-uri'
+require 'net/http'
+require 'json'
+
+
+require "climate_tracker/version"
+require "climate_tracker/cli"
+require "climate_tracker/noaa_data.rb"
+
+module ClimateTracker
+end

data/sped.md

@@ -0,0 +1,6 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application - run cli through ./bin/climate_tracker
+- [x] Pull data from an external source - pulls data from the NOAA Climate API
+- [x] Implement both list and detail views - User can select to either display average monthly temperatures for a chosen date across the New England States (list) or make a comparision between two chosen dates to calculate the percentage change in average monthly temperatures (detail)

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: climate_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Will Lynch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: Allows anyone to view the average monthly temperature for any state in
+  the US between 1831 and 2015.  It also allows users to compare the averages across
+  date ranges and display changes over time.
+email:
+- will.lynch91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/climate_tracker
+- bin/console
+- bin/setup
+- climate_tracker.gemspec
+- lib/climate_tracker.rb
+- lib/climate_tracker/cli.rb
+- lib/climate_tracker/noaa_data.rb
+- lib/climate_tracker/version.rb
+- sped.md
+homepage: https://github.com/lynch16/climate-tracker-cli-gem
+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.8
+signing_key: 
+specification_version: 4
+summary: Access average monthly temperatures through data retrieved from the NOAA
+  Cliamte API
+test_files: []