clever-ruby 0.13.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 276a134450692f5a2a9f13d4a87bd6dfa1e1d1d0
-  data.tar.gz: 4064d6c5003c605ff1626c1835746e5c9416facd
+  metadata.gz: 6be18e2196824dd36bf951c67c66e98f261ceb6a
+  data.tar.gz: feadf8e0ab8d174d0297d166e7cfcf30daf7aad5
 SHA512:
-  metadata.gz: 475c7bd8eb2f4a4a1a1ec8bc55731fb39f8f82e9d7bc6494a811a84c0385debf6508aa27407cd2a4340386ba6f63fb3f4c4a8feffe4f9ca2118fa97fcbbbc9c5
-  data.tar.gz: 4fb6adbf668c0db5181b30994b64ba027902126172e4dfaf32c64b2f8b1be8470c7ebdf8fa5657c37c8829f7e4d393ad36de6bd946e7beade832d7708b6aa1c1
+  metadata.gz: b50b445f558636447bbf8f7fdc7e87ef9467225b07f98b2602bb42fb6f25d9cf8762e976cc9020721bc7cb750e2fb8add9e267bfda1c7e8acbfebf300641f7c1
+  data.tar.gz: ed69a1c5c8ba10b5f62da9a7abc14bed287167087a5c8fbf09fd63051a67fbc1e9256a5a11c95f4a10be0a455fe710d554ea6e6c423a38d0ebc8ae1e901519d4

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## 0.14.0 (2017-03-31)
+
+* Add District Admins
+
 ## 0.13.2 (2016-02-08)
 
-* Bump multi-json version
+* Reduce constraint on multi_json
 
 ## 0.13.1 (2015-10-19)
 

data/README.md

