owmo 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a412e9d668b31fda079d98755fc42eda2ecb0914
-  data.tar.gz: 74ae3e5e9d8069f5c8466f28ba47a271aa72032f
+  metadata.gz: 84b6f969b10f394d6c8f9c0fda1ac2dbd6929811
+  data.tar.gz: 0ebeca0df38b5d6104890759bdf756feccf3fd68
 SHA512:
-  metadata.gz: a06e37fd046e4fa840ba9b2e04e8a176ceb8db775575a3c8ad3b673321f103bf161d766202f249b60a4ad1def192a80c7073b618caa97e3d2ae9b98d836d6484
-  data.tar.gz: 7bc73c2851eb22dbfc95e7a6f2cb701774dbad74e04972fcc96b7c0bcabb2c060522c07319c68ed6f1be0ae53645aba4f19d03c6213523b25183a4df1b000978
+  metadata.gz: 10dcefd739e026f47f6e3b4adfbef8101fbfee1ecf1477b483a5d8b418eb3b04aa4c0591687ccc794446dc100514c7f98d1a8cda64faa57533ac99fbc1a1cc1d
+  data.tar.gz: 87a157f21b913e319187b28569e058cdd85401217af165ed00e031528f1d53c601c80a2c30dc6e8b8615d80235779623ba690608f5f0f0f274515800f6bb4cee

data/examples/current_box.rb

@@ -0,0 +1,7 @@
+require 'owmo'
+
+api_key = ""
+
+OWMO::weather(api_key) do |weather|
+  puts weather.get :box, bbox: [12, 32, 15, 37, 10].join(',')
+end

data/examples/current_circle.rb

@@ -0,0 +1,7 @@
+require 'owmo'
+
+api_key = ""
+
+OWMO::weather(api_key) do |weather|
+  puts weather.get :circle, lat: 55.5, lon: 37.5, cnt: 10
+end

data/examples/current_group.rb

@@ -0,0 +1,7 @@
+require 'owmo'
+
+api_key = ""
+
+OWMO::weather(api_key) do |weather|
+  puts weather.get :group, id: [4850751,4887398,2643743,4164138,5368361].join(',')
+end

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

@@ -1,15 +1,9 @@
 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
@@ -17,35 +11,32 @@ Returns the weather
         def weather
           parse_weather
           @weather
-        end # weather
+        end
 
 =begin rdoc
 Returns the response code
 =end
-        public
         def weather_code
           parse_weather
           return (@weather['cod'] || "200").to_i if @weather.is_a? Hash
           200
-        end # weather_error
+        end
 
 =begin rdoc
 Returns the response message
 =end
-        public
         def weather_message
           parse_weather
           return @weather['message'] if @weather.is_a? Hash
-          ""
-        end # weather_message
+          "None"
+        end
 
 =begin rdoc
 Returns boolean if the response contains an error or not.
 =end
-        public
         def has_error?
           weather_code != 200
-        end # has_error?
+        end
 
 =begin rdoc
 Attempts to parse the body to JSON.  This is so we don't have to continually
@@ -58,9 +49,9 @@ parse the raw JSON.
           rescue
             @weather = self.body
           end if @weather.nil?
-        end # parse_weather
+        end
 
-      end # WeatherResponse
-    end # HTTPResponse
-  end # Net
-end # CoreExtensions
+      end
+    end
+  end
+end

data/lib/owmo.rb

@@ -1,4 +1,3 @@
-require "owmo/api"
 require "owmo/version"
 require "owmo/weather"
 
@@ -18,20 +17,26 @@ 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"
+* Single request:
+  api_key = ''
+  OWMO::weather(api_key).get :current, city_name: "London,UK"
+* Muliple requests:
+  api_key = ''
+  OWMO::weather(api_key) do |weather|
+    puts weather.get :current, city_name: "London,UK"
+    puts weather.get :forecast5, city_name: "London,UK"
+    puts weather.get :forecast16, city_name: "London,UK"
   end
 =end
   public
   def self.weather(api_key, **params)
-    weather = Weather.new(api_key, params)
-
-    if block_given?
-      yield weather
-    else
-      return weather
-    end # if
-  end # weather
+    Weather.new(api_key, params) do |weather|
+      if block_given?
+        yield weather
+      else
+        return weather
+      end
+    end
+  end
 
-end # OWMO
+end

data/lib/owmo/version.rb

