oweather 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a0f5221cebf4676607e1653e3696720567ce8ba
+  data.tar.gz: 3d4864eac797cd15c2c93f1db68230c3826b1cf5
+SHA512:
+  metadata.gz: b9662019bc5a3c0c2321f97c5fe704855e4e07e8eed636932b411ba2e73eee2a3ff977627e8176f973e1c78fd924dffb3d20523b1dcac8477924ed189f6108da
+  data.tar.gz: f8340cc7741d6147114e1e6164d59571745cace41e70fc1f2ddc58ab4b8141cb618b2fa95a0d32397a13d06336ac2f5f15e2444eaaca6f8a2ce386a95f01d739

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lucas Ocon
+
+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/OW.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'OW/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oweather"
+  spec.version       = OW::VERSION
+  spec.authors       = ["Lucas Ocon"]
+  spec.email         = ["lucas_masterclas@hotmail.com"]
+
+  spec.summary       = %q{Wrapper the OpenWeatherMap API}
+  spec.description   = %q{A minimal Ruby Gem to wrap the OpenWeatherMap API http://openweathermap.org}
+  spec.homepage      = "https://github.com/lucasocon/oweather"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest", "~> 5.5.1"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "json"
+end

data/README.md

@@ -0,0 +1,90 @@
+# Oweather [![Gem Version](https://badge.fury.io/rb/openweather2.svg)](http://badge.fury.io/rb/openweather2)
+
+This gem is an abstraction to the OpenWeatherMap API.
+
+This gem provide the weather from numerous regions around the world.
+
+Also you can get some data on the gem response:
+* City name
+* Longitude
+* Latitude
+* Temperature
+* Pressure
+* Humidity
+* Min temperature
+* Max temperature
+* Clouds
+* Wind speed
+* Wind angle
+
+You can get your APP ID from the OpenWeatherMap website.
+
+http://openweathermap.org/appid#get
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oweather'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oweather
+
+## Usage
+
+Usage:
+
+```ruby
+require "oweather"
+
+OW.configure do |config|
+  config.endpoint = 'http://api.openweathermap.org/data/2.5/weather'
+  config.apikey = YOUR APP ID
+end
+
+OW.get_weather(city: 'london')
+
+
+OW.get_weather(zip: xxxx)
+
+
+OW.get_weather(lat: xxxx, lon: xxxx)
+
+```
+
+Also you can provide a second parameter for the units to convert the temperature to 'metric' or 'imperial'
+
+```ruby
+
+OW.get_weather(city: 'london', units: 'metric')
+OW.get_weather(city: 'london', units: 'imperial')
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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
+
+Be free to report and send your pull request.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lucasocon/oweather.
+
+Contributors:
+* Lucas Ocon (lucasocon)
+
+## 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,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "OW"
+
+# 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

data/bin/setup

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

data/lib/OW.rb

@@ -0,0 +1,3 @@
+require "OW/version"
+require "OW/client"
+require "OW/weather"

data/lib/OW/client.rb

@@ -0,0 +1,77 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module OW
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  class Configuration
+    attr_accessor :endpoint, :apikey
+  end
+
+  class UnprocessableError < RuntimeError; end
+  class ForbiddenError < RuntimeError; end
+  class UnknownResponse < RuntimeError; end
+
+  extend self
+
+  def configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def get_weather(options={})
+    check_configuration!
+    uri = set_params(options)
+    response = send_request(uri)
+    parse_json(response)
+  end
+
+  private  
+  def parse_json(response)
+    case response
+    when Net::HTTPSuccess
+      check_response(response)
+    when Net::HTTPUnprocessableEntity
+      raise UnprocessableError, 'Bad URI param!'
+    else
+      raise UnknownResponse, 'Something was wrong!'
+    end
+  end
+
+  def check_response(response)
+    json = JSON.parse(response.body)
+    if json['cod'] == 200
+      OW::Weather.new(json)
+    else
+      nil
+    end
+  end
+
+  def send_request(uri)
+    req = Net::HTTP::Get.new(uri.request_uri)
+    http_params = [uri.hostname, uri.port, use_ssl: uri.scheme == 'https']
+    Net::HTTP.start(*http_params) {|http| http.request(req)}
+  end
+
+  def set_params(options)
+    uri = URI(OW.configuration.endpoint)
+    uri.query = URI.encode_www_form(default_params.merge(lat: options[:lat], lon: options[:lon], units: options[:units])) if options[:lat] && options[:lon]
+    uri.query = URI.encode_www_form(default_params.merge(zip: options[:zip], units: options[:units])) if options[:zip]
+    uri.query = URI.encode_www_form(default_params.merge(q: options[:city], units: options[:units])) if options[:city]
+    uri
+  end
+
+  def check_configuration!
+    if OW.configuration.instance_variables.size < 2
+      raise ArgumentError, 'You must configure OW'
+    end
+  end
+
+  def default_params
+    {APPID: OW.configuration.apikey}
+  end
+end

data/lib/OW/version.rb

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

data/lib/OW/weather.rb

@@ -0,0 +1,21 @@
+module OW
+  class Weather
+
+    attr_reader :city, :longitude, :latitude, :pressure, :humidity, :clouds,
+      :temperature, :min_temperature, :max_temperature, :wind_speed, :wind_angle
+
+    def initialize(json)
+      @city = json['name']
+      @longitude = json['coord'] && json['coord']['lon']
+      @latitude = json['coord'] && json['coord']['lat']
+      @temperature = json['main']['temp']
+      @pressure = json['main']['pressure']
+      @humidity = json['main']['humidity']
+      @min_temperature = json['main']['temp_min']
+      @max_temperature = json['main']['temp_max']
+      @clouds = json['clouds']['all']
+      @wind_speed = json['wind']['speed']
+      @wind_angle = json['wind']['deg']
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: oweather
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Ocon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A minimal Ruby Gem to wrap the OpenWeatherMap API http://openweathermap.org
+email:
+- lucas_masterclas@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- OW.gemspec
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/OW.rb
+- lib/OW/client.rb
+- lib/OW/version.rb
+- lib/OW/weather.rb
+homepage: https://github.com/lucasocon/oweather
+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.8
+signing_key: 
+specification_version: 4
+summary: Wrapper the OpenWeatherMap API
+test_files: []