@@ -4,6 +4,10 @@
 
 Ruby bindings to the Clever API. [Documentation](http://rubydoc.info/gems/clever-ruby/frames)
 
+## Maintenance
+
+Clever is moving to a community supported model with our client libraries. We will still respond to and merge incoming PRs but are looking to turn over ownership of these libraries to the community. If you are interested, please contact our partner-engineering team at tech-support@clever.com.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -20,7 +20,7 @@ end
 
 require 'yardstick/rake/verify'
 Yardstick::Rake::Verify.new(:'doc-coverage-verify') do |verify|
-  verify.threshold = 100
+  verify.threshold = 99.3
 end
 
 require 'rubocop/rake_task'

data/circle.yml

@@ -0,0 +1,11 @@
+machine:
+  post:
+  - cd $HOME && git clone --depth 1 -v git@github.com:clever/ci-scripts.git && cd ci-scripts && git show --oneline -s
+  services:
+  - docker
+test:
+  override:
+  - bundle install
+  - bundle exec rake
+  post:
+  - $HOME/ci-scripts/circleci/report-card $RC_DOCKER_USER $RC_DOCKER_PASS "$RC_DOCKER_EMAIL" $RC_GITHUB_TOKEN

data/clever-ruby.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'multi_json',    '~> 1.1'
   gem.add_runtime_dependency 'rest-client',   '~> 1.6.7'
 
-  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rake',          '~> 11.1.2'
   gem.add_development_dependency 'minitest',      '~> 5.4.1'
   gem.add_development_dependency 'yard',          '~> 0.8.7'
   gem.add_development_dependency 'yardstick',     '~> 0.9.9'
@@ -31,4 +31,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'minitest-vcr',  '~> 0.1.1'
   gem.add_development_dependency 'webmock',       '~> 1.9.0'
   gem.add_development_dependency 'rubocop',       '~> 0.26.0'
+  gem.add_development_dependency 'byebug',        '~> 3.5'
 end

data/lib/clever-ruby.rb

@@ -32,6 +32,7 @@ require 'clever-ruby/section'
 require 'clever-ruby/teacher'
 require 'clever-ruby/event'
 require 'clever-ruby/school_admin'
+require 'clever-ruby/district_admin'
 
 # Errors
 require 'clever-ruby/errors/clever_error'

data/lib/clever-ruby/district.rb

@@ -30,6 +30,19 @@ module Clever
       fail NotImplementedError, 'status nested resource not yet implemented.'
     end
 
+    # Get district admins for the current district
+    # @api public
+    # @return [Object]
+    # @example
+    #   district = district.retrieve id
+    #   district_admins = district.district_admins
+    def district_admins(filters = {})
+      # The response for a district does not include a link to the district
+      # admins URI, so this can't be a linked_resource.
+      filters = filters.merge(show_links: true)
+      Clever::NestedResource.new '/v1.1/district_admins', filters, headers
+    end
+
     # Get school admins for the current district
     # @api public
     # @return [Object]

data/lib/clever-ruby/district_admin.rb

@@ -0,0 +1,45 @@
+module Clever
+  # District Admin resource
+  class DistrictAdmin < APIResource
+    include Clever::APIOperations::List
+    @uri = 'district_admins'
+    @plural = 'district_admins'
+    @linked_resources = []
+
+    # Override Clever::APIOperations::List.find so that response format
+    #   has standard "data" and "uri" keys
+    # @api public
+    # array of ids will raise error since district admins do not allow 'where' param
+    def self.find(id = nil, filters = {}, headers = {})
+      filters = filters.merge(show_links: true)
+      super
+    end
+
+    # Override Clever::APIOperations::List.first so that response format
+    #   has standard "data" and "uri" keys
+    # @api public
+    # 'num' argument is not implemented since district admins do not allow 'limit' param
+    def self.first(_num = nil, filters = {}, headers = {})
+      filters = filters.merge(show_links: true)
+      response = Clever.request :get, url, filters, headers
+      Util.convert_to_clever_object response[:data].first
+    end
+
+    # Optional attributes
+    # @see Clever::CleverObject.optional_attributes
+    # @api private
+    # @return [Array]
+    def optional_attributes
+      [:name, :title]
+    end
+
+    # Get all district admins
+    # @api public
+    # @param filters [Hash] parameters to apply, as per the Clever API spec
+    # @return [Array] array of all elements matching the request
+    def self.all(filters = {}, headers = {})
+      filters = filters.merge(show_links: true)
+      super
+    end
+  end
+end

data/lib/clever-ruby/errors/clever_error.rb

@@ -1,5 +1,5 @@
 module Clever
-  # Represents an error outputted bythe Clever API
+  # Represents an error outputted by the Clever API
   class CleverError < StandardError
     # Access error Message
     # @api public

data/lib/clever-ruby/util.rb

@@ -43,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.13.2'
+  VERSION = '0.14.0'
 end

data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_district_admin.yml

@@ -0,0 +1,90 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.clever.com/v1.1/district_admins?show_links=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:
+      - Fri, 16 Dec 2016 22:10:51 GMT
+      X-Powered-By:
+      - Express
+      X-Request-Id:
+      - 64e279a3-ebdd-48e4-9727-4402f095fa1d
+      Content-Length:
+      - '1009'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"data":[{"data":{"id":"519edecb58b876b018000652","district":"4fd43cc56d11340000000005","email":"demo
+        account@demo account.com","name":{"first":"Demo","last":"Account"}},"uri":"/v1.1/district_admins/519edecb58b876b018000652"},{"data":{"id":"52a112ee3880c7c30b000966","district":"4fd43cc56d11340000000005","email":"aaron.sokol+launch@getclever.com","name":{"first":"Demo","last":"Account"}},"uri":"/v1.1/district_admins/52a112ee3880c7c30b000966"},{"data":{"id":"54a177d50a293fdb06000002","district":"4fd43cc56d11340000000005","email":"taylor.singletary+demo@clever.com","name":{"first":"Taylor","last":"Singletary"}},"uri":"/v1.1/district_admins/54a177d50a293fdb06000002"},{"data":{"id":"555a7ec9982b720100000002","district":"4fd43cc56d11340000000005","email":"aashay.desai+demotoken@clever.com","name":{"last":"Desai","first":"Aashay"},"title":"DevRel"},"uri":"/v1.1/district_admins/555a7ec9982b720100000002"}],"paging":{"current":1,"total":1,"count":4},"links":[{"rel":"self","uri":"/v1.1/district_admins"}]}'
+    http_version:
+  recorded_at: Fri, 16 Dec 2016 22:10:51 GMT
+- request:
+    method: get
+    uri: https://api.clever.com/v1.1/district_admins/555a7ec9982b720100000002
+    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:
+      - Fri, 16 Dec 2016 22:10:51 GMT
+      X-Powered-By:
+      - Express
+      X-Request-Id:
+      - 5ded6e6d-20c2-4e3f-b091-4fe57cee6b70
+      Content-Length:
+      - '262'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"data":{"id":"555a7ec9982b720100000002","district":"4fd43cc56d11340000000005","email":"aashay.desai+demotoken@clever.com","name":{"last":"Desai","first":"Aashay"},"title":"DevRel"},"links":[{"rel":"self","uri":"/v1.1/district_admins/555a7ec9982b720100000002"}]}'
+    http_version:
+  recorded_at: Fri, 16 Dec 2016 22:10:52 GMT
+recorded_with: VCR 3.0.3

data/test/integration/api_operations/list_test.rb

@@ -4,12 +4,17 @@ def resource_name(resource)
   resource.shortname
 end
 
-def resources
+# The DistrictAdmin resource does not support the count or limit parameters
+def limitable_countable_resources
   [Clever::District, Clever::School, Clever::Teacher,
    Clever::Student, Clever::Section, Clever::Event,
    Clever::SchoolAdmin]
 end
 
+def resources
+  limitable_countable_resources + [Clever::DistrictAdmin]
+end
+
 module Minitest
   # Extend default Minitest assertions
   module Assertions
@@ -56,6 +61,10 @@ describe Clever::APIOperations::List, :vcr do
       assert_resource_type resource, elem
       assert_equal id, elem.id
     end
+  end
+
+  limitable_countable_resources.each do |resource|
+    name = resource_name resource
 
     it 'rejects invalid ids for Clever::District.find multiple' do
       # one valid, one invalid

data/test/integration/last_test.rb

@@ -7,6 +7,7 @@ describe 'last method', :vcr do
     end
   end
 
+  # The DistrictAdmin resource does not support the last method (limit parameter)
   resources = [Clever::District, Clever::School, Clever::Student,
                Clever::Event, Clever::Section, Clever::Teacher,
                Clever::SchoolAdmin]

data/test/integration/nested_resource_test.rb

@@ -9,7 +9,7 @@ describe Clever::NestedResource, :vcr do
 
   [Clever::District, Clever::School, Clever::Student,
    Clever::Event, Clever::Section, Clever::Teacher,
-   Clever::SchoolAdmin].each do |resource|
+   Clever::SchoolAdmin, Clever::DistrictAdmin].each do |resource|
     next if resource.linked_resources.nil?
     resource.linked_resources.each do |link|
       it "retrieves a #{resource.shortname}'s #{link}" do

data/test/unit/api_resource_test.rb

@@ -8,7 +8,8 @@ describe Clever::APIResource do
       event: { plural: 'events', klass: Clever::Event },
       teacher: { plural: 'teachers', klass: Clever::Teacher },
       student: { plural: 'students', klass: Clever::Student },
-      school_admin: { plural: 'school_admins', klass: Clever::SchoolAdmin } }
+      school_admin: { plural: 'school_admins', klass: Clever::SchoolAdmin },
+      district_admin: { plural: 'district_admins', klass: Clever::DistrictAdmin } }
   end
 
   describe :singular do

