common_app

This is gem for integration of common app

MIT License

Stars
0
View Code on GitHub
Ecosystems: Ruby

Common App

Common App Partner API

Installation

Add these lines to your application's Gemfile:

gem 'savon', git: 'https://github.com/haider-cialfo/savon.git'
gem 'common_app'

And then execute:

$ bundle

Configuration

Create a file with a name common_app.rb in config/initializers

Add these lines to config/initializers/common_app.rb:

CommonApp.configure do |config|
  config.rest_api     = '' # Common App Partner REST API URL
  config.soap_service = '' # Common App Partner Soap Service WSDL URL
  config.api_key      = '' # Your API Key
  config.username     = '' # Your Username
  config.password     = '' # Your Password
  config.proxy        = '' # (Optional) Your Proxy URL
  config.cache        = Rails.cache # Or replace with cache of your own choice
end

Usage

Table of Contents

Auth

In the configuration, supply:

  • rest_api
  • soap_service
  • api_key
  • username
  • password
  • proxy
  • cache

Create

Applicant

params  = {
  "address" : {
    "addressline1" : "Address line 1",
    "addressline2" : "Address line 1",
    "addressline3" : "Address line 1",
    "city" : "City name",
    "country" : "Country name",
    "state" : "State name",
    "zip" : "123456"
  },
  "birthdate" : "03/21/2000",
  "email" : "[email protected]",
  "firstname" : "Example",
  "lastname" : "Last Name",
  "phone" : {
    "countrycode" : "+65",
    "number" : "123456789"
  }
}

CommonApp::Create::Applicant.new(params).call

Get

Applicant

Application Status

params = {
    "applicant_id" : "Applicant ID"
    "member_id" : "Member ID"
}

CommonApp::Get::Applicant::ApplicationStatus.new(params).call

Authorization Status

params = {
    "applicant_id" : "Applicant ID"
}

CommonApp::Get::Applicant::AuthorizationStatus.new(params).call

Details

params = {
    "applicant_id" : "Applicant ID"
}

CommonApp::Get::Applicant::Detail.new(params).call

Get

params = {
    "email" : "Email Address"
}

CommonApp::Get::Applicant::Get.new(params).call

Counselor

ED2 Status

"applicant_id" : "Applicant ID"
"recommender_id" : "Recommender ID"
"member_id": "Member ID"

CommonApp::Get::Counselor::EarlyDecision2Status.new(applicant_id, recommender_id, member_id).call

ED Status

params = {
  "applicant_id" : "Applicant ID"
  "recommender_id" : "Recommender ID"
  "member_id": "Member ID"
}

CommonApp::Get::Counselor::EarlyDecisionStatus.new(params).call

FeeWaiver Status

params = {
  "applicant_id" : "Applicant ID"
  "recommender_id" : "Recommender ID"
  "member_id": "Member ID"
}

CommonApp::Get::Counselor::FeeWavierStatus.new(params).call

Final Report Status

params = {
  "applicant_id" : "Applicant ID"
  "recommender_id" : "Recommender ID"
  "member_id": "Member ID"
}

CommonApp::Get::Counselor::FinalReportStatus.new(params).call

Get

params = {
  "email" : "Email Address"
}

CommonApp::Get::Counselor::Get.new(params).call

Midyear Report Status

params = {
  "applicant_id" : "Applicant ID"
  "recommender_id" : "Recommender ID"
  "member_id": "Member ID"
}

CommonApp::Get::Counselor::MidyearReportStatus.new(params).call

Optional Report Status

params = {
  "applicant_id" : "Applicant ID"
  "recommender_id" : "Recommender ID"
  "member_id": "Member ID"
}

CommonApp::Get::Counselor::OptionalReportStatus.new(params).call

Recommendation Status

params = {
  "applicant_id" : "Applicant ID"
  "recommender_id" : "Recommender ID"
  "member_id": "Member ID"
}

CommonApp::Get::Counselor::RecommendationStatus.new(params).call

Secondary Report Status

params = {
  "applicant_id" : "Applicant ID"
  "recommender_id" : "Recommender ID"
  "member_id": "Member ID"
}

CommonApp::Get::Counselor::SecondaryReportStatus.new(params).call

Status

params = {
  "recommender_id" : "Recommender ID"
}

CommonApp::Get::Counselor::Status.new(params).call

Members

Deadlines

CommonApp::Get::Members::Deadlines.new.call

List

CommonApp::Get::Members::List.new.call

Teacher

RecommendationStatus

params = {
    "applicant_id" : "Applicant ID"
    "recommender_id" : "recommender_id"
    "member_id" : "member_id"
}

CommonApp::Get::Teacher::RecommendationStatus.new(params).call

SecondarySchools

CommonApp::Get::SecondarySchools.new.call

Invite

Assign

Remove Teacher

params = {
    "applicant_id" : "Applicant ID"
    "recommender_id" : "Recommender ID"
    "member_id" : "Member ID"
}

CommonApp::Invite::Assign::RemoveTeacher.new(params).call

Teacher

params = {
    "applicant_id" : "Applicant ID"
    "recommender_id" : "Recommender ID"
    "member_id" : "Member ID"
}

CommonApp::Invite::Assign::Teacher.new(params).call

Counselor

params = {
    "applicant_id" = "Applicant ID"
    "counselor" = "Counselor"
}

CommonApp::Invite::Counselor.new(params).call

RemoveCounselor

params = {
    "applicant_id" = "Applicant ID"
    "counselor" = "Counselor"
}

CommonApp::Invite::RemoveCounselor.new(params).call

RemoveTeacher

params = {
    "applicant_id" = "Applicant ID"
    "recommender_id" = "Recommender ID"
}

CommonApp::Invite::RemoveTeacher.new(params).call

Teacher

params = {
    "applicant_id" = "Applicant ID"
    "teacher" = "Teacher"
    "subject" = "Subject"
}

CommonApp::Invite::Teacher.new(params).call

Post

Counselor

ED

  Answers: [
    {
     AnswerData: {
              QuestionId: question_id,
              Response: response
            },
     AnswerData: {
              QuestionId: question_id,
              UploadFileContents: file content
            }       
    }
  }
  ],
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Post::Counselor::ED.new(params).call

ED2

  Answers: [
    {
     AnswerData: {
              QuestionId: question_id,
              Response: response
            },
     AnswerData: {
              QuestionId: question_id,
              UploadFileContents: file content
            }       
    }
  }
  ],
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Post::Counselor::ED2.new(params).call

Fee Waiver

  Answers: [
    {
     AnswerData: {
              QuestionId: question_id,
              Response: response
            },
     AnswerData: {
              QuestionId: question_id,
              UploadFileContents: file content
            }       
    }
  }
  ],
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Post::Counselor::FeeWaiver.new(params).call

Final Report

  Answers: [
    {
     AnswerData: {
              QuestionId: question_id,
              Response: response
            },
     AnswerData: {
              QuestionId: question_id,
              UploadFileContents: file content
            }       
    }
  }
  ],
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Post::Counselor::FinalReport.new(params).call

Midyear Report

  Answers: [
    {
     AnswerData: {
              QuestionId: question_id,
              Response: response
            },
     AnswerData: {
              QuestionId: question_id,
              UploadFileContents: file content
            }       
    }
  }
  ],
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Post::Counselor::MidyearReport.new(params).call

Optional Report

  Answers: [
    {
     AnswerData: {
              QuestionId: question_id,
              Response: response
            },
     AnswerData: {
              QuestionId: question_id,
              UploadFileContents: file content
            }       
    }
  }
  ],
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Post::Counselor::OptionalReport.new(params).call

Recommendation

  Answers: [
    {
     AnswerData: {
              QuestionId: question_id,
              Response: response
            },
     AnswerData: {
              QuestionId: question_id,
              UploadFileContents: file content
            }       
    }
  }
  ],
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Post::Counselor::Recommendation.new(params).call

Secondary Report

  Answers: [
    {
     AnswerData: {
              QuestionId: question_id,
              Response: response
            },
     AnswerData: {
              QuestionId: question_id,
              UploadFileContents: file content
            }       
    }
  }
  ],
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Post::Counselor::SecondaryReport.new(params).call

Teacher

Recommendation

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Post::Teacher::Recommendation.new(params).call

Submit

Counselor

ED

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Submit::Counselor::EarlyDecision.new(params).call

ED2

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Submit::Counselor::EarlyDecision2.new(params).call

Fee Waiver

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Submit::Counselor::FeeWaiver.new(params).call

Final Report

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
  MemberId: member_id
  SchoolId: school_id
}

CommonApp::Submit::Counselor::FinalReport.new(params).call

Midyear Report

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Submit::Counselor::MidYearReport.new(params).call

Optional Report

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Submit::Counselor::OptionalReport.new(params).call

Recommendation

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Submit::Counselor::Recommendation.new(params).call

School Report

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
}

CommonApp::Submit::Counselor::SchoolReport.new(params).call

Teacher

Recommendation

params = {
  ApplicantId: common_app_applicant_id,
  RecommenderId: common_app_recommender_id
  MemberId: member_id
  SchoolId: school_id
}

CommonApp::Submit::Teacher::Recommendation.new(params).call

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Hitendra1632/common_app. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the CommonApp project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Related Projects
ruby-openai

OpenAI API + Ruby! 🤖❤️ NEW: Assistant Vector Stores

03 Aug 2020 2,725
ruby_whatsapp_sdk

A lightweight, efficient Ruby gem for interacting with Whatsapp Cloud API.

29 May 2022 161
dev-ruby

Ruby bindings for dev.to API

15 May 2022 7
restrictable

Simple authorization gem for Ruby on Rails.

03 Feb 2018 6
mail-notify

Rails plugin, send and preview email with GOV.UK Notify

30 Jan 2019 5
attr-gather

Hit a million different APIs and combine the results in one simple hash (without pulling your hai...

24 Oct 2019 39
case_register

Provide a design pattern to manage switch statements by mapping each case to a method which is dy...

09 Sep 2020 6
XSpear

🔱 Powerfull XSS Scanning and Parameter analysis tool&gem

12 Jul 2019 1,172
rubocop-cable_ready

Code style checking for CableReady

27 Jun 2021 4
miller

DSL constructor

16 Nov 2018 1
request_via

RequestVia: A Functional HTTP Client That Wraps Net::HTTP

30 Oct 2017 75
allure-report-publisher

Upload allure reports to cloud storage

20 Apr 2021 27
langchainrb

Build LLM-powered applications in Ruby

18 Apr 2023 1,073
github

Ruby interface to GitHub API

25 Sep 2011 1,146
fixings

An opinionated Rails toolkit for code formatting, logging, testing, etc

16 Jan 2020 0