@@ -3,6 +3,6 @@ module OWMO
 =begin rdoc
 Gem Version
 =end
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 
-end # OWMO
+end

data/lib/owmo/weather.rb

@@ -1,9 +1,12 @@
-require 'owmo/api'
-require 'owmo/weather/exceptions'
-require 'owmo/weather/parameters'
+require 'net/http'
+require 'time'
+require 'core_extensions/net/http_response/weather_response'
 
-require 'set'
-require 'uri'
+
+=begin rdoc
+Include some weather response info into Net::HTTPResponse
+=end
+Net::HTTPResponse.include CoreExtensions::Net::HTTPResponse::WeatherResponse
 
 
 module OWMO
@@ -16,20 +19,68 @@ A weather class for retrieving current and forecasted weather conditions.
   api_key = "<My API Key>"
   weather = OWMO::Weather.new api_key: api_key
   puts weather.get :current, city_name: "London,uk"
-
 =end
   class Weather
-    include WeatherAPI
-    include WeatherExceptions
-    include WeatherParameters
 
+=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
+    end
+
+=begin rdoc
+OpenWeatherMap.Org weather API key
+=end
     attr_reader :api_key
 
-    def initialize(api_key, **kwargs) #:notnew:
+=begin rdoc
+Access current or forecasted conditions by (required):
+=end
+    Paths = {
+      current: 'weather', # Current weather data
+      group: 'group', # Current weather w/multiple IDs
+      box: 'box/city', # Current weather w/in a rectangle box
+      circle: 'find', # Current weather w/in a circle
+      forecast5: 'forecast', # 5 day / 3 hour forecast
+      forecast16: 'forecast/daily' # 16 day / daily forecast
+    }
+
+=begin rdoc
+Geocode aliases
+=end
+    Geocode_Aliases = {
+      city_name: :q,
+      city_id: :id,
+      zip_code: :zip,
+      latitude: :lat,
+      longitude: :lon
+    }
+
+=begin rdoc
+Either yeild the class, or instanciate it.
+==== Attributes
+* +api_key+ - OpenWEatherMap.Org's weather API key
+* +**kwargs+ - Any additional paramters
+=end
+    def initialize(api_key, **kwargs)
+      @debug = kwargs[:debug] || FALSE
+      log "Debug= #{@debug}"
+
       @api_key = api_key
+      log "Api Key= #{@api_key}"
 
-      yield self if block_given?
-    end # initialize
+      log "Args= #{kwargs}"
+
+      if block_given?
+        log "Yielding"
+        yield self
+        log "Yield complete."
+      end
+    end
 
 =begin rdoc
 A weather class for retrieving current and forecasted weather conditions.
@@ -43,54 +94,77 @@ A weather class for retrieving current and forecasted weather conditions.
 =end
     public
     def get(path, **query)
+      log "Starting request= #{path} -> #{query}"
+      start = Time.now
+
       # Format Geocode info
-      query = check_geocodes query
+      query = alias_geocodes(query)
 
       # Add the api key
       query[:APPID] = @api_key
 
       # Create the uri
-      raise InvalidPathSpecified.new(path) if Paths[path].nil?
-      uri = URI "#{OWMO::URL}/#{Paths[path]}?#{URI.encode_www_form(query).gsub('%2C', ',')}"
+      uri = format_uri(OWMO::URL, Paths[path], query)
 
       # Get the weather data
-      get_weather(uri)
+      weather = GET(uri)
+
+      elapsed_sec = (Time.now - start).round 5
+      log "Request completed in #{elapsed_sec} seconds."
 
-    end # get
+      weather
+    end
 
 =begin rdoc
-Ensure appropriate query options are applied to the final URI
+Aliases some geocode parameters to the correct ones, for example :city_name is
+easier to read than :q
 =end
-  def check_geocodes(**query)
+    private
+    def alias_geocodes(**query)
+      log "Query before= #{query}"
 
-    # May never be called since query is requiredcity_name
-    raise MissingGeocodes if query.size == 0
+      (query.keys & Geocode_Aliases.keys).each do |key|
+        query[Geocode_Aliases[key]] = query.delete(key)
+      end
 
-    Geocodes.each do |name, geocodes|
+      log "Query after= #{query}"
+      query
+    end
 
