owmo 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e14ca9d0e7400dc1e9acd4d318c1f223837eae89
-  data.tar.gz: ab5302d6ef868d2723d10a8d24d4f9a1e0b4d8be
+  metadata.gz: 76cf3aad7eed6385b91969ab9e129367ce8e7b40
+  data.tar.gz: 4604435004a67f5e01bba1c0c789b1823351bafc
 SHA512:
-  metadata.gz: 2f82d1d1e265163514a0b24d0f1dd5e8e318b3905375d3eef8399df26eef91c1101b72f8836065b822d05360978414586d80e886f00cb510f5e60f54baef7b5b
-  data.tar.gz: a798ccfdc3f3482c244c5e8a474ba26d6a653831d85580d6ef652f7476c2a30353af2a6324b4594cbd3417c789fe55a444ff1bbbc308a0202828a4fade0651c2
+  metadata.gz: 6a5c8504dde37e3b907e57cfa71cec9f3e8a9c1008ba38421d90be8b4131d67de3bf478af4f79650a3d69d18079ae3355e584a584b7973892cfad72ed1980e17
+  data.tar.gz: 67ab4aa60a944b7141ba01e85b47454600c72042ac4fa4536501182fd252c36eaebeabe6b24298c46746b3793ce7c967f84a1047fd709b50d8a80c295045f599

data/Gemfile

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

data/README.md

@@ -32,55 +32,91 @@ Compelete examples can be found under owmo/examples.
 ```ruby
 require 'owmo'
 api_key = "<api key here>"
-weather = OWMO::Weather.new api_key: api_key
-puts weather.get :current, zip: 52402
+weather = OWMO::Weather.new api_key
+puts weather.get :current, city_name: "London,UK"
 ```
 
 ```ruby
 require 'owmo'
 api_key = "<api key here>"
-OWMO::weather api_key: api_key do |weather|
-    puts weather.get :forecast, zip: 52402
+OWMO::weather api_key do |weather|
+    puts weather.get :forecast, city_name: "London,UK"
 end
 ```
 ----
+### Weather Information
+#### Current weather data (http://openweathermap.org/current)
+```ruby
+puts weather.get :current, city_name: "London,UK"
+```
+#### 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)
+```ruby
+puts weather.get :forecast16, city_name: "London,UK"
+```
+
+----
+### Query parameters
+
+#### Geocode (required)
+```ruby
+# Geocode by City ID
+puts weather.get :current, city_id: 5328041
+puts weather.get :current, id: 5328041
+
+# Geocode by City Name
+puts weather.get :current, city_name: "Beverly Hills"
+puts weather.get :current, q: "Beverly Hills"
+
+# Geocode by Zip Code
+puts weather.get :current, zip: 90210
+puts weather.get :current, zip_code: 90210
+
+# Geocode by Coordinance
+puts weather.get :current, lon: -118.41, lat: 34.09
+```
 
-### Current weather data (http://openweathermap.org/current)
+#### Mode
 ```ruby
-  params = {
-    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
-  }
+# Response in JSON format (default)
+puts weather.get :current, city_name: "London,UK"
+puts weather.get :current, city_name: "London,UK", mode: :json
 
-  puts weather.get :current, params
+# Response in XML format
+puts weather.get :current, city_name: "London,UK", mode: :xml
 
+# Response in HTML format
+puts weather.get :current, city_name: "London,UK", mode: :html
 ```
-### 5 day weather forecast (http://openweathermap.org/forecast5)
+
+#### Units
 ```ruby
-  params = {
-    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
-  }
-
-  puts weather.get :forecast, params
+# Kelvin (default)
+puts weather.get :current, city_name: "London,UK"
+
+# Imperial
+puts weather.get :current, city_name: "London,UK", units: :imperial
+
+# Metric
+puts weather.get :current, city_name: "London,UK", units: :metric
 ```
 
