pixelforce_kit 0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9eb1ebeb58e607f988a36ba20788d1ac6bbfee708f7e73b720118ada30e8b63c
+  data.tar.gz: 3c8ae485b66fecb9adba79cc32138e3405950964211877c50af53171b0e4e472
+SHA512:
+  metadata.gz: a620fe8c8ed32557b758d1ae6650ae106dfc4d244dd683adda8183ab52bec458d8c5406ffb41c567bcce34b7013c3e5e6df3d387f55891e7ee68179791d91d11
+  data.tar.gz: a14632e7c4d665f82dafcdd3c812ca6e2d891fda01488ada1635dcefd9efdb87d7e243c0fa048dc2ebd599d53799a9aec2d4a4697e13d9d699ebc8439af276a6

data/.gitignore

@@ -0,0 +1,2 @@
+/pkg
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pixelforce_kit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,299 @@
+PATH
+  remote: .
+  specs:
+    pixelforce_kit (0.9)
+      ahoy_matey
+      capistrano (> 3.0.0)
+      devise
+      devise_token_auth
+      elbas
+      jbuilder
+      kaminari
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.5)
+      actionpack (= 7.1.5)
+      activesupport (= 7.1.5)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.5)
+      actionpack (= 7.1.5)
+      activejob (= 7.1.5)
+      activerecord (= 7.1.5)
+      activestorage (= 7.1.5)
+      activesupport (= 7.1.5)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.5)
+      actionpack (= 7.1.5)
+      actionview (= 7.1.5)
+      activejob (= 7.1.5)
+      activesupport (= 7.1.5)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.5)
+      actionview (= 7.1.5)
+      activesupport (= 7.1.5)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.5)
+      actionpack (= 7.1.5)
+      activerecord (= 7.1.5)
+      activestorage (= 7.1.5)
+      activesupport (= 7.1.5)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.5)
+      activesupport (= 7.1.5)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.5)
+      activesupport (= 7.1.5)
+      globalid (>= 0.3.6)
+    activemodel (7.1.5)
+      activesupport (= 7.1.5)
+    activerecord (7.1.5)
+      activemodel (= 7.1.5)
+      activesupport (= 7.1.5)
+      timeout (>= 0.4.0)
+    activestorage (7.1.5)
+      actionpack (= 7.1.5)
+      activejob (= 7.1.5)
+      activerecord (= 7.1.5)
+      activesupport (= 7.1.5)
+      marcel (~> 1.0)
+    activesupport (7.1.5)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      mutex_m
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0)
+    ahoy_matey (5.2.1)
+      activesupport (>= 6.1)
+      device_detector (>= 1)
+      safely_block (>= 0.4)
+    airbrussh (1.5.3)
+      sshkit (>= 1.6.1, != 1.7.0)
+    aws-eventstream (1.3.0)
+    aws-partitions (1.999.0)
+    aws-sdk-autoscaling (1.123.0)
+      aws-sdk-core (~> 3, >= 3.210.0)
+      aws-sigv4 (~> 1.5)
+    aws-sdk-core (3.211.0)
+      aws-eventstream (~> 1, >= 1.3.0)
+      aws-partitions (~> 1, >= 1.992.0)
+      aws-sigv4 (~> 1.9)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-ec2 (1.486.0)
+      aws-sdk-core (~> 3, >= 3.210.0)
+      aws-sigv4 (~> 1.5)
+    aws-sigv4 (1.10.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+    base64 (0.2.0)
+    bcrypt (3.1.20)
+    benchmark (0.3.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    capistrano (3.19.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
+    device_detector (1.1.3)
+    devise (4.9.4)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0)
+      responders
+      warden (~> 1.2.3)
+    devise_token_auth (1.2.4)
+      bcrypt (~> 3.0)
+      devise (> 3.5.2, < 5)
+      rails (>= 4.2.0, < 7.3)
+    diff-lcs (1.2.5)
+    drb (2.2.1)
+    elbas (3.0.4)
+      aws-sdk-autoscaling (~> 1)
+      aws-sdk-ec2 (~> 1)
+      capistrano (> 3)
+    erubi (1.13.0)
+    faker (3.4.2)
+      i18n (>= 1.8.11, < 2)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.14.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    jbuilder (2.13.0)
+      actionview (>= 5.0.0)
+      activesupport (>= 5.0.0)
+    jmespath (1.6.2)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    logger (1.6.1)
+    loofah (2.23.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.7)
+    minitest (5.25.1)
+    mutex_m (0.2.0)
+    net-imap (0.4.17)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-scp (4.0.0)
+      net-ssh (>= 2.6.5, < 8.0.0)
+    net-sftp (4.0.0)
+      net-ssh (>= 5.0.0, < 8.0.0)
+    net-smtp (0.5.0)
+      net-protocol
+    net-ssh (7.3.0)
+    nio4r (2.7.4)
+    nokogiri (1.16.7)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    orm_adapter (0.5.0)
+    ostruct (0.6.0)
+    psych (5.1.2)
+      stringio
+    racc (1.8.1)
+    rack (3.1.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.5)
+      actioncable (= 7.1.5)
+      actionmailbox (= 7.1.5)
+      actionmailer (= 7.1.5)
+      actionpack (= 7.1.5)
+      actiontext (= 7.1.5)
+      actionview (= 7.1.5)
+      activejob (= 7.1.5)
+      activemodel (= 7.1.5)
+      activerecord (= 7.1.5)
+      activestorage (= 7.1.5)
+      activesupport (= 7.1.5)
+      bundler (>= 1.15.0)
+      railties (= 7.1.5)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.5)
+      actionpack (= 7.1.5)
+      activesupport (= 7.1.5)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rake (13.0.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    reline (0.5.10)
+      io-console (~> 0.5)
+    responders (3.1.1)
+      actionpack (>= 5.2)
+      railties (>= 5.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safely_block (0.4.1)
+    securerandom (0.3.1)
+    sshkit (1.23.2)
+      base64
+      net-scp (>= 1.1.2)
+      net-sftp (>= 2.1.2)
+      net-ssh (>= 2.8.0)
+      ostruct
+    stringio (3.1.1)
+    thor (1.3.2)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    warden (1.2.9)
+      rack (>= 2.0.9)
+    webrick (1.8.2)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  faker
+  pixelforce_kit!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.33

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 BenZhang
+
+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,73 @@
+# Pixelforce Kit
+
+Pixelforce Kit implements 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pixelforce_kit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pixelforce_kit
+
+## Usage
+add below code to deploy.rb
+```ruby
+require 'pixelforce_kit'
+```
+
+## 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]/pixelforce_kit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## supervisor support
+
+The recipes for capistrano3 with supervisor support.   
+Please use `process:supervisor:task` to invoke it.   
+They relied on some capistrano plugins for some variables
+
+* [**rvm**](https://github.com/capistrano/rvm) for `rvm_ruby_version`
+
+Tweak some option for supervisor, the following value is default
+
+```ruby
+set :autostart, 'true'
+set :autorestart, 'true'
+set :logfile_maxbytes, '1GB'
+set :logfile_backups, '10'
+```
+
+#### unicorn
+
+Relied on unicornherder for supervisor monitoring.
+
+#### puma
+
+Get rid of capistrano-puma, and now generate puma config itself.
+
+```ruby
+set :puma_threads, [0, 1]
+set :puma_workers, 2
+```
+
+## sysvinit support
+
+Please use `process:sysvinit:task` to invoke it.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/app/controllers/admin/api/admin_base_controller.rb

@@ -0,0 +1,116 @@
+require 'csv'
+
+module Admin
+  module Api
+    class AdminBaseController < ApplicationController
+      include DeviseTokenAuth::Concerns::SetUserByToken
+      include ResponseHandler
+      include RequestHeaderHandler
+      include ExceptionHandler
+
+      layout false
+
+      before_action :authenticate_admin_user!
+      before_action :format_params
+      before_action :prepare_pagination_params
+      after_action :track_admin_request
+
+      def authenticate_admin_user!
+        authenticate_admin_api_admin_user!
+      end
+
+      def current_admin_user
+        current_admin_api_admin_user
+      end
+
+      def log_target
+        @log_target
+      end
+
+      def admin_action_on_user_id
+        @admin_action_on_user_id = if log_target.present?
+          if log_target.is_a?(User)
+            log_target.id
+          else
+            log_target.user_id
+          end
+        end
+      end
+
+      def render_error(status, message, errors = nil, source: nil, meta: {})
+        super(status, message, errors, source: source, meta: meta, admin_server_error: true)
+      end
+
+      private
+
+      def track_admin_request
+        unless params[:action] == 'index' || params[:action] == 'show'
+          ahoy.track 'AdminLog', {
+            params:   request.filtered_parameters,
+            url:      request.original_url,
+            response: response.status
+          }
+        end
+      end
+
+      def set_response_format
+        if request.format.to_s != 'text/csv'
+          request.format = :json
+          self.content_type = 'application/json'
+        end
+      end
+
+      def pagination_headers(collection, item_name)
+        headers['Content-Range'] = "#{item_name} #{collection.offset_value}-#{collection.offset_value + collection.limit_value - 1}/#{collection.total_count}"
+        headers['Access-Control-Expose-Headers'] = 'Content-Range'
+      end
+
+      def pagination_headers_for_dropdown(item_name)
+        headers['Content-Range'] = "#{item_name} 0-999/1000"
+        headers['Access-Control-Expose-Headers'] = 'Content-Range'
+      end
+
+      def default_per_page
+        10
+      end
+
+      def keywords
+        keyword = params[:filter].try(:[], :keyword)
+        if keyword.present?
+          @keywords = keyword.split(/,|  */).reject(&:blank?).map { |value| "%#{value.strip}%" }
+        else
+          []
+        end
+      end
+
+      def export_resource_csv(resources, headers)
+        resources = resources.except(:limit, :offset)
+        table_name = resources.table_name
+        csv_data = CSV.generate(headers: true) do |csv|
+          csv << headers.map(&:titleize)
+          resources.find_each do |resource|
+            csv << headers.map { |header| resource.send(header.parameterize.to_sym) }
+          end
+        end
+        send_data csv_data, filename: "#{table_name}-#{Date.today}.csv"
+      end
+
+      def prepare_pagination_params
+        if params[:range].present? && params[:range].is_a?(Array) && params[:range].length == 2
+          beginning_offset = params[:range][0].to_i
+          end_offset = params[:range][1].to_i
+          per_page = end_offset - beginning_offset + 1
+          params[:perPage] = per_page
+          params[:page] = (beginning_offset / per_page) + 1
+        end
+      end
+
+      def format_params
+        if request.method_symbol == :get
+          params[:filter] = ActionController::Parameters.new(JSON.parse(params[:filter])) if params[:filter].present? && params[:filter].is_a?(String)
+          params[:range] = JSON.parse(params[:range]) if params[:range].present? && params[:range].is_a?(String)
+        end
+      end
+    end
+  end
+end

data/app/controllers/admin/api/app_versions_controller.rb

@@ -0,0 +1,26 @@
+module Admin
+  module Api
+    class AppVersionsController < Admin::Api::AdminBaseController
+      def show
+        app_version = AppVersion.last
+        app_version ||= AppVersion.create!
+        render json: app_version.as_json(only: %i[id ios_minimum_version_number android_minimum_version_number])
+      end
+
+      def update
+        app_version = AppVersion.find(params[:id])
+        if app_version.update(app_version_params)
+          render json: app_version.as_json(only: %i[id ios_minimum_version_number android_minimum_version_number])
+        else
+          render_error(400, nil, app_version.errors)
+        end
+      end
+
+      private
+
+      def app_version_params
+        params.permit(:ios_minimum_version_number, :android_minimum_version_number)
+      end
+    end
+  end
+end

data/app/controllers/admin/api/available_modules_controller.rb

@@ -0,0 +1,20 @@
+module Admin
+  module Api
+    class AvailableModulesController < AdminBaseController
+      def index
+        render json: [
+          {
+            "id":   1,
+            "name": 'Dashboard',
+            "path": '/dashboard'
+          },
+          {
+            "id":   2,
+            "name": 'Users',
+            "path": '/users'
+          }
+        ]
+      end
+    end
+  end
+end

data/app/controllers/api/base_controller.rb

@@ -0,0 +1,82 @@
+module Api
+  class BaseController < ApplicationController
+    include DeviseTokenAuth::Concerns::SetUserByToken
+    include ResponseHandler
+    include RequestHeaderHandler
+    include ExceptionHandler
+
+    protect_from_forgery with: :null_session
+
+    before_action :authenticate_user!
+    before_action :minimum_version_check!
+    before_action :set_user_timezone
+    before_action :create_user_devices!
+
+    after_action :track_request
+
+    def render_authenticate_error
+      return render json: {
+        errors: { 
+          server: [I18n.t('devise.failure.unauthenticated')]
+        }
+      }, status: 401
+    end
+
+    private
+
+    def create_user_devices!
+      if current_user.present? && device_headers[:device_token].present?
+        user_device = UserDevice.find_or_initialize_by(device_token: device_headers[:device_token])
+
+        if user_device.persisted? && user_device.user_id != current_user.id
+          user_device.destroy!
+          user_device = UserDevice.new(device_token: device_headers[:device_token])
+        end
+
+        user_device.user_id = current_user.id
+        user_device.app_version = device_headers[:app_version]
+        user_device.platform = device_headers[:platform]
+        user_device.device_model = device_headers[:device_model]
+        user_device.os_version = device_headers[:os_version]
+        user_device.app_build_version = device_headers[:app_build_version]
+        user_device.save!
+      end
+    end
+
+    def set_user_timezone
+      if user_timezone && current_user && current_user.timezone != user_timezone
+        current_user.update(timezone: user_timezone)
+      end
+    end
+
+    def user_timezone
+      @user_timezone ||= device_headers[:user_timezone]
+    end
+
+    def minimum_version_check!
+      app_version = device_headers[:app_version]
+      platform = device_headers[:platform]
+
+      if app_version.present? && platform.present?
+        current_app_version = AppVersion.order(id: :desc).first
+
+        if current_app_version.present?
+          minimum_version = current_app_version.minimum_version(platform)
+
+          if minimum_version.present? && Gem::Version.new(app_version) < Gem::Version.new(minimum_version)
+            render_error(426, I18n.t('api.errors.upgrade_app_version'))
+          end
+        end
+      end
+    end
+
+    def track_request
+      api_version = request.path.split('/')[2]
+      ahoy.track "ApiRequest::#{api_version}", {
+        params:   request.filtered_parameters,
+        url:      request.original_url,
+        response: response.status
+      }
+    end
+  end
+end

data/app/controllers/api/v1/health_check_controller.rb

@@ -0,0 +1,12 @@
+module Api
+  module V1
+    class HealthCheckController < Api::BaseController
+      skip_after_action :track_request
+      skip_before_action :authenticate_user!
+
+      def index
+        render_success
+      end
+    end
+  end
+end

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :null_session
+  skip_before_action :verify_authenticity_token, if: :json_request?
+
+  private
+
+  def json_request?
+    request.format.json?
+  end
+end

data/app/controllers/auth/passwords_controller.rb

@@ -0,0 +1,7 @@
+class Auth::PasswordsController < Devise::PasswordsController
+  protected
+
+  def after_resetting_password_path_for(_resource)
+    reset_password_success_path
+  end
+end