Skip to content

Commit

Permalink
[FGTW-1795] Initialize gem (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
arthur-santos-foxbit authored Aug 21, 2024
1 parent 21587f3 commit 4213f03
Show file tree
Hide file tree
Showing 15 changed files with 407 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Tests

on: [push]

jobs:
security_check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Salus Scan
run: docker run --rm -t -v $(pwd):/home/repo coinbase/salus:latest

tests:
runs-on: ubuntu-latest
container:
image: ruby:2.7.6
env:
BUNDLE_JOBS: 3
BUNDLE_RETRY: 3
BUNDLE_PATH: vendor/bundle
RAILS_ENV: test
steps:
- uses: actions/checkout@v3

- name: Which bundler?
run: |
bundle -v
- name: Cache
id: restore-cache
uses: actions/cache@v3
with:
path: vendor/bundle
key: rails-demo-bundle-v2-${{ hashFiles('Gemfile.lock') }}

- name: Bundle Install
run: |
bundle check || bundle install
- name: Rubocop
run: bundle exec rubocop --require rubocop-rspec

- name: Run rspec
run: |
bundle exec rspec spec
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/

# rspec failure tracking
.rspec_status
30 changes: 30 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
require: rubocop-rspec

inherit_gem:
rubocop-github:
- "config/default.yml"
rubocop-rspec:
- "config/default.yml"

Metrics/LineLength:
Max: 120

Documentation:
Enabled: false

Metrics/MethodLength:
Max: 30

Metrics/AbcSize:
Max: 30

RSpec/ExampleLength:
Max: 20

Naming/FileName:
Exclude:
- "lib/lightspark-client.rb"

Metrics/BlockLength:
Exclude:
- "spec/**/*.rb"
5 changes: 5 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# frozen_string_literal: true

source "https://rubygems.org"

gemspec
127 changes: 127 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
PATH
remote: .
specs:
lightspark-client (0.0.1)
typhoeus (~> 1.3)

GEM
remote: https://rubygems.org/
specs:
activesupport (7.1.3.4)
base64
bigdecimal
concurrent-ruby (~> 1.0, >= 1.0.2)
connection_pool (>= 2.2.5)
drb
i18n (>= 1.6, < 2)
minitest (>= 5.1)
mutex_m
tzinfo (~> 2.0)
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
ast (2.4.2)
base64 (0.2.0)
bigdecimal (3.1.8)
byebug (10.0.2)
coderay (1.1.3)
concurrent-ruby (1.3.4)
connection_pool (2.4.1)
crack (1.0.0)
bigdecimal
rexml
diff-lcs (1.5.1)
drb (2.2.1)
ethon (0.16.0)
ffi (>= 1.15.0)
ffi (1.16.3)
hashdiff (1.1.1)
i18n (1.14.5)
concurrent-ruby (~> 1.0)
method_source (1.1.0)
minitest (5.25.1)
mutex_m (0.2.0)
parallel (1.26.3)
parser (3.3.4.2)
ast (~> 2.4.1)
racc
pry (0.14.2)
coderay (~> 1.1)
method_source (~> 1.0)
pry-byebug (3.6.0)
byebug (~> 10.0)
pry (~> 0.10)
public_suffix (5.1.1)
racc (1.8.1)
rack (3.1.7)
rainbow (3.1.1)
rake (12.3.3)
regexp_parser (2.9.2)
rexml (3.3.5)
strscan
rspec (3.13.0)
rspec-core (~> 3.13.0)
rspec-expectations (~> 3.13.0)
rspec-mocks (~> 3.13.0)
rspec-core (3.13.0)
rspec-support (~> 3.13.0)
rspec-expectations (3.13.2)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.13.0)
rspec-mocks (3.13.1)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.13.0)
rspec-support (3.13.1)
rubocop (0.93.1)
parallel (~> 1.10)
parser (>= 2.7.1.5)
rainbow (>= 2.2.2, < 4.0)
regexp_parser (>= 1.8)
rexml
rubocop-ast (>= 0.6.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 1.4.0, < 2.0)
rubocop-ast (1.32.1)
parser (>= 3.3.1.0)
rubocop-github (0.17.0)
rubocop
rubocop-performance
rubocop-rails
rubocop-performance (1.10.2)
rubocop (>= 0.90.0, < 2.0)
rubocop-ast (>= 0.4.0)
rubocop-rails (2.9.1)
activesupport (>= 4.2.0)
rack (>= 1.1)
rubocop (>= 0.90.0, < 2.0)
rubocop-rspec (1.44.1)
rubocop (~> 0.87)
rubocop-ast (>= 0.7.1)
ruby-progressbar (1.13.0)
strscan (3.1.0)
typhoeus (1.4.1)
ethon (>= 0.9.0)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
unicode-display_width (1.8.0)
webmock (3.23.1)
addressable (>= 2.8.0)
crack (>= 0.3.2)
hashdiff (>= 0.4.0, < 2.0.0)

