bearcat 0.9.10 → 0.9.12

data/bearcat.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# spec/fixtures/bearcat.jpg Attribution: TassiloRau at the German language Wikipedia
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bearcat/version'
@@ -21,7 +22,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "bundler", ">= 1.0.0"
   gem.add_development_dependency "rspec", "~> 2.6"
   gem.add_development_dependency "webmock"
-  gem.add_development_dependency "debugger"
 
   gem.add_dependency "footrest", ">= 0.2.2"
 end

data/lib/bearcat/client.rb

@@ -1,24 +1,25 @@
-require 'footrest/client'
-require 'bearcat/api_array'
-require 'bearcat/client/assignments'
-require 'bearcat/client/courses'
-require 'bearcat/client/enrollments'
-require 'bearcat/client/outcome_groups'
-require 'bearcat/client/outcomes'
-require 'bearcat/client/sections'
-require 'bearcat/client/o_auth2'
-require 'bearcat/client/groups'
-require 'bearcat/client/conferences'
-require 'bearcat/client/users'
-require 'bearcat/client/reports'
-require 'bearcat/client/accounts'
-require 'bearcat/client/submissions'
-require 'bearcat/client/conversations'
-require 'bearcat/client/modules'
-
 module Bearcat
   class Client < Footrest::Client
 
+    require 'footrest/client'
+    require 'bearcat/api_array'
+    require 'bearcat/client/assignments'
+    require 'bearcat/client/courses'
+    require 'bearcat/client/enrollments'
+    require 'bearcat/client/outcome_groups'
+    require 'bearcat/client/outcomes'
+    require 'bearcat/client/sections'
+    require 'bearcat/client/o_auth2'
+    require 'bearcat/client/groups'
+    require 'bearcat/client/conferences'
+    require 'bearcat/client/users'
+    require 'bearcat/client/reports'
+    require 'bearcat/client/accounts'
+    require 'bearcat/client/submissions'
+    require 'bearcat/client/conversations'
+    require 'bearcat/client/modules'
+    require 'bearcat/client/canvas_files'
+
     include Assignments
     include Accounts
     include Courses
@@ -34,6 +35,7 @@ module Bearcat
     include Submissions
     include Conversations
     include Modules
+    include CanvasFiles
 
 
     # Override Footrest request for ApiArray support

data/lib/bearcat/client/canvas_files.rb

@@ -0,0 +1,51 @@
+module Bearcat
+  class Client < Footrest::Client
+    module CanvasFiles
+
+      def upload_file(api_path, file_path, params = {})
+        declare_response = declare_file(api_path, file_params(file_path).merge(params))
+        confirmation_url = post_file(declare_response['upload_url'], declare_response['upload_params'], file_path)
+        confirm_file_upload(confirmation_url)
+      end
+
+      private
+
+      def file_params(file_path)
+        {
+          size: File.open(file_path).size,
+          name: File.basename(file_path)
+        }
+      end
+
+      def declare_file(api_path, params)
+        post(api_path, params)
+      end
+
+      def post_file(url, params, file_path)
+        params['Filename'] = File.basename(file_path)
+        params['file'] = Faraday::UploadIO.new(file_path, params['content-type'])
+
+        response = upload_connection.post(url, params)
+        if response.status == (302 || 303) #success if it is a redirect
+          response.headers['Location']
+        else
+          raise 'FailedFileUpload'
+        end
+      end
+
+      def confirm_file_upload(url)
+        uri = URI(url)
+        post(uri.path, CGI::parse(uri.query))
+      end
+
+      def upload_connection
+        Faraday.new do |f|
+          f.request :multipart
+          f.request :url_encoded
+          f.adapter :net_http
+        end
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/submissions.rb

@@ -6,6 +6,32 @@ module Bearcat
         get("/api/v1/courses/#{course.to_s}/students/submissions", params)
       end
 
+      def course_submission(course, assignment, params)
+        post("/api/v1/courses/#{course}/assignments/#{assignment}/submissions", params)
+      end
+
+      def section_submission(section, assignment, params)
+        post("/api/v1/sections/#{section}/assignments/#{assignment}/submissions", params)
+      end
+
+      def course_file_upload_submission(course, assignment, user, file_path, params={})
+        response = upload_file("/api/v1/courses/#{course}/assignments/#{assignment}/submissions/#{user}/files", file_path, params)
+        params['submission'] = {
+          'submission_type' => 'online_upload',
+          'file_ids'=> [response['id']]
+        }
+        course_submission(course, assignment, params)
+      end
+
+      def section_file_upload_submission(section, assignment, user, file_path, params={})
+        response = upload_file("/api/v1/sections/#{section}/assignments/#{assignment}/submissions/#{user}/files", file_path, params)
+        params['submission'] = {
+          'submission_type' => 'online_upload',
+          'file_ids'=> [response['id']]
+        }
+        section_submission(section, assignment, params)
+      end
+
     end
   end
