common_tools 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2a95d74e5f492d7ceb125c348f2655fd419c312
-  data.tar.gz: 9d5ce6bd8169aed65d8c1fda6602c0d0dc954cda
+  metadata.gz: 32d15df00510dd6daa5eb7d0e2265333d4372df1
+  data.tar.gz: e9bedae78696baf4936d23ba8f7599faeb7e9def
 SHA512:
-  metadata.gz: 5714ec808ddd6e4449aecaa335e7d339c14184ac11126f302195407833aacb3a4ee212634e2e667fd1935abb3b77e748ca3ded327d4431151279f403b0e2461e
-  data.tar.gz: 307f7b03346ebc080cc6f2ce7e9ccd62f73d3b6b3a3f31ac82fdb76232f74a257f2ebe424639b694799afa183e3cc26e96710bbd29538579be504d31d6f76470
+  metadata.gz: 294d4912767ccf1a2d7c7121e70e99d40bfab4630b1af16171e6cd8f1beedb93a6401006b21cf6f4716836e572d57304344f7afb40fe8bef9c64b03b21bbdca2
+  data.tar.gz: f9eb17609998102eae12fdd5c7d7c4fe237d5cc6d85dfc3d2d1f9eb42d9b5914ff331045ff2fd147465fd355222da124025cbc520e4e9d5b49678f26bc77d4fd

data/README.md

@@ -1,28 +1,55 @@
 # Instructor Tools: Common Tools
 
