bearcat 0.1

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/bearcat.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bearcat/version'
+
+Gem::Specification.new do |gem|
+  gem.authors =       ["Nathan Mills"]
+  gem.email =         ["nathanm@instructure.com"]
+  gem.description =   %q{Ruby interface for interacting with the canvas API}
+  gem.summary =       %q{Canvas API}
+
+  gem.files = %w[Rakefile bearcat.gemspec]
+  gem.files += Dir.glob("lib/**/*.rb")
+  gem.files += Dir.glob("spec/**/*")
+  gem.test_files    = Dir.glob("spec/**/*")
+  gem.name          = "bearcat"
+  gem.require_paths = ["lib"]
+  gem.version       = Bearcat::VERSION
+
+  gem.add_development_dependency "rake"
+  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.1.2"
+end

data/lib/bearcat.rb

@@ -0,0 +1,2 @@
+require 'bearcat/version'
+require 'bearcat/client'

data/lib/bearcat/api_array.rb

@@ -0,0 +1,118 @@
+module Bearcat
+  class ApiArray
+    include Enumerable
+
+    attr_reader :status, :headers, :members
+
+    def self.process_response(response, api_client)
+      if response.body.is_a? Array
+        ApiArray.new response, api_client
+      else
+        response.body
+      end
+    end
+
+    def initialize(response, api_client)
+      @api_client = api_client
+      case response.status
+        when 200..206
+          if response.body.is_a?(Array)
+            @members = response.body
+            @status = response.status
+            @headers = response.headers
+            @method = response.env[:method]
+            init_pages(@headers['Link'])
+          end
+        else
+      end
+    end
+
+    def [](i)
+      @members[i]
+    end
+
+    def last
+      @members.last
+    end
+
+    def each(&block)
+      @members.each { |member| block.call(member) }
+    end
+
+    def pages?
+      !@link_hash.empty?
+    end
+
+    def next_page
+      load_page('next')
+
+    end
+
+    def prev_page
+      load_page('prev')
+    end
+
+    def first_page
+      load_page('first')
+    end
+
+    def last_page
+      load_page('last')
+    end
+
+    def all_pages!(page_count = 50)
+      if pages?
+        @page_count = page_count
+        response = get_page(@link_hash['first'])
+        @headers = response.headers
+        @status = response.status
+        @method = response.env[:method]
+        init_pages(@headers[:link])
+        @members = response.body
+        while @link_hash['next']
+          response = get_page(@link_hash['next'])
+          @headers = response.headers
+          @status = response.status
+          @method = response.env[:method]
+          @members.concat(response.body)
+          init_pages(@headers[:link])
+        end
+        @link_hash = {}
+        self
+      end
+    end
+
+    private
+
+    def init_pages(link_header)
+      @link_hash = {}
+      if @headers.has_key? 'Link'
+        links = link_header.split(/,\s?/)
+
+        links.each do |link|
+          link_parts = link.split(/;\s?/)
+          url = link_parts.shift.strip.gsub(/^<|>$/, '')
+          rel = link_parts.find { |part| part.gsub('"', '').split('=').first == 'rel' }
+          @link_hash[rel.gsub('"', '').split('=').last] = url
+        end
+      end
+    end
+
+    def get_page(url, params = {})
+      params['per_page'] = @page_count unless params.has_key? 'per_page' || !@page_count
+      query = URI.parse(url).query
+      p = CGI.parse(query).merge(params)
+      u = url.gsub("?#{query}", '')
+      p.each { |k, v| p[k] = v.first if v.is_a?(Array) }
+      @api_client.request(:get, u, p)
+    end
+
+    def load_page(rel)
+      if @link_hash.has_key? rel
+        response = get_page(@link_hash[rel])
+        ApiArray.process_response(response, @api_client)
+      end
+    end
+
+  end
+end

data/lib/bearcat/client.rb

@@ -0,0 +1,20 @@
+require 'footrest/client'
+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'
+
+module Bearcat
+  class Client < Footrest::Client
+
+    include Assignments
+    include Courses
+    include Enrollments
+    include OutcomeGroups
+    include Outcomes
+    include Sections
+  end
+
+end

data/lib/bearcat/client/assignments.rb

