api_pack 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf4c6bafb046c3e5e2973fffa4d6ef460e97c54c49fc2a53ee97d765068763e0
-  data.tar.gz: 88203c2eaad28463a1280d6d86987b9dd2f8a8d2e46359669a3a381bb90fd3a2
+  metadata.gz: 1108b79f1495ff944ba4298731ec0c68e030d73d6ecbd031120d312c14620759
+  data.tar.gz: e56c3cbe722219a0c79307bc964f265aff47fcb6f2f63a46fc211752bb7363cb
 SHA512:
-  metadata.gz: e030fc6456c257babab2f92a1bc026e4df1c8782d7cd1b54279de0352e89404d8e5e0f8fbad82e1811f92905d8ccbf59d361b02fcb4e43b9c6dea6e9ad09fcf8
-  data.tar.gz: 81e97e117806d75a3bffc3c78f341f3fba67fc59d69e7e80510d6d161c3ed6d81eec0286cdfb109e43219bf1ebd49921b4f04321c3e6efa103482b5ce41e3872
+  metadata.gz: 77a5de40fb986ba63ee7b44be5d310ddda4660518843ee1ff9afa3ec2dda22f70e2b0916f2197496b4b1e7b4964860569882866042f6da57e28df6382d217048
+  data.tar.gz: 5ac7a7d1b8ca6ce1d6069ca1bc3bbcd390e02107678c526835d0da88bbecaad9831610f1caf0f610206a99987676ccbc21f3e65b60d4ebf0504ea442df548620

data/README.md

@@ -3,9 +3,20 @@
 
 # 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
 
@@ -25,13 +36,164 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### JsonWebToken methods
+  
+- ApiPack::JsonWebToken.encode({ user_id: user.id }) \
+returns a valid token with an expiration time of one day
+- To change o expiration create an initializer api_pack and put this code
+```ruby
+ApiPack.exp = 12345
+```
+
+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
 
-## Development
+create an ExceptionHandler concern and deal with api errors in json api format
 
-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.
+```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
 
-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).
+  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
+```
 
 ## 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'
@@ -10,20 +11,27 @@ 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
+  DEFAULT_PAGE = 1
+  DEFAULT_PER_PAGE = 10
   # 24 hours from now
   DEFAULT_EXP = (Time.now + 1 * 86_400).to_i
 
-  attr_writer :default_per_page, :exp
+  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 exp=(value)
+    @exp = value
   end
 
   def exp

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/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.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_pack
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Jorge
@@ -60,6 +60,7 @@ files:
 - bin/console
 - bin/setup
 - lib/api_pack.rb
+- lib/api_pack/api_helper.rb
 - lib/api_pack/constants.rb
 - lib/api_pack/errors/api_errors_serializer.rb
 - lib/api_pack/errors/auth.rb
@@ -71,7 +72,7 @@ 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: