owmo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ac6a3db29e87019c86229bcfe4d0e3b7a001080
+  data.tar.gz: 067bec01b6055748a4844d8aa380fd06b0c37324
+SHA512:
+  metadata.gz: 4f4d0980495978f29e7b4b93ffe6ea9904c82382b6e3325a88a7c401f7f971fed8148071029e1be68479515f273a5f12b6bd6b6ce514f679749dcfa9b7a825f4
+  data.tar.gz: db1d47014dd4d26e646826a1b7708a0c62542fd71d480377eac568cc4992b2bb0f7c3ba02bf3d2203d96bf2d56470e560f2d050a57d4fc70f41a0b623a1348fc

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+
+*.gem
+test.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Robb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Owmo
+
+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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'owmo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install owmo
+
+## Usage
+
+You'll need and API key from OpenWeatherMap.org (http://openweathermap.org/appid).
+
+Either instanciate the OWMO::Weather class:
+```ruby
+require 'owmo'
+api_key = ""
+
+weather = OWMO::Weather.new api_key: api_key
+```
+
+or through the OWMO::weather method block:
+```ruby
+require 'owmo'
+api_key = ""
+
+OWMO::weather api_key: api_key do |weather|
+    puts weather.get :current, city_name: "London,uk"
+end
+```
+
+**Current weather data** (http://openweathermap.org/current)
+```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
+  }
+
+  puts weather.get :current, params
+
+```
+**5 day weather forecast** (http://openweathermap.org/forecast5)
+```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
+```
+
+**16 day weather forecast** (http://openweathermap.org/forecast16)
+```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
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/owmo.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "owmo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/current_conditions.rb

@@ -0,0 +1,18 @@
+require 'owmo'
+
+api_key = ""
+
+OWMO::weather api_key: api_key do |weather|
+
+  # http://openweathermap.org/current#data
+  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
+  }
+
+  current_condition = weather.get :current, params
+
+  puts current_condition
+end

data/examples/extended.rb

@@ -0,0 +1,18 @@
+require 'owmo'
+
+api_key = ""
+
+OWMO::weather api_key: api_key do |weather|
+
+  # http://openweathermap.org/forecast16
+  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
+  }
+
+  extended = weather.get :extended, params
+
+  puts extended
+end

data/examples/forecast.rb

@@ -0,0 +1,18 @@
+require 'owmo'
+
+api_key = ""
+
+OWMO::weather api_key: api_key do |weather|
+
+  # http://openweathermap.org/forecast5
+  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
+  }
+
+  forecast = weather.get :forecast, params
+
+  puts forecast
+end

data/lib/owmo/Weather.rb

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

data/lib/owmo/version.rb

@@ -0,0 +1,3 @@
+module Owmo
+  VERSION = "0.1.0"
+end

data/lib/owmo.rb

@@ -0,0 +1,14 @@
+require "owmo/version"
+require "owmo/Weather"
+
+
+module OWMO
+  URL = 'http://api.openweathermap.org/data/2.5'
+
+  public
+  def self.weather(**params)
+    w = Weather.new params
+    yield w
+  end # weather
+
+end

data/owmo.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'owmo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "owmo"
+  spec.version       = Owmo::VERSION
+  spec.authors       = ["Robb"]
+  spec.email         = ["robb.randall@gmail.com"]
+
+  spec.summary       = %q{OpenWeatherMap.org client for current and forecasted weather conditions.}
+  spec.description   = %q{OpenWeatherMap.org client for current and forecasted weather conditions.}
+  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
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: owmo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robb
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: OpenWeatherMap.org client for current and forecasted weather conditions.
+email:
+- robb.randall@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/current_conditions.rb
+- examples/extended.rb
+- examples/forecast.rb
+- lib/owmo.rb
+- lib/owmo/Weather.rb
+- lib/owmo/version.rb
+- owmo.gemspec
+homepage: https://github.com/robb-randall/owmo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: OpenWeatherMap.org client for current and forecasted weather conditions.
+test_files: []