simple_open_weather_map 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6da0559f9a0ad5553267ee56edb26c0b9b21a74
+  data.tar.gz: 9b72b0e4d27787e0772387da3e7e6582628a7434
+SHA512:
+  metadata.gz: 03cffaa8f500e3cddc9add26dae251d1f3f6ed28050c8d4a7572f3e0472f81984b9ee9a4ca97fdd0efdd5df239b50189dd1722e05ebaf95327b14481cb66e4f2
+  data.tar.gz: fba4347b32bd3bfdb577a7712d57448748d25e9244843d7b7afd4eb8e30c6d61a9b95be8d9ecdd3dca99d28405f8f82ab5197836795fd270918637bca3a21498

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,60 @@
+# SimpleOpenWeatherMap
+
+A simple ruby language library for the OpenWeatherMap API.
+This library doesn't have functions enough to call the OpenWeatherMap API because I basically made this to display current weather and forecast to my desktop using the GeekTool.
+But I think this library helps you to call the OpenWeatherMap API with using or extending Openweathermap::Weather class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_open_weather_map'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_open_weather_map
+
+## Usage
+
+```ruby
+require 'simple_open_weather_map'
+
+conf = simple_open_weather_map::Config({
+  app_id: "your APPID",        # Get from OpenWeatherMap.org",
+  city_id: 1234,               # integer: specify city id.
+  unit: "metric",              # metric or kelvin. Default: metric
+  save_icon: true,             # if you set true, you have to specify save_icon_dir. Default: true
+  save_icon_dir: "~/Pictures", # Specify directory path to save weather icon. Default: /tmp
+  forecast_days: 7,            # Specify number of days to get forecast. Default: 7
+})
+weather = simple_open_weather_map::Weather.new
+current = weather.current(conf) # returns json formatted content.
+forecast = weather.forecast(conf) # returns json formatted content.
+icon_path = weather.icon_path # returns path of current weather icon.
+```
+
+See the following site about json response.
+
+* [current](http://openweathermap.org/current#current_JSON)
+* [forecast](http://openweathermap.org/forecast16#JSON)
+
+## 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/whize/simple_open_weather_map. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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 "simple_open_weather_map"
+
+# 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,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/lib/simple_open_weather_map.rb

@@ -0,0 +1,43 @@
+require "simple_open_weather_map/version"
+require 'simple_open_weather_map/config'
+require 'simple_open_weather_map/report'
+require 'simple_open_weather_map/weather'
+require 'simple_open_weather_map/http_connection'
+
+module SimpleOpenWeatherMap
+  #
+  # OpenWeatherMap API URL
+  #
+  BASE_URL = 'http://api.openweathermap.org/data/2.5'.freeze
+
+  #
+  # Weather icon url template.
+  # You must bind icon name into this strings.
+  #
+  ICON_URL_TEMPLATE = 'http://openweathermap.org/img/w/%s.png'.freeze
+
+  #
+  # Url path for current
+  #
+  PATH_CURRENT = '/weather'.freeze
+
+  #
+  # Url path for forecast daily
+  #
+  PATH_FORECAST = '/forecast/daily'.freeze
+
+  #
+  # Parameter value for unit (kelvin)
+  #
+  UNIT_KELVIN = 'kelvin'.freeze
+
+  #
+  # Parameter value for unit (metric)
+  #
+  UNIT_METRIC = 'metric'.freeze
+
+  #
+  # Default number of days to get forecast. 7 days
+  #
+  FORECAST_DAYS = 7
+end

data/lib/simple_open_weather_map/config.rb

@@ -0,0 +1,59 @@
+
+
+class SimpleOpenWeatherMap::Config
+  attr_accessor :app_id, :unit, :forecast_days, :save_icon_dir, :city_id
+
+  def initialize(config = {})
+    raise "Hash only." unless config.is_a?(Hash)
+
+    validate(config)
+    parse(default_config.merge(config))
+  end
+
+  def save_icon?
+    @save_icon || false
+  end
+
+  protected
+
+  def default_config
+    {
+      city_id: 1850147,
+      unit: "metric",
+      forecast_days: 7,
+      save_icon: true,
+      save_icon_dir: "/tmp",
+    }
+  end
+
+  def parse(config = {})
+    config.each_key do | key |
+      case key
+      when :app_id then
+          @app_id = config[:app_id]
+      when :city_id then
+          @city_id = config[:city_id]
+      when :unit then
+          @unit = config[:unit]
+      when :forecast_days then
+          @forecast_days = config[:forecast_days]
+      when :save_icon then
+          @save_icon = config[:save_icon]
+      when :save_icon_dir then
+          @save_icon_dir = config[:save_icon_dir]
+      end
+    end
+  end
+
+  private
+
+  def mandatory_key
+    [:app_id, :city_id]
+  end
+
+  def validate(config = {})
+      raise ArgumentError.new("Value of app_id key is mandatory.") unless config.has_key?(:app_id)
+      # raise ArgumentError.new("Value of city_id key is mandatory") unless config.has_key?(:city_id)
+  end
+
+end

data/lib/simple_open_weather_map/http_connection.rb

@@ -0,0 +1,22 @@
+require 'uri'
+require 'httpclient'
+
+class SimpleOpenWeatherMap::HttpConnection
+
+  def initialize(uri)
+    @uri = uri
+  end
+
+  def get_contents(params = {})
+    client = ::HTTPClient.new
+    client.get_content(url_with_params(params))
+  end
+
+  protected
+
+  def url_with_params(params = {})
+    encoded_params = URI.encode_www_form(params)
+    [@uri, encoded_params].join("?")
+  end
+
+end

data/lib/simple_open_weather_map/report.rb

@@ -0,0 +1,64 @@
+
+class SimpleOpenWeatherMap::Report
+    attr_accessor :config, :city_id
+
+    def initialize(config)
+      if config.is_a?(Hash) then
+        @config = SimpleOpenWeatherMap::Config.new(config)
+      elsif config.is_a?(SimpleOpenWeatherMap::Config) then
+        @config = config
+      else
+        raise "config should be Hash or SimpleOpenWeatherMap::Config object."
+      end
+    end
+
+    public
+
+    def current
+        weather.current(@config)
+    end
+
+    def forecast
+        weather.forecast(@config)
+    end
+
+    def puts_report
+      puts format_current(current)
+      puts ""
+
+      cnt = 0
+      forecast["list"].each do |data|
+        if cnt != 0 then
+          puts format_forecast(data)
+        end
+
+        cnt += 1
+      end
+    end
+
+    private
+
+    def weather
+        @weather = @weather || SimpleOpenWeatherMap::Weather.new
+    end
+
+    def format_current(data)
+      # temp main, description :name
+      "%d°C %s, %s :%s" % [
+          data["main"]["temp"],
+          data["weather"][0]["main"],
+          data["weather"][0]["description"],
+          data["name"]
+      ]
+    end
+
+    def format_forecast(data)
+      # day temp-min - temp.max description
+      "%-4s\t\t%2d°C - %2d°C\t\t%s" % [
+          ::Time.at(data["dt"]).strftime("%a"),
+          data["temp"]["min"],
+          data["temp"]["max"],
+          data["weather"][0]["description"]
+      ]
+    end
+end

data/lib/simple_open_weather_map/version.rb

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

data/lib/simple_open_weather_map/weather.rb

@@ -0,0 +1,72 @@
+require 'json'
+require 'FileUtils'
+require 'open-uri'
+
+class SimpleOpenWeatherMap::Weather
+
+  attr_accessor :icon_path
+
+  def current(config)
+    raise "SimpleOpenWeatherMap::Config only!" unless config.is_a?(SimpleOpenWeatherMap::Config)
+
+    responseJson = http_connection(SimpleOpenWeatherMap::PATH_CURRENT).get_contents(current_params(config))
+    return nil if responseJson.nil? || responseJson.empty?
+
+    @current = ::JSON.parse(responseJson)
+
+    if config.save_icon? then
+      save_current_icon(@current["weather"][0]["icon"], config.save_icon_dir)
+    end
+
+    return @current
+  end
+
+  def forecast(config)
+    raise "SimpleOpenWeatherMap::Config only!" unless config.is_a?(SimpleOpenWeatherMap::Config)
+
+    responseJson = http_connection(SimpleOpenWeatherMap::PATH_FORECAST).get_contents(forecast_params(config))
+    return nil if responseJson.nil? || responseJson.empty?
+
+    ::JSON.parse(responseJson)
+  end
+
+  protected
+
+  def http_connection(path)
+    SimpleOpenWeatherMap::HttpConnection.new(SimpleOpenWeatherMap::BASE_URL + path)
+  end
+
+  def current_params(config)
+    {
+      APPID: config.app_id,
+      units: config.unit,
+      id:    config.city_id,
+    }
+  end
+
+  def forecast_params(config)
+    {
+      APPID: config.app_id,
+      units: config.unit,
+      id:    config.city_id,
+      cnt:   config.forecast_days,
+    }
+  end
+
+  def save_current_icon(icon_name, dir)
+    return nil if icon_name.nil? || icon_name.empty?
+
+    icon_url = SimpleOpenWeatherMap::ICON_URL_TEMPLATE % [icon_name]
+    @icon_path = "%s/%s" % [dir, "weather_icon.png"]
+
+    ::FileUtils.mkdir_p(dir) unless ::FileTest.exist?(dir)
+
+    open(@icon_path, 'wb') do |output|
+      open(icon_url) do |data|
+        output.write(data.read)
+      end
+    end
+
+  end
+
+end

data/simple_open_weather_map.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_open_weather_map/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_open_weather_map"
+  spec.version       = SimpleOpenWeatherMap::VERSION
+  spec.authors       = ["whize"]
+  spec.email         = ["whize.k@gmail.com"]
+
+  spec.summary       = %q{A simple ruby language library for the OpenWeatherMap API.}
+  spec.description   = %q{A simple ruby language library for the OpenWeatherMap API.}
+  spec.homepage      = "https://github.com/whize/simple_open_weather_map"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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 { |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 "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "httpclient"
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: simple_open_weather_map
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- whize
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  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'
+- !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 simple ruby language library for the OpenWeatherMap API.
+email:
+- whize.k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_open_weather_map.rb
+- lib/simple_open_weather_map/config.rb
+- lib/simple_open_weather_map/http_connection.rb
+- lib/simple_open_weather_map/report.rb
+- lib/simple_open_weather_map/version.rb
+- lib/simple_open_weather_map/weather.rb
+- simple_open_weather_map.gemspec
+homepage: https://github.com/whize/simple_open_weather_map
+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.1
+signing_key: 
+specification_version: 4
+summary: A simple ruby language library for the OpenWeatherMap API.
+test_files: []