whois_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c20fd2512ad19fa719a87c44dc6244cc24b2e0258fb1367ec02dfdcc78e181a6
+  data.tar.gz: 74748b0956817b926652646293e4858d9c3a9d44cb646f11faa726c968ad4273
+SHA512:
+  metadata.gz: '079fa6173a6bcd3d58014290b59dd2571959dc27dd818131acf2b1a45acd182cd5d261a73e958cf1d5b1a886ce3a39d78b6bbc0d1af298944d7336ed6ebf8798'
+  data.tar.gz: cf28e642b45055c555cfcd1bb808be0c0ffb8f5e38d74a37b9bfd8b51dcca4854091a0649f4277a4ecbc7f7c754524355b65861c3ab2d122226cbfa8e1b11995

data/.bumpversion.cfg

@@ -0,0 +1,15 @@
+[bumpversion]
+current_version = 0.1.0
+commit = True
+
+[bumpversion:file:README.md]
+search = whois_rb --version "{current_version}"
+replace = whois_rb --version "{new_version}"
+
+[bumpversion:file:lib/whois_rb/version.rb]
+search = VERSION = "{current_version}"
+replace = VERSION = "{new_version}"
+
+[bumpversion:file:Gemfile.lock]
+search = whois_rb ({current_version})
+replace = whois_rb ({new_version})

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hello@promptapi.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in whois_rb.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    whois_rb (0.1.0)
+      faraday (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    minitest (5.14.2)
+    multipart-post (2.1.1)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  whois_rb!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Prompt API
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+![Ruby](https://img.shields.io/badge/ruby-2.7.0-green.svg)
+[![Gem Version](https://badge.fury.io/rb/whois_rb.svg)](https://badge.fury.io/rb/whois_rb)
+[![Build Status](https://travis-ci.org/promptapi/whois_rb.svg?branch=main)](https://travis-ci.org/promptapi/whois_rb)
+
+# Prompt API - Whois API - Ruby Package
+
+`whois_rb` is a simple ruby wrapper for [whois-api][whois-api].
+
+## Requirements
+
+1. You need to signup for [Prompt API][promptapi-signup]
+1. You need to subscribe [whois-api][whois-api], test drive is **free!!!**
+1. You need to set `PROMPTAPI_TOKEN` environment variable after subscription.
+
+then;
+
+```bash
+$ gem install whois_rb
+```
+
+or; install from GitHub:
+
+```bash
+$ gem install whois_rb --version "0.1.0" --source "https://rubygems.pkg.github.com/promptapi"
+```
+
+---
+
+## Example Usage
+
+Check domain examples:
+
+```ruby
+require 'whois_rb'
+
+result = WhoisRb::check('promptapi.com')
+# => {:result=>"registered"}
+
+result = WhoisRb::check('promptapi.com', timeout=20)
+# => {:result=>"registered"}
+
+result = WhoisRb::check('foo')
+# => {:error=>"Not a valid domain name"}
+
+result = WhoisRb::check('promptapi123456.com')
+# => {:result=>"available"}
+```
+
+Query domain examples:
+
+```ruby
+require 'whois_rb'
+
+result = WhoisRb::query('foo')
+# => {:error=>"Not a valid domain name"}
+
+result = WhoisRb::query('promptapi.com')
+# => {
+    :result=>{
+        :domain_name=>"PROMPTAPI.COM", 
+        :registrar=>"NameCheap, Inc.", 
+        :whois_server=>"whois.namecheap.com", 
+        :referral_url=>nil, 
+        :updated_date=>"2020-05-27 22:19:36", 
+        :creation_date=>"2020-04-19 15:11:52", 
+        :expiration_date=>"2021-04-19 15:11:52", 
+        :name_servers=>["APOLLO.NS.CLOUDFLARE.COM", "MARJORY.NS.CLOUDFLARE.COM"], 
+        :status=>"clientTransferProhibited https://icann.org/epp#clientTransferProhibited", 
+        :emails=>"abuse@namecheap.com", 
+        :dnssec=>"unsigned", 
+        :name=>nil, 
+        :org=>nil, 
+        :address=>nil, 
+        :city=>nil, 
+        :state=>nil, 
+        :zipcode=>nil, 
+        :country=>nil
+    }
+}
+
+result = WhoisRb::query('promptapi1234.com')
+# => {:error=>"No match for promptapi1234.com"}
+```
+
+---
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake test` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org][rubygems]
+
+```bash
+$ rake -T
+
+rake build            # Build whois_rb-0.0.0.gem into the pkg directory
+rake bump[revision]   # Bump version
+rake clean            # Remove any temporary products
+rake clobber          # Remove any generated files
+rake install          # Build and install whois_rb-0.0.0.gem into system gems
+rake install:local    # Build and install whois_rb-0.0.0.gem into system gems without network access
+rake push_to_github   # Push whois_rb-0.0.0.gem to GitHub registry
+rake release[remote]  # Create tag v0.0.0 and build and push whois_rb-0.0.0.gem to rubygems.org
+rake test             # Run tests
+```
+
+---
+
+## License
+
+This project is licensed under MIT
+
+---
+
+## Contributer(s)
+
+* [Prompt API](https://github.com/promptapi) - Creator, maintainer
+
+---
+
+## Contribute
+
+Bug reports and pull requests are welcome on GitHub:
+
+1. `fork` (https://github.com/promptapi/whois_rb/fork)
+1. Create your `branch` (`git checkout -b my-feature`)
+1. `commit` yours (`git commit -am 'Add awesome features...'`)
+1. `push` your `branch` (`git push origin my-feature`)
+1. Than create a new **Pull Request**!
+
+This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct][coc].
+
+---
+
+[whois-api]:        https://promptapi.com/marketplace/description/whois-api
+[promptapi-signup]: https://promptapi.com/#signup-form
+[coc]:              https://github.com/promptapi/whois_rb/blob/main/CODE_OF_CONDUCT.md
+[rubygems]:         https://rubygems.org

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+AVAILABLE_REVISIONS = ["major", "minor", "patch"]
+desc "Bump version"
+task :bump, [:revision] do |t, args|
+  args.with_defaults(revision: "patch")
+  abort "Please provide valid revision: #{AVAILABLE_REVISIONS.join(',')}" unless AVAILABLE_REVISIONS.include?(args.revision)
+  system "bumpversion #{args.revision}"
+end
+
+def get_package_name
+  name = Dir['*.gemspec'].first.split('.').first
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  version = line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+  "#{name}-#{version}.gem"
+end
+
+desc "Push #{get_package_name} to GitHub registry"
+task :push_to_github do
+  package_path = "pkg/#{get_package_name}"
+  system "gem push --key github --host https://rubygems.pkg.github.com/promptapi #{package_path}"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "whois_rb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/whois_rb.rb

@@ -0,0 +1,16 @@
+require "whois_rb/version"
+require "whois_rb/http"
+
+module WhoisRb
+  class Error < StandardError; end
+
+  class << self
+    def check(domain, timeout=10)
+      WhoisRb::Http.get(domain, timeout)
+    end
+
+    def query(domain, timeout=10)
+      WhoisRb::Http.get(domain, timeout, 'query')
+    end
+  end
+end

data/lib/whois_rb/http.rb

@@ -0,0 +1,50 @@
+require 'faraday'
+require 'json'
+
+module WhoisRb
+  module Http
+    PROMPTAPI_ENDPOINT = 'https://api.promptapi.com/whois'
+
+    class << self
+      def parse(body)
+        begin
+          JSON.parse(body, symbolize_names: true)
+        rescue JSON::ParserError
+          {error: "JSON decoding error"}
+        end
+      end
+      
+      def get(domain, timeout, url_suffix='check')
+        options = {
+          url: "#{PROMPTAPI_ENDPOINT}/#{url_suffix}",
+          params: {domain: domain},
+          request: {timeout: timeout},
+          headers: {
+            'Accept' => 'application/json',
+            'apikey' => ENV['PROMPTAPI_TOKEN'] || nil,
+          },
+        }
+        unless options[:headers]['apikey']
+          return {error: "You need to set PROMPTAPI_TOKEN environment variable"}
+        end
+        
+        conn = Faraday.new(options) do |c|
+          c.use Faraday::Response::RaiseError
+        end
+        
+        begin
+          response = conn.get
+          return self.parse(response.body)
+        rescue Faraday::ConnectionFailed
+          return {error: "Connection error"}
+        rescue Faraday::TimeoutError => e
+          return {error: e.message.capitalize}
+        rescue Faraday::ClientError => e
+          return {error: parse(e.response[:body])[:message].capitalize}
+        rescue Faraday::ServerError => e
+          return {error: e.message.capitalize}
+        end
+      end
+    end
+  end
+end

data/lib/whois_rb/version.rb

@@ -0,0 +1,3 @@
+module WhoisRb
+  VERSION = "0.1.0"
+end

data/whois_rb.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/whois_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whois_rb"
+  spec.version       = WhoisRb::VERSION
+  spec.authors       = ["Prompt API"]
+  spec.email         = ["hello@promptapi.com"]
+
+  spec.summary       = %q{Ruby wrapper for Prompt API's Whois API}
+  spec.homepage      = "https://github.com/promptapi/whois_rb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/promptapi/whois_rb"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: whois_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Prompt API
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description:
+email:
+- hello@promptapi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bumpversion.cfg"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/whois_rb.rb
+- lib/whois_rb/http.rb
+- lib/whois_rb/version.rb
+- whois_rb.gemspec
+homepage: https://github.com/promptapi/whois_rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/promptapi/whois_rb
+  source_code_uri: https://github.com/promptapi/whois_rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for Prompt API's Whois API
+test_files: []