iplookupapi 1.0.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/README.md +76 -0
  3. metadata +77 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 72954d2a3fc34137360dd48680c9a91d0a0e8931a40cd90a4f3135acfb625bda
4
+ data.tar.gz: abf5b3838488f3f52fd6543b4951de55c488e9eab0e1c90b0291dd528e002c0f
5
+ SHA512:
6
+ metadata.gz: f8dcb46366ce059ca8d18da33b0e8b31006893f58cfdef441cc4d41b18416d12932f2c684ff39ace475fbacaa37c8415ce8813e24445444a002fc58aafcf4238
7
+ data.tar.gz: 9bd75970b620f97b8aa40f2acae3c66d0febea65d69c0ab9b5c99879457f3572761928c56ab7136fdc240462baac56cd1324cc175e5a2d8a34bcb6f0221ff67c
data/README.md ADDED
@@ -0,0 +1,76 @@
1
+ <p align="center">
2
+ <img src="https://app.iplookupapi.com/img/logo/iplookupapi.png" width="300"/>
3
+ </p>
4
+
5
+ # iplookupapi-ruby
6
+
7
+ iplookupapi-ruby is the official Ruby Wrapper around the [iplookupapi](https://iplookupapi.com) API.
8
+
9
+ Â
10
+
11
+ ## Installation
12
+
13
+ Add this line to your application's Gemfile:
14
+
15
+ gem 'iplookupapi'
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ Or install it yourself as:
22
+
23
+ $ gem install iplookupapi
24
+
25
+ ## Configuration
26
+
27
+ You will need your apikey to use iplookupapi, you can get
28
+ one [https://app.iplookupapi.com/register](https://app.iplookupapi.com/register).
29
+
30
+ Create an instance and pass your api key like here:
31
+
32
+ ip = iplookupapi::Endpoints.new(:apikey => 'APIKEY')
33
+
34
+ ## Usage & Endpoints
35
+
36
+ Use the instance to call the endpoints
37
+
38
+ #### Status
39
+
40
+ Returns your current quota
41
+
42
+ ip.status()
43
+
44
+ #### Info
45
+
46
+ Checks the provided ip address (both v4 & v6 formats) and returns all available information.
47
+
48
+ ip.info(ip, language)
49
+
50
+ | Parameter | Data type | Mandatory | Description |
51
+ -----------| --- | ----------- | --- | ----------- |
52
+ | ip | string, Path Parameter | yes | The ip address you want to query |
53
+ | language | string | no | An ISO Alpha 2 Language Code for localising the ip data |
54
+
55
+ You can find further information on https://iplookupapi.com/docs/
56
+
57
+ ## Contributing
58
+
59
+ 1. Fork it
60
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
61
+ 3. Commit your changes (`git commit -am 'Added some feature'`)
62
+ 4. Push to the branch (`git push origin my-new-feature`)
63
+ 5. Create new Pull Request
64
+
65
+ Bug reports and pull requests are welcome on GitHub at https://github.com/everapihq/iplookupapi-ruby. This project is
66
+ intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
67
+ the [code of conduct](https://github.com/everapihq/iplookupapi-ruby/blob/master/CODE_OF_CONDUCT.md).
68
+
69
+ ## License
70
+
71
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
72
+
73
+ ## Code of Conduct
74
+
75
+ Everyone interacting in the iplookupapi project's codebases, issue trackers, chat rooms and mailing lists is expected to
76
+ follow the [code of conduct](https://github.com/everapihq/iplookupapi-ruby/blob/master/CODE_OF_CONDUCT.md).
metadata ADDED
@@ -0,0 +1,77 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: iplookupapi
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Dominik Kukacka
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2023-06-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rest-client
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: json
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ description: iplookupapi.com provides a reliable & scalable IP lookup API for software
42
+ developers. It uses a database of IP addresses associated with cities and other
43
+ relevant information like time zone, latitude, and longitude.
44
+ email:
45
+ - dominik@everapi.com
46
+ executables: []
47
+ extensions: []
48
+ extra_rdoc_files:
49
+ - README.md
50
+ files:
51
+ - README.md
52
+ homepage: https://iplookupapi.com/
53
+ licenses:
54
+ - MIT
55
+ metadata:
56
+ homepage_uri: https://iplookupapi.com/
57
+ source_code_uri: https://github.com/everapihq/iplookupapi-ruby
58
+ post_install_message:
59
+ rdoc_options: []
60
+ require_paths:
61
+ - lib
62
+ required_ruby_version: !ruby/object:Gem::Requirement
63
+ requirements:
64
+ - - ">="
65
+ - !ruby/object:Gem::Version
66
+ version: 2.6.0
67
+ required_rubygems_version: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - ">="
70
+ - !ruby/object:Gem::Version
71
+ version: '0'
72
+ requirements: []
73
+ rubygems_version: 3.0.3.1
74
+ signing_key:
75
+ specification_version: 4
76
+ summary: A ruby wrapper for iplookupapi.com's API
77
+ test_files: []