@@ -0,0 +1,18 @@
+module Bearcat
+  class Client < Footrest::Client
+    module Assignments
+
+      def assignments(course, params={})
+        get("/api/v1/courses/#{course}/assignments", params)
+      end
+
+      def create_assignment_override(course, assignment, params)
+        post("api/v1/courses/#{course}/assignments/#{assignment}/overrides", params)
+      end
+
+      def create_assignment(course, params={})
+        post("/api/v1/courses/#{course}/assignments", params)
+      end
+    end
+  end
+end

data/lib/bearcat/client/courses.rb

@@ -0,0 +1,19 @@
+module Bearcat
+  class Client < Footrest::Client
+    module Courses
+
+      def course(course)
+        get("/api/v1/courses/#{course}")
+      end
+
+      def create_course(account_id, params={})
+        post("/api/v1/accounts/#{account_id}/courses", params)
+      end
+
+      def list_users(course, params={})
+        get("/api/v1/courses/#{course}/users", params)
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/enrollments.rb

@@ -0,0 +1,19 @@
+module Bearcat
+  class Client < Footrest::Client
+    module Enrollments
+
+      def user_enrollments(user, params={})
+        get("/api/v1/users/#{user.to_s}/enrollments", params)
+      end
+
+      def enroll_in_section(section, params={})
+        post("/api/v1/sections/#{section.to_s}/enrollments", params)
+      end
+
+      def conclude_enrollment(course, enrollment, params={})
+        delete("/api/v1/courses/#{course}/enrollments/#{enrollment}", params)
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/outcome_groups.rb

@@ -0,0 +1,81 @@
+module Bearcat
+  class Client < Footrest::Client
+    module OutcomeGroups
+
+      def show_outcome_group(outcome_group_id, params={})
+        get("#{outcomes_context_slug(params)}#{outcome_group_id}")
+      end
+
+      def update_outcome_group(outcome_group_id, params={})
+        put("#{outcomes_context_slug(params)}#{outcome_group_id}", params)
+      end
+
+      def delete_outcome_group(outcome_group_id, params={})
+        delete("#{outcomes_context_slug(params)}#{outcome_group_id}")
+      end
+
+      def list_linked_outcomes(outcome_group_id, params={})
+        get("#{outcomes_context_slug(params)}#{outcome_group_id}/outcomes")
+      end
+
+      def create_outcome_in_group(outcome_group_id, params={})
+        post("#{outcomes_context_slug(params)}#{outcome_group_id}/outcomes", params)
+      end
+
+      def link_outcome(outcome_group_id, outcome_id, params={})
+        put("#{outcomes_context_slug(params)}#{outcome_group_id}/outcomes/#{outcome_id}")
+      end
+
+      def unlink_outcome(outcome_group_id, outcome_id, params={})
+        delete("#{outcomes_context_slug(params)}#{outcome_group_id}/outcomes/#{outcome_id}")
+      end
+
+      def list_subgroups(outcome_group_id, params={})
+        get("#{outcomes_context_slug(params)}#{outcome_group_id}/subgroups")
+      end
+
+      def create_subgroup(outcome_group_id, params={})
+        post("#{outcomes_context_slug(params)}#{outcome_group_id}/subgroups", params)
+      end
+
+      def import_outcome_group(outcome_group_id, params={})
+        post("#{outcomes_context_slug(params)}#{outcome_group_id}/import", params)
+      end
+
+      def outcomes_context_slug(params)
+        context_hash = params.select { |k, _| k == "account" || k == "course" }
+
+        if context_hash.keys.count > 1
+          raise ArgumentError, "cannot have account and course in params"
+        elsif context_hash.empty?
+          return "#{config.prefix}#{global_slug}"
+        else
+          context_hash_key = context_hash.keys.first
+          case context_hash_key
+            when 'account'
+              "#{config.prefix}#{account_slug(context_hash[context_hash_key])}"
+            when 'course'
+              "#{config.prefix}#{course_slug(context_hash[context_hash_key])}"
+          end
+        end
+      end
+
+      private
+      def account_slug(account_id)
+        "accounts/#{account_id}/outcome_groups/"
+      end
+
+
+      private
+      def course_slug(course_id)
+        "courses/#{course_id}/outcome_groups/"
+      end
+
+      private
+      def global_slug
+        "global/outcome_groups/"
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/outcomes.rb

