fis 0.1.1

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'aruba/platform'
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+Cucumber::Rake::Task.new do |t|
+  t.profile = 'default'
+end
+
+Cucumber::Rake::Task.new('cucumber:wip', 'Run Cucumber features which are "WIP" and are allowed to fail') do |t|
+  t.profile = 'wip'
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fis'
+
+# 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/cucumber.yml

@@ -0,0 +1,7 @@
+<%
+std_opts = "--format pretty --color --exclude features/fixtures --require features --tags 'not @unsupported-on' --publish-quiet"
+ignore_opts = "--tags 'not @ignore'"
+%>
+
+default: <%= std_opts %> --tags 'not @wip' <%= ignore_opts %>
+wip: <%= std_opts %> --wip --tags @wip:5 <%= ignore_opts %>

data/exe/fis

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require 'fis'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  FIS::CLI::Base.start
+rescue FIS::CLI::Base::Error => e
+  puts "ERROR: #{e.message}"
+  exit 1
+end

data/fis.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/fis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fis'
+  spec.license       = 'MIT'
+  spec.version       = FIS::VERSION
+  spec.authors       = ['Tom Milewski']
+  spec.email         = ['tmilewski@gmail.com']
+
+  spec.summary       = 'The command line interface to Flatiron School services.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://portal.flatironschool.com'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/tmilewski/fis'
+  spec.metadata['changelog_uri'] = 'https://github.com/tmilewski/fis/releases'
+
+  # 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(__dir__)) 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_runtime_dependency 'faraday', '~> 1.1.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 1.0.0'
+  spec.add_runtime_dependency 'oauth2', '~> 1.4.4'
+  spec.add_runtime_dependency 'sinatra', '~> 2.1.0'
+  spec.add_runtime_dependency 'thin', '~> 1.7.2'
+  spec.add_runtime_dependency 'thor', '~> 1.0'
+  spec.add_runtime_dependency 'tty-config', '~> 0.4'
+  spec.add_runtime_dependency 'tty-link', '~> 0.1'
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.22'
+  spec.add_runtime_dependency 'zeitwerk', '~> 2.4.0'
+end

data/lib/fis.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+ENV['THOR_SILENCE_DEPRECATION'] = 'true'
+
+require 'faraday'
+require 'faraday_middleware'
+require 'learn_web'
+require 'logger'
+require 'oauth2'
+require 'sinatra/base'
+require 'thin'
+
+# TTY Libraries
+require 'tty-link'
+require 'tty-prompt'
+require 'tty-config'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.log! if ENV['DEBUG']
+loader.inflector.inflect 'fis' => 'FIS'
+loader.inflector.inflect 'cli' => 'CLI'
+loader.inflector.inflect 'ui' => 'UI'
+loader.setup
+
+# Entry point for the FIS CLI
+module FIS
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :ui
+
+    def ui
+      @ui ||= UI.new(TTY::Prompt.new)
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def client
+      @client ||= begin
+        token = config.fetch(:identity, :portal, :token)
+
+        if token.nil? || token.empty?
+          FIS.ui.newline
+          FIS.ui.error("You're not logged in. Please run `fis auth login` to continue.")
+          exit
+        end
+
+        Client::Base.new(token: token)
+      end
+    end
+  end
+end

data/lib/fis/auth.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FIS
+  module Auth
+    DEFAULT_CLIENT_ID = 'b04559b9a82e2077088af40009d02053b74ce06af361b171e04ee853cdf3c89a'
+
+    CLIENT_ID = ENV.fetch('FIS_OAUTH2_CLIENT_ID', DEFAULT_CLIENT_ID)
+    LOCAL_URI = ENV.fetch('FIS_OAUTH2_LOCAL_URI', 'http://localhost:4444')
+    PROVIDER_URL = ENV.fetch('FIS_OAUTH2_PROVIDER_URL', 'http://localhost:3000')
+    REDIRECT_URI = ENV.fetch('FIS_OAUTH2_REDIRECT_URI', "#{LOCAL_URI}/callback")
+  end
+end

data/lib/fis/auth/client.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# PKCE modifies the standard authorization code grant.
+# https://doorkeeper.gitbook.io/guides/ruby-on-rails/pkce-flow
+
+module FIS
+  module Auth
+    # OAuth2 + PKCE helper class for authenticating against portal.flatironschool.com
+    class Client
+      CODE_CHALLENGE_METHOD = 'S256'
+
+      def initialize
+        @client = OAuth2::Client.new(
+          Auth::CLIENT_ID,
+          nil,
+          site: Auth::PROVIDER_URL,
+          redirect_uri: Auth::REDIRECT_URI
+        )
+      end
+
+      def authorize_url
+        @client.auth_code.authorize_url(
+          code_challenge: code_challenge,
+          code_challenge_method: CODE_CHALLENGE_METHOD
+        )
+      end
+
+      def get_token(code:)
+        @client.auth_code.get_token(code, code_verifier: code_verifier)
+      end
+
+      private
+
+      def code_challenge
+        padded_result = Base64.urlsafe_encode64(Digest::SHA256.digest(code_verifier))
+        padded_result.split('=')[0] # Remove trailing '='
+      end
+
+      def code_verifier
+        @code_verifier ||= SecureRandom.hex(128)
+      end
+    end
+  end
+end

