sn-chell 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f38b33a63091ea900385082c15185e658ec8b1a3
+  data.tar.gz: 1209e9f5c4fe73b8fb374f21135582d720d2d054
+SHA512:
+  metadata.gz: 92079bc2e404f8779d13bbdbd64527fbd9c0ab739594d0dde60f862fdf57ad937995ecabde0e3ea322133b31d9228032be5efa111eb8da5456aa268de948eec8
+  data.tar.gz: 35634c5fccf2001e2fc42ef2eaa4ee679839dc36202684f888fddcda450df38320f4e158bba8e9038d4886c5de2223f2820d714c84d5099327f693b6752f1aa5

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# 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/).
+
+## [Unreleased][]
+
+## [0.1.3][] - 2018-02-24
+### Changed
+-   Update `oj` dependency version.
+
+## [0.1.2][] - 2017-04-17
+### Fixed
+-   Course content retrieval.
+
+### Changed
+-   Split "retrieve course" and "retrieve course content" API into
+    `course(...)` and `course_content(...)`, respectively.
+
+## [0.1.1][] - 2017-04-12
+### Added
+-   Enable CI.
+-   Use Docker for development.
+-   Instance variable `@chell` to development console (`bin/console`).
+
+### Changed
+-   Rename Chel to Chell.
+-   Rename "Chell Client" to just "Chell".
+-   Publishing to Artifactory is now driven by Git tags.
+-   Use `url/access_key/secret_key` convention in constructor.
+
+## 0.1.0 - 2017-02-22
+Initial release.
+
+[Unreleased]: https://github.ibm.com/bdu/companion-cube-ruby/compare/0.1.3...HEAD
+[0.1.3]: https://github.ibm.com/bdu/companion-cube-ruby/compare/0.1.2...0.1.3
+[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,3 @@
+Copyright (C) 2017 IBM Corporation
+
+All rights reserved - Do Not Redistribute

data/README.md

@@ -0,0 +1,74 @@
+[![Build Status](https://travis.ibm.com/bdu/chell-ruby.svg?token=CCLjK5gsaLWyxhCwwcrs&branch=master)](https://travis.ibm.com/bdu/chell=ruby)
+
+# Chell
+
+Ruby client for [Chell](https://github.ibm.com/bdu/chell).
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "chell"
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install chell
+```
+
+## Usage
+
+```ruby
+# To start, create a client
+chell = Chell::Client.new(url: "https://chell.example.com/api")
+
+# Retrieve all courses
+courses = chell.courses
+
+# Retrieve an existing course
+course_id = courses.first[:id]
+course = chell.course(course_id)
+
+# Retrieve an existing course's content
+version_id = couse[:versions].last[:id]
+content = chell.course_content(course_id, version_id)
+```
+
+## Development
+
+Start by creating a `chell.env` file based on `chell.env.example`. Then:
+
+*   To run the tests:
+
+    ```sh
+    docker-compose run chell-ruby rake spec; docker-compose down
+    ```
+
+*   You can also run the following command for an interactive prompt that will
+    allow you to experiment.
+
+    ```sh
+    docker-compose run chell-ruby bin/console; docker-compose down
+    ```
+
+*   For added flexibility, you can use Bash.
+
+    ```sh
+    docker-compose run --service-ports chell-ruby bash; docker-compose down
+    ```
+
+## 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,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json"
+require "chell"
+
+require "irb"
+
+instance_variable_set(:@chell,
+  Chell::Client.new(
+    url:        ENV.fetch("CHELL_URL"),
+    access_key: ENV.fetch("CHELL_ACCESS_KEY"),
+    secret_key: ENV.fetch("CHELL_SECRET_KEY")
+  ))
+
+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/chell.rb

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

data/lib/chell/client.rb

@@ -0,0 +1,47 @@
+require "oj"
+require "rest-client"
+
+module Chell
+  class Client
+    FORMATS = {
+      json: "application/json",
+      gzip: "application/x-gzip"
+    }.freeze
+
+    def initialize(options = {})
+      @access_key = options.fetch(:access_key)
+      @secret_key = options.fetch(:secret_key)
+      @url = options.fetch(:url)
+    end
+
+    def courses
+      parse_json(resource["/courses"].get.body)
+    end
+
+    def course(id)
+      path = "/courses/#{id}"
+      headers = { accept: FORMATS[:json] }
+
+      response = resource[path].get(headers)
+      parse_json(response.body)
+    end
+
+    def course_content(id, version_id)
+      path = "/courses/#{id}/versions/#{version_id}"
+      headers = { accept: FORMATS[:gzip] }
+
+      resource[path].get(headers).body
+    end
+
+    private
+
+    def parse_json(body)
+      Oj.default_options = { mode: :compat, symbol_keys: true }
+      Oj.load(body)
+    end
+
+    def resource
+      @resource ||= RestClient::Resource.new(@url, user: @access_key, password: @secret_key)
+    end
+  end
+end

data/lib/chell/version.rb

@@ -0,0 +1,3 @@
+module Chell
+  VERSION = "0.1.3".freeze
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: sn-chell
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Skills Network
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-10 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: 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: 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: 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: 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: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !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: Client for the Chell service
+email: info@skills.network
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/chell.rb
+- lib/chell/client.rb
+- lib/chell/version.rb
+homepage: https://github.ibm.com/bdu/chell-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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Chell Client
+test_files: []