magicseaweed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebbb514871802d52b4a60abce613bb5391d7e28c0969a793797f0fab7aea0169
+  data.tar.gz: e079314ca6b3739146342e1439385c4d12c15477d14c675d3420ee4d53329114
+SHA512:
+  metadata.gz: e58b87cd809c3f2dbfd0989f88a50eabae03793a8f2c34280dc1b2210c50a3934bbc99843e5c07c67a8af935a7012aa6e8695f470e562aea9a538d12855a35cd
+  data.tar.gz: ef6b3b36eca409d8ab629ebd645e4494554f3eca8bc45b04e18c4b089ef619d8c6f11b23b3e7aa071c2a7137e779e7d97a90f9dc8d556defd029b811abcc3c7e

data/.circleci/config.yml

@@ -0,0 +1,21 @@
+version: 2.0
+jobs:
+  build:
+    docker:
+      - image: ruby:2.6.1
+    steps:
+      - checkout
+      - run:
+          name: Update RubyGems & Bundler
+          command: |
+            gem update --system
+            gem install bundler
+      - run:
+          name: Install Dependencies
+          command: bin/setup
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+      - run:
+          name: Run RSpec
+          command: rake spec

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/.rubocop.yml

@@ -0,0 +1,8 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6.1
+
+Metrics/BlockLength:
+  Exclude:
+    - !ruby/regexp /.+_spec.rb$/

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in magicseaweed.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    magicseaweed (0.1.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.8)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.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.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.64.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.5)
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  magicseaweed!
+  pry (~> 0.12.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.64.0)
+  rubocop-rspec (~> 1.0)
+  webmock (~> 3.5.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Paul Williams
+
+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,45 @@
+# Magicseaweed CLI · [![License](https://badgen.net/badge/license/MIT/blue)](https://github.com/papa-whisky/magicseaweed/blob/master/LICENSE.txt) [![RubyGems](https://badgen.net/rubygems/v/magicseaweed)](https://rubygems.org/gems/magicseaweed) [![CircleCI](https://badgen.net/circleci/github/papa-whisky/magicseaweed/master)](https://circleci.com/gh/papa-whisky/magicseaweed/tree/master)
+
+[![Powered by Magicseaweed](https://im-1-uk.msw.ms/msw_powered_by.png)](https://magicseaweed.com)
+
+Check surf forecasts from [Magicseaweed](https://magicseaweed.com) in your terminal.
+
+## Requirements
+
+- [Ruby](https://www.ruby-lang.org/en) ~> 2.6
+
+(I'm sure it will run in many earlier versions as well, but haven't tested.)
+
+## Installation
+
+```console
+$ gem install magicseaweed
+Successfully installed magicseaweed-0.1.0
+```
+
+## Usage
+
+To view a basic star-rating forecast for a given spot for the next five days:
+
+```console
+$ magicseaweed API_KEY SPOT_ID
+Spot: SPOT_ID
+Forecast:
+Thu: ***, Fri: **, Sat: **, Sun: **, Mon:
+```
+
+To get an API key you'll need to contact Magicseaweed, there's more info on their [developer page](https://magicseaweed.com/developer/api).
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/papa-whisky/magicseaweed](https://github.com/papa-whisky/magicseaweed).
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'magicseaweed'
+require 'pry'
+
+Pry.start

data/bin/magicseaweed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'magicseaweed'
+
+Magicseaweed::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/magicseaweed.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'magicseaweed/cli'
+require 'magicseaweed/version'

data/lib/magicseaweed/api_client.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
+module Magicseaweed
+  # Call the Magicseaweed API
+  class APIClient
+    class Error < StandardError; end
+
+    HOST = 'magicseaweed.com'
+
+    def initialize(api_key:, units: nil)
+      @api_key = api_key
+      @units = units
+    end
+
+    def get_forecast(spot_id:, fields: nil)
+      @spot_id = spot_id
+      @fields = fields
+
+      Net::HTTP.get_response(forecast_uri).then(&method(:handle_response))
+    end
+
+    private
+
+    attr_reader :api_key
+    attr_reader :units
+    attr_reader :spot_id
+    attr_reader :fields
+
+    def forecast_uri
+      URI::HTTPS.build(
+        host: HOST,
+        path: api_path + '/forecast',
+        query: spot_id_query + fields_query + units_query
+      )
+    end
+
+    def api_path
+      "/api/#{api_key}"
+    end
+
+    def spot_id_query
+      "spot_id=#{spot_id}&"
+    end
+
+    def fields_query
+      return '' unless fields
+
+      "fields=#{[fields].flatten.join(',')}&"
+    end
+
+    def units_query
+      return '' unless units
+
+      "units=#{units}&"
+    end
+
+    def handle_response(response)
+      raise Error, response.msg unless response.is_a? Net::HTTPSuccess
+
+      body = JSON.parse(response.body)
+
+      # The Magicseaweed API annoyingly returns error messages with a 200 status
+      # code, so check for that before returning the body
+      if body.is_a?(Hash) && body.key?('error_response')
+        raise Error, body['error_response']['error_msg']
+      end
+
+      body
+    end
+  end
+end

data/lib/magicseaweed/cli.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'magicseaweed/forecast'
+require 'thor'
+
+module Magicseaweed
+  # Define commands for CLI
+  class CLI < Thor
+    desc 'forecast API_KEY SPOT_ID', 'print a forecast for SPOT_ID'
+    def forecast(api_key, spot_id)
+      forecast = Magicseaweed::Forecast.new(api_key: api_key, spot_id: spot_id)
+      puts forecast
+    end
+  end
+end

data/lib/magicseaweed/forecast.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'magicseaweed/api_client'
+
+module Magicseaweed
+  # Generate a forecast to be printed
+  class Forecast
+    def initialize(api_key:, spot_id:)
+      @api_key = api_key
+      @spot_id = spot_id
+    end
+
+    def to_s
+      "Spot: #{spot_id}\nForecast:\n#{daily_ratings.join(', ')}"
+    end
+
+    private
+
+    attr_reader :api_key
+    attr_reader :spot_id
+
+    def daily_ratings
+      midday_ratings.map do |rating|
+        day_of_week(rating['localTimestamp']) +
+          ': ' +
+          ('*' * rating['solidRating'])
+      end
+    end
+
+    def midday_ratings
+      forecast.select do |forecast|
+        Time.at(forecast['localTimestamp']).utc.hour == 12
+      end
+    end
+
+    def forecast
+      api_client
+        .get_forecast(spot_id: spot_id, fields: %i[localTimestamp solidRating])
+    end
+
+    def api_client
+      Magicseaweed::APIClient.new(api_key: api_key)
+    end
+
+    def day_of_week(local_timestamp)
+      Time.at(local_timestamp).utc.strftime('%a')
+    end
+  end
+end

data/lib/magicseaweed/version.rb

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

data/magicseaweed.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magicseaweed/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'magicseaweed'
+  s.version  = Magicseaweed::VERSION
+  s.summary  = 'Magicseaweed surf reports via CLI.'
+  s.homepage = 'https://github.com/papa-whisky/magicseaweed'
+  s.author   = 'Paul Williams'
+  s.email    = 'paul@pdwilliams.net'
+  s.license  = 'MIT'
+
+  s.executables = 'magicseaweed'
+  s.files       = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+                     .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  s.add_dependency 'thor'
+
+  s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_development_dependency 'pry', '~> 0.12.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rubocop', '~> 0.64.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.0'
+  s.add_development_dependency 'webmock', '~> 3.5.0'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: magicseaweed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.64.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.64.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: 
+email: paul@pdwilliams.net
+executables:
+- magicseaweed
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/magicseaweed
+- bin/setup
+- lib/magicseaweed.rb
+- lib/magicseaweed/api_client.rb
+- lib/magicseaweed/cli.rb
+- lib/magicseaweed/forecast.rb
+- lib/magicseaweed/version.rb
+- magicseaweed.gemspec
+homepage: https://github.com/papa-whisky/magicseaweed
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Magicseaweed surf reports via CLI.
+test_files: []