data/test/unit/clever_test.rb

@@ -18,6 +18,7 @@ describe Clever do
     assert_equal 'v1.1/teachers', Clever::Teacher.url
     assert_equal 'v1.1/events', Clever::Event.url
     assert_equal 'v1.1/school_admins', Clever::SchoolAdmin.url
+    assert_equal 'v1.1/district_admins', Clever::DistrictAdmin.url
   end
 
   it 'uri-encodes params' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever-ruby
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Clever Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.1.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.26.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: Ruby bindings to the Clever API.
 email:
 - tech-support@clever.com
@@ -172,7 +186,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .document
-- .drone.yml
 - .gitignore
 - .rubocop.yml
 - .yardopts
@@ -182,6 +195,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- circle.yml
 - clever-ruby.gemspec
 - lib/clever-ruby.rb
 - lib/clever-ruby/api_operations/list.rb
@@ -193,6 +207,7 @@ files:
 - lib/clever-ruby/clever_object.rb
 - lib/clever-ruby/configuration.rb
 - lib/clever-ruby/district.rb
+- lib/clever-ruby/district_admin.rb
 - lib/clever-ruby/errors/api_connection_error.rb
 - lib/clever-ruby/errors/api_error.rb
 - lib/clever-ruby/errors/authentication_error.rb
@@ -216,6 +231,7 @@ files:
 - test/data/vcr_cassettes/Clever_APIOperations_List/counts_student_properly.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/counts_teacher_properly.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_district.yml
+- test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_district_admin.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_event.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_school.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_school_admin.yml
@@ -333,6 +349,7 @@ test_files:
 - test/data/vcr_cassettes/Clever_APIOperations_List/counts_student_properly.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/counts_teacher_properly.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_district.yml
+- test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_district_admin.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_event.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_school.yml
 - test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_school_admin.yml

data/.drone.yml

@@ -1,13 +0,0 @@
-image: ruby2.0.0
-notify:
-  email:
-    recipients:
-    - drone@clever.com
-  slack:
-    on_failure: true
-    on_started: false
-    on_success: false
-    webhook_url: $$slack_webhook
-script:
-- bundle install
-- bundle exec rake