Initial commit

.codeclimate.yml

@@ -0,0 +1,59 @@
+version: '2'
+checks:
+  argument-count:
+    enabled: true
+    config:
+      threshold: 4
+  complex-logic:
+    enabled: true
+    config:
+      threshold: 4
+  file-lines:
+    enabled: true
+    config:
+      threshold: 250
+  method-complexity:
+    enabled: true
+    config:
+      threshold: 5
+  method-count:
+    enabled: true
+    config:
+      threshold: 20
+  method-lines:
+    enabled: true
+    config:
+      threshold: 25
+  nested-control-flow:
+    enabled: true
+    config:
+      threshold: 4
+  return-statements:
+    enabled: true
+    config:
+      threshold: 4
+  similar-code:
+    enabled: true
+    config:
+      threshold: #language-specific defaults. overrides affect all languages.
+  identical-code:
+    enabled: true
+    config:
+      threshold: #language-specific defaults. overrides affect all languages.
+plugins:
+  bundler-audit:
+    enabled: true
+  csslint:
+    enabled: true
+  duplication:
+    enabled: true
+    exclude_patterns:
+      - spec/**/*
+  flog:
+    enabled: true
+    exclude_patterns:
+      - db/**/*
+      - config/**/*
+      - spec/**/*
+exclude_patterns:
+  - 'babel.config.js'

.dockerignore

@@ -0,0 +1,35 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all default key files
+config/master.key
+config/credentials/*.key
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+/public/assets
+
+# Ignore node_modules
+/node_modules
+
+# Ignore .env files
+!.env.test
+.env*

.env.sample

@@ -0,0 +1,10 @@
+AWS_ACCESS_KEY_ID=
+AWS_BUCKET_REGION=
+AWS_SECRET_ACCESS_KEY=
+DOCKER_ENABLED=false
+NEW_RELIC_API_KEY=api_key
+NEW_RELIC_APP_NAME='rails_api_base - development'
+PASSWORD_RESET_URL=http://127.0.0.1:3000
+SENDGRID_API_KEY=
+SERVER_HOST=localhost
+S3_BUCKET_NAME=

.env.test

@@ -0,0 +1,2 @@
+SERVER_HOST=localhost
+PASSWORD_RESET_URL=/

.github/CODEOWNERS

@@ -0,0 +1,51 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+
+# *       @global-owner1 @global-owner2   (remove # at beginning of line to make it work)
+
+
+# Order is important; the last matching pattern takes the most
+# precedence. When someone opens a pull request that only
+# modifies JS files, only @js-owner and not the global
+# owner(s) will be requested for a review.
+
+# *.js    @js-owner                       (remove # at beginning of line to make it work)
+
+
+# You can also use email addresses if you prefer. They'll be
+# used to look up users just like we do for commit author
+# emails.
+
+# *.go    [email protected]                (remove # at beginning of line to make it work)
+
+
+# In this example, @doctocat owns any files in the build/logs
+# directory at the root of the repository and any of its
+# subdirectories.
+
+# /build/logs/ @doctocat                  (remove # at beginning of line to make it work)
+
+
+# The `docs/*` pattern will match files like
+# `docs/getting-started.md` but not further nested files like
+# `docs/build-app/troubleshooting.md`.
+
+# docs/*  [email protected]                (remove # at beginning of line to make it work)
+
+
+# In this example, @octocat owns any file in an apps directory
+# anywhere in your repository.
+
+# apps/   @octocat                        (remove # at beginning of line to make it work)
+
+
+# In this example, @doctocat owns any file in the `/docs`
+# directory in the root of your repository.
+
+# /docs/  @doctocat                       (remove # at beginning of line to make it work)

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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/

.github/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing
+
+1. Fork the project
+2. Setup in your machine following the [guide](https://github.com/rootstrap/rails_api_base#how-to-use)
+3. Make your change. Add tests for your change when necessary.
+4. Make sure the tests pass with `rspec`
+5. Push to your fork and [create a pull request](https://help.github.com/articles/creating-a-pull-request/)
+
+## Releases
+
+We release new versions of Rails Api Base when it is convenient, we follow [semver](http://semver.org/). When ready to release:
+
+1. Make sure that tests are green.
+2. Update the changelog with [Github Changelog Generator](https://github.com/skywinder/github-changelog-generator)
+3. Tag the release by running git tag v<version>. Push the tag: git push --tags. Or use the Github UI

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,8 @@
+When posting issues, please include the following information to speed up the troubleshooting process:
+
+* **Version**: which version of this repo do you have?
+* **Ruby Version**: which version of ruby do you have?
+* **Environment**: in which env is happening?
+* **Rails Stacktrace**: this can be found in the `log/development.log` or `log/test.log`, if this is applicable.
+
+Use labels to categorize it and thanks for posting the issue!

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug] "
+labels: bug
+assignees: ''
+
+---
+
+## Bug report:
+* **Expected Behavior**: 
+* **Actual Behavior**: 
+* **Steps to Reproduce**: 
+  1.
+  2.
+  3.
+
+* **Version of the repo**:
+* **Ruby and Rails Version**: 
+* **Rails Stacktrace**: this can be found in the `log/development.log` or `log/test.log`, if this is applicable.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,31 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]"
+labels: enhancement
+assignees: ''
+
+---
+
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '[FEATURE]'
+labels: enhancement
+assignees: ''
+
+---
+<!-- Please note by far the quickest way to get a new feature is to file a Pull Request.
+We will consider your request but it may be closed if it's something we're not actively planning to work on. -->
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+#### Board:
+* [Ticket #NUMBER_OF_THE_TICKET](link_goes_here)
+---
+#### Description:
+<!-- * Add a description of what is the aim of this PR -->
+---
+#### Notes:
+*
+---
+#### Tasks:
+- [x] Add each element in this format
+---
+#### Risk:
+*
+---
+#### Preview:

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"