Merge pull request #392 from openstax/achievements-badge

Introducted the achievements page and the badges section

backend/app/bindings/api/v1/bindings/badge_certificate_response.rb

@@ -0,0 +1,220 @@
+=begin
+#OpenStax Kinetic API
+
+#The Kinetic API for OpenStax.  Requests to this API should include `application/json` in the `Accept` header.  The desired API version is specified in the request URL, e.g. `[domain]/api/v1/researcher/studies`. While the API does support a default version, that version will change over time and therefore should not be used in production code! 
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Api::V1::Bindings
+  class BadgeCertificateResponse
+    # Base64-encoded PDF data
+    attr_accessor :pdf
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pdf' => :'pdf'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'pdf' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Api::V1::Bindings::BadgeCertificateResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Api::V1::Bindings::BadgeCertificateResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'pdf')
+        self.pdf = attributes[:'pdf']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          pdf == o.pdf
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [pdf].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Api::V1::Bindings.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

backend/app/controllers/api/v1/badge_certificate_controller.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Api::V1::BadgeCertificateController < Api::V1::BaseController
+  before_action :render_unauthorized_unless_signed_in!
+
+  def show
+    badge_id = params[:badge_id]
+    email = params[:email]
+
+    if badge_id.blank? || email.blank?
+      render json: { error: 'Badge ID and email are required' }, status: :unprocessable_entity
+      return
+    end
+
+    response = OpenBadgeApi.instance.get_pdf(badge_id, email)
+
+    if response && response[:pdf]
+      pdf_content = response[:pdf].read
+      base64_pdf = Base64.encode64(pdf_content)
+      render json: { pdf: base64_pdf }, status: :ok
+    else
+      render json: { error: 'Failed to retrieve PDF' }, status: :bad_request
+    end
+  end
+end

backend/app/controllers/api/v1/badge_certificate_open_api.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class Api::V1::BadgeCertificateOpenApi
+  include OpenStax::OpenApi::Blocks
+
+  openapi_component do
+    schema :BadgeCertificateResponse do
+      property :pdf do
+        key :type, :string
+        key :description, 'Base64-encoded PDF data'
+      end
+    end
+  end
+
+  openapi_path '/badge_certificate' do
+    operation :get do
+      key :summary, 'Retrieve a PDF link for a badge'
+      key :description, 'Fetches a PDF link associated with a badge for a given email'
+      key :operationId, 'getBadgeCertificate'
+
+      parameter name: :badge_id, in: :query, required: true do
+        schema do
+          key :type, :string
+          key :description, 'Badge ID'
+        end
+      end
+
+      parameter name: :email, in: :query, required: true do
+        schema do
+          key :type, :string
+          key :description, 'Recipient Email'
+        end
+      end
+
+      response 200 do
+        key :description, 'PDF link retrieved successfully.'
+        content 'application/json' do
+          schema { key :$ref, :BadgeCertificateResponse }
+        end
+      end
+      response 404 do
+        key :description, 'Badge or PDF link not found.'
+      end
+      extend Api::V1::OpenApiResponses::ServerError
+    end
+  end
+end

backend/app/controllers/api/v1/open_api_controller.rb

@@ -65,6 +65,7 @@ class Api::V1::OpenApiController < ApplicationController
     Api::V1::Researcher::AnalysisRunOpenApi,
     Api::V1::LearningPathsOpenApi,
     Api::V1::ResearchersOpenApi,
+    Api::V1::BadgeCertificateOpenApi,
     self
   ].freeze
 

backend/app/services/open_badge_api.rb

@@ -57,4 +57,49 @@ def issue_badge(badge_id, emails)
             })
   end
 
+  def get_event_id(badge_id, email, called: false)
+    data = fetch_event_response(email)
+
+    matching_item = data.find { |item| item['badge_id'] == badge_id }
+
+    if matching_item.nil? || matching_item.empty?
+      issue_badge(badge_id, [email]) unless called
+      return get_event_id(badge_id, email, called: true)
+    end
+
+    matching_item['id']
+  end
+
+  def get_pdf(badge_id, email)
+    event_id = get_event_id(badge_id, email)
+
+    # Fetching the pdf link
+    pdf_response = HTTPX.plugin(:auth)
+                     .with(headers: { 'content-type' => 'application/json' })
+                     .authorization("Bearer #{token}")
+                     .get("https://openbadgefactory.com/v1/event/#{@client_id}/#{event_id}/assertion")
+
+    data = JSON.parse(pdf_response)
+    pdf_link = data['pdf']['en']
+
+    # Fetching the pdf from pdf_link
+    pdf_response = HTTPX.plugin(:auth)
+                     .authorization("Bearer #{token}")
+                     .get(pdf_link)
+
+    { pdf: pdf_response.body }
+  end
+
+  private
+
+  def fetch_event_response(email)
+    # Response is an octet stream
+    response = HTTPX.plugin(:auth)
+                 .with(headers: { 'content-type' => 'application/json' })
+                 .authorization("Bearer #{token}")
+                 .get("https://openbadgefactory.com/v1/event/#{@client_id}?email=#{email}")
+
+    json_objects = response.body.to_s.split("\n").map(&:strip).reject(&:empty?)
+    json_objects.map { |json_str| JSON.parse(json_str) }
+  end
 end

backend/config/routes.rb

@@ -72,6 +72,8 @@
 
       get :openapi, to: 'open_api#json', constraints: { format: :json }
 
+      get 'badge_certificate', to: 'badge_certificate#show'
+
       get :environment, to: 'environment#index'
 
       resources :eligibility, only: [:index]