-end
+end

data/lib/bearcat/client/users.rb

@@ -40,6 +40,9 @@ module Bearcat
         delete("/api/v1/users/#{user}/custom_data/#{scope}", params)
       end
 
+      def page_views(user, params = {})
+        get("/api/v1/users/#{user}/page_views", params)
+      end
     end
   end
 end

data/lib/bearcat/version.rb

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

data/spec/bearcat/client/canvas_files_spec.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+describe Bearcat::Client::CanvasFiles do
+  before do
+    @client = Bearcat::Client.new(prefix: "http://canvas.instructure.com", token: "test_token")
+  end
+
+  it 'uploads a file' do
+    stub_post(@client, "/my/upload/path").
+      with(:body => {"name" => "bearcat.jpg", "size" => "121363"}).
+      to_return(json_response('canvas_files', 'declare_file.json'))
+
+    stub_request(:post, "https://upload-url.invalid/").
+      to_return(status: 302, headers: {'Location' => 'https://confirm-upload.invalid/confirm?param=true'})
+
+    stub_post(@client, "/confirm").
+      with(:body => {"param" => ["true"]}).to_return(json_response('canvas_files', 'upload_success.json'))
+
+    response = @client.upload_file('my/upload/path', fixture('bearcat.jpg'))
+    expect(response['id']).to eq 123
+  end
+
+  it 'throws an error on a failed file upload' do
+    stub_post(@client, "/my/upload/path").
+      with(:body => {"name" => "bearcat.jpg", "size" => "121363"}).
+      to_return(json_response('canvas_files', 'declare_file.json'))
+
+    stub_request(:post, "https://upload-url.invalid/").
+      to_return(status: 400, headers: {'Location' => 'https://confirm-upload.invalid/confirm?param=true'})
+
+    expect { @client.upload_file('my/upload/path', fixture('bearcat.jpg')) }.to raise_exception
+  end
+
+end

data/spec/bearcat/client/modules_spec.rb

@@ -13,7 +13,7 @@ describe Bearcat::Client::Modules do
   end
 
   it "returns a course items module sequence" do
-    query = {"asset_type" => "assignment", "asset_id" => 22}
+    query = {"asset_type" => "assignment", "asset_id" => '22'}
     stub_get(@client, "/api/v1/courses/1/module_item_sequence").with(query: query).to_return(json_response("module_item_sequence.json"))
     item_sequence = @client.course_module_item_sequence("1", query)
     items = item_sequence["modules"]

data/spec/bearcat/client/submissions_spec.rb

@@ -6,7 +6,7 @@ describe Bearcat::Client::Submissions do
   end
 
   it "returns all submissions for a course" do
-    stub_get(@client, "/api/v1/courses/3/students/submissions").to_return(json_response("submissions.json"))
+    stub_get(@client, "/api/v1/courses/3/students/submissions").to_return(json_response('submissions', "submission.json"))
     submissions = @client.course_submissions(3)
     submissions['assignment_id'].should == 2353405
     submissions['id'].should == 8444510
@@ -21,4 +21,23 @@ describe Bearcat::Client::Submissions do
     submissions['workflow_state'].should =='unsubmitted'
   end
 
+  context 'course' do
+    it "submits a file" do
+      @client.stub(:upload_file).and_return({})
+      stub_post(@client, '/api/v1/courses/1/assignments/2/submissions').to_return(json_response('submissions', 'submission.json'))
+      response = @client.course_file_upload_submission(1, 2, 3, fixture('bearcat.jpg'))
+      response['id'].should == 8444510
+    end
+  end
+
+  context 'section' do
+    it "submits a file" do
+      @client.stub(:upload_file).and_return({})
+      stub_post(@client, '/api/v1/sections/1/assignments/2/submissions').to_return(json_response('submissions', 'submission.json'))
+      response = @client.section_file_upload_submission(1, 2, 3, fixture('bearcat.jpg'))
+      response['id'].should == 8444510
+    end
+  end
+
+
 end

data/spec/bearcat/client/users_spec.rb

@@ -38,6 +38,15 @@ describe Bearcat::Client::Users do
       user_profile["time_zone"].should == "America/Denver"
     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)
+      page_views.members.count.should == 1
+      page_views.members.first['action'].should == 'show'
+      page_views.members.first['links'].should == {'user'=>1, 'context'=>1, 'asset'=>nil,
+                                                   'real_user'=>nil, 'account'=>1}
+    end
+
     describe 'user custom data' do
       before (:each) do
         @query = {"ns" => "com.test.app"}

data/spec/fixtures/canvas_files/declare_file.json

