bearcat 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1047c6475c6879d0406a32058b0cc88a1a159c95
-  data.tar.gz: 6cb156cb6106f68ac2284d45e3e05764dc5dd1b4
+  metadata.gz: 33acb91dffeaac66dddee65d11ae3adf74fae5a5
+  data.tar.gz: ed319de8739a90563f130a35d51c102ea2bbdb8f
 SHA512:
-  metadata.gz: 788499c589eeba61c1d48a2fad38d605865a6796a09a1679a6aa0c2dba55212248dc6273f5e3e4792312fc6040c29b9cdc0c2689eb41fa87ac9b5d58e7245560
-  data.tar.gz: 6727e28c3511252ae2f87fe49100734514b8fb277aae30a106645fc7fa4cb7217cfd39df3bf68acde630192b2e7bcfdf6eacb5d882767762a445d17561ffde49
+  metadata.gz: f82bab13382211c00f34cab2262d1492ec731b807eb76f86bceea3ee65819d247a9508edf73878142524400eaf888fefce7e1406f698dae98d25b14148d9b949
+  data.tar.gz: 5d3ba85086d8473021007a7eb3993b0d6d3e4eb28f40c6e1886b3c479433a11422066df8e2ce33b3bb8cfadde7a22962696f6156e9bbd89d76b8c0fe4d4a6116

data/lib/bearcat/client.rb

@@ -32,6 +32,7 @@ module Bearcat
     require 'bearcat/client/analytics'
     require 'bearcat/client/module_items'
     require 'bearcat/client/content_migrations'
+    require 'bearcat/client/content_exports'
 
     include Assignments
     include Accounts
@@ -63,6 +64,7 @@ module Bearcat
     include Folders
     include ModuleItems
     include ContentMigrations
+    include ContentExports
 
 
     # Override Footrest request for ApiArray support

data/lib/bearcat/client/content_exports.rb

@@ -0,0 +1,39 @@
+module Bearcat
+  class Client < Footrest::Client
+    module ContentExports
+
+      def create_content_export(id, type, params = {})
+        post("/api/v1/#{type}/#{id}/content_exports", params)
+      end
+
+      def create_course_export(id, params = {})
+        create_content_export(id, 'courses', params)
+      end
+
+      def create_group_export(id, params = {})
+        create_content_export(id, 'groups', params)
+      end
+
+      def create_user_export(id, params = {})
+        create_content_export(id, 'users', params)
+      end
+
+      def get_content_export(id, export_id, type, params = {})
+        get("/api/v1/#{type}/#{id}/content_exports/#{export_id}", params)
+      end
+
+      def get_course_export(course_id, export_id, params = {})
+        get_content_export(course_id, export_id, 'courses', params)
+      end
+
+      def get_group_export(group_id, export_id, params = {})
+        get_content_export(group_id, export_id, 'groups', params)
+      end
+
+      def get_user_export(user_id, export_id, params = {})
+        get_content_export(user_id, export_id, 'users', params)
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/content_migrations.rb

@@ -9,6 +9,46 @@ module Bearcat
         confirm_file_upload(confirmation_url)
       end
 
+      def get_content_migration(id, migration_id, type, params = {})
+        get("/api/v1/#{type}/#{id}/content_migrations/#{migration_id}", params)
+      end
+
+      def get_account_content_migration(account_id, migration_id, params = {})
+        get_content_migration(account_id, migration_id, 'accounts', params = {})
+      end
+
+      def get_course_content_migration(course_id, migration_id, params = {})
+        get_content_migration(course_id, migration_id, 'courses', params = {})
+      end
+
+      def get_group_content_migration(group_id, migration_id, params = {})
+        get_content_migration(group_id, migration_id, 'groups', params = {})
+      end
+
+      def get_user_content_migration(user_id, migration_id, params = {})
+        get_content_migration(user_id, migration_id, 'users', params = {})
+      end
+
+      def create_content_migration(id, type, params = {})
+        post("/api/v1/#{type}/#{id}/content_migrations", params)
+      end
+
+      def create_account_content_migration(account_id, params = {})
+        create_content_migration(account_id, 'accounts', params)
+      end
+
+      def create_course_content_migration(course_id, params = {})
+        create_content_migration(course_id, 'courses', params)
+      end
+
+      def create_group_content_migration(group_id, params = {})
+        create_content_migration(group_id, 'groups', params)
+      end
+
+      def create_user_content_migration(user_id, params = {})
+        create_content_migration(user_id, 'users', params)
+      end
+
     end
   end
 end

