forced 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1b62f3102ad7c3f39bfb99d9b7ea2cec3873f29
+  data.tar.gz: cabafaba97d16fc8191b4971bb972684ca887cc8
+SHA512:
+  metadata.gz: f5716bc3e260313d6db7d072a917fad99fd7ecd2f1c0578ae6fcf03eb9a88de8428d1c522b0cc30432517a08b0cfc1b5371513526b4533e071c1f1ee25c49255
+  data.tar.gz: 8dd67dc2a93046387c8de356db7038e512533755ec9498e6d01c456862dfbabfd2cd1c29d8ec9058379e4ec2510e13efaa00f4723b66f4cacc27f2223c6724d1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 aoozdemir
+
+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 @@
+# Forced
+
+This plugin is for Rails APIs that supports multiple mobile applications and want to force an update to those applications.
+
+Read the link below to get some insight.
+
+* [Handling Force Update on Mobile Apps / Rusty Neuron](https://rustyneuron.net/2018/07/12/handling-force-update-on-mobile-apps/)
+
+## Usage
+
+Module needs to get the coming request to prepare the response. As long as request headers contains `X-Platform` and `X-Client-Version`, you are good to go.
+
+After adding `forced` to your Gemfile, add the line below to your routes file.
+
+```ruby
+mount Forced::Engine => "/forced"
+```
+
+Then send a `GET` request to `{{url}}/forced/status`. This will return the below JSON.
+
+```json
+{
+    "update": "force_update",
+    "latest_version": "1.0.0",
+    "current_time": "2018-07-13T16:28:22.829Z"
+}
+```
+
+If you want to return some version of this hash, you can access the response by calling the `Response.call(request)` method. See below.
+
+```ruby
+response = Forced::Response.call(request)
+```
+
+Client enum is `[:android, :ios]` at default. To change it, open up an initializer for `Forced` module and change the constant named `CLIENT_ENUM`.
+
+```ruby
+module Forced
+  CLIENT_ENUM = [:android, :ios]
+end
+```
+
+To create a record, you can use your Rails console.
+
+```ruby
+Forced::AppVersion.new
+
+# => #<Forced::AppVersion id: nil, client: nil, version: nil, force_update: false, changelog: nil, created_at: nil, updated_at: nil>
+```
+
+## Responses
+
+All available under `Forced::MESSAGES` hash table. You can override the values as you wish. Also checkout the `check_update_status` private method in `base.rb` to understand the cases.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forced'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install forced
+```
+
+## 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,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Forced'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/forced_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/forced .js
+//= link_directory ../stylesheets/forced .css

data/app/assets/javascripts/forced/application.js

@@ -0,0 +1,15 @@
+// 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 rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/forced/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/app/controllers/forced/application_controller.rb

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

data/app/controllers/forced/status_controller.rb

@@ -0,0 +1,9 @@
+module Forced
+  class StatusController < ApplicationController
+    def index
+      response = Forced::Response.call(request)
+
+      render json: response
+    end
+  end
+end

data/app/helpers/forced/application_helper.rb

@@ -0,0 +1,4 @@
+module Forced
+  module ApplicationHelper
+  end
+end

data/app/jobs/forced/application_job.rb

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

data/app/mailers/forced/application_mailer.rb

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

data/app/models/forced/app_version.rb

@@ -0,0 +1,21 @@
+# == Schema Information
+#
+# Table name: forced_app_versions
+#
+#  id           :integer          not null, primary key
+#  client       :integer
+#  version      :string(255)
+#  force_update :boolean          default(FALSE)
+#  changelog    :text
+#  created_at   :datetime         not null
+#  updated_at   :datetime         not null
+#
+
+module Forced
+  class AppVersion < ApplicationRecord
+    enum client: Forced::CLIENT_ENUM
+
+    validates :client, presence: true
+    validates :version, presence: true, length: { maximum: 255 }
+  end
+end

data/app/models/forced/application_record.rb

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

data/app/views/layouts/forced/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Forced</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "forced/application", media: "all" %>
+  <%= javascript_include_tag "forced/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Forced::Engine.routes.draw do
+  get :status, to: 'status#index'
+end

data/db/migrate/20180713160038_create_forced_app_versions.rb

@@ -0,0 +1,12 @@
+class CreateForcedAppVersions < ActiveRecord::Migration[5.2]
+  def change
+    create_table :forced_app_versions do |t|
+      t.integer :client
+      t.string :version, limit: 255
+      t.boolean :force_update, nil: false, default: false
+      t.text :changelog
+
+      t.timestamps
+    end
+  end
+end

data/lib/forced.rb

@@ -0,0 +1,8 @@
+require 'forced/engine'
+require 'forced/base'
+require 'forced/response'
+require 'forced/client_enum'
+require 'forced/messages'
+
+module Forced
+end

data/lib/forced/base.rb

@@ -0,0 +1,47 @@
+module Forced
+  class Base
+    class << self
+      def get_records(request)
+        @client_platform = get_client_platform(request)
+        @client_version = get_client_version(request)
+
+        @client_version_records = (@client_platform && @client_version ? Forced::AppVersion.where(client: @client_platform) : nil)
+        @versions_after_client = @client_version_records&.where('version > ?', @client_version)
+        @latest_app_version = @client_version_records&.last
+        @any_forced_in_the_future = @versions_after_client&.pluck(:force_update)&.any?
+      end
+
+      private
+
+      def get_client_platform(request)
+        return request.headers['X-Platform'].to_s.downcase
+      end
+
+      def get_client_version(request)
+        return request.headers['X-Client-Version']
+      end
+
+      def check_update_status(client_version, latest_app_version, any_forced_in_the_future)
+        nil_report = []
+        nil_report << MESSAGES[:app_version_returned_nil] if latest_app_version.nil?
+        nil_report << MESSAGES[:client_version_returned_nil] if client_version.nil?
+
+        return nil_report.join(', ') if !nil_report.empty?
+
+        client_v = Gem::Version.new(client_version)
+        latest_v = Gem::Version.new(latest_app_version.version)
+
+        case
+        when client_v == latest_v
+          return MESSAGES[:no_update]
+        when client_v < latest_v
+          any_forced_in_the_future ? MESSAGES[:force_update] : MESSAGES[:just_update]
+        when client_v > latest_v
+          return MESSAGES[:client_is_ahead_of_backend]
+        else
+          return MESSAGES[:something_went_wrong]
+        end
+      end
+    end
+  end
+end

data/lib/forced/client_enum.rb

@@ -0,0 +1,3 @@
+module Forced
+  CLIENT_ENUM = [:android, :ios]
+end

data/lib/forced/engine.rb

@@ -0,0 +1,14 @@
+module Forced
+  class Engine < ::Rails::Engine
+    isolate_namespace Forced
+
+    # import engine's migratons into main app
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/forced/messages.rb

@@ -0,0 +1,11 @@
+module Forced
+  MESSAGES = {
+    app_version_returned_nil: :app_version_returned_nil,
+    client_version_returned_nil: :client_version_returned_nil,
+    no_update: :no_update,
+    force_update: :force_update,
+    just_update: :just_update,
+    client_is_ahead_of_backend: :client_is_ahead_of_backend,
+    something_went_wrong: :something_went_wrong
+  }
+end

data/lib/forced/response.rb

@@ -0,0 +1,15 @@
+module Forced
+  class Response < Base
+    class << self
+      def call(request)
+        get_records(request)
+
+        return status = {
+          update: check_update_status(@client_version, @latest_app_version, @any_forced_in_the_future),
+          latest_version: @latest_app_version&.version,
+          current_time: Time.zone.now
+        }
+      end
+    end
+  end
+end

data/lib/forced/version.rb

@@ -0,0 +1,8 @@
+module Forced
+  MAJOR = 0
+  MINOR = 1
+  TINY  = 0
+  PRE   = nil
+
+  VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.').freeze
+end

data/lib/tasks/forced_tasks.rake

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: forced
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aoozdemir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: annotate
+  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'
+description: Easy force update control for APIs that support mobile clients.
+email:
+- aoozdemir@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/forced_manifest.js
+- app/assets/javascripts/forced/application.js
+- app/assets/stylesheets/forced/application.css
+- app/controllers/forced/application_controller.rb
+- app/controllers/forced/status_controller.rb
+- app/helpers/forced/application_helper.rb
+- app/jobs/forced/application_job.rb
+- app/mailers/forced/application_mailer.rb
+- app/models/forced/app_version.rb
+- app/models/forced/application_record.rb
+- app/views/layouts/forced/application.html.erb
+- config/routes.rb
+- db/migrate/20180713160038_create_forced_app_versions.rb
+- lib/forced.rb
+- lib/forced/base.rb
+- lib/forced/client_enum.rb
+- lib/forced/engine.rb
+- lib/forced/messages.rb
+- lib/forced/response.rb
+- lib/forced/version.rb
+- lib/tasks/forced_tasks.rake
+homepage: https://github.com/aoozdemir/forced
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Easy force update control for Rails APIs that support mobile clients.
+test_files: []