bearcat 1.0.0 → 1.5.24

data/spec/bearcat/client/users_spec.rb

@@ -31,6 +31,13 @@ describe Bearcat::Client::Users do
       user_avatars.first['type'].should == 'gravatar'
     end
 
+    it "returns the user details" do
+      stub_get(@client, "/api/v1/users/1").to_return(json_response("user_details.json"))
+      user_detail = @client.user_detail(1)
+      user_detail["id"].should ==  1
+      user_detail["name"].should == "testuser@instructure.com"
+    end
+
     it "returns a users profile" do
       stub_get(@client, "/api/v1/users/1/profile").to_return(json_response("user_profile.json"))
       user_profile = @client.user_profile(1)
@@ -38,6 +45,14 @@ describe Bearcat::Client::Users do
       user_profile["time_zone"].should == "America/Denver"
     end
 
+    it "returns a users logins" do
+      stub_get(@client, "/api/v1/users/1/logins").to_return(json_response("user_logins.json"))
+      user_logins = @client.user_logins(1)
+      user_logins.count.should == 1
+      user_logins.first['account_id'].should == 2
+      user_logins.first['unique_id'].should == "test@instructure.com"
+    end
+
     it "returns a users page_views" do
       stub_get(@client, "/api/v1/users/1/page_views").to_return(json_response("user_page_views.json"))
       page_views = @client.page_views(1)
@@ -47,6 +62,28 @@ describe Bearcat::Client::Users do
                                                    'real_user'=>nil, 'account'=>1}
     end
 
+    it 'returns communication channels for user' do
+      stub_get(@client, "/api/v1/users/1/communication_channels").to_return(json_response("communication_channels.json"))
+      com_channels = @client.communication_channels(1)
+      com_channels.members.count.should == 1
+      com_channels.members.first['address'].should == 'brandonbr@instructure.com'
+    end
+
+    it 'returns assignments for a user' do
+      stub_get(@client, "/api/v1/users/1/courses/1/assignments").to_return(json_response("assignments.json"))
+      assignments = @client.user_assignments(1, 1)
+      assignments.count.should == 2
+      assignments.first["assignment_group_id"].should == 53
+      assignments.first["id"].should == 123
+      assignments.first["due_at"].should == nil
+    end
+
+    it 'retuns a users dashboard' do
+      stub_get(@client, "/api/v1/users/1/dashboard_positions").to_return(json_response("dashboard.json"))
+      dashboard = @client.dashboard_positions(1)
+      dashboard["dashboard_positions"].length.should == 2
+    end
+
     describe 'user custom data' do
       before (:each) do
         @query = {"ns" => "com.test.app"}
@@ -100,6 +137,12 @@ describe Bearcat::Client::Users do
       custom_food_data["data"]["food"]["least_favorite"].should == "water mellon"
     end
 
+    it "merges user info" do
+      body = {}
+      stub_put(@client, "/api/v1/users/1/merge_into/2").with(body: body).to_return(json_response('merge_user.json'))
+      user = @client.user_merge(1,2)
+    end
+
   end
 
   context 'DELETE' do

data/spec/bearcat/client_spec.rb

@@ -1,16 +1,13 @@
 require 'helper'
 
 describe Bearcat::Client do
-
   it "sets the domain" do
     client = Bearcat::Client.new(domain: "http://canvas.instructure.com")
     client.config[:domain].should == "http://canvas.instructure.com"
-
   end
 
   it "sets the authtoken" do
     client = Bearcat::Client.new(token: "test_token")
     client.config[:token].should == "test_token"
   end
-
-end
+end

data/spec/bearcat/rate_limiting_spec.rb

