owmo 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ce70a84df088217ce4682019a4815dcab4b1db1
-  data.tar.gz: bde9b9055267c9c7d7a623e87ea579c27fbca1d6
+  metadata.gz: c4f5a0571e3deeb308b950109d1e2ce5e260e4a6
+  data.tar.gz: aaad5a9604b18c99c0f73c694f83d3ae4ad6ad0f
 SHA512:
-  metadata.gz: 6d8853935c1daa9c82f76c8b5fd9e4971db71d09f714b489207af6bed0e0ab99c96e1c5aabad7b5a370df8b50179fa4ec060cf70baefa367b56ae728604e0c51
-  data.tar.gz: df115d83e3e1307a5b9aeadc2b026480c5f7bb91d5337743e04d739c49e45c68f086f3bb25473dec0e2e5f2b8601764860e5dfd571bd0de905793c5452bc50af
+  metadata.gz: 01267656624f05395af9020be406e7d3bd2b7c09fad5f590a1194b5dfb16d373a0c5e849932945ecc5f89d5c51885fe6d037545b31c62d3684b228dd12534cb0
+  data.tar.gz: 1f35d90931232807f5635038734d117d40c5e39dccebd855b4b72481fbdd36454107186ab51e7bc7c562dcf8f72417259cf2942da055aca83eae0138be4bb3cb

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 
 You'll need and API key from [OpenWeatherMap.org](http://openweathermap.org/appid).
 
-Compelete examples can be found under owmo/examples.
+Complete examples can be found under owmo/examples.
 
 ----
 ### Quick Start
