cymon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77bd6c902511b5e0f0510c62a7d8c141e7f479fe917ac2eff6ca31dccc4f4b65
+  data.tar.gz: 8a142b42d3e544586bdb1654736fc84ea20b106692176b209504f8c166ca7435
+SHA512:
+  metadata.gz: b0de1ba4ba6f3932301e85d57d11e40d4db9a26a532ffac4ca6a9453ec8f1f1565972e02283f3a8853812a6523cad9679f831ba436da5122bb2ef5bdd43ea329
+  data.tar.gz: c61fbf5662e10a5ca0bfd3e508a8038efc351fb13f4155e58d6542b0bed8e00d9f279046ad25ee6dc241c8b7389e604f003bc7b09cc7f57ffdef566cb26961f7

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,39 @@
+# Configurations: http://rubocop.readthedocs.io/en/latest/configuration/#configuration
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Documentation:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20
+
+TrailingBlankLines:
+  Enabled: false
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+CaseIndentation:
+  # Valid values are: case, end
+  EnforcedStyle: case
+  IndentOneStep: true
+
+#Metrics/CyclomaticComplexity:
+#  Severity: warning

data/.ruby-gemset

@@ -0,0 +1 @@
+cymon

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.0

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+  - 2.4.2
+before_install: gem install bundler -v 1.16.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 falegk1@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cymon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Antony Falegkos
+
+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,66 @@
+# Cymon
+
+A Ruby client gem for [Cymon.io](https://cymon.io) API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cymon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cymon
+
+## Usage
+
+```
+# Init a client
+client = Cymon.client
+
+# /search endpoint
+# Seach By IP
+resp = client.search.by_ip('209.90.88.140')
+resp.status
+    => 200
+resp.body
+    => {"total"=>14, "from"=>0, "size"=>10, "hits"=>[{...}, {...}]}
+
+```
+
+## Current Endpoints
+
+| Plugin | README |
+| ------ | ------ |
+| **Search** | http://docs.cymon.io/#search |
+| .by_ip | http://docs.cymon.io/#search-search-by-ip-get |
+| .by_domain | http://docs.cymon.io/#search-search-by-domain-get |
+| .by_hostname | http://docs.cymon.io/#search-search-by-hostname-get |
+| .by_md5 | http://docs.cymon.io/#search-search-by-md5-get |
+| .by_sha1 | http://docs.cymon.io/#search-search-by-sha1-get |
+| .by_sha256 | http://docs.cymon.io/#search-search-by-sha256-get |
+| .by_term | http://docs.cymon.io/#search-search-by-term-get |
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `rake console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+[Report issues / feature requests](https://github.com/falegk/cymon/issues) and [pull requests](https://github.com/falegk/cymon/pulls) are welcome.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+# Run `rake console` for test
+task :console do
+  exec "irb -r cymon -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cymon"
+
+# 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/cymon.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cymon/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cymon"
+  spec.version       = Cymon::VERSION
+  spec.authors       = ["Antony Falegkos"]
+  spec.email         = ["falegk1@gmail.com"]
+
+  spec.summary       = %q{A Ruby client gem for cymon.io API}
+  spec.description   = %q{Cymon is the largest open tracker of malware, phishing, botnets, spam, and more. Brought to you by eSentire.}
+  spec.homepage      = "https://github.com/falegk/cymon"
+  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('..', __FILE__)) 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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'vcr', '~> 4.0', '>= 4.0.0'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.15', '>= 0.15.2'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.12', '>= 0.12.2'
+end

data/exe/cymon

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "cymon"

data/lib/cymon.rb

@@ -0,0 +1,8 @@
+require 'cymon/version'
+require 'cymon/client'
+
+module Cymon
+  def self.client(options = {})
+    @client ||= Cymon::Client.new(options)
+  end
+end

data/lib/cymon/client.rb

@@ -0,0 +1,52 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'cymon/configuration'
+require 'cymon/endpoint/base'
+require 'cymon/endpoint/search'
+
+module Cymon
+  class Client
+
+    ENDPOINTS = [:search].freeze
+
+    attr_reader :configuration
+
+    attr_accessor *ENDPOINTS
+
+    def initialize(options = nil)
+      @configuration = Configuration.new(options)
+      define_endpoint_methods
+    end
+
+    def api_connection(url = nil)
+      url ||= "https://api.cymon.io"
+
+      Faraday.new(url: url) do |faraday|
+        faraday.response :logger
+        faraday.request :json
+        faraday.ssl.verify = false
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.options.timeout = @configuration.timeout # open/read timeout in seconds
+        faraday.adapter Faraday.default_adapter
+
+        # TODO; Implementation for authenticated users http://docs.cymon.io/#header-authentication
+        # faraday.use :http_cache, store: Rails.cache
+        # faraday.authorization :Bearer, FOUNDATION_AUTH_KEY
+        # faraday.headers['Authorization']
+      end
+    end
+
+    private
+
+    def define_endpoint_methods
+      namespace = "Cymon::Endpoint"
+
+      ENDPOINTS.each do |endpoint|
+        endpoint_klass = Object.const_get("#{namespace}::#{endpoint.to_s.capitalize}")
+        klass = endpoint_klass.new(self)
+        send("#{endpoint.to_s}=", klass)
+      end
+    end
+  end
+end

data/lib/cymon/configuration.rb

@@ -0,0 +1,24 @@
+module Cymon
+  class Configuration
+    attr_accessor :api_version, :timeout
+
+    def initialize(options = nil)
+      options = options ? default_options.merge(options) : default_options
+
+      return unless options.is_a?(Hash)
+
+      options.each do |config_name, config_value|
+        send("#{config_name}=", config_value)
+      end
+    end
+
+    private
+
+    def default_options
+      {
+          api_version: 'v2',
+          timeout: 60
+      }
+    end
+  end
+end

data/lib/cymon/endpoint/base.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+require 'cymon/responses/base'
+
+module Cymon
+  module Endpoint
+    class Base
+      attr_accessor :client
+      attr_accessor :api, :api_version_path
+
+      def initialize(client)
+        @client = client
+        @api = @client.api_connection
+
+        @api_version_path = @client.configuration.api_version
+      end
+    end
+  end
+end

data/lib/cymon/endpoint/search.rb

@@ -0,0 +1,91 @@
+require 'cymon/responses/base'
+require 'cymon/responses/search'
+
+module Cymon
+  module Endpoint
+    class Search < Base
+      PATH = 'ioc/search'
+
+      def url_path
+        "#{api_version_path}/#{PATH}"
+      end
+
+      # Search threat reports by IP address (IPv4 and IPv6).
+      # http://docs.cymon.io/#search-search-by-ip-get
+      #
+      # @param value [String] The query value to search for. Example: 209.90.88.140.
+      # @param params [Hash]
+      #   +startDate+ The start date for searching. Example: 2017-03-25
+      #   +endDate+ The end date for searching. Example: 2017-03-29
+      #   +from+ The offset to use for pagination. Example: 0
+      #   +size+ The limit to use for pagination. Example: 3
+      def by_ip(value, params = {})
+        params = default_params(params)
+        response = @api.get("#{url_path}/ip/#{value}", params)
+        Cymon::Responses::Search.new(response)
+      end
+
+      # Search threat reports by domain name.
+      # http://docs.cymon.io/#search-search-by-domain-get
+      def by_domain(value, params = {})
+        params = default_params(params)
+        response = @api.get("#{url_path}/domain/#{value}", params)
+        Cymon::Responses::Search.new(response)
+      end
+
+      # Search threat reports by hostname.
+      # http://docs.cymon.io/#search-search-by-hostname-get
+      def by_hostname(value, params = {})
+        params = default_params(params)
+        response = @api.get("#{url_path}/hostname/#{value}", params)
+        Cymon::Responses::Search.new(response)
+      end
+
+      # Search threat reports by md5.
+      # http://docs.cymon.io/#search-search-by-md5-get
+      def by_md5(value, params = {})
+        params = default_params(params)
+        response = @api.get("#{url_path}/md5/#{value}", params)
+        Cymon::Responses::Search.new(response)
+      end
+
+      # Search threat reports by sha1.
+      # http://docs.cymon.io/#search-search-by-sha1-get
+      def by_sha1(value, params = {})
+        params = default_params(params)
+        response = @api.get("#{url_path}/sha1/#{value}", params)
+        Cymon::Responses::Search.new(response)
+      end
+
+      # Search threat reports by sha256.
+      # http://docs.cymon.io/#search-search-by-sha256-get
+      def by_sha256(value, params = {})
+        params = default_params(params)
+        response = @api.get("#{url_path}/sha256/#{value}", params)
+        Cymon::Responses::Search.new(response)
+      end
+
+      # Search threat reports by term.
+      # http://docs.cymon.io/#search-search-by-term-get
+      def by_term(value, params = {})
+        params = default_params(params)
+        response = @api.get("#{url_path}/term/#{value}", params)
+        Cymon::Responses::Search.new(response)
+      end
+
+      # Search threat reports by feed.
+      # http://docs.cymon.io/#search-search-by-feed-get
+      def by_feed(value, params = {})
+        params = default_params(params)
+        response = @api.get("#{url_path}/feed/#{value}", params)
+        Cymon::Responses::Search.new(response)
+      end
+
+      private
+
+      def default_params(params)
+        params.slice(:from, :size, :startDate, :endDate)
+      end
+    end
+  end
+end

data/lib/cymon/responses/base.rb

@@ -0,0 +1,18 @@
+require 'json'
+
+module Cymon
+  module Responses
+    class Base
+
+      attr_accessor :body, :status
+      attr_accessor :raw_response
+
+      # @param response Faraday::Response
+      def initialize(response)
+        @raw_response = response
+        @body = JSON.parse(response.body)
+        @status = response.status
+      end
+    end
+  end
+end

data/lib/cymon/responses/search.rb

@@ -0,0 +1,7 @@
+module Cymon
+  module Responses
+    class Search < Base
+
+    end
+  end
+end

data/lib/cymon/version.rb

@@ -0,0 +1,3 @@
+module Cymon
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: cymon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Antony Falegkos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: Cymon is the largest open tracker of malware, phishing, botnets, spam,
+  and more. Brought to you by eSentire.
+email:
+- falegk1@gmail.com
+executables:
+- cymon
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cymon.gemspec
+- exe/cymon
+- lib/cymon.rb
+- lib/cymon/client.rb
+- lib/cymon/configuration.rb
+- lib/cymon/endpoint/base.rb
+- lib/cymon/endpoint/search.rb
+- lib/cymon/responses/base.rb
+- lib/cymon/responses/search.rb
+- lib/cymon/version.rb
+homepage: https://github.com/falegk/cymon
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A Ruby client gem for cymon.io API
+test_files: []