@@ -0,0 +1,14 @@
+{
+    "upload_url": "https://upload-url.invalid",
+    "upload_params": {
+        "AWSAccessKeyId": "ABC123",
+        "Filename": "",
+        "key": "key",
+        "acl": "private",
+        "Policy": "policy",
+        "Signature": "signature",
+        "success_action_redirect": "https://my_redirect.invalid/redirect?my_param=100",
+        "content-type": "image/jpg"
+    },
+    "file_param": "file"
+}

data/spec/fixtures/canvas_files/upload_success.json

@@ -0,0 +1,17 @@
+{
+    "id": 123,
+    "content-type": "image/jpg",
+    "display_name": "bearcat.jpg",
+    "filename": "bearcat.jpg",
+    "url": "https://canvas.instructure.com/files/123/download?download_frd=1&verifier=cdw3",
+    "size": 178559,
+    "created_at": "2014-05-01T17:04:32Z",
+    "updated_at": "2014-05-01T17:04:34Z",
+    "unlock_at": null,
+    "locked": false,
+    "hidden": false,
+    "lock_at": null,
+    "hidden_for_user": false,
+    "thumbnail_url": "https://thumbnail.invalid",
+    "locked_for_user": false
+}

data/spec/fixtures/submissions/submission.json

@@ -0,0 +1,18 @@
+{
+    "assignment_id": 2353405,
+    "attempt": null,
+    "body": null,
+    "grade": "1",
+    "grade_matches_current_submission": null,
+    "graded_at": "2014-02-27T20:22:49Z",
+    "grader_id": 627536,
+    "id": 8444510,
+    "score": 1,
+    "submission_type": null,
+    "submitted_at": null,
+    "url": null,
+    "user_id": 682285,
+    "workflow_state": "unsubmitted",
+    "late": false,
+    "preview_url": "https://canvas.instructure.com/courses/218274/assignments/2353405/submissions/682285?preview=1"
+}

data/spec/fixtures/user_page_views.json

@@ -0,0 +1,31 @@
+[
+    {
+        "action": "show",
+        "asset_type": null,
+        "asset_user_access_id": null,
+        "context_type": "Account",
+        "controller": "accounts",
+        "created_at": "2014-05-28T22:03:32Z",
+        "developer_key_id": null,
+        "http_method": "get",
+        "interaction_seconds": 5,
+        "participated": null,
+        "remote_ip": "70.70.45.79",
+        "render_time": 0.395979262,
+        "session_id": "84fa36c3e18f9d11d8f4fa47ec123525",
+        "summarized": true,
+        "updated_at": "2014-05-28T22:03:32Z",
+        "url": "http:localhost:3000",
+        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.114 Safari/537.36",
+        "user_request": true,
+        "id": "d4e6c140-c8e1-0131-3994-22000ab7c2ed",
+        "contributed": false,
+        "links": {
+            "user": 1,
+            "context": 1,
+            "asset": null,
+            "real_user": null,
+            "account": 1
+        }
+    }
+]

data/spec/helper.rb

@@ -6,8 +6,8 @@ require 'json'
 
 WebMock.disable_net_connect!
 
-def fixture(file)
-  File.new(File.join(File.expand_path("../fixtures", __FILE__), file))
+def fixture(*file)
+  File.new(File.join(File.expand_path("../fixtures", __FILE__), *file))
 end
 
 def stub_get(client, url)
@@ -26,9 +26,9 @@ def stub_delete(client, url)
   stub_request(:delete, "#{client.config[:prefix]}#{url}")
 end
 
