recurly_event 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 367bf8594ffdbe43736320bb78109eb9ece66b2a
+  data.tar.gz: ac68290ea4c65fc053da003bc7f07bc16ab4f75d
+SHA512:
+  metadata.gz: fafc05450d5623ed878004ae4c68ea99bfd16785c46131d82174e85a39858685f18e9b3367a9a440a785f48dc7d96c69b23ebe38d781527aae8767d3bc8d6bcf
+  data.tar.gz: 191eec00bda36c9f273793ec26141caa35654f71ebf37d3ee117baee662a7da11096443874e6b978df25f29f9b98e6a76b885abb28ec3f72c5cf7d78464dbc7a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.3
+addons:
+  code_climate:
+      repo_token: c9aa4c7c36f23faa189a65c4414bbc553d60320b488a6cde301a267b30c49409
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in recurly_event.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ejay Canaria
+
+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,86 @@
+# RecurlyEvent
+[![Build Status](https://travis-ci.org/ejaypcanaria/recurly_event.svg)](https://travis-ci.org/ejaypcanaria/recurly_event) [![Code Climate](https://codeclimate.com/github/ejaypcanaria/recurly_event/badges/gpa.svg)](https://codeclimate.com/github/ejaypcanaria/recurly_event) [![Test Coverage](https://codeclimate.com/github/ejaypcanaria/recurly_event/badges/coverage.svg)](https://codeclimate.com/github/ejaypcanaria/recurly_event/coverage)
+
+RecurlyEvent is a simple Ruby DSL for managing [Recurly Webhooks](https://recurly.readme.io/v2.0/page/webhooks) inside a Rails application. This project is inspired by the [StripeEvent](https://github.com/integrallis/stripe_event/) gem and is built using pub/sub API of [ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'recurly_event'
+```
+
+And then execute:
+
+    $ bundle
+
+Mount the Rails Engine to your route:
+```ruby
+# config/routes.rb
+mount RecurlyEvent::Engine, at: "/your-chosen-path"
+```
+
+## Usage
+Add an initializer to your Rails application:
+```ruby
+# config/initializers/recurly.rb
+RecurlyEvent.configure do |events|
+  # To subscribe to a webhook, just pass in the event name and
+  # an instance of a class that responds to `call(recurly_object)`
+  events.subscribe "account.new", AccountCreated.new
+
+  # You can also subscribe to a namespace of events.
+  # In this case, you will be notified of all the invoice actions webhook
+  events.subscribe "invoice.", InvoiceEventHandler.new
+
+  # Subscribe to all the events
+  events.all RecurlyEventLogger.new
+end
+```
+
+### Event name convention
+All Recurly webhooks are listed [here](https://recurly.readme.io/v2.0/page/webhooks). Here's a sample `new_account_notification` XML response from their website:
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<new_account_notification>
+  <account>
+    <account_code>1</account_code>
+    <username nil="true"></username>
+    <email>verena@example.com</email>
+    <first_name>Verena</first_name>
+    <last_name>Example</last_name>
+    <company_name nil="true"></company_name>
+  </account>
+</new_account_notification>
+```
+As you can see above the top level node is the event name from Recurly, in this case `new_account_notification`. The convention in this gem follows this pattern for the event name: `[noun].[verb]`. So, if you want to subscribe to this event, the event name is `account.new`.
+
+### Callable object
+The second parameter in the `subscribe` method is an instance of a class that responds to `call(recurly_object)`. This will be triggered once Recurly fires the webhook.
+
+```ruby
+# Plain old Ruby object
+class AccountCreated
+  def call(recurly_object)
+    # recurly_object is an OpenStruct that has the same structure as the XML without the parent node (the event name).
+    # You can get specific attributes by traversing the object like this:
+    puts recurly_object.account.username
+  end
+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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ejaypcanaria/recurly_event. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/recurly_event/webhook_controller.rb

@@ -0,0 +1,8 @@
+module RecurlyEvent
+  class WebhookController < ActionController::Base
+    def event
+      RecurlyEvent.process_request(request)
+      head :ok
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "recurly_event"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/config/routes.rb

@@ -0,0 +1,3 @@
+RecurlyEvent::Engine.routes.draw do
+  root "webhook#event", via: :post
+end

data/lib/recurly_event/engine.rb

@@ -0,0 +1,5 @@
+module RecurlyEvent
+  class Engine < ::Rails::Engine
+    isolate_namespace RecurlyEvent
+  end
+end

data/lib/recurly_event/namespace.rb

@@ -0,0 +1,27 @@
+module RecurlyEvent
+  class Namespace < Struct.new(:namespace, :delimeter)
+    RESOURCES_REGEXP = /account|billing_info|invoice|subscription|payment|refund/
+
+    def with_namespace(name)
+      "#{namespace}#{delimeter}#{name}"
+    end
+
+    def parse_with_namespace(name)
+      with_namespace(parse_name(name))
+    end
+
+    def regexp_wrap(name)
+      /^#{Regexp.escape(with_namespace(name))}/
+    end
+
+  private
+
+    def parse_name(name)
+      noun = RESOURCES_REGEXP.match(name).to_s
+      splitted = name.gsub("#{noun}_", "").split("_")
+      splitted.pop
+      verb = splitted.join("_")
+      "#{noun}.#{verb}"
+    end
+  end
+end

data/lib/recurly_event/parser.rb

@@ -0,0 +1,33 @@
+require "json"
+require "active_support/core_ext/hash"
+
+module RecurlyEvent
+  class Parser
+    def self.parse(request)
+      new(request)
+    end
+
+    def self.from_payload(payload)
+      JSON.parse(payload.to_json, object_class: OpenStruct)
+    end
+
+    def initialize(request)
+      @request = request
+    end
+
+    def event_name
+      hash_from_request.first.first
+    end
+
+    def payload
+      hash_from_request.first.last
+    end
+
+  private
+
+    def hash_from_request
+      # see https://recurly.readme.io/v2.0/page/webhooks for the xml structure
+      @hash_from_request ||= Hash.from_xml(@request.body.string)
+    end
+  end
+end

data/lib/recurly_event/version.rb

@@ -0,0 +1,3 @@
+module RecurlyEvent
+  VERSION = "1.0.0"
+end

data/lib/recurly_event.rb

@@ -0,0 +1,42 @@
+require "active_support/notifications"
+require "recurly_event/version"
+require "recurly_event/namespace"
+require "recurly_event/parser"
+require "recurly_event/engine" if defined? Rails
+
+module RecurlyEvent
+  NAMESPACE = "recurly".freeze
+
+  class << self
+    attr_accessor :notifications, :namespace, :parser
+
+    def configure(&block)
+      raise ArgumentError, "missing block" unless block_given?
+      yield self
+    end
+
+    def all(callable=Proc.new {})
+      subscribe nil, callable
+    end
+
+    def process_request(request)
+      parsed_request = parser.parse(request)
+      publish(parsed_request.event_name, parsed_request.payload)
+    end
+
+    def publish(event_name, payload)
+      notifications.instrument(namespace.parse_with_namespace(event_name), payload)
+    end
+
+    def subscribe(event_name, callable=Proc.new {})
+      notifications.subscribe namespace.regexp_wrap(event_name) do |*args|
+        recurly_object = parser.from_payload(args.last)
+        callable.call(recurly_object)
+      end
+    end
+  end
+
+  self.parser        = Parser
+  self.namespace     = Namespace.new(NAMESPACE, ".")
+  self.notifications = ActiveSupport::Notifications
+end

data/recurly_event.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'recurly_event/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "recurly_event"
+  spec.version       = RecurlyEvent::VERSION
+  spec.authors       = ["Ejay Canaria"]
+  spec.email         = ["ejaypcanaria@gmail.com"]
+
+  spec.summary       = %q{Simple DSL to utilize Recurly webhook inside a Rails application}
+  spec.homepage      = "https://github.com/ejaypcanaria/recurly_event"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 3.1"
+
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: recurly_event
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ejay Canaria
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ejaypcanaria@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/.DS_Store
+- app/controllers/.DS_Store
+- app/controllers/recurly_event/.DS_Store
+- app/controllers/recurly_event/webhook_controller.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/recurly_event.rb
+- lib/recurly_event/engine.rb
+- lib/recurly_event/namespace.rb
+- lib/recurly_event/parser.rb
+- lib/recurly_event/version.rb
+- recurly_event.gemspec
+homepage: https://github.com/ejaypcanaria/recurly_event
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simple DSL to utilize Recurly webhook inside a Rails application
+test_files: []