one-mentor-ruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9904bfffe82b3303d8c50a6811bed3a6c132094527e141d8b64afae1aa07dfde
+  data.tar.gz: 3a20fb4ccebad84af455dd36a796c7f65db49c894ed612d0476242ec8bb438d1
+SHA512:
+  metadata.gz: bc2059d775d808a5aaf8e89d157bdc9e94bfff102eb96bf127ff43b0262637ec8ed855975cdfc8e0494c7689f72fc3698a79cb3434a1b1a595409de7ec9bbc75
+  data.tar.gz: 4f0ca170a8392af8f6cac0cfe03ab843d1793bbb18c3bf0b2004f5318fc762e3f25d8909abd2eaf5bd4b441684113ed3a784b96afed6be9c55d5902196abc940

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,56 @@
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+  
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 100
+
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - lib/one-mentor-ruby.rb
+
+RSpec/ExampleLength:
+  Enabled: false
+  Exclude:
+    - lib/one-mentor-ruby/actions/**/*
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  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
+

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## v0.1.0
+
+Initial release of the gem. 
+
+## [Unreleased]

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'faraday', '>= 2.0.1'
+
+group :development, :test do
+  gem 'base64', '~> 0.3.0'
+  gem 'benchmark', '~> 0.4.1'
+  gem 'ostruct', '~> 0.6.3'
+  gem 'rake', '~> 13.0.6'
+  gem 'rspec', '~> 3.12.0'
+  gem 'rspec_junit_formatter', '~> 0.6.0'
+  gem 'rubocop', '~> 1.79.2'
+  gem 'rubocop-rspec', '~> 3.6.0'
+  gem 'webmock', '~> 3.18.1'
+end

data/Gemfile.lock