@@ -0,0 +1,62 @@
+require 'helper'
+
+require 'sidekiq'
+
+describe Bearcat::RateLimiting do
+  let!(:subject) { Bearcat::RateLimiting::RedisLimiter.new }
+  let!(:client) { Bearcat::Client.new(prefix: "http://canvas.instructure.com", rate_limiter: subject, token: SecureRandom.hex) }
+  let!(:token) { client.send(:rate_limit_key) }
+
+  def fillup(count, rate: 100)
+    count.times do
+      subject.apply(token) do
+        rate
+      end
+    end
+  end
+
+  it "fills the bucket with each request" do
+    allow(Time).to receive(:now).and_return(Time.at(5000))
+    expect(subject).to_not receive(:sleep)
+    fillup(5)
+    expect(subject.increment(token, 0, 0)).to eql({ count: 500.0, timestamp: 5000.0 })
+  end
+
+  it "drains the bucket over time" do
+    allow(Time).to receive(:now).and_return(Time.at(5000))
+    expect(subject).to_not receive(:sleep)
+    fillup(5)
+
+    allow(Time).to receive(:now).and_return(Time.at(5009))
+    expect(subject.increment(token, 0, 0)).to eql({ count: 410.0, timestamp: 5009.0 })
+  end
+
+  it "sleeps requests when full" do
+    allow(Time).to receive(:now).and_return(Time.at(5000))
+    expect(subject).to receive(:sleep).at_least(:once)
+    fillup(10)
+  end
+
+  it "rate limits requests" do
+    allow(Time).to receive(:now).and_return(Time.at(5000))
+    allow(subject).to receive(:sleep)
+    fillup(10)
+
+    stub_request(:get, /.*/).to_return(body: "{}")
+    expect(subject).to receive(:sleep).once
+    client.course(1)
+  end
+
+  it "retries after a Canvas 403 - Rate Limited" do
+    stub_request(:get, /.*/).to_return(status: 403, body: "(Rate Limit Exceeded)")
+    expect(subject).to receive(:apply).exactly(3).times.and_call_original
+    expect(subject).to receive(:sleep).twice
+    expect { client.course(1) }.to raise_error(Footrest::HttpError::Forbidden)
+  end
+
+  it "pushes x-rate-limit-remaining to the bucket" do
+    stub_request(:get, /.*/).to_return(headers: { 'X-Rate-Limit-Remaining' => 120 }, body: "{}")
+    expect(subject).to receive(:checkin_known).with(token, 20)
+    client.course(1)
+  end
+end

data/spec/bearcat/stub_bearcat_spec.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+require 'bearcat/spec_helpers'
+
+describe Bearcat::SpecHelpers do
+  include Bearcat::SpecHelpers
+  let!(:client) { Bearcat::Client.new(prefix: "http://canvas.instructure.com", token: SecureRandom.hex) }
+
+  describe "#stub_bearcat" do
+    it "works as expected" do
+      stub_bearcat(:course).to_return(body: { id: 10 })
+      expect(client.course(1)[:id]).to eql 10
+    end
+  end
+end

data/spec/fixtures/access_token.json

@@ -0,0 +1,3 @@
+{
+  "access_token": "foo_bar_token"
+}

data/spec/fixtures/account_admin_create.json

@@ -0,0 +1,14 @@
+{
+  "id": 99,
+  "role": "AccountAdmin",
+  "role_id": 1,
+  "user": {
+    "id": 1575,
+   "name": "Dummy User 4",
+   "sortable_name": "4, Dummy User",
+   "short_name": "Dummy User 4",
+   "sis_user_id": "user1_sis_id",
+   "sis_login_id": "dummy_user_4",
+   "login_id": "dummy_user_4"
+  }
+}

data/spec/fixtures/account_admin_delete.json

@@ -0,0 +1,15 @@
+{
+  "id": 99,
+  "role": "AccountAdmin",
+  "role_id": 1,
+  "user": {
+    "id": 1575,
+   "name": "Dummy User 4",
+   "sortable_name": "4, Dummy User",
+   "short_name": "Dummy User 4",
+   "sis_user_id": "user1_sis_id",
+   "sis_login_id": "dummy_user_4",
+   "login_id": "dummy_user_4"
+  },
+  "status": "deleted"
+}

data/spec/fixtures/account_admins.json

@@ -0,0 +1,54 @@
+[
+    {
+        "id": 3,
+        "role": "AccountAdmin",
+        "role_id": 1,
+        "user": {
+            "id": 32,
+            "name": "first admin",
+            "sortable_name": "admin, first",
+            "short_name": "first admin",
+            "sis_user_id": "firstadmin",
+            "integration_id": null,
+            "sis_login_id": "firstadmin",
+            "sis_import_id": null,
+            "login_id": "firstadmin"
+        }
+    },
+    {
+        "id": 4,
+        "role": "AccountAdmin",
+        "role_id": 1,
+        "user": {
+            "id": 35,
+            "name": "second admin",
+            "sortable_name": "admin, second",
+            "short_name": "second admin",
+            "login_id": "secondadmin"
+        }
+    },
+    {
+        "id": 5,
+        "role": "AccountAdmin",
+        "role_id": 1,
+        "user": {
+            "id": 36,
+            "name": "third admin",
+            "sortable_name": "admin, third",
+            "short_name": "third admin",
+            "login_id": "thirdadmin@example.com"
+        }
+    },
+    {
+        "id": 6,
+        "role": "Custom Admin",
+        "role_id": 13,
+        "user": {
+            "id": 39,
+            "name": "fourth admin",
+            "sortable_name": "admin, fourth",
+            "short_name": "fourth admin",
+            "login_id": "fourthadmin"
+        }
+    }
+]

