Intial commit

Author: patch0

Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+ruby '>= 3.0'
+
+gem 'faraday'
+gem 'sinatra'
+gem 'webrick'

Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    rack (2.2.7)
+    rack-protection (3.0.6)
+      rack
+    ruby2_keywords (0.0.5)
+    sinatra (3.0.6)
+      mustermann (~> 3.0)
+      rack (~> 2.2, >= 2.2.4)
+      rack-protection (= 3.0.6)
+      tilt (~> 2.0)
+    tilt (2.1.0)
+    webrick (1.8.1)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  faraday
+  sinatra
+  webrick
+
+RUBY VERSION
+   ruby 3.2.2p53
+
+BUNDLED WITH
+   2.4.13

README.md

@@ -0,0 +1,68 @@
+# RPF apprentice software engineer challenge
+
+This is a little application, written in [Ruby](https://ruby-lang.org), using the [Sinatra](https://sinatrarb.com/) framework.  It allows users to see the whereabouts of the International Space Station, using the [OpenNotify APIs](http://api.open-notify.org/).
+
+## What we're expecting
+
+* You should spend 2-3 hours on this challenge, and attempt all three tasks.
+* Please send back your code by the end of Sunday 4th June, either as a link to a Github/Gitlab repo, or a zip/tar of your code.
+
+We understand that you will have other commitments and time constraints, please let us know as soon as possible if you will be unable to complete this task by 4th June, so we are able to make allowances.
+
+It is important to attempt the tasks, even if you don't finish them.
+
+If you need help with the task, for whatever reason, please drop us an email and we will do our best to assist.
+
+## Tasks
+
+1. Build a page to show the current astronauts that are in space, using the `OpenNotify#astros` method.
+2. Style the application using HTML and CSS to allow the information to be presented clearly.
+3. Add new endpoints, or modify the existing ones, to return the ISS position data as JSON, instead of an HTML page.
+   e.g. `http://localhost:4567/iss_position.json` should return JSON in the following format:
+
+```json
+{"iss_position": {"longitude": "-3.4941", "latitude": "-37.5113"}, "timestamp": 1684502291, "message": "success"}
+```
+
+## Getting started
+
+Firstly you'll want to download and unzip the code into a directory or folder of your choice.
+
+Next if you've not already got Ruby, you'll need to [install it](https://www.ruby-lang.org/en/documentation/installation/).  There are a number of different ways to do it depending on your operating system.  **NB** Apple Macs already have it installed, but the version is quite old, so we'd recommend installing a more up-to-date one.
+
+Once you've installed ruby, you can install the dependencies for this project in a terminal.  You should open a terminal in the directory or folder where your code has been checked out.
+
+```shell
+bundle config path vendor/bundle
+bundle install
+```
+
+Then to start it:
+
+```shell
+bundle exec ruby app.rb
+```
+
+and you should be able to see it at http://localhost:4567.  **NB** When you make changes to your code, you'll need to stop the app, using `ctrl+c` and then restart it using the same command above.
+
+## Layout
+
+* `app.rb` - Our Sinatra application
+* `open_notify.rb` - OpenNotify library
+* `Gemfile` - list of Ruby libraries (gems) that our app depends on.
+* `Gemfile.lock` - automatically generated "lockfile" for our dependencies.
+* `public/` - directory where "static" assets, e.g. images, CSS files can be kept.
+* `data/` - directory with static data from OpenNotify to allow development without internet access.
+* `views/` - directory containg the views (templates) for use by Sinatra.  These are all using `erb`.
+
+## Useful documentation
+
+* [Getting started with Sinatra](https://sinatrarb.com/intro.html)
+* Various useful Ruby classes and modules:
+  * [Array](https://ruby-doc.org/3.2.2/Array.html)
+  * [Hash](https://ruby-doc.org/3.2.2/Hash.html)
+  * [String](https://ruby-doc.org/3.2.2/String.html)
+  * [Comparable](https://ruby-doc.org/3.2.2/Comparable.html) (handy if you're sorting things)
+  * [Enumerable](https://ruby-doc.org/3.2.2/Enumerable.html) (full of useful methods that both Hash and Array can use)
+* [ERB Templating](https://ruby-doc.org/3.2.2/stdlibs/erb/ERB.html)
+

app.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# myapp.rb
+require 'sinatra'
+require_relative 'open_notify'
+
+# Allow our templates in views/ to end in `.html.erb`
+Tilt.register Tilt::ERBTemplate, 'html.erb'
+
+set :layout, 'views/layout.html.erb'
+
+get '/' do
+  erb :index
+end
+
+get '/position' do
+  iss_now = OpenNotify.iss_now
+
+  erb :position, locals: { data: iss_now }
+end

data/astros.json

@@ -0,0 +1 @@
+{"message": "success", "number": 10, "people": [{"craft": "ISS", "name": "Sergey Prokopyev"}, {"craft": "ISS", "name": "Dmitry Petelin"}, {"craft": "ISS", "name": "Frank Rubio"}, {"craft": "Shenzhou 15", "name": "Fei Junlong"}, {"craft": "Shenzhou 15", "name": "Deng Qingming"}, {"craft": "Shenzhou 15", "name": "Zhang Lu"}, {"craft": "ISS", "name": "Stephen Bowen"}, {"craft": "ISS", "name": "Warren Hoburg"}, {"craft": "ISS", "name": "Sultan Alneyadi"}, {"craft": "ISS", "name": "Andrey Fedyaev"}]}

data/iss-now.json

@@ -0,0 +1 @@
+{"iss_position": {"longitude": "-3.4941", "latitude": "-37.5113"}, "timestamp": 1684502291, "message": "success"}

open_notify.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'faraday'
+
+# Fetch data from the OpenNotify API service at
+# http://api.open-notify.org/
+#
+# To allow this to work without internet access, the read data method just
+# loads and parses the data
+module OpenNotify
+  BASE_DIR = __dir__
+
+  def iss_now
+    fetch_data(api: 'iss-now')
+  end
+
+  def astros
+    fetch_data(api: 'astros')
+  end
+
+  # This method would really fetch data from the live API, but for our
+  # purposes, a static file makes sense.
+  def fetch_data(api:)
+    if ENV['USE_LIVE_DATA'] == 'yes'
+      conn = Faraday.new('http://api.open-notify.org/') do |f|
+        f.response :json
+      end
+
+      conn.get("#{api}.json").body
+    else
+      filepath = File.join(BASE_DIR, 'data', "#{api}.json")
+      JSON.parse(File.read(filepath))
+    end
+  end
+
+  module_function :iss_now, :astros, :fetch_data
+end

public/favicon.ico

@@ -0,0 +1,4 @@
+<h1>RPF software engineer apprentice challenge 🚀</h1>
+<ul>
+  <li><a href='position'>Where is the ISS? 🛰️</a></li>
+</ul>

views/index.html.erb

@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+  <head>
+    <title>RPF apprenticeship technical task</title>
+    <link rel="shortcut icon" href="/favicon.ico">
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>