pirate_weather_forecast_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 607191d92bac7b13f41e405eb6e7bdfcdb4907f53ad6136c1c17767304f0251b
+  data.tar.gz: 39fec03a81d4a2af78b44ba9f74b05c2653a2dbc81aab02e37c00642ff36c1cf
+SHA512:
+  metadata.gz: 3037f44e1b656f68170df5ff4508d326b693b8db5712bd737e1a56c6ae5256f75a771f5614274d749e1d245cb871c8e344249c32d9bbe08b74772c39109960e7
+  data.tar.gz: a7751e814b6e7b322a9a2037454003b2d7485e9559fda9c3d5680693ee5f1d9fbf2d6b0db536c2ab05dcbaa05257d0ae59018f2b2426852a44966b338c128a3d

data/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/ruby:1-3.2-bullseye",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	"remoteUser": "root"
+}

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.2.2'
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--order random

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 3.2.2
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+# TODO: remove + fix code to pass everything
+Metrics/BlockLength:
+  Enabled: false
+
+# TODO: remove + fix code to pass everything
+Style/Documentation:
+  Enabled: false
+
+

data/.ruby-gemset

@@ -0,0 +1 @@
+pirate_weather_forecast_ruby

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-10
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pirate_weather_forecast_ruby.gemspec
+gemspec
+
+gem "dotenv-rails", groups: %i[development test]
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Alex Cochran
+
+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,90 @@
+# pirate_weather_forecast_ruby
+
+[![Workflow: Ruby](https://github.com/alexcochran/pirate-weather-forecast-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/alexcochran/pirate-weather-forecast-ruby/actions/workflows/main.yml)
+
+[Pirate Weather forecast.io](https://pirateweather.net/en/latest/) API wrapper in Ruby, forked from
+[Dark Sky's forecast.io](https://github.com/darkskyapp/forecast-ruby).
+
+Pirate Weather aims to be a drop-in replacement for Apple's (now) non-free Dark Sky API. Similarly, this
+project's goal is to provide a drop-in replacement for the [Ruby Dark Sky API wrapper](https://github.com/darkskyapp/forecast-ruby).
+
+---
+
+## Installation
+
+`gem install pirate_weather_forecast_ruby`
+
+or in your `Gemfile`
+
+```ruby
+gem 'pirate_weather_forecast_ruby'
+```
+
+## Usage
+
+Make sure you require the library.
+
+```ruby
+require 'pirate_weather_forecast_ruby'
+```
+
+You need to set an API key before you can make requests to the API. Grab one from
+[Pirate Weather](https://pirateweather.net/en/latest/).
+
+```ruby
+ForecastIO.configure do |configuration|
+  configuration.api_key = 'this-is-your-api-key'
+end
+```
+
+Alternatively:
+
+```ruby
+ForecastIO.api_key = 'this-is-your-api-key'
+```
+
+You can then make requests to the `ForecastIO.forecast(latitude, longitude, options = {})` method.
+
+Valid options in the `options` hash are:
+
+* `:time` - Unix time in seconds.
+* `:params` - Query parameters that can contain the following:
+  * `:jsonp` - JSONP callback.
+  * `:units` - Return the API response in SI units, rather than the default Imperial units.
+  * `:exclude` - "Exclude some number of data blocks from the API response. This is useful for reducing latency and saving cache space. [blocks] should be a comma-delimeted list (without spaces) of any of the following: currently, minutely, hourly, daily, alerts, flags." (via Dark Sky's [v2 docs](https://developer.forecast.io/docs/v2#changelog))
+
+Get the current forecast:
+
+```ruby
+forecast = ForecastIO.forecast(37.8267, -122.423)
+```
+
+Get the current forecast at a given time:
+
+```ruby
+forecast = ForecastIO.forecast(37.8267, -122.423, time: Time.new(2013, 3, 11).to_i)
+```
+
+Get the current forecast and use SI units:
+
+```ruby
+forecast = ForecastIO.forecast(37.8267, -122.423, params: { units: 'si' })
+```
+
+The `forecast(...)` method will return a response that you can interact with in a more-friendly way, such as:
+
+```ruby
+forecast = ForecastIO.forecast(37.8267, -122.423)
+forecast.latitude
+forecast.longitude
+```
+
+---
+
+## Contributing
+
+⏳
+
+## [License](./LICENSE)
+
+Copyright (c) 2023 Alex Cochran

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+  spec.rspec_opts = ["--backtrace"]
+  # spec.ruby_opts = ['-w']
+end
+
+task default: :spec
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pirate_weather_forecast_ruby"
+
+# 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/lib/pirate_weather_forecast_ruby/configuration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ForecastIO
+  module Configuration
+    # Default API endpoint
+    DEFAULT_FORECAST_IO_API_ENDPOINT = "https://api.pirateweather.net"
+
+    # Forecast API endpoint
+    attr_writer :api_endpoint
+
+    # API key
+    attr_writer :api_key
+
+    # Request read timeout
+    attr_writer :timeout
+
+    # Default parameters
+    attr_accessor :default_params
+
+    # Yield self to be able to configure ForecastIO with block-style configuration.
+    #
+    # Example:
+    #
+    #   ForecastIO.configure do |configuration|
+    #     configuration.api_key = 'this-is-your-api-key'
+    #     configuration.timeout = 500
+    #   end
+    def configure
+      yield self
+    end
+
+    # API endpoint
+    def api_endpoint
+      @api_endpoint ||= DEFAULT_FORECAST_IO_API_ENDPOINT
+    end
+
+    # API key
+    def api_key
+      @api_key
+    end
+
+    # Request read timeout
+    def timeout
+      @timeout
+    end
+  end
+end

data/lib/pirate_weather_forecast_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ForecastIO
+  VERSION = "0.1.0"
+end

data/lib/pirate_weather_forecast_ruby.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "pirate_weather_forecast_ruby/configuration"
+require_relative "pirate_weather_forecast_ruby/version"
+
+require "hashie"
+require "multi_json"
+require "faraday"
+
+module ForecastIO
+  extend Configuration
+
+  self.default_params = {}
+
+  class << self
+    # Retrieve the forecast for a given latitude and longitude.
+    #
+    # @param latitude [String] Latitude.
+    # @param longitude [String] Longitude.
+    # @param options [String] Optional parameters. Valid options are `:time` and `:params`.
+    def forecast(latitude, longitude, options = {})
+      forecast_url = "#{ForecastIO.api_endpoint}/forecast/#{ForecastIO.api_key}/#{latitude},#{longitude}"
+      forecast_url += ",#{options[:time]}" if options[:time]
+
+      forecast_response = get(forecast_url, options[:params])
+
+      return unless forecast_response.success?
+
+      Hashie::Mash.new(MultiJson.load(forecast_response.body))
+    end
+
+    # Build or get an HTTP connection object.
+    def connection
+      @connection ||= Faraday.new(request: { timeout: ForecastIO.timeout })
+    end
+
+    # Set an HTTP connection object.
+    #
+    # @param connection Connection object to be used.
+    attr_writer :connection
+
+    private
+
+    def get(path, params = {})
+      params = ForecastIO.default_params.merge(params || {})
+
+      connection.get(path, params)
+    end
+  end
+end

data/pirate_weather_forecast_ruby.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+require_relative "lib/pirate_weather_forecast_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "pirate_weather_forecast_ruby"
+  spec.version     = ForecastIO::VERSION
+  spec.authors     = ["Alex Cochran"]
+  spec.email       = ["acochran50@gmail.com"]
+  spec.homepage    = "https://github.com/alexcochran/pirate-weather-forecast-ruby"
+  spec.summary     = "forecast.io API wrapper in Ruby"
+  spec.description = "forecast.io API wrapper in Ruby"
+
+  spec.required_ruby_version = ">= 3.2.2"
+
+  spec.rubyforge_project = "pirate_weather_forecast_ruby"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("faraday")
+  spec.add_dependency("hashie")
+  spec.add_dependency("multi_json")
+
+  spec.add_development_dependency("faraday-typhoeus")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("rspec")
+  spec.add_development_dependency("vcr")
+end

data/sig/pirate_weather_forecast_ruby.rbs

@@ -0,0 +1,4 @@
+module PirateWeatherForecastRuby
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end