zipfyi 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/zipfyi.rb +107 -0
  3. metadata +46 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 7646cc12ad21f8296d7f80e4331f3d1103f8bdab1a0ece75be20adcd4ad1b412
4
+ data.tar.gz: 534eba69e2db6ebd2ff53cd0c4865398bf8caff515c3bcf5bc0f968af946b6bd
5
+ SHA512:
6
+ metadata.gz: 68098e0be646bf7d0fc17cc4a9923f1195f1c3c539d76bfa8563920a78f8c34bcec4a6c0a63d6d0be6a65d9d396acc46cd673fb465139c7f9a5696de2f7fe766
7
+ data.tar.gz: 9b13096d31aa5c4f5241c5de6a5087c4989c6bdeaf849279f1e1e665cf888631a7f5431c4456e6bef554cfd64ecee72b9cbf216dbb1206cba59ce758cdb1804b
data/lib/zipfyi.rb ADDED
@@ -0,0 +1,107 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "net/http"
4
+ require "json"
5
+ require "uri"
6
+
7
+ # Ruby client for ZipFYI REST API (zipfyi.com).
8
+ #
9
+ # client = ZipFYI::Client.new
10
+ # result = client.search("query")
11
+ #
12
+ module ZipFYI
13
+ class Client
14
+ BASE_URL = "https://zipfyi.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 blog posts.
25
+ def list_blog_posts
26
+ get("/api/v1/blog-posts/")
27
+ end
28
+
29
+ # Get blog post by slug.
30
+ def get_blog_post(slug)
31
+ get("/api/v1/blog-posts/#{slug}/")
32
+ end
33
+ # List all blog series.
34
+ def list_blog_series
35
+ get("/api/v1/blog-series/")
36
+ end
37
+
38
+ # Get blog sery by slug.
39
+ def get_blog_sery(slug)
40
+ get("/api/v1/blog-series/#{slug}/")
41
+ end
42
+ # List all cities.
43
+ def list_cities
44
+ get("/api/v1/cities/")
45
+ end
46
+
47
+ # Get city by slug.
48
+ def get_city(slug)
49
+ get("/api/v1/cities/#{slug}/")
50
+ end
51
+ # List all countries.
52
+ def list_countries
53
+ get("/api/v1/countries/")
54
+ end
55
+
56
+ # Get country by slug.
57
+ def get_country(slug)
58
+ get("/api/v1/countries/#{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 postal codes.
79
+ def list_postal_codes
80
+ get("/api/v1/postal-codes/")
81
+ end
82
+
83
+ # Get postal code by slug.
84
+ def get_postal_code(slug)
85
+ get("/api/v1/postal-codes/#{slug}/")
86
+ end
87
+ # List all states.
88
+ def list_states
89
+ get("/api/v1/states/")
90
+ end
91
+
92
+ # Get state by slug.
93
+ def get_state(slug)
94
+ get("/api/v1/states/#{slug}/")
95
+ end
96
+
97
+ private
98
+
99
+ def get(path, **params)
100
+ uri = URI.join(@base_url, path)
101
+ uri.query = URI.encode_www_form(params) unless params.empty?
102
+ response = Net::HTTP.get_response(uri)
103
+ raise "HTTP #{response.code}" unless response.is_a?(Net::HTTPSuccess)
104
+ JSON.parse(response.body)
105
+ end
106
+ end
107
+ end
metadata ADDED
@@ -0,0 +1,46 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: zipfyi
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 ZipFYI REST API at zipfyi.com. Zero external dependencies.
14
+ email: dev@fyipedia.com
15
+ executables: []
16
+ extensions: []
17
+ extra_rdoc_files: []
18
+ files:
19
+ - lib/zipfyi.rb
20
+ homepage: https://zipfyi.com
21
+ licenses:
22
+ - MIT
23
+ metadata:
24
+ source_code_uri: https://github.com/fyipedia/zipfyi-rb
25
+ documentation_uri: https://zipfyi.com/api/v1/schema/
26
+ homepage_uri: https://zipfyi.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 ZipFYI API
46
+ test_files: []