brvs 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.editorconfig +14 -0
- data/.github/FUNDING.yml +1 -0
- data/.github/ISSUE_TEMPLATE/bug_report.md +24 -0
- data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
- data/.github/PULL_REQUEST_TEMPLATE.md +28 -0
- data/.github/dependabot.yml +17 -0
- data/.github/workflows/verify.yml +74 -0
- data/.gitignore +16 -0
- data/.rspec +3 -0
- data/.rubocop.yml +22 -0
- data/CHANGELOG.md +18 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/CONTRIBUTING.md +3 -0
- data/Gemfile +17 -0
- data/Gemfile.lock +107 -0
- data/LICENSE.txt +21 -0
- data/README.md +57 -0
- data/Rakefile +8 -0
- data/bin/console +8 -0
- data/bin/setup +6 -0
- data/brvs.gemspec +27 -0
- data/lib/brvs.rb +7 -0
- data/lib/brvs/version.rb +5 -0
- metadata +70 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8c40973affced4bc02d3c85eaecf98b4bf998218e2eae75146c8a46100cd6bcf
|
4
|
+
data.tar.gz: 1fd790de9a49f5f494623d07b75d3c7fcc1537cc061e0b1428030fcc93542cfc
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 215b1f71223fbfcd2e5d8ab9bb8682656893f4ffbf75d2495950074fc0cafca12021c8a5422a27bbd51570b7a9342453e2a0ef07ac4957c3810f01cc2eddd0ae
|
7
|
+
data.tar.gz: b8eb9a4d1d71f7da54df21ba7f8f76d6641729063e8a8e7992d4046460e592d08c86ed9cec65cd9cb41f6319208c6d2a91870d9ee9ec49eaf1486d68fe62e58a
|
data/.editorconfig
ADDED
data/.github/FUNDING.yml
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
ko_fi: craftyphotons
|
@@ -0,0 +1,24 @@
|
|
1
|
+
---
|
2
|
+
name: Bug report
|
3
|
+
about: Create a report to help us improve
|
4
|
+
title: ''
|
5
|
+
labels: bug
|
6
|
+
assignees: ''
|
7
|
+
|
8
|
+
---
|
9
|
+
|
10
|
+
**Describe the bug**
|
11
|
+
A clear and concise description of what the bug is.
|
12
|
+
|
13
|
+
**To Reproduce**
|
14
|
+
Steps to reproduce the behavior:
|
15
|
+
1. Go to '...'
|
16
|
+
2. Click on '....'
|
17
|
+
3. Scroll down to '....'
|
18
|
+
4. See error
|
19
|
+
|
20
|
+
**Expected behavior**
|
21
|
+
A clear and concise description of what you expected to happen.
|
22
|
+
|
23
|
+
**Additional context**
|
24
|
+
Add any other context about the problem here.
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
name: Feature request
|
3
|
+
about: Suggest an idea for this project
|
4
|
+
title: ''
|
5
|
+
labels: enhancement
|
6
|
+
assignees: ''
|
7
|
+
|
8
|
+
---
|
9
|
+
|
10
|
+
**Is your feature request related to a problem? Please describe.**
|
11
|
+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
12
|
+
|
13
|
+
**Describe the solution you'd like**
|
14
|
+
A clear and concise description of what you want to happen.
|
15
|
+
|
16
|
+
**Describe alternatives you've considered**
|
17
|
+
A clear and concise description of any alternative solutions or features you've considered.
|
18
|
+
|
19
|
+
**Additional context**
|
20
|
+
Add any other context or screenshots about the feature request here.
|
@@ -0,0 +1,28 @@
|
|
1
|
+
**Pull Request template**
|
2
|
+
|
3
|
+
Please, go through these steps before you submit a PR.
|
4
|
+
|
5
|
+
1. Make sure that your PR is not a duplicate.
|
6
|
+
2. If not, then make sure that:
|
7
|
+
|
8
|
+
a. You have done your changes in a separate branch. Branches MUST have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/some-issue` or `feature/issue-templates`.
|
9
|
+
|
10
|
+
b. You have a descriptive commit message with a short title (first line).
|
11
|
+
|
12
|
+
c. You have only one commit (if not, squash them into one commit).
|
13
|
+
|
14
|
+
d. `bundle exec rspec` doesn't throw any errors. If it does, fix them first and amend your commit (`git commit --amend`).
|
15
|
+
|
16
|
+
e. `bundle exec rubocop` doesn't throw any errors. If it does, fix them first and amend your commit (`git commit --amend`).
|
17
|
+
|
18
|
+
3. **After** these steps, you're ready to open a pull request.
|
19
|
+
|
20
|
+
a. Give a descriptive title to your PR.
|
21
|
+
|
22
|
+
b. Provide a description of your changes.
|
23
|
+
|
24
|
+
c. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
|
25
|
+
|
26
|
+
IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
|
27
|
+
|
28
|
+
**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**
|
@@ -0,0 +1,17 @@
|
|
1
|
+
version: 2
|
2
|
+
updates:
|
3
|
+
- package-ecosystem: "github-actions"
|
4
|
+
directory: "/"
|
5
|
+
schedule:
|
6
|
+
interval: "weekly"
|
7
|
+
commit-message:
|
8
|
+
prefix: "chore"
|
9
|
+
include: "scope"
|
10
|
+
|
11
|
+
- package-ecosystem: "bundler"
|
12
|
+
directory: "/"
|
13
|
+
schedule:
|
14
|
+
interval: "daily"
|
15
|
+
commit-message:
|
16
|
+
prefix: "chore"
|
17
|
+
include: "scope"
|
@@ -0,0 +1,74 @@
|
|
1
|
+
name: Verify
|
2
|
+
on: [push, pull_request]
|
3
|
+
|
4
|
+
jobs:
|
5
|
+
lint:
|
6
|
+
name: Lint (Ruby ${{ matrix.ruby }})
|
7
|
+
runs-on: ubuntu-latest
|
8
|
+
strategy:
|
9
|
+
matrix:
|
10
|
+
ruby: ['2.5', '2.6', '2.7']
|
11
|
+
steps:
|
12
|
+
- name: Checkout code
|
13
|
+
uses: actions/checkout@v2
|
14
|
+
|
15
|
+
- name: Set up Ruby
|
16
|
+
uses: ruby/setup-ruby@v1
|
17
|
+
with:
|
18
|
+
ruby-version: ${{ matrix.ruby }}
|
19
|
+
|
20
|
+
- name: Ruby gem cache
|
21
|
+
uses: actions/cache@v2.1.0
|
22
|
+
with:
|
23
|
+
path: vendor/bundle
|
24
|
+
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
|
25
|
+
restore-keys: |
|
26
|
+
${{ runner.os }}-gems-
|
27
|
+
|
28
|
+
- name: Install gems
|
29
|
+
run: |
|
30
|
+
bundle config path vendor/bundle
|
31
|
+
bundle install --jobs 4 --retry 3
|
32
|
+
|
33
|
+
- name: Run linters
|
34
|
+
run: |
|
35
|
+
bundle exec rubocop --parallel
|
36
|
+
|
37
|
+
- name: Run security checks
|
38
|
+
run: |
|
39
|
+
bundle exec bundler-audit --update
|
40
|
+
|
41
|
+
test:
|
42
|
+
name: Test (Ruby ${{ matrix.ruby }})
|
43
|
+
runs-on: ubuntu-latest
|
44
|
+
strategy:
|
45
|
+
matrix:
|
46
|
+
ruby: ['2.5', '2.6', '2.7']
|
47
|
+
steps:
|
48
|
+
- name: Checkout code
|
49
|
+
uses: actions/checkout@v2
|
50
|
+
|
51
|
+
- name: Set up Ruby
|
52
|
+
uses: ruby/setup-ruby@v1
|
53
|
+
with:
|
54
|
+
ruby-version: ${{ matrix.ruby }}
|
55
|
+
|
56
|
+
- name: Ruby gem cache
|
57
|
+
uses: actions/cache@v2.1.0
|
58
|
+
with:
|
59
|
+
path: vendor/bundle
|
60
|
+
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
|
61
|
+
restore-keys: |
|
62
|
+
${{ runner.os }}-gems-
|
63
|
+
|
64
|
+
- name: Install gems
|
65
|
+
run: |
|
66
|
+
bundle config path vendor/bundle
|
67
|
+
bundle install --jobs 4 --retry 3
|
68
|
+
|
69
|
+
- name: Run tests
|
70
|
+
env:
|
71
|
+
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
|
72
|
+
RAILS_ENV: test
|
73
|
+
run: |
|
74
|
+
bundle exec rspec
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.rubocop.yml
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
#inherit_from: .rubocop_todo.yml
|
2
|
+
|
3
|
+
require:
|
4
|
+
- rubocop-performance
|
5
|
+
- rubocop-rspec
|
6
|
+
|
7
|
+
AllCops:
|
8
|
+
NewCops: enable
|
9
|
+
Exclude:
|
10
|
+
- vendor/**/*
|
11
|
+
TargetRubyVersion: 2.5
|
12
|
+
|
13
|
+
Metrics/BlockLength:
|
14
|
+
Exclude:
|
15
|
+
- spec/**/*.rb
|
16
|
+
|
17
|
+
RSpec/ExampleLength:
|
18
|
+
Enabled: false
|
19
|
+
|
20
|
+
RSpec/FilePath:
|
21
|
+
CustomTransform:
|
22
|
+
IndieAuthDiscovery: indieauth_discovery
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# Brvs Changelog
|
2
|
+
|
3
|
+
All notable changes to this project will be documented in this file.
|
4
|
+
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
6
|
+
|
7
|
+
## [Unreleased]
|
8
|
+
|
9
|
+
## [0.1.0]
|
10
|
+
|
11
|
+
Initial release! :tada:
|
12
|
+
|
13
|
+
### Added
|
14
|
+
|
15
|
+
* Gem skeleton
|
16
|
+
|
17
|
+
[Unreleased]: https://github.com/craftyphotons/brvs-ruby/compare/v0.1.0...HEAD
|
18
|
+
[0.1.0]: https://github.com/craftyphotons/brvs-ruby/releases/tag/v0.1.0
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at tony@tonyburns.net. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,3 @@
|
|
1
|
+
## Contributing to `brvs-ruby`
|
2
|
+
|
3
|
+
Bug reports and pull requests are welcome on GitHub at [craftyphotons/brvs-ruby](https://github.com/craftyphotons/brvs-ruby). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/craftyphotons/brvs-ruby/blob/main/CODE_OF_CONDUCT.md).
|
data/Gemfile
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
source 'https://rubygems.org'
|
4
|
+
|
5
|
+
gemspec
|
6
|
+
|
7
|
+
gem 'bundler-audit', '~> 0.7'
|
8
|
+
gem 'byebug', '~> 11.1'
|
9
|
+
gem 'coveralls', '~> 0.8'
|
10
|
+
gem 'pry', '~> 0.13'
|
11
|
+
gem 'rake', '~> 13.0'
|
12
|
+
gem 'rspec', '~> 3.9'
|
13
|
+
gem 'rubocop', '~> 0.89'
|
14
|
+
gem 'rubocop-performance', '~> 1.7'
|
15
|
+
gem 'rubocop-rspec', '~> 1.42'
|
16
|
+
gem 'webmock', '~> 3.8'
|
17
|
+
gem 'yard', '~> 0.9'
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,107 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
brvs (0.1.0)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
addressable (2.7.0)
|
10
|
+
public_suffix (>= 2.0.2, < 5.0)
|
11
|
+
ast (2.4.1)
|
12
|
+
bundler-audit (0.7.0.1)
|
13
|
+
bundler (>= 1.2.0, < 3)
|
14
|
+
thor (>= 0.18, < 2)
|
15
|
+
byebug (11.1.3)
|
16
|
+
coderay (1.1.3)
|
17
|
+
coveralls (0.8.23)
|
18
|
+
json (>= 1.8, < 3)
|
19
|
+
simplecov (~> 0.16.1)
|
20
|
+
term-ansicolor (~> 1.3)
|
21
|
+
thor (>= 0.19.4, < 2.0)
|
22
|
+
tins (~> 1.6)
|
23
|
+
crack (0.4.3)
|
24
|
+
safe_yaml (~> 1.0.0)
|
25
|
+
diff-lcs (1.4.4)
|
26
|
+
docile (1.3.2)
|
27
|
+
hashdiff (1.0.1)
|
28
|
+
json (2.3.1)
|
29
|
+
method_source (1.0.0)
|
30
|
+
parallel (1.19.2)
|
31
|
+
parser (2.7.1.4)
|
32
|
+
ast (~> 2.4.1)
|
33
|
+
pry (0.13.1)
|
34
|
+
coderay (~> 1.1)
|
35
|
+
method_source (~> 1.0)
|
36
|
+
public_suffix (4.0.5)
|
37
|
+
rainbow (3.0.0)
|
38
|
+
rake (13.0.1)
|
39
|
+
regexp_parser (1.7.1)
|
40
|
+
rexml (3.2.4)
|
41
|
+
rspec (3.9.0)
|
42
|
+
rspec-core (~> 3.9.0)
|
43
|
+
rspec-expectations (~> 3.9.0)
|
44
|
+
rspec-mocks (~> 3.9.0)
|
45
|
+
rspec-core (3.9.2)
|
46
|
+
rspec-support (~> 3.9.3)
|
47
|
+
rspec-expectations (3.9.2)
|
48
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
49
|
+
rspec-support (~> 3.9.0)
|
50
|
+
rspec-mocks (3.9.1)
|
51
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
52
|
+
rspec-support (~> 3.9.0)
|
53
|
+
rspec-support (3.9.3)
|
54
|
+
rubocop (0.89.1)
|
55
|
+
parallel (~> 1.10)
|
56
|
+
parser (>= 2.7.1.1)
|
57
|
+
rainbow (>= 2.2.2, < 4.0)
|
58
|
+
regexp_parser (>= 1.7)
|
59
|
+
rexml
|
60
|
+
rubocop-ast (>= 0.3.0, < 1.0)
|
61
|
+
ruby-progressbar (~> 1.7)
|
62
|
+
unicode-display_width (>= 1.4.0, < 2.0)
|
63
|
+
rubocop-ast (0.3.0)
|
64
|
+
parser (>= 2.7.1.4)
|
65
|
+
rubocop-performance (1.7.1)
|
66
|
+
rubocop (>= 0.82.0)
|
67
|
+
rubocop-rspec (1.42.0)
|
68
|
+
rubocop (>= 0.87.0)
|
69
|
+
ruby-progressbar (1.10.1)
|
70
|
+
safe_yaml (1.0.5)
|
71
|
+
simplecov (0.16.1)
|
72
|
+
docile (~> 1.1)
|
73
|
+
json (>= 1.8, < 3)
|
74
|
+
simplecov-html (~> 0.10.0)
|
75
|
+
simplecov-html (0.10.2)
|
76
|
+
sync (0.5.0)
|
77
|
+
term-ansicolor (1.7.1)
|
78
|
+
tins (~> 1.0)
|
79
|
+
thor (1.0.1)
|
80
|
+
tins (1.25.0)
|
81
|
+
sync
|
82
|
+
unicode-display_width (1.7.0)
|
83
|
+
webmock (3.8.3)
|
84
|
+
addressable (>= 2.3.6)
|
85
|
+
crack (>= 0.3.2)
|
86
|
+
hashdiff (>= 0.4.0, < 2.0.0)
|
87
|
+
yard (0.9.25)
|
88
|
+
|
89
|
+
PLATFORMS
|
90
|
+
ruby
|
91
|
+
|
92
|
+
DEPENDENCIES
|
93
|
+
brvs!
|
94
|
+
bundler-audit (~> 0.7)
|
95
|
+
byebug (~> 11.1)
|
96
|
+
coveralls (~> 0.8)
|
97
|
+
pry (~> 0.13)
|
98
|
+
rake (~> 13.0)
|
99
|
+
rspec (~> 3.9)
|
100
|
+
rubocop (~> 0.89)
|
101
|
+
rubocop-performance (~> 1.7)
|
102
|
+
rubocop-rspec (~> 1.42)
|
103
|
+
webmock (~> 3.8)
|
104
|
+
yard (~> 0.9)
|
105
|
+
|
106
|
+
BUNDLED WITH
|
107
|
+
2.1.4
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2020 Tony Burns
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,57 @@
|
|
1
|
+
# `brvs-ruby`
|
2
|
+
|
3
|
+
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/craftyphotons/brvs-ruby/Verify/main?style=for-the-badge)](https://github.com/craftyphotons/brvs-ruby/actions?query=workflow%3AVerify)
|
4
|
+
|
5
|
+
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/craftyphotons/brvs-ruby?style=for-the-badge)](https://codeclimate.com/github/craftyphotons/brvs-ruby)
|
6
|
+
|
7
|
+
[![Coveralls github branch](https://img.shields.io/coveralls/github/craftyphotons/brvs-ruby/main?style=for-the-badge)](https://coveralls.io/github/craftyphotons/brvs-ruby)
|
8
|
+
|
9
|
+
[![Gem](https://img.shields.io/gem/v/brvs-ruby?style=for-the-badge)](https://rubygems.org/gems/brvs-ruby)
|
10
|
+
|
11
|
+
Ruby client library for [Brvs](https://github.com/craftyphotons/brvs), an open source URL shortener and branded link management application.
|
12
|
+
|
13
|
+
## Features
|
14
|
+
|
15
|
+
_TBD_
|
16
|
+
|
17
|
+
## Roadmap
|
18
|
+
|
19
|
+
_TBD_
|
20
|
+
|
21
|
+
## Installation
|
22
|
+
|
23
|
+
Add this line to your application's `Gemfile`:
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
gem 'brvs'
|
27
|
+
```
|
28
|
+
|
29
|
+
And then execute:
|
30
|
+
|
31
|
+
$ bundle install
|
32
|
+
|
33
|
+
Or install it yourself as:
|
34
|
+
|
35
|
+
$ gem install brvs
|
36
|
+
|
37
|
+
## Usage
|
38
|
+
|
39
|
+
_TBD_
|
40
|
+
|
41
|
+
## Development
|
42
|
+
|
43
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
44
|
+
|
45
|
+
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](https://rubygems.org).
|
46
|
+
|
47
|
+
## Contributing
|
48
|
+
|
49
|
+
Bug reports and pull requests are welcome on GitHub at [craftyphotons/brvs-ruby](https://github.com/craftyphotons/brvs-ruby). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/craftyphotons/brvs-ruby/blob/main/CODE_OF_CONDUCT.md).
|
50
|
+
|
51
|
+
## License
|
52
|
+
|
53
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
54
|
+
|
55
|
+
## Code of Conduct
|
56
|
+
|
57
|
+
Everyone interacting in the IndieauthDiscovery project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/craftyphotons/brvs-ruby/blob/main/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
data/bin/setup
ADDED
data/brvs.gemspec
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative 'lib/brvs/version'
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = 'brvs'
|
7
|
+
spec.version = Brvs::VERSION
|
8
|
+
spec.authors = ['Tony Burns']
|
9
|
+
spec.email = ['tony@tonyburns.net']
|
10
|
+
|
11
|
+
spec.summary = 'Client library for Brvs'
|
12
|
+
spec.description = 'Client library for Brvs, an open source URL shortener and branded link management application'
|
13
|
+
spec.homepage = 'https://github.com/craftyphotons/brvs-ruby'
|
14
|
+
spec.license = 'MIT'
|
15
|
+
spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
|
16
|
+
|
17
|
+
spec.metadata['homepage_uri'] = spec.homepage
|
18
|
+
spec.metadata['source_code_uri'] = 'https://github.com/craftyphotons/brvs-ruby'
|
19
|
+
spec.metadata['changelog_uri'] = 'https://github.com/craftyphotons/brvs-ruby/blob/main/CHANGELOG.md'
|
20
|
+
|
21
|
+
spec.files = Dir.chdir(File.expand_path(__dir__)) do
|
22
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
|
23
|
+
end
|
24
|
+
spec.bindir = 'exe'
|
25
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
26
|
+
spec.require_paths = ['lib']
|
27
|
+
end
|
data/lib/brvs.rb
ADDED
data/lib/brvs/version.rb
ADDED
metadata
ADDED
@@ -0,0 +1,70 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: brvs
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Tony Burns
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-08-14 00:00:00.000000000 Z
|
12
|
+
dependencies: []
|
13
|
+
description: Client library for Brvs, an open source URL shortener and branded link
|
14
|
+
management application
|
15
|
+
email:
|
16
|
+
- tony@tonyburns.net
|
17
|
+
executables: []
|
18
|
+
extensions: []
|
19
|
+
extra_rdoc_files: []
|
20
|
+
files:
|
21
|
+
- ".editorconfig"
|
22
|
+
- ".github/FUNDING.yml"
|
23
|
+
- ".github/ISSUE_TEMPLATE/bug_report.md"
|
24
|
+
- ".github/ISSUE_TEMPLATE/feature_request.md"
|
25
|
+
- ".github/PULL_REQUEST_TEMPLATE.md"
|
26
|
+
- ".github/dependabot.yml"
|
27
|
+
- ".github/workflows/verify.yml"
|
28
|
+
- ".gitignore"
|
29
|
+
- ".rspec"
|
30
|
+
- ".rubocop.yml"
|
31
|
+
- CHANGELOG.md
|
32
|
+
- CODE_OF_CONDUCT.md
|
33
|
+
- CONTRIBUTING.md
|
34
|
+
- Gemfile
|
35
|
+
- Gemfile.lock
|
36
|
+
- LICENSE.txt
|
37
|
+
- README.md
|
38
|
+
- Rakefile
|
39
|
+
- bin/console
|
40
|
+
- bin/setup
|
41
|
+
- brvs.gemspec
|
42
|
+
- lib/brvs.rb
|
43
|
+
- lib/brvs/version.rb
|
44
|
+
homepage: https://github.com/craftyphotons/brvs-ruby
|
45
|
+
licenses:
|
46
|
+
- MIT
|
47
|
+
metadata:
|
48
|
+
homepage_uri: https://github.com/craftyphotons/brvs-ruby
|
49
|
+
source_code_uri: https://github.com/craftyphotons/brvs-ruby
|
50
|
+
changelog_uri: https://github.com/craftyphotons/brvs-ruby/blob/main/CHANGELOG.md
|
51
|
+
post_install_message:
|
52
|
+
rdoc_options: []
|
53
|
+
require_paths:
|
54
|
+
- lib
|
55
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
56
|
+
requirements:
|
57
|
+
- - ">="
|
58
|
+
- !ruby/object:Gem::Version
|
59
|
+
version: 2.3.0
|
60
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
61
|
+
requirements:
|
62
|
+
- - ">="
|
63
|
+
- !ruby/object:Gem::Version
|
64
|
+
version: '0'
|
65
|
+
requirements: []
|
66
|
+
rubygems_version: 3.1.2
|
67
|
+
signing_key:
|
68
|
+
specification_version: 4
|
69
|
+
summary: Client library for Brvs
|
70
|
+
test_files: []
|