api_pack 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a343d0ee7607c4f0c4b075e1646bc773a93cd06559115321f033637b545868e4
+  data.tar.gz: fb14ee9d7150fb83829d8c54a2e92a152a1d9765c5a5fa51b0c6dcb5d58595ac
+SHA512:
+  metadata.gz: ca5d0110ce9790804a3daf4830ade07a4e71c8c60e564fd79aca96eac6ee6a16b56854789de00fa4cf601bbb615b6fc13c363deec25197e7d92c1518e19cf9b9
+  data.tar.gz: 5258dbb75b045129a23d249d93586c4d7a93aedc0a9f490c141f551915b5076c574ae6eecbc9a7f47f24680334104c5c000d3a9cd237bc91db655a84a17e1ea6

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.fasterer.yml

@@ -0,0 +1,5 @@
+speedups:
+  each_with_index_vs_while: false
+
+exclude_paths:
+  - spec/**/*.rb

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.DS_store
+
+# rspec failure tracking
+.rspec_status

data/.overcommit.yml

@@ -0,0 +1,44 @@
+CommitMsg:
+  CapitalizedSubject:
+    enabled: false
+
+  EmptyMessage:
+    enabled: false
+
+  TrailingPeriod:
+    enabled: true
+
+  TextWidth:
+    enabled: false
+
+PreCommit:
+  ALL:
+    on_warn: fail
+
+  AuthorEmail:
+    enabled: true
+
+  AuthorName:
+    enabled: true
+    
+  BundleCheck:
+    enabled: true
+    
+  BundleAudit:
+    enabled: true
+    
+  Fasterer:
+    enabled: true
+    
+  RuboCop:
+    enabled: true
+  
+  RubyCritic:
+    enabled: true
+  
+  MergeConflicts:
+    enabled: true
+
+PrePush:
+  RSpec:
+    enabled: true

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+    - 'bin/**/*'
+    - api_pack.gemspec
+    - 'lib/api_pack/constants.rb'
+  TargetRubyVersion: 2.7.1
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength: 
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 18
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/GlobalStdStream:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
+install: bundle install --jobs=3 --retry=3
+
+after_success:
+  - CI=true TRAVIS=true coveralls --verbose

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+gem 'fast_jsonapi'
+gem 'jwt'
+
+group :test do
+  gem 'faker'
+  gem 'rspec', '~> 3.7'
+end
+
+group :development, :test do
+  gem 'bundler-audit'
+  gem 'coveralls_reborn', '~> 0.18.0', require: false
+  gem 'fasterer'
+  gem 'overcommit'
+  gem 'pry'
+  gem 'rubocop', require: false
+  gem 'rubycritic', require: false
+  gem 'simplecov', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jorge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+[![Build Status](https://travis-ci.org/Jllima/api_pack.svg?branch=master)](https://travis-ci.org/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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_pack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_pack
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_pack.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/api_pack.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_pack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'api_pack'
+  spec.version       = ApiPack::VERSION
+  spec.authors       = ['Jorge']
+  spec.email         = ['jlimajorge@gmail.com']
+
+  spec.summary       = 'Api requirements'
+  spec.description   = 'Api requirements pack for api rails development'
+  spec.homepage      = 'https://github.com/Jllima/api_pack'
+  spec.license       = 'MIT'
+
+  raise 'RubyGems 2.4 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 13.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api_pack"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/api_pack.rb

@@ -0,0 +1,36 @@
+require 'jwt'
+require 'fast_jsonapi'
+require 'api_pack/version'
+require 'api_pack/json_web_token'
+require 'api_pack/pagination_meta_generator'
+require 'api_pack/errors/auth'
+require 'api_pack/errors/error_map'
+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/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
+
+  def default_per_page
+    @default_per_page ||= PER_PAGE
+  end
+
+  def exp
+    @exp ||= DEFAULT_EXP
+  end
+
+  def serializer_adapter=(adapter)
+    ApiPack::Serializer::Parser.adapter = adapter
+  end
+end

data/lib/api_pack/constants.rb

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

data/lib/api_pack/errors/api_errors_serializer.rb

@@ -0,0 +1,39 @@
+module ApiPack
+  module Errors
+    class ApiErrorsSerializer
+      def initialize(body)
+        @body = body
+      end
+
+      def serializer
+        serializable
+      end
+
+      private
+
+      attr_accessor :body
+
+      def serializable
+        return serializable_array if body[:details].is_a?(Array)
+
+        serializable_object
+      end
+
+      def serializable_object
+        {
+          errors: [
+            body
+          ]
+        }
+      end
+
+      def serializable_array
+        {
+          title: body[:title],
+          status: body[:status],
+          errors: body[:details]
+        }
+      end
+    end
+  end
+end

data/lib/api_pack/errors/auth.rb

@@ -0,0 +1,9 @@
+module ApiPack
+  module Errors
+    module Auth
+      class AuthenticationError < StandardError; end
+      class InvalidToken < StandardError; end
+      class MissingToken < StandardError; end
+    end
+  end
+end

data/lib/api_pack/errors/error_map.rb

@@ -0,0 +1,38 @@
+module ApiPack
+  module Errors
+    module ErrorMap
+      ERROR_MAP = {
+        'ActiveRecord::RecordNotFound' => {
+          method: :error_message_body,
+          title: 'Not Found',
+          status: :not_found
+        },
+        'ActionController::ParameterMissing' => {
+          method: :parameter_missing,
+          title: 'Parameter Missing',
+          status: :unprocessable_entity
+        },
+        'ActiveRecord::RecordInvalid' => {
+          method: :record_invalid,
+          title: 'Validations Failed',
+          status: :unprocessable_entity
+        },
+        'ApiPack::Errors::Auth::AuthenticationError' => {
+          method: :error_message_body,
+          title: 'Invalid Credentials',
+          status: :unauthorized
+        },
+        'ApiPack::Errors::Auth::InvalidToken' => {
+          method: :error_message_body,
+          title: 'Invalid Token',
+          status: :unprocessable_entity
+        },
+        'ApiPack::Errors::Auth::MissingToken' => {
+          method: :error_message_body,
+          title: 'Missing Token',
+          status: :unprocessable_entity
+        }
+      }.freeze
+    end
+  end
+end

data/lib/api_pack/errors/handle_error.rb

@@ -0,0 +1,63 @@
+module ApiPack
+  module Errors
+    class HandleError
+      include Errors::ErrorMap
+
+      def initialize(error)
+        @error = error
+      end
+
+      def call
+        handle_error
+      end
+
+      private
+
+      attr_accessor :error
+
+      def handle_error
+        if ERROR_MAP.keys.include? error.class.name
+          handler = ERROR_MAP[error.class.name]
+          body = send(handler[:method], handler: handler, error: error)
+        else
+          body = {
+            title: 'Internal Server Error',
+            details: error.message,
+            status: :internal_server_error
+          }
+        end
+
+        { body: serialize(body), status: body[:status] }
+      end
+
+      def serialize(body)
+        ApiPack::Errors::ApiErrorsSerializer.new(body).serializer
+      end
+
+      def error_message_body(handler:, error:)
+        {
+          title: handler[:title],
+          status: handler[:status],
+          details: error.message
+        }
+      end
+
+      def parameter_missing(handler:, error:)
+        {
+          title: handler[:title],
+          details: error.message,
+          status: handler[:status],
+          parameter: error.param
+        }
+      end
+
+      def record_invalid(handler:, error:)
+        {
+          title: handler[:title],
+          status: handler[:status],
+          details: ApiPack::Errors::ValidationErrorsSerializer.new(error.record).serialize
+        }
+      end
+    end
+  end
+end

data/lib/api_pack/errors/validation_error_serializer.rb

@@ -0,0 +1,25 @@
+module ApiPack
+  module Errors
+    class ValidationErrorSerializer
+      def initialize(record, field, message)
+        @record = record
+        @field = field
+        @message = message
+      end
+
+      def serialize
+        {
+          resource: underscored_resource_name,
+          field: @field,
+          detail: @message
+        }
+      end
+
+      private
+
+      def underscored_resource_name
+        @record.class.to_s.gsub('::', '').underscore
+      end
+    end
+  end
+end

data/lib/api_pack/errors/validation_errors_serializer.rb

@@ -0,0 +1,19 @@
+module ApiPack
+  module Errors
+    class ValidationErrorsSerializer
+      attr_reader :record
+
+      def initialize(record)
+        @record = record
+      end
+
+      def serialize
+        record.errors.messages.map do |field, messages|
+          messages.map do |error_messages|
+            ApiPack::Errors::ValidationErrorSerializer.new(record, field, error_messages).serialize
+          end
+        end.flatten
+      end
+    end
+  end
+end

data/lib/api_pack/json_web_token.rb

@@ -0,0 +1,15 @@
+module ApiPack
+  class JsonWebToken
+    def self.encode(payload, exp: ApiPack.exp)
+      payload[:exp] = exp.to_i
+
+      JWT.encode(payload, ApiPack::HMAC_SECRET)
+    end
+
+    def self.decode(token)
+      JWT.decode(token, ApiPack::HMAC_SECRET).first
+    rescue JWT::DecodeError => e
+      raise ApiPack::Errors::Auth::InvalidToken, e.message
+    end
+  end
+end

data/lib/api_pack/pagination_meta_generator.rb

@@ -0,0 +1,75 @@
+require './lib/api_pack/support/api_helper'
+
+module ApiPack
+  class PaginationMetaGenerator
+    include Support::ApiHelper
+
+    def initialize(request:, total_pages:)
+      @url = "#{request.base_url}#{request.path}"
+      @page = request.params[:page].to_i
+      @per_page = request.params[:per_page].to_i
+      @total_pages = total_pages
+    end
+
+    def call
+      {
+        links: links,
+        meta: {
+          current_page: current_page,
+          total_pages: @total_pages
+        }
+      }
+    end
+
+    private
+
+    attr_accessor :url, :hash
+
+    attr_reader :per_page, :page, :total_pages
+
+    def links
+      links = {
+        self: generate_url,
+        first: generate_url(number_page: 1),
+        last: generate_url(number_page: total_pages)
+      }
+
+      links[:next] = generate_url(number_page: next_number(page)) if current_page != total_pages
+      links[:prev] = generate_url(number_page: page - 1) if page > 1
+
+      links
+    end
+
+    def generate_url(number_page: 0)
+      return url if number_page.zero?
+
+      [url, url_params(number_page)].join("?")
+    end
+
+    def url_params(number_page)
+      url_params = {}
+      url_params[:per_page] = include_per_page
+      url_params[:page] = number_page
+
+      to_query_api(url_params)
+    end
+
+    def include_per_page
+      return ApiPack.default_per_page if per_page.zero?
+
+      per_page
+    end
+
+    def next_number(number_page)
+      return number_page + 2 if number_page.zero?
+
+      number_page + 1
+    end
+
+    def current_page
+      return 1 if page.zero?
+
+      page
+    end
+  end
+end

data/lib/api_pack/serializer/adapter/fast_json_api.rb

@@ -0,0 +1,16 @@
+module ApiPack
+  module Serializer
+    module Adapter
+      module FastJsonApi
+        module_function
+
+        def serializer_hash(resource, klass, opt: {})
+          name_klass = klass.to_s.split('_').collect(&:capitalize).join
+
+          serializer = "#{name_klass}Serializer"
+          FastJsonapi.const_get(serializer).new(resource, opt).serializable_hash
+        end
+      end
+    end
+  end
+end

data/lib/api_pack/serializer/parser.rb

@@ -0,0 +1,26 @@
+module ApiPack
+  module Serializer
+    module Parser
+      module_function
+
+      def serializer_hash(resource, klass, opt: {})
+        adapter.serializer_hash(resource, klass, opt: opt)
+      end
+
+      def adapter
+        return @adapter if @adapter
+
+        self.adapter = :fast_json_api
+        @adapter
+      end
+
+      def adapter=(adapter)
+        require "./lib/api_pack/serializer/adapter/#{adapter}"
+
+        adapter_name = adapter.to_s.split('_').collect(&:capitalize).join
+
+        @adapter = Serializer::Adapter.const_get(adapter_name)
+      end
+    end
+  end
+end

data/lib/api_pack/support/api_helper.rb

@@ -0,0 +1,12 @@
+module Support
+  module ApiHelper
+    def to_query_api(params)
+      query = params.collect do |key, value|
+        "#{key}=#{value}"
+      end.compact
+
+      query.sort!
+      query.join("&")
+    end
+  end
+end

data/lib/api_pack/version.rb

@@ -0,0 +1,3 @@
+module ApiPack
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: api_pack
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jorge
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Api requirements pack for api rails development
+email:
+- jlimajorge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".fasterer.yml"
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_pack.gemspec
+- bin/console
+- bin/setup
+- lib/api_pack.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
+- lib/api_pack/errors/handle_error.rb
+- lib/api_pack/errors/validation_error_serializer.rb
+- lib/api_pack/errors/validation_errors_serializer.rb
+- lib/api_pack/json_web_token.rb
+- 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/version.rb
+homepage: https://github.com/Jllima/api_pack
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Api requirements
+test_files: []