companion_cube 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d266227d5728df0bfbd1e3bab171a1d5117bc646601ed0418edc9e36a161a58a
+  data.tar.gz: 6073315fc04b331975683919ab3050c403d656a540d740867197017d9ee0eaaa
+SHA512:
+  metadata.gz: d0686ba10b830b3a75afcd7c99713701c79db3b2d8bcb36af2ea5f6d0502f3c3f1820a3ce9dc85071fd0928aa5dd6fcb634b7e9b6459c210b5f63a54ab08e6d1
+  data.tar.gz: e7f47865bff4e98ad9a2989c7cb590c2cfc011ae6e5444604c6b6e5a4992b3b5d06837de40ae162910de12b63ed0255f0fdfc243abf8ea895788556e00b6181b

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.2.3][] - 2020-01-31
+### Added
+- Feature to delete courses
+
+## [0.2.0][] - 2017-05-11
+### Added
+-   Support for `/reports/completions` and `/reports/enrollments`
+-   Build instructions
+
+### Fixed
+-   Fixed test coverage measurement in `coverage/index.html`
+
+## [0.1.2][] - 2017-04-25
+### Fixed
+-   Bug in parsing responses.
+
+## [0.1.1][] - 2017-04-17
+### Added
+-   SimpleCov for test coverage.
+
+### Changed
+-   Remove Rails things from RuboCop config.
+-   Git-less gem specification.
+
+### Removed
+-   Custom exceptions.
+
+### Fixed
+-   Send multipart request for create/update course.
+
+## 0.1.0 - 2017-04-07
+### Added
+-   Implement all APIs
+
+[Unreleased]: https://github.ibm.com/bdu/companion-cube-ruby/compare/0.1.2...HEAD
+[0.1.2]: https://github.ibm.com/bdu/companion-cube-ruby/compare/0.1.1...0.1.2
+[0.1.1]: https://github.ibm.com/bdu/companion-cube-ruby/compare/0.1.0...0.1.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 International Business Machines
+
+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,114 @@
+[![Build Status](https://travis.ibm.com/bdu/companion-cube-ruby.svg?token=CCLjK5gsaLWyxhCwwcrs&branch=master)](https://travis.ibm.com/bdu/companion-cube-ruby)
+
+# Companion Cube
+
+Ruby client for [Companion Cube](https://github.ibm.com/bdu/companion-cube).
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "companion_cube"
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install companion_cube
+```
+
+## Usage
+
+```ruby
+# To start, create a client
+cc = CompanionCube::Client.new(url: "https://cc.example.com")
+
+# Retrieve all existing courses
+courses = cc.courses
+
+# Create a new course
+params = {
+  run:          "...",
+  archive_file: File.new("...")
+}
+new_course = cc.create_course(params)
+
+# Retrieve an existing course
+course = cc.course(new_course["id"])
+
+# Update a course
+params = {
+  archive_file: File.new("...")
+}
+updated_course = cc.update_course(course["id"], params)
+```
+
+## Development
+
+To run the tests, run:
+
+```sh
+docker-compose run --rm cc rake spec
+```
+
+You can also run the following command for an interactive prompt that will
+allow you to experiment.
+
+```sh
+docker-compose run --rm cc bin/console
+```
+
+For added flexibility, you can use Bash.
+
+```sh
+docker-compose run --rm cc bash
+```
+
+## Build
+
+Add the gem repo to your configuration:
+
+```sh
+# replace @ with %40 in your username
+gem source -a \
+  https://<USERNAME>:<PASSWORD>@na.artifactory.swg-devops.com/artifactory/api/gems/apset-ruby/
+  
+# keep @ AS IS
+curl -u<USERNAME>:<PASSWORD> \
+  https://na.artifactory.swg-devops.com/artifactory/api/gems/apset-ruby/api/v1/api_key.yaml \
+  > ~/.gem/credentials
+```
+
+Build the gem:
+
+```sh
+gem build companion_cube.gemspec
+```
+
+Install the gem locally: (optional)
+
+```sh
+gem install companion_cube-*.gem
+```
+
+Push the gem:
+
+```sh
+gem push companion_cube-*.gem
+rm companion_cube-*.gem
+```
+
+## License
+
+Please refer to [LICENSE](LICENSE).
+
+## Authors
+
+*   Partner Ecosystem Team, IBM Digital Business Group <mailto:imcloud@ca.ibm.com>

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json"
+require "companion_cube"
+
+cc = nil
+
+begin
+  cc = CompanionCube::Client.new(
+    url:        ENV.fetch("COMPANION_CUBE_URL"),
+    access_key: ENV.fetch("COMPANION_CUBE_ACCESS_KEY"),
+    secret_key: ENV.fetch("COMPANION_CUBE_SECRET_KEY")
+  )
+rescue
+  puts "Set Companion Cube env variables to automatically load the client"
+end
+
+instance_variable_set(:@companion_cube, cc)
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/companion_cube.rb

@@ -0,0 +1,2 @@
+require "companion_cube/client"
+require "companion_cube/version"

data/lib/companion_cube/client.rb

@@ -0,0 +1,71 @@
+require "rest-client"
+require "json"
+
+module CompanionCube
+  class Client
+    API_HEADERS = { "Accept" => "application/json" }.freeze
+
+    def initialize(url:, access_key: nil, secret_key: nil)
+      raise "Missing required parameter 'url'" if url.nil? || url.empty?
+
+      keys_empty = !access_key.nil? && access_key.empty?
+      keys_empty ||= !secret_key.nil? && secret_key.empty?
+      raise "Access/secret key cannot be blank" if keys_empty
+
+      self.resource = RestClient::Resource.new(url, access_key, secret_key)
+    end
+
+    def courses
+      JSON.parse(send_request(:get, "/courses"))
+    end
+
+    def create_course(params)
+      params[:multipart] = true
+
+      send_request(:post, "/courses", body: params)
+    end
+
+    def delete_course(id)
+      send_request(:delete, "/courses/#{id}")
+    end
+
+    def course(id)
+      raise "Missing required parameter 'id'" if id.nil?
+
+      JSON.parse(send_request(:get, "/courses/#{id}"))
+    end
+
+    def update_course(id, params)
+      params[:multipart] = true
+
+      send_request(:put, "/courses/#{id}", body: params)
+    end
+
+    def reports(type, params = {})
+      raise "Missing required parameter 'type'" if type.nil?
+      format = params.fetch(:format, :json).to_sym
+
+      response = send_request(:get, "/reports/#{type}", params: params, accept: format)
+      return JSON.parse(response) if format == :json
+      # csv, etc.
+      response
+    end
+
+    protected
+
+    attr_accessor :resource
+
+    def send_request(method, path, opts = {})
+      body    = opts.fetch(:body, {})
+      headers = opts.fetch(:headers, {}).merge(API_HEADERS)
+
+      response = if %i[get delete].include?(method)
+                   resource[path].send(method, opts)
+                 else
+                   resource[path].send(method, body, headers)
+                 end
+
+      response.body
+    end
+  end
+end

data/lib/companion_cube/version.rb

@@ -0,0 +1,3 @@
+module CompanionCube
+  VERSION = "0.2.3".freeze
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: companion_cube
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Partner Ecosystem Team, IBM Digital Business Group
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Companion Cube client
+email:
+- imcloud@ca.ibm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/companion_cube.rb
+- lib/companion_cube/client.rb
+- lib/companion_cube/version.rb
+homepage: https://github.com/IBM/companion-cube-ruby
+licenses:
+- All rights reserved.
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Companion Cube client
+test_files: []