canvas_lms_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e327db5daad3366209150d82923fb620bc1788b99f73185f5bdadf581bd10eb
+  data.tar.gz: 4f6f1a8aded691287101a3b1a0f7ea6abb271f7d719066d6957f5491443ee441
+SHA512:
+  metadata.gz: '090d56fd98b5307b71f8b0f59cec7ca56bb960061087f261567534afc45d1af50a5245037ff3bbe493109d9a67b59ec5ed57edbbb4e5d0e43306ac95af9a3749'
+  data.tar.gz: c5c53cbac27ebd568993e69d18f015cd3f465e3b9c51ed29c5f35b54fba268e0ce2f0e70025371838b1326215c2cf5ed8e3ae007a806f03057526c02594346fe

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Christopher Bennell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# CanvasLmsApi
+
+A simple ruby API client for CanvasLMS.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+canvas_client = CanvasLmsApi::Client.new("https://your.canvas.com", "your API Key")
+
+## Todo
+
+-[ ] Add YARD doc
+-[ ] Remove Results.coalesce_results
+
+## Contributing
+
+1. Fork it ( https://github.com/christopher-b/canvas_lms_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/christopher-b/canvas_lms_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/christopher-b/canvas_lms_api/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CanvasLms::Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/christopher-b/canvas_lms-api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/canvas_lms_api/client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "canvas_lms_api/request_methods"
+require "canvas_lms_api/request"
+require "canvas_lms_api/results"
+require "canvas_lms_api/uri"
+
+# @TODO extract URI
+# extract CRUD methods
+# extract pagination?
+
+module CanvasLmsApi
+  class Client
+    include CanvasLmsApi::RequestMethods
+
+    def initialize(prefix, api_key)
+      @prefix = prefix
+      @api_key = api_key
+    end
+
+    def request(endpoint, params = {})
+      uri = uri_for(endpoint, params[:query])
+      loop do
+        response = CanvasLmsApi::Request.new(
+          uri,
+          params[:method],
+          params[:payload]
+        ).call
+        results.collect(response.body)
+        next_page_uri = response.next_page
+
+        break unless next_page_uri
+        uri = uri_for(next_page_uri)
+      end
+
+      results.coalesce_results
+    end
+
+    private
+
+    def results
+      @results ||= CanvasLmsApi::Results.new
+    end
+
+    def uri_for(endpoint, params = nil)
+      CanvasLmsApi::Uri.new(@prefix, endpoint, params)
+    end
+  end
+end

data/lib/canvas_lms_api/request.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "json"
+require "rest-client"
+require "canvas_lms_api/response"
+
+module CanvasLmsApi
+  class Request
+    def initialize(uri, method = nil, payload = nil)
+      @uri = uri
+      @method = method
+      @payload = payload
+    end
+
+    def call
+      CanvasLmsApi::Response.new(rest_request.execute, self)
+    rescue RestClient::BadRequest => e
+      message = JSON.parse(e.response)["message"]
+      raise CanvasLmsApi::BadRequest.new(e.message + ": #{message}")
+    end
+
+    private
+
+    def rest_request
+      @rest_request ||= RestClient::Request.new(
+        url: @uri.to_s,
+        method: @method || :get,
+        payload: @payload,
+        headers: headers
+        # verify_ssl: false
+      )
+    end
+
+    def headers
+      {"Authorization" => "Bearer #{@api_key}"}
+    end
+  end
+end

data/lib/canvas_lms_api/request_methods.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CanvasLmsApi
+  module RequestMethods
+    def get(endpoint, query = nil)
+      request(endpoint, method: :get, query: query)
+    end
+
+    def post(endpoint, payload = nil)
+      request(endpoint, method: :post, payload: payload)
+    end
+
+    def put(endpoint, payload = nil, params = {})
+      request(endpoint, method: :put, payload: payload)
+    end
+
+    # def delete(endpoint, payload = nil)
+    #   request(endpoint, method: :delete, payload: payload)
+    # end
+  end
+end

data/lib/canvas_lms_api/response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CanvasLmsApi
+  class Response
+    LINK_PATTERN = %r{^<https?://.*/api/v1/([^>]+)[^"]+"([^"]+)}
+
+    attr_reader :rest_response, :request
+
+    def initialize(rest_response, request)
+      @rest_response = rest_response
+      @request = request
+    end
+
+    def body
+      @body ||= JSON.parse(rest_response.body)
+    end
+
+    def next_page
+      @next_page ||= begin
+        return nil unless rest_response.headers[:link]
+
+        rest_response.headers[:link].split(",").each do |link|
+          link.match(LINK_PATTERN) do |match|
+            url = match[1]
+            rel = match[2]
+            return url if rel == "next"
+          end
+        end
+
+        # No "next" link found
+        nil
+      end
+    end
+  end
+end

data/lib/canvas_lms_api/results.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "rest-client"
+
+# This is a wrapper around a result set, which allows us to collect
+# results across paginated responses
+
+module CanvasLmsApi
+  class Results
+    attr_accessor :value
+
+    def initialize
+      @value = nil
+    end
+
+    def collect(new_results)
+      if value.nil?
+        self.value = new_results
+      elsif new_results.is_a? Hash
+        new_results.each_pair do |k, v|
+          if value.key?(k) && value[k].is_a?(Array)
+            value[k].concat(v)
+          else
+            value[k] = v
+          end
+        end
+      else
+        value.try(:concat, new_results)
+      end
+    end
+
+    # This was a bad decision and I should work to remove it
+    def coalesce_results
+      if value.is_a? Array
+        value.one? ? value.first : value
+      else
+        value
+      end
+    end
+  end
+end

data/lib/canvas_lms_api/uri.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "rack/utils"
+require "active_support/core_ext/hash"
+
+module CanvasLmsApi
+  class Uri
+    PER_PAGE = 999
+
+    attr_reader :prefix, :endpoint, :query_param
+
+    def initialize(prefix, endpoint, query_param)
+      @prefix = fix_prefix(prefix)
+      @endpoint = fix_endpoint(endpoint, @prefix)
+      @query_param = query_param
+    end
+
+    def uri
+      URI("#{prefix}#{endpoint}").tap do |u|
+        query = Rack::Utils.parse_nested_query u.query
+        query.merge! Hash(query_param)
+        query[:per_page] ||= PER_PAGE
+        u.query = query.to_query
+      end
+    end
+
+    def to_s
+      uri.to_s
+    end
+
+    private
+
+    def fix_prefix(prefix)
+      "#{prefix}/api/v1/"
+    end
+
+    def fix_endpoint(endpoint, prefix)
+      endpoint.delete_prefix(prefix)
+    end
+  end
+end

data/lib/canvas_lms_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CanvasLmsApi
+  VERSION = "0.1.0"
+end

data/lib/canvas_lms_api.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "canvas_lms_api/version"
+require_relative "canvas_lms_api/client"
+# require "canvas_lms_api/request_methods"
+# require "canvas_lms_api/request"
+# require "canvas_lms_api/response"
+# require "canvas_lms_api/results"
+# require "canvas_lms_api/uri"
+
+require "canvas_lms_api/client"
+
+module CanvasLmsApi
+  class BadRequest < StandardError
+    attr_accessor :request
+  end
+
+  class << self
+    attr_writer :logger
+    def logger
+      @logger ||= logger.new("/dev/null").tap do |log|
+        log.progname = name
+      end
+    end
+  end
+end

data/sig/canvas_lms/api.rbs

@@ -0,0 +1,6 @@
+module CanvasLms
+  module Api
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: canvas_lms_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Bennell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+description:
+email:
+- cbennell@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/canvas_lms_api.rb
+- lib/canvas_lms_api/client.rb
+- lib/canvas_lms_api/request.rb
+- lib/canvas_lms_api/request_methods.rb
+- lib/canvas_lms_api/response.rb
+- lib/canvas_lms_api/results.rb
+- lib/canvas_lms_api/uri.rb
+- lib/canvas_lms_api/version.rb
+- sig/canvas_lms/api.rbs
+homepage: https://github.com/christopher-b/canvas_lms_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/christopher-b/canvas_lms_api
+  source_code_uri: https://github.com/christopher-b/canvas_lms_api
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A simple API client for CanvasLMS.
+test_files: []