chefu_academy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56cf1309b2b9aec7c93d650ea719bd128fdfee851bfb765ba2ccef9956819f3f
+  data.tar.gz: 05053aba56bc1c0ff0bf957d3df4c559622306efbda75429acf7a1c874391881
+SHA512:
+  metadata.gz: 6794e73aa2e4217d8a77d66d0c8a2388c1d62bbc0e747b80f95380e66bf6550ac3becc6a8903cba632a1a78c1eea5adf8312b6b6b631f8ab660b6f1186d98551
+  data.tar.gz: ea113d018beb72e2ff917feb90ed4223ea8fce0b039e1ad06cc9e635066b49889aa330ad31bd3665942398bd4216820b0510c350b231b3cd2c7aa1ee0d0a0d3f

data/README.md

@@ -0,0 +1,16 @@
+# CheFu Academy Ruby Client
+
+Official Ruby gem source for the CheFu Academy API.
+
+## Usage
+
+```ruby
+client = CheFuAcademy::Client.new(api_key: 'chf_publicId_secret')
+courses = client.list_courses(limit: 5)
+```
+
+## Local Install
+
+```bash
+bundle install
+```

data/lib/chefu_academy/client.rb

@@ -0,0 +1,169 @@
+require 'json'
+require 'net/http'
+require 'uri'
+
+module CheFuAcademy
+  DEFAULT_BASE_URL = 'https://api.chefuinc.com/api'
+
+  class Error < StandardError
+    attr_reader :status_code, :details
+
+    def initialize(message, status_code: nil, details: nil)
+      super(message)
+      @status_code = status_code
+      @details = details
+    end
+  end
+
+  class Client
+    attr_accessor :api_key, :auth_token
+
+    def initialize(api_key: nil, auth_token: nil, base_url: DEFAULT_BASE_URL, timeout: 10)
+      @api_key = api_key
+      @auth_token = auth_token
+      @base_url = base_url.delete_suffix('/')
+      @timeout = timeout
+    end
+
+    def login(email:, password:)
+      session = request('POST', '/auth/login', body: { email: email, password: password }, api_key_auth: false)
+      self.auth_token = session['idToken'] || session['token']
+      session
+    end
+
+    def register(email:, password:, fullname:)
+      request('POST', '/auth/register', body: { email: email, password: password, fullname: fullname }, api_key_auth: false)
+    end
+
+    def refresh(refresh_token:)
+      session = request('POST', '/auth/refresh', body: { refreshToken: refresh_token }, api_key_auth: false)
+      self.auth_token = session['idToken'] || session['token']
+      session
+    end
+
+    def list_courses(**query)
+      request('GET', '/courses', query: query)
+    end
+
+    def search_courses(**query)
+      request('GET', '/courses/search', query: query)
+    end
+
+    def featured_courses(**query)
+      request('GET', '/courses/featured', query: query)
+    end
+
+    def course_categories
+      request('GET', '/courses/categories')
+    end
+
+    def course(course_id)
+      request('GET', "/courses/#{escape(course_id)}")
+    end
+
+    def course_chapters(course_id)
+      request('GET', "/courses/#{escape(course_id)}/chapters")
+    end
+
+    def course_chapter(course_id, chapter_index)
+      request('GET', "/courses/#{escape(course_id)}/chapters/#{chapter_index}")
+    end
+
+    def course_lessons(course_id, chapter_index)
+      request('GET', "/courses/#{escape(course_id)}/chapters/#{chapter_index}/lessons")
+    end
+
+    def course_quiz(course_id)
+      request('GET', "/courses/#{escape(course_id)}/quiz")
+    end
+
+    def course_flashcards(course_id)
+      request('GET', "/courses/#{escape(course_id)}/flashcards")
+    end
+
+    def course_qa(course_id)
+      request('GET', "/courses/#{escape(course_id)}/qa")
+    end
+
+    def list_videos(**query)
+      request('GET', '/videos', query: query)
+    end
+
+    def search_videos(**query)
+      request('GET', '/videos/search', query: query)
+    end
+
+    def videos_by_category(category)
+      request('GET', "/videos/category/#{escape(category)}")
+    end
+
+    def video(video_id)
+      request('GET', "/videos/#{escape(video_id)}")
+    end
+
+    def create_key(name: nil)
+      request('POST', '/keys/create', body: { name: name }, user_auth: true, api_key_auth: false)
+    end
+
+    def list_keys
+      request('GET', '/keys/list', user_auth: true, api_key_auth: false)
+    end
+
+    def revoke_key(key_id)
+      request('POST', '/keys/revoke', body: { keyId: key_id }, user_auth: true, api_key_auth: false)
+    end
+
+    private
+
+    def request(method, path, query: {}, body: nil, user_auth: false, api_key_auth: true)
+      token = user_auth ? auth_token : api_key
+      raise Error.new('User authentication is required.', status_code: 401) if user_auth && blank?(token)
+      raise Error.new('API key is required.', status_code: 401) if api_key_auth && !user_auth && blank?(token)
+
+      uri = URI("#{@base_url}#{path}")
+      clean_query = query.reject { |_key, value| value.nil? || value.to_s.empty? }
+      uri.query = URI.encode_www_form(clean_query) unless clean_query.empty?
+
+      request = Net::HTTP.const_get(method.capitalize).new(uri)
+      request['Accept'] = 'application/json'
+      request['Authorization'] = "Bearer #{token}" unless blank?(token)
+      if body
+        request['Content-Type'] = 'application/json'
+        request.body = JSON.generate(body)
+      end
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', read_timeout: @timeout) do |http|
+        http.request(request)
+      end
+
+      decoded = response.body.nil? || response.body.empty? ? nil : JSON.parse(response.body)
+      unless response.is_a?(Net::HTTPSuccess)
+        raise Error.new(error_message(decoded, response.body), status_code: response.code.to_i, details: decoded)
+      end
+
+      decoded
+    rescue JSON::ParserError => error
+      raise Error.new("JSON parse error: #{error.message}")
+    end
+
+    def escape(value)
+      URI.encode_www_form_component(value.to_s).gsub('+', '%20')
+    end
+
+    def blank?(value)
+      value.nil? || value.to_s.empty?
+    end
+
+    def error_message(decoded, raw)
+      if decoded.is_a?(Hash)
+        message = decoded['message']
+        return message.join(' ') if message.is_a?(Array)
+        return message if message.is_a?(String) && !message.empty?
+        error = decoded['error']
+        return error if error.is_a?(String) && !error.empty?
+      end
+
+      raw.nil? || raw.empty? ? 'CheFu Academy request failed.' : raw
+    end
+  end
+end

data/lib/chefu_academy.rb

@@ -0,0 +1,4 @@
+require_relative 'chefu_academy/client'
+
+module CheFuAcademy
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: chefu_academy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CheFu Inc
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-06-03 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/chefu_academy.rb
+- lib/chefu_academy/client.rb
+homepage: https://github.com/CheFu-code/CheFu-Academy-SDK
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/CheFu-code/CheFu-Academy-SDK
+  source_code_uri: https://github.com/CheFu-code/CheFu-Academy-SDK/tree/main/clients/ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Official Ruby client for the CheFu Academy API
+test_files: []