data/lib/bearcat/version.rb

@@ -1,3 +1,3 @@
 module Bearcat
-  VERSION = '1.3.4' unless defined?(Bearcat::VERSION)
+  VERSION = '1.3.5' unless defined?(Bearcat::VERSION)
 end

data/spec/bearcat/client/content_exports_spec.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+describe Bearcat::Client::ContentExports do
+  before do
+    @client = Bearcat::Client.new(prefix: "http://canvas.instructure.com", token: "test_token")
+  end
+
+  describe 'create_course_export' do
+    it "creates a course export" do
+      stub_post(@client, "/api/v1/courses/3/content_exports").to_return(json_response("content_export.json"))
+      course = @client.create_course_export(3)
+      course['export_type'].should == 'common_cartridge'
+      course['attachment'].should == {"url" => "https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh"}
+      course['progress_url'].should == "https://example.com/api/v1/progress/4"
+    end
+  end
+
+  describe 'create_group_export' do
+    it "creates a group export" do
+      stub_post(@client, "/api/v1/groups/3/content_exports").to_return(json_response("content_export.json"))
+      group = @client.create_group_export(3)
+      group['export_type'].should == 'common_cartridge'
+      group['attachment'].should == {"url" => "https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh"}
+      group['progress_url'].should == "https://example.com/api/v1/progress/4"
+    end
+  end
+
+  describe 'create_user_export' do
+    it "creates a user export" do
+      stub_post(@client, "/api/v1/users/3/content_exports").to_return(json_response("content_export.json"))
+      user = @client.create_user_export(3)
+      user['export_type'].should == 'common_cartridge'
+      user['attachment'].should == {"url" => "https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh"}
+      user['progress_url'].should == "https://example.com/api/v1/progress/4"
+    end
+  end
+
+  describe 'get_course_export' do
+    it "gets a course export" do
+      stub_get(@client, "/api/v1/courses/3/content_exports/1").to_return(json_response("content_export.json"))
+      course = @client.get_course_export(3, 1)
+      course['export_type'].should == 'common_cartridge'
+      course['attachment'].should == {"url" => "https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh"}
+      course['progress_url'].should == "https://example.com/api/v1/progress/4"
+    end
+  end
+
+  describe 'get_group_export' do
+    it "gets a group export" do
+      stub_get(@client, "/api/v1/groups/3/content_exports/1").to_return(json_response("content_export.json"))
+      group = @client.get_group_export(3, 1)
+      group['export_type'].should == 'common_cartridge'
+      group['attachment'].should == {"url" => "https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh"}
+      group['progress_url'].should == "https://example.com/api/v1/progress/4"
+    end
+  end
+
+  describe 'get_user_export' do
+    it "gets a user export" do
+      stub_get(@client, "/api/v1/users/3/content_exports/1").to_return(json_response("content_export.json"))
+      user = @client.get_user_export(3, 1)
+      user['export_type'].should == 'common_cartridge'
+      user['attachment'].should == {"url" => "https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh"}
+      user['progress_url'].should == "https://example.com/api/v1/progress/4"
+    end
+  end
+
+end

data/spec/bearcat/client/content_migrations_spec.rb

@@ -19,4 +19,76 @@ describe Bearcat::Client::ContentMigrations do
     expect(response['id']).to eq 293
   end
 
