ctws 0.1.12.alpha → 0.1.13.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5be817a0afed3eba6a2644b0ca2e7f9d19a78f0b
-  data.tar.gz: cc5d76993f3549ed7d3cf0441a1dcc7185c93d28
+  metadata.gz: 2f86a86cc1af9c424b2349bad827b752cce5ad87
+  data.tar.gz: 167ea2979b16ea75af0ba49790e30a69765ee58f
 SHA512:
-  metadata.gz: 2d0ee407f5fd1ccfa1d689ad4238af538a1dffd444a70bb2e7d98c91f2f24a905426aea31b9eaab0eabbd2ba701b49f50e729615f08051fc374da55f97d7e94c
-  data.tar.gz: c6907f7c9be5f43774dcf437c7a19e11bd1a942e5a38dc6e0cc2e8923e43e9aeb614e6e3c8413265d171a3a0e643271a96c4e376a404c440f298ef5d662d926c
+  metadata.gz: 78997a0717a48effc5370641eec6d86d16b0069c640d762e246dd2e4dbe6ff69729adbdfa2fde10b36f741defc9f1caf884aeafce351d3655aec9794afcc05bd
+  data.tar.gz: af4cf13d78a02772d22c650841d7dab03e9b342df78b2cdc52a3a48d4894594a5b9aea2d331b6d35bc3a642b661ffd40f13d90fe7642ea0fcc5ec9f38e541f17

data/README.md

@@ -36,13 +36,13 @@ server. It can be whatever you want.
 
 ## Engine setup
 
-The engine contains migrations for the `ctws_min_app_version` and `xxx` table which need to be created in the application's database so that the engine's models can query them correctly. 
+The engine contains migrations for the `ctws_min_app_version` and `xxx` table which need to be created in the application's database so that the engine's models can query them correctly.
 To copy these migrations into the application run the following command from the Rails App root, then run these migrations:
 
 ```bash
 rails ctws:install:migrations
 rails db:migrate
-``` 
+```
 
 If you want to revert engine's migrations before removing it. To revert all migrations from blorgh engine you can run code such as:
 
@@ -54,7 +54,7 @@ bin/rails db:migrate SCOPE=ctws VERSION=0
 
 By default the user model is `User` but you can change it by creating or editing the `ctws.rb` initializer file in `config/initializers` and put this content in it:
 
-```ruby 
+```ruby
 Ctws.user_class = "Account"
 ```
 
@@ -64,12 +64,12 @@ The **`password` is optional** by default a user is validated with password, for
 
 To opt out the user validation with the password change it by creating or editing the `ctws.rb` initializer file in `config/initializers` and put this content in it:
 
-```ruby 
+```ruby
 Ctws.user_validate_with_password = false
 ```
 You can edit your app's required fields for signup by creating or editing the `ctws.rb` initializer file in `config/initializers` and put your strong parameters:
 
-```ruby 
+```ruby
 Ctws.user_class_strong_params = [:email, :password, :password_confirmation]
 ```
 
@@ -77,7 +77,7 @@ Ctws.user_class_strong_params = [:email, :password, :password_confirmation]
 
 By default the token expiry time is 24h but you can change it by creating or editing the `ctws.rb` initializer file in `config/initializers` and put this content in it:
 
-```ruby 
+```ruby
 Ctws.jwt_expiration_time = 24.hours.from_now
 ```
 
@@ -93,6 +93,14 @@ end
 ```
 -->
 
+### Response messages in users' locale (i18n)
+
+In your app set your accepted languages, add to `application.rb`:
+
+```
+config.i18n.available_locales = %w(en es fr ca)
+```
+
 ## Endpoints
 
 | Endpoint                                           | Functionality                                    | Requires Authentication?  |
