learn-status 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fa1b5a5f78a9c86f096e93e41619ba64fbcd10d
+  data.tar.gz: e7ff53169a66fea55c3ec52a8391194e4cb22f78
+SHA512:
+  metadata.gz: 1e4187be9a26f7d2714d24f8831250f4dc2254dc21a71ede9dbee361fcf0a30166e4fafce22992cd577bd0c6a60e3940b0c077b8ca98f1842571ba0e37a1f084
+  data.tar.gz: 92acce8efee30574d7bba067fd3fbc8adb3ebce12e4ab0094fbbddf9bf000064f5540da8ca9fd9139f63815cbfeb955c75a085f9a79c3f065e5d0978f07b79d1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in learn-status.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Flatiron School
+
+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,37 @@
+# learn-status
+
+Gets your current lesson status from Learn.co.
+
+## Installation
+
+Install with:
+
+```
+$ gem install learn-status
+```
+
+Alternatively, add this line to your application's Gemfile:
+
+```ruby
+gem 'learn-status'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In your code:
+
+```ruby
+require 'learn_status'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/flatiron-labs/learn-status/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "learn/status"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/learn-status

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'learn_status'
+
+LearnStatus::Report.generate

data/learn-status.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'learn_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "learn-status"
+  spec.version       = LearnStatus::VERSION
+  spec.authors       = ["Flatiron School"]
+  spec.email         = ["learn@flatironschool.com"]
+
+  spec.summary       = %q{Gets your current status from Learn.co}
+  spec.homepage      = "https://learn.co"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "exe"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "netrc"
+  spec.add_runtime_dependency "colorize"
+  spec.add_runtime_dependency "learn-web", ">= 1.2.0"
+end

data/lib/learn_status.rb

@@ -0,0 +1,9 @@
+require 'netrc'
+require 'colorize'
+require 'learn_web'
+
+require 'learn_status/version'
+require 'learn_status/report'
+
+module LearnStatus
+end

data/lib/learn_status/report.rb

@@ -0,0 +1,34 @@
+require 'learn_status/report/formatter'
+
+module LearnStatus
+  class Report
+    attr_reader   :client
+    attr_accessor :status
+
+    def initialize
+      _login, token = Netrc.read['learn-config']
+      @client       = LearnWeb::Client.new(token: token)
+    end
+
+    def self.generate
+      new.generate
+    end
+
+    def generate
+      get_status
+      generate_report
+    end
+
+    private
+
+    def get_status
+      puts 'Getting current status...'
+      self.status = client.current_status
+    end
+
+    def generate_report
+      formatted_report = LearnStatus::Report::Formatter.new(status).execute
+      puts formatted_report.printable_output
+    end
+  end
+end

data/lib/learn_status/report/formatter.rb

@@ -0,0 +1,76 @@
+module LearnStatus
+  class Report
+    class Formatter
+      attr_reader   :status
+      attr_accessor :lights
+
+      extend Forwardable
+
+      def_delegators :status, :title, :started, :students_working,
+                     :median_completion_time
+
+      def initialize(status)
+        @status = status
+      end
+
+      def execute
+        build_lights_status
+
+        self
+      end
+
+      def printable_output
+        <<-OUTPUT
+
+Current Lesson: #{title}
+Started: #{started}
+Students Working: #{students_working}
+Median Completion Time: #{median_completion_time}
+
+#{lights_output}
+        OUTPUT
+      end
+
+      private
+
+      def lights_output
+        output = ''
+
+        self.lights.each do |light|
+          output << "#{light[:title]}: "
+
+          if light[:color]
+            output << '●'.send(light[:color])
+          else
+            output << 'x'
+          end
+
+          if light[:tests]
+            output << " (Passing: #{light[:tests][:passing]} / Failing: #{light[:tests][:passing]})"
+          end
+
+          output << "\n"
+        end
+
+        output
+      end
+
+      def build_lights_status
+        self.lights = status.lights.map do |light|
+          {
+            title: light[:type].split('_').map(&:capitalize).join(' '),
+            color: if light[:started]
+              light[:passing] ? :green : :red
+            end,
+            tests: if light[:tests_passing]
+              {
+                passing: light[:tests_passing],
+                failing: light[:tests_failing]
+              }
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/learn_status/version.rb

@@ -0,0 +1,3 @@
+module LearnStatus
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: learn-status
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Flatiron School
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: netrc
+  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: colorize
+  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: learn-web
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: 
+email:
+- learn@flatironschool.com
+executables:
+- learn-status
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/learn-status
+- learn-status.gemspec
+- lib/learn_status.rb
+- lib/learn_status/report.rb
+- lib/learn_status/report/formatter.rb
+- lib/learn_status/version.rb
+homepage: https://learn.co
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- exe
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Gets your current status from Learn.co
+test_files: []