zoomeye-rb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fb0000a0778a5f22bfa139290c2d117c514548da3a3399d8c9dbd8f5255ad7d
+  data.tar.gz: 6571f7f69a6898a28a509603c262d2de56cfd4513aa3484e2eedf63037341c2e
+SHA512:
+  metadata.gz: e63100f48bcd4cf82d86e6538c6f0d54d7bfd5e6ba622374cdd4baaa7a62c7e90b9d7c1f9477d6689b3433bb1bbb11babd92d23953cf0b5ed9eb4489b4518e1c
+  data.tar.gz: fd724c156cf3c0d6d19fee2bc9a5aee426ce2634b4af2c224cbbc6dd22896e313a4ba18e2c908a17db5d83b3ccb093b9a3940ddce971744fe3a9df8135a20142

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zoomeye.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Manabu Niseki
+
+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,44 @@
+# zoomeye-rb
+
+[![Build Status](https://travis-ci.com/ninoseki/zoomeye-rb.svg?branch=master)](https://travis-ci.com/ninoseki/zoomeye-rb)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/zoomeye-rb/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/zoomeye-rb?branch=master)
+[![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/zoomeye-rb/badge)](https://www.codefactor.io/repository/github/ninoseki/zoomeye-rb)
+
+[ZoomEye](https://www.zoomeye.org/) API wrapper for Ruby.
+
+## Installation
+
+```bash
+gem install zoomeye
+```
+
+## Usage
+
+```ruby
+require "zoomeye"
+
+# when given nothing, it tries to load your usernamem & password via ENV["ZOOMEYE_USERNAME"] and ENV["ZOOMEYE_PASSWORD"]
+api = ZoomEye::API.new
+
+# or you can set them manually
+api = ZoomEye::API.new(username: "USERNAME", password: "PASSWORD")
+
+# Host search
+api.host.search("port:80 nginx")
+api.host.search("port:80 nginx", page: 7, facets: "app,device")
+
+# Web search
+api.web.search("wordpress")
+api.web.search("wordpress", page: 1, facets: "app.os")
+
+# Resource info
+api.resource_info.get
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ninoseki/zoomeye-rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "zoomeye"
+
+# 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/zoomeye.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "zoomeye/version"
+
+require "zoomeye/clients/base"
+
+require "zoomeye/clients/host"
+require "zoomeye/clients/resource_info"
+require "zoomeye/clients/user"
+require "zoomeye/clients/web"
+
+require "zoomeye/api"
+
+module ZoomEye
+  class Error < StandardError; end
+end

data/lib/zoomeye/api.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ZoomEye
+  class API
+    def initialize(username: ENV["ZOOMEYE_USERNAME"], password: ENV["ZOOMEYE_PASSWORD"])
+      @username = username
+      raise ArgumentError, "No usernamme has been found or provided!" unless @username
+
+      @password = password
+      raise ArgumentError, "No password has been found or provided!" unless @password
+    end
+
+    def user
+      @user ||= Clients::User.new(username: @username, password: @password)
+    end
+
+    def web
+      @web ||= Clients::Web.new(access_token: access_token)
+    end
+
+    def host
+      @host ||= Clients::Host.new(access_token: access_token)
+    end
+
+    def resource_info
+      @resource_info ||= Clients::ResourceInfo.new(access_token: access_token)
+    end
+
+    private
+
+    def access_token
+      @access_token ||= user.access_token
+    end
+  end
+end

data/lib/zoomeye/clients/base.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/https"
+require "uri"
+
+module ZoomEye
+  module Clients
+    class Base
+      HOST = "api.zoomeye.org"
+      BASE_URL = "https://#{HOST}"
+
+      def initialize(username: nil, password: nil, access_token: nil)
+        @username = username
+        @password = password
+        @access_token = access_token
+      end
+
+      private
+
+      def url_for(path)
+        URI(BASE_URL + path)
+      end
+
+      def https_options
+        if proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"]
+          uri = URI(proxy)
+          {
+            proxy_address: uri.hostname,
+            proxy_port: uri.port,
+            proxy_from_env: false,
+            use_ssl: true
+          }
+        else
+          { use_ssl: true }
+        end
+      end
+
+      def make_request(req)
+        Net::HTTP.start(HOST, 443, https_options) do |http|
+          response = http.request(req)
+
+          code = response.code.to_i
+          body = response.body
+          json = JSON.parse(body)
+
+          case code
+          when 200
+            yield json
+          else
+            error = json.dig("message") || body
+            raise Error, "Unsupported response code returned: #{code} - #{error}"
+          end
+        end
+      end
+
+      def token_headers
+        {
+          Authorization: "JWT #{@access_token}"
+        }
+      end
+
+      def build_request(type: "GET", path:, params: {})
+        uri = url_for(path)
+        uri.query = URI.encode_www_form(params) if type == "GET"
+
+        headers = path == "/user/login" ? {} : token_headers
+
+        request = case type
+                  when "GET"
+                    Net::HTTP::Get.new(uri, headers)
+                  when "POST"
+                    Net::HTTP::Post.new(uri, headers)
+                  else
+                    raise ArgumentError, "#{type} HTTP method is not supported"
+                  end
+
+        request.body = JSON.generate(params) unless type == "GET"
+
+        request
+      end
+
+      def _get(path, params = {}, &block)
+        request = build_request(type: "GET", path: path, params: params)
+        make_request(request, &block)
+      end
+
+      def _post(path, params = {}, &block)
+        request = build_request(type: "POST", path: path, params: params)
+        make_request(request, &block)
+      end
+    end
+  end
+end

data/lib/zoomeye/clients/host.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ZoomEye
+  module Clients
+    class Host < Base
+      #
+      # Search the Host devices
+      #
+      # @param [String] query Query string
+      # @param [Integer, nil] page The page number to paging(default:1)
+      # @param [String, nil] facets A comma-separated list of properties to get summary information on query
+      #
+      # @return [Hash]
+      #
+      def search(query, page: nil, facets: nil)
+        params = {
+          query: query,
+          page: page,
+          facets: facets
+        }.compact
+
+        _get("/host/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/zoomeye/clients/resource_info.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ZoomEye
+  module Clients
+    class ResourceInfo < Base
+      #
+      # Resources info for account
+      #
+      # @return [Hash]
+      #
+      def get
+        _get("/resources-info") { |json| json }
+      end
+    end
+  end
+end

data/lib/zoomeye/clients/user.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ZoomEye
+  module Clients
+    class User < Base
+      def access_token
+        _post("/user/login", username: @username, password: @password) { |json| json.dig("access_token") }
+      end
+    end
+  end
+end

data/lib/zoomeye/clients/web.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ZoomEye
+  module Clients
+    class Web < Base
+      #
+      # Search the Web technologies
+      #
+      # @param [String] query Query string
+      # @param [Integer, nil] page The page number to paging(default:1)
+      # @param [String, nil] facets A comma-separated list of properties to get summary information on query
+      #
+      # @return [Hash]
+      #
+      def search(query, page: nil, facets: nil)
+        params = {
+          query: query,
+          page: page,
+          facets: facets
+        }.compact
+
+        _get("/web/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/zoomeye/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ZoomEye
+  VERSION = "0.1.1"
+end

data/zoomeye.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zoomeye/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zoomeye-rb"
+  spec.version       = ZoomEye::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "ZoomEye API wrapper for Ruby"
+  spec.description   = "ZoomEye API wrapper for Ruby"
+  spec.homepage      = "https://github.com/ninoseki/zoomeye-rb"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.7"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: zoomeye-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: ZoomEye API wrapper for Ruby
+email:
+- manabu.niseki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zoomeye.rb
+- lib/zoomeye/api.rb
+- lib/zoomeye/clients/base.rb
+- lib/zoomeye/clients/host.rb
+- lib/zoomeye/clients/resource_info.rb
+- lib/zoomeye/clients/user.rb
+- lib/zoomeye/clients/web.rb
+- lib/zoomeye/version.rb
+- zoomeye.gemspec
+homepage: https://github.com/ninoseki/zoomeye-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: ZoomEye API wrapper for Ruby
+test_files: []