pandarus 0.1.0

data/lib/pandarus.rb

@@ -0,0 +1 @@
+require "pandarus/v1_api"

data/lib/pandarus/api_base.rb

@@ -0,0 +1,114 @@
+require "uri"
+require "footrest"
+
+module Pandarus
+  class APIBase < Footrest::Client
+    attr_reader :response
+
+    def initialize(*args)
+      @pagination_params = {}
+      super
+    end
+
+    # Swagger allows for each param to be a query param or a form param, which
+    # is a bit unusual because in the 99% case, all params will be of one type
+    # or the other for a single Canvas request. In order to accommodate the 1%
+    # case, however, we allow for mixed requests in general.
+    def mixed_request(method, path, query_params, form_params, headers)
+      @response = connection.send(method) do |r|
+        if query_params.empty?
+          r.path = fullpath(path)
+        else
+          r.url(fullpath(path), query_params)
+        end
+        r.body = form_params unless form_params.empty?
+        r.headers = headers if headers
+      end
+      @response.body
+    end
+
+    def remember_key(method, path)
+      "#{method}:#{path}"
+    end
+
+    def page_params_store(method, path, url=@response.env[:next_page])
+      uri = URI.parse(url)
+      params = Hash[URI.decode_www_form(uri.query)]
+      @pagination_params[remember_key(method, path)] = params
+    rescue URI::InvalidURIError
+      nil
+    end
+
+    def page_params_load(method, path)
+      @pagination_params[remember_key(method, path)]
+    end
+
+
+    def underscored_merge_opts(opts, base)
+      base.merge(opts).merge(underscored_flatten_hash(opts))
+    end
+
+  protected
+
+    # Take a hash such as { :user => { :name => "me" } } and return a flattened
+    # hash such as { :user__name__ => "me" }. We do this as a workaround to
+    # swagger's disdain for rails-style square bracket parameters in the url.
+    def underscored_flatten_hash(hash)
+      Hash[
+        dot_flatten_hash(hash).map do |key, value|
+          count = 0
+          newkey = key.to_s.gsub(".") {|x| count += 1; count == 1 ? '__' : '____' }
+          newkey += '__' if count > 0
+          [newkey.to_sym, value]
+        end
+      ]
+    end
+
+    def dot_flatten_hash(hash)
+      Hash[*dot_flatten_recur(hash).flatten]
+    end
+
+    def dot_flatten_recur(hash)
+      hash.map do |k1, v1|
+        if v1.is_a?(Hash)
+          dot_flatten_recur(v1).map do |k2, v2|
+            ["#{k1}.#{k2}", v2]
+          end.flatten
+        else
+          [k1, v1]
+        end
+      end
+    end
+
+    def escape_string(string)
+      URI.encode(string.to_s)
+    end
+
+    # Convert something like user__name__ to user[name]
+    def underscores_to_square_brackets(key)
+      key.to_s.gsub(/(__.+?__)/) do |x|
+        x.sub('__', '[').sub('__', ']')
+      end.to_sym
+    end
+
+    # pull querystring keys from options, and convert double underscores
+    # back to square brackets
+    def select_params(params, param_keys)
+      Hash[
+        params.select do |key, value|
+          param_keys.include? key
+        end.map do |key, value|
+          [underscores_to_square_brackets(key), value]
+        end
+      ]
+    end
+
+    def path_replace(path, args={})
+      rpath = path.dup
+      args.each_pair do |key, value|
+        rpath.sub!("{#{key}}", escape_string(value))
+      end
+      rpath
+    end
+  end
+end

data/lib/pandarus/model_base.rb

@@ -0,0 +1,54 @@
+require 'active_support'
+
+module Pandarus
+  class ModelBase
+    def initialize(attributes = {})
+      return if attributes.empty?
+      attributes.each_pair do |name, value|
+        if has_attr? name.to_sym
+          assign(name, value)
+        else
+          raise ArgumentError, "#{name} is not an attribute of #{self.class}"
+        end
+      end
+    end
+
+    def attr(name)
+      self.class.attribute_map[name.to_sym]
+    end
+
+    def has_attr?(name)
+      self.class.attribute_map.has_key? name.to_sym
+    end
+
+    def inspect
+      Hash[
+        self.class.attribute_map.keys.map do |key|
+          [key, instance_variable_get("@#{key}")]
+        end
+      ].inspect.sub(/^\{/,"<#{self.class} ").sub(/\}$/,'>')
+    end
+
+    def assign(attr_name, value)
+      props = attr(attr_name)
+      if props[:type]
+        if props[:container]
+          value = value.map{ |v| props[:type].constantize.new(v) }
+        else
+          value = props[:type].constantize.new(v)
+        end
+      end
+      instance_variable_set("@#{attr_name}", value)
+    end
+
+    def to_body
+      body = {}
+      self.class.attribute_map.each_pair do |key, props|
+        unless (value = self.send(key).nil?)
+          body[props[:external]] = value
+        end
+      end
+      body
+    end
+  end
+end

