clever-ruby 0.11.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0039ae3dc00766830c25a98b0103c15c4c0a15a2
-  data.tar.gz: de6f1ccf28e1b444ebe267cc7a63256b075ca134
+  metadata.gz: 3fbf4a2b0e378bcb5b8b6ddf915b9a893637d817
+  data.tar.gz: d4e7d196ec9472367e3055c7af19ac76de4150fd
 SHA512:
-  metadata.gz: b5284126d1c005cdddf2abca0a0ef5ddb238e2907455d0c70b46caa21bfce038242c50c68254413bb5d1a18823a08fda0ed8c540570ec5f52000ada08352022b
-  data.tar.gz: 10e619159f21dfb3f3c2469f3d9a5a25328a34f6e6a24e58c27e832f156c99a217f3fef292f43a3346278b5d47ef53b71598b232f89d7da55064e2419a674454
+  metadata.gz: 74b6cb015615bb153bc3b04b9d6c9d6a1a0eff230af5becb19d566996cb5c45c6bf69f9015eb36b9d1ab14a502fabd409a0ab7a9a65f54a565a510bbd839e747
+  data.tar.gz: 4bb8fba062d4766b7f6e770965ffa221c9ee321f1f260f47de38fa360b6218e4d38d592519bfd5727013602eafedf13833b7149203a222e8015ff9606aa0915a

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.13.0 (2015-10-05)
+
+* Add support for school admins
+
+## 0.12.0 (2015-09-28)
+
+* Remove inflector dependency
+
 ## 0.11.1 (2015-09-28)
 
 * Fix APIError throwing a TypeError when API requests fail

data/README.md

@@ -45,6 +45,12 @@ To run all tests:
 $ rake test
 ```
 
+To run a specific test file, for example `test/unit/clever_test.rb`:
+
+```bash
+$ rake test TEST=test/unit/clever_test.rb
+```
+
 To run all tests and the linter ([rubocop](https://github.com/bbatsov/rubocop)):
 
 ```bash
