starfyi 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.
Files changed (3) hide show
  1. checksums.yaml +7 -0
  2. data/lib/starfyi.rb +134 -0
  3. metadata +46 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: e337583d25ef1f98aa8c0b9fb2a296c65744b8cd8c8652ee746e65367d8997f6
4
+ data.tar.gz: 35ff5bd72c00ec374f10e0da917e77a9f856c85e3a3926f0d7f2becfe358287f
5
+ SHA512:
6
+ metadata.gz: a4ce7e0424b92bfb9f3d5da79f1c445c6bb14b4c3d21134b3ccae44a8ba7ca188fef048d419f29746e218037e083759ca37b9029baaedb120a9771a8eafbc001
7
+ data.tar.gz: 2845ecd4e29decfbbc0297c8a7ac03084366fcfdd5beeefba46014f951562a049a7f1064ef9bd6f584921abcc4aad0a38102de7c4b0fd4b5cd525b489e0a32de
data/lib/starfyi.rb ADDED
@@ -0,0 +1,134 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "net/http"
4
+ require "json"
5
+ require "uri"
6
+
7
+ # Ruby client for StarFYI REST API (starfyi.com).
8
+ #
9
+ # client = StarFYI::Client.new
10
+ # result = client.search("query")
11
+ #
12
+ module StarFYI
13
+ class Client
14
+ BASE_URL = "https://starfyi.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 comparisons.
25
+ def list_comparisons
26
+ get("/api/v1/comparisons/")
27
+ end
28
+
29
+ # Get comparison by slug.
30
+ def get_comparison(slug)
31
+ get("/api/v1/comparisons/#{slug}/")
32
+ end
33
+ # List all constellations.
34
+ def list_constellations
35
+ get("/api/v1/constellations/")
36
+ end
37
+
38
+ # Get constellation by slug.
39
+ def get_constellation(slug)
40
+ get("/api/v1/constellations/#{slug}/")
41
+ end
42
+ # List all deep sky.
43
+ def list_deep_sky
44
+ get("/api/v1/deep-sky/")
45
+ end
46
+
47
+ # Get deep sky by slug.
48
+ def get_deep_sky(slug)
49
+ get("/api/v1/deep-sky/#{slug}/")
50
+ end
51
+ # List all exoplanets.
52
+ def list_exoplanets
53
+ get("/api/v1/exoplanets/")
54
+ end
55
+
56
+ # Get exoplanet by slug.
57
+ def get_exoplanet(slug)
58
+ get("/api/v1/exoplanets/#{slug}/")
59
+ end
60
+ # List all faqs.
61
+ def list_faqs
62
+ get("/api/v1/faqs/")
63
+ end
64
+
65
+ # Get faq by slug.
66
+ def get_faq(slug)
67
+ get("/api/v1/faqs/#{slug}/")
68
+ end
69
+ # List all glossary.
70
+ def list_glossary
71
+ get("/api/v1/glossary/")
72
+ end
73
+
74
+ # Get term by slug.
75
+ def get_term(slug)
76
+ get("/api/v1/glossary/#{slug}/")
77
+ end
78
+ # List all glossary categories.
79
+ def list_glossary_categories
80
+ get("/api/v1/glossary-categories/")
81
+ end
82
+
83
+ # Get glossary category by slug.
84
+ def get_glossary_category(slug)
85
+ get("/api/v1/glossary-categories/#{slug}/")
86
+ end
87
+ # List all guide series.
88
+ def list_guide_series
89
+ get("/api/v1/guide-series/")
90
+ end
91
+
92
+ # Get guide sery by slug.
93
+ def get_guide_sery(slug)
94
+ get("/api/v1/guide-series/#{slug}/")
95
+ end
96
+ # List all guides.
97
+ def list_guides
98
+ get("/api/v1/guides/")
99
+ end
100
+
101
+ # Get guide by slug.
102
+ def get_guide(slug)
103
+ get("/api/v1/guides/#{slug}/")
104
+ end
105
+ # List all spectral classes.
106
+ def list_spectral_classes
107
+ get("/api/v1/spectral-classes/")
108
+ end
109
+
110
+ # Get spectral classe by slug.
111
+ def get_spectral_classe(slug)
112
+ get("/api/v1/spectral-classes/#{slug}/")
113
+ end
114
+ # List all stars.
115
+ def list_stars
116
+ get("/api/v1/stars/")
117
+ end
118
+
119
+ # Get star by slug.
120
+ def get_star(slug)
121
+ get("/api/v1/stars/#{slug}/")
122
+ end
123
+
124
+ private
125
+
126
+ def get(path, **params)
127
+ uri = URI.join(@base_url, path)
128
+ uri.query = URI.encode_www_form(params) unless params.empty?
129
+ response = Net::HTTP.get_response(uri)
130
+ raise "HTTP #{response.code}" unless response.is_a?(Net::HTTPSuccess)
131
+ JSON.parse(response.body)
132
+ end
133
+ end
134
+ end
metadata ADDED
@@ -0,0 +1,46 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: starfyi
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 StarFYI REST API at starfyi.com. Zero external dependencies.
14
+ email: dev@fyipedia.com
15
+ executables: []
16
+ extensions: []
17
+ extra_rdoc_files: []
18
+ files:
19
+ - lib/starfyi.rb
20
+ homepage: https://starfyi.com
21
+ licenses:
22
+ - MIT
23
+ metadata:
24
+ source_code_uri: https://github.com/fyipedia/starfyi-rb
25
+ documentation_uri: https://starfyi.com/api/v1/schema/
26
+ homepage_uri: https://starfyi.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 StarFYI API
46
+ test_files: []