mconnect 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 948eb6c67121e0e1ea374fea00c6308df6a93772
+  data.tar.gz: 0c48a76c2959530fec7df1e6dd896304ca963035
+SHA512:
+  metadata.gz: 50ee996726e6f3ba3eb96b8c2df735e2b871cfddbd79cbbea3dd60e8e6d322f54f506b47095b0f38e27e402b554abc0ce27a616d27b960c38eca629043b04784
+  data.tar.gz: cd9baaa2313597de01c8c29bd033cfc5b5a7a9855746380c80ffa0e833e60d19fb52b7ef90682133368424656d6cf427a2a1417693acc1cda8ce721547b8640f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Silas Sao
+
+MIT License
+
+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,50 @@
+# Mconnect
+
+CLI to export endpoints from the MasteryConnect API to CSV
+
+## Important
+
+This gem was specifically created for Ingenium Schools and has custom decorators
+to format the CSV's how they need them. I'm open sourcing this code just in case
+someone that runs across it, can benefit from it.
+
+## Installation
+
+    $ gem install mconnect
+
+## Usage
+
+Running the gem without any arguments will display a list of commands that can
+be ran.
+
+    $ mconnect
+
+First things first, you need to setup a configuration file.
+
+    $ mconnect config
+
+It will ask you some questions and generate a configuration yaml. After this is
+complete, you will need to authorize your client.
+
+    $ mconnect auth
+
+This will give you a URL to paste into your browser that will send you to a
+login, then immediately after, an authorization page. It will be awaiting input
+for your oauth verifier. This can be found as a parameter on the end of the URL
+after you've been logged in and authorized. After you paste your oauth verifier
+into the input and the program completes, your authorization file has been generated.
+
+You are now free to run the get method in order to get a specific API endpoint
+and export it to a CSV file. Use the '-e' to tell the program which endpoint you
+want to export and '-o' to tell it where you want the data to go. You can see an
+example below:
+
+    $ mconnect get -e teachers -o ~/Desktop/teachers.csv
+
+## Contributing
+
+1. Fork it ( https://github.com/sao/mconnect/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,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/mconnect

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'mconnect'
+
+Mconnect::CLI.start

data/lib/mconnect.rb

@@ -0,0 +1,57 @@
+require 'mconnect/version'
+require 'thor'
+require 'oauth'
+require 'yaml'
+require 'json'
+require 'csv'
+
+require 'mconnect/worker'
+require 'mconnect/decorator'
+require 'mconnect/generator'
+require 'mconnect/authorizer'
+
+module Mconnect
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "config", "create a new configuration yaml"
+    def config options = {}
+      say "Let's setup a configuration file.."
+
+      options['consumer_key']    = ask('What is the consumer key?').to_s
+      options['consumer_secret'] = ask('What is the consumer secret?').to_s
+
+      create_file '/tmp/mconnect/config.yml' do
+        options.to_yaml
+      end
+    end
+
+    desc "auth", "authorize client and create authorization yaml"
+    def auth
+      authorizer = Mconnect::Authorizer.new
+
+      say 'Copy and paste the following URL in your browser:'
+      say "\t#{authorizer.authorize_url}"
+
+      authorizer.verifier = ask('When you sign in, copy and paste the oauth verifier here:').to_s
+
+      create_file '/tmp/mconnect/authorization.yml' do
+        authorizer.authorization.to_yaml
+      end
+    end
+
+    desc "get", "gets endpoint and saves to CSV"
+    option :e, required: true, desc: "which endpoint to export"
+    option :o, required: true, desc: "destination to put CSV"
+    def get
+      directory  = options[:o].to_s
+      endpoint   = options[:e].to_s
+      authorizer = Mconnect::Authorizer.new
+      worker     = Mconnect::Worker.new authorizer.access_token, endpoint
+      generator  = Mconnect::Generator.new(worker.content, directory, endpoint)
+
+      generator.save_csv
+    end
+  end
+end
+

data/lib/mconnect/authorizer.rb

@@ -0,0 +1,41 @@
+require 'mconnect/helpers'
+
+module Mconnect
+  class Authorizer
+    include Helpers
+
+    attr_writer :verifier
+    attr_reader :client
+
+    def initialize
+      oauth_options  = load_yaml '/tmp/mconnect/config.yml'
+      client_options = { :site => 'https://api.masteryconnect.com',
+                         :authorize_path => '/oauth/authorize',
+                         :request_token_path => '/oauth/request_token',
+                         :access_token_path => '/oauth/access_token' }
+
+      @client = OAuth::Consumer.new(
+                  oauth_options['consumer_key'],
+                  oauth_options['consumer_secret'],
+                  client_options
+                )
+    end
+
+    def access_token
+      access_token = load_yaml '/tmp/mconnect/authorization.yml'
+      OAuth::AccessToken.new(client, access_token.token, access_token.secret)
+    end
+
+    def request_token
+      @request_token ||= client.get_request_token
+    end
+
+    def authorize_url
+      request_token.authorize_url
+    end
+
+    def authorization
+      request_token.get_access_token(oauth_verifier: @verifier)
+    end
+  end
+end

data/lib/mconnect/decorator.rb

@@ -0,0 +1,58 @@
+module Mconnect
+  class Decorator
+    attr_accessor :content
+
+    def initialize content
+      @content = content
+    end
+
+    def remove_columns columns = []
+      @content.each do |hash|
+        hash.reject! do |k,v|
+          columns.include? k
+        end
+      end
+    end
+
+    def flatten_column column
+      orig_content = @content.dup
+      @content = []
+
+      orig_content.each do |hash|
+        @content << hash[column]
+      end
+
+      @content.flatten!
+    end
+
+    def sections_hash
+      orig_content = @content.dup
+      @content = []
+
+      orig_content.each do |hash|
+        hash['teachers'].each do |t|
+          hash['students'].each do |s|
+            @content << {
+              "id"                 => hash['id'],
+              "school_id"          => hash['school_id'],
+              "name"               => hash['name'],
+              "teacher_id"         => t['id'],
+              "teacher_school_id"  => t['school_id'],
+              "teacher_first_name" => t['first_name'],
+              "teacher_last_name"  => t['last_name'],
+              "teacher_custom"     => t['custom'],
+              "student_id"         => s['id'],
+              "student_first_name" => s['first_name'],
+              "student_last_name"  => s['last_name'],
+              "student_number"     => s['student_number'],
+              "student_school_id"  => s['school_id'],
+              "student_custom"     => s['custom']
+            }
+          end
+        end
+      end
+
+      return @content
+    end
+  end
+end

data/lib/mconnect/generator.rb

@@ -0,0 +1,34 @@
+require 'pry'
+module Mconnect
+  class Generator
+    attr_accessor :content
+    attr_reader :directory, :endpoint
+
+    def initialize content, directory, endpoint
+      @content   = content
+      @directory = directory
+      @endpoint  = endpoint
+    end
+
+    def save_csv
+      decorator = Mconnect::Decorator.new @content
+
+      case endpoint
+      when "teachers"
+        content = decorator.remove_columns ['custom', 'saml_name']
+      when "students"
+        content = decorator.remove_columns ['sections']
+      when "standards"
+        content = decorator.flatten_column 'standards'
+      when "sections"
+        content = decorator.sections_hash
+      end
+
+      CSV.open("#{@directory}/#{@endpoint}.csv", "w", write_headers: true, headers: @content.first.keys) do |csv|
+        @content.each do |hash|
+          csv << hash.values
+        end
+      end
+    end
+  end
+end

data/lib/mconnect/helpers.rb

@@ -0,0 +1,11 @@
+module Mconnect
+  module Helpers
+    def load_yaml data
+      if data.kind_of? Hash
+        YAML.load(data.to_yaml)
+      else
+        YAML.load_file(data)
+      end
+    end
+  end
+end

data/lib/mconnect/version.rb

@@ -0,0 +1,3 @@
+module Mconnect
+  VERSION = "0.1.2"
+end

data/lib/mconnect/worker.rb

@@ -0,0 +1,26 @@
+module Mconnect
+  class Worker
+    attr_accessor :content
+
+    def initialize access_token, endpoint
+      @access_token   = access_token
+      @endpoint       = endpoint
+
+      get_content
+    end
+
+    def get_content page_number = 1
+      @content ||= []
+
+      url = "/api/#{@endpoint}?page=#{page_number}"
+
+      @content << JSON.parse(@access_token.get(url, 'x-li-format' => 'json').body)
+      @content.flatten!
+
+      unless @content.count < page_number * 1000
+        puts "Getting page #{page_number}.."
+        get_content (page_number + 1)
+      end
+    end
+  end
+end

data/mconnect.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mconnect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mconnect"
+  spec.version       = Mconnect::VERSION
+  spec.authors       = ["Silas Sao"]
+  spec.email         = ["silassao@gmail.com"]
+  spec.summary       = "Gem for the MasteryConnect API"
+  spec.description   = "Gem created to convert MasteryConnect API endpoints to CSV"
+  spec.homepage      = "http://silassao.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor",  "~> 0.19"
+  spec.add_dependency "oauth", "~> 0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Mconnect::Helpers do
+  include Mconnect::Helpers
+
+  describe "#load_yaml" do
+    let(:data) { { token: "XXXXXX", secret: "YYYYYY" } }
+
+    it "takes a hash as a parameter" do
+      expect(load_yaml(data)).to be_kind_of Hash
+    end
+
+    it "takes a file as a parameter" do
+      allow(YAML).to receive(:load_file).with('config.yml').and_return(data)
+      expect(load_yaml("config.yml")).to be_kind_of Hash
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'mconnect'

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: mconnect
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Silas Sao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: 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'
+description: Gem created to convert MasteryConnect API endpoints to CSV
+email:
+- silassao@gmail.com
+executables:
+- mconnect
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mconnect
+- lib/mconnect.rb
+- lib/mconnect/authorizer.rb
+- lib/mconnect/decorator.rb
+- lib/mconnect/generator.rb
+- lib/mconnect/helpers.rb
+- lib/mconnect/version.rb
+- lib/mconnect/worker.rb
+- mconnect.gemspec
+- spec/helpers_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: http://silassao.com
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for the MasteryConnect API
+test_files:
+- spec/helpers_spec.rb
+- spec/spec_helper.rb
+has_rdoc: