castle-rb 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5cc61c1968c76886ed79bcfdb8bcbe7a0b2e461
-  data.tar.gz: 61e68682c3a8189955c1ccd58eba566d07adc568
+  metadata.gz: da65c9def9b0ff8c49dc58216030b24656a4c73c
+  data.tar.gz: 7c8dacb82d986baf51a16adac10dc6cc86d3a909
 SHA512:
-  metadata.gz: f393006a3b3ad7826dd76dafd12a66f6f1999fc8f3f4e0de18cf71a10917d5c30a39a3d8c2a9397ee2445d448cf2705ad7f25c23ebfd00005a1383f1ff9f4a78
-  data.tar.gz: 1da76b1851dd486d928f02f96a0201dd314e55bd8ff610548c0019cd4d0b96deb723c65e73dad24eacef07528726239d98c4a951b0418fb1f5146bcf0ec656be
+  metadata.gz: 17364b5ee431f2b715708b19e495c96bcea331cc0c8b537aa0ad819d7ac71d746777f88555026772b2c4d107dc8c930912badf5733a3576fbdad9c3baa459d23
+  data.tar.gz: 8b1abb0fbee5840e9f8fb8e3a9b5cef3e1b217e2c2bc817e3e215d7aa73237f64eb57b9e375cada367672312b876b9c81e83b4696b2fb1d93b510d0af1295a7c

data/README.md

@@ -64,6 +64,24 @@ castle.track(
 
 - `$login`: The submitted email or username from when the user attempted to log in or reset their password. Useful when there is no `user_id` available.
 
+## Secure mode
+
+Avoid client-side spoofing by having your backend sign the user data with `secure_encode`.
+
+```erb
+_castle('setUser', '<%= Castle.secure_encode({
+  id: current_user.id,
+  email: current_user.email }) %>');
+```
+
+This will use your API Secret to encode the data into [JWT](http://jwt.io) format, for example:
+
+```javascript
+_castle('setUser', 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1...y4PCIXrz1Ejs');
+```
+
+**Important:** Make sure you enable **Secure mode** in the [Castle dashboard](https://dashboard.castle.io/settings/general).
+
 ## Configuration
 
 ```ruby

data/lib/castle.rb

@@ -30,6 +30,10 @@ end
 
 module Castle
   API = Castle.setup_api
+
+  def self.secure_encode(properties = {})
+    ::JWT.encode(properties, Castle.config.api_secret)
+  end
 end
 
 # These need to be required after setting up Her

data/lib/castle/version.rb

@@ -1,3 +1,3 @@
 module Castle
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: castle-rb
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Johan