@@ -57,7 +63,15 @@ The linter follows the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-
 $ rake lint
 ```
 
-Running specific tests is not currently supported.
+### Updating VCR cassettes
+
+It is not currently possible to easily recreate the scenario in which the original VCR cassettes were recorded, especially for the events. If you need to update or add to the recorded requests and responses:
+
+* Using a Clever District Admin sandbox account, set up the data to include the updated or added situation.
+* In the tests, **temporarily** replace `DEMO_TOKEN` with the OAuth token of your sandbox district.
+* Remove the existing VCR cassettes that you would like to update so that they will get rerecorded.
+* Run the tests.
+* Using a combination of `git checkout -p`, `git add -p`, find-and-replace, `sed`/`awk`, etc. check into git the updated data and any updated formatting that you want to keep. **Check out and discard any recordings of your `Bearer Token` (so that the cassettes all contain `DEMO_TOKEN`)** and any other irrelevant data changes. Change the IDs of any objects in your added or updated response data to match those of the demo data.
 
 ## Documentation
 

data/clever-ruby.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'multi_json',    '~> 1.10.0'
   gem.add_runtime_dependency 'rest-client',   '~> 1.6.7'
-  gem.add_runtime_dependency 'activesupport', '~> 4.2.1'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest',      '~> 5.4.1'

data/lib/clever-ruby.rb

@@ -1,7 +1,6 @@
 # rubocop:disable FileName
 require 'rest_client'
 require 'multi_json'
-require 'active_support/inflector'
 require 'open-uri'
 require 'set'
 require 'uri'
@@ -32,6 +31,7 @@ require 'clever-ruby/student'
 require 'clever-ruby/section'
 require 'clever-ruby/teacher'
 require 'clever-ruby/event'
+require 'clever-ruby/school_admin'
 
 # Errors
 require 'clever-ruby/errors/clever_error'

data/lib/clever-ruby/api_resource.rb

@@ -1,5 +1,6 @@
 module Clever
-  # Superclass of API resources in the Clever API
+  # Superclass of API resources in the Clever API. API objects are to be
+  # singular, not plural; as in class Student, for the /students endpoint.
   class APIResource < CleverObject
     @resources = []
 
@@ -13,6 +14,21 @@ module Clever
       # @api private
       # @return [Array] List of resources nested under this resource
       attr_reader :linked_resources
+
+      # Get the plural form of a resource's name
+      #
+      # For instance, for class Student, returns "students"
+      # @api private
+      # @return [String] Plural name of a resource
+      attr_reader :plural
+
+      # Get the URI corresponding to a resource
+      #
+      # For instance, for class Student, urls start with /v1.1/students, so
+      # this returns "students"
+      # @api private
+      # @return [String] URI corresponding to a resource
+      attr_reader :uri
     end
 
     # Registers valid API resources
@@ -23,19 +39,39 @@ module Clever
       super
     end
 
+    # Check if the name of an APIResource is in its singular form
+    #
+    # For instance, the Student API resource can be referred to as
+    # "student" or "students"; this returns true on the former.
+    # @api private
+    # @param word [String] APIResource name to check
+    # @return [Boolean] False if plural, true if singular
+    def self.singular?(resource_name)
+      klass = named resource_name
+      unless klass
+        fail 'Clever::APIResource only supports checking singularity of words '\
+          'that refer to children of Clever::APIResource; received ' \
+          "'#{resource_name}'"
+      end
+
+      klass.plural != resource_name.downcase
+    end
+
     # Get a canonical name for a resource
     # @api private
     # @return [String]
     def self.shortname
-      name.split('::')[-1].downcase.singularize
+      name.split('::')[-1].gsub(/([a-z\d])([A-Z])/, '\1_\2'.freeze).downcase
     end
 
-    # Convert the name of a resource to its APIResource subclass
+    # Convert the uri of a resource to its APIResource subclass
     # @api private
     # @return [APIResource]
     def self.named(name)
-      name = name.to_s.downcase.singularize
-      matching = resources.select { |res| res.shortname == name }
+      name = name.to_s.downcase
+      matching = resources.select do |res|
+        (name == res.shortname) || (name == res.plural)
+      end
       return nil if matching.empty?
       matching.first
     end
@@ -48,7 +84,7 @@ module Clever
         fail NotImplementedError, 'APIResource is an abstract class. You should perform actions '\
           'on its subclasses (School, Student, etc.)'
       end
-      "v1.1/#{CGI.escape shortname.pluralize}"
+      "v1.1/#{uri}"
     end
 
     # Get URL for an instance of a resource
@@ -112,7 +148,7 @@ module Clever
       return if self.class.linked_resources.nil?
 
       self.class.linked_resources.each do |resource|
-        if Clever::Util.singular? resource.to_s
+        if APIResource.singular? resource.to_s
           # Get single resource
           self.class.send :define_method, resource do
             response = Clever.request :get, get_link_uri(resource), {}, headers

data/lib/clever-ruby/district.rb

@@ -2,6 +2,8 @@ module Clever
   # District resource
   class District < APIResource
     include Clever::APIOperations::List
+    @plural = 'districts'
+    @uri = 'districts'
     @linked_resources = [:schools, :teachers, :sections, :students, :events]
 
     # Get admins for the current district
@@ -28,6 +30,18 @@ module Clever
       fail NotImplementedError, 'status nested resource not yet implemented.'
     end
 
+    # Get school admins for the current district
+    # @api public
+    # @return [Object]
+    # @example
+    #   district = district.retrieve id
+    #   school_admins = district.school_admins
+    def school_admins(filters = {})
+      # The response for a district does not include a link to the school
+      # admins URI, so this can't be a linked_resource.
+      Clever::NestedResource.new '/v1.1/school_admins', filters, headers
+    end
+
     # @see Clever::CleverObject.optional_attributes
     # @api private
     # @return [Array]

data/lib/clever-ruby/event.rb

@@ -2,6 +2,8 @@ module Clever
   # Event resource
   class Event < APIResource
     include Clever::APIOperations::List
+    @uri = 'events'
+    @plural = 'events'
 
     # Optional attributes
     # @see Clever::CleverObject.optional_attributes

data/lib/clever-ruby/school.rb

@@ -2,6 +2,8 @@ module Clever
   # School resource
   class School < APIResource
     include Clever::APIOperations::List
+    @uri = 'schools'
+    @plural = 'schools'
     @linked_resources = [:students, :district, :sections, :teachers, :events]
 
     # Optional attributes

data/lib/clever-ruby/school_admin.rb

@@ -0,0 +1,17 @@
+module Clever
+  # School Admin resource
+  class SchoolAdmin < APIResource
+    include Clever::APIOperations::List
+    @uri = 'school_admins'
+    @plural = 'school_admins'
+    @linked_resources = [:schools]
+
+    # Optional attributes
+    # @see Clever::CleverObject.optional_attributes
+    # @api private
+    # @return [Array]
+    def optional_attributes
+      [:email, :title, :staff_id]
+    end
+  end
+end

data/lib/clever-ruby/section.rb

@@ -2,6 +2,8 @@ module Clever
   # Section resource
   class Section < APIResource
     include Clever::APIOperations::List
+    @uri = 'sections'
+    @plural = 'sections'
     @linked_resources = [:school, :district, :students, :teacher, :events]
 
     # Optional attributes

data/lib/clever-ruby/student.rb

@@ -2,6 +2,8 @@ module Clever
   # Student resource
   class Student < APIResource
     include Clever::APIOperations::List
+    @uri = 'students'
+    @plural = 'students'
     @linked_resources = [:school, :district, :sections, :teachers, :events]
 
     # Get contacts for the current student

data/lib/clever-ruby/teacher.rb

@@ -2,6 +2,8 @@ module Clever
   # Teacher resource
   class Teacher < APIResource
     include Clever::APIOperations::List
+    @uri = 'teachers'
+    @plural = 'teachers'
     @linked_resources = [:school, :district, :students, :sections, :events]
 
     # Optional attributes

data/lib/clever-ruby/util.rb

@@ -1,14 +1,6 @@
 module Clever
   # Library helper methods
   module Util
-    # Check if a given word is singular
-    # @api private
-    # @param word [String] Word to check
-    # @return [Boolean] False if plural, true if singular
-    def self.singular?(word)
-      word.singularize == word
-    end
-
     # Check if a given ID is a valid format (MongoDB BSON ObjectID)
     # @api private
     # @param id [String] ID to check
@@ -51,7 +43,7 @@ module Clever
           uri = resp[:links].select { |l| l[:rel] == 'self' }[0][:uri]
         end
 
-        klass_name = %r{/v1.1/([a-z]+)/\S+$}.match(uri)[1]
+        klass_name = %r{/v1.1/([a-z_]+)/\S+$}.match(uri)[1]
         klass = APIResource.named klass_name if klass_name
         klass ||= CleverObject
         klass.construct_from resp[:data]

data/lib/clever-ruby/version.rb

@@ -2,5 +2,5 @@
 module Clever
   # Version. Follows semantic versioning, as described here:
   # http://semver.org/
-  VERSION = '0.11.1'
+  VERSION = '0.13.0'
 end

data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_district_properly.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       Accept:
-      - ! '*/*; q=0.5, application/xml'
+      - "*/*; q=0.5, application/xml"
       Accept-Encoding:
       - gzip, deflate
       Authorization:
@@ -25,22 +25,28 @@ http_interactions:
       Access-Control-Allow-Methods:
       - GET,PATCH,POST,DELETE
       Access-Control-Allow-Origin:
-      - ! '*'
+      - "*"
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Sat, 13 Sep 2014 00:03:49 GMT
-      Server:
-      - nginx/1.4.7
+      - Sat, 26 Sep 2015 17:40:59 GMT
       X-Powered-By:
       - Express
+      X-Ratelimit-Bucket:
+      - bearer
+      X-Ratelimit-Limit:
+      - '1200'
+      X-Ratelimit-Remaining:
+      - '1166'
+      X-Ratelimit-Reset:
+      - '1443289303'
       Content-Length:
       - '71'
       Connection:
       - keep-alive
     body:
-      encoding: US-ASCII
-      string: ! '{"count":1,"links":[{"rel":"self","uri":"/v1.1/districts?count=true"}]}'
+      encoding: UTF-8
+      string: '{"count":1,"links":[{"rel":"self","uri":"/v1.1/districts?count=true"}]}'
     http_version: 
-  recorded_at: Sat, 13 Sep 2014 00:03:49 GMT
+  recorded_at: Sat, 26 Sep 2015 17:40:59 GMT
 recorded_with: VCR 2.9.3

data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_event_properly.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       Accept:
-      - ! '*/*; q=0.5, application/xml'
+      - "*/*; q=0.5, application/xml"
       Accept-Encoding:
       - gzip, deflate
       Authorization:
@@ -25,22 +25,28 @@ http_interactions:
       Access-Control-Allow-Methods:
       - GET,PATCH,POST,DELETE
       Access-Control-Allow-Origin:
-      - ! '*'
+      - "*"
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Sat, 13 Sep 2014 00:05:05 GMT
-      Server:
-      - nginx/1.4.7
+      - Sat, 26 Sep 2015 17:40:53 GMT
       X-Powered-By:
       - Express
+      X-Ratelimit-Bucket:
+      - bearer
+      X-Ratelimit-Limit:
+      - '1200'
+      X-Ratelimit-Remaining:
+      - '1184'
+      X-Ratelimit-Reset:
+      - '1443289303'
       Content-Length:
       - '68'
       Connection:
       - keep-alive
     body:
-      encoding: US-ASCII
-      string: ! '{"count":7,"links":[{"rel":"self","uri":"/v1.1/events?count=true"}]}'
+      encoding: UTF-8
+      string: '{"count":7,"links":[{"rel":"self","uri":"/v1.1/events?count=true"}]}'
     http_version: 
-  recorded_at: Sat, 13 Sep 2014 00:05:05 GMT
+  recorded_at: Sat, 26 Sep 2015 17:40:53 GMT
 recorded_with: VCR 2.9.3

data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_school_admin_properly.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.clever.com/v1.1/school_admins?count=true
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PATCH,POST,DELETE
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sat, 26 Sep 2015 17:41:03 GMT
+      X-Powered-By:
+      - Express
+      X-Ratelimit-Bucket:
+      - bearer
+      X-Ratelimit-Limit:
+      - '1200'
+      X-Ratelimit-Remaining:
+      - '1157'
+      X-Ratelimit-Reset:
+      - '1443289303'
+      Content-Length:
+      - '75'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"count":1,"links":[{"rel":"self","uri":"/v1.1/school_admins?count=true"}]}'
+    http_version:
+  recorded_at: Sat, 26 Sep 2015 17:41:03 GMT
+recorded_with: VCR 2.9.3