darksky_weather-api 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 064e45392826a9604aa9b78bf7997b4037a26451bc6c1b0c48703e94f23baf8e
+  data.tar.gz: c2f9800eb63a696bba4111f74eaa8202995a7c6714845cc7bf5530a300ec97c9
+SHA512:
+  metadata.gz: 73b8bb85e37f444420d3a90dd0252894700e4195f2e4c88f1a90bea4edcc8c7688e4fcc0d4d59e43d87c8c7dd4c299ce48f04994d6e11b5c0ce5d3ec93193cc2
+  data.tar.gz: c470a0f750c40f7069f2a3cef9f4f6e00cbb89610c692afc3289cba11b2087d366ea799e990210807c0c5f20f86387d10b74726102421848480bd4b16fb34f89

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.2 (2019-09-20)
+
+* Changed module names and paths to make auto-inclusion work properly

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in darksky-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    darksky_weather-api (0.1.2)
+      activesupport
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    httparty (0.17.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0904)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  darksky_weather-api!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Lojistic
+
+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,114 @@
+# DarkskyWeather::Api
+
+This gem provides a wrapper around the [Dark Sky API](https://darksky.net/dev) for retrieving and analyzing past and current weather forecasts. In order to use this gem, you'll need to [register for an account](https://darksky.net/dev/register) on Dark Sky so that you can get an API key to make requests with. The account is free, and your first 1,000 calls per day are also free. After that, you'll be billed for each subsequent call. See the [Dark Sky FAQ](https://darksky.net/dev/docs/faq) for more details.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'darksky_weather-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install darksky_weather-api
+
+## Usage
+
+The main purpose of this gem is to make it easy to retrieve and perform basic analysis on weather data provided by the Dark Sky API. The goal is to offer simple configuration and an easy-to-use interface for working with the information provided. Once you've set up your account, you'll be ready to go with this gem after just a few configuration steps.
+
+### Configuring a Rails Application
+
+First create `config/initializers/darksky.rb`. Inside that file, place the following contents:
+
+```ruby
+DarkskyWeather::Api.configure{|c| c.api_key = "YourDarkskySecretKeyHere" }
+```
+
+The above example not withstanding, it's a better security practice to store your API key outside of version control and to pass it in via configuration or environment variables. There are a number of methods for doing so which are beyond the scope of this documentation. In any case, once you've set up the initializer, you're done with all configuration.
+
+### Configuring Other Rack Applications
+
+If you're using an alternative framework like Sinatra or Grape that adheres to the Rack interface, you can place the above configuration line inside your `rackup.ru` file to ensure that it executes before you start using the gem.
+
+### Configuring Any Other Ruby Application
+
+If you're using this gem outside of the context of a rack application, just make sure that the configuration line above is called after you've required the gem but before you use it.
+
+### Fetching The Weather
+
+The gem makes a [forecast request](https://darksky.net/dev/docs#forecast-request) in order to obtain current weather information from the Dark Sky API.
+
+To fetch the current weather for a given location, you'll need to know the latitude and longitude of that location. You can obtain this information via a number of methods in a process called "geocoding". Both Google Maps and Bing Maps provide geocoding API's that will transform an address into a latitude, longitude pair. It's beyond the scope of this documentation to discuss their use in detail. Once you have a latitude, longitude pair to work with, retrieving weather is as simple as instantiating a client and calling a single method:
+
+```ruby
+client    = DarkskyWeather::Api::Client.new
+lat, lng  = [37.8267, -122.4233]
+client.get_weather(lat: lat, lng: lng)
+```
+
+Note the use of kwargs in the method call. Calling the `get_weather` method will return a `WeatherData` object that defines a number of useful methods/attributes:
+
+Calling the `attributes` method on a `WeatherData` instance will return a Hash of the following information:
+
+* `current_precipitation`: The amount of liquid rain in inches that has fallen as of the time of the weather report.
+* `current_accumulation`: The amount of snow accumulation, in inches, that is present as of the time of the weather report.
+* `current_visibility`: The number of miles of visibility at the time of the weather report.
+* `current_temperature`: The temperature, in fahrenheit, at the time of the weather report.
+* `current_wind_speed`: The sustained wind speed, in miles per hour, at the time of the weather report.
+* `current_wind_gust`: The wind gust speed, in miles per hour, at the time of the weather report.
+* `max_precipitation`: The largest amount of liquid rain, in inches, expected to fall on the day of the weather report.
+* `max_accumulation`: The largest amount of snow accumulation, in inches, expected for the day of the report.
+* `worst_visibility`: The worst visbility, (in terms of miles), expected for the day of the report.
+* `max_temperature`: The highest temperature, in fahrenheit, expected for the day of the report.
+* `min_temperature`: The lowest temperature, in fahrenheit, expected for the day of the report.
+* `max_wind_speed`: The highest sustained wind speed, in miles per hour, expected for the day of the report.
+* `max_wind_gust`: The highest wind gust speed, in miles per hour, expected for the day of the report.
+* `report_date`: The date that the report was requested for.
+
+Each of the data points in the Hash above _also_ corresponds to a method on the `WeatherData` instance. So, if you just want to know what the `max_precipitation` is, this is perfectly valid:
+
+```ruby
+client       = DarkskyWeather::Api::Client.new
+lat, lng     = [37.8267, -122.4233]
+weather_data = client.get_weather(lat: lat, lng: lng)
+
+puts weather_data.max_precipitation
+
+```
+These attributes and convenience methods do _not_ represent the entirety of the data returned by the API call. Instead, the gem focuses on trying to present the data that's likely to be most useful for most contexts. That said, it is always possible to get back the entire API response as a Hash:
+
+```ruby
+  weather_data = client.get_weather(lat: lat, lng: lng)
+  response = weather_data.raw
+```
+
+For more information about all of the data that comes back from the request, [see the documentation](https://darksky.net/dev/docs).
+
+In addition, you can retrieve the URL for your particular API request by calling `source_url` on the `WeatherData` instance.
+
+### Fetching Historical Weather
+
+The gem also supports making [Dark Sky Time Machine Requests](https://darksky.net/dev/docs#time-machine-request). These work identically to a normal forecast request, with the exception that all of the data is related to the specified time in the past. You can make a time machine request by simply passing in a Unix timestamp along with the latitude and longitude in the `get_weather` call:
+
+```ruby
+client       = DarkskyWeather::Api::Client.new
+lat, lng     = [37.8267, -122.4233]
+weather_data = client.get_weather(lat: lat, lng: lng, timestamp: 30.days.ago.to_i)
+```
+
+You'll get back a `WeatherData` object, just as before, with all of the same methods and attributes to work with.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Lojistic/DarkSky-gem. In particular, exposing more weather data through convenience methods and/or adding methods to analyze the data more effectively would be especially appreciated.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "darksky/api"
+
+# 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/darksky_weather-api.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "darksky_weather/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "darksky_weather-api"
+  spec.version       = DarkskyWeather::Api::VERSION
+  spec.authors       = ["Lojistic Dev Team"]
+  spec.email         = ["dev@lojistic.com"]
+
+  spec.summary       = %q{ Simple wrapper around the DarkSky Weather API}
+  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"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "httparty"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/darksky_weather/api.rb

@@ -0,0 +1,25 @@
+require "darksky_weather/api/version"
+require "darksky_weather/api/client"
+require "darksky_weather/api/weather_data"
+require "active_support/time"
+
+module DarkskyWeather
+  module Api
+    class Error < StandardError; end
+
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+
+
+    class Configuration
+      attr_accessor :api_key
+    end
+
+  end
+end

data/lib/darksky_weather/api/client.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+
+module DarkskyWeather
+  module Api
+    class Client
+      include HTTParty
+      base_uri "https://api.darksky.net/forecast/"
+
+      def get_weather(lat:, lng:, timestamp: nil)
+        key         = DarkskyWeather::Api.configuration.api_key
+
+        request_path   = "/#{key}/#{lat},#{lng}"
+        request_path << ",#{timestamp}" if timestamp
+
+        raw_result  = self.class.get(request_path)
+        request_uri = raw_result.request.uri.to_s
+
+        return WeatherData.new(request_uri, raw_result.parsed_response)
+      end
+    end
+  end
+end

data/lib/darksky_weather/api/version.rb

@@ -0,0 +1,5 @@
+module DarkskyWeather
+  module Api
+    VERSION = "0.1.2"
+  end
+end

data/lib/darksky_weather/api/weather_data.rb

@@ -0,0 +1,99 @@
+module DarkskyWeather
+  module Api
+    class WeatherData
+
+      attr_reader :latitude, :longitude, :timestamp, :currently, :minutely, :hourly, :daily, :raw, :flags, :source_url
+
+      def initialize(source_url, json_data)
+        @source_url = source_url
+        @raw        = json_data
+        @latitude   = json_data['latitude']
+        @longitude  = json_data['longitude']
+        @timestamp  = json_data['currently']['time']
+
+        json_data.each do |k, v|
+          instance_variable_set(:"@#{k}", v) if self.respond_to?(k)
+        end
+      end
+
+      def attributes
+        atts = {}
+        [ :current_precipitation,
+          :current_accumulation,
+          :current_visibility,
+          :current_temperature,
+          :current_wind_speed,
+          :current_wind_gust,
+          :max_precipitation,
+          :max_accumulation,
+          :worst_visibility,
+          :max_temperature,
+          :min_temperature,
+          :max_wind_speed,
+          :max_wind_gust,
+          :report_date ].each do |att_name|
+            atts[att_name] = self.send(att_name)
+          end
+
+          return atts
+      end
+
+      def report_date
+        DateTime.strptime(currently['time'].to_s,'%s').to_date
+      end
+
+      def current_precipitation
+        currently['precipIntensity'] || 0
+      end
+
+      def current_accumulation
+        currently['precipAccumulation'] || 0
+      end
+
+      def current_visibility
+        currently['visibility'].to_f
+      end
+
+      def current_temperature
+        currently['temperature'].to_f
+      end
+
+      def current_wind_speed
+        currently['windSpeed'].to_f
+      end
+
+      def current_wind_gust
+        currently['windGust'].to_f
+      end
+
+      def max_precipitation
+        daily['data'].map{|d| d['precipIntensityMax'].to_f }.max || 0
+      end
+
+      def max_accumulation
+        daily['data'].map{|d| d['precipAccumulation'].to_f }.max || 0
+      end
+
+      def worst_visibility
+        hourly['data'].map{|d| d['visibility'].to_f }.min
+      end
+
+      def max_temperature
+        daily['data'].map{|d| d['temperatureMax'].to_f }.max
+      end
+
+      def min_temperature
+        daily['data'].map{|d| d['temperatureMin'].to_f }.max
+      end
+
+      def max_wind_speed
+        hourly['data'].map{|d| d['windSpeed'].to_f }.max
+      end
+
+      def max_wind_gust
+        hourly['data'].map{|d| d['windGust'].to_f }.max
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: darksky_weather-api
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Lojistic Dev Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: activesupport
+  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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: 
+email:
+- dev@lojistic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- darksky_weather-api.gemspec
+- lib/darksky_weather/api.rb
+- lib/darksky_weather/api/client.rb
+- lib/darksky_weather/api/version.rb
+- lib/darksky_weather/api/weather_data.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Simple wrapper around the DarkSky Weather API
+test_files: []