alloyfyi 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/alloyfyi.rb +125 -0
  3. metadata +47 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 760dda49afc313869c21bfe09ce36eaea3aa19b6e0fe74ca91b1129b4293155c
4
+ data.tar.gz: 2dd56cd865fed0023b3749cda2d6a3fa455ef112a40a57e7f10ca4202a236b9c
5
+ SHA512:
6
+ metadata.gz: 685eaaa1eb88cef5337a31b0b360c4b9c7dbaecfa2a4c10fdebc39324cba49f222dcf0adb5af7cb181aa80a577bc4acdf626531d8806187a011bde3992eea3bb
7
+ data.tar.gz: 8655e331dc4f37455a72f3f9ba2b7e66e9490f3fce49d40a2aec2ab01c6e3a5fd67a6944f3916047da4c67218dd0e11bb1bf88b374969227eec9c8fb019ffd55
data/lib/alloyfyi.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 AlloyFYI REST API (alloyfyi.com).
8
+ #
9
+ # client = AlloyFYI::Client.new
10
+ # result = client.search("query")
11
+ #
12
+ module AlloyFYI
13
+ class Client
14
+ BASE_URL = "https://alloyfyi.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 alloy applications.
25
+ def list_alloy_applications
26
+ get("/api/v1/alloy-applications/")
27
+ end
28
+
29
+ # Get alloy application by slug.
30
+ def get_alloy_application(slug)
31
+ get("/api/v1/alloy-applications/#{slug}/")
32
+ end
33
+ # List all alloys.
34
+ def list_alloys
35
+ get("/api/v1/alloys/")
36
+ end
37
+
38
+ # Get alloy by slug.
39
+ def get_alloy(slug)
40
+ get("/api/v1/alloys/#{slug}/")
41
+ end
42
+ # List all applications.
43
+ def list_applications
44
+ get("/api/v1/applications/")
45
+ end
46
+
47
+ # Get application by slug.
48
+ def get_application(slug)
49
+ get("/api/v1/applications/#{slug}/")
50
+ end
51
+ # List all comparisons.
52
+ def list_comparisons
53
+ get("/api/v1/comparisons/")
54
+ end
55
+
56
+ # Get comparison by slug.
57
+ def get_comparison(slug)
58
+ get("/api/v1/comparisons/#{slug}/")
59
+ end
60
+ # List all families.
61
+ def list_families
62
+ get("/api/v1/families/")
63
+ end
64
+
65
+ # Get family by slug.
66
+ def get_family(slug)
67
+ get("/api/v1/families/#{slug}/")
68
+ end
69
+ # List all faqs.
70
+ def list_faqs
71
+ get("/api/v1/faqs/")
72
+ end
73
+
74
+ # Get faq by slug.
75
+ def get_faq(slug)
76
+ get("/api/v1/faqs/#{slug}/")
77
+ end
78
+ # List all glossary.
79
+ def list_glossary
80
+ get("/api/v1/glossary/")
81
+ end
82
+
83
+ # Get term by slug.
84
+ def get_term(slug)
85
+ get("/api/v1/glossary/#{slug}/")
86
+ end
87
+ # List all glossary categories.
88
+ def list_glossary_categories
89
+ get("/api/v1/glossary-categories/")
90
+ end
91
+
92
+ # Get glossary category by slug.
93
+ def get_glossary_category(slug)
94
+ get("/api/v1/glossary-categories/#{slug}/")
95
+ end
96
+ # List all guide series.
97
+ def list_guide_series
98
+ get("/api/v1/guide-series/")
99
+ end
100
+
101
+ # Get guide sery by slug.
102
+ def get_guide_sery(slug)
103
+ get("/api/v1/guide-series/#{slug}/")
104
+ end
105
+ # List all guides.
106
+ def list_guides
107
+ get("/api/v1/guides/")
108
+ end
109
+
110
+ # Get guide by slug.
111
+ def get_guide(slug)
112
+ get("/api/v1/guides/#{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,47 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: alloyfyi
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 AlloyFYI REST API at alloyfyi.com. Zero external
14
+ dependencies.
15
+ email: dev@fyipedia.com
16
+ executables: []
17
+ extensions: []
18
+ extra_rdoc_files: []
19
+ files:
20
+ - lib/alloyfyi.rb
21
+ homepage: https://alloyfyi.com
22
+ licenses:
23
+ - MIT
24
+ metadata:
25
+ source_code_uri: https://github.com/fyipedia/alloyfyi-rb
26
+ documentation_uri: https://alloyfyi.com/api/v1/schema/
27
+ homepage_uri: https://alloyfyi.com
28
+ post_install_message:
29
+ rdoc_options: []
30
+ require_paths:
31
+ - lib
32
+ required_ruby_version: !ruby/object:Gem::Requirement
33
+ requirements:
34
+ - - ">="
35
+ - !ruby/object:Gem::Version
36
+ version: '3.0'
37
+ required_rubygems_version: !ruby/object:Gem::Requirement
38
+ requirements:
39
+ - - ">="
40
+ - !ruby/object:Gem::Version
41
+ version: '0'
42
+ requirements: []
43
+ rubygems_version: 3.0.3.1
44
+ signing_key:
45
+ specification_version: 4
46
+ summary: Ruby client for AlloyFYI API
47
+ test_files: []