wwo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fde78b945408af8d30ac20e5f143dd502ce82a05
+  data.tar.gz: 7e5592d90c69813fb4528ccb8d4b7b41d9c9bf06
+SHA512:
+  metadata.gz: e324fc63f41c1f25776767906520e0a2fdbae799cf419f97976cfc1018aae624e2c3ea8dc323089dfb614faf43cd6ee0da1d956c7a5a14434defdac909111fe1
+  data.tar.gz: 8d2f67cfc46b68d1cd8e97ce09027a52e6f972f71498a0dc00f61c600cc4484748aae44c99d49e5c056172ff6cf2d19cca11bdfab6832a22e1046dd3feb370e7

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.1.2
+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 ryan@ryanstenhouse.eu. 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 wwo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ryan Stenhouse for 株式会社アルム ( Allm Inc )
+http://allm.net
+
+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,70 @@
+# WWO - World Weather Online API Gem
+
+This gem provides a (for now) very opinionated interface to [World Weather Online's API][1]. It's based heavily on the
+[forecast-ruby gem](https://github.com/darkskyapp/forecast-ruby) by the wonderful people over at Dark Skies / Forecast.io
+and was bourne out of the need to have a drop in replacemnet for Forecast.io in an application.
+
+The plan is to ehance this over time so that it supports more of WWO's API. Right now it supports forecasts and historical
+weather for a lat / long pair of anywhere in the world.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wwo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wwo
+
+## Usage
+
+
+Basic usage is just like the forecast gem. For example, if you were calling the API from a
+Rails action, you might want to do this:
+
+````ruby
+Wwo.configure do |configuration|
+  configuration.api_key = 'this-is-your-api-key'
+  configuration.use_premium_api = true # default is false
+end
+
+Wwo.connection = Faraday.new do |builder|
+   builder.use Faraday::HttpCache, store: Rails.cache, serializer: Marshal
+   builder.adapter Faraday.default_adapter
+end
+
+weather = Wwo.forecast(latitude, longitude, time: timestamp)
+````
+
+The `forecast` method provides API compatibilty with `forecast-ruby`. We also expose `historic` for any
+past weather and `now_or_future` for any forecasting that is required.
+
+We also play around with the response we get back from WWO so that it is in the same structure as the response
+from the Dark Sky API. The main difference is that the icon names will be the actual URLs to icon images served
+from WWO's CDN.
+
+
+## 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/sujrd/wwo. 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).
+
+
+[1]: https://developer.worldweatheronline.com

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 "wwo"
+
+# 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/wwo/configuration.rb

@@ -0,0 +1,57 @@
+module Wwo
+  module Configuration
+    # Default API endpoint
+    DEFAULT_FREE_ENDPOINT       = 'https://api.worldweatheronline.com/free/v2'
+    DEFAULT_PREMIUM_ENDPOINT    = 'https://api.worldweatheronline.com/premium/v1'
+
+    # Forecast API endpoint
+    attr_writer :api_endpoint
+
+    # API key
+    attr_writer :api_key
+
+    # Cache Object
+    attr_writer :api_cache_store
+
+    # Cache Object
+    attr_writer :use_premium_api
+
+    # Default parameters
+    attr_accessor :default_params
+
+    # Example:
+    #
+    #   Wwo.configure do |configuration|
+    #     configuration.use_peremium_api = true
+    #     configuration.api_key = 'this-is-your-api-key'
+    #   end
+    def configure
+      yield self
+    end
+
+    # API endpoint
+    def api_endpoint
+      @api_endpoint ||= ( use_premium_api? ? DEFAULT_PREMIUM_ENDPOINT : DEFAULT_FREE_ENDPOINT )
+    end
+
+    # API key
+    def api_key
+      @api_key
+    end
+
+    def use_premium_api
+      @use_premium_api
+    end
+
+    # API Cache Object
+    def api_cache_store
+      @api_cache_store
+    end
+
+    private
+
+    def use_premium_api?
+      Wwo.use_premium_api == true
+    end
+  end
+end

data/lib/wwo/version.rb

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

data/lib/wwo.rb

@@ -0,0 +1,92 @@
+require "wwo/version"
+require "wwo/configuration"
+
+require 'hashie'
+require 'multi_json'
+require 'faraday'
+require 'date'
+
+module Wwo
+  extend Configuration
+
+  self.default_params = {}
+  self.api_cache_store = nil
+
+  class << self
+
+    # Provides API compatibility to forecast.io's rubygem - expects the same signature and a
+    # Unix Timestamp for :time, it will use the historic / now_or_later methods under the hood
+    # to actually do its work.
+    #
+    def forecast(latitude, longitude, options = {})
+      if options[:time]
+        date = Time.at(options[:time])
+      else
+        date = Time.now
+      end
+
+      if date.to_i < Time.now.to_i
+        historic(latitude, longitude, date)
+      else
+        now_or_later(latitude, longitude, date)
+      end
+    end
+
+    # Returns historic weather at the provided latitude and longitude coordinates, on a
+    # specific date.
+    #
+    # @param latitude [String] Latitude.
+    # @param longitude [String] Longitude.
+    # @param date [Date] or [Integer] Date, or Unix Timestamp.
+    #
+    def historic(latitude, longitude, date_or_timestamp)
+      date = date_or_timestamp.is_a?(Numeric) ? Time.at(date_or_timestamp).strftime("%F") : date_or_timestamp.strftime("%F")
+      uri = "#{Wwo.api_endpoint}/past-weather.ashx?q=#{latitude},#{longitude}&date=#{date}&tp=24&format=json&key=#{Wwo.api_key}"
+
+      api_response = get(uri)
+
+      if api_response.success?
+        return Hashie::Mash.new(MultiJson.load(api_response.body))
+      end
+    end
+
+    # Returns historic weather at the provided latitude and longitude coordinates, on a
+    # specific date.
+    #
+    # @param latitude [String] Latitude.
+    # @param longitude [String] Longitude.
+    # @param date [Date] or [Integer] Date, or Unix Timestamp.
+    #
+    def now_or_later(latitude, longitude, date_or_timestamp = Date.today)
+      date = date_or_timestamp.is_a?(Numeric) ? Time.at(date_or_timestamp).strftime("%F") : date_or_timestamp.strftime("%F")
+      uri = "#{Wwo.api_endpoint}/weather.ashx?q=#{latitude},#{longitude}&date=#{date}&num_of_days=1&tp=24&format=json&key=#{Wwo.api_key}"
+
+      api_response = get(uri)
+
+      if api_response.success?
+        return Hashie::Mash.new(MultiJson.load(api_response.body))
+      end
+    end
+
+    # Build or get an HTTP connection object.
+    def connection
+      return @connection if @connection
+      @connection = Faraday.new
+    end
+
+    # Set an HTTP connection object.
+    #
+    # @param connection Connection object to be used.
+    def connection=(connection)
+      @connection = connection
+    end
+
+    private
+
+    def get(path, params = {})
+      params = Wwo.default_params.merge(params || {})
+
+      connection.get(path, params)
+    end
+  end
+end

data/wwo.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wwo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wwo"
+  spec.version       = Wwo::VERSION
+  spec.authors       = ["株式会社アルム　Allm Inc", "Ryan Stenhouse", "David Czarnecki"]
+  spec.email         = ["r.stenhouse@allm.net"]
+
+  spec.summary       = %q{Rubygem for accessing the free and premium weather APIs from World Weather Online.  Inspired by Dark Sky's Forecast.IO gem.}
+  spec.homepage      = "https://github.com/sujrd/wwo"
+  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_dependency('faraday')
+  spec.add_dependency('faraday-http-cache')
+  spec.add_dependency('multi_json')
+  spec.add_dependency('hashie')
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency('vcr')
+  spec.add_development_dependency('typhoeus')
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: wwo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "株式会社アルム　Allm Inc"
+- Ryan Stenhouse
+- David Czarnecki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday-http-cache
+  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: multi_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'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: 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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- r.stenhouse@allm.net
+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/wwo.rb
+- lib/wwo/configuration.rb
+- lib/wwo/version.rb
+- wwo.gemspec
+homepage: https://github.com/sujrd/wwo
+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: Rubygem for accessing the free and premium weather APIs from World Weather
+  Online.  Inspired by Dark Sky's Forecast.IO gem.
+test_files: []