forced 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15dfa1cdf12965aa435d5a421e2e02feefc72bdd
-  data.tar.gz: e923d04a3b5c36f1b15d4a7e78ad162cb6b45bb9
+  metadata.gz: 16c4c3bfcdfca6854aff43e3155e3e34102b36dc
+  data.tar.gz: a1157c7f545af0f270bf9a7c669f929884c82552
 SHA512:
-  metadata.gz: 79a13fc074436dc5f2ab88fab77258438dfd9aa5f07e516da6cecc61a44d8da0edb52a941d4caa5eeb68f70fc88118625000bcc237ec08fe32cc73921591dd5d
-  data.tar.gz: 2be9b20179a649fe225f0c4a16b92dd15dc7c7c63e6fb2eb03f777f54f2fd2101eabc04c993192d7870f3f82d4a146610c24e6ee3bc4385fda72b3148c00e6a6
+  metadata.gz: 64b4a7a5081e2288eb4019eb5e83e14a94eab16d52147a5fe5b07871006e93fe089efa382f8bb5d4b45a89865cda3903f03217c34414cb1de5263a2a5c76b233
+  data.tar.gz: 8d1fbe32b4928fcff4d93c12c4092b1a7589413125e935aa3e96256f8f888fdca53f1f11d88c08c8703cf8b2c89e6e0ed3bf0e85d2e07f486f5869bdf4c8ed01

data/README.md

@@ -42,7 +42,7 @@ You endpoint and tables are set!
 
 ## Usage
 
-If you want a parent for your `Forced::Client` records, you can add the desired parent model `is_versionable`. Beware that both `Forced::Client` to `Forced::Version` relation and `is_versionable` to `Forced::Client` relation are set to `dependent: :destroy`.
+If you want a parent for your `Forced::Client` records, you can add `is_versionable` to the desired parent model. Beware that both `Forced::Client` to `Forced::Version` relation and `is_versionable` to `Forced::Client` relation are set to `dependent: :destroy`.
 
 The `Forced::Client`'s polymorphic relation is optional as well. So, you can use the gem without setting a parent class relation. It'll work exactly the same.
 
@@ -67,7 +67,7 @@ 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'"
+# => "SELECT "forced_clients".* FROM "forced_clients" WHERE "forced_clients"."owner_id" = :id AND "forced_clients"."owner_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.
@@ -91,11 +91,31 @@ If you want to return some version of this hash, you can access the response by
 response = Forced::Response.call(request)
 ```
 
-To create a record, you can use your Rails console. `Forced::Client` is polymorphic and keeps `foreign_key` and `foreign_type` columns as `item_#`. So, when you are creating a `Forced::Client` instance, use `item:` for your reference column, e.g. `Forced::Client.create(item: Brand.first)`
+To change the default response from the mounted endpoint, create a `StatusController` like below.
+
+```ruby
+# In order this to work,
+# you need to create this file in the correct path,
+# that is;
+#
+# app/controllers/forced/status_controller.rb
+
+module Forced
+  class StatusController < ::ApplicationController
+    def index
+      response = Forced::Response.call(request)
+
+      # Do what you want to do with the response hash.
+    end
+  end
+end
+```
+
+To create a record, you can use your Rails console. `Forced::Client` is polymorphic and keeps `foreign_key` and `foreign_type` columns as `owner_#`. So, when you are creating a `Forced::Client` instance, use `owner:` for your reference column, e.g. `Forced::Client.create(owner: Brand.first)`
 
 ```ruby
 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::Client id: nil, owner_type: nil, owner_id: nil, identifier: nil, deleted_at: 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>
@@ -105,7 +125,7 @@ Forced::Version.new
 
 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
+## Upgrading from 0.2.0 to 1.2.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.
 

data/app/models/forced/client.rb

@@ -3,8 +3,8 @@
 # Table name: forced_clients
 #
 #  id         :integer          not null, primary key
-#  item_type  :string
-#  item_id    :integer
+#  owner_type :string
+#  owner_id   :integer
 #  identifier :string
 #  deleted_at :datetime
 #  created_at :datetime         not null
@@ -13,7 +13,7 @@
 
 module Forced
   class Client < ApplicationRecord
-    belongs_to :item, polymorphic: true, optional: true
+    belongs_to :owner, polymorphic: true, optional: true
 
     has_many :versions, class_name: 'Forced::Version', foreign_key: 'client_id', dependent: :destroy
   end

data/lib/forced/version.rb

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

data/lib/forced/versionable.rb

@@ -3,7 +3,7 @@ module Forced
     extend ActiveSupport::Concern
 
     included do
-      has_many :clients, class_name: 'Forced::Client', as: :item, dependent: :destroy
+      has_many :clients, class_name: 'Forced::Client', as: :owner, dependent: :destroy
     end
   end
 end

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

@@ -4,7 +4,7 @@
 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.references :owner, polymorphic: true, index: true
       t.string :identifier, index: { unique: true }
       t.datetime :deleted_at
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forced
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - aoozdemir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-07 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails