forced 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24410ac9c0767e607034525d8168837dc87231bf
-  data.tar.gz: 1706c0b98edca3bc8b4e09779c829fdc74c07180
+  metadata.gz: 0f8bfe65c4245d7193e813ab666edea94a8d9bc4
+  data.tar.gz: 95c773c3051dee62f912d14cf00e6e6ca7628aa5
 SHA512:
-  metadata.gz: 16f9039bfcd3f53f2a91148d28f3c52f8363e2c735eca9e3d76ff9d2c4ca7ae5d2495313e6280d5e7eeb91ba39eb7f03525ba516158daecba4a9e2d723e25a49
-  data.tar.gz: 49b535a85af7581037e7db44d8dceaba655db7454e17a38f70c1f074cd0c7d61161d5a422f7540d78648dad963ba260f35411b68bc74cc125c84e4b75024fa10
+  metadata.gz: 1f10f544891d22c7b6c9f3eded67de2f93a87a0de60f87a9a908f39d5da7f5aade90af1a51e46f302b1e7777db21f9386d089018b2f2bfc252f75ce80b7dbcae
+  data.tar.gz: ef0fafa3cb75e9815fbc5291e118ff9254270f5b2cd038f7094c0df6a0a59c0827c90adfccde9ddf55e592a44a7bc488252304a400dead669c88a0f7d827530c

data/README.md

@@ -38,14 +38,40 @@ After all these are done, add the line below to your routes file.
 mount Forced::Engine => "/forced"
 ```
 
-You are all set!
+You endpoint and tables are set!
 
 ## 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.
+Add `is_versionable` to any model you want to keep as a parent for `Forced::Client` model.
 
+For example, imagine you have a `Brand` model to identify each application. Adding the line below to your model, will hold a relation for `has_many :clients'
 
-Then send a `GET` request to `{{url}}/forced/status`. This will return the below JSON.
+```ruby
+class Brand < ApplicationRecord
+  # ...
+
+  is_versionable
+
+  # ...
+end
+```
+
+Then, you can call your clients with;
+
+```ruby
+Brand.find(:id).clients
+# => #<ActiveRecord::Associations::CollectionProxy [...]>
+
+Brand.find(:id).clients.to_sql
+# => "SELECT \"forced_clients\".* FROM \"forced_clients\" WHERE \"forced_clients\".\"item_id\" = :id AND \"forced_clients\".\"item_type\" = 'Brand'"
+```
+
+The Forced 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.
+
+* `X-Platform` will need to match with `Forced::Client identifier:string` attribute in order to search the available versions.
+* `X-Client-Version` should contain a semantic version number, e.g. `1.0.0`
+
+Then send a `GET` request to `{{url}}/forced/status`. This will return the below JSON. (`/forced` is where you mounted the engine!)
 
 ```json
 {
@@ -61,25 +87,25 @@ If you want to return some version of this hash, you can access the response by
 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.
+To create a record, you can use your Rails console. `Forced::Client`
 
 ```ruby
-Forced::AppVersion.new
+Forced::Client.new
+# => #<Forced::Client id: nil, item_type: nil, item_id: nil, identifier: nil, deleted_at: nil, created_at: nil, updated_at: nil>
 
-# => #<Forced::AppVersion id: nil, client: nil, version: nil, force_update: false, changelog: nil, created_at: nil, updated_at: nil>
+Forced::Version.new
+# => #<Forced::Version id: nil, client_id: nil, version: nil, force_update: false, changelog: nil, deleted_at: 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.
 
+## Upgrading from 0.2.0 to 1.0.0
+
+New migrations and tables have a different name, so, unless you are using custom calls, you can optionally and gradually create a migration for old table and move your records into the new table.
+
+If you had some trouble or found something that wasn't suppose to be there, feel free to open an issue.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/models/forced/client.rb

@@ -0,0 +1,7 @@
+module Forced
+  class Client < ApplicationRecord
+    belongs_to :item, polymorphic: true
+
+    has_many :versions, class_name: 'Forced::Version', foreign_key: 'client_id'
+  end
+end

data/app/models/forced/version.rb

@@ -0,0 +1,7 @@
+module Forced
+  class Version < ApplicationRecord
+    belongs_to :client, class_name: 'Forced::Client'
+
+    validates :version, presence: true, length: { maximum: 255 }
+  end
+end

data/app/models/forced.rb

@@ -0,0 +1,5 @@
+module Forced
+  def self.table_name_prefix
+    'forced_'
+  end
+end

data/lib/forced/base.rb

@@ -5,7 +5,7 @@ module Forced
         @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)
+        @client_version_records = (@client_platform && @client_version ? Forced::Client.find_by!(identifier: @client_platform).versions : 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?

data/lib/forced/is_versionable.rb

@@ -0,0 +1,15 @@
+require 'forced/versionable'
+
+module Forced
+  module Model
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def is_versionable
+        send :include, Forced::Versionable
+      end
+    end
+  end
+end

data/lib/forced/version.rb

@@ -1,6 +1,6 @@
 module Forced
-  MAJOR = 0
-  MINOR = 2
+  MAJOR = 1
+  MINOR = 0
   TINY  = 0
   PRE   = nil
 

data/lib/forced/versionable.rb

@@ -0,0 +1,9 @@
+module Forced
+  module Versionable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :clients, class_name: 'Forced::Client', as: :item
+    end
+  end
+end

data/lib/forced.rb

@@ -1,8 +1,11 @@
 require 'forced/engine'
 require 'forced/base'
 require 'forced/response'
-require 'forced/client_enum'
 require 'forced/messages'
+require 'forced/is_versionable'
 
 module Forced
+  ActiveSupport.on_load(:active_record) do
+    include Forced::Model
+  end
 end

data/lib/generators/forced/install_generator.rb

@@ -14,10 +14,10 @@ module Forced
 
     source_root File.expand_path('templates', __dir__)
 
-    desc "Generates (but does not run) a migration to add a forced_app_versions table."
+    desc "Generates (but does not run) a migration to add a forced_app_clients and forced_app_versions table."
 
     def create_migration_file
-      add_paper_trail_migration('create_forced_app_versions')
+      add_forced_app_migration('create_forced_tables')
     end
 
     def self.next_migration_number(dirname)
@@ -26,7 +26,7 @@ module Forced
 
     protected
 
-    def add_paper_trail_migration(template)
+    def add_forced_app_migration(template)
       migration_dir = File.expand_path('db/migrate')
 
       if self.class.migration_exists?(migration_dir, template)
@@ -36,7 +36,7 @@ module Forced
           "#{template}.rb.erb",
           "db/migrate/#{template}.rb",
           migration_version: migration_version,
-          forced_app_versions_table_options: forced_app_versions_table_options
+          forced_table_options: forced_table_options
         )
       end
     end
@@ -54,7 +54,7 @@ module Forced
       MYSQL_ADAPTERS.include?(ActiveRecord::Base.connection.class.name)
     end
 
-    def forced_app_versions_table_options
+    def forced_table_options
       if mysql?
         ', { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }'
       else
@@ -62,4 +62,4 @@ module Forced
       end
     end
   end
-end
+end

data/lib/generators/forced/templates/create_forced_tables.rb.erb

@@ -0,0 +1,24 @@
+# This migration creates the `app_clients` and `app_versions` table,
+# which `forced` gem requires to run properly.
+
+class CreateForcedTables < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :forced_clients<%= forced_table_options %> do |t|
+      t.references :item, polymorphic: true, index: true
+      t.string :identifier, index: { unique: true }
+      t.datetime :deleted_at
+
+      t.timestamps
+    end
+
+    create_table :forced_versions<%= forced_table_options %> do |t|
+      t.references :client, foreign_key: { to_table: :forced_clients }
+      t.string :version, limit: 255
+      t.boolean :force_update, nil: false, default: false
+      t.text :changelog
+      t.datetime :deleted_at
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forced
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - aoozdemir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -64,18 +64,21 @@ files:
 - Rakefile
 - app/controllers/forced/application_controller.rb
 - app/controllers/forced/status_controller.rb
-- app/models/forced/app_version.rb
+- app/models/forced.rb
 - app/models/forced/application_record.rb
+- app/models/forced/client.rb
+- app/models/forced/version.rb
 - config/routes.rb
 - lib/forced.rb
 - lib/forced/base.rb
-- lib/forced/client_enum.rb
 - lib/forced/engine.rb
+- lib/forced/is_versionable.rb
 - lib/forced/messages.rb
 - lib/forced/response.rb
 - lib/forced/version.rb
+- lib/forced/versionable.rb
 - lib/generators/forced/install_generator.rb
-- lib/generators/forced/templates/create_forced_app_versions.rb.erb
+- lib/generators/forced/templates/create_forced_tables.rb.erb
 - lib/tasks/forced_tasks.rake
 homepage: https://github.com/aoozdemir/forced
 licenses:

data/app/models/forced/app_version.rb

@@ -1,21 +0,0 @@
-# == 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/lib/forced/client_enum.rb

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

data/lib/generators/forced/templates/create_forced_app_versions.rb.erb

@@ -1,15 +0,0 @@
-# This migration creates the `app_versions` table, the only schema PT requires.
-# All other migrations PT provides are optional.
-class CreateForcedAppVersions < ActiveRecord::Migration<%= migration_version %>
-
-  def change
-    create_table :forced_app_versions<%= forced_app_versions_table_options %> 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