common_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0042d9af59bbb4270bbaefbcfd969cf6a7f3a3b9
+  data.tar.gz: 5b7e52deb4a1d5425e4d0eab153fe5ac523851bd
+SHA512:
+  metadata.gz: 39105abeb746297c768e0a8cdb55358408b09d569bc7e5c18140476938d681adaee95e0446d880dbb553c65076bb9b5d94b5a8075ccddd5f964db16718ab6e7f
+  data.tar.gz: 5c64ed6c7e8245e890c58a7f62fd642d10f11e16066023d19dfb721e0283733bfcf602599891e32bc90bd21afd0ce7f71e4a504b3a4000c25852b2f52490e1f7

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,28 @@
+# 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). 
+
+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. 
+
+##Instructions
+
+To include this gem add the below line to your projects gemfile: 
+
+```
+gem 'instructor-tools-common-tools'
+```
+
+###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: 
+
+* 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

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = %q{Common Tools and scripts for Flatiron School Instructors}
+  spec.description   = %q{Includes often used scripts to help instructors work}
+  spec.homepage      = "https://github.com/flatiron-labs/instructor-tools-common-tools"
+
+  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"]
+
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  # end
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/common_tools/parser.rb

@@ -0,0 +1,19 @@
+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
+  end
+
+  def self.make_student_attributes(row)
+    Student.new(row.to_h)
+  end
+end

data/lib/common_tools/say_hello.rb

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

data/lib/common_tools/student.rb

@@ -0,0 +1,22 @@
+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

data/lib/common_tools/version.rb

@@ -0,0 +1,3 @@
+class CommonTools
+  VERSION = "0.1.0"
+end

data/lib/common_tools.rb

@@ -0,0 +1,13 @@
+require_relative "common_tools/version"
+require_relative "common_tools/say_hello"
+require_relative "common_tools/parser"
+
+
+class CommonTools
+  extend SayHello
+
+  def self.parse_csv(csv_file)
+    Parser.build_batch(csv_file)
+  end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: common_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BenjaGross
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: Includes often used scripts to help instructors work
+email:
+- ben@flatironschool.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- common_tools.gemspec
+- lib/common_tools.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: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.6
+signing_key: 
+specification_version: 4
+summary: Common Tools and scripts for Flatiron School Instructors
+test_files: []