data/lib/pandarus/models.rb

@@ -0,0 +1,43 @@
+# This is an autogenerated file. See readme.md.
+require 'pandarus/models/admin'
+require 'pandarus/models/account_authorization_config'
+require 'pandarus/models/role'
+require 'pandarus/models/assignment_group'
+require 'pandarus/models/group_category'
+require 'pandarus/models/content_migration'
+require 'pandarus/models/folder'
+require 'pandarus/models/collection'
+require 'pandarus/models/discovery_url'
+require 'pandarus/models/collaborator'
+require 'pandarus/models/module_item_sequence'
+require 'pandarus/models/quiz'
+require 'pandarus/models/comm_message'
+require 'pandarus/models/collection_item'
+require 'pandarus/models/assignment_override'
+require 'pandarus/models/migrator'
+require 'pandarus/models/outcome_group'
+require 'pandarus/models/section'
+require 'pandarus/models/day'
+require 'pandarus/models/file'
+require 'pandarus/models/page'
+require 'pandarus/models/submission_version'
+require 'pandarus/models/group'
+require 'pandarus/models/submission_history'
+require 'pandarus/models/course'
+require 'pandarus/models/migration_issue'
+require 'pandarus/models/grader'
+require 'pandarus/models/favorite'
+require 'pandarus/models/user'
+require 'pandarus/models/outcome_link'
+require 'pandarus/models/report'
+require 'pandarus/models/assignment'
+require 'pandarus/models/module_item'
+require 'pandarus/models/outcome'
+require 'pandarus/models/external_feed'
+require 'pandarus/models/communication_channel'
+require 'pandarus/models/progress'
+require 'pandarus/models/module'
+require 'pandarus/models/page_revision'
+require 'pandarus/models/group_membership'
+require 'pandarus/models/quiz_report'
+

data/lib/pandarus/models/account_authorization_config.rb

@@ -0,0 +1,34 @@
+require "pandarus/model_base"
+
+# This is an autogenerated file. See readme.md.
+module Pandarus
+  class AccountAuthorizationConfig < ModelBase
+    attr_accessor :login_handle_name, :identifier_format, :auth_type, :id, :log_out_url, :log_in_url, :certificate_fingerprint, :change_password_url, :requested_authn_context, :position, :idp_entity_id, :login_attribute, :auth_host, :auth_filter, :auth_over_tls, :auth_base, :auth_username, :auth_port
+
+
+    def self.attribute_map
+      {
+        :login_handle_name => {:external => "login_handle_name", :container => false, :type => nil},
+        :identifier_format => {:external => "identifier_format", :container => false, :type => nil},
+        :auth_type => {:external => "auth_type", :container => false, :type => nil},
+        :id => {:external => "id", :container => false, :type => nil},
+        :log_out_url => {:external => "log_out_url", :container => false, :type => nil},
+        :log_in_url => {:external => "log_in_url", :container => false, :type => nil},
+        :certificate_fingerprint => {:external => "certificate_fingerprint", :container => false, :type => nil},
+        :change_password_url => {:external => "change_password_url", :container => false, :type => nil},
+        :requested_authn_context => {:external => "requested_authn_context", :container => false, :type => nil},
+        :position => {:external => "position", :container => false, :type => nil},
+        :idp_entity_id => {:external => "idp_entity_id", :container => false, :type => nil},
+        :login_attribute => {:external => "login_attribute", :container => false, :type => nil},
+        :auth_host => {:external => "auth_host", :container => false, :type => nil},
+        :auth_filter => {:external => "auth_filter", :container => false, :type => nil},
+        :auth_over_tls => {:external => "auth_over_tls", :container => false, :type => nil},
+        :auth_base => {:external => "auth_base", :container => false, :type => nil},
+        :auth_username => {:external => "auth_username", :container => false, :type => nil},
+        :auth_port => {:external => "auth_port", :container => false, :type => nil}
+
+      }
+    end
+  end
+end
+

data/lib/pandarus/models/admin.rb

@@ -0,0 +1,19 @@
+require "pandarus/model_base"
+
+# This is an autogenerated file. See readme.md.
+module Pandarus
+  class Admin < ModelBase
+    attr_accessor :id, :role, :user
+
+
+    def self.attribute_map
+      {
+        :id => {:external => "id", :container => false, :type => nil},
+        :role => {:external => "role", :container => false, :type => nil},
+        :user => {:external => "user", :container => false, :type => nil}
+
+      }
+    end
+  end
+end
+

data/lib/pandarus/models/assignment.rb