-      # Get the common keys
-      intersect = geocodes[:options].flatten & query.keys
-
-      # If there are common keys
-      if intersect.size > 0 then
+=begin rdoc
+Formats the url with the given url, path, and query
+=end
+    private
+    def format_uri(url, path, query)
+      uri = URI "#{url}/#{path}?#{URI.encode_www_form(query).gsub('%2C', ',')}"
+      log "URI= #{uri}"
+      uri
+    end
 
-        # 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
+=begin rdoc
+Sends the GET request to OpenWeatherMap.org
+=end
+    private
+    def GET(uri)
+      log "Starting GET request"
+      response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.request(Net::HTTP::Get.new(uri))
+      end
+      log "Request returned= #{response.weather_code}: #{response.weather_message}".gsub(/: $/, '')
 
-        return query
-      end # if
+      # Check the response
+      raise WeatherResponseError.new(response) if response.has_error?
 
-    end # GEOCODES
+      response.weather
+    end
 
-    raise MissingGeocodes
-  end # check_geocodes
+=begin rdoc
+Simple log method for debugging purposes
+=end
+    private
+    def log(msg)
+      puts "#{DateTime.now} :~> #{msg}" if @debug
+    end
 
-  end # Weather
-end # OWMO
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owmo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Robb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-20 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,9 @@ files:
 - bin/console
 - bin/setup
 - examples/current.rb
+- examples/current_box.rb
+- examples/current_circle.rb
+- examples/current_group.rb
 - examples/forecast16.rb
 - examples/forecast5.rb
 - examples/query_all.rb
@@ -77,15 +80,10 @@ files:
 - examples/query_mode.rb
 - examples/query_units.rb
 - examples/sinatra_example.rb
-- lib/core_extensions/core_extensions.rb
 - lib/core_extensions/net/http_response/weather_response.rb
 - lib/owmo.rb
-- lib/owmo/api.rb
-- lib/owmo/api/exceptions.rb
 - lib/owmo/version.rb
 - lib/owmo/weather.rb
-- lib/owmo/weather/exceptions.rb
-- lib/owmo/weather/parameters.rb
 - owmo.gemspec
 homepage: https://github.com/robb-randall/owmo
 licenses:

data/lib/core_extensions/core_extensions.rb

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

data/lib/owmo/api.rb

@@ -1,41 +0,0 @@
-require 'core_extensions/net/http_response/weather_response'
-require 'owmo/api/exceptions'
-
-require 'net/http'
-require 'uri'
-
-
-=begin rdoc
-Include some weather response info into Net::HTTPResponse
-=end
-Net::HTTPResponse.include CoreExtensions::Net::HTTPResponse::WeatherResponse
-
-
-=begin rdoc
-Net module Mixins
-=end
-module WeatherAPI
-  include ApiExceptions
-
-=begin rdoc
-Sends the GET request to OpenWeatherMap.org, and returns the response
-=end
-  private
-  def get_weather(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 WeatherResponseError.new(response) if response.has_error?
-
-    return response.weather
-
-  end # get_weather
-end # WeatherAPI

data/lib/owmo/api/exceptions.rb

@@ -1,14 +0,0 @@
-
-module ApiExceptions
-
-=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
-
-end # ApiExceptions

data/lib/owmo/weather/exceptions.rb

@@ -1,20 +0,0 @@
-
-module WeatherExceptions
-
-=begin rdoc
-Invalid path specified
-=end
-  class InvalidPathSpecified < StandardError
-    def initialize(path=nil)
-      @path = path
-      super("Invalid path specified: Got: '#{@path}', expected one of: #{Paths.keys}")
-    end # initialize
-  end # NoGeocodeSpecified
-
-=begin rdoc
-Missing Geocode from query
-=end
-  class MissingGeocodes < StandardError
-  end # MissingGeocodes
-
-end # WeatherExceptions

data/lib/owmo/weather/parameters.rb

@@ -1,51 +0,0 @@
-module WeatherParameters
-  attr_reader :Paths, :Geocodes
-
-=begin rdoc
-Access current or forecasted conditions by (required):
-* +:current+ - {Current weather data}[http://openweathermap.org/current]
-* +:forecast5+ - {5 day / 3 hour forecast}[http://openweathermap.org/forecast5]
-* +:forecast16+ - {16 day / daily forecast}[http://openweathermap.org/forecast16]
-=end
-  Paths = {
-    group: 'group', # Current weather w/multiple IDs
-    current: 'weather', # Current weather data
-    forecast5: 'forecast', # 5 day / 3 hour forecast
-    forecast16: '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]]
-    }
-  }
-
-end # WeatherParameters