@@ -0,0 +1,15 @@
+module Bearcat
+  class Client < Footrest::Client
+    module Outcomes
+
+      def show_outcome(id)
+        get("/api/v1/outcomes/#{id}")
+      end
+
+      def update_outcome(id, params={})
+        put("/api/v1/outcomes/#{id}", params)
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/sections.rb

@@ -0,0 +1,27 @@
+module Bearcat
+  class Client < Footrest::Client
+    module Sections
+
+      def course_sections(course, params={})
+        get("/api/v1/courses/#{course.to_s}/sections", params)
+      end
+
+      def section(section)
+        get("/api/v1/sections/#{section.to_s}")
+      end
+
+      def create_section(course, params)
+        post("/api/v1/courses/#{course.to_s}/sections", params)
+      end
+
+      def update_section(section, params)
+        put("/api/v1/sections/#{section.to_s}", params)
+      end
+
+      def delete_section(section)
+        delete("/api/v1/sections/#{section.to_s}")
+      end
+
+    end
+  end
+end

data/lib/bearcat/version.rb

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

data/spec/bearcat/client/assignments_spec.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+describe Bearcat::Client::Assignments do
+  before do
+    @client = Bearcat::Client.new(prefix: "http://canvas.instructure.com", token: "test_token")
+  end
+
+  it "returns all assignments for a course" do
+    stub_get(@client, "/api/v1/courses/3/assignments").to_return(json_response("assignments.json"))
+    assignments = @client.assignments(3)
+    expect(assignments.count).to eq(2)
+    expect(assignments.first["assignment_group_id"]).to eq(53)
+    expect(assignments.first["id"]).to eq(123)
+    expect(assignments.first["due_at"]).to eq(nil)
+  end
+
+  it "creates an assignment override for a section" do
+    stub_post(@client, "/api/v1/courses/310/assignments/123/overrides")
+      .with(:body => {"assignment_override"=>{"course_section_id"=>"74", "due_at"=>"2013-06-27T21:08:46Z"}})
+      .to_return(json_response("assignment_section_override.json"))
+    override = @client.create_assignment_override(310, 123, {
+      "assignment_override[course_section_id]" => 74,
+      "assignment_override[due_at]" => "2013-06-27T21:08:46Z"
+    })
+    expect(override["all_day"]).to eq(false)
+    expect(override["due_at"]).to eq("2013-06-27T15:08:46-06:00")
+    expect(override["id"]).to eq(1)
+    expect(override["course_section_id"]).to eq(74)
+  end
+
+  it "creates a new assignment" do
+    name = "new assignment"
+    stub_post(@client, "/api/v1/courses/1/assignments").with(body: {"assignment" => {"name" => name}}).to_return(json_response("created_assignment.json"))
+    assignment = @client.create_assignment(1, {"assignment" => {"name" => name}})
+    expect(assignment["name"]).to eq(name)
+    expect(assignment["id"]).to eq(1)
+  end
+
+end

data/spec/bearcat/client/courses_spec.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+describe Bearcat::Client::Sections do
+  before do
+    @client = Bearcat::Client.new(prefix: "http://canvas.instructure.com", token: "test_token")
+  end
+
+  it "returns a section" do
+    stub_get(@client, "/api/v1/courses/3").to_return(json_response("course.json"))
+    course = @client.course(3)
+    expect(course['name']).to eq('Course 3')
+    expect(course['id']).to eq(3)
+    expect(course['start_at']).to eq('2012-06-01T00:00:00-06:00')
+  end
+
+  it "creates a new course" do
+    name = "new course"
+    stub_post(@client, "/api/v1/accounts/1/courses").with(body: {"course" => {"name" => name}}).to_return(json_response("created_course.json"))
+    course = @client.create_course(1, {"course[name]" => name})
+    expect(course['name']).to eq(name)
+    expect(course['id']).to eq(1)
+  end
+
+  it "lists all of the students in a course" do
+    stub_get(@client, "/api/v1/courses/1/users?enrollment_type=student").to_return(json_response("course_students.json"))
+    students = @client.list_users(1, {"enrollment_type" => "student"})
+    expect(students['name']).to eq('test@student.com')
+    expect(students['id']).to eq(2)
+  end
+
+end