PaypalEvent
PaypalEvent is built on the ActiveSupport::Notifications API. Incoming webhook requests are authenticated with the webhook signature. Define subscribers to handle specific event types. Subscribers can be a block or an object that responds to #call
.
This project is refer to StripeEvent
Installation
Add this line to your application's Gemfile:
gem 'paypal_event'
And then execute:
$ bundle
Or install it yourself as:
$ gem install paypal_event
Usage
# config/initializers/paypal.rb
PaypalEvent.configure do |events|
events.subscribe 'PAYMENT.SALE.COMPLETED' do |event|
# Define subscriber behavior based on the event object
event[:event_type] #=> 'PAYMENT.SALE.COMPLETED'
end
events.all do |event|
# Handle all event types - logging, etc.
end
end
Subscriber objects that respond to #call
class PaymentSaleCompleted
def call(event)
# Event handling
end
end
class BillingEventLogger
def initialize(logger)
@logger = logger
end
def call(event)
@logger.info "BILLING:#{event[:event_type]}:#{event[:id]}"
end
end
PaypalEvent.configure do |events|
events.all BillingEventLogger.new(Rails.logger)
events.subscribe 'PAYMENT.SALE.COMPLETED', PaymentSaleCompleted.new
end
Subscribing to a namespace of event types
PaymentEvent.subscribe 'PAYMENT.SALE.' do |event|
# Will be triggered for any PAYMENT.SALE.* events
end
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/paypal_event.
License
MIT License. Copyright 2019-2020 Integrallis Software.