-### 16 day weather forecast (http://openweathermap.org/forecast16)
+#### All
 ```ruby
-  params = {
-    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
-  }
-
-  puts weather.get :extended, params
+query = {
+  city_name: "London,UK",
+  mode: 'json',
+  units: 'imperial',
+  lang: 'fr'
+}
+
+puts weather.get :current, query
 ```
 
+----
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/examples/current.rb

@@ -0,0 +1,13 @@
+require 'owmo'
+
+=begin rdoc
+An example on how to get current conditions and use the different parameters.
+=end
+api_key = ""
+
+weather = OWMO::Weather.new api_key
+
+# http://openweathermap.org/current#data
+current = weather.get :current, city_name: "London,UK"
+
+puts current

data/examples/forecast16.rb

@@ -0,0 +1,14 @@
+require 'owmo'
+
+
+=begin rdoc
+An example on how to get the weather forcast and use the different parameters.
+=end
+api_key = ""
+
+weather = OWMO::Weather.new api_key
+
+# http://openweathermap.org/forecast16
+forecast16 = weather.get :forecast16, city_name: "London,UK"
+
+puts forecast16

data/examples/forecast5.rb

@@ -0,0 +1,14 @@
+require 'owmo'
+
+
+=begin rdoc
+An example on how to get the extended forcast and use the different parameters.
+=end
+api_key = ""
+
+weather = OWMO::Weather.new api_key
+
+# http://openweathermap.org/forecast5
+forecast5 = weather.get :forecast5, city_name: "London,UK"
+
+puts forecast5

data/examples/query_all.rb

@@ -0,0 +1,16 @@
+require 'owmo'
+
+api_key = ""
+
+weather = OWMO::Weather.new api_key
+
+query = {
+  city_name: "London,UK", # Geolocation, required
+  mode: 'json', # Return data [json (defaul), xml, html]
+  units: 'imperial', # [imperial, metric, or blank (Default, Kelvin)]
+  lang: 'fr' # Language support
+}
+
+current = weather.get :current, query
+
+puts current

data/examples/query_geocode.rb

@@ -0,0 +1,20 @@
+require 'owmo'
+
+api_key = ""
+
+weather = OWMO::Weather.new api_key
+
+# Geocode by City ID
+puts weather.get :current, city_id: 5328041
+puts weather.get :current, id: 5328041
+
+# Geocode by City Name
+puts weather.get :current, city_name: "Beverly Hills"
+puts weather.get :current, q: "Beverly Hills"
+
+# Geocode by Zip Code
+puts weather.get :current, zip: 90210
+puts weather.get :current, zip_code: 90210
+
+# Geocode by Coordinance
+puts weather.get :current, lon: -118.41, lat: 34.09

data/examples/query_mode.rb

@@ -0,0 +1,15 @@
+require 'owmo'
+
+api_key = ""
+
+weather = OWMO::Weather.new api_key
+
+# Response in JSON format
+puts weather.get :current, city_name: "London,UK"
+puts weather.get :current, city_name: "London,UK", mode: :json
+
+# Response in XML format
+puts weather.get :current, city_name: "London,UK", mode: :xml
+
+# Response in HTML format
+puts weather.get :current, city_name: "London,UK", mode: :html

data/examples/query_units.rb

@@ -0,0 +1,14 @@
+require 'owmo'
+
+api_key = ""
+
+weather = OWMO::Weather.new api_key
+
+# Kelvin
+puts weather.get :current, city_name: "London,UK"
+
+# Imperial
+puts weather.get :current, city_name: "London,UK", units: :imperial
+
+# Metric
+puts weather.get :current, city_name: "London,UK", units: :metric

data/lib/owmo/version.rb

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

data/lib/owmo/weather.rb

@@ -16,14 +16,53 @@ A weather class for retrieving current and forecasted weather conditions.
 =end
   class Weather
 
+    attr_reader :api_key, :Paths, :Geocodes
+
 =begin rdoc
