ctws 0.1.5.alpha

data/app/controllers/ctws/v1/ctws_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "ctws/application_controller"
+
+module Ctws
+  module V1
+    class CtwsController < Ctws::CtwsController
+      # Generic API stuff here
+    end
+  end
+end

data/app/controllers/ctws/v1/min_app_versions_controller.rb

@@ -0,0 +1,6 @@
+module Ctws
+  module V1
+    class MinAppVersionsController < Ctws::MinAppVersionsController
+    end
+  end
+end

data/app/controllers/ctws/v1/users_controller.rb

@@ -0,0 +1,6 @@
+module Ctws
+  module V1
+    class UsersController < Ctws::UsersController
+    end
+  end
+end

data/app/controllers/ctws/v2/ctws_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "ctws/application_controller"
+
+module Ctws
+  module V2
+    class CtwsController < ApplicationController
+      # Generic API stuff here
+    end
+  end
+end

data/app/controllers/ctws/v2/min_app_versions_controller.rb

@@ -0,0 +1,6 @@
+module Ctws
+  module V2
+    class MinAppVersionsController < Ctws::MinAppVersionsController
+    end
+  end
+end

data/app/jobs/ctws/application_job.rb

@@ -0,0 +1,4 @@
+module Ctws
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/lib/ctws/json_web_token.rb

@@ -0,0 +1,25 @@
+module Ctws
+  class JsonWebToken
+    require 'jwt'
+    
+    # secret to encode and decode token
+    HMAC_SECRET = Rails.application.secrets.secret_key_base
+
+    def self.encode(payload, exp = Ctws.jwt_expiration_time)
+      # set expiry to 24 hours from creation time
+      payload[:exp] = exp.to_i
+      # sign token with application secret
+      JWT.encode(payload, HMAC_SECRET)
+    end
+
+    def self.decode(token)
+      # get payload; first index in decoded Array
+      body = JWT.decode(token, HMAC_SECRET)[0]
+      HashWithIndifferentAccess.new body
+      # rescue from expiry exception
+    rescue JWT::ExpiredSignature, JWT::VerificationError => e
+      # raise custom error to be handled by custom handler
+      raise Ctws::ExceptionHandler::ExpiredSignature, e.message
+    end
+  end
+end

data/app/lib/ctws/message.rb

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

data/app/mailers/ctws/application_mailer.rb

@@ -0,0 +1,6 @@
+module Ctws
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/ctws/application_record.rb

@@ -0,0 +1,5 @@
+module Ctws
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/ctws/min_app_version.rb

@@ -0,0 +1,22 @@
+module Ctws
+  class MinAppVersion < ApplicationRecord
+    validates_presence_of :codename, :description, :platform, :min_version, :store_uri
+  
+    def as_jsonapi(options={})
+      {
+        type: ActiveModel::Naming.param_key(self),
+        id: self.id,
+        attributes: {
+          codename: self.codename, 
+          description: self.description, 
+          min_version: self.min_version, 
+          platform: self.platform, 
+          store_uri: self.store_uri,
+          updated_at: self.updated_at
+        }
+      }
+    end
+  end
+  
+  
+end

data/config/initializers/ctws.rb

@@ -0,0 +1,5 @@
+Ctws.user_class = "User"
+Ctws.user_class_strong_params = %i(email password password_confirmation)
+Ctws.user_validate_with_password = true
+Ctws.jwt_expiration_time = 24.hours.from_now
+Ctws.jwt_auth_token_attrs = %i(id email) # TODO: implement

data/config/initializers/mime_types.rb

@@ -0,0 +1 @@
+Mime::Type.register "application/vnd.api+json", :json

data/config/routes.rb

@@ -0,0 +1,18 @@
+Ctws::Engine.routes.draw do
+  namespace :v1 do
+    resources :min_app_versions
+    get 'min_app_version', to: 'min_app_versions#min_app_version'
+    post 'signup', to: 'users#create'
+    post 'login', to: 'authentication#authenticate'
+  end
+  namespace :v2 do
+    # resources :min_app_versions
+    get 'min_app_version', to: 'min_app_versions#min_app_version'
+  end
+  
+  get '*unmatched_route', to: 'ctws#raise_not_found!'
+
+  # match '/', :to => 'base#raise_not_found!', via: :all
+  # match '*other', :to => 'base#raise_not_found!', via: :all
+
+end

data/db/migrate/20170425110839_create_ctws_min_app_versions.rb

@@ -0,0 +1,13 @@
+class CreateCtwsMinAppVersions < ActiveRecord::Migration[5.0]
+  def change
+    create_table :ctws_min_app_versions do |t|
+      t.string :codename
+      t.text :description
+      t.string :platform
+      t.string :min_version
+      t.string :store_uri
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20170425110933_add_values_to_ctws_min_app_versions.rb

@@ -0,0 +1,26 @@
+class AddValuesToCtwsMinAppVersions < ActiveRecord::Migration[5.0]
+  def up
+    min_app_version_ios = Ctws::MinAppVersion.create!({
+      codename: "First Release", 
+      description: "You need to update your app. You will be redirected to the corresponding store",
+      platform: "ios",
+      min_version: "0.0.1",
+      store_uri: "https://itunes.apple.com/"
+    })
+    
+    min_app_version_android = Ctws::MinAppVersion.create!({
+      codename: "First Release", 
+      description: "You need to update your app. You will be redirected to the corresponding store",
+      platform: "android",
+      min_version: "0.0.1",
+      store_uri: "https://play.google.com"
+    })
+  end
+
+  def down
+    min_app_version_ios = Ctws::MinAppVersion.find_by_min_version( "0.0.1" )
+    min_app_version_ios.destroy
+    min_app_version_android = Ctws::MinAppVersion.find_by_min_version( "0.0.1" )
+    min_app_version_android.destroy       
+  end
+end

data/lib/ctws/engine.rb

@@ -0,0 +1,13 @@
+module Ctws
+  class Engine < ::Rails::Engine
+    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'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/ctws/version.rb

@@ -0,0 +1,3 @@
+module Ctws
+  VERSION = '0.1.5.alpha'
+end

data/lib/ctws.rb

@@ -0,0 +1,18 @@
+require "ctws/engine"
+
+module Ctws
+  mattr_accessor :user_class
+  mattr_accessor :user_class_strong_params
+  mattr_accessor :user_validate_with_password
+  mattr_accessor :jwt_expiration_time
+  mattr_accessor :jwt_auth_token_attrs
+
+  def self.user_class
+    @@user_class.constantize
+  end
+  
+  def self.jwt_auth_token_attrs
+    # TODO: implement
+    @@jwt_auth_token_attrs
+  end
+end

data/lib/tasks/ctws_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ctws do
+#   # Task goes here
+# end

data/spec/auth/ctws/authenticate_user_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+
+module Ctws
+  RSpec.describe AuthenticateUser, class: 'Ctws::AuthenticateUser' do
+    # create test user
+    let(:ctws_user) { create(:ctws_user) }
+    # valid request subject
+    subject(:valid_auth_obj) { described_class.new(ctws_user.email, ctws_user.password) }
+    # invalid request subject
+    subject(:invalid_auth_obj) { described_class.new('foo', 'bar') }
+    
+    # Test suite for AuthenticateUser#call
+    describe '#call' do
+      # return token when valid request
+      context 'when valid credentials' do
+        it 'returns an auth token' do
+          token = valid_auth_obj.call
+          expect(token).not_to be_nil
+        end
+      end
+      
+      # raise Authentication Error when invalid request
+      context 'when invalid credentials' do
+        it 'raises an authentication error' do
+          expect { invalid_auth_obj.call }
+          .to raise_error(
+          Ctws::ExceptionHandler::AuthenticationError,
+          /Invalid credentials/
+          )
+        end
+      end
+    end
+  end
+end

data/spec/auth/ctws/authorize_api_request_spec.rb

@@ -0,0 +1,62 @@
+require 'rails_helper'
+
+module Ctws
+  RSpec.describe AuthorizeApiRequest, class: 'Ctws::AuthorizeApiRequest' do
+    # Create test user
+    let(:ctws_user) { create(:ctws_user) }
+    
+    # Mock `Authorization` header
+    let(:header) { { 'Authorization' => token_generator(ctws_user.id) } }
+    # Invalid request subject
+    subject(:invalid_request_obj) { described_class.new({}) }
+    # Valid request subject
+    subject(:request_obj) { described_class.new(header) }
+
+    # Test Suite for AuthorizeApiRequest#call
+    # This is our entry point into the service class
+    describe '#call' do
+      # returns user object when request is valid
+      context 'when valid request' do
+        it 'returns user object' do
+          result = request_obj.call
+          expect(result[:user]).to eq(ctws_user)
+        end
+      end
+
+      # returns error message when invalid request
+      context 'when invalid request' do
+        context 'when missing token' do
+          it 'raises a MissingToken error' do
+            expect { invalid_request_obj.call }
+              .to raise_error(Ctws::ExceptionHandler::MissingToken, 'Missing token')
+          end
+        end
+
+        context 'when invalid token' do
+          subject(:invalid_request_obj) do
+            # custom helper method `token_generator`
+            described_class.new('Authorization' => token_generator(5))
+          end
+
+          it 'raises an InvalidToken error' do
+            expect { invalid_request_obj.call }
+              .to raise_error(Ctws::ExceptionHandler::InvalidToken, /Invalid token/)
+          end
+        end
+
+        context 'when token is expired' do
+          let(:header) { { 'Authorization' => expired_token_generator(ctws_user.id) } }
+          subject(:request_obj) { described_class.new(header) }
+
+          it 'raises ExceptionHandler::ExpiredSignature error' do
+            expect { request_obj.call }
+              .to raise_error(
+                Ctws::ExceptionHandler::ExpiredSignature,
+                /Signature has expired/
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/controllers/ctws/ctws_controller_spec.rb

@@ -0,0 +1,41 @@
+require 'rails_helper'
+
+module Ctws
+  RSpec.describe CtwsController, type: :controller do
+    # create test ctws_user
+    let!(:ctws_user) { create(:ctws_user) }
+    # set headers for authorization
+    let(:headers) { { 'Authorization' => token_generator(ctws_user.id) } }
+    let(:invalid_headers) { { 'Authorization' => nil } }
+    
+    describe "authorize_request" do
+      context "when auth token is passed" do
+        before { allow(request).to receive(:headers).and_return(headers) }
+        
+        # private method authorize_request returns current ctws_user
+        it "sets the current ctws_user" do
+          expect(subject.instance_eval { authorize_request }).to eq(ctws_user)
+        end
+      end
+      
+      context "when auth token is not passed" do
+        before do
+          allow(request).to receive(:headers).and_return(invalid_headers)
+        end
+        
+        it "raises MissingToken error" do
+          expect { subject.instance_eval { authorize_request } }.
+          to raise_error(Ctws::ExceptionHandler::MissingToken, /Missing token/)
+        end
+      end
+    end
+    describe "routes" do
+      context "when route is not found" do
+        xit "returns 404" do
+          to raise_error(Ctws::ExceptionHandler::RoutingError, /No route matches/)
+        end
+      end
+    end
+  end
+end
+

data/spec/controllers/ctws/users_controller_spec.rb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+module Ctws
+  RSpec.describe UsersController, type: :controller do
+
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link ctws_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/user_controller.rb

@@ -0,0 +1,18 @@
+class UserController < ApplicationController
+=begin
+  def create
+    # We use Active Record's create! method so that in the event there's an error, 
+    # an exception will be raised and handled in the exception handler.
+    ctws_user = Ctws.user_class.create!(ctws_user_params)
+    auth_token = Ctws::AuthenticateUser.new(ctws_user.email, ctws_user.password).call
+    response = { message: Ctws::Message.account_created, auth_token: auth_token }
+    json_response(response, :created)
+  end
+  
+  private
+  
+  def ctws_user_params
+    params.permit(:email, :password, :password_confirmation)
+  end
+=end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/helpers/user_helper.rb

@@ -0,0 +1,2 @@
+module UserHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,4 @@
+class User < ApplicationRecord
+  has_secure_password
+  validates_presence_of :email, :password_digest
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end