data/spec/fixtures/account_courses.json

@@ -0,0 +1,48 @@
+[
+  {
+    "account_id": 3,
+    "course_code": "sub1c1",
+    "default_view": "feed",
+    "enrollment_term_id": 3,
+    "grading_standard_id": null,
+    "id": 1,
+    "is_public": false,
+    "name": "Sub1 Course1",
+    "start_at": "2015-02-24T19:04:00Z",
+    "end_at": null,
+    "public_syllabus": false,
+    "storage_quota_mb": 500,
+    "is_public_to_auth_users": false,
+    "apply_assignment_group_weights": false,
+    "calendar": {
+      "ics": "http://localhost:3000/feeds/calendars/course_jknx1huncbUV3gQSIHfYjFO0uHyBBs53hBQb9RYA.ics"
+    },
+    "sis_course_id": "2015-TVY15-7006-21094202-832271",
+    "integration_id": null,
+    "hide_final_grades": false,
+    "workflow_state": "available"
+    },
+  {
+    "account_id": 4,
+    "course_code": "sub2c1",
+    "default_view": "feed",
+    "enrollment_term_id": 1,
+    "grading_standard_id": null,
+    "id": 2,
+    "is_public": null,
+    "name": "Sub2 Cours1",
+    "start_at": "2015-02-24T19:05:03Z",
+    "end_at": null,
+    "public_syllabus": false,
+    "storage_quota_mb": 500,
+    "is_public_to_auth_users": false,
+    "apply_assignment_group_weights": false,
+    "calendar": {
+      "ics": "http://localhost:3000/feeds/calendars/course_ugQF3mnjRQ1k5XDGBr6WgUl3a087vUSQHwwzqeYZ.ics"
+    },
+    "sis_course_id": null,
+    "integration_id": null,
+    "hide_final_grades": false,
+    "workflow_state": "available"
+  }
+]

data/spec/fixtures/account_grading_standards.json

@@ -0,0 +1,20 @@
+{
+  "id":1,
+  "title":"account grading scheme",
+  "context_id":1,
+  "context_type":"Account",
+  "grading_scheme":[
+    {"name":"A","value":0.94},
+    {"name":"A-","value":0.9},
+    {"name":"B+","value":0.87},
+    {"name":"B","value":0.84},
+    {"name":"B-","value":0.8},
+    {"name":"C+","value":0.77},
+    {"name":"C","value":0.74},
+    {"name":"C-","value":0.7},
+    {"name":"D+","value":0.67},
+    {"name":"D","value":0.64},
+    {"name":"D-","value":0.61},
+    {"name":"F","value":0.0}
+  ]
+}

data/spec/fixtures/account_groups.json

@@ -0,0 +1,42 @@
+[
+  {
+    "id": 1,
+    "name": "2010",
+    "max_membership": null,
+    "is_public": false,
+    "join_level": "invitation_only",
+    "group_category_id": 22446,
+    "description": null,
+    "members_count": 7,
+    "storage_quota_mb": 50,
+    "context_type": "Account",
+    "account_id": 97006,
+    "avatar_url": null,
+    "role": null,
+    "leader": null,
+    "sis_group_id": null,
+    "sis_import_id": null,
+    "has_submission": false,
+    "concluded": false
+  },
+  {
+    "id": 3,
+    "name": "UI Test Groups",
+    "max_membership": null,
+    "is_public": false,
+    "join_level": "invitation_only",
+    "group_category_id": 13091,
+    "description": null,
+    "members_count": 6,
+    "storage_quota_mb": 50,
+    "context_type": "Account",
+    "account_id": 97006,
+    "avatar_url": null,
+    "role": null,
+    "leader": null,
+    "sis_group_id": null,
+    "sis_import_id": null,
+    "has_submission": false,
+    "concluded": false
+  }
+]

data/spec/fixtures/account_role.json

