numlookupapi 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 +61 -0
  3. metadata +77 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 0bd74d82be4a66eec8df79e563a83b8d8f4a63cd8a012ced62afb0767fb9f065
4
+ data.tar.gz: 82cb56a4f9c7fd2511ed00067a3c9cc5914f9d09aeba2a189d1de628f3b7d393
5
+ SHA512:
6
+ metadata.gz: 91f058d009df979b37db5dcc9602362a9f41bc0578b2f6dd017f3ff192e5185cad9f496a567bc6c193bffa3abebd5dd8a5f78068406c67aade34cb89a6c7d891
7
+ data.tar.gz: 1143464e01bb86c4d82c98ca9a3b4188bd4784ef292dcb2baf2c2e141f622998982ae94dbbb8f38632a1c70124d9b975d77a65c4b1d393f1b34caa8d21c52a58
data/README.md ADDED
@@ -0,0 +1,61 @@
1
+ <p align="center">
2
+ <img src="https://app.numlookupapi.com/img/logo/numlookupapi.png" width="300"/>
3
+ </p>
4
+
5
+ # numlookupapi-ruby
6
+
7
+ numlookupapi-ruby is the official Ruby Wrapper around the [numlookupapi](https://app.numlookupapi.com) API.
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ gem 'numlookupapi'
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install numlookupapi
22
+
23
+ ## Configuration
24
+
25
+ You will need your apikey to use numlookupapi, you can get one [https://app.numlookupapi.com/register](https://app.numlookupapi.com/register).
26
+
27
+ Create an instance and pass your api key like here:
28
+
29
+ numlookup = numlookupapi::Endpoints.new(:apikey => 'APIKEY')
30
+
31
+ ## Usage & Endpoints
32
+
33
+ Use the instance to call the endpoints
34
+
35
+ #### Status
36
+ Returns your current quota
37
+
38
+ numlookup.status()
39
+
40
+ #### Info
41
+ Checks the provided ip address (both v4 & v6 formats) and returns all available information.
42
+
43
+ numlookup.info(ip, language)
44
+
45
+ | Parameter | Data type | Mandatory | Description |
46
+ | --- | ----------- | --- | ----------- |
47
+ | ip | string, Path Parameter | yes | The ip address you want to query |
48
+ | language | string | no | An ISO Alpha 2 Language Code for localising the ip data |
49
+
50
+
51
+ You can find further information on https://numlookupapi.com/docs/
52
+
53
+ Bug reports and pull requests are welcome on GitHub at https://github.com/everapihq/numlookupapi-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/everapihq/numlookupapi-ruby/blob/master/CODE_OF_CONDUCT.md).
54
+
55
+ ## License
56
+
57
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
58
+
59
+ ## Code of Conduct
60
+
61
+ Everyone interacting in the numlookupapi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/everapihq/numlookupapi-ruby/blob/master/CODE_OF_CONDUCT.md).
metadata ADDED
@@ -0,0 +1,77 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: numlookupapi
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Clemens Ehrenreich
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2023-04-05 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: numlookupapi.com provides a worldwide phone number lookup & verification
42
+ API. Automate your phone number verification process by checking carrier information
43
+ with our free and worldwide phone number lookup API.
44
+ email:
45
+ - office@everapi.com
46
+ executables: []
47
+ extensions: []
48
+ extra_rdoc_files:
49
+ - README.md
50
+ files:
51
+ - README.md
52
+ homepage: https://numlookupapi.com/
53
+ licenses:
54
+ - MIT
55
+ metadata:
56
+ homepage_uri: https://numlookupapi.com/
57
+ source_code_uri: https://github.com/everapihq/numlookupapi-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.4.7
74
+ signing_key:
75
+ specification_version: 4
76
+ summary: A ruby wrapper for numlookupapi.com's API
77
+ test_files: []