cased-ruby 0.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45c422e1920ea510d16c5c8a5b91016ac2a4eedb9a2b880ff29018dc18580a13
+  data.tar.gz: 83e14abb44637e8d61a3fff592d8b434cbf8373cd8a4c8afede513cf89852f8a
+SHA512:
+  metadata.gz: 5beffb4be2a539b74e6145c4d4b7b96ae6aea94c2bb5cdf9a79dfb90bfaeac615c80b537db0249702d807acb7f69727ff7b81cfc62896d03ad6e2c44124c1360
+  data.tar.gz: 8ae4ac844f566981de31a5d51ecfe28d4e665f9cebd5c6f5327a596b052e43e92ab0d7db9bb07029211f0786db5baf00035db8022a376b5ea3ba30ac512dbbda

data/.github/workflows/rubocop.yml

@@ -0,0 +1,21 @@
+name: Rubocop
+
+on: [push]
+
+jobs:
+  build:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --local
+      - run: bin/rubocop

data/.github/workflows/ruby.yml

@@ -0,0 +1,46 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - "2.5"
+          - "2.6"
+          - "2.7"
+    name: Ruby ${{ matrix.ruby }} test
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --local
+
+      - name: Run Tests
+        run: |
+          bundle exec rake test
+
+      - name: Generate yard documentation
+        run: |
+          bundle exec yard
+
+      - name: Upload test coverage report
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage
+          path: coverage/**/*
+
+      - name: Upload generated yard documentation
+        uses: actions/upload-artifact@v2
+        with:
+          name: yard
+          path: doc/**/*

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,88 @@
+AllCops:
+  Exclude:
+    - "db/**/*"
+    - "config/**/*"
+    - "script/**/*"
+    - "bin/{rails,rake,bundle}"
+    - "node_modules/**/*"
+    - "app/views/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Exclude:
+    - db/schema.rb
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/cased-ruby.rb
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/RescueEnsureAlignment:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  Enabled: false
+
+Layout/EndAlignment:
+  Enabled: false
+
+Layout/ElseAlignment:
+  Enabled: false
+
+Layout/IndentationWidth:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/CaseIndentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@garrettbjerkhoel.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cased-ruby.gemspec
+gemspec
+
+gem 'simplecov', '0.18.5', require: false

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    cased-ruby (0.3.3)
+      activesupport (~> 6)
+      dotpath (= 0.1.0)
+      faraday (~> 1.0)
+      faraday_middleware (~> 1.0)
+      json (~> 2)
+      net-http-persistent (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.3.2)
+    dotpath (0.1.0)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.3.1)
+    minitest (5.13.0)
+    mocha (1.11.2)
+    multipart-post (2.1.1)
+    net-http-persistent (3.1.0)
+      connection_pool (~> 2.2)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    public_suffix (4.0.5)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redis (4.1.4)
+    rubocop (0.78.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    safe_yaml (1.0.5)
+    sidekiq (6.0.7)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.24)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (= 2.1.4)
+  byebug (= 11.0.1)
+  cased-ruby!
+  minitest (= 5.13.0)
+  mocha (= 1.11.2)
+  rack (= 2.2.2)
+  rake (= 10.5.0)
+  rubocop (= 0.78.0)
+  rubocop-performance (= 1.5.2)
+  sidekiq (= 6.0.7)
+  simplecov (= 0.18.5)
+  webmock (= 3.8.3)
+  yard (= 0.9.24)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Cased, Inc.
+
+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,661 @@
+# cased-ruby
+
+A Cased client for Ruby applications in your organization to control and monitor the access of information within your organization.
+
+## Overview
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Usage](#usage)
+  - [Publishing events to Cased](#publishing-events-to-cased)
+  - [Retrieving events from a Cased Policy](#retrieving-events-from-a-cased-policy)
+  - [Retrieving events from a Cased Policy containing variables](#retrieving-events-from-a-cased-policy-containing-variables)
+  - [Retrieving events from multiple Cased Policies](#retrieving-events-from-multiple-cased-policies)
+  - [Exporting events](#exporting-events)
+  - [Masking & filtering sensitive information](#masking-and-filtering-sensitive-information)
+  - [Disable publishing events](#disable-publishing-events)
+  - [Context](#context)
+  - [Testing](#testing)
+- [Customizing cased-ruby](#customizing-cased-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cased-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cased-ruby
+
+## Configuration
+
+All configuration options available in cased-ruby are available to be configured by an environment variable or manually.
+
+```ruby
+Cased.configure do |config|
+  # CASED_POLICY_KEY=policy_live_1dQpY5JliYgHSkEntAbMVzuOROh
+  config.policy_key = 'policy_live_1dQpY5JliYgHSkEntAbMVzuOROh'
+
+  # CASED_USERS_POLICY_KEY=policy_live_1dQpY8bBgEwdpmdpVrrtDzMX4fH
+  # CASED_ORGANIZATIONS_POLICY_KEY=policy_live_1dSHQRurWX8JMYMbkRdfzVoo62d
+  config.policy_keys = {
+    users: 'policy_live_1dQpY8bBgEwdpmdpVrrtDzMX4fH',
+    organizations: 'policy_live_1dSHQRurWX8JMYMbkRdfzVoo62d',
+  }
+
+  # CASED_PUBLISH_KEY=publish_live_1dQpY1jKB48kBd3418PjAotmEwA
+  config.publish_key = 'publish_live_1dQpY1jKB48kBd3418PjAotmEwA'
+
+  # CASED_PUBLISH_URL=https://publish.cased.com
+  config.publish_url = 'https://publish.cased.com'
+
+  # CASED_API_URL=https://api.cased.com
+  config.api_url = 'https://api.cased.com'
+
+  # CASED_RAISE_ON_ERRORS=1
+  config.raise_on_errors = false
+
+  # CASED_SILENCE=1
+  config.silence = false
+
+  # CASED_HTTP_OPEN_TIMEOUT=5
+  config.http_open_timeout = 5
+
+  # CASED_HTTP_READ_TIMEOUT=10
+  config.http_read_timeout = 10
+end
+```
+
+## Usage
+
+### Publishing events to Cased
+
+There are two ways to publish your first Cased event.
+
+**Manually**
+
+```ruby
+require 'cased-ruby'
+
+Cased.configure do |config|
+  config.publish_key = 'publish_live_1dQpY1jKB48kBd3418PjAotmEwA'
+end
+
+Cased.publish(
+  action: 'credit_card.charge',
+  amount: 2000,
+  currency: 'usd',
+  source: 'tok_amex',
+  description: 'My First Test Charge (created for API docs)',
+  credit_card_id: 'card_1dQpXqQwXxsQs9sohN9HrzRAV6y',
+)
+```
+
+**Cased::Model**
+
+cased-ruby provides a class mixin that gives you a framework to publish events.
+
+```ruby
+require 'cased-ruby'
+
+Cased.configure do |config|
+  config.publish_key = 'publish_live_1dQpY1jKB48kBd3418PjAotmEwA'
+end
+
+class CreditCard
+  include Cased::Model
+
+  def initialize(amount:, currency:, source:, description:)
+    @amount = amount
+    @currency = currency
+    @source = source
+    @description = description
+  end
+
+  def charge
+    Stripe::Charge.create({
+      amount: @amount,
+      currency: @currency,
+      source: @source,
+      description: @description,
+    })
+
+    cased(:charge, payload: {
+      amount: @amount,
+      currency: @currency,
+      description: @description,
+    })
+  end
+
+  def cased_id
+    'card_1dQpXqQwXxsQs9sohN9HrzRAV6y'
+  end
+
+  def cased_payload
+    {
+      credit_card: self,
+    }
+  end
+end
+
+credit_card = CreditCard.new(
+  amount: 2000,
+  currency: 'usd',
+  source: 'tok_amex',
+  description: 'My First Test Charge (created for API docs)',
+)
+
+credit_card.charge
+```
+
+Both examples above are equivelent in that they publish the following `credit_card.charge` event to Cased:
+
+```json
+{
+  "cased_id": "5f8559cd-4cd9-48c3-b1d0-6eedc4019ec1",
+  "action": "credit_card.charge",
+  "amount": 2000,
+  "currency": "usd",
+  "source": "tok_amex",
+  "description": "My First Test Charge (created for API docs)",
+  "credit_card_id": "card_1dQpXqQwXxsQs9sohN9HrzRAV6y",
+  "timestamp": "2020-06-23T02:02:39.932759Z"
+}
+```
+
+### Retrieving events from a Cased Policy
+
+If you plan on retrieving events from your audit trails you must use an Cased Policy token.
+
+```ruby
+require 'cased-ruby'
+
+Cased.configure do |config|
+  config.policy_key = 'policy_live_1dQpY5JliYgHSkEntAbMVzuOROh'
+end
+
+query = Cased.policy.events.limit(25).page(1)
+results = query.results
+results.each do |event|
+  puts event['action'] # => credit_card.charge
+  puts event['timestamp'] # => 2020-06-23T02:02:39.932759Z
+end
+query.total_count # => 2,366
+query.total_pages # => 95
+query.success? # => true
+query.error? # => false
+```
+
+### Retrieving events from a Cased Policy containing variables
+
+Cased policies allow you to filter events by providing variables to your Cased Policy events query. One example of a Cased Policy is to have a single Cased Policy that you can use to query events for any user in your database without having to create a Cased Policy for each user.
+
+```ruby
+require 'cased-ruby'
+
+Cased.configure do |config|
+  config.policy_key = 'policy_live_1dQpY5JliYgHSkEntAbMVzuOROh'
+end
+
+variables = {
+  user_id: 'user_1dSHQSNtAH90KA8zGTooMnmMdiD',
+}
+query = Cased.policy(variables: variables).events.limit(25).page(1)
+results = query.results
+results.each do |event|
+  puts event['action'] # => credit_card.charge
+  puts event['timestamp'] # => 2020-06-23T02:02:39.932759Z
+end
+```
+
+### Retrieving events from multiple Cased Policies
+
+To retrieve events from one or more Cased Policies you can configure multiple Cased Policy API keys and retrieve events for each one.
+
+```ruby
+require 'cased-ruby'
+
+Cased.configure do |config|
+  config.policy_keys = {
+    users: 'policy_live_1dQpY8bBgEwdpmdpVrrtDzMX4fH',
+    organizations: 'policy_live_1dSHQRurWX8JMYMbkRdfzVoo62d',
+  }
+end
+
+query = Cased.policy[:users].events.limit(25).page(1)
+results = query.results
+results.each do |event|
+  puts event['action'] # => user.login
+  puts event['timestamp'] # => 2020-06-23T02:02:39.932759Z
+end
+
+query = Cased.policy[:organizations].events.limit(25).page(1)
+results = query.results
+results.each do |event|
+  puts event['action'] # => organization.create
+  puts event['timestamp'] # => 2020-06-22T22:16:31.055655Z
+end
+```
+
+### Exporting events
+
+Exporting events from a Cased Policy allows you to provide users with exports of their own data or to respond to data requests.
+
+```ruby
+require 'cased-ruby'
+
+Cased.configure do |config|
+  config.policy_key = 'policy_live_1dQpY5JliYgHSkEntAbMVzuOROh'
+end
+
+export = Cased.policy.exports.create(
+  format: :json,
+  phrase: 'action:credit_card.charge',
+)
+export.download_url # => https://api.cased.com/exports/export_1dSHQSNtAH90KA8zGTooMnmMdiD/download?token=eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidXNlcl8xZFFwWThiQmdFd2RwbWRwVnJydER6TVg0ZkgiLCJ
+```
+
+### Masking & filtering sensitive information
+
+If you are handling sensitive information on behalf of your users you should consider masking or filtering any sensitive information.
+
+```ruby
+require 'cased-ruby'
+
+Cased.configure do |config|
+  config.publish_key = 'publish_live_1dQpY1jKB48kBd3418PjAotmEwA'
+end
+
+Cased.publish(
+  action: 'credit_card.charge',
+  user: Cased::Sensitive::String.new('john@organization.com', label: :email)
+)
+```
+
+### Console Usage
+
+Most Cased events will be created by users from actions on the website from
+custom defined events or lifecycle callbacks. The exception is any console
+session where models may generate Cased events as you start to modify records.
+
+By default any console session will include the hostname of where the console
+session takes place. Since every event must have an actor, you must set the
+actor at the beginning of your console session. If you don't know the user,
+it's recommended you create a system/robot user.
+
+```ruby
+# OTHER CONSOLE INITIALIZATION HERE
+Cased.context.push(actor: @actor)
+```
+
+### Disable publishing events
+
+Although rare, there may be times where you wish to disable publishing events to Cased. To do so wrap your transaction inside of a `Cased.disable` block:
+
+```ruby
+Cased.disable do
+  user.cased(:login)
+end
+```
+
+Or you can configure the entire process to disable publishing events.
+
+```
+CASED_DISABLE_PUBLISHING=1 bundle exec ruby crawl.rb
+```
+
+### Context
+
+One of the most easiest ways to publish detailed events to Cased is to push contextual information on to the Cased context.
+
+```ruby
+require 'cased-ruby'
+
+Cased.configure do |config|
+  config.publish_key = 'publish_live_1dQpY1jKB48kBd3418PjAotmEwA'
+end
+
+Cased.context.merge(location: 'hostname.local')
+
+Cased.publish(
+  action: 'console.start',
+  user: 'john',
+)
+```
+
+Any information stored in `Cased.context` will be included anytime an event is published.
+
+```json
+{
+  "cased_id": "5f8559cd-4cd9-48c3-b1d0-6eedc4019ec1",
+  "action": "user.login",
+  "user": "john",
+  "location": "hostname.local",
+  "timestamp": "2020-06-22T21:43:06.157336"
+}
+```
+
+You can provide `Cased.context.merge` a block and the context will only be present for the duration of the block:
+
+```ruby
+Cased.context.merge(location: 'hostname.local') do
+  # Will include { "location": "hostname.local" }
+  Cased.publish(
+    action: 'console.start',
+    user: 'john',
+  )
+end
+
+# Will not include { "location": "hostname.local" }
+Cased.publish(
+  action: 'console.end',
+  user: 'john',
+)
+```
+
+To clear/reset the context:
+
+```ruby
+Cased.context.clear
+```
+
+### Testing
+
+cased-ruby provides a test helper class that you can use to test events are being published to Cased.
+
+```ruby
+require 'test-helper'
+
+class CreditCardTest < Test::Unit::TestCase
+  include Cased::TestHelper
+
+  def test_charging_credit_card_publishes_credit_card_create_event
+    credit_card = CreditCard.new(
+      amount: 2000,
+      currency: 'usd',
+      source: 'tok_amex',
+      description: 'My First Test Charge (created for API docs)',
+    )
+
+    credit_card.charge
+
+    assert_cased_events 1, action: 'credit_card.charge', amount: 2000
+  end
+
+  def test_charging_credit_card_publishes_credit_card_create_event_with_block
+    credit_card = CreditCard.new(
+      amount: 2000,
+      currency: 'usd',
+      source: 'tok_amex',
+      description: 'My First Test Charge (created for API docs)',
+    )
+
+    assert_cased_events 1, action: 'credit_card.charge', amount: 2000 do
+      credit_card.charge
+    end
+  end
+
+  def test_charging_credit_card_with_zero_amount_does_not_publish_credit_card_create_event
+    credit_card = CreditCard.new(
+      amount: 0,
+      currency: 'usd',
+      source: 'tok_amex',
+      description: 'My First Test Charge (created for API docs)',
+    )
+
+    assert_no_cased_events do
+      credit_card.charge
+    end
+  end
+end
+```
+
+## Customizing cased-ruby
+
+Out of the box cased-ruby takes care of serializing objects for you to the best of its ability, but you can customize cased-ruby should you like to fit your products needs.
+
+Let's look at each of these methods independently as they all work together to
+create the event.
+
+`Cased::Model#cased`
+
+This method is what publishes events for you to Cased. You include information specific to a particular event when calling `Cased::Model#cased`:
+
+```ruby
+class CreditCard
+  include Cased::Model
+
+  # ...
+
+  def charge
+    Stripe::Charge.create({
+      amount: @amount,
+      currency: @currency,
+      source: @source,
+      description: @description,
+    })
+
+    cased(:charge, payload: {
+      amount: @amount,
+      currency: @currency,
+      description: @description,
+    })
+  end
+end
+```
+
+Or you can customize information that is included anytime `Cased::Model#cased` is called in your class:
+
+```ruby
+class CreditCard
+  include Cased::Model
+
+  # ...
+
+  def charge
+    Stripe::Charge.create({
+      amount: @amount,
+      currency: @currency,
+      source: @source,
+      description: @description,
+    })
+
+    cased(:charge)
+  end
+
+  def cased_payload
+    {
+      credit_card: self,
+      amount: @amount,
+      currency: @currency,
+      description: @description,
+    }
+  end
+end
+```
+
+Both examples are equivelent.
+
+`Cased::Model#cased_category`
+
+By default `cased_category` will use the underscore class name to generate the
+prefix for all events generated by this class. If you published a
+`CreditCard#charge` event it would be delivered to Cased `credit_card.charge`. If you want to
+customize what cased-ruby uses you can do so by re-opening the method:
+
+```ruby
+class CreditCard
+  include Cased::Model
+
+  def cased_category
+    :card
+  end
+end
+```
+
+`Cased::Model#cased_id`
+
+Per our guide on [Human and machine readable information](https://docs.cased.com/guides/design-audit-trail-events#human-and-machine-readable-information) for [Designing audit trail events](https://docs.cased.com/guides/design-audit-trail-events) we encourage you to publish a unique identifier that will never change to Cased along with your events. This way when you [retrieve events](#retrieving-events-from-a-cased-policy) from Cased you'll be able to locate the corresponding object in your system.
+
+```ruby
+class User
+  include Cased::Model
+
+  def cased_id
+    database_id
+  end
+end
+```
+
+`Cased::Model#cased_context`
+
+To assist you in publishing events to Cased that are consistent and predictable, cased-ruby attempts to build your `cased_context` as long as you implement either `to_s` or `cased_id` in your class:
+
+```ruby
+class Plan
+  include Cased::Model
+
+  def initialize(name)
+    @name = name
+  end
+
+  def cased_id
+    database_id
+  end
+
+  def to_s
+    @name
+  end
+end
+
+plan = Plan.new('Free')
+plan.to_s # => 'Free'
+plan.cased_id # => 'plan_1dQpY1jKB48kBd3418PjAotmEwA'
+plan.cased_context # => { plan: 'Free', plan_id: 'plan_1dQpY1jKB48kBd3418PjAotmEwA' }
+```
+
+If your class does not implement `to_s` it will only include `cased_id`:
+
+```ruby
+class Plan
+  include Cased::Model
+
+  def initialize(name)
+    @name = name
+  end
+
+  def cased_id
+    database_id
+  end
+end
+
+plan = Plan.new('Free')
+plan.to_s # => '#<Plan:0x00007feadf63b7e0>'
+plan.cased_context # => { plan_id: 'plan_1dQpY1jKB48kBd3418PjAotmEwA' }
+```
+
+Or you can customize it if your `to_s` implementation is not suitable for Cased:
+
+```ruby
+class Plan
+  include Cased::Model
+
+  def initialize(name)
+    @name = name
+  end
+
+  def cased_id
+    'plan_1dQpY1jKB48kBd3418PjAotmEwA'
+  end
+
+  def to_s
+    @name
+  end
+
+  def cased_context(category: cased_category)
+    {
+      "#{category}_id".to_sym => cased_id,
+      category => @name.parameterize,
+    }
+  end
+end
+
+class CreditCard
+  include Cased::Model
+
+  def initialize(amount:, currency:, source:, description:)
+    @amount = amount
+    @currency = currency
+    @source = source
+    @description = description
+  end
+
+  def charge
+    Stripe::Charge.create({
+      amount: @amount,
+      currency: @currency,
+      source: @source,
+      description: @description,
+    })
+
+    cased(:charge, payload: {
+      amount: @amount,
+      currency: @currency,
+      description: @description,
+    })
+  end
+
+  def plan
+    Plan.new('Free')
+  end
+
+  def cased_id
+    'card_1dQpXqQwXxsQs9sohN9HrzRAV6y'
+  end
+
+  def cased_payload
+    {
+      credit_card: self,
+      plan: plan,
+    }
+  end
+end
+
+credit_card = CreditCard.new(
+  amount: 2000,
+  currency: 'usd',
+  source: 'tok_amex',
+  description: 'My First Test Charge (created for API docs)',
+)
+
+credit_card.charge
+```
+
+Results in:
+
+```json
+{
+  "cased_id": "5f8559cd-4cd9-48c3-b1d0-6eedc4019ec1",
+  "action": "credit_card.charge",
+  "credit_card": "personal",
+  "credit_card_id": "card_1dQpXqQwXxsQs9sohN9HrzRAV6y",
+  "plan": "Free",
+  "plan_id": "plan_1dQpY1jKB48kBd3418PjAotmEwA",
+  "timestamp": "2020-06-22T20:24:04.815758"
+}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/cased/cased-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request