owmo 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76cf3aad7eed6385b91969ab9e129367ce8e7b40
-  data.tar.gz: 4604435004a67f5e01bba1c0c789b1823351bafc
+  metadata.gz: 0ce70a84df088217ce4682019a4815dcab4b1db1
+  data.tar.gz: bde9b9055267c9c7d7a623e87ea579c27fbca1d6
 SHA512:
-  metadata.gz: 6a5c8504dde37e3b907e57cfa71cec9f3e8a9c1008ba38421d90be8b4131d67de3bf478af4f79650a3d69d18079ae3355e584a584b7973892cfad72ed1980e17
-  data.tar.gz: 67ab4aa60a944b7141ba01e85b47454600c72042ac4fa4536501182fd252c36eaebeabe6b24298c46746b3793ce7c967f84a1047fd709b50d8a80c295045f599
+  metadata.gz: 6d8853935c1daa9c82f76c8b5fd9e4971db71d09f714b489207af6bed0e0ab99c96e1c5aabad7b5a370df8b50179fa4ec060cf70baefa367b56ae728604e0c51
+  data.tar.gz: df115d83e3e1307a5b9aeadc2b026480c5f7bb91d5337743e04d739c49e45c68f086f3bb25473dec0e2e5f2b8601764860e5dfd571bd0de905793c5452bc50af

data/.gitignore

@@ -15,3 +15,4 @@
 *.gem
 test.rb
 scratch.rb
+api_key.txt

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-You'll need and API key from OpenWeatherMap.org (http://openweathermap.org/appid).
+You'll need and API key from [OpenWeatherMap.org](http://openweathermap.org/appid).
 
 Compelete examples can be found under owmo/examples.
 
@@ -45,18 +45,23 @@ end
 ```
 ----
 ### Weather Information
-#### Current weather data (http://openweathermap.org/current)
+#### [Current weather data](http://openweathermap.org/current)
 ```ruby
 puts weather.get :current, city_name: "London,UK"
 ```
-#### 5 day weather forecast (http://openweathermap.org/forecast5)
+[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"
 ```
-#### 16 day weather forecast (http://openweathermap.org/forecast16)
+[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"
 ```
+[Full example](https://github.com/robb-randall/owmo/blob/master/examples/forecast16.rb)
 
 ----
 ### Query parameters
@@ -78,6 +83,7 @@ puts weather.get :current, zip_code: 90210
 # Geocode by Coordinance
 puts 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
@@ -91,6 +97,7 @@ puts weather.get :current, city_name: "London,UK", mode: :xml
 # Response in HTML format
 puts 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
@@ -103,6 +110,7 @@ puts weather.get :current, city_name: "London,UK", units: :imperial
 # Metric
 puts weather.get :current, city_name: "London,UK", units: :metric
 ```
+[Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_units.rb)
 
 #### All
 ```ruby
@@ -115,6 +123,26 @@ query = {
 
 puts weather.get :current, query
 ```
+[Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_all.rb)
+
+----
+### Wroking example using Sinatra
+
+```ruby
+require 'owmo'
+require 'sinatra' # Need to install, not included in gemspec
+require 'uri'
+
+get '/current/:name' do
+    api_key = '<API Key>'
+    weather = OWMO::Weather.new api_key
+    weather.get :current, city_name: params[:name], mode: :html
+end
+```
+
+Then navigate to: http://localhost:4567/current/London,UK
+
+[Full example](https://github.com/robb-randall/owmo/blob/master/examples/sinatra_example.rb)
 
 ----
 ## Development

data/examples/sinatra_example.rb

@@ -0,0 +1,10 @@
+require 'owmo'
+require 'sinatra' # Need to install, not included in gemspec
+require 'uri'
+
+
+get '/current/:name' do
+    api_key = '<API Key>'
+    weather = OWMO::Weather.new api_key
+    weather.get :current, city_name: params[:name], mode: :html
+end

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

@@ -39,6 +39,14 @@ Returns the response message
           ""
         end # weather_message
 
+=begin rdoc
+Returns boolean if the response contains an error or not.
+=end
+        public
+        def has_error?
+          weather_code != 200
+        end # has_error?
+
 =begin rdoc
 Attempts to parse the body to JSON.  This is so we don't have to continually
 parse the raw JSON.

data/lib/owmo.rb

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

data/lib/owmo/api.rb

@@ -1,4 +1,6 @@
 require 'core_extensions/net/http_response/weather_response'
+require 'owmo/api/exceptions'
+
 require 'net/http'
 require 'uri'
 
@@ -9,20 +11,12 @@ Include some weather response info into Net::HTTPResponse
 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
+    include ApiExceptions
 
 =begin rdoc
 Sends the GET request to OpenWeatherMap.org, and returns the response
@@ -39,7 +33,7 @@ Sends the GET request to OpenWeatherMap.org, and returns the response
       end # response
 
       # Check the response
-      raise OWMO::API::WeatherResponseError.new(response) unless response.weather_code == 200
+      raise OWMO::API::WeatherResponseError.new(response) if response.has_error?
 
       return response.weather
 

data/lib/owmo/api/exceptions.rb

@@ -0,0 +1,14 @@
+
+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/version.rb

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

data/lib/owmo/weather.rb

@@ -1,3 +1,5 @@
+require 'owmo/weather/exceptions'
+
 require 'set'
 require 'uri'
 
@@ -15,6 +17,7 @@ A weather class for retrieving current and forecasted weather conditions.
 
 =end
   class Weather
+    include WeatherExceptions
 
     attr_reader :api_key, :Paths, :Geocodes
 
@@ -64,23 +67,6 @@ Access current or forecasted conditions by (required):
       }
     }
 
-=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
-
-
     def initialize(api_key, **kwargs) #:notnew:
       @api_key = api_key
     end # initialize

data/lib/owmo/weather/exceptions.rb

@@ -0,0 +1,20 @@
+
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owmo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Robb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-18 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,12 +76,15 @@ files:
 - examples/query_geocode.rb
 - 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
 - owmo.gemspec
 homepage: https://github.com/robb-randall/owmo
 licenses: