bridge_api 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffdeb2475681552091445eba9aa00bdcf33df8d7
-  data.tar.gz: c6503c5b12114a7f8cd639b810ac5dd656b23671
+  metadata.gz: aa247d0c90a1e78f78434ff7a13b768627956db8
+  data.tar.gz: 7112201e71a64448ba46a366c77bd353a306df9a
 SHA512:
-  metadata.gz: 51cfb544f896ba30f56edb9d80eedb216ed9b7419709a2d7b9bc32f4f9f9930944d37e36363a8c1cea286743382c83a7a27009fabca673f5fdeeb2b055a8d953
-  data.tar.gz: 1b58a15df476ded08dd5f1d827938b7085ce3ebff3c8c2cd17ed54463baec4eceb350ba43c4c714b13268049958849925652b686695f5a5ce9e4cad1aecc6076
+  metadata.gz: b35e1515f91a563140e1c889e5346e9ef8886ba153d608f1f250c709ccba5a53600e50168c787ade26c93145aabd05c9adc6e6e86c189205400df19bbeb0b74f
+  data.tar.gz: 0a5b2d4b7884c7d87ab342728b78d447b90fcd4c3e7e6db3ba88883f841eb4a935256d895740b1cac53dd380dcdd3d620e1d862ff9074a93447e6cb3e874da8e

data/lib/bridge_api/client.rb

@@ -15,6 +15,8 @@ module BridgeAPI
     DATA_DUMP_PATH = '/data_dumps'
     COURSE_TEMPLATE_PATH = '/course_templates'
     ENROLLMENT_PATH = '/enrollments'
+    PROGRAM_PATH = '/programs'
+    PROGRAM_ENROLLMENT_PATH = '/learners'
     USER_PATH = '/users'
     GROUPS_PATH = '/groups'
     MANAGER_PATH = '/managers'

data/lib/bridge_api/client/program_enrollment.rb

@@ -0,0 +1,21 @@
+module BridgeAPI
+  class Client
+    # WARNING: the API endpoint for program enrollments is currently undocumented
+    # in the Bridge API. It's possible that it might change or be removed in the
+    # future, causing this to break.
+
+    module ProgramEnrollment
+      def add_program_enrollment(program_id, params = {})
+        post("#{API_PATH}#{AUTHOR_PATH}#{PROGRAM_PATH}/#{program_id}#{PROGRAM_ENROLLMENT_PATH}", params)
+      end
+
+      def delete_program_enrollment(program_id, enrollment_id, params = {})
+        delete("#{API_PATH}#{AUTHOR_PATH}#{PROGRAM_PATH}/#{program_id}#{PROGRAM_ENROLLMENT_PATH}/#{enrollment_id}", params)
+      end
+
+      def get_all_program_enrollments(program_id, params = {})
+        get("#{API_PATH}#{AUTHOR_PATH}#{PROGRAM_PATH}/#{program_id}#{PROGRAM_ENROLLMENT_PATH}", params)
+      end
+    end
+  end
+end

data/lib/bridge_api/version.rb

@@ -1,3 +1,3 @@
 module BridgeAPI
-  VERSION = '0.0.12' unless defined?(BridgeAPI::VERSION)
+  VERSION = '0.0.13' unless defined?(BridgeAPI::VERSION)
 end

data/spec/bridge_api/client/program_enrollment_spec.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+describe BridgeAPI::Client::ProgramEnrollment do
+  before do
+    @client = BridgeAPI::Client.new(prefix: "http://test.bridge.com", token: "test_token")
+  end
+
+  it 'should add a program enrollment' do
+    response = @client.add_program_enrollment(1)
+    expect(response.status).to(eq(204))
+  end
+
+  it 'should delete a program enrollment' do
+    response = @client.delete_program_enrollment(1, 2)
+    expect(response.status).to(eq(204))
+  end
+
+  it 'should get all program enrollments' do
+    enrollments = @client.get_all_enrollments(1)
+    expect(enrollments.length).to(eq(2))
+  end
+end

data/spec/fixtures/program_enrollments.json

@@ -0,0 +1,39 @@
+{
+  "meta": {},
+  "learners": [
+    {
+      "id": "2",
+      "name": "fakeperon",
+      "email": "fakeemail@fakedomain.com",
+      "avatar_url": null,
+      "state": "active",
+      "current_program_item_index": 0,
+      "program_items_complete": 0,
+      "total_program_items": 1,
+      "current_program_item_due": 7,
+      "program_due": null,
+      "group_ids": [],
+      "current_course_index": 0,
+      "courses_complete": 0,
+      "total_courses": 1,
+      "current_course_due": 7
+    },
+    {
+      "id": "3",
+      "name": "fakeperson2",
+      "email": null,
+      "avatar_url": null,
+      "state": "active",
+      "current_program_item_index": 0,
+      "program_items_complete": 0,
+      "total_program_items": 1,
+      "current_program_item_due": 7,
+      "program_due": null,
+      "group_ids": [],
+      "current_course_index": 0,
+      "courses_complete": 0,
+      "total_courses": 1,
+      "current_course_due": 7
+    }
+  ]
+}

data/spec/support/fake_bridge.rb

@@ -35,6 +35,20 @@ class FakeBridge < Sinatra::Base
     get_json_data 200, 'programs.json'
   end
 
+  ## Program enrollments
+
+  get %r{/api/author/programs/\d+/learners} do
+    get_json_data 200, 'program_enrollments.json'
+  end
+
+  post %r{/api/author/programs/\d+/learners} do
+    get_json_data 204, nil
+  end
+
+  delete %r{/api/author/programs/\d+/learners} do
+    get_json_data 204, nil
+  end
+
   ## Users
 
   get %r{/api/author/users$} do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridge_api
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Jay Shaffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -196,6 +196,7 @@ files:
 - lib/bridge_api/client/enrollment.rb
 - lib/bridge_api/client/group.rb
 - lib/bridge_api/client/manager.rb
+- lib/bridge_api/client/program_enrollment.rb
 - lib/bridge_api/client/user.rb
 - lib/bridge_api/version.rb
 - spec/bridge_api/client/course_template_spec.rb
@@ -204,6 +205,7 @@ files:
 - spec/bridge_api/client/enrollment_spec.rb
 - spec/bridge_api/client/group_spec.rb
 - spec/bridge_api/client/manager_spec.rb
+- spec/bridge_api/client/program_enrollment_spec.rb
 - spec/bridge_api/client/user_spec.rb
 - spec/bridge_api/client_spec.rb
 - spec/fixtures/course.json
@@ -216,6 +218,7 @@ files:
 - spec/fixtures/enrollments.json
 - spec/fixtures/group.json
 - spec/fixtures/managers.json
+- spec/fixtures/program_enrollments.json
 - spec/fixtures/programs.json
 - spec/fixtures/user.json
 - spec/fixtures/users.json
@@ -241,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Bridge API
@@ -252,6 +255,7 @@ test_files:
 - spec/bridge_api/client/enrollment_spec.rb
 - spec/bridge_api/client/group_spec.rb
 - spec/bridge_api/client/manager_spec.rb
+- spec/bridge_api/client/program_enrollment_spec.rb
 - spec/bridge_api/client/user_spec.rb
 - spec/bridge_api/client_spec.rb
 - spec/fixtures/course.json
@@ -264,9 +268,9 @@ test_files:
 - spec/fixtures/enrollments.json
 - spec/fixtures/group.json
 - spec/fixtures/managers.json
+- spec/fixtures/program_enrollments.json
 - spec/fixtures/programs.json
 - spec/fixtures/user.json
 - spec/fixtures/users.json
 - spec/support/fake_bridge.rb
 - spec/test_helper.rb
-has_rdoc: