OpenWeather 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04848fe1578b21c27a4254fad19d41a04a58bc38
+  data.tar.gz: 473287b838114e720b68d7cfebc976d1895aa7b7
+SHA512:
+  metadata.gz: 1f0e62dd9999d64457f0541ccac32178b74c5f4eb4fd67b8a240d89ef94182b9d2da798aba999439f2d8120bfd679eaf52aab35cb1885c5a557070debf58ae08
+  data.tar.gz: b05d78a68a6dc70cd05c608fe6793616f9cac440348f45973d8c3fedfc99a6a01cdd39e1cb01b94c08a3a0fbfddd8911a98f9302c83093ee533cd78163a1b3d5

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# RubyMine
+.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris911
+
+MIT License
+
+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/OpenWeather.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'OpenWeather/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "OpenWeather"
+  spec.version       = OpenWeather::VERSION
+  spec.authors       = ["Chris911"]
+  spec.email         = ["Christophe.naud.dulude@gmail.com"]
+  spec.description   = "Ruby wrapper for Open Weather Map - http://openweathermap.org/"
+  spec.summary       = "Ruby wrapper for Open Weather Map - http://openweathermap.org/"
+  spec.homepage      = "https://github.com/Chris911/OpenWeather"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "httparty"
+  spec.add_runtime_dependency "json"
+end

data/README.md

@@ -0,0 +1,29 @@
+# OpenWeather
+
+Ruby wrapper for Open Weather Map - http://openweathermap.org/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'OpenWeather'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install OpenWeather
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/OpenWeather.rb

@@ -0,0 +1,40 @@
+require 'httparty'
+require 'json'
+
+require "OpenWeather/version"
+require "OpenWeather/forecast"
+require "OpenWeather/weather"
+require "OpenWeather/utilities"
+require "OpenWeather/exceptions"
+require "OpenWeather/conditions"
+
+module OpenWeather
+  class Client
+    include HTTParty
+
+    [Forecast, Weather, Utilities].each do |inc|
+      include inc
+    end
+
+    attr_accessor(:units_format, :data_format)
+
+    # Open Weather Map Client
+    #
+    # @param opts [Hash] A hash of options
+    # @option opts [String] :url The Open Weather Map API URL.
+    # @option opts [String] :useragent Useragent used for the request
+    # @option opts [String] :api_key Your API key if you have one
+    def initialize( opts = {} )
+      options = {url: "http://api.openweathermap.org/data/2.5", useragent: "Open Weather Ruby v#{VERSION}"}.merge opts
+      @baseurl = options[:url]
+      @headers = {'User-Agent' => options[:useragent]}
+      # For HTTParty
+      self.class.base_uri options[:url]
+      self.class.headers @headers
+
+      @units_format = 'metric'
+      @data_format  = 'json'
+      @api_key = options[:api_key] if options[:api_key]
+    end
+  end
+end

data/lib/OpenWeather/conditions.rb

@@ -0,0 +1,11 @@
+module OpenWeather
+    CONDITIONS = {
+      200 => "Thunderstorm",
+      300 => "Drizzle",
+      500 => "Rain",
+      600 => "Snow",
+      700 => "Atmoshere",
+      800 => "Clouds",
+      900 => "Extreme"
+    }
+end

data/lib/OpenWeather/exceptions.rb

@@ -0,0 +1,7 @@
+module OpenWeather
+
+  # Thrown whenever the webserver returns anything but 200
+  #
+  class WebserverError < StandardError
+  end
+end

data/lib/OpenWeather/forecast.rb

@@ -0,0 +1,28 @@
+module OpenWeather
+  module Forecast
+    def forecast_raw(city)
+      get('/forecast', query: { q: city, units: @units_format, mode: @data_format })
+    end
+
+    def forecast_tomorrow_min(city)
+      forecast = forecast_raw(city)
+      tomorrow_list = forecast['list'].select { |weather| weather['dt_txt'].split(" ")[0] == tomorrow  }
+      tomorrow_list.min_by { |temp| temp['main']['temp_min'] }['main']['temp_min']
+    end
+
+    def forecast_tomorrow_max(city)
+      forecast = forecast_raw(city)
+      tomorrow_list = forecast['list'].select { |weather| weather['dt_txt'].split(" ")[0] == tomorrow  }
+      tomorrow_list.max_by { |temp| temp['main']['temp_max'] }['main']['temp_max']
+    end
+
+    def forecast_tomorrow_rain?(city)
+      forecast = forecast_raw(city)
+      tomorrow_list = forecast['list'].select { |weather| weather['dt_txt'].split(" ")[0] == tomorrow  }
+      # This selects any period of time during the day where the condition code is between 500 and 599 which
+      # corresponds to rainy condition. If the array is empty that means it won't rain so we return the opposite.
+      ! tomorrow_list.select { |code| Integer(code['weather'][0]['id']).between?(500, 599) }.empty?
+    end
+
+  end
+end

