api_pack 1.0.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf4c6bafb046c3e5e2973fffa4d6ef460e97c54c49fc2a53ee97d765068763e0
-  data.tar.gz: 88203c2eaad28463a1280d6d86987b9dd2f8a8d2e46359669a3a381bb90fd3a2
+  metadata.gz: 90690a0d83cc8cc7f5ceea8bac821b5e37a4041c8f86422dcc46e0441ba6e274
+  data.tar.gz: 6a4c83180bd090e1b8e64eec029cbb3074a53b66c37a92de6ab0abba1032704f
 SHA512:
-  metadata.gz: e030fc6456c257babab2f92a1bc026e4df1c8782d7cd1b54279de0352e89404d8e5e0f8fbad82e1811f92905d8ccbf59d361b02fcb4e43b9c6dea6e9ad09fcf8
-  data.tar.gz: 81e97e117806d75a3bffc3c78f341f3fba67fc59d69e7e80510d6d161c3ed6d81eec0286cdfb109e43219bf1ebd49921b4f04321c3e6efa103482b5ce41e3872
+  metadata.gz: 223b02240830989e6f7c16d0e0cea2ae124af88a71ef4c75cf302085803bee46975fe2f7485161cc83aa0824ea80617c4df44e5b7896d65d579c27272cc3f99b
+  data.tar.gz: 32fe39dadf86fe81880657b42e113a80bc23a58da82e962515738fef898856b8b2e2e7e5bf4088cb58a9919a83ab352d7cd4d281e581d3887daae75b86279136

data/.gitignore

@@ -8,6 +8,7 @@
 /tmp/
 Gemfile.lock
 .DS_store