@@ -133,26 +141,26 @@ X-XSS-Protection: 1; mode=block
 {
   "data": [
     {
-      "id": 3, 
+      "id": 3,
       "type": "min_app_version",
       "attributes": {
-        "codename": "Second release", 
-        "description": "Second release Description text", 
-        "min_version": "0.0.2", 
-        "platform": "android", 
-        "store_uri": "htttps://fdsafdsafdsaf.cot", 
+        "codename": "Second release",
+        "description": "Second release Description text",
+        "min_version": "0.0.2",
+        "platform": "android",
+        "store_uri": "htttps://fdsafdsafdsaf.cot",
         "updated_at": "2017-06-22T17:53:31.252+02:00"
       }
-    }, 
+    },
     {
       "type": "min_app_version",
-      "id": 1, 
+      "id": 1,
       "attributes": {
-        "codename": "First Release", 
-        "description": "You need to update your app. You will be redirected to the corresponding store", 
-        "min_version": "0.0.1", 
-        "platform": "ios", 
-        "store_uri": "https://itunes.apple.com/", 
+        "codename": "First Release",
+        "description": "You need to update your app. You will be redirected to the corresponding store",
+        "min_version": "0.0.1",
+        "platform": "ios",
+        "store_uri": "https://itunes.apple.com/",
         "updated_at": "2017-06-21T14:29:59.348+02:00"
       }
     }
@@ -184,10 +192,10 @@ X-XSS-Protection: 1; mode=block
 {
   "data": {
     "type": "user",
-    "id": 20, 
+    "id": 20,
     "attributes": {
       "message": "Account created successfully",
-      "auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyMCwiZXhwIjoxNDk5ODU1MjQ5fQ.H9ljjShWOAv8b9xn9ZLKv-zgmH8xkPe6dkdhH4JrJPw", 
+      "auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyMCwiZXhwIjoxNDk5ODU1MjQ5fQ.H9ljjShWOAv8b9xn9ZLKv-zgmH8xkPe6dkdhH4JrJPw",
       "created_at": "2017-07-11T12:27:27.916+02:00"
     }
   }
@@ -271,7 +279,7 @@ X-XSS-Protection: 1; mode=block
 
 running `rspec` will run tests and output a report, first run migrations the tests:
 
-```bash 
+```bash
 rails db:migrate RAILS_ENV=test
 rspec
 ```

data/app/controllers/concerns/ctws/exception_handler.rb

@@ -1,13 +1,13 @@
 module Ctws
-  #  In the case where the record does not exist, 
-  # ActiveRecord will throw an exception ActiveRecord::RecordNotFound. 
+  #  In the case where the record does not exist,
+  # ActiveRecord will throw an exception ActiveRecord::RecordNotFound.
   # We'll rescue from this exception and return a 404 message.
   # List of Rails Status Code Symbols http://billpatrianakos.me/blog/2013/10/13/list-of-rails-status-code-symbols
-  
+
   module ExceptionHandler
     # provides the more graceful `included` method
     extend ActiveSupport::Concern
-    
+
     # Define custom error subclasses - rescue catches `StandardErrors`
     class AuthenticationError < StandardError; end
     class MissingToken < StandardError; end
@@ -15,6 +15,7 @@ module Ctws
     class ExpiredSignature < StandardError; end
     class UnprocessableEntity < StandardError; end
     class RoutingError < StandardError; end
+    class NotConfirmed < StandardError; end
 
     included do
       # Define custom handlers
@@ -27,19 +28,23 @@ module Ctws
       rescue_from ExceptionHandler::RoutingError, with: :not_found
       rescue_from ActiveRecord::RecordNotFound, with: :not_found
       rescue_from ActionController::RoutingError, with: :not_found
-
+      rescue_from ExceptionHandler::NotConfirmed, with: :not_confirmed
     end
-    
+
     # JSON response with message; Status code 401 - Unauthorized
     def unauthorized_request(e)
       json_response([{ message: e.message, error_code: "401"}], :unauthorized)
     end
-    
+
     # JSON response with message; Status code 404 - Not Found
     def not_found(e)
       json_response([{ message: e.message, error_code: "404" }], :not_found)
     end
-    
+
+    def not_confirmed(e)
+      json_response([{ message: e.message, error_code: "403" }], :unauthorized)
+    end
+
     # JSON response with message; Status code 422 - unprocessable entity
     def four_twenty_two(e)
       json_response([{ message: e.message, error_code: "422" }], :unprocessable_entity)
@@ -49,6 +54,6 @@ module Ctws
     def four_ninety_eight(e)
       json_response([{ message: e.message, error_code: "498" }], :invalid_token)
     end
-    
+
   end
 end

data/app/controllers/concerns/ctws/response.rb

@@ -10,11 +10,11 @@ module Ctws
         self.data_payload(object)
       end
     end
-    
+
     def json_response(object = {}, status = :ok)
       render json: self.payload?(object, status), status: status
     end
-    
+
     def data_payload(object)
       {data: object}
     end

data/app/controllers/ctws/ctws_controller.rb

@@ -4,13 +4,15 @@ module Ctws
   class CtwsController < ApplicationController
     include Response
     include ExceptionHandler
+    include HttpAcceptLanguage::AutoLocale
+
     # Generic API stuff here
-    
+
     # called before every action on controllers
     before_action :authorize_request
     skip_before_action :authorize_request, only: [:raise_not_found!]
     attr_reader :current_user
-    
+
     def raise_not_found!
       raise Ctws::ExceptionHandler::RoutingError, ("#{Ctws::Message.unmatched_route(params[:unmatched_route])}")
     end

data/app/lib/ctws/message.rb

@@ -1,47 +1,51 @@
 module Ctws
   class Message
     def self.not_found(record = 'record')
-      "Sorry, #{record} not found."
+      I18n.t('ctws.not_found', record: record)
     end
 
     def self.unmatched_route(route = 'route')
-      "No route matches #{route}"
+      I18n.t('ctws.unmatched_route', route: route)
     end
 
     def self.invalid_credentials
-      'Invalid credentials'
+      I18n.t('ctws.invalid_credentials')
     end
 
     def self.invalid_token
-      'Invalid token'
+      I18n.t('ctws.invalid_token')
     end
 
     def self.missing_token
-      'Missing token'
+      I18n.t('ctws.missing_token')
     end
 
     def self.unauthorized
-      'Unauthorized request'
+      I18n.t('ctws.unauthorized')
     end
 
     def self.account_created
-      'Account created successfully'
+      I18n.t('ctws.account_created')
     end
 
     def self.account_not_created
-      'Account could not be created'
+      I18n.t('ctws.account_not_created')
     end
 
     def self.account_doesnt_exist
-      "Account doesn't exist"
+      I18n.t('ctws.account_doesnt_exist')
     end
 
     def self.authenticated_user_success
-      'Authenticated user successfully'
+      I18n.t('ctws.authenticated_user_success')
     end
 
     def self.expired_token
-      'Sorry, your token has expired. Please login to continue.'
+      I18n.t('ctws.expired_token')
+    end
+
+    def self.record_not_confirmed(record = 'record')
+      I18n.t('ctws.record_not_confirmed', record: record)
     end
   end
 end

data/config/locales/ctws_messages_ca.yml

@@ -0,0 +1,14 @@
+ca:
+  ctws:
+    account_created: "S'ha creat el compte amb èxit."
+    account_doesnt_exist: "El compte no existeix."
+    account_not_created: "No s'ha pogut crear el compte."
+    authenticated_user_success: "Usuari autenticat amb èxit."
+    expired_token: "Ho sentim, el vostre token ha caducat. Inicieu sessió per continuar."
+    invalid_credentials: "Credencials no vàlides."
+    invalid_token: "Token invàlid."
+    missing_token: "Falta token."
+    not_found: "No s'ha trobat %{record}."
+    record_not_confirmed: "%{record} no confirmat."
+    unauthorized: "Sol·licitud no autoritzada."
+    unmatched_route: "Cap ruta coincideix amb %{route}."

data/config/locales/ctws_messages_en.yml

@@ -0,0 +1,14 @@
+en:
+  ctws:
+    account_created: "Account created successfully."
+    account_doesnt_exist: "Account doesn't exist."
+    account_not_created: "Account could not be created."
+    authenticated_user_success: "Authenticated user successfully."
+    expired_token: "Sorry, your token has expired. Please login to continue."
+    invalid_credentials: "Invalid credentials."
+    invalid_token: "Invalid token."
+    missing_token: "Missing token."
+    not_found: "Sorry, %{record} not found."
+    record_not_confirmed: "%{record} not confirmed."
+    unauthorized: "Unauthorized request."
+    unmatched_route: "No route matches %{route}."

data/config/locales/ctws_messages_es.yml

@@ -0,0 +1,14 @@
+es:
+  ctws:
+    account_created: "Cuenta creada con éxito."
+    account_doesnt_exist: "La cuenta no existe."
+    account_not_created: "La cuenta no pudo ser creada."
+    authenticated_user_success: "Usuario autenticado con éxito."
+    expired_token: "Tu token ha expirado, por favor inicie sesión para continuar."
+    invalid_credentials: "Credenciales no válidas."
+    invalid_token: "Token no valido."
+    missing_token: "Falta token."
+    not_found: "Lo sentimos, %{record} no encontrado."
+    record_not_confirmed: "%{record} not confirmado."
+    unauthorized: "Solicitud no autorizada."
+    unmatched_route: "Ninguna ruta coincide con %{route}."

data/lib/ctws/engine.rb

@@ -1,9 +1,11 @@
 module Ctws
   class Engine < ::Rails::Engine
+    require "http_accept_language"
+
     engine_name "ctws"
     isolate_namespace Ctws
     config.generators.api_only = true
-    
+
     config.generators do |g|
       g.test_framework :rspec, :fixture => false
       g.fixture_replacement :factory_girl_rails, :dir => 'spec/factories'

data/lib/ctws/version.rb

@@ -1,3 +1,3 @@
 module Ctws
-  VERSION = '0.1.12.alpha'
+  VERSION = '0.1.13.alpha'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ctws
 version: !ruby/object:Gem::Version
-  version: 0.1.12.alpha
+  version: 0.1.13.alpha
 platform: ruby
 authors:
 - Agustí B.R.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: http_accept_language
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +203,9 @@ files:
 - app/models/ctws/min_app_version.rb
 - config/initializers/ctws.rb
 - config/initializers/mime_types.rb
+- config/locales/ctws_messages_ca.yml
+- config/locales/ctws_messages_en.yml
+- config/locales/ctws_messages_es.yml
 - config/routes.rb
 - db/migrate/20170425110839_create_ctws_min_app_versions.rb
 - db/migrate/20170425110933_add_values_to_ctws_min_app_versions.rb