PLATFORMS
ruby

DEPENDENCIES
bundler (~> 1.16)
byebug (~> 10.0)
lightspark-client!
pry-byebug (<= 3.6)
rake (~> 12.3.3)
rspec (~> 3.8)
rubocop (~> 0.53)
rubocop-github (~> 0.10)
rubocop-rspec (~> 1.24)
webmock (~> 3.5)

BUNDLED WITH
2.1.4
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
# lightspark-client
Ruby GEM client to integrate lightspark API

# Installation

Add this line to your application's Gemfile:
```ruby
gem 'lightspark-client', git: '[email protected]:foxbit-group/lightspark-client.git', branch: 'main'
```
7 changes: 7 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# frozen_string_literal: true
require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task default: :spec
15 changes: 15 additions & 0 deletions bin/console
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/usr/bin/env ruby
# frozen_string_literal: true

require "bundler/setup"
require "lightspark/client"

# 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__)
8 changes: 8 additions & 0 deletions bin/setup
Original file line number Diff line number Diff line change
@@ -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
84 changes: 84 additions & 0 deletions docs/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<details open>
<summary>
<b>Feature (descrever funcionalidade e motivação)</b>
</summary>
N/A
</details>

<details open>
<summary>
<b>Bugfix</b>
</summary>

- **Descrição do problema**
N/A

- **Causa do problema**
N/A

- **Solução**
N/A

- **Sustentação da solução**
N/A

</details>

<details open>
<summary>
<b>Changelog</b>
</summary>
N/A
</details>

<details open>
<summary>
<b>Testes</b>
</summary>

- **Sumário**
- [ ] (descrever os testes em checkbox)

- **Observações**
N/A

- **Evidências visuais**
N/A


</details>

<details open>
<summary>
<b>Evidencias visuais :framed_picture:</b>
</summary>
N/A
</details>

<details open>
<summary>
<b>Existe breaking change sendo introduzido?</b>
</summary>

- [ ] Sim (descrever)
- [ ] Não
</details>

<details open>
<summary>
<b>Checklist antes de abrir o PR</b>
</summary>

- [ ] Tags adicionadas
- [ ] Changelog preenchido
- [ ] Code reviewers adicionados
- [ ] Build passando
- [ ] Testado em ambiente de stage
</details>

<details open>
<summary>
<b>Informações adicionais</b>
</summary>
N/A
</details>
6 changes: 6 additions & 0 deletions lib/lightspark-client.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# frozen_string_literal: true

# Dependencies

# Source
require "lightspark-client/version"
5 changes: 5 additions & 0 deletions lib/lightspark-client/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# frozen_string_literal: true

module LightsparkClient
VERSION = "0.0.1"
end
34 changes: 34 additions & 0 deletions lightspark-client.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# frozen_string_literal: true

lib = File.expand_path("lib", __dir__)

$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

require "lightspark-client/version"

Gem::Specification.new do |spec|
spec.name = "lightspark-client"
spec.version = LightsparkClient::VERSION
spec.authors = ["Arthur Ferraz dos Santos"]
spec.email = ["[email protected]"]

spec.summary = "Lightspark Client"
spec.description = "A ruby client to integrate Lightspark API"
spec.homepage = "https://github.com/foxbit-group/lightspark-client"
spec.license = "MIT"

spec.files = Dir["lib/**/*"]
spec.require_paths = ["lib"]

spec.add_dependency "typhoeus", "~> 1.3"

spec.add_development_dependency "bundler", "~> 1.16"
spec.add_development_dependency "byebug", "~> 10.0"
spec.add_development_dependency "pry-byebug", "<= 3.6"
spec.add_development_dependency "rake", "~> 12.3.3"
spec.add_development_dependency "rspec", "~> 3.8"
spec.add_development_dependency "rubocop", "~> 0.53"
spec.add_development_dependency "rubocop-github", "~> 0.10"
spec.add_development_dependency "rubocop-rspec", "~> 1.24"
spec.add_development_dependency "webmock", "~> 3.5"
end
Loading

0 comments on commit 4213f03

Please sign in to comment.