-Raised when missing OpenWeatherMap.org API key
+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
-    class MissingApiKey < StandardError
-      def initialize()
-        super("Missing OpenWeatherMap.org API key, please register for one here -> http://openweathermap.org/appid")
-      end # initialize
-    end # MissingApiKey
+    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]]
+      }
+    }
 
 =begin rdoc
 Invalid path specified
@@ -31,7 +70,7 @@ Invalid path specified
     class InvalidPathSpecified < StandardError
       def initialize(path=nil)
         @path = path
-        super("Invalid path specified: Got: '#{@path}', expected one of: #{OWMO::PATHS.keys}")
+        super("Invalid path specified: Got: '#{@path}', expected one of: #{Paths.keys}")
       end # initialize
     end # NoGeocodeSpecified
 
@@ -41,20 +80,15 @@ Missing Geocode from query
     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]
+    def initialize(api_key, **kwargs) #:notnew:
+      @api_key = api_key
     end # initialize
 
 =begin rdoc
 A weather class for retrieving current and forecasted weather conditions.
 ==== Attributes
-* +path+ - OWMO::PATH parameter
+* +path+ - OWMO::Wether.Path parameter
 * +query+ - Hash of query options (Geocode, response format, units, etc.)
 ==== Examples
   api_key = "<My API Key>"
@@ -67,11 +101,11 @@ A weather class for retrieving current and forecasted weather conditions.
       query = check_geocodes query
 
       # Add the api key
-      query[:APPID] = @api_key if query[:APPID].nil?
+      query[:APPID] = @api_key
 
       # Create the uri
-      raise InvalidPathSpecified.new(path) if OWMO::PATHS[path].nil?
-      uri = URI "#{OWMO::URL}/#{OWMO::PATHS[path]}?#{URI.encode_www_form(query)}"
+      raise InvalidPathSpecified.new(path) if Paths[path].nil?
+      uri = URI "#{OWMO::URL}/#{Paths[path]}?#{URI.encode_www_form(query)}"
 
       # Get the weather data
       OWMO::API.get(uri)
@@ -86,7 +120,7 @@ Ensure appropriate query options are applied to the final URI
     # May never be called since query is required
     raise MissingGeocodes if query.size == 0
 
-    GEOCODES.each do |name, geocodes|
+    Geocodes.each do |name, geocodes|
 
       # Get the common keys
       intersect = geocodes[:options].flatten & query.keys

data/lib/owmo.rb

@@ -13,52 +13,6 @@ 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
@@ -70,9 +24,9 @@ Yield a weather object for querying weather data
   end
 =end
   public
-  def self.weather(**params)
-    w = Weather.new params
-    yield w
+  def self.weather(api_key, **params)
+    weather = Weather.new api_key, params
+    yield weather
   end # weather
 
 end # OWMO

data/owmo.gemspec

@@ -14,15 +14,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/robb-randall/owmo"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
-
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owmo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Robb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-11 00:00:00.000000000 Z
+date: 2017-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,9 +69,13 @@ files:
 - _config.yml
 - bin/console
 - bin/setup
-- examples/current_conditions.rb
-- examples/extended.rb
-- examples/forecast.rb
+- examples/current.rb
+- examples/forecast16.rb
+- examples/forecast5.rb
+- examples/query_all.rb
+- examples/query_geocode.rb
+- examples/query_mode.rb
+- examples/query_units.rb
 - lib/core_extensions/core_extensions.rb
 - lib/core_extensions/net/http_response/weather_response.rb
 - lib/owmo.rb

data/examples/current_conditions.rb

@@ -1,21 +0,0 @@
-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
-  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, query
-
-  puts current_condition
-end

data/examples/extended.rb

@@ -1,22 +0,0 @@
-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
-  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, query
-
-  puts extended
-end

data/examples/forecast.rb

@@ -1,22 +0,0 @@
-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
-  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, query
-
-  puts forecast
-end