data/lib/fis/auth/runner.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FIS
+  module Auth
+    # Manages the local Sinatra/Thin server in a forked process
+    class Runner
+      def start
+        @pid = fork do
+          Thin::Logging.silent = true
+          Server.start!
+        end
+
+        Process.detach(@pid)
+      end
+
+      def stop
+        Process.kill('SIGINT', @pid) if @pid
+      end
+    end
+  end
+end

data/lib/fis/auth/server.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+
+module FIS
+  module Auth
+    # Local Sinatra server to respond to OAuth2 code requests.
+    class Server < Sinatra::Base
+      enable :raise_errors, :quiet
+      disable :sessions, :logging, :show_exceptions
+
+      set :bind, '127.0.0.1'
+      set :port, 4444
+
+      def initialize
+        @auth = FIS::Auth::Client.new
+        super(nil)
+      end
+
+      get '/' do
+        redirect @auth.authorize_url
+      end
+
+      get '/callback' do
+        auth = @auth.get_token(code: params[:code])
+
+        FIS.config.set(:identity, :portal, :token) { auth.token }
+
+        'Success! You may close this window and return to the CLI.'
+      rescue # rubocop:disable Style/RescueStandardError
+        'Authentication failure. Please try again from the CLI'
+      end
+    end
+  end
+end

data/lib/fis/cli.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module FIS
+  module CLI
+    # Root for all Thor CLI-based commands
+    class Base < Thor
+      Error = Class.new(StandardError)
+
+      def initialize(*args)
+        super
+
+        prompt = TTY::Prompt.new(enable_color: !options['no-color'])
+        FIS.ui = UI.new(prompt)
+        FIS.ui.debug! if options['verbose']
+      end
+
+      desc 'version', 'version information'
+      def version
+        puts "v#{FIS::VERSION}"
+      end
+      map %w[--version -v] => :version
+
+      desc 'auth', 'Leverage Authentication'
+      subcommand 'auth', FIS::CLI::Auth
+    end
+  end
+end

data/lib/fis/cli/auth.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module FIS
+  module CLI
+    # Authentication-related Thor subcommands
+    class Auth < Thor
+      desc 'login', 'Command description...'
+      method_option(
+        :help,
+        aliases: '-h',
+        type: :boolean,
+        desc: 'Display usage information'
+      )
+      def login(*)
+        if options[:help]
+          invoke :help, ['login']
+        else
+          FIS::CLI::Commands::Login.new(options).execute
+        end
+      end
+
+      desc 'logout', 'Command description...'
+      method_option(
+        :help,
+        aliases: '-h',
+        type: :boolean,
+        desc: 'Display usage information'
+      )
+      def logout(*)
+        if options[:help]
+          invoke :help, ['logout']
+        else
+          FIS::CLI::Commands::Logout.new(options).execute
+        end
+      end
+
+      desc 'whoami', 'Command description...'
+      method_option(
+        :help,
+        aliases: '-h',
+        type: :boolean,
+        desc: 'Display usage information'
+      )
+      def whoami(*)
+        if options[:help]
+          invoke :help, ['whoami']
+        else
+          FIS::CLI::Commands::Whoami.new.execute
+        end
+      end
+    end
+  end
+end

data/lib/fis/cli/commands/login.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module FIS
+  module CLI
+    module Commands
+      # `auth login` - Requests and adds the user's authentication credentials
+      class Login < Command
+        def initialize(options)
+          @options = options
+          @auth_local_server = FIS::Auth::Runner.new
+        end
+
+        def execute
+          # TODO: Allow for token to be set with a flag
+
+          FIS.ui.newline
+
+          return FIS.ui.error("You're already logged in. Please run `fis auth logout` to continue.") if logged_in?
+          return FIS.ui.warn('OAuth not available. Please set your token using the `--token` flag.') if remote_ide?
+
+          @auth_local_server.start
+
+          FIS.ui.info('Logging into your Flatiron School account...')
+          open_browser!
+
+          sleep 1 until token_accessible? # TODO: Timeout?
+
+          FIS.ui.newline
+
+          FIS.ui.ok("You've successfully logged in.")
+        ensure
+          @auth_local_server.stop
+        end
+
+        private
+
+        def logged_in?
+          FIS.config.fetch(:identity, :portal, :token)
+        end
+
+        def open_browser!
+          system('open', FIS::Auth::LOCAL_URI)
+        end
+
+        def remote_ide?
+          false # TODO: Check if in an environment without a browser
+        end
+
+        def token_accessible?
+          FIS.config.reread
+          token = FIS.config.fetch(:identity, :portal, :token)
+          !token.nil? && !token.empty?
+        end
+      end
+    end
+  end
+end

data/lib/fis/cli/commands/logout.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FIS
+  module CLI
+    module Commands
+      # `auth logout` - Removes the user's authentication credentials
+      class Logout < Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute
+          FIS.config.unset(:identity, :portal, :token)
+
+          FIS.ui.newline
+          FIS.ui.ok('You\'ve successfully logged out.')
+        end
+      end
+    end
+  end
+end