data/lib/OpenWeather/utilities.rb

@@ -0,0 +1,34 @@
+module OpenWeather
+  # Utility functions.
+  #
+  # @author Mostly https://github.com/paradox460/snoo
+  module Utilities
+
+    def today
+      time = Time.new
+      time.strftime("%Y-%m-%d")
+    end
+
+    def tomorrow
+      time = Time.now + (60 * 60 * 24)
+      time.strftime("%Y-%m-%d")
+    end
+
+    private
+    # HTTParty get wrapper. This serves to clean up code, as well as throw webserver errors wherever needed
+    #
+    def get *args, &block
+      response = self.class.get *args, &block
+      raise WebserverError, response.code unless response.code == 200
+      response
+    end
+
+    # HTTParty POST wrapper. This serves to clean up code, as well as throw webserver errors wherever needed
+    #
+    def post *args, &block
+      response = self.class.post *args, &block
+      raise WebserverError, response.code unless response.code == 200
+      response
+    end
+  end
+end

data/lib/OpenWeather/version.rb

@@ -0,0 +1,3 @@
+module OpenWeather
+  VERSION = "0.0.1"
+end

data/lib/OpenWeather/weather.rb

@@ -0,0 +1,17 @@
+module OpenWeather
+  module Weather
+    def weather_raw(city)
+      get('/weather', query: { q: city, units: @units_format, mode: @data_format })
+    end
+
+    def weather_min(city)
+      weather = weather_raw(city)
+      weather['main']['temp_min']
+    end
+
+    def weather_max(city)
+      weather = weather_raw(city)
+      weather['main']['temp_max']
+    end
+  end
+end

data/tests/forecast_spec.rb

@@ -0,0 +1,19 @@
+require "OpenWeather"
+require "rspec"
+
+describe "Fetch Forecast" do
+
+  it "should get proper coordinates" do
+    owc = OpenWeather::Client.new
+    forecast = owc.forecast_raw "Montreal"
+    forecast['city']['coord']['lon'].should == -73.587807
+    forecast['city']['coord']['lat'].should == 45.508839
+  end
+
+  it "min should be smaller than max" do
+    owc = OpenWeather::Client.new
+    min = owc.forecast_tomorrow_min "Montreal"
+    max = owc.forecast_tomorrow_max "Montreal"
+    min.should <= max
+  end
+end

data/tests/weather_spec.rb

@@ -0,0 +1,20 @@
+require "rspec"
+require "OpenWeather"
+require "json"
+
+describe "Fetch Weather" do
+
+  it "should get proper coordinates" do
+    owc = OpenWeather::Client.new
+    weather = owc.weather_raw "Montreal"
+    weather['coord']['lon'].should == -73.587807
+    weather['coord']['lat'].should == 45.508839
+  end
+
+  it "should return unknown city" do
+    owc = OpenWeather::Client.new
+    weather = owc.weather_raw "FakeCity123"
+    weather['message'].should == "Error: Not found city"
+    weather['cod'].should == "404"
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: OpenWeather
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris911
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Open Weather Map - http://openweathermap.org/
+email:
+- Christophe.naud.dulude@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- OpenWeather.gemspec
+- README.md
+- Rakefile
+- lib/OpenWeather.rb
+- lib/OpenWeather/conditions.rb
+- lib/OpenWeather/exceptions.rb
+- lib/OpenWeather/forecast.rb
+- lib/OpenWeather/utilities.rb
+- lib/OpenWeather/version.rb
+- lib/OpenWeather/weather.rb
+- tests/forecast_spec.rb
+- tests/weather_spec.rb
+homepage: https://github.com/Chris911/OpenWeather
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Open Weather Map - http://openweathermap.org/
+test_files: []