@@ -0,0 +1,96 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.2)
+    faraday (2.13.4)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
+    hashdiff (1.2.0)
+    json (2.13.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    net-http (0.6.0)
+      uri
+    ostruct (0.6.3)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    public_suffix (6.0.2)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.11.1)
+    rexml (3.4.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.3)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.2)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.79.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.46.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.6.0)
+    uri (1.0.3)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  base64 (~> 0.3.0)
+  benchmark (~> 0.4.1)
+  faraday (>= 2.0.1)
+  ostruct (~> 0.6.3)
+  rake (~> 13.0.6)
+  rspec (~> 3.12.0)
+  rspec_junit_formatter (~> 0.6.0)
+  rubocop (~> 1.79.2)
+  rubocop-rspec (~> 3.6.0)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.6.8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 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,116 @@
+# one-mentor-ruby
+
+A GraphQL client for 1Mentor in ruby.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'one-mentor-ruby'
+```
+
+Then `bundle install`.
+
+## Usage
+
+### API Client
+
+The 1Mentor API client uses an API key to authenticate API requests.
+
+To obtain an API key talk to your 1Mentor representative.
+
+Then you can create a 1MEntor API client.
+
+```ruby
+client = OneMentor::Client.new(
+    api_key: 'my_key',
+    subdomain: 'my-subdomain' # Your API instance subdomain
+    timeout: 30, # Optional setting for timeouts of all requests (default 60)
+)
+```
+
+### API Endpoints
+
+1Mentor currently does not have any public facing documantion available, so support for endpoints is limited.
+
+### List learner career objectives
+
+Example: `client.learner_career_objectives(email@learner.com)`
+
+Returns the following array
+
+```json
+[
+  {},
+  {},
+  {},
+]
+```
+
+### Check learner
+
+Example: `client.learner_exists(email@learner.com)`
+
+Returns `true` if the email address is tied to a learner account, `false` otherwise.
+
+### Custom requests
+
+Because the 1Mentor API is a wrapper on top of a GraphQL API, adhoc requests can be made
+using the applicable GraphQL syntax.
+
+Example:
+
+```
+query = <<~GRAPHQL
+        query GetLearnerCareerObjectivesAndSkillGaps($studentEmail: NonEmptyString!)
+        {
+          getLearnerCareerObjectivesAndSkillGaps(studentEmail: $studentEmail) {
+            status
+            message
+          }
+        }
+      GRAPHQL
+
+client.request({
+  operationName: 'GetLearnerCareerObjectivesAndSkillGaps',
+  query:,
+  variables: {
+    studentEmail: email
+  },
+})
+```
+
+Custom requests will return the raw data structure from 1Mentor in this form:
+
+```json
+{
+  "data": {
+    "getLearnerCareerObjectivesAndSkillGaps": {
+      "status": true,
+      "message": ""
+    }
+  }
+}
+```
+
+### Pagination
+
+1Mentor does not currently support pagination.
+
+### Errors
+
+Any error code returned by the OneMentor API will result in one of the following expections
+
+|Code|Exception|
+|----|---------|
+|400| OneMentor::BadRequest|
+|401| OneMentor::Unauthorized|
+|403| OneMentor::Forbidden|
+|404| OneMentor::NotFound|
+|429| OneMentor::TooManyRequests|
+|400...499| OneMentor::ClientError|
+|500| OneMentor::InternalServerError|
+|502| OneMentor::BadGateway|
+|503| OneMentor::ServiceUnavailable|
+|500...599| OneMentor::ServerError|

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/one-mentor-ruby/actions/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OneMentor
+  module Actions
+    module Base
+      def request(body)
+        connection.post('graphql', body)
+      end
+    end
+  end
+end

data/lib/one-mentor-ruby/actions/learners.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module OneMentor
+  module Actions
+    module Learners
+      def learner_career_objectives(email)
+        query = <<~GRAPHQL
+          query GetLearnerCareerObjectivesAndSkillGaps($studentEmail: NonEmptyString!)
+          {
+            getLearnerCareerObjectivesAndSkillGaps(studentEmail: $studentEmail) {
+              status
+              message
+              careerObjectives {
+                occupation
+                gaps
+              }
+            }
+          }
+        GRAPHQL
+
+        response = connection.post('graphql', {
+                                     operationName: 'GetLearnerCareerObjectivesAndSkillGaps',
+                                     query: query,
+                                     variables: {
+                                       studentEmail: email
+                                     }
+                                   })
+
+        if response.dig('data', 'getLearnerCareerObjectivesAndSkillGaps', 'status')
+          response.dig('data', 'getLearnerCareerObjectivesAndSkillGaps', 'careerObjectives')
+        else
+          false
+        end
+      end
+
+      def learner_exists(email)
+        query = <<~GRAPHQL
+          query GetLearnerCareerObjectivesAndSkillGaps($studentEmail: NonEmptyString!)
+          {
+            getLearnerCareerObjectivesAndSkillGaps(studentEmail: $studentEmail) {
+              status
+              message
+            }
+          }
+        GRAPHQL
+
+        response = connection.post('graphql', {
+                                     operationName: 'GetLearnerCareerObjectivesAndSkillGaps',
+                                     query: query,
+                                     variables: {
+                                       studentEmail: email
+                                     }
+                                   })
+
+        response.dig('data', 'getLearnerCareerObjectivesAndSkillGaps', 'status')
+      end
+    end
+  end
+end

data/lib/one-mentor-ruby/client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OneMentor
+  class Client
+    include OneMentor::Actions::Base
+    include OneMentor::Actions::Learners
+
+    attr_reader :subdomain, :api_key, :base_url
+
+    def initialize(subdomain:, api_key:)
+      @subdomain  = subdomain
+      @api_key    = api_key
+
+      @base_url = "https://#{subdomain}.1mentor.io/external"
+    end
+
+    def connection
+      Connection.new(@base_url, @api_key)
+    end
+  end
+end

data/lib/one-mentor-ruby/connection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module OneMentor
+  class Connection
+    def initialize(url, api_key, options = { timeout: 60 })
+      @connection = Faraday.new(url: url) do |builder|
+        builder.request :json
+        builder.headers[:accept] = 'application/json'
+        builder.headers['Content-Type'] = 'application/json'
+        builder.headers['x-api-key'] = api_key
+        builder.response :json
+        builder.options.timeout = options[:timeout]
+      end
+    end
+
+    def post(path, params = {})
+      request(:post, 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/one-mentor-ruby/error.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OneMentor
+  class Error < StandardError
+    attr_reader :response
+
+    def self.from_response(response) # rubocop:disable Metrics/CyclomaticComplexity
+      klass =
+        case response.status
+        when 400 then BadRequest
+        when 401 then Unauthorized
+        when 403 then Forbidden
+        when 404 then NotFound
+        when 429 then TooManyRequests
+        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 TooManyRequests < Error; end
+  class ServerError < Error; end
+  class InternalServerError < Error; end
+  class BadGateway < Error; end
+  class ServiceUnavailable < Error; end
+end

data/lib/one-mentor-ruby/version.rb

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

data/lib/one-mentor-ruby.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'one-mentor-ruby/actions/base'
+require 'one-mentor-ruby/actions/learners'
+
+require 'one-mentor-ruby/client'
+require 'one-mentor-ruby/connection'
+require 'one-mentor-ruby/error'
+require 'one-mentor-ruby/version'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: one-mentor-ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jordan Ell
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Access the 1Mentor REST API.
+email:
+- jordan.ell@riipen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/one-mentor-ruby.rb
+- lib/one-mentor-ruby/actions/base.rb
+- lib/one-mentor-ruby/actions/learners.rb
+- lib/one-mentor-ruby/client.rb
+- lib/one-mentor-ruby/connection.rb
+- lib/one-mentor-ruby/error.rb
+- lib/one-mentor-ruby/version.rb
+homepage: https://github.com/riipen/one-mentor-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/riipen/one-mentor-ruby
+  changelog_uri: https://github.com/riipen/one-mentor-ruby/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: An API client for 1Mentor in ruby.
+test_files: []