@@ -32,34 +32,32 @@ Compelete examples can be found under owmo/examples.
 ```ruby
 require 'owmo'
 api_key = "<api key here>"
-weather = OWMO::Weather.new api_key
+weather = OWMO::weather api_key
 puts weather.get :current, city_name: "London,UK"
 ```
 
 ```ruby
 require 'owmo'
 api_key = "<api key here>"
-OWMO::weather api_key do |weather|
-    puts weather.get :forecast, city_name: "London,UK"
-end
+OWMO::weather(api_key) { |weather| puts weather.get :current, city_name: "London,UK" }
 ```
 ----
 ### Weather Information
 #### [Current weather data](http://openweathermap.org/current)
 ```ruby
-puts weather.get :current, city_name: "London,UK"
+weather.get :current, city_name: "London,UK"
 ```
 [Full example](https://github.com/robb-randall/owmo/blob/master/examples/current.rb)
 
 #### [5 day weather forecast](http://openweathermap.org/forecast5)
 ```ruby
-puts weather.get :forecast5, city_name: "London,UK"
+weather.get :forecast5, city_name: "London,UK"
 ```
 [Full example](https://github.com/robb-randall/owmo/blob/master/examples/forecast5.rb)
 
 #### [16 day weather forecast](http://openweathermap.org/forecast16)
 ```ruby
-puts weather.get :forecast16, city_name: "London,UK"
+weather.get :forecast16, city_name: "London,UK"
 ```
 [Full example](https://github.com/robb-randall/owmo/blob/master/examples/forecast16.rb)
 
@@ -69,46 +67,46 @@ puts weather.get :forecast16, city_name: "London,UK"
 #### Geocode (required)
 ```ruby
 # Geocode by City ID
-puts weather.get :current, city_id: 5328041
-puts weather.get :current, id: 5328041
+weather.get :current, city_id: 5328041
+weather.get :current, id: 5328041
 
 # Geocode by City Name
-puts weather.get :current, city_name: "Beverly Hills"
-puts weather.get :current, q: "Beverly Hills"
+weather.get :current, city_name: "Beverly Hills"
+weather.get :current, q: "Beverly Hills"
 
 # Geocode by Zip Code
-puts weather.get :current, zip: 90210
-puts weather.get :current, zip_code: 90210
+weather.get :current, zip: 90210
+weather.get :current, zip_code: 90210
 
 # Geocode by Coordinance
-puts weather.get :current, lon: -118.41, lat: 34.09
+weather.get :current, lon: -118.41, lat: 34.09
 ```
 [Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_geocode.rb)
 
 #### Mode
 ```ruby
 # Response in JSON format (default)
-puts weather.get :current, city_name: "London,UK"
-puts weather.get :current, city_name: "London,UK", mode: :json
+weather.get :current, city_name: "London,UK"
+weather.get :current, city_name: "London,UK", mode: :json
 
 # Response in XML format
-puts weather.get :current, city_name: "London,UK", mode: :xml
+weather.get :current, city_name: "London,UK", mode: :xml
 
 # Response in HTML format
-puts weather.get :current, city_name: "London,UK", mode: :html
+weather.get :current, city_name: "London,UK", mode: :html
 ```
 [Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_mode.rb)
 
 #### Units
 ```ruby
 # Kelvin (default)
-puts weather.get :current, city_name: "London,UK"
+weather.get :current, city_name: "London,UK"
 
 # Imperial
-puts weather.get :current, city_name: "London,UK", units: :imperial
+weather.get :current, city_name: "London,UK", units: :imperial
 
 # Metric
-puts weather.get :current, city_name: "London,UK", units: :metric
+weather.get :current, city_name: "London,UK", units: :metric
 ```
 [Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_units.rb)
 
@@ -121,12 +119,12 @@ query = {
   lang: 'fr'
 }
 
-puts weather.get :current, query
+weather.get :current, query
 ```
 [Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_all.rb)
 
 ----
-### Wroking example using Sinatra
+### Working example using Sinatra
 
 ```ruby
 require 'owmo'
@@ -153,10 +151,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/owmo.
+Bug reports and pull requests are welcome on GitHub at https://github.com/robb-randall/owmo.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/owmo.rb

@@ -25,7 +25,13 @@ Yield a weather object for querying weather data
 =end
   public
   def self.weather(api_key, **params)
-    yield Weather.new api_key, params
+    weather = Weather.new(api_key, params)
+
+    if block_given?
+      yield weather
+    else
+      return weather
+    end
   end # weather
 
 end # OWMO

data/lib/owmo/api.rb

@@ -10,34 +10,32 @@ 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
-    include ApiExceptions
+module WeatherAPI
+  include ApiExceptions
 
 =begin rdoc
 Sends the GET request to OpenWeatherMap.org, and returns the response
 =end
-    def self.get(uri)
+  private
+  def get_weather(uri)
 
-      raise "Invalid URI:  Expected URI, got #{uri.class}" unless uri.is_a? URI
+    raise "Invalid URI:  Expected URI, got #{uri.class}" unless uri.is_a? URI
 
-      # Send the request
-      request = Net::HTTP::Get.new(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
+    response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+      http.request(request)
+    end # response
 
-      # Check the response
-      raise OWMO::API::WeatherResponseError.new(response) if response.has_error?
+    # Check the response
+    raise OWMO::API::WeatherResponseError.new(response) if response.has_error?
 
-      return response.weather
+    return response.weather
 
-    end # get
-  end # Net
-
-end # OWMO
+  end # get_weather
+end # WeatherAPI

data/lib/owmo/version.rb

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

data/lib/owmo/weather.rb

@@ -1,4 +1,6 @@
+require 'owmo/api'
 require 'owmo/weather/exceptions'
+require 'owmo/weather/parameters'
 
 require 'set'
 require 'uri'
@@ -18,57 +20,15 @@ A weather class for retrieving current and forecasted weather conditions.
 =end
   class Weather
     include WeatherExceptions
+    include WeatherParameters
+    include WeatherAPI
 
     attr_reader :api_key, :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 = {
-      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]]
-      }
-    }
-
     def initialize(api_key, **kwargs) #:notnew:
       @api_key = api_key
+
+      yield self if block_given?
     end # initialize
 
 =begin rdoc
@@ -94,7 +54,7 @@ A weather class for retrieving current and forecasted weather conditions.
       uri = URI "#{OWMO::URL}/#{Paths[path]}?#{URI.encode_www_form(query)}"
 
       # Get the weather data
-      OWMO::API.get(uri)
+      get_weather(uri)
 
     end # get
 

data/lib/owmo/weather/parameters.rb

@@ -0,0 +1,48 @@
+module WeatherParameters
+=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 = {
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owmo
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Robb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2017-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - 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: