univfyi 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/univfyi.rb +125 -0
- metadata +46 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 7a3a3c962a51aa36b00447c7447372c44c06f19e74a0d9964f5e871fde3db54f
|
|
4
|
+
data.tar.gz: f7a261604e5386e199b109777f8de237be4540dd132c1a022ae7280d8cffda67
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: c4f298f66d300862d277908bb4cfd9538636a02215d385f262f797108c556bff5ad8f531508492725c640f984cfcdf2c2517faf8295748d307b1c79cb1df1948
|
|
7
|
+
data.tar.gz: fb381b8fa29282c31b92adfdc21aca3549e83d7d69fdb30506cc2c7407adb69e4f029d9321620461c07d166a8b6f3ca6eb6d752061ed7f56d974325968745a31
|
data/lib/univfyi.rb
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "net/http"
|
|
4
|
+
require "json"
|
|
5
|
+
require "uri"
|
|
6
|
+
|
|
7
|
+
# Ruby client for UnivFYI REST API (univfyi.com).
|
|
8
|
+
#
|
|
9
|
+
# client = UnivFYI::Client.new
|
|
10
|
+
# result = client.search("query")
|
|
11
|
+
#
|
|
12
|
+
module UnivFYI
|
|
13
|
+
class Client
|
|
14
|
+
BASE_URL = "https://univfyi.com"
|
|
15
|
+
|
|
16
|
+
def initialize(base_url: BASE_URL)
|
|
17
|
+
@base_url = base_url
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
def search(query)
|
|
21
|
+
get("/api/v1/search/", q: query)
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
# List all continents.
|
|
25
|
+
def list_continents
|
|
26
|
+
get("/api/v1/continents/")
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
# Get continent by slug.
|
|
30
|
+
def get_continent(slug)
|
|
31
|
+
get("/api/v1/continents/#{slug}/")
|
|
32
|
+
end
|
|
33
|
+
# List all countries.
|
|
34
|
+
def list_countries
|
|
35
|
+
get("/api/v1/countries/")
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Get country by slug.
|
|
39
|
+
def get_country(slug)
|
|
40
|
+
get("/api/v1/countries/#{slug}/")
|
|
41
|
+
end
|
|
42
|
+
# List all faqs.
|
|
43
|
+
def list_faqs
|
|
44
|
+
get("/api/v1/faqs/")
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Get faq by slug.
|
|
48
|
+
def get_faq(slug)
|
|
49
|
+
get("/api/v1/faqs/#{slug}/")
|
|
50
|
+
end
|
|
51
|
+
# List all glossary.
|
|
52
|
+
def list_glossary
|
|
53
|
+
get("/api/v1/glossary/")
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# Get term by slug.
|
|
57
|
+
def get_term(slug)
|
|
58
|
+
get("/api/v1/glossary/#{slug}/")
|
|
59
|
+
end
|
|
60
|
+
# List all glossary categories.
|
|
61
|
+
def list_glossary_categories
|
|
62
|
+
get("/api/v1/glossary-categories/")
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# Get glossary category by slug.
|
|
66
|
+
def get_glossary_category(slug)
|
|
67
|
+
get("/api/v1/glossary-categories/#{slug}/")
|
|
68
|
+
end
|
|
69
|
+
# List all guide series.
|
|
70
|
+
def list_guide_series
|
|
71
|
+
get("/api/v1/guide-series/")
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Get guide sery by slug.
|
|
75
|
+
def get_guide_sery(slug)
|
|
76
|
+
get("/api/v1/guide-series/#{slug}/")
|
|
77
|
+
end
|
|
78
|
+
# List all guides.
|
|
79
|
+
def list_guides
|
|
80
|
+
get("/api/v1/guides/")
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Get guide by slug.
|
|
84
|
+
def get_guide(slug)
|
|
85
|
+
get("/api/v1/guides/#{slug}/")
|
|
86
|
+
end
|
|
87
|
+
# List all regions.
|
|
88
|
+
def list_regions
|
|
89
|
+
get("/api/v1/regions/")
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# Get region by slug.
|
|
93
|
+
def get_region(slug)
|
|
94
|
+
get("/api/v1/regions/#{slug}/")
|
|
95
|
+
end
|
|
96
|
+
# List all tiers.
|
|
97
|
+
def list_tiers
|
|
98
|
+
get("/api/v1/tiers/")
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Get tier by slug.
|
|
102
|
+
def get_tier(slug)
|
|
103
|
+
get("/api/v1/tiers/#{slug}/")
|
|
104
|
+
end
|
|
105
|
+
# List all universities.
|
|
106
|
+
def list_universities
|
|
107
|
+
get("/api/v1/universities/")
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Get university by slug.
|
|
111
|
+
def get_university(slug)
|
|
112
|
+
get("/api/v1/universities/#{slug}/")
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
private
|
|
116
|
+
|
|
117
|
+
def get(path, **params)
|
|
118
|
+
uri = URI.join(@base_url, path)
|
|
119
|
+
uri.query = URI.encode_www_form(params) unless params.empty?
|
|
120
|
+
response = Net::HTTP.get_response(uri)
|
|
121
|
+
raise "HTTP #{response.code}" unless response.is_a?(Net::HTTPSuccess)
|
|
122
|
+
JSON.parse(response.body)
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: univfyi
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- FYIPedia
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2026-03-21 00:00:00.000000000 Z
|
|
12
|
+
dependencies: []
|
|
13
|
+
description: Ruby client for the UnivFYI REST API at univfyi.com. Zero external dependencies.
|
|
14
|
+
email: dev@fyipedia.com
|
|
15
|
+
executables: []
|
|
16
|
+
extensions: []
|
|
17
|
+
extra_rdoc_files: []
|
|
18
|
+
files:
|
|
19
|
+
- lib/univfyi.rb
|
|
20
|
+
homepage: https://univfyi.com
|
|
21
|
+
licenses:
|
|
22
|
+
- MIT
|
|
23
|
+
metadata:
|
|
24
|
+
source_code_uri: https://github.com/fyipedia/univfyi-rb
|
|
25
|
+
documentation_uri: https://univfyi.com/api/v1/schema/
|
|
26
|
+
homepage_uri: https://univfyi.com
|
|
27
|
+
post_install_message:
|
|
28
|
+
rdoc_options: []
|
|
29
|
+
require_paths:
|
|
30
|
+
- lib
|
|
31
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
32
|
+
requirements:
|
|
33
|
+
- - ">="
|
|
34
|
+
- !ruby/object:Gem::Version
|
|
35
|
+
version: '3.0'
|
|
36
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - ">="
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '0'
|
|
41
|
+
requirements: []
|
|
42
|
+
rubygems_version: 3.0.3.1
|
|
43
|
+
signing_key:
|
|
44
|
+
specification_version: 4
|
|
45
|
+
summary: Ruby client for UnivFYI API
|
|
46
|
+
test_files: []
|