ed_fi_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91f16e3849cc8bec80fcf68483932d75c7fe8221cd16d553e5f1bd2bb381e0d7
+  data.tar.gz: c4b25b4a6cb267155f41b89c4fa5f1895855a7efcbc5314a4ccfc29421cc669e
+SHA512:
+  metadata.gz: 7c026d408a34de9255917942482602e7300447b849013cf825f7c1b2fb62f362156e47d292ac56f013eeea15be35f1d064225fdc5d2c902e74d2d8a49bdd7691
+  data.tar.gz: d624dff599c036d39c4c3038e34a11ed0446e56397c57f616714071705e9bc02a3a1ac9642cc9f21f2c806d04d7a8be42787e77a1c204440378ab78ec939bac2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/true/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+  - "**/*.rake"
+  - "**/Gemfile"
+  - "**/Rakefile"
+  - "**/Capfile"
+  - "**/Berksfile"
+  - "**/Cheffile"
+  Exclude:
+  - "vendor/**/*"
+  - "db/**/*"
+  - "tmp/**/*"
+  - "true/**/*"
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/LineLength:
+  Description: Limit lines to 100 characters.
+  Enabled: false
+  Max: 100
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and conditions.
+  Enabled: false
+  Max: 15
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Lint/Debugger:
+  Description: Warn in debugger entries
+  Enabled: false
+Style/SymbolArray:
+  Description: Use %i or %I for arrays of symbols.
+  Enabled: false
+Style/RegexpLiteral:
+  Description: Enforces using / or %r around regular expressions.
+  EnforcedStyle: percent_r
+Style/AsciiComments:
+  # Disabling this so we can use non-breaking spaces (' ') in documentation comments, preventing browsers from collapsing multiple spaces in code blocks.
+  Description: This cop checks for non-ascii (non-English) characters in comments.
+  Enabled: false
+Style/NumericLiterals:
+  Description: This cop checks for big numeric literals without _ between groups of digits in them.
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Description: Use nested modules/class definitions instead of compact style.
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/EmptyMethod:
+  Enabled: false
+Style/StderrPuts:
+  Enabled: true
+  Exclude:
+    - 'bin/**/*'
+Style/BlockDelimiters:
+  Description: Check for uses of braces or do/end around single line or multi-line blocks.
+  Enabled: true
+  Exclude:
+    - 'spec/**/*.rb'
+Style/RescueModifier:
+  Description: This cop checks for uses of rescue in its modifier form.
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/.yardopts

@@ -0,0 +1 @@
+--output-dir=./docs --no-private --markup=markdown --format=html

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ed_fi_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    ed_fi_client (0.1.0)
+      activesupport (~> 5.2.0)
+      crapi (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crapi (0.1.2)
+      activesupport (~> 5.2.0)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rspec_junit_formatter (0.3.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ed_fi_client!
+  pry (~> 0.11)
+  pry-byebug (~> 3.6)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.3)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nestor Custodio
+
+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,113 @@
+# EdFi::Client  [![Gem Version](https://badge.fury.io/rb/ed_fi_client.svg)](https://badge.fury.io/rb/ed_fi_client)
+
+A utility class for authenticating to and making CRUD calls against an Ed-Fi ODS API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ed_fi_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ed_fi_client
+
+
+## Using EdFi::Client
+
+### Basic Usage: Reading Data
+
+```ruby
+## Establish a connection to an Ed-Fi ODS / API.
+## (We'll use the Alliance-hosted Ed-Fi ODS / API sandbox instance.)
+
+sandbox = EdFi::Client.new(
+  'https://api.ed-fi.org/api/',
+  client_id: 'RvcohKz9zHI4',
+  client_secret: 'E1iEFusaNf81xzCxwHfbolkC'
+)
+
+sandbox = sandbox.v2(2017)  ## For purposes of these samples, we're only
+                            ## concerned with 2017-2018 school-year data.
+
+
+## Let's pull some assorted values!
+
+sandbox.get('schools', query: { school_id: 255901001 })  ## Get school 255901001.
+
+sandbox.get('disciplineIncidents')  ## Get all discipline incidents.
+sandbox.get('disciplineIncidents').sample.school  ## A random incident's school.
+
+all_schools = sandbox.get('schools')  ## All schools.
+all_schools.sample.name_of_institution  ## A random school's name.
+all_schools.map { |i| [i.id, i.school_id] }.to_h  ## Maps ODS IDs to school IDs.
+```
+
+---
+
+### Basic Usage: Writing Data
+
+```ruby
+sandbox = EdFi::Client.new(
+  'https://api.ed-fi.org/api/',
+  client_id: 'RvcohKz9zHI4',
+  client_secret: 'E1iEFusaNf81xzCxwHfbolkC'
+).v2(2017)
+
+school = sandbox.get('schools').sample
+original_name = school.name_of_institution  ## So we can leave it like we found it.
+
+
+## Via PUT ...
+
+school.name_of_institution = 'New Name, via PUT'
+sandbox.put("schools/#{school.id}", payload: school)
+sandbox.get("schools/#{school.id}").name_of_institution  ## => "New Name, via PUT"
+
+
+## Via POST ...
+
+school.name_of_institution = 'New Name, via POST'
+sandbox.post("schools", payload: school.except(:id))
+sandbox.get("schools/#{school.id}").name_of_institution  ## => "New Name, via POST"
+
+
+## Let's leave things like we found them.
+
+school.name_of_institution = original_name
+sandbox.put("schools/#{school.id}", payload: school)
+```
+
+---
+
+[Consult the repo docs for the full EdFi::Client documentation.](http://nestor-custodio.github.io/ed_fi_client/EdFi/Client.html)
+
+
+## Feature Roadmap / Future Development
+
+Additional features/options coming in the future:
+
+- Cleaner handling of non-body-returning calls.
+- Use the given base endpoint's Swagger API definition file (if present) to make collections/resources more easily reachable: `#schools`, `#discipline_incidents`, etc.
+- Allow for easier manipulation of resources via AR-like methods (`#find`, `#find_by`, `#where`, `#create`, `#update`, etc).
+
+
+## Contribution / Development
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nestor-custodio/ed_fi_client.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Linting is courtesy of [Rubocop](https://github.com/bbatsov/rubocop) and documentation is built using [Yard](https://yardoc.org/). Neither is included in the Gemspec; you'll need to install these locally (`gem install rubocop yard`) to take advantage.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ed_fi_client'
+
+# 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(__FILE__)

data/bin/setup

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

data/docs/EdFi.html

@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: EdFi
+  
+    &mdash; Documentation by YARD 0.9.12
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "EdFi";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index (E)</a> &raquo;
+    
+    
+    <span class="title">EdFi</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: EdFi
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/ed_fi/client/version.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>The EdFi module houses the <span class='object_link'><a href="EdFi/Client.html" title="EdFi::Client (class)">EdFi::Client</a></span> in this gem, but
+should also house future EdFi tooling.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="EdFi/Client.html" title="EdFi::Client (class)">Client</a></span>
+    
+  
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu May 24 18:35:37 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.12 (ruby-2.5.1).
+</div>
+
+    </div>
+  </body>
+</html>