-def json_response(file)
+def json_response(*file)
   {
-    :body => fixture(file),
+    :body => fixture(*file),
     :headers => {
       :content_type => 'application/json; charset=utf-8'
     }

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 0.9.10
+  version: 0.9.12
+  prerelease: 
 platform: ruby
 authors:
 - Nathan Mills, Jake Sorce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,20 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -83,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: footrest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -90,6 +86,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -103,12 +100,11 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - bearcat.gemspec
-- lib/bearcat.rb
 - lib/bearcat/api_array.rb
-- lib/bearcat/client.rb
 - lib/bearcat/client/account_reports.rb
 - lib/bearcat/client/accounts.rb
 - lib/bearcat/client/assignments.rb
+- lib/bearcat/client/canvas_files.rb
 - lib/bearcat/client/conferences.rb
 - lib/bearcat/client/conversations.rb
 - lib/bearcat/client/courses.rb
@@ -122,9 +118,12 @@ files:
 - lib/bearcat/client/sections.rb
 - lib/bearcat/client/submissions.rb
 - lib/bearcat/client/users.rb
+- lib/bearcat/client.rb
 - lib/bearcat/version.rb
+- lib/bearcat.rb
 - spec/bearcat/client/accounts_spec.rb
 - spec/bearcat/client/assignments_spec.rb
+- spec/bearcat/client/canvas_files_spec.rb
 - spec/bearcat/client/conferences_spec.rb
 - spec/bearcat/client/conversations_spec.rb
 - spec/bearcat/client/courses_spec.rb
@@ -146,6 +145,9 @@ files:
 - spec/fixtures/add_user.json
 - spec/fixtures/assignment_section_override.json
 - spec/fixtures/assignments.json
+- spec/fixtures/bearcat.jpg
+- spec/fixtures/canvas_files/declare_file.json
+- spec/fixtures/canvas_files/upload_success.json
 - spec/fixtures/conclude_enrollment.json
 - spec/fixtures/conversation.json
 - spec/fixtures/course.json
@@ -182,40 +184,43 @@ files:
 - spec/fixtures/section_enrollments.json
 - spec/fixtures/single_account.json
 - spec/fixtures/start_report.json
-- spec/fixtures/submissions.json
+- spec/fixtures/submissions/submission.json
 - spec/fixtures/update_outcome.json
 - spec/fixtures/update_outcome_group.json
 - spec/fixtures/update_section.json
 - spec/fixtures/user_avatars.json
 - spec/fixtures/user_enrollments.json
+- spec/fixtures/user_page_views.json
 - spec/fixtures/user_profile.json
 - spec/helper.rb
 homepage: 
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Canvas API
 test_files:
 - spec/bearcat/client/accounts_spec.rb
 - spec/bearcat/client/assignments_spec.rb
+- spec/bearcat/client/canvas_files_spec.rb
 - spec/bearcat/client/conferences_spec.rb
 - spec/bearcat/client/conversations_spec.rb
 - spec/bearcat/client/courses_spec.rb
@@ -237,6 +242,9 @@ test_files:
 - spec/fixtures/add_user.json
 - spec/fixtures/assignment_section_override.json
 - spec/fixtures/assignments.json
+- spec/fixtures/bearcat.jpg
+- spec/fixtures/canvas_files/declare_file.json
+- spec/fixtures/canvas_files/upload_success.json
 - spec/fixtures/conclude_enrollment.json
 - spec/fixtures/conversation.json
 - spec/fixtures/course.json
@@ -273,12 +281,13 @@ test_files:
 - spec/fixtures/section_enrollments.json
 - spec/fixtures/single_account.json
 - spec/fixtures/start_report.json
-- spec/fixtures/submissions.json
+- spec/fixtures/submissions/submission.json
 - spec/fixtures/update_outcome.json
 - spec/fixtures/update_outcome_group.json
 - spec/fixtures/update_section.json
 - spec/fixtures/user_avatars.json
 - spec/fixtures/user_enrollments.json
+- spec/fixtures/user_page_views.json
 - spec/fixtures/user_profile.json
 - spec/helper.rb
 has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Y2RkMGQ5ZDdhNWZkNWQ5MjVmZGU2NzAwY2I5ZDJmMjA1NzE3ZDNkMw==
-  data.tar.gz: !binary |-
-    NDUzNzU0NjhkYjY2MWZkMWMyNzRkODhjYjczZDFjYzA3NjI4NjI2ZA==
-SHA512:
-  metadata.gz: !binary |-
-    N2Y2YWIwMGUzNWM4MTZjOTkxMmVhMWNjNmY5YmQwYjYyZjA1N2M4ZWFhNWYw
-    MjcyYmRjYzU4YzJkMjc1ODhkYzAyNjk0ZGY1NDQ2NTE1N2RiOTg5NzM3N2I3
-    ODE4NjZlZDU4ZmZlOTlmZjhlYzNkOTY0MTc3OGYzMjA5MGI4NTc=
-  data.tar.gz: !binary |-
-    MTBjMzE2MDY3MjI1OTBjZmRhZmNkMzI1N2YxZTFkNzUxYWZiZTAyMTA5Nzdk
-    NDFhNGRiNDVkZTI3NzExZWQ4NGVhNDNjYTM4MTJhY2JkMzQ1ZWMzNTY2MTNk
-    ZGFmZTdjMzliNGQ4NWEwMjM4NTQyZGI3OTk1MDc1Nzc4NDE0ZTk=

data/spec/fixtures/submissions.json

@@ -1,18 +0,0 @@
-    {
-        "assignment_id": 2353405,
-        "attempt": null,
-        "body": null,
-        "grade": "1",
-        "grade_matches_current_submission": null,
-        "graded_at": "2014-02-27T20:22:49Z",
-        "grader_id": 627536,
-        "id": 8444510,
-        "score": 1,
-        "submission_type": null,
-        "submitted_at": null,
-        "url": null,
-        "user_id": 682285,
-        "workflow_state": "unsubmitted",
-        "late": false,
-        "preview_url": "https://canvas.instructure.com/courses/218274/assignments/2353405/submissions/682285?preview=1"
-    }