api_pack 1.1.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1108b79f1495ff944ba4298731ec0c68e030d73d6ecbd031120d312c14620759
-  data.tar.gz: e56c3cbe722219a0c79307bc964f265aff47fcb6f2f63a46fc211752bb7363cb
+  metadata.gz: b271de6e69e7310b83a0e0a4272291207ab1b2b21356e77ced5d78d38c1884af
+  data.tar.gz: 5a7e2ce5a172e446acea51b9c8f046b778942d61a9947307e378122d30873264
 SHA512:
-  metadata.gz: 77a5de40fb986ba63ee7b44be5d310ddda4660518843ee1ff9afa3ec2dda22f70e2b0916f2197496b4b1e7b4964860569882866042f6da57e28df6382d217048
-  data.tar.gz: 5ac7a7d1b8ca6ce1d6069ca1bc3bbcd390e02107678c526835d0da88bbecaad9831610f1caf0f610206a99987676ccbc21f3e65b60d4ebf0504ea442df548620
+  metadata.gz: 565ebc2d98a7f6b3aa32e1c9a8735cbbfeaf7b482f4fff4a51078dcc27454942765fc05a90f1eb7183c63245144046e422c4a6216ce942d3a068a4d2fb97c29a
+  data.tar.gz: 35ed85d6f2f209754acba27f472864eb1cf5fb3a16652612ee0ad7886cfc4129d3da7713d0bef7cc94840c2ba296626fa77710c38dbfced631ae478b4f01e59b

data/.gitignore

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

data/Gemfile

@@ -4,7 +4,6 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
-gem 'fast_jsonapi'
 gem 'jwt'
 
 group :test do

data/README.md

@@ -1,4 +1,5 @@
-[![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
@@ -23,7 +24,7 @@ ruby >= 2.4
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'api_pack'
+gem 'api_pack', '~> 1.3.1' 
 ```
 
 And then execute:
@@ -37,12 +38,17 @@ Or install it yourself as:
 ## Usage
 
 ### 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
-- To change o expiration create an initializer api_pack and put this code
+returns a valid token with an expiration time of one day by default
+- To change o expiration call method with parameter exp:
 ```ruby
-ApiPack.exp = 12345
+ApiPack::JsonWebToken.encode({ user_id: user.id, exp: 123 })
 ```
 
 Usage in a service authenticate user
@@ -137,46 +143,10 @@ module ExceptionHandler
 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
+-  Apipack has default per page like 5
 - To change o defaut_per_page create an initializer api_pack and put this code
 
 ```ruby
@@ -195,6 +165,11 @@ def index
 end
 ```
 
+## This example project uses gem api_apck
+
+https://github.com/Jllima/api_pack_rails
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_pack.

data/lib/api_pack.rb

@@ -1,5 +1,4 @@
 require 'jwt'
-require 'fast_jsonapi'
 require 'api_pack/version'
 require 'api_pack/api_helper'
 require 'api_pack/json_web_token'
@@ -10,18 +9,16 @@ 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/helper'
+require 'api_pack/support/undescore'
 require 'api_pack/serializer/parser'
 
 module ApiPack
   module_function
 
   DEFAULT_PAGE = 1
-  DEFAULT_PER_PAGE = 10
-  # 24 hours from now
-  DEFAULT_EXP = (Time.now + 1 * 86_400).to_i
-
+  DEFAULT_PER_PAGE = 5
+  
   def default_per_page=(value)
     @default_per_page = value
   end
@@ -30,12 +27,12 @@ module ApiPack
     @default_per_page ||= DEFAULT_PER_PAGE
   end
 
-  def exp=(value)
-    @exp = value
+  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

@@ -13,7 +13,7 @@ module ApiPack
     def per_page
       return params[:per_page].to_i if defined?(params[:per_page]) && !params[:per_page].nil?
 
-      ApiPack::DEFAULT_PER_PAGE
+      ApiPack.default_per_page
     end
 
     def serializer_hash(resource, class_name, opt: {})

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/support/undescore.rb

@@ -0,0 +1,5 @@
+class String
+  def underscore
+    gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z\d])([A-Z])/, '\1_\2').tr("-", "_").downcase
+  end
+end

data/lib/api_pack/version.rb

@@ -1,3 +1,3 @@
 module ApiPack
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.3.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_pack
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Jorge
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,7 +61,6 @@ files:
 - 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
 - lib/api_pack/errors/error_map.rb
@@ -73,12 +72,13 @@ files:
 - lib/api_pack/serializer/adapter/fast_json_api.rb
 - lib/api_pack/serializer/parser.rb
 - lib/api_pack/support/helper.rb
+- lib/api_pack/support/undescore.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
@@ -93,8 +93,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.2.15
+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