@@ -0,0 +1,57 @@
+require "pandarus/model_base"
+
+# This is an autogenerated file. See readme.md.
+module Pandarus
+  class Assignment < ModelBase
+    attr_accessor :id, :name, :description, :due_at, :lock_at, :unlock_at, :all_dates, :course_id, :html_url, :assignment_group_id, :allowed_extensions, :turnitin_enabled, :turnitin_settings, :grade_group_students_individually, :external_tool_tag_attributes, :peer_reviews, :automatic_peer_reviews, :peer_review_count, :peer_reviews_assign_at, :group_category_id, :needs_grading_count, :position, :muted, :points_possible, :submission_types, :grading_type, :grading_standard_id, :published, :locked_for_user, :lock_info, :lock_explanation, :quiz_id, :anonymous_submissions, :discussion_topic, :freeze_on_copy, :frozen, :frozen_attributes, :submission, :use_rubric_for_grading, :rubric_settings, :rubric
+
+
+    def self.attribute_map
+      {
+        :id => {:external => "id", :container => false, :type => nil},
+        :name => {:external => "name", :container => false, :type => nil},
+        :description => {:external => "description", :container => false, :type => nil},
+        :due_at => {:external => "due_at", :container => false, :type => nil},
+        :lock_at => {:external => "lock_at", :container => false, :type => nil},
+        :unlock_at => {:external => "unlock_at", :container => false, :type => nil},
+        :all_dates => {:external => "all_dates", :container => false, :type => nil},
+        :course_id => {:external => "course_id", :container => false, :type => nil},
+        :html_url => {:external => "html_url", :container => false, :type => nil},
+        :assignment_group_id => {:external => "assignment_group_id", :container => false, :type => nil},
+        :allowed_extensions => {:external => "allowed_extensions", :container => false, :type => nil},
+        :turnitin_enabled => {:external => "turnitin_enabled", :container => false, :type => nil},
+        :turnitin_settings => {:external => "turnitin_settings", :container => false, :type => nil},
+        :grade_group_students_individually => {:external => "grade_group_students_individually", :container => false, :type => nil},
+        :external_tool_tag_attributes => {:external => "external_tool_tag_attributes", :container => false, :type => nil},
+        :peer_reviews => {:external => "peer_reviews", :container => false, :type => nil},
+        :automatic_peer_reviews => {:external => "automatic_peer_reviews", :container => false, :type => nil},
+        :peer_review_count => {:external => "peer_review_count", :container => false, :type => nil},
+        :peer_reviews_assign_at => {:external => "peer_reviews_assign_at", :container => false, :type => nil},
+        :group_category_id => {:external => "group_category_id", :container => false, :type => nil},
+        :needs_grading_count => {:external => "needs_grading_count", :container => false, :type => nil},
+        :position => {:external => "position", :container => false, :type => nil},
+        :muted => {:external => "muted", :container => false, :type => nil},
+        :points_possible => {:external => "points_possible", :container => false, :type => nil},
+        :submission_types => {:external => "submission_types", :container => false, :type => nil},
+        :grading_type => {:external => "grading_type", :container => false, :type => nil},
+        :grading_standard_id => {:external => "grading_standard_id", :container => false, :type => nil},
+        :published => {:external => "published", :container => false, :type => nil},
+        :locked_for_user => {:external => "locked_for_user", :container => false, :type => nil},
+        :lock_info => {:external => "lock_info", :container => false, :type => nil},
+        :lock_explanation => {:external => "lock_explanation", :container => false, :type => nil},
+        :quiz_id => {:external => "quiz_id", :container => false, :type => nil},
+        :anonymous_submissions => {:external => "anonymous_submissions", :container => false, :type => nil},
+        :discussion_topic => {:external => "discussion_topic", :container => false, :type => nil},
+        :freeze_on_copy => {:external => "freeze_on_copy", :container => false, :type => nil},
+        :frozen => {:external => "frozen", :container => false, :type => nil},
+        :frozen_attributes => {:external => "frozen_attributes", :container => false, :type => nil},
+        :submission => {:external => "submission", :container => false, :type => nil},
+        :use_rubric_for_grading => {:external => "use_rubric_for_grading", :container => false, :type => nil},
+        :rubric_settings => {:external => "rubric_settings", :container => false, :type => nil},
+        :rubric => {:external => "rubric", :container => false, :type => nil}
+
+      }
+    end
+  end
+end
+

data/lib/pandarus/models/assignment_group.rb

@@ -0,0 +1,22 @@
+require "pandarus/model_base"
+
+# This is an autogenerated file. See readme.md.
+module Pandarus
+  class AssignmentGroup < ModelBase
+    attr_accessor :id, :name, :position, :group_weight, :assignments, :rules
+
+
+    def self.attribute_map
+      {
+        :id => {:external => "id", :container => false, :type => nil},
+        :name => {:external => "name", :container => false, :type => nil},
+        :position => {:external => "position", :container => false, :type => nil},
+        :group_weight => {:external => "group_weight", :container => false, :type => nil},
+        :assignments => {:external => "assignments", :container => false, :type => nil},
+        :rules => {:external => "rules", :container => false, :type => nil}
+
+      }
+    end
+  end
+end
+

