<commit_before>rspec-stripe
============

Provides some rspec helper methods for testing Stripe without hitting the Stripe API.

Handling Webhooks
------------

Your webhook handling code should authenticate a webhook request by retrieving the Event object from Stripe. 
This can be a little cumbersome when testing your webhook handling code, as you can end up having to create a JSON fixture for the webhook JSON as well as a matching Stripe::Event mock object.

This gem contains JSON fixtures for common Stripe events (these are yet to be fully populated) and automatically returns a mock Stripe::Event object.

For example:

    RspecStripeWebhookHelper.new.handle('charge.failed') { |body|
		  # Your test code here
    }

Will load a JSON fixture for the `charge.failed` webhook and will provide it to the block as the `body` parameter.
It will also stub the `Stripe::Event.retrieve` method and return a Stripe::Event mock object that matches the JSON in `body`. The stub is only applied within the scope of the block.<commit_msg>Updating README<commit_after>rspec-stripe
============

Provides some rspec helper methods for testing Stripe without hitting the Stripe API.

Handling Webhooks
------------

Your webhook handling code should authenticate a webhook request by retrieving the Event object from Stripe. 
This can be a little cumbersome when testing your webhook handling code, as you can end up having to create a JSON fixture for the webhook JSON as well as a matching Stripe::Event mock object.

This gem contains JSON fixtures for common Stripe events (these are yet to be fully populated) and automatically returns a mock Stripe::Event object.

For example:

    RspecStripeWebhookHelper.new.handle('charge.failed') { |body|
		  # Your test code here
    }

Will load a JSON fixture for the `charge.failed` webhook and will provide it to the block as the `body` parameter.
It will also stub the `Stripe::Event.retrieve` method and return a Stripe::Event mock object that matches the JSON in `body`. The stub is only applied within the scope of the block.

You can also override property values in the JSON and Stripe Event object by passing in a hash.

For example:

    RspecStripeWebhookHelper.new.handle('charge.failed', { :livemode => true }) { |body|
		  # Your test code here
    }

{'fraction_non_alphanumeric': 0.0683982683982684, 'fraction_numerical': 0.0, 'mean_word_length': 4.135555555555555, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1389118', 'n_tokens_mistral': 621, 'n_tokens_neox': 584, 'n_words': 324}