commons_yellowme 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72561778339f9301bc276ec516c4bf13d3e98323c93ba4a7bfce41d67dcca9d2
-  data.tar.gz: 9036b246544ec395c0cfb7829bdbea2b85deb1cbf14b465c8aacf3eaaf56c709
+  metadata.gz: 8647af0312b7a12912e0aa7d1dcf10c2a810b17badfadb626cb4e7f548ae3832
+  data.tar.gz: a9794e7a96deb33df33d15e2e2b641fa900efcf93ed14661909ae7bd3caf63a9
 SHA512:
-  metadata.gz: 563e23f1dfecd7805b3e274327365fe77a789db503cb421e00773d4ada57fb990456cfc5dea53fb0a411d1622074e4ef5985e851f54bce516ae6237d5863c785
-  data.tar.gz: 87e562f16d6f70f1c870c6db5ade5f5ae3c48601704e7040f7c327f8ad7c3c42b56a345268a68fa2bc1c04965b5ab672512f9d46bd3dc83144eb31afc18c762d
+  metadata.gz: c1c7895faba91c9758b80ab388f3f3966068c8c7758cf8ec84dcf79181f80773d9b83cefd923c70e0b578a4047812e3d52703a310c1c72a3de9c77b0e52b39a0
+  data.tar.gz: af4f866a77d8fa9295b1add9157c2dc3fdce233f9abb6cec8a30cab999292a83756077c8ae312fda1be8748eccd5c3b051f27d24bf0edca983a72521f3869938

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/db/*.sqlite3-*
+spec/dummy/log/*.log
+spec/dummy/storage/
+spec/dummy/tmp/
+coverage

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--require rails_helper
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in commons.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.

data/Gemfile.lock

@@ -0,0 +1,234 @@
+PATH
+  remote: .
+  specs:
+    commons (0.10.3)
+      active_model_serializers (~> 0.10.10)
+      dry-validation
+      json (~> 1.8)
+      jwt
+      phonelib (~> 0.6.29)
+      rails (~> 6.0.1)
+      strip_attributes
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2)
+      actionpack (= 6.0.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2)
+      actionpack (= 6.0.2)
+      activejob (= 6.0.2)
+      activerecord (= 6.0.2)
+      activestorage (= 6.0.2)
+      activesupport (= 6.0.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2)
+      actionpack (= 6.0.2)
+      actionview (= 6.0.2)
+      activejob (= 6.0.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2)
+      actionview (= 6.0.2)
+      activesupport (= 6.0.2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2)
+      actionpack (= 6.0.2)
+      activerecord (= 6.0.2)
+      activestorage (= 6.0.2)
+      activesupport (= 6.0.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2)
+      activesupport (= 6.0.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_model_serializers (0.10.10)
+      actionpack (>= 4.1, < 6.1)
+      activemodel (>= 4.1, < 6.1)
+      case_transform (>= 0.2)
+      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
+    activejob (6.0.2)
+      activesupport (= 6.0.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2)
+      activesupport (= 6.0.2)
+    activerecord (6.0.2)
+      activemodel (= 6.0.2)
+      activesupport (= 6.0.2)
+    activestorage (6.0.2)
+      actionpack (= 6.0.2)
+      activejob (= 6.0.2)
+      activerecord (= 6.0.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    builder (3.2.4)
+    case_transform (0.2)
+      activesupport
+    concurrent-ruby (1.1.5)
+    crass (1.0.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    dry-configurable (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-initializer (3.0.3)
+    dry-logic (1.0.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-schema (1.4.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.2)
+    dry-types (1.2.2)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.4.2)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.4, >= 1.4.3)
+    erubi (1.9.0)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
+    factory_bot_rails (5.1.1)
+      factory_bot (~> 5.1.0)
+      railties (>= 4.2.0)
+    faker (2.8.1)
+      i18n (>= 1.6, < 1.8)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    json (1.8.6)
+    jsonapi-renderer (0.2.2)
+    jwt (2.2.1)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    phonelib (0.6.41)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2)
+      actioncable (= 6.0.2)
+      actionmailbox (= 6.0.2)
+      actionmailer (= 6.0.2)
+      actionpack (= 6.0.2)
+      actiontext (= 6.0.2)
+      actionview (= 6.0.2)
+      activejob (= 6.0.2)
+      activemodel (= 6.0.2)
+      activerecord (= 6.0.2)
+      activestorage (= 6.0.2)
+      activesupport (= 6.0.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2)
+      actionpack (= 6.0.2)
+      activesupport (= 6.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    strip_attributes (1.9.0)
+      activemodel (>= 3.0, < 7.0)
+    thor (1.0.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  commons!
+  factory_bot_rails (~> 5.1.1)
+  faker
+  rspec-rails
+  simplecov
+  sqlite3
+
+BUNDLED WITH
+   2.0.2

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/commons.gemspec

@@ -0,0 +1,43 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "commons/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "commons_yellowme"
+  spec.version     = Commons::VERSION
+  spec.date        = '2019-12-10'
+  spec.summary     = "Commons is Yellowme's Rails APIs utilities gem"
+  spec.description = "Commons is Yellowme's Rails APIs utilities gem"
+  spec.authors     = ["Yellowme"]
+  spec.email       = 'hola@yellowme.mx'
+  spec.homepage    = 'https://github.com/yellowme/commons-rails'
+  spec.license      = 'MIT'
+
+  #spec.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
+  #spec.files       = [
+  #                     "lib/commons.rb",
+  #                     "spec/support/shared-examples/capitalizable.rb",
+  #                     "spec/support/shared-examples/undestroyable.rb",
+  #                     "spec/support/shared-examples/stripable.rb"
+  #                   ]
+  spec.files       = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+
+  spec.add_dependency "rails", "~> 6.0.1"
+  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency "active_model_serializers", "~> 0.10.10"
+  spec.add_dependency "strip_attributes"
+  spec.add_dependency "jwt"
+  spec.add_dependency "dry-validation"
+  spec.add_dependency "phonelib", "~> 0.6.29"
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "factory_bot_rails", "~> 5.1.1"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "simplecov"
+end

data/lib/commons/version.rb

@@ -1,3 +1,3 @@
 module Commons
-  VERSION = '0.11.0'
+  VERSION = '0.11.1'
 end

data/spec/commons/authentication/authenticate_by_jwt_spec.rb

@@ -0,0 +1,37 @@
+RSpec.describe Commons::Authentication::AuthenticateByJWT, type: :request do
+  describe 'when calling /misc/application_parameters' do
+    context 'raises error as an unauthenticated user' do
+      subject do
+        get "/misc/application_parameters",
+            params: {}.to_json,
+            headers: {
+              'content-type': 'application/json'
+            }
+        response
+      end
+
+      it do
+        is_expected.to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'works ok as an authenticated user' do
+      let(:user) { create(:user) }
+      let(:jwt) { Commons::Authentication::JSONWebToken.encode(user_id: user.id) }
+
+      subject do
+        get "/misc/application_parameters",
+            params: {}.to_json,
+            headers: {
+              'content-type': 'application/json',
+              'Authorization': 'Bearer ' + jwt
+            }
+        response
+      end
+
+      it do
+        is_expected.to have_http_status(:ok)
+      end
+    end
+  end
+end

data/spec/commons/authentication/json_web_token_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe Commons::Authentication::JSONWebToken do
+  let(:user) { create(:user) }
+  let(:exp) { 24.hours.from_now }
+  let(:jwt) { Commons::Authentication::JSONWebToken.encode({ user_id: user.id }, exp) }
+
+  describe 'decode' do
+    subject { Commons::Authentication::JSONWebToken.decode(jwt) }
+
+    context 'works ok' do
+      it do
+        expect { subject }.not_to raise_error
+        expect(subject[:user_id]).not_to be_nil
+        expect(subject[:expires_at]).not_to be_nil
+        expect(subject[:user_id]).to eq user.id
+        expect(subject[:expires_at]).to eq exp.to_i
+      end
+    end
+
+    context 'raises error when invalid' do
+      let(:jwt) { Faker::Name.last_name }
+      it do
+        expect { subject }.to raise_error JWT::DecodeError
+      end
+    end
+  end
+
+  describe 'encode' do
+    subject { Commons::Authentication::JSONWebToken.encode({ user_id: user.id }, exp) }
+
+    context 'works ok' do
+      it { expect { subject }.not_to raise_error }
+      it do
+        token = Commons::Authentication::JSONWebToken.decode(subject)
+        expect(token[:user_id]).not_to be_nil
+        expect(token[:user_id]).to eq user.id
+        expect(token[:expires_at]).not_to be_nil
+        expect(token[:expires_at]).to eq exp.to_i
+      end
+    end
+  end
+end

data/spec/commons/concerns/attributes/sex_spec.rb

@@ -0,0 +1,24 @@
+RSpec.describe Commons::Concerns::Attributes::Sex do
+  let(:sex) { Commons::Concerns::Attributes::Sex::FEMALE }
+  let(:user) { build(:user, name: 'rosa del barrio', last_name: 'hernandez', sex: sex) }
+
+  subject do
+    user
+  end
+
+  describe 'works ok!' do
+    it 'when valid data' do
+      expect(subject.sex).to eq sex
+      expect(subject.female_sex?).to be true
+    end
+  end
+
+  describe 'fails' do
+    subject do
+      user = User.new(sex: 'sex')
+    end
+    it 'when invalid sex' do
+      expect{ subject }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/commons/concerns/extensions/deleted_spec.rb

@@ -0,0 +1,42 @@
+RSpec.describe Commons::Concerns::Extensions::Deleted do
+  let(:user) { create(:user) }
+
+  subject do
+    user
+  end
+
+  describe 'works ok!' do
+    it 'when existing user' do
+      expect(subject.deleted?).to eq false
+    end
+
+    it 'when existing user allows save' do
+      subject.name = Faker::Name.first_name
+      expect{ subject.save }.not_to raise_error
+    end
+
+    it 'when deleted user' do
+      # given
+      user = subject
+      user = UserRepository.instance.soft_delete!(user.id)
+      # do
+      expect(user.deleted?).to eq true
+    end
+
+    it 'when deleted user denies save' do
+      # given
+      user = subject
+      user = UserRepository.instance.soft_delete!(user.id)
+      user.name = Faker::Name.first_name
+      # do
+      expect{ user.save }.to raise_error(ActiveRecord::RecordInvalid)
+    end
+
+    it 'when model is not deletable' do
+      # given
+      employee = Employee.new
+      # do
+      expect{ employee.deleted? }.to raise_error(ActiveModel::MissingAttributeError)
+    end
+  end
+end