owmo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ac6a3db29e87019c86229bcfe4d0e3b7a001080
-  data.tar.gz: 067bec01b6055748a4844d8aa380fd06b0c37324
+  metadata.gz: e14ca9d0e7400dc1e9acd4d318c1f223837eae89
+  data.tar.gz: ab5302d6ef868d2723d10a8d24d4f9a1e0b4d8be
 SHA512:
-  metadata.gz: 4f4d0980495978f29e7b4b93ffe6ea9904c82382b6e3325a88a7c401f7f971fed8148071029e1be68479515f273a5f12b6bd6b6ce514f679749dcfa9b7a825f4
-  data.tar.gz: db1d47014dd4d26e646826a1b7708a0c62542fd71d480377eac568cc4992b2bb0f7c3ba02bf3d2203d96bf2d56470e560f2d050a57d4fc70f41a0b623a1348fc
+  metadata.gz: 2f82d1d1e265163514a0b24d0f1dd5e8e318b3905375d3eef8399df26eef91c1101b72f8836065b822d05360978414586d80e886f00cb510f5e60f54baef7b5b
+  data.tar.gz: a798ccfdc3f3482c244c5e8a474ba26d6a653831d85580d6ef652f7476c2a30353af2a6324b4594cbd3417c789fe55a444ff1bbbc308a0202828a4fade0651c2

data/.gitignore

@@ -14,3 +14,4 @@
 
 *.gem
 test.rb
+scratch.rb

data/README.md

@@ -1,8 +1,8 @@
-# Owmo
+# OWMO - OpenWeatherMap.Org Client API
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/owmo`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby client for openweathermap.org client API.  Currently only for current and forecast information.
 
-TODO: Delete this and the text above, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/owmo.svg)](https://badge.fury.io/rb/owmo)
 
 ## Installation
 
@@ -24,25 +24,28 @@ Or install it yourself as:
 
 You'll need and API key from OpenWeatherMap.org (http://openweathermap.org/appid).
 
-Either instanciate the OWMO::Weather class:
+Compelete examples can be found under owmo/examples.
+
+----
+### Quick Start
+
 ```ruby
 require 'owmo'
-api_key = ""
-
+api_key = "<api key here>"
 weather = OWMO::Weather.new api_key: api_key
+puts weather.get :current, zip: 52402
 ```
 
-or through the OWMO::weather method block:
 ```ruby
 require 'owmo'
-api_key = ""
-
+api_key = "<api key here>"
 OWMO::weather api_key: api_key do |weather|
