credly-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5d96c6baa44e620c2e44bc279d9bcdd8d58e71db589b1f07e97f82c2ccf0899
+  data.tar.gz: '0778f0d6e8085ae348a428756a3dbad3488386c60ab33e7f99263fdd20b9605a'
+SHA512:
+  metadata.gz: 50faa5e49656e64d0f29177595121932a978fc16a2220bd56fcba9fdf2832757be9ced0890cee793143f260e28d391583e855458004c08510af04de41f875493
+  data.tar.gz: fdfb11f1616d5ecf3d5b126e837c458314bde7f101778076b35cf10cc0fc746626ee7efd36b01f175938d1dfefd693376ec6a580ad7d39f8fdd72b7a977285b9

data/.rubocop.yml

@@ -0,0 +1,49 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - lib/credly-ruby.rb
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 150

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## v0.1.0
+
+Initial release of the gem. 
+
+- Added badge endpoints
+- Added badge template endpoints
+- Added organization endpoints
+- Added obi endpoints
+- Added employee endpoint
+
+## [Unreleased]

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'faraday', '~> 2.7', '>= 2.7.11'
+
+group :development, :test do
+  gem 'rspec', '~> 3.12.0'
+  gem 'rspec_junit_formatter', '~> 0.6.0'
+  gem 'rubocop', '~> 1.52.1'
+  gem 'rubocop-rspec', '~> 2.22.0'
+  gem 'simplecov'
+  gem 'webmock', '~> 3.18.1'
+end

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    credly-ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x64-mingw-ucrt
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  credly-ruby!
+  faraday (~> 2.7, >= 2.7.11)
+  rspec (~> 3.12.0)
+  rspec_junit_formatter (~> 0.6.0)
+  rubocop (~> 1.52.1)
+  rubocop-rspec (~> 2.22.0)
+  simplecov
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Riipen
+
+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,58 @@
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/riipen/credly-ruby/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/riipen/credly-ruby/tree/main)
+
+# Credly Ruby
+
+An API client for the Credly REST API in ruby.
+
+Credly API documentation can be found here:
+
+https://www.credly.com/docs/
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'credly-ruby'
+```
+
+Then `bundle install`.
+
+## Usage
+
+### Quick Start
+
+```ruby
+client = Credly::Client.new(auth_token: 'my_organization_token')
+
+client.badge_list(organization_id)
+```
+
+The `Client` class also accepts the following options:
+
+|Option|Type|Description|Default|
+|------|----|-----------|-------|
+|sandbox|boolean|Whether to use the sandbox environment.|false|
+|version|string|The API version to use.|v1|
+
+Additional request examples can be found in https://github.com/riipen/credly-ruby/blob/main/spec/credly-ruby/actions
+
+### Errors
+
+Any error code returned by the Credly API will result in one of the following expections
+
+|Code|Exception|
+|----|---------|
+|400| Credly::BadRequest|
+|401| Credly::Unauthorized|
+|403| Credly::Forbidden|
+|404| Credly::NotFound|
+|410| Credly::Gone|
+|4xx| Credly::ClientError|
+|500| Credly::InternalServerError|
+|503| Credly::ServiceUnavailable|
+|5xx| Credly::ServerError|
+
+## License
+
+Copyright (C) 2023 Riipen. See [LICENSE](https://github.com/riipen/credly-ruby/blob/master/LICENSE.md) for details.

data/Rakefile

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

data/lib/credly/actions/badge_templates.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Credly
+  module Actions
+    module BadgeTemplates
+      def badge_templates_list(organization_id, query_params = {})
+        connection.get("organizations/#{organization_id}/badge_templates", query_params)
+      end
+
+      def badge_template_get(organization_id, badge_template_id)
+        connection.get("organizations/#{organization_id}/badge_templates/#{badge_template_id}")
+      end
+    end
+  end
+end

data/lib/credly/actions/badges.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Credly
+  module Actions
+    module Badges
+      def badge_list(organization_id, query_params = {})
+        connection.get("organizations/#{organization_id}/badges", query_params)
+      end
+
+      def badge_issue(organization_id, body_params)
+        connection.post("organizations/#{organization_id}/badges", body_params)
+      end
+
+      def badge_delete(organization_id, badge_id)
+        connection.delete("organizations/#{organization_id}/badges/#{badge_id}")
+      end
+
+      def badge_list_bulk(organization_id, query_params = {})
+        connection.get("organizations/#{organization_id}/high_volume_issued_badge_search", query_params)
+      end
+
+      def badge_revoke(organization_id, badge_id, body_params)
+        connection.put("organizations/#{organization_id}/badges/#{badge_id}/revoke", body_params)
+      end
+
+      def badge_replace(organization_id, badge_id, body_params)
+        connection.post("organizations/#{organization_id}/badges/#{badge_id}/replace", body_params)
+      end
+    end
+  end
+end

data/lib/credly/actions/issuer_authorizations.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Credly
+  module Actions
+    module IssuerAuthorizations
+      def issuer_list(organization_id)
+        connection.get("organizations/#{organization_id}/issuers")
+      end
+
+      def grantor_list(organization_id)
+        connection.get("organizations/#{organization_id}/grantors")
+      end
+
+      def issuer_deauthorize(organization_id, issuer_id)
+        connection.delete("organizations/#{organization_id}/issuers/#{issuer_id}")
+      end
+    end
+  end
+end

data/lib/credly/actions/obi.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Credly
+  module Actions
+    module OBI
+      def obi_badge_assertion_get(badge_id)
+        connection.get("obi/v2/badge_assertions/#{badge_id}")
+      end
+
+      def obi_badge_class_get(badge_class_id)
+        connection.get("obi/v2/badge_classes/#{badge_class_id}")
+      end
+
+      def obi_issuer_get(issuer_id)
+        connection.get("obi/v2/issuers/#{issuer_id}")
+      end
+    end
+  end
+end

data/lib/credly/actions/organizations.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Credly
+  module Actions
+    module Organizations
+      def organizations_list
+        connection.get('organizations')
+      end
+
+      def organization_get(organization_id)
+        connection.get("organizations/#{organization_id}")
+      end
+
+      def organization_update(organization_id, body_params)
+        connection.put("organizations/#{organization_id}", body_params)
+      end
+
+      def organization_event_get(organization_id, event_id)
+        connection.get("organizations/#{organization_id}/events/#{event_id}")
+      end
+
+      def organization_tokens_list(organization_id)
+        connection.get("organizations/#{organization_id}/authorization_tokens")
+      end
+
+      def organization_event_list(organization_id, query_params = {})
+        connection.get("organizations/#{organization_id}/events", query_params)
+      end
+    end
+  end
+end

data/lib/credly/actions/workforce.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Credly
+  module Actions
+    module Workforce
+      def employee_list(organization_id, query_params = {})
+        connection.get("organizations/#{organization_id}/employees", query_params)
+      end
+
+      def employee_get(organization_id, employee_id)
+        connection.get("organizations/#{organization_id}/employees/#{employee_id}")
+      end
+
+      def employee_update(organization_id, employee_id, body_params)
+        connection.put("organizations/#{organization_id}/employees/#{employee_id}", body_params)
+      end
+
+      def employee_create(organization_id, body_params)
+        connection.post("organizations/#{organization_id}/employees", body_params)
+      end
+
+      def employee_invite(organization_id, body_params)
+        connection.post("organizations/#{organization_id}/employees/send_invitations", body_params)
+      end
+
+      def employee_delete(organization_id, employee_id)
+        connection.delete("organizations/#{organization_id}/employees/#{employee_id}")
+      end
+
+      def employee_data_api_get(organization_id, employee_id)
+        connection.get("organizations/#{organization_id}/employees/#{employee_id}/data")
+      end
+    end
+  end
+end

data/lib/credly/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Credly
+  class Client
+    include Credly::Actions::Badges
+    include Credly::Actions::BadgeTemplates
+    include Credly::Actions::Organizations
+    include Credly::Actions::OBI
+    include Credly::Actions::IssuerAuthorizations
+    include Credly::Actions::Workforce
+    attr_reader :url, :auth_token
+    attr_accessor :sandbox
+
+    BASE_URL_P  = 'https://api.credly.com'
+    BASE_URL_S  = 'https://sandbox-api.credly.com'
+
+    def initialize(auth_token:, version: 'v1', sandbox: false)
+      @base_url = sandbox ? BASE_URL_S : BASE_URL_P
+      @url = [@base_url, version].join('/')
+      @version = version
+      @auth_token = auth_token
+      @sandbox = sandbox
+      @connection = Connection.new(@url, @auth_token)
+    end
+
+    def connection
+      @connection ||= Connection.new(@url, @auth_token)
+    end
+
+    def auth_token=(auth_token)
+      @auth_token = auth_token
+      @connection.auth_token = auth_token
+    end
+
+    def base_url
+      @sandbox ? BASE_URL_S : BASE_URL_P
+    end
+  end
+end

data/lib/credly/connection.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Credly
+  class Connection
+    def initialize(url, auth_token)
+      @connection = Faraday.new(url: url) do |builder|
+        builder.request :json
+        builder.headers[:accept] = 'application/json'
+        builder.response :json
+        builder.request :authorization, :basic, auth_token, ''
+      end
+    end
+
+    def auth_token=(auth_token)
+      @connection.set_basic_auth(auth_token, '')
+    end
+
+    def delete(path, params = {})
+      request(:delete, path, params)
+    end
+
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+
+    def put(path, params = {})
+      request(:put, path, params)
+    end
+
+    def request(method, path, params)
+      response = @connection.send(method, path, params)
+
+      error = Error.from_response(response)
+
+      raise error if error
+
+      response.body
+    end
+  end
+end

data/lib/credly/error.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Credly
+  class Error < StandardError
+    attr_reader :response
+
+    def self.from_response(response) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength:
+      klass =
+        case response.status
+        when 400 then BadRequest
+        when 401 then Unauthorized
+        when 403 then Forbidden
+        when 404 then NotFound
+        when 410 then Gone
+        when 422 then UnprocessableEntity
+        when 400..499 then ClientError
+        when 500 then InternalServerError
+        when 503 then ServiceUnavailable
+        when 500..599 then ServerError
+        end
+
+      klass&.new(response)
+    end
+
+    def initialize(response = nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    private
+
+    def build_error_message
+      return nil if @response.nil?
+
+      @response.body
+    end
+  end
+
+  class ClientError < Error; end
+  class BadRequest < Error; end
+  class Unauthorized < Error; end
+  class Forbidden < Error; end
+  class NotFound < Error; end
+  class ServerError < Error; end
+  class InternalServerError < Error; end
+  class ServiceUnavailable < Error; end
+  class UnprocessableEntity < Error; end
+  class Gone < Error; end
+end

data/lib/credly/version.rb

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

data/lib/credly_ruby.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'credly/connection'
+require 'credly/actions/badges'
+require 'credly/actions/badge_templates'
+require 'credly/actions/organizations'
+require 'credly/actions/obi'
+require 'credly/actions/issuer_authorizations'
+require 'credly/actions/workforce'
+require 'credly/client'
+require 'credly/error'
+require 'credly/version'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: credly-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Ogilvie
+- Elijah Almacen
+- ChanSokphanavy Plean
+- Yahui Qin
+- Shuning Xu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Access the Credly REST API.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/credly/actions/badge_templates.rb
+- lib/credly/actions/badges.rb
+- lib/credly/actions/issuer_authorizations.rb
+- lib/credly/actions/obi.rb
+- lib/credly/actions/organizations.rb
+- lib/credly/actions/workforce.rb
+- lib/credly/client.rb
+- lib/credly/connection.rb
+- lib/credly/error.rb
+- lib/credly/version.rb
+- lib/credly_ruby.rb
+homepage: https://github.com/riipen/credly-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/riipen/credly-ruby
+  source_code_uri: https://github.com/riipen/credly-ruby
+  changelog_uri: https://github.com/riipen/credly-ruby/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: An API client for Credly in ruby.
+test_files: []