fis 0.1.1

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module FIS
+  module CLI
+    module Commands
+      # `auth whoami` - Requests details about the authenitcated user
+      class Whoami < Command
+        def execute
+          user = FIS.client.user.me
+
+          FIS.ui.newline
+          
+          FIS.ui.ok 'Account Information:'
+          FIS.ui.newline
+          FIS.ui.print_table([
+            ['Name:', user.full_name],
+            ['Email:', user.email],
+            ['Username:', user.username],
+            ['Flatiron UUID:', user.learn_uuid],
+            ['GitHub User ID:', user.github_uid.to_s] # .to_s for appropriate formatting
+          ])
+
+          FIS.ui.newline
+
+          FIS.ui.ok 'Account Status:'
+          FIS.ui.newline
+          FIS.ui.print_table([
+            ['Verified?', user.learn_verified_user],
+            ['Can Start Working?', user.can_start_working]
+          ])
+        end
+      end
+    end
+  end
+end

data/lib/fis/client/base.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module FIS
+  module Client
+    class Base
+      BASE_URL = ENV.fetch('FIS_CLIENT_BASE_URL', 'https://portal.flatironschool.com')
+      API_ROOT = '/api/v1'
+
+      CLIENT_ERROR_STATUSES = [400, 401, 403, 407, 422].freeze
+      SERVER_ERROR_STATUSES = (500..511).to_a.freeze
+
+      ERROR_STATUSES = (CLIENT_ERROR_STATUSES + SERVER_ERROR_STATUSES).freeze
+
+      attr_reader :client
+
+      def initialize(token:)
+        url = [BASE_URL, API_ROOT].join
+
+        @client = Faraday.new(url: url) do |conn|
+          conn.authorization :Bearer, token
+
+          conn.response :json, 
+                        content_type: 'application/json',
+                        parser_options: {
+                          object_class: OpenStruct 
+                        }
+          
+          conn.request :retry,
+                       max: 3,
+                       interval: 2,
+                       interval_randomness: 0.5,
+                       backoff_factor: 2,
+                       methods: Faraday::Request::Retry::IDEMPOTENT_METHODS + [:post],
+                       retry_statuses: ERROR_STATUSES,
+                       exceptions: Faraday::Request::Retry::DEFAULT_EXCEPTIONS
+
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      def valid_token?
+        !!user.data
+      end
+
+      def user
+        @user ||= User.new(base: self)
+      end
+    end
+  end
+end

data/lib/fis/client/user.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FIS
+  module Client
+    class User
+      def initialize(base:)
+        @base = base
+      end
+
+      def me
+        @base.client.get('users/me').body
+      end
+    end
+  end
+end

data/lib/fis/command.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module FIS
+  # Inheritable helpers for common command tasks
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require 'tty-file'
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager(**options)
+      require 'tty-pager'
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require 'tty-platform'
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require 'tty-screen'
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which(*args)
+      require 'tty-which'
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist?(*args)
+      require 'tty-which'
+      TTY::Which.exist?(*args)
+    end
+  end
+end

data/lib/fis/configuration.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module FIS
+  # Handles the global configuration of the gem via ~/.flatiron-school/configuration.yml
+  class Configuration
+    attr_reader :file_path, :file_name, :file_full_path, :config
+
+    def initialize
+      @file_path = File.join(Dir.home, '.flatiron-school')
+      @file_name = 'configuration.yml'
+      @file_full_path = File.join(@file_path, @file_name)
+
+      @config = read
+    end
+
+    def fetch(*keys)
+      key = keys.pop
+      keys.inject(@config, :fetch)[key]
+    end
+
+    def set(*keys)
+      key = keys.pop
+      keys.inject(@config, :fetch)[key] = yield
+
+      write!
+    end
+
+    def unset(*keys)
+      set(*keys) do
+        key = keys.pop
+        keys.inject(default, :fetch)[key]
+      end
+    end
+
+    def read
+      return default unless File.exist?(@file_full_path)
+
+      deep_merge(
+        default,
+        YAML.safe_load(
+          File.open(@file_full_path).read,
+          [Symbol]
+        )
+      )
+    end
+
+    def reread
+      @config = read
+    end
+
+    def write!
+      Dir.mkdir(@file_path, 0o700) unless Dir.exist?(@file_path)
+
+      File.open(@file_full_path, 'w') do |file|
+        yaml = deep_merge(default, @config).to_yaml
+        file.write(yaml)
+      end
+    end
+
+    private
+
+    def default
+      {
+        identity: {
+          portal: {
+            token: nil
+          },
+          github: {
+            id: nil,
+            username: nil
+          }
+        }
+      }
+    end
+
+    def deep_merge(this_hash, other_hash)
+      this_hash.merge(other_hash) do |_key, this_val, other_val|
+        if this_val.is_a?(::Hash) && other_val.is_a?(::Hash)
+          deep_merge(this_val, other_val)
+        else
+          other_val
+        end
+      end
+    end
+  end
+end

data/lib/fis/ui.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module FIS
+  # Class responsible for displaying different level information
+  class UI
+    extend Forwardable
+
+    def_delegators :@prompt, :ok, :ask, :mask, :suggest
+
+    def initialize(prompt)
+      @prompt = prompt
+      @debug = ENV['DEBUG']
+      @shell = Thor::Shell::Basic.new
+    end
+
+    def newline(num = 1)
+      @prompt.say("\n" * num)
+    end
+
+    def info(message)
+      @prompt.say(message)
+    end
+
+    def warn(message)
+      @prompt.warn(message)
+    end
+
+    def error(message)
+      @prompt.error(message)
+    end
+
+    def debug(error, newline = nil)
+      return unless @debug
+
+      message = ["#{error.class}: #{error.message}", *error.backtrace]
+      @prompt.say(newline ? message.join("\n") : message)
+    end
+
+    def debug!
+      @debug = true
+    end
+
+    def print_table(table, options = {})
+      @shell.print_table(table, options)
+    end
+
+    def print_link(title, url)
+      @prompt.say(format_link(title, url))
+    end
+
+    def format_link(title, url)
+      TTY::Link.link_to(title, url)
+    end
+  end
+end

data/lib/fis/version.rb

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

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: fis
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tom Milewski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tty-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: tty-link
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: The command line interface to Flatiron School services.
+email:
+- tmilewski@gmail.com
+executables:
+- fis
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".envrc.example"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cucumber.yml
+- exe/fis
+- fis.gemspec
+- lib/fis.rb
+- lib/fis/auth.rb
+- lib/fis/auth/client.rb
+- lib/fis/auth/runner.rb
+- lib/fis/auth/server.rb
+- lib/fis/cli.rb
+- lib/fis/cli/auth.rb
+- lib/fis/cli/commands/login.rb
+- lib/fis/cli/commands/logout.rb
+- lib/fis/cli/commands/whoami.rb
+- lib/fis/client/base.rb
+- lib/fis/client/user.rb
+- lib/fis/command.rb
+- lib/fis/configuration.rb
+- lib/fis/ui.rb
+- lib/fis/version.rb
+homepage: https://portal.flatironschool.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://portal.flatironschool.com
+  source_code_uri: https://github.com/tmilewski/fis
+  changelog_uri: https://github.com/tmilewski/fis/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: The command line interface to Flatiron School services.
+test_files: []