castle-rb 1.2.11 → 1.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba0f2b39431a260b85e4466f76901325b5c23726
-  data.tar.gz: c08ad55dd0965329595500f61b309dade6be0448
+  metadata.gz: 31540e9160fdebfa32408ff4eb628d66735a44a9
+  data.tar.gz: 86de8e3b76a4cfe72541a9932081bd42af13ab1e
 SHA512:
-  metadata.gz: f1fd3a088e41699773103700b66f76f5db17f659f0b125a7c855461f06dee6c914781bab11564724b0b3a9cfd81a92817dd71ec8210f8218046cba1bc67962c1
-  data.tar.gz: 24b821b597b5d660c33ae72b7e0a04419be415d8c7d15aa6c55f9d7ad5187edc5f34c1e035f36d5b8c772de5996593c20a43f04e4e770f136fdc888d53813ed6
+  metadata.gz: 296f0c509c04e4f671ec62dac7329b972d494342437247875bcf76cacdf0e27c5f04da61017bcfadc18b8f98898423f0b807fcd35eb1f2af4187d0ead6506a0f
+  data.tar.gz: 063acc0eb147a34c4b37a0fd3b3e69cbd52f3ed79bd5c80babb2f5ed28d7278be451e7a8162500f2b42d5df98b270923f8cd0bf611d9ef93a80170fa608160c2

data/README.md

@@ -21,72 +21,11 @@ Load and configure the library with your Castle API secret in an initializer or
 Castle.api_secret = 'YOUR_API_SECRET'
 ```
 
-A Castle client instance will automatically be made available as `castle` in your Rails, Sinatra or Padrino controllers.
+A Castle client instance will be made available as `castle` in your Rails, Sinatra or Padrino controllers. The client will automatically configure the [request context](https://api.castle.io/docs#request-context) for each request.
 
-## Identifying users
+## Documentation
 
-Call `identify` when a user logs in or updates their information.
-
-```ruby
-castle.identify(user.id, {
-  created_at: user.created_at,
-  email: user.email,
-  name: user.name,
-  custom_attributes: {
-    company_name: 'Acme',
-    age: 28
-  }
-})
-```
-
-Read more about the available fields in the [API docs](https://api.castle.io/docs#users).
-
-## Tracking events
-
-`track` lets you record the security-related actions your users perform. The more actions you track, the more accurate Castle is in identifying fraudsters.
-
-Event names and detail properties that have semantic meaning are prefixed `$`, and we handle them in special ways.
-
-When you have access to a **logged in user**, set `user_id` to the same user identifier as when you initiated Castle.js.
-
-```ruby
-castle.track(
-  name: '$login.succeeded',
-  user_id: user.id)
-```
-
-When you **don't** have access to a logged in user just omit `user_id`, typically when tracking `$login.failed` and `$password_reset.requested`. Instead, whenever you have access to the user-submitted form value, add this to the event details as `$login`.
-
-```ruby
-castle.track(
-  name: '$login.failed',
-  details: {
-    '$login' => 'johan@castle.io'
-  })
-```
-
-### Supported events
-
-- `$login.succeeded`: Record when a user attempts to log in.
-- `$login.failed`: Record when a user logs out.
-- `$logout.succeeded`:  Record when a user logs out.
-- `$registration.succeeded`: Capture account creation, both when a user signs up as well as when created manually by an administrator.
-- `$registration.failed`: Record when an account failed to be created.
-- `$email_change.requested`: An attempt was made to change a user’s email.
-- `$email_change.succeeded`: The user completed all of the steps in the email address change process and the email was successfully changed.
-- `$email_change.failed`: Use to record when a user failed to change their email address.
-- `$challenge.requested`: Record when a user is prompted with additional verification, such as two-factor authentication or a captcha.
-- `$challenge.succeeded`: Record when additional verification was successful.
-- `$challenge.failed`: Record when additional verification failed.
-- `$password_reset.requested`: An attempt was made to reset a user’s password.
-- `$password_reset.succeeded`: The user completed all of the steps in the password reset process and the password was successfully reset. Password resets **do not** required knowledge of the current password.
-- `$password_reset.failed`: Use to record when a user failed to reset their password.
-- `$password_change.succeeded`: Use to record when a user changed their password. This event is only logged when users change their **own** password.
-- `$password_change.failed`:  Use to record when a user failed to change their password.
-
-### Supported detail properties
-
-- `$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.
+[Official Castle docs](https://castle.io/docs)
 
 ## Exceptions
 

data/lib/castle-rb/version.rb

@@ -1,3 +1,3 @@
 module Castle
-  VERSION = "1.2.11"
+  VERSION = "1.2.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: castle-rb
 version: !ruby/object:Gem::Version
-  version: 1.2.11
+  version: 1.2.12
 platform: ruby
 authors:
 - Johan Brissmyr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: her