birdfyi 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/birdfyi.rb +143 -0
  3. metadata +46 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 0eea11e9bf0030d1367175cdcc0490cfd889c28467a6b102e3faaa2a84ba5eb7
4
+ data.tar.gz: e3f62ede25452592c3678e40625b7cafb96d270086d63267ecdbe346a5e6a067
5
+ SHA512:
6
+ metadata.gz: d02a8f22e7f7e3cea1a336d41e010b88aace36428913d7ef9fa65f1871ee001d35132ca416cdd7f7ef2a591501e43e0e28c793f30baaeac195465f003f1861bf
7
+ data.tar.gz: 26328ad86744feb43166bdd744e1c90951f6c0d50f6db8f55d23d9078849a563240a193f1940afe61332da1a414dd1e7f880adac757f09dfbe4faff20b0cdea9
data/lib/birdfyi.rb ADDED
@@ -0,0 +1,143 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "net/http"
4
+ require "json"
5
+ require "uri"
6
+
7
+ # Ruby client for BirdFYI REST API (birdfyi.com).
8
+ #
9
+ # client = BirdFYI::Client.new
10
+ # result = client.search("query")
11
+ #
12
+ module BirdFYI
13
+ class Client
14
+ BASE_URL = "https://birdfyi.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 birds.
25
+ def list_birds
26
+ get("/api/v1/birds/")
27
+ end
28
+
29
+ # Get bird by slug.
30
+ def get_bird(slug)
31
+ get("/api/v1/birds/#{slug}/")
32
+ end
33
+ # List all comparisons.
34
+ def list_comparisons
35
+ get("/api/v1/comparisons/")
36
+ end
37
+
38
+ # Get comparison by slug.
39
+ def get_comparison(slug)
40
+ get("/api/v1/comparisons/#{slug}/")
41
+ end
42
+ # List all countries.
43
+ def list_countries
44
+ get("/api/v1/countries/")
45
+ end
46
+
47
+ # Get country by slug.
48
+ def get_country(slug)
49
+ get("/api/v1/countries/#{slug}/")
50
+ end
51
+ # List all families.
52
+ def list_families
53
+ get("/api/v1/families/")
54
+ end
55
+
56
+ # Get family by slug.
57
+ def get_family(slug)
58
+ get("/api/v1/families/#{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 habitats.
106
+ def list_habitats
107
+ get("/api/v1/habitats/")
108
+ end
109
+
110
+ # Get habitat by slug.
111
+ def get_habitat(slug)
112
+ get("/api/v1/habitats/#{slug}/")
113
+ end
114
+ # List all orders.
115
+ def list_orders
116
+ get("/api/v1/orders/")
117
+ end
118
+
119
+ # Get order by slug.
120
+ def get_order(slug)
121
+ get("/api/v1/orders/#{slug}/")
122
+ end
123
+ # List all regional presences.
124
+ def list_regional_presences
125
+ get("/api/v1/regional-presences/")
126
+ end
127
+
128
+ # Get regional presence by slug.
129
+ def get_regional_presence(slug)
130
+ get("/api/v1/regional-presences/#{slug}/")
131
+ end
132
+
133
+ private
134
+
135
+ def get(path, **params)
136
+ uri = URI.join(@base_url, path)
137
+ uri.query = URI.encode_www_form(params) unless params.empty?
138
+ response = Net::HTTP.get_response(uri)
139
+ raise "HTTP #{response.code}" unless response.is_a?(Net::HTTPSuccess)
140
+ JSON.parse(response.body)
141
+ end
142
+ end
143
+ end
metadata ADDED
@@ -0,0 +1,46 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: birdfyi
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 BirdFYI REST API at birdfyi.com. Zero external dependencies.
14
+ email: dev@fyipedia.com
15
+ executables: []
16
+ extensions: []
17
+ extra_rdoc_files: []
18
+ files:
19
+ - lib/birdfyi.rb
20
+ homepage: https://birdfyi.com
21
+ licenses:
22
+ - MIT
23
+ metadata:
24
+ source_code_uri: https://github.com/fyipedia/birdfyi-rb
25
+ documentation_uri: https://birdfyi.com/api/v1/schema/
26
+ homepage_uri: https://birdfyi.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 BirdFYI API
46
+ test_files: []