@@ -0,0 +1,34 @@
+{
+  "id": 1,
+  "role": "AccountAdmin",
+  "label": "Account Admin",
+  "base_role_type": "AccountMembership",
+  "workflow_state": "built_in",
+  "permissions": {
+    "read_forum": {
+      "enabled": true,
+      "locked": false,
+      "readonly": false,
+      "explicit": false
+    },
+    "post_to_forum": {
+      "enabled": true,
+      "locked": false,
+      "readonly": false,
+      "explicit": false
+    },
+    "moderate_forum": {
+      "enabled": true,
+      "locked": false,
+      "readonly": false,
+      "explicit": false
+    },
+    "manage_catalog": {
+      "enabled": true,
+      "locked": false,
+      "readonly": false,
+      "explicit": false
+    }
+  }
+}
+

data/spec/fixtures/account_roles.json

@@ -0,0 +1,35 @@
+[
+   {
+      "id": 1,
+      "role": "AccountAdmin",
+      "label": "Account Admin",
+      "base_role_type": "AccountMembership",
+      "workflow_state": "built_in",
+      "permissions": {
+         "read_forum": {
+            "enabled": true,
+            "locked": false,
+            "readonly": false,
+            "explicit": false
+         },
+         "post_to_forum": {
+            "enabled": true,
+            "locked": false,
+            "readonly": false,
+            "explicit": false
+         },
+         "moderate_forum": {
+            "enabled": true,
+            "locked": false,
+            "readonly": false,
+            "explicit": false
+         },
+         "manage_catalog": {
+            "enabled": true,
+            "locked": false,
+            "readonly": false,
+            "explicit": false
+         }
+      }
+   }
+]

data/spec/fixtures/account_sis_imports.json

@@ -0,0 +1,39 @@
+{
+  "sis_imports":
+  [{"created_at": "2017-03-22T03:01:18Z",
+  "started_at": "2017-03-22T03:01:18Z",
+  "ended_at": "2017-03-22T03:01:19Z",
+  "updated_at": "2017-03-22T03:01:19Z",
+  "progress": 100,
+  "id": 30,
+  "workflow_state": "imported",
+  "data": {
+  "import_type": "instructure_csv",
+  "supplied_batches": [
+  "course"
+  ],
+  "counts": {
+  "accounts": 0,
+  "terms": 0,
+  "abstract_courses": 0,
+  "courses": 1,
+  "sections": 0,
+  "xlists": 0,
+  "users": 0,
+  "user_observers": 0,
+  "enrollments": 0,
+  "groups": 0,
+  "group_memberships": 0,
+  "grade_publishing_results": 0
+  }
+  },
+  "batch_mode": null,
+  "batch_mode_term_id": null,
+  "override_sis_stickiness": null,
+  "add_sis_stickiness": null,
+  "clear_sis_stickiness": null,
+  "diffing_data_set_identifier": null,
+  "diffed_against_import_id": null
+  }
+  ]
+}

data/spec/fixtures/account_sub_accounts.json

@@ -0,0 +1,17 @@
+[
+   {
+      "id": 2,
+      "name": "Manually-Created Courses",
+      "workflow_state": "active",
+      "parent_account_id": 1,
+      "root_account_id": 1,
+      "uuid": "rd7NGVGl7f7913DzKCxFUKh17qMTQRZEJ0k4WW3R",
+      "default_storage_quota_mb": "5000",
+      "default_user_storage_quota_mb": "50",
+      "default_group_storage_quota_mb": "50",
+      "default_time_zone": "America/Denver",
+      "sis_account_id": null,
+      "sis_import_id": null,
+      "integration_id": null
+   }
+]

data/spec/fixtures/accounts.json

@@ -0,0 +1,13 @@
+[
+    {
+        "id": 1,
+        "name": "Local Testing",
+        "parent_account_id": null,
+        "root_account_id": null,
+        "workflow_state": "active",
+        "default_storage_quota_mb": 500,
+        "default_user_storage_quota_mb": 50,
+        "default_group_storage_quota_mb": 50,
+        "default_time_zone": "America/Denver"
+    }
+]

data/spec/fixtures/assignment.json

@@ -0,0 +1,32 @@
+{
+  "assignment_group_id": 53,
+  "automatic_peer_reviews": false,
+  "description": "",
+  "due_at": null,
+  "grade_group_students_individually": false,
+  "grading_standard_id": null,
+  "grading_type": "points",
+  "group_category_id": null,
+  "id": 1,
+  "lock_at": null,
+  "peer_reviews": false,
+  "points_possible": 0,
+  "position": 14,
+  "unlock_at": null,
+  "course_id": 3,
+  "name": "Start",
+  "submission_types": [
+      "external_tool"
+  ],
+  "turnitin_enabled": false,
+  "turnitin_settings": {
+      "originality_report_visibility": "immediate",
+      "s_paper_check": true,
+      "internet_check": true,
+      "journal_check": true,
+      "exclude_biblio": true,
+      "exclude_quoted": true,
+      "exclude_small_matches_type": null,
+      "exclude_small_matches_value": null
+  }
+}

