Initial commit.

BrunoBernardino · BrunoBernardino · commit 87dc18b6330c · 2025-03-11T16:01:22.000Z
diff --git a/.env.sample b/.env.sample
@@ -0,0 +1 @@
+TEST_KEY_CODE="your-test-key-code-here"
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,5 @@
+github: [BrunoBernardino]
+custom: [
+  'https://paypal.me/brunobernardino',
+  'https://gist.github.com/BrunoBernardino/ff5b54c13dd96ac7f9fee6fbfd825b09',
+]
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,17 @@
+name: Run Tests
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '.ruby-version'
+      - env:
+          TEST_KEY_CODE: ${{ secrets.TEST_KEY_CODE }}
+        run: |
+          make install
+          make test
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.env
+*.gem
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,22 @@
+plugins: rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MethodLength:
+  Enabled: false
+
+RSpec/Metrics/AbcSize:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  Enabled: false  
+
+Style/Documentation:
+  Enabled: false
diff --git a/.ruby-version b/.ruby-version
@@ -0,0 +1 @@
+3.4.2
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'json', '~> 2.10', require: true
+gem 'net-http', '~> 0.6.0', require: true
+gem 'uri', '~> 1.0', require: true
+
+gem 'rspec', '~> 3.13', require: false
+gem 'rubocop', '~> 1.73', require: false
+gem 'rubocop-rspec', '~> 3.5', require: false
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -0,0 +1,66 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.6.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    net-http (0.6.0)
+      uri
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.73.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.1)
+      parser (>= 3.3.1.0)
+    rubocop-rspec (3.5.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  json (~> 2.10)
+  net-http (~> 0.6.0)
+  rspec (~> 3.13)
+  rubocop (~> 1.73)
+  rubocop-rspec (~> 3.5)
+  uri (~> 1.0)
+
+BUNDLED WITH
+   2.6.2
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,9 @@
+ISC License
+
+Copyright (c) 2025 Safelyx
+
+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.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,22 @@
+.PHONY: install
+install:
+	bundle install
+
+.PHONY: format
+format:
+	bundle exec rubocop -A
+
+.PHONY: test
+test:
+	bundle exec rubocop
+	bundle exec rspec
+
+.PHONY: build
+build:
+	gem build safelyx.gemspec
+
+.PHONY: publish
+publish:
+	gem build safelyx.gemspec
+	gem push safelyx-0.*.gem
+	rm safelyx-0.*.gem
diff --git a/README.md b/README.md
@@ -0,0 +1,52 @@
+# Safelyx API
+
+[![](https://github.com/safelyx/safelyx-ruby/workflows/Run%20Tests/badge.svg)](https://github.com/safelyx/safelyx-ruby/actions?workflow=Run+Tests) [![pypi](https://badge.fury.io/rb/safelyx.svg)](https://rubygems.org/gems/safelyx)
+
+> Safelyx API client
+
+Safelyx API client for Ruby. It has no dependencies.
+
+You can find the API documentation at https://safelyx.com/safe-api.
+
+### Some things to note:
+
+1. It's simply making an HTTP request to the Safelyx API.
+
+2. It provides types for the results and for the parameters.
+
+## Usage
+
+It has a method per API endpoint.
+
+```bash
+gem install safelyx
+```
+
+```ruby
+require 'safelyx'
+
+client = Safelyx::Client.new('your-key-code')
+
+result = client.check_link('https://example.com')
+
+puts result[:result] # Outputs a safety score between 0 (unsafe) and 10 (safe). -1 if there was an error, -2 if there are no checks remaining.
+```
+
+## Development
+
+Requires `ruby`.
+
+```bash
+make install
+make format
+make test
+make build
+```
+
+## Publishing
+
+After committing and pushing with a new version in `safelyx.gemspec`, just run:
+
+```bash
+make publish
+```
diff --git a/safelyx.gemspec b/safelyx.gemspec
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name        = 'safelyx'
+  spec.version     = '0.1.0'
+  spec.summary     = 'Safelyx API SDK'
+  spec.description = 'Safelyx API SDK for Ruby'
+  spec.authors     = ['Safelyx']
+  spec.email       = 'help@safelyx.com'
+  spec.files       = ['safelyx.rb']
+
+  github_link = 'https://github.com/safelyx/safelyx-ruby'
+
+  spec.homepage    = github_link
+  spec.license     = 'ISC'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata = {
+    'bug_tracker_uri' => "#{github_link}/issues",
+    'changelog_uri' => "#{github_link}/releases",
+    'documentation_uri' => 'https://safelyx.com/safe-api',
+    'homepage_uri' => spec.homepage,
+    'source_code_uri' => github_link,
+    'rubygems_mfa_required' => 'true'
+  }
+end
diff --git a/safelyx.rb b/safelyx.rb
@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+
+module Safelyx
+  class Client
+    def initialize(key_code = nil)
+      @key_code = key_code
+      @http_timeout = 10
+    end
+
+    def check_link(link)
+      payload = {
+        link: link,
+        key_code: @key_code
+      }
+
+      make_request('https://safelyx.com/safe-link-checker', payload)
+    end
+
+    def check_email(email)
+      payload = {
+        email: email,
+        key_code: @key_code
+      }
+
+      make_request('https://safelyx.com/safe-email-checker', payload)
+    end
+
+    def check_message(message, skip_link_and_email_checks: false)
+      payload = {
+        message: message,
+        skip_link_and_email_checks: skip_link_and_email_checks,
+        key_code: @key_code
+      }
+
+      make_request('https://safelyx.com/safe-message-checker', payload)
+    end
+
+    def check_image(image_url)
+      payload = {
+        image_url: image_url,
+        key_code: @key_code
+      }
+
+      make_request('https://safelyx.com/safe-image-checker', payload)
+    end
+
+    private
+
+    def make_request(url, payload)
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      http.read_timeout = @http_timeout
+
+      request = Net::HTTP::Post.new(uri)
+      request['Content-Type'] = 'application/json; charset=utf-8'
+      request['Accept'] = 'application/json; charset=utf-8'
+      request.body = payload.to_json
+
+      response = http.request(request)
+      JSON.parse(response.body, symbolize_names: true)
+    rescue StandardError => e
+      raise "Request failed: #{e.message}"
+    end
+  end
+end
diff --git a/safelyx_spec.rb b/safelyx_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+TEST_KEY_CODE="your-test-key-code-here"`