+  describe 'get_group_content_migration' do
+    it "gets a content_migration" do
+      stub_get(@client, "/api/v1/accounts/3/content_migrations/1").to_return(json_response("content_migration_files/content_migration.json"))
+      account = @client.get_account_content_migration(3, 1)
+      account['migration_type'].should == 'common_cartridge_importer'
+      account['migration_type_title'].should == "Canvas Cartridge Importer"
+    end
+  end
+
+  describe 'get_course_content_migration' do
+    it "gets a content_migration" do
+      stub_get(@client, "/api/v1/courses/3/content_migrations/1").to_return(json_response("content_migration_files/content_migration.json"))
+      course = @client.get_course_content_migration(3, 1)
+      course['migration_type'].should == 'common_cartridge_importer'
+      course['migration_type_title'].should == "Canvas Cartridge Importer"
+    end
+  end
+
+  describe 'get_group_content_migration' do
+    it "gets a content_migration" do
+      stub_get(@client, "/api/v1/groups/3/content_migrations/1").to_return(json_response("content_migration_files/content_migration.json"))
+      group = @client.get_group_content_migration(3, 1)
+      group['migration_type'].should == 'common_cartridge_importer'
+      group['migration_type_title'].should == "Canvas Cartridge Importer"
+    end
+  end
+
+  describe 'get_user_content_migration' do
+    it "gets a content_migration" do
+      stub_get(@client, "/api/v1/users/3/content_migrations/1").to_return(json_response("content_migration_files/content_migration.json"))
+      user = @client.get_user_content_migration(3, 1)
+      user['migration_type'].should == 'common_cartridge_importer'
+      user['migration_type_title'].should == "Canvas Cartridge Importer"
+    end
+  end
+
+  describe 'create_account_content_migration' do
+    it "creates a account migration" do
+      stub_post(@client, "/api/v1/accounts/3/content_migrations").to_return(json_response('content_migration_files/content_migration.json'))
+      account = @client.create_account_content_migration(3)
+      account['migration_type'].should == 'common_cartridge_importer'
+      account['migration_type_title'].should == "Canvas Cartridge Importer"
+    end
+  end
+
+  describe 'create_course_content_migration' do
+    it "creates a course migration" do
+      stub_post(@client, "/api/v1/courses/3/content_migrations").to_return(json_response('content_migration_files/content_migration.json'))
+      course = @client.create_course_content_migration(3)
+      course['migration_type'].should == 'common_cartridge_importer'
+      course['migration_type_title'].should == "Canvas Cartridge Importer"
+    end
+  end
+
+  describe 'create_group_content_migration' do
+    it "creates a group migration" do
+      stub_post(@client, "/api/v1/groups/3/content_migrations").to_return(json_response('content_migration_files/content_migration.json'))
+      group = @client.create_group_content_migration(3)
+      group['migration_type'].should == 'common_cartridge_importer'
+      group['migration_type_title'].should == "Canvas Cartridge Importer"
+    end
+  end
+
+  describe 'create_user_content_migration' do
+    it "creates a user migration" do
+      stub_post(@client, "/api/v1/users/3/content_migrations").to_return(json_response('content_migration_files/content_migration.json'))
+      user = @client.create_user_content_migration(3)
+      user['migration_type'].should == 'common_cartridge_importer'
+      user['migration_type_title'].should == "Canvas Cartridge Importer"
+    end
+  end
+
 end

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": {}}
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - Nathan Mills, Jake Sorce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -114,6 +114,7 @@ files:
 - lib/bearcat/client/calendar_events.rb
 - lib/bearcat/client/canvas_files.rb
 - lib/bearcat/client/conferences.rb
+- lib/bearcat/client/content_exports.rb
 - lib/bearcat/client/content_migrations.rb
 - lib/bearcat/client/conversations.rb
 - lib/bearcat/client/courses.rb
@@ -145,6 +146,7 @@ files:
 - spec/bearcat/client/calendar_events_spec.rb
 - spec/bearcat/client/canvas_files_spec.rb
 - spec/bearcat/client/conferences_spec.rb
+- spec/bearcat/client/content_exports_spec.rb
 - spec/bearcat/client/content_migrations_spec.rb
 - spec/bearcat/client/conversations_spec.rb
 - spec/bearcat/client/courses_spec.rb
@@ -197,6 +199,8 @@ files:
 - spec/fixtures/cc.imscc
 - spec/fixtures/communication_channels.json
 - spec/fixtures/conclude_enrollment.json
+- spec/fixtures/content_export.json
+- spec/fixtures/content_migration_files/content_migration.json
 - spec/fixtures/content_migration_files/response.json
 - spec/fixtures/content_migration_files/upload_success.json
 - spec/fixtures/conversation.json
@@ -301,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Canvas API
@@ -313,6 +317,7 @@ test_files:
 - spec/bearcat/client/calendar_events_spec.rb
 - spec/bearcat/client/canvas_files_spec.rb
 - spec/bearcat/client/conferences_spec.rb
+- spec/bearcat/client/content_exports_spec.rb
 - spec/bearcat/client/content_migrations_spec.rb
 - spec/bearcat/client/conversations_spec.rb
 - spec/bearcat/client/courses_spec.rb
@@ -365,6 +370,8 @@ test_files:
 - spec/fixtures/cc.imscc
 - spec/fixtures/communication_channels.json
 - spec/fixtures/conclude_enrollment.json
+- spec/fixtures/content_export.json
+- spec/fixtures/content_migration_files/content_migration.json
 - spec/fixtures/content_migration_files/response.json
 - spec/fixtures/content_migration_files/upload_success.json
 - spec/fixtures/conversation.json