+api_pack-*
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,18 +1,30 @@
-[![Build Status](https://travis-ci.org/Jllima/api_pack.svg?branch=master)](https://travis-ci.org/Jllima/api_pack)
+[![Gem Version](https://badge.fury.io/rb/api_pack.svg)](https://badge.fury.io/rb/api_pack)
+[![Build Status](https://www.travis-ci.com/Jllima/api_pack.svg?branch=master)](https://www.travis-ci.com/Jllima/api_pack)
 [![Coverage Status](https://coveralls.io/repos/github/Jllima/api_pack/badge.svg?branch=master)](https://coveralls.io/github/Jllima/api_pack?branch=master)
 
 # ApiPack
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/api_pack`. To experiment with that code, run `bin/console` for an interactive prompt.
+ApiPack is a set of helpers to Api rails
 
-TODO: Delete this and the text above, and describe your gem
+**This project provides the following helpers**
+
+  - Json Web Token helpers
+  - Json Api especifications
+  - Errors Serializers
+  - Pagination links Serializers
+  - Serializer Adapter (BETA)
+
+## Compatibility
+```
+ruby >= 2.4
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'api_pack'
+gem 'api_pack', '~> 1.1.4' 
 ```
 
 And then execute:
@@ -25,13 +37,174 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### JsonWebToken methods
+- First create file api_pack.rb in initializers in put this code
+```ruby
+Rails.application.config.to_prepare do
+  ApiPack.hmac_secret = 'your_secret_key'
+end
+```  
+- ApiPack::JsonWebToken.encode({ user_id: user.id }) \
+returns a valid token with an expiration time of one day by default
+- To change o expiration call method with parameter exp:
+```ruby
+ApiPack::JsonWebToken.encode({ user_id: user.id, exp: 123 })
+```
+
+Usage in a service authenticate user
+
+ApiPack use gem JWT
+
+```ruby
+class AuthenticateUser
+  def initialize(email, password)
+    @email = email
+    @password = password
+  end
+
+  def call
+    # return token valid
+    ApiPack::JsonWebToken.encode({ user_id: user.id }) if user
+  end
+  
+  private
+
+  attr_accessor :email, :password
+
+  def user
+    user = User.find_by(email: email)
+    return user if user&.authenticate(password)
+
+    # raise AuthenticationError if authenticate fail
+    raise(ApiPack::Errors::Auth::AuthenticationError, 'Invalid credentials')
+  end
+end
+```
+
+- ApiPack::JsonWebToken.decode(http_auth_header)
+
+Usage in a service authorize api request
+
+```ruby
+class AuthorizeApiRequest
+    def initialize(headers: {})
+      @headers = headers
+    end
+
+    def call
+      { user: user }
+    end
+
+    private
+
+    attr_accessor :headers
+
+    def user
+      @user ||= User.find(decoded_auth_token['user_id']) if decoded_auth_token
+    rescue ActiveRecord::RecordNotFound => e
+      # raise InvalidToken if user not found
+      raise ApiPack::Errors::Auth::InvalidToken, ("Invalid token #{e.message}")
+    end
+
+    def decoded_auth_token
+      # decode a token valid
+      @decoded_auth_token ||= ApiPack::JsonWebToken.decode(http_auth_header)
+    end
+
+    def http_auth_header
+      return headers['Authorization'].split(' ').last if headers['Authorization'].present?
+
+      raise(ApiPack::Errors::Auth::MissingToken, 'Missing token')
+    end
+  end
+```
+
+### Errors Serializers
+
+- Errors handled \
+ActiveRecord::RecordNotFound \
+ActionController::ParameterMissing \
+ActiveRecord::RecordInvalid
+
+- ApiPack::Errors::HandleError.new(e).call
+
+create an ExceptionHandler concern and deal with api errors in json api format
+
+```ruby
+module ExceptionHandler
+  extend ActiveSupport::Concern
+
+  included do
+    rescue_from StandardError do |e|
+      result = ApiPack::Errors::HandleError.new(e).call
+      render json: result[:body], status: result[:status]
+    end
+  end
+end
+```
+
+### Serializer Parser Adapter (BETA)
+
+This Parser aims to provide adapters for using serializers like FastJsonApi
+
+Default is FastJsonApi
+
+By convection the serializers should be in
+
+serializers/name_serializer/class_serializer
+
+Ex: serializers/fast_jsonapi/user_serializer.rb
+
+USAGE:
+ - Create initializer serilializer_parser.rb and put this code
+ 
+ 
+```ruby
+ApiPack::Serializer::Parser.adapter = :fast_json_api
+```
+
+ - include ApiPack::ApiHelper in aplication_controler.rb
+
+```ruby
+ class ApplicationController < ActionController::API
+  include ApiPack::ApiHelper
+end
+```
+  - use method serializer_hash to return an hash
+
+```ruby
+def index
+  users = User.all
+
+  render json: serializer_hash(users, :user)
+end
+```
+## Pagination Links
+- pagination_meta_generator \
+  Return an hash with pagination links
+-  Apipack has default per page like 10
+- To change o defaut_per_page create an initializer api_pack and put this code
+
+```ruby
+ApiPack.defaut_per_page = 12
+```
+
+```ruby
+def index
+  # current_page mtehod default is 1
+  # per_page method default is 10
+  users = User.page(current_page).per_page(per_page)
+
+  options = pagination_meta_generator(request, users.total_pages)
+
+  render json: serializer_hash(users, :user, opt: options)
+end
+```
 
-## Development
+## This example project uses gem api_apck
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+https://github.com/Jllima/api_pack_rails
 
-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).
 
 ## Contributing
 

data/lib/api_pack.rb

@@ -1,6 +1,7 @@
 require 'jwt'
 require 'fast_jsonapi'
 require 'api_pack/version'
+require 'api_pack/api_helper'
 require 'api_pack/json_web_token'
 require 'api_pack/pagination_meta_generator'
 require 'api_pack/errors/auth'
@@ -9,25 +10,29 @@ require 'api_pack/errors/handle_error'
 require 'api_pack/errors/api_errors_serializer'
 require 'api_pack/errors/validation_error_serializer'
 require 'api_pack/errors/validation_errors_serializer'
-require 'api_pack/constants'
-require 'api_pack/support/api_helper'
+require 'api_pack/support/helper'
 require 'api_pack/serializer/parser'
 
 module ApiPack
   module_function
 
-  PER_PAGE = 10
-  # 24 hours from now
-  DEFAULT_EXP = (Time.now + 1 * 86_400).to_i
-
-  attr_writer :default_per_page, :exp
+  DEFAULT_PAGE = 1
+  DEFAULT_PER_PAGE = 5
+  
+  def default_per_page=(value)
+    @default_per_page = value
+  end
 
   def default_per_page
-    @default_per_page ||= PER_PAGE
+    @default_per_page ||= DEFAULT_PER_PAGE
+  end
+
+  def hmac_secret=(value)
+    @hmac_secret = value
   end
 
-  def exp
-    @exp ||= DEFAULT_EXP
+  def hmac_secret
+    @hmac_secret
   end
 
   def serializer_adapter=(adapter)

data/lib/api_pack/api_helper.rb

@@ -0,0 +1,23 @@
+module ApiPack
+  module ApiHelper
+    def pagination_meta_generator(request, total_pages)
+      ApiPack::PaginationMetaGenerator.new(request: request, total_pages: total_pages).call
+    end
+
+    def current_page
+      return params[:page].to_i if defined?(params[:page]) && !params[:page].nil?
+
+      ApiPack::DEFAULT_PAGE
+    end
+
+    def per_page
+      return params[:per_page].to_i if defined?(params[:per_page]) && !params[:per_page].nil?
+
+      ApiPack.default_per_page
+    end
+
+    def serializer_hash(resource, class_name, opt: {})
+      ApiPack::Serializer::Parser.serializer_hash(resource, class_name, opt: opt)
+    end
+  end
+end

data/lib/api_pack/errors/auth.rb

@@ -4,6 +4,7 @@ module ApiPack
       class AuthenticationError < StandardError; end
       class InvalidToken < StandardError; end
       class MissingToken < StandardError; end
+      class MissingHmacSecret < StandardError; end
     end
   end
 end

data/lib/api_pack/errors/error_map.rb

@@ -24,8 +24,8 @@ module ApiPack
         },
         'ApiPack::Errors::Auth::InvalidToken' => {
           method: :error_message_body,
-          title: 'Invalid Token',
-          status: :unprocessable_entity
+          title: 'Access Denied - Invalid Token',
+          status: :forbidden
         },
         'ApiPack::Errors::Auth::MissingToken' => {
           method: :error_message_body,

data/lib/api_pack/json_web_token.rb

@@ -1,13 +1,18 @@
 module ApiPack
   class JsonWebToken
-    def self.encode(payload, exp: ApiPack.exp)
+    # exp: 24 hours from now
+    def self.encode(payload, exp: (Time.now + 1 * 86_400).to_i)
+      raise ApiPack::Errors::Auth::MissingHmacSecret if ApiPack.hmac_secret.nil?
+
       payload[:exp] = exp.to_i
 
-      JWT.encode(payload, ApiPack::HMAC_SECRET)
+      JWT.encode(payload, ApiPack.hmac_secret)
+    rescue ApiPack::Errors::Auth::MissingHmacSecret
+      raise ApiPack::Errors::Auth::MissingHmacSecret, 'ApiPach.hmac_secret is missing'
     end
 
     def self.decode(token)
-      JWT.decode(token, ApiPack::HMAC_SECRET).first
+      JWT.decode(token, ApiPack.hmac_secret).first
     rescue JWT::DecodeError => e
       raise ApiPack::Errors::Auth::InvalidToken, e.message
     end

data/lib/api_pack/pagination_meta_generator.rb

@@ -1,8 +1,8 @@
-require 'api_pack/support/api_helper'
+require 'api_pack/support/helper'
 
 module ApiPack
   class PaginationMetaGenerator
-    include Support::ApiHelper
+    include Support::Helper
 
     def initialize(request:, total_pages:)
       @url = "#{request.base_url}#{request.path}"

data/lib/api_pack/support/{api_helper.rb → helper.rb}

@@ -1,5 +1,5 @@
 module Support
-  module ApiHelper
+  module Helper
     def to_query_api(params)
       query = params.collect do |key, value|
         "#{key}=#{value}"

data/lib/api_pack/version.rb

@@ -1,3 +1,3 @@
 module ApiPack
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_pack
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Jorge
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,7 +60,7 @@ files:
 - bin/console
 - bin/setup
 - lib/api_pack.rb
-- lib/api_pack/constants.rb
+- lib/api_pack/api_helper.rb
 - lib/api_pack/errors/api_errors_serializer.rb
 - lib/api_pack/errors/auth.rb
 - lib/api_pack/errors/error_map.rb
@@ -71,13 +71,13 @@ files:
 - lib/api_pack/pagination_meta_generator.rb
 - lib/api_pack/serializer/adapter/fast_json_api.rb
 - lib/api_pack/serializer/parser.rb
-- lib/api_pack/support/api_helper.rb
+- lib/api_pack/support/helper.rb
 - lib/api_pack/version.rb
 homepage: https://github.com/Jllima/api_pack
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,8 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Api requirements
 test_files: []

data/lib/api_pack/constants.rb

@@ -1,3 +0,0 @@
-module ApiPack
-  HMAC_SECRET = '2e484b352b985259601a5f2f2c1712b31d63136bf22d9213303a5b501942723827508038484b9da1ead77a7788799c55e05785f2f148e53d943e6dedf635a291'.freeze
-end