data/lib/pandarus/models/assignment_override.rb

@@ -0,0 +1,27 @@
+require "pandarus/model_base"
+
+# This is an autogenerated file. See readme.md.
+module Pandarus
+  class AssignmentOverride < ModelBase
+    attr_accessor :id, :assignment_id, :student_ids, :group_id, :course_section_id, :title, :due_at, :all_day, :all_day_date, :unlock_at, :lock_at
+
+
+    def self.attribute_map
+      {
+        :id => {:external => "id", :container => false, :type => nil},
+        :assignment_id => {:external => "assignment_id", :container => false, :type => nil},
+        :student_ids => {:external => "student_ids", :container => false, :type => nil},
+        :group_id => {:external => "group_id", :container => false, :type => nil},
+        :course_section_id => {:external => "course_section_id", :container => false, :type => nil},
+        :title => {:external => "title", :container => false, :type => nil},
+        :due_at => {:external => "due_at", :container => false, :type => nil},
+        :all_day => {:external => "all_day", :container => false, :type => nil},
+        :all_day_date => {:external => "all_day_date", :container => false, :type => "Date"},
+        :unlock_at => {:external => "unlock_at", :container => false, :type => nil},
+        :lock_at => {:external => "lock_at", :container => false, :type => nil}
+
+      }
+    end
+  end
+end
+

data/lib/pandarus/models/collaborator.rb

@@ -0,0 +1,19 @@
+require "pandarus/model_base"
+
+# This is an autogenerated file. See readme.md.
+module Pandarus
+  class Collaborator < ModelBase
+    attr_accessor :id, :type, :name
+
+
+    def self.attribute_map
+      {
+        :id => {:external => "id", :container => false, :type => nil},
+        :type => {:external => "type", :container => false, :type => nil},
+        :name => {:external => "name", :container => false, :type => nil}
+
+      }
+    end
+  end
+end
+

data/lib/pandarus/models/collection.rb

@@ -0,0 +1,22 @@
+require "pandarus/model_base"
+
+# This is an autogenerated file. See readme.md.
+module Pandarus
+  class Collection < ModelBase
+    attr_accessor :id, :name, :visibility, :followed_by_user, :followers_count, :items_count
+
+
+    def self.attribute_map
+      {
+        :id => {:external => "id", :container => false, :type => nil},
+        :name => {:external => "name", :container => false, :type => nil},
+        :visibility => {:external => "visibility", :container => false, :type => nil},
+        :followed_by_user => {:external => "followed_by_user", :container => false, :type => nil},
+        :followers_count => {:external => "followers_count", :container => false, :type => nil},
+        :items_count => {:external => "items_count", :container => false, :type => nil}
+
+      }
+    end
+  end
+end
+

data/lib/pandarus/models/collection_item.rb

@@ -0,0 +1,33 @@
+require "pandarus/model_base"
+
+# This is an autogenerated file. See readme.md.
+module Pandarus
+  class CollectionItem < ModelBase
+    attr_accessor :id, :collection_id, :item_type, :link_url, :post_count, :upvote_count, :upvoted_by_user, :root_item_id, :image_url, :image_pending, :title, :description, :user_comment, :html_preview, :url, :created_at, :user
+
+
+    def self.attribute_map
+      {
+        :id => {:external => "id", :container => false, :type => nil},
+        :collection_id => {:external => "collection_id", :container => false, :type => nil},
+        :item_type => {:external => "item_type", :container => false, :type => nil},
+        :link_url => {:external => "link_url", :container => false, :type => nil},
+        :post_count => {:external => "post_count", :container => false, :type => nil},
+        :upvote_count => {:external => "upvote_count", :container => false, :type => nil},
+        :upvoted_by_user => {:external => "upvoted_by_user", :container => false, :type => nil},
+        :root_item_id => {:external => "root_item_id", :container => false, :type => nil},
+        :image_url => {:external => "image_url", :container => false, :type => nil},
+        :image_pending => {:external => "image_pending", :container => false, :type => nil},
+        :title => {:external => "title", :container => false, :type => nil},
+        :description => {:external => "description", :container => false, :type => nil},
+        :user_comment => {:external => "user_comment", :container => false, :type => nil},
+        :html_preview => {:external => "html_preview", :container => false, :type => nil},
+        :url => {:external => "url", :container => false, :type => nil},
+        :created_at => {:external => "created_at", :container => false, :type => "Date"},
+        :user => {:external => "user", :container => false, :type => nil}
+
+      }
+    end
+  end
+end
+