plantfyi 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/plantfyi.rb +143 -0
  3. metadata +47 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 3386056879dbb2d0d315152a850aff862c33cded5c6b75a744444049dd85f367
4
+ data.tar.gz: d0640d55c53efdd2dc127c2891e507d58bec18e9e6fd3570365369168c449541
5
+ SHA512:
6
+ metadata.gz: 177c0543aee313763672ff6bdd47aeda51a6a74ec798a0233b1fb6490482ba05cdab2c080df2f536334ab6937da49e427a114e05eff66661f0c927d6119a2e61
7
+ data.tar.gz: 725e14328f39883c727f6f618a46ee511e8102080ad2f16f07d2a5e4b667f37681ee1de8ba6b42c8d7b597d83ba47dd608e54864d62ef615ffd3640d4618bd48
data/lib/plantfyi.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 PlantFYI REST API (plantfyi.com).
8
+ #
9
+ # client = PlantFYI::Client.new
10
+ # result = client.search("query")
11
+ #
12
+ module PlantFYI
13
+ class Client
14
+ BASE_URL = "https://plantfyi.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 climate zones.
25
+ def list_climate_zones
26
+ get("/api/v1/climate-zones/")
27
+ end
28
+
29
+ # Get climate zone by slug.
30
+ def get_climate_zone(slug)
31
+ get("/api/v1/climate-zones/#{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 distributions.
52
+ def list_distributions
53
+ get("/api/v1/distributions/")
54
+ end
55
+
56
+ # Get distribution by slug.
57
+ def get_distribution(slug)
58
+ get("/api/v1/distributions/#{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
+ # 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 plants.
124
+ def list_plants
125
+ get("/api/v1/plants/")
126
+ end
127
+
128
+ # Get plant by slug.
129
+ def get_plant(slug)
130
+ get("/api/v1/plants/#{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,47 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: plantfyi
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 PlantFYI REST API at plantfyi.com. Zero external
14
+ dependencies.
15
+ email: dev@fyipedia.com
16
+ executables: []
17
+ extensions: []
18
+ extra_rdoc_files: []
19
+ files:
20
+ - lib/plantfyi.rb
21
+ homepage: https://plantfyi.com
22
+ licenses:
23
+ - MIT
24
+ metadata:
25
+ source_code_uri: https://github.com/fyipedia/plantfyi-rb
26
+ documentation_uri: https://plantfyi.com/api/v1/schema/
27
+ homepage_uri: https://plantfyi.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 PlantFYI API
47
+ test_files: []