Niklick

Versioned API solution template for hipsters!

• Version 2.6.1.

Prerequisites

• Ruby 2.3.1 and +
• Rails 5 and +
• RVM
• PostgreSQL

Ruby Gems

• Pg - Ruby interface to the PostgreSQL RDBMS
• Foreman - Manage Procfile-based applications
• devisetokenauth - Token based authentication for Rails JSON APIs. Designed to work with jToker and ng-token-auth
• GraphQL - Ruby implementation of GraphQL
• delayedjobactive_record - ActiveRecord backend integration for DelayedJob 3.0+
• Better errors - Better error page for Rack apps
• RSpec - RSpec for Rails-3+
• Factory Girl Rails - Factory Girl ♥ Rails
• Shoulda - Collection of testing matchers extracted from Shoulda
• Database cleaner - Strategies for cleaning databases in Ruby. Can be used to ensure a clean state for testing
• Faker - A library for generating fake data such as names, addresses, and phone numbers
• Rack attack - Rack middleware for blocking & throttling
• Pry Rails - Rails >= 3 pry initializer
• Bundler audit - Patch-level verification for Bundler
• Rubocop - A Ruby static code analyzer
• LogAnalyzer - Rails logs analyzer (see how fast your views are rendering)
• Bcrypt - bcrypt-ruby is a Ruby binding for the OpenBSD bcrypt() password hashing algorithm, allowing you to easily store a secure hash of your users’ passwords
• Fasterer - Make your Rubies go faster with this command line tool highly inspired by fast-ruby and Sferik’s talk at Baruco Conf
• Reek - Code smell detector for Ruby
• Brakeman - A static analysis security vulnerability scanner for Ruby on Rails applications
• railsbestpractices - A code metric tool for rails projects

Project Setup

• For production, you need to replace the asterisk with the URL of your client-side application in ./config/application.rb file.

1. Clone or download this repo
2. Run bundle install
3. Run rake db:create
4. Run bin/rails db:migrate RAILS_ENV=development
5. Run bin/rails db:seed RAILS_ENV=development
6. Run foreman start
7. Visit –> http://localhost:5000/. That’s it!.

Directory Structure (Main folders and files)

.
├── app                         # Rails application - controllers, models, etc.
├── /bin                        # Folder for Rake, bundle, spring setup, etc.
├── /config                     # Rails app configuration - database, app, environment, etc.
├── /db                         # Database setup - migrate, seeds, schema
├── /lib                        # Lib folder
├── /log/                       # Log folder
├── /spec/                      # Tests for the Rails app
├── /test/                      # Unit and integration tests for the Rails app
├── /tmp/                       # TMP folder - sockets, cache, etc.
├── /vendor/                    # Vendor assets
│── .fasterer.yml               # Fasterer config file
│── .gitigonre                  # Gitignore file
│── .gqlconfig                  # GraphQl config file
│── .rspec                      # Tests file
│── .rubocop.yml                # Rubocop config file
│── .ruby-version               # Ruby version file
│── config.reek                 # Reek config file
│── config.ru                   # Config file for Rails app
│── Gemfile                     # File for all Ruby gems
│── Gemfile.lock                # File with Gemfile lock
│── license                     # License file
│── Procfile                    # Foreman file with script for start server
│── Rakefile                    # File for rake tasks

Backend Side Development

1. Run foreman start.
2. And visit http://localhost:5000/.

GraphQL API playground

• Open http://localhost:5000/graphiql and play with GraphQL.

Sending emails

• In app/mailers/user_notifier_mailer.rb is method for sending emails.
• In app/views/User_notifier/send_signup_email.html.erb is html template for emails.
• In config/environment.rb is ActionMailer settings to point to SendGrid’s servers.
• You can modify all files and use it in controller with UserNotifier.send_signup_email(@user).deliver or you can use Job for sending emails with SendEmailJob.set(wait: 20.seconds).perform_later(@user).

Jobs (for production environment)

You can start jobs with bundle exec rake jobs:work.

Code analyzer, linter, bundle audit and tools

• Run rubocop for Ruby lint.
• Run rubocop -a for fixed some issues automatically.
• Run reek . for analyzing code.
• Run fasterer for code analyzer.
• Run bundle audit for audito your bundle.
• Run brakeman for static analysis and for security vulnerabilities.
• Run rails_best_practices . in root app directory. Helps to find unused methods, missing indexes into database tables and many other things.

Pry initializer

Avoid repeating yourself, use pry-rails instead of copying the initializer to every rails project. * Run rails console and in Rails console: * For showing models –> show-models. * For showing routes –> show-routes.

Test API with Postman

* headers: "accept: application/json; version=1", "access-token: v9S2milc1aEcx4hhIGupbg", "client: LCYog4PFg_PN_eCVWyQtYw", "expiry: 1515865278", "uid: your@email.com"
* method: POST

#
# POSTS
#
# Get all Posts
* url: `http://localhost:5000/api/v1/graphql?query={allPosts{title, subtitle, description}}`

# Get specific Post
* url: `http://localhost:5000/api/v1/graphql?query={post(id:2){id,title, subtitle, description}}`

# Create Post
* url: `http://localhost:5000/api/v1/graphql?query=mutation{createPost(title: "Deadly Weapon 4", subtitle: "Deadly Weapon 3", description: "Even deadlier!", content: "Even deadlier!"){id, errors}}`  

# Update Post  
* url: `http://localhost:5000/api/v1/graphql?query=mutation{updatePost(id: 46, title: "Deadly Weapon 55", subtitle: "Deadly Weapon 33", description: "Even deadlier!", content: "Even deadlier!"){id}}`

# Delete Post
* url: `http://localhost:5000/api/v1/graphql?query=mutation{deletePost(id:17){id}}`

#
# USERS
#
# Get all Users
* url: `http://localhost:5000/api/v1/graphql?query={allUsers{id,email,posts{id, title}, errors}}`

# Get specific User
* url: `http://localhost:5000/api/v1/graphql?query={user(id:1){id,email,posts{id, title}, errors}}`