-    puts weather.get :current, city_name: "London,uk"
+    puts weather.get :forecast, zip: 52402
 end
 ```
+----
 
-**Current weather data** (http://openweathermap.org/current)
+### Current weather data (http://openweathermap.org/current)
 ```ruby
   params = {
     city_name: "London,uk", # [city_name, city_id, zip, lat/lon]
@@ -54,7 +57,7 @@ end
   puts weather.get :current, params
 
 ```
-**5 day weather forecast** (http://openweathermap.org/forecast5)
+### 5 day weather forecast (http://openweathermap.org/forecast5)
 ```ruby
   params = {
     zip: "90210", # [city_name, city_id, zip, lat/lon]
@@ -66,7 +69,7 @@ end
   puts weather.get :forecast, params
 ```
 
-**16 day weather forecast** (http://openweathermap.org/forecast16)
+### 16 day weather forecast (http://openweathermap.org/forecast16)
 ```ruby
   params = {
     lat: "40.7128", lon: "74.0059",  # [city_name, city_id, zip, lat/lon]

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-hacker

data/examples/current_conditions.rb

@@ -1,18 +1,21 @@
 require 'owmo'
 
+=begin rdoc
+An example on how to get current conditions and use the different parameters.
+=end
 api_key = ""
 
 OWMO::weather api_key: api_key do |weather|
 
   # http://openweathermap.org/current#data
-  params = {
+  query = {
     city_name: "London,uk", # [city_name, city_id, zip, lat/lon]
     mode: 'json', # [json, xml, html] Not required, but an option
     units: 'imperial', # [imperial, metric] Not required, but an option
     lang: 'en_US' # Not required, but an option
   }
 
-  current_condition = weather.get :current, params
+  current_condition = weather.get :current, query
 
   puts current_condition
 end

data/examples/extended.rb

@@ -1,18 +1,22 @@
 require 'owmo'
 
+
+=begin rdoc
+An example on how to get the weather forcast and use the different parameters.
+=end
 api_key = ""
 
 OWMO::weather api_key: api_key do |weather|
 
   # http://openweathermap.org/forecast16
-  params = {
+  query = {
     lat: "40.7128", lon: "74.0059",  # [city_name, city_id, zip, lat/lon]
     mode: 'json', # [json, xml, html] Not required, but an option
     units: 'imperial', # [imperial, metric] Not required, but an option
     lang: 'en_US' # Not required, but an option
   }
 
-  extended = weather.get :extended, params
+  extended = weather.get :extended, query
 
   puts extended
 end

data/examples/forecast.rb

@@ -1,18 +1,22 @@
 require 'owmo'
 
+
+=begin rdoc
+An example on how to get the extended forcast and use the different parameters.
+=end
 api_key = ""
 
 OWMO::weather api_key: api_key do |weather|
 
   # http://openweathermap.org/forecast5
-  params = {
+  query = {
     zip: "90210", # [city_name, city_id, zip, lat/lon]
     mode: 'json', # [json, xml, html] Not required, but an option
     units: 'imperial', # [imperial, metric] Not required, but an option
     lang: 'en_US' # Not required, but an option
   }
 
-  forecast = weather.get :forecast, params
+  forecast = weather.get :forecast, query
 
   puts forecast
 end

data/lib/core_extensions/core_extensions.rb

@@ -0,0 +1,4 @@
+require 'core_extensions/string/uri'
+
+module CoreExtensions
+end # CoreExtensions

data/lib/core_extensions/net/http_response/weather_response.rb

@@ -0,0 +1,58 @@
+require 'json'
+
+
+module CoreExtensions
+  module Net
+    module HTTPResponse
+      module WeatherResponse
+=begin rdoc
+Contains the weather data.  If it's JSON, then it'll be a hash, other forms (XML, HTML)
+will be raw format.  The raw JSON is also available using the self.body.
+=end
+        attr_reader :weather
+
+=begin rdoc
+Returns the weather
+=end
+        def weather
+          parse_weather
+          @weather
+        end # weather
+
+=begin rdoc
+Returns the response code
+=end
+        public
+        def weather_code
+          parse_weather
+          return @weather['cod'].to_i if @weather.is_a? Hash
+          200
+        end # weather_error
+
+=begin rdoc
+Returns the response message
+=end
+        public
+        def weather_message
+          parse_weather
+          return @weather['message'] if @weather.is_a? Hash
+          ""
+        end # weather_message
+
+=begin rdoc
+Attempts to parse the body to JSON.  This is so we don't have to continually
+parse the raw JSON.
+=end
+        private
+        def parse_weather
+          begin
+            @weather = JSON.parse(self.body)
+          rescue
+            @weather = self.body
+          end if @weather.nil?
+        end # parse_weather
+
+      end # WeatherResponse
+    end # HTTPResponse
+  end # Net
+end # CoreExtensions

data/lib/owmo/api.rb

@@ -0,0 +1,49 @@
+require 'core_extensions/net/http_response/weather_response'
+require 'net/http'
+require 'uri'
+
+
+=begin rdoc
+Include some weather response info into Net::HTTPResponse
+=end
+Net::HTTPResponse.include CoreExtensions::Net::HTTPResponse::WeatherResponse
+
+module OWMO
+=begin rdoc
+Net module Mixins
+=end
+  module API
+
+=begin rdoc
+Weather response error to handle errors received from OpenWeatherMap.orgs API
+=end
+    class WeatherResponseError < StandardError
+      def initialize(response)
+        @response = response
+        super("ERROR #{@response.weather_code}: #{@response.weather_message}")
+      end # initialize
+    end # WeatherResponseError
+
+=begin rdoc
+Sends the GET request to OpenWeatherMap.org, and returns the response
+=end
+    def self.get(uri)
+
+      raise "Invalid URI:  Expected URI, got #{uri.class}" unless uri.is_a? URI
+
+      # Send the request
+      request = Net::HTTP::Get.new(uri)
+
+      response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.request(request)
+      end # response
+
+      # Check the response
+      raise OWMO::API::WeatherResponseError.new(response) unless response.weather_code == 200
+
+      return response.weather
+
+    end # get
+  end # Net
+
+end # OWMO

data/lib/owmo/version.rb

@@ -1,3 +1,8 @@
-module Owmo
-  VERSION = "0.1.0"
-end
+module OWMO
+
+=begin rdoc
+Gem Version
+=end
+  VERSION = "0.2.0"
+
+end # OWMO

data/lib/owmo/weather.rb

@@ -0,0 +1,116 @@
+require 'set'
+require 'uri'
+
+
+module OWMO
+
+=begin rdoc
+A weather class for retrieving current and forecasted weather conditions.
+==== Attributes
+* +api_key+ - {OpenWeatherMap.org API key}[http://openweathermap.org/appid]
+==== Examples
+  api_key = "<My API Key>"
+  weather = OWMO::Weather.new api_key: api_key
+  puts weather.get :current, city_name: "London,uk"
+
+=end
+  class Weather
+
+=begin rdoc
+Raised when missing OpenWeatherMap.org API key
+=end
+    class MissingApiKey < StandardError
+      def initialize()
+        super("Missing OpenWeatherMap.org API key, please register for one here -> http://openweathermap.org/appid")
+      end # initialize
+    end # MissingApiKey
+
+=begin rdoc
+Invalid path specified
+=end
+    class InvalidPathSpecified < StandardError
+      def initialize(path=nil)
+        @path = path
+        super("Invalid path specified: Got: '#{@path}', expected one of: #{OWMO::PATHS.keys}")
+      end # initialize
+    end # NoGeocodeSpecified
+
+=begin rdoc
+Missing Geocode from query
+=end
+    class MissingGeocodes < StandardError
+    end # MissingGeocodes
+
+=begin rdoc
+{OpenWeatherMap.org API key}[http://openweathermap.org/appid]
+=end
+    attr_reader :api_key
+
+    def initialize(**kwargs) #:notnew:
+      raise MissingApiKey if kwargs[:api_key].nil?
+      @api_key = kwargs[:api_key]
+    end # initialize
+
+=begin rdoc
+A weather class for retrieving current and forecasted weather conditions.
+==== Attributes
+* +path+ - OWMO::PATH parameter
+* +query+ - Hash of query options (Geocode, response format, units, etc.)
+==== Examples
+  api_key = "<My API Key>"
+  weather = OWMO::Weather.new api_key: api_key
+  puts weather.get :current, city_name: "London,uk"
+=end
+    public
+    def get(path, **query)
+      # Format Geocode info
+      query = check_geocodes query
+
+      # Add the api key
+      query[:APPID] = @api_key if query[:APPID].nil?
+
+      # Create the uri
+      raise InvalidPathSpecified.new(path) if OWMO::PATHS[path].nil?
+      uri = URI "#{OWMO::URL}/#{OWMO::PATHS[path]}?#{URI.encode_www_form(query)}"
+
+      # Get the weather data
+      OWMO::API.get(uri)
+
+    end # get
+
+=begin rdoc
+Ensure appropriate query options are applied to the final URI
+=end
+  def check_geocodes(**query)
+
+    # May never be called since query is required
+    raise MissingGeocodes if query.size == 0
+
+    GEOCODES.each do |name, geocodes|
+
+      # Get the common keys
+      intersect = geocodes[:options].flatten & query.keys
+
+      # If there are common keys
+      if intersect.size > 0 then
+
+        # Remap any keys if they are not the same as the query
+        case geocodes[:query]
+        when Array then
+          intersect.zip(geocodes[:query]).each do |old_key, new_key|
+            query[new_key] = query.delete(old_key) unless new_key == old_key
+          end # intersect
+        else
+          query[geocodes[:query]] = query.delete(intersect[0]) unless geocodes[:query] == intersect[0]
+        end # case
+
+        return query
+      end # if
+
+    end # GEOCODES
+
+    raise MissingGeocodes
+  end # check_geocodes
+
+  end # Weather
+end # OWMO

data/lib/owmo.rb

@@ -1,14 +1,78 @@
+require "owmo/api"
 require "owmo/version"
-require "owmo/Weather"
+require "owmo/weather"
 
 
+=begin rdoc
+OMWO = OpenWeatherMap.org client for current and forecasted weather conditions.
+=end
 module OWMO
+
+=begin rdoc
+Openweathermap.org URL
+=end
   URL = 'http://api.openweathermap.org/data/2.5'
 
+=begin rdoc
+Access current or forecasted conditions by (required):
+* +:current+ - {Current weather data}[http://openweathermap.org/current]
+* +:forecast+ - {5 day / 3 hour forecast}[http://openweathermap.org/forecast5]
+* +:extended+ - {16 day / daily forecast}[http://openweathermap.org/forecast16]
+=end
+  PATHS = {
+    current: 'weather', # Current weather data
+    forecast: 'forecast', # 5 day / 3 hour forecast
+    extended: 'forecast/daily' # 16 day / daily forecast
+  }
+
+=begin rdoc
+{Geocode options (required):}[http://openweathermap.org/current#one]
+* +q:+ or +city_name:+ - By city name
+* +id:+ or +city_id:+ - By city ID
+* +zip:+ or +zip_code:+ - By zip code
+* +lat:+, +lon:+ or +latitude:+, +longitude:+ - By geographic coordinates
+=end
+  GEOCODES = {
+    "City Name" => {
+      query: :q,
+      options: [:q, :city_name]
+    },
+    "City ID" => {
+      query: :id,
+      options: [:id, :city_id]
+    },
+    "Zip Code" => {
+      query: :zip,
+      options: [:zip, :zip_code]
+    },
+    "Coordinance" => {
+      query: [:lat, :lon],
+      options: [[:lat, :lon], [:lattitude, :longitude]]
+    },
+    "Cities Within a Rectangle Zone" => {
+      query: :bbox,
+      options: [:bbox]
+    },
+    "Cities Within a Circle" => {
+      query: [:lat, :lon, :cnt],
+      options: [[:lat, :lon, :cnt],[:lattitude, :longitude, :cnt]]
+    }
+  }
+
+=begin rdoc
+Yield a weather object for querying weather data
+==== Attributes
+* +api_key:+ - {OpenWeatherMap.org API key}[http://openweathermap.org/appid]
+==== Examples
+  api_key = "<My API Key>"
+  OWMO::weather api_key do |weather|
+    puts weather.get :current, city_name: "London,uk"
+  end
+=end
   public
   def self.weather(**params)
     w = Weather.new params
     yield w
   end # weather
 
-end
+end # OWMO

data/owmo.gemspec

@@ -5,7 +5,7 @@ require 'owmo/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "owmo"
-  spec.version       = Owmo::VERSION
+  spec.version       = OWMO::VERSION
   spec.authors       = ["Robb"]
   spec.email         = ["robb.randall@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owmo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,14 +66,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/setup
 - examples/current_conditions.rb
 - examples/extended.rb
 - examples/forecast.rb
+- lib/core_extensions/core_extensions.rb
+- lib/core_extensions/net/http_response/weather_response.rb
 - lib/owmo.rb
-- lib/owmo/Weather.rb
+- lib/owmo/api.rb
 - lib/owmo/version.rb
+- lib/owmo/weather.rb
 - owmo.gemspec
 homepage: https://github.com/robb-randall/owmo
 licenses:

data/lib/owmo/Weather.rb

@@ -1,96 +0,0 @@
-require 'net/http'
-
-module OWMO
-  class Weather
-
-    attr_reader :url, :api_key
-
-    def initialize(**kwargs)
-      raise "Missing required api_key" if kwargs[:api_key].nil?
-      @url = kwargs[:url] || OWMO::URL
-      @api_key = kwargs[:api_key]
-    end # initialize
-
-    public
-    def get(path, **params)
-      # Parse the path
-      path = parse_path(path)
-
-      # Parse the params
-      params = parse_params(params)
-
-      # Format the URI
-      uri = build_uri(path, params)
-
-      # Get the weather data
-      get_weather(uri)
-    end # get
-
-    private
-    def parse_path(path)
-      case path
-      # Current weather data
-      when :current then 'weather'
-
-      # 5 day / 3 hour forecast
-      when :forecast then 'forecast'
-
-      # 16 day / daily forecast
-      when :extended then 'forecast/daily'
-
-      # Raise an error
-      else raise "Unknown path: '#{path}'"
-
-      end # case
-    end # path
-
-    private
-    def parse_params(**params)
-      case
-      # Search by city name
-      when params.key?(:city_name) then
-        params[:q] = params.delete :city_name
-
-      # Search by city ID
-      when params.key?(:city_id) then
-        params[:id] = params.delete :city_id
-
-      # Search by Zip
-      when params.key?(:zip) then
-
-      # Search by geo location
-      when params.key?(:lat) && params.key?(:lon) then
-
-      # Nothing is specified, raise an error
-      else raise "Missing location parameter: #{params}"
-      end # case
-
-      params
-    end # parse_params
-
-    private
-    def build_uri(path, **params)
-      URI "#{@url}/#{path}?#{format_parameters(params)}"
-    end # format_uri
-
-    private
-    def format_parameters(**params)
-      params[:APPID] = @api_key if params[:APPID].nil?
-      params.map {|k,v| "#{k}=#{v}"}.join('&')
-    end # format_params
-
-    private
-    def get_weather(uri)
-      Net::HTTP.start(uri.host, uri.port) do |http|
-        req = Net::HTTP::Get.new uri
-        resp = http.request req
-
-        # Error if the request was unsuccessful
-        raise "ERROR #{resp.code}: #{res.message} (#{res.class.name})" unless Net::HTTPSuccess
-
-        resp.body
-      end # http
-    end # get_weather
-
-  end # Weather
-end # OWMO