-Welcome to the instructor tools Common Tools gem. This gem will exist as a dependency of [Instructor-Tools](https://github.com/flatiron-labs/Instructor-tools-gem). 
+Welcome to the instructor tools Common Tools gem. This gem will exist as a dependency of [Instructor-Tools](https://github.com/flatiron-labs/Instructor-tools-gem).
 
-The purpose of this gem is to provide instructors with a resource for commonly used tools (parsing a batch csv into student objects) that can be required as a dependency instead of re-writing the same code. 
+The purpose of this gem is to provide instructors with a resource for commonly used tools, for example:
 
-##Instructions
+- Building Cohort Data
+- Building Student Data
 
-To include this gem add the below line to your projects gemfile: 
+Instead of instructors re-writing the same code in their projects, `CommonTools` gem can be required as a dependency in projects that need these common functionalities.
 
-```
-gem 'instructor-tools-common-tools'
-```
+The Gem sends a request to Learn API endpoint of the given batch, parses string payload into a array of student hashes.
+
+You will be asked for your github credentials the first time you run the gem. Your Github credentials is stored in a `client.yml`, which is in the gem's lib directory  and git-ignored.
+
+
+##Using the gem in another project
+Public-facing code is the `CommonTools` module.
+
+
+#####For inclusion in a gem:
+
+- add "common_tools" as a dependency in gemspec file
+
+
+#####For inclusion in a Rails app:
+- add `gem 'common_tools'` to project gemfile
+
+
+##Functionality
+This gem contains several functions.  Specific details are listed below:
+
+- `batch_id` refers to the last 2 or more digits in the learn-url of a batch. For example: The url for Web-1115 is `https://learn.co/batches/168`. Therefore `batch-id` for Web-115 is 168
+
+#### Two ways to run the gem:
+- `bin/console`
+  - This drops you into an interactive irb session.
+  - The command `CommonTools::Generator.get_batch(batch_id)` return an array of student hashes. You can use this data to build your own student or batch objects
+
+
+- `exe/common-tools batch_id`
+  - will return an array of student hashes
+  - receives batch-id as an argument and returns an array of student hashes.
+
+##Testing
+Make sure all new features are built TDD first.
 
-###Functionality
-This gem contains several functions see below for specific details
 
-* CSV to JSON Parser 
-	* `CommonTools.parse_csv('complete/path/to/file')`
-	* This will parse your csv file into a JSON string     
-    
 ## Contributing
-To contribute to this gem: 
+To contribute to this gem:
 
 * Fork the [repo](https://github.com/flatiron-labs/instructor-tools-common-tools)
 * Make your contributions and set up whatever tests are necessary
 * Wrap any new functionality in `CommonTools` class methods
-* Submit a pull request
+* Submit a pull request

data/common_tools.gemspec

@@ -6,8 +6,8 @@ require 'common_tools/version'
 Gem::Specification.new do |spec|
   spec.name          = "common_tools"
   spec.version       = CommonTools::VERSION
-  spec.authors       = ["BenjaGross"]
-  spec.email         = ["ben@flatironschool.com"]
+  spec.authors       = ["MsUzoAgu", "BenjaGross", "SophieDeBenedetto"]
+  spec.email         = ["uzo@flatironschool.com", "ben@flatironschool.com", "sophie.debenedetto@gmail.com"]
 
   spec.summary       = %q{Common Tools and scripts for Flatiron School Instructors}
   spec.description   = %q{Includes often used scripts to help Flatiron School instructors}
@@ -18,6 +18,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "mechanize"
 end

data/exe/common-tools

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require_relative '../lib/common_tools'
+
+if ARGV.length >=1
+  PP.pp CommonTools::Generator.get_batch(ARGV[0].to_i)
+elsif ARGV.include?("--help")
+  CommonTools::Generator.new.help
+else
+  puts "please use common_tools --help for a list of options"
+end

data/lib/common_tools/batch_generator.rb

@@ -0,0 +1,2 @@
+class BatchGenerator
+end

data/lib/common_tools/data_fetcher.rb

@@ -0,0 +1,43 @@
+class DataFetcher
+
+  attr_accessor :batch_id, :keys, :client
+
+  def initialize(batch_id=nil)
+    @batch_id = batch_id
+  end
+
+  def parse_roster
+    roster = get_roster
+    Parser.parse_roster(roster)
+  end
+
+
+  def get_roster
+    configure_keys
+    configure_credentials
+    @client.csv_for(self.batch_id)
+  end
+
+  private
+
+
+  def get_and_store_github_credentials
+    puts "Please enter your github username:"
+    username = STDIN.gets.chomp
+    puts "Please enter your github password:"
+    password = STDIN.gets.chomp
+    self.keys = {"GITHUB_USERNAME" => username, "GITHUB_PASSWORD" => password}
+    File.open(File.expand_path(File.dirname(__FILE__)) + '/credentials.yml', 'w') {|f| f.write self.keys.to_yaml }
+  end
+
+  def configure_keys
+    keys = YAML.load_file(File.expand_path(File.dirname(__FILE__)) + '/credentials.yml')
+    get_and_store_github_credentials unless keys
+  end
+
+  def configure_credentials
+    keys = YAML.load_file(File.expand_path(File.dirname(__FILE__)) + '/credentials.yml')
+    credentials = LearnProxy::Credentials.new(keys['GITHUB_USERNAME'],  keys['GITHUB_PASSWORD'])
+    @client = LearnProxy::Client.new(credentials)
+  end
+end

data/lib/common_tools/learn_proxy.rb

@@ -0,0 +1,64 @@
+require 'pry'
+require "mechanize"
+
+
+module LearnProxy
+  class Client
+    CSV_URL = -> (batch_id) {"https://learn.co/batches/#{batch_id}/students.csv"}
+
+    def initialize(credentials)
+      @credentials = credentials
+    end
+
+    def csv_for(batch_id)
+      connection.get(CSV_URL[batch_id]).body
+    end
+
+    private
+    attr_reader :credentials
+
+    def connection
+      @connection ||= Connection.new(credentials)
+    end
+  end
+
+  class Connection
+    extend Forwardable
+    def_delegator :@session, :get
+
+    def initialize(credentials)
+      @credentials = credentials
+      connect!
+    end
+
+    private
+    attr_reader :credentials
+    def connect!
+      @session ||= begin
+        Mechanize.new.tap do |client|
+          client.get('https://learn.co/sign_in/github?sign_in=true')
+          form = client.page.form_with!(action: "/session")
+          GithubForm.submit(form, credentials)
+          client.page.link_with!(href: /learn\.co/).click
+        end
+      end
+    end
+  end
+
+  module GithubForm
+    def self.submit(form, credentials)
+      form['login'] = credentials.username
+      form['password'] = credentials.password
+      form.submit
+    end
+  end
+
+  class Credentials
+    attr_accessor :username, :password
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+  end
+end
+

data/lib/common_tools/parser.rb

@@ -1,19 +1,20 @@
-require 'csv'
-require 'json'
-require 'pry'
-require_relative 'student'
-
 class Parser
 
-  def self.build_batch(file)
-    headers = CSV.read(file, headers: true).headers
-    Student.build_attributes(headers)
-    CSV.foreach(file, headers: true).map do |row|
-      make_student_attributes(row) unless row[0] == "first_name" || row[0].nil?
-    end.to_json
+  def self.build_attributes(roster)
+    attributes_string = roster.split(/\n/).reject(&:empty?).delete_at(0)
+    attributes_array = attributes_string.split(/\n/).first.split(',').collect {|attribute| attribute.to_sym}
   end
 
-  def self.make_student_attributes(row)
-    Student.new(row.to_h)
+  def self.parse_roster(roster)
+    attributes_array = build_attributes(roster)
+    student_strings = roster.split(/\n/).reject(&:empty?).drop(1)
+    array_of_student_hashes = []
+
+    array_of_students = student_strings.collect { |student_string| student_string.split(',') }
+
+    array_of_students.each_with_object(attributes_array) do |student_array, attribute_hash|
+      array_of_student_hashes << [attribute_hash, student_array].transpose.to_h
+    end
+    array_of_student_hashes
   end
 end

data/lib/common_tools/version.rb

@@ -1,3 +1,3 @@
-class CommonTools
-  VERSION = "0.1.1"
+module CommonTools
+  VERSION = "0.1.2"
 end

data/lib/common_tools.rb

@@ -1,13 +1,15 @@
 require_relative "common_tools/version"
-require_relative "common_tools/say_hello"
+require_relative "common_tools/learn_proxy"
+require_relative "common_tools/batch_generator"
+require_relative "common_tools/data_fetcher"
 require_relative "common_tools/parser"
 
+module CommonTools
 
-class CommonTools
-  extend SayHello
-
-  def self.parse_csv(csv_file)
-    Parser.build_batch(csv_file)
+  class Generator
+    def self.get_batch(batch_id)
+      batch= DataFetcher.new(batch_id).get_roster
+      Parser.parse_roster(batch)
+    end
   end
-
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: common_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
+- MsUzoAgu
 - BenjaGross
+- SophieDeBenedetto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2016-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,10 +40,83 @@ dependencies:
     - - "~>"
       - !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Includes often used scripts to help Flatiron School instructors
 email:
+- uzo@flatironschool.com
 - ben@flatironschool.com
-executables: []
+- sophie.debenedetto@gmail.com
+executables:
+- common-tools
 extensions: []
 extra_rdoc_files: []
 files:
@@ -54,10 +129,13 @@ files:
 - bin/console
 - bin/setup
 - common_tools.gemspec
+- exe/common-tools
 - lib/common_tools.rb
+- lib/common_tools/batch_generator.rb
+- lib/common_tools/credentials.yml
+- lib/common_tools/data_fetcher.rb
+- lib/common_tools/learn_proxy.rb
 - lib/common_tools/parser.rb
-- lib/common_tools/say_hello.rb
-- lib/common_tools/student.rb
 - lib/common_tools/version.rb
 homepage: https://github.com/flatiron-labs/instructor-tools-common-tools
 licenses: []
@@ -78,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Common Tools and scripts for Flatiron School Instructors

data/lib/common_tools/say_hello.rb

@@ -1,7 +0,0 @@
-module SayHello
-
-  def say_hello(name)
-    "Hello #{name}"
-  end
-
-end

data/lib/common_tools/student.rb

@@ -1,22 +0,0 @@
-require 'json'
-class Student
-
-  def initialize(args)
-    args.each do |key, value|
-      self.public_send("#{key}=", value )
-    end
-  end
-
-  def self.build_attributes(headers)
-    headers.each do |header| 
-      attr_accessor header.to_sym
-    end
-  end
-
-  def to_json(args)
-    hash = {}
-    self.instance_variables.each{ |var| hash[var.to_s.delete("@")] = self.instance_variable_get(var) }
-    hash.to_json
-  end
-
-end