data/spec/fixtures/assignment_group.json

@@ -0,0 +1,7 @@
+{
+  "group_weight": 500,
+  "id": 2,
+  "name": "Quizzes",
+  "position": 2,
+  "rules": {}
+}

data/spec/fixtures/assignment_groups.json

@@ -0,0 +1,16 @@
+[
+    {
+        "group_weight": 500,
+        "id": 2,
+        "name": "Quizzes",
+        "position": 2,
+        "rules": {}
+    },
+    {
+        "group_weight": 500,
+        "id": 3,
+        "name": "Assignments",
+        "position": 3,
+        "rules": {}
+    }
+]

data/spec/fixtures/blueprint_migration.json

@@ -0,0 +1,12 @@
+{
+  "id": 1,
+  "template_id": 2,
+  "subscription_id": 101,
+  "user_id": 3,
+  "workflow_state": "running",
+  "created_at": "2013-08-28T23:59:00-06:00",
+  "exports_started_at": "2013-08-28T23:59:00-06:00",
+  "imports_queued_at": "2013-08-28T23:59:00-06:00",
+  "imports_completed_at": "2013-08-28T23:59:00-06:00",
+  "comment": "Fixed spelling in question 3 of midterm exam"
+}

data/spec/fixtures/blueprint_subscriptions.json

@@ -0,0 +1,5 @@
+{
+  "id": 101,
+  "template_id": 1,
+  "blueprint_course": {"id":2,"name":"Biology 100 Blueprint","course_code":"BIOL 100 BP","term_name":"Default term"}
+}

data/spec/fixtures/blueprint_template.json

@@ -0,0 +1,7 @@
+{
+  "id": 1,
+  "course_id": 2,
+  "last_export_completed_at": "2013-08-28T23:59:00-06:00",
+  "associated_course_count": 3,
+  "latest_migration": null
+}

data/spec/fixtures/blueprint_update_assocations_success.json

@@ -0,0 +1,3 @@
+{
+    "success": true
+}

data/spec/fixtures/communication_channels.json

@@ -0,0 +1,10 @@
+[
+    {
+        "id": 1,
+        "position": 1,
+        "user_id": 1,
+        "workflow_state": "active",
+        "address": "brandonbr@instructure.com",
+        "type": "email"
+    }
+]

data/spec/fixtures/content_export.json

@@ -0,0 +1,9 @@
+{
+  "id": 101,
+  "created_at": "2014-01-01T00:00:00Z",
+  "export_type": "common_cartridge",
+  "attachment": {"url":"https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh"},
+  "progress_url": "https://example.com/api/v1/progress/4",
+  "user_id": 4,
+  "workflow_state": "exported"
+}

data/spec/fixtures/content_migration_files/content_migration.json

@@ -0,0 +1,13 @@
+{
+  "id": 370663,
+  "migration_type": "common_cartridge_importer",
+  "migration_type_title": "Canvas Cartridge Importer",
+  "migration_issues_url": "https://example.com/api/v1/courses/1/content_migrations/1/migration_issues",
+  "attachment": {"url": "https://example.com/api/v1/courses/1/content_migrations/1/download_archive"},
+  "progress_url": "https://example.com/api/v1/progress/4",
+  "user_id": 4,
+  "workflow_state": "running",
+  "started_at": "2012-06-01T00:00:00-06:00",
+  "finished_at": "2012-06-01T00:00:00-06:00",
+  "pre_attachment": {"upload_url": "",  "message": "file exceeded quota", "upload_params": {}}
+}

data/spec/fixtures/course_copy.json

@@ -0,0 +1,18 @@
+{
+  "finished_at": null,
+  "id": 199,
+  "migration_type": "course_copy_importer",
+  "started_at": null,
+  "user_id": 1,
+  "workflow_state": "running",
+  "created_at": "2015-09-11T13:27:42Z",
+  "migration_issues_url": "http://localhost:3000/api/v1/courses/128/content_migrations/199/migration_issues",
+  "migration_issues_count": 0,
+  "settings": {
+    "source_course_id": 2,
+    "source_course_name": "Course 2",
+    "source_course_html_url": "http://localhost:3000/courses/2"
+  },
+  "progress_url": "http://localhost:3000/api/v1/progress/200",
+  "migration_type_title": "Course Copy"
+}