webhookr-recurly 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66d23a50439f5eca817d93a19ca1da8a40f03acc
+  data.tar.gz: f96b2e3e14633a5ac31f978badeb729fdc191e10
+SHA512:
+  metadata.gz: 27d9377d0f06ef3cd3eb1b388ca639c967384afbaa6792bde0a02f1e734925c58ef39d525535c3a57c09244ba8a184cc11703c3baca225d2313525f86a53e948
+  data.tar.gz: 2c22dd453aeb8e634fb92891635dd448cbaa51482e4f4722244eb0a870ded37d5cce31104d76bfff638c36fa98034d6eda678028b7b341421ad23e0a5e162218

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.ruby-version
+.ruby-gemset
+.bundle
+.config
+.yardoc
+Gemfile.lock
+Gemfile.local
+Guardfile.local
+README.html
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-19mode # JRuby in 1.9 mode
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 10.0"
+  gem "minitest"
+  gem "minitest-reporters"
+  gem "em-websocket"
+  gem "guard"
+  gem "guard-minitest"
+  gem "guard-markdown"
+  gem "guard-livereload"
+  gem "simplecov", :require => false
+end
+
+if File.exists?('Gemfile.local')
+  instance_eval File.read('Gemfile.local')
+end
+

data/Guardfile

@@ -0,0 +1,26 @@
+
+guard 'minitest', :test_folders => 'test', :test_file_patterns => '*_tests.rb' do
+  watch(%r|^test/(.+)_test\.rb|)
+  watch(%r|^test/(.+)_tests\.rb|)
+
+  watch(%r|^lib/(.*)([^/]+)\.rb|) do |m|
+    "test/#{m[1]}#{m[2]}_tests.rb"
+  end
+
+  watch(%r|^test/test_helper\.rb|) do
+    "test"
+  end
+end
+
+guard 'markdown', :convert_on_start => true do
+ watch ('README.md') { "./README.md|./README.html" }
+end
+
+guard 'livereload' do
+  watch('README.html')
+end
+
+if File.exists?('Guardfile.local')
+  instance_eval File.read('Guardfile.local')
+end
+

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Todd Eichel <todd@toddeichel.com> and Zoocasa, Brokerage <code@zoocasa.com>
+
+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,118 @@
+# Webhookr::Recurly
+
+[![Build Status](https://travis-ci.org/tfe/webhookr-recurly.png?branch=master)](https://travis-ci.org/tfe/webhookr-recurly)
+[![Dependency Status](https://gemnasium.com/tfe/webhookr-recurly.png)](https://gemnasium.com/tfe/webhookr-recurly)
+[![Code Climate](https://codeclimate.com/github/tfe/webhookr-recurly.png)](https://codeclimate.com/github/tfe/webhookr-recurly)
+
+This gem is a plugin for [Webhookr](https://github.com/zoocasa/webhookr) that enables
+your application to accept [webhooks from Recurly](https://docs.recurly.com/push-notifications).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'webhookr-recurly'
+
+Or install it yourself:
+
+    $ gem install webhookr-recurly
+
+## Usage
+
+Once you have the gem installed run the generator to add the code to your initializer.
+An initializer will be created if you do not have one.
+
+```console
+rails g webhookr:recurly:init *initializer_name* -s
+```
+
+Run the generator to create an example file to handle Recurly webhooks.
+
+```console
+rails g webhookr:recurly:example_hooks
+```
+
+Or create a Recurly handler class for any event that you want to handle. For example
+to handle unsubscribes you would create a class as follows:
+
+```ruby
+class RecurlyHooks
+  def canceled_subscription_notification(incoming)
+    # Your custom logic goes here.
+    User.sync_recurly_subscription(incoming.payload.account.account_code)
+  end
+end
+```
+
+For a complete list of events, and the payload format, see below.
+
+Edit config/initializers/*initializer_name* and change the commented line to point to
+your custom Recurly event handling class. If your class was called *RecurlyHooks*
+the configuration line would look like this:
+
+```ruby
+  Webhookr::Recurly::Adapter.config.callback = RecurlyHooks
+```
+
+To see the list of Recurly URLs for your application can use when you configure
+Recurly webhooks (https://[yoursite].recurly.com/configuration/notifications),
+run the provided webhookr rake task:
+
+```console
+rake webhookr:services
+```
+
+Example output:
+
+```console
+recurly:
+  GET	/webhookr/events/recurly/19xl64emxvn
+  POST	/webhookr/events/recurly/19xl64emxvn
+```
+
+## Recurly Events & Payload
+
+### Events
+
+All webhook events are supported. For further information on events, see the
+[Recurly documentation](https://docs.recurly.com/api/push-notifications).
+
+### Payload
+
+The payload is the full payload data from as per the [Recurly
+documentation](https://docs.recurly.com/api/push-notifications), converted to an
+OpenStruct for ease of access. Examples for the subscription canceled webhook:
+
+```ruby
+  incoming.payload.account.account_code
+  incoming.payload.account.email
+  incoming.payload.subscription.state
+  incoming.payload.subscription.canceled_at
+  incoming.payload.subscription.expires_at
+  incoming.payload.subscription.plan.plan_code
+  incoming.payload.subscription.plan.name
+```
+
+### Versioning
+This library aims to adhere to [Semantic Versioning 2.0.0](http://semver.org/). Violations of this scheme should be reported as
+bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, that
+version should be immediately yanked and/or a new version should be immediately released that restores
+compatibility. Breaking changes to the public API will only be introduced with new major versions. As a
+result of this policy, once this gem reaches a 1.0 release, you can (and should) specify a dependency on
+this gem using the [Pessimistic Version Constraint](http://docs.rubygems.org/read/chapter/16#page74) with
+two digits of precision. For example:
+
+    spec.add_dependency 'webhookr-recurly', '~> 1.0'
+
+While this gem is currently a 0.x release, suggestion is to require the exact version that works for your code:
+
+    spec.add_dependency 'webhookr-recurly', '0.1'
+
+## License
+
+webhookr-recurly is released under the [MIT license](http://www.opensource.org/licenses/MIT).
+
+## Authors
+
+* [Todd Eichel](https://github.com/tfe)
+* [Gerry Power](https://github.com/gerrypower)

data/Rakefile

@@ -0,0 +1,51 @@
+
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'bundler/gem_tasks'
+
+$:.push File.expand_path(File.dirname(__FILE__), 'lib')
+
+version = Webhookr::Recurly::VERSION
+
+desc 'Test Webhookr Recurly'
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/**/*_tests.rb']
+  t.verbose = !!ENV['VERBOSE_TESTS']
+  t.warning = !!ENV['WARNINGS']
+end
+
+desc 'Build docs'
+Rake::RDocTask.new do |t|
+  t.main = 'README.md'
+  t.title = "Webhookr Recurly #{version}"
+  t.rdoc_dir = 'doc'
+  t.rdoc_files.include('README.md', 'MIT-LICENSE', 'lib/**/*.rb')
+end
+
+namespace :webhookr do
+  namespace:test do
+    desc 'Install gems in all Rubies'
+    task :install do
+      sh %{rbenv each -v bundle install}
+    end
+
+    desc 'Test with all Rubies'
+    task :test_versions do
+      sh %{rbenv each -v bundle exec rake test}
+    end
+
+    desc 'Update rails'
+    task :update_rails do
+      sh %{rbenv each -v bundle update rails}
+    end
+
+    desc 'Install and test all'
+    task :all => [:install, :test_versions]
+  end
+end
+
+task :default => :test

data/lib/generators/webhookr/recurly/example_hooks_generator.rb

@@ -0,0 +1,16 @@
+module Webhookr
+  module Recurly
+    module Generators
+
+      class ExampleHooksGenerator < Rails::Generators::Base
+        source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+        desc "Creates an example Recurly hook file: 'app/models/recurly_hooks.rb'"
+        def example_hooks
+          copy_file( "recurly_hooks.rb", "app/models/recurly_hooks.rb")
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/webhookr/recurly/init_generator.rb

@@ -0,0 +1,24 @@
+require 'generators/webhookr/init_generator'
+
+module Webhookr
+  module Recurly
+    module Generators
+      class InitGenerator < Webhookr::Generators::InitGenerator
+
+        desc "This generator updates the named initializer with Recurly options"
+        def init
+          super
+          append_to_file "config/initializers/#{file_name}.rb" do
+            plugin_initializer_text
+          end
+        end
+
+        def plugin_initializer_text
+          "\nWebhookr::Recurly::Adapter.config.security_token = '#{generate_security_token}'" +
+          "\n# Uncomment the next line to include your custom Recurly handler\n" +
+          "# <-- Webhookr::Recurly::Adapter.config.callback = your_custom_class --> \n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/webhookr/recurly/templates/recurly_hooks.rb

@@ -0,0 +1,16 @@
+class RecurlyHooks
+
+  # All 'on_' handlers are optional. Omit any you do not require.
+
+  def on_canceled_subscription_notification(incoming)
+    payload = incoming.payload
+    # puts payload.account.account_code
+    # puts payload.account.email
+    # puts payload.subscription.state
+    # puts payload.subscription.canceled_at
+    # puts payload.subscription.expires_at
+    # puts payload.subscription.plan.plan_code
+    # puts payload.subscription.plan.name
+  end
+
+end

data/lib/webhookr-recurly.rb

@@ -0,0 +1,54 @@
+require "webhookr"
+require "webhookr-recurly/version"
+require "active_support/core_ext/module/attribute_accessors"
+require "webhookr/ostruct_utils"
+
+module Webhookr
+  module Recurly
+    class Adapter
+      SERVICE_NAME = 'recurly'
+
+      include Webhookr::Services::Adapter::Base
+
+      def self.process(raw_response)
+        new.process(raw_response)
+      end
+
+      def process(raw_response)
+        response = parse(raw_response)
+        event_type, payload = response.first
+        Webhookr::AdapterResponse.new(
+          SERVICE_NAME,
+          event_type,
+          OstructUtils.to_ostruct(payload)
+        )
+      end
+
+      private
+
+      def parse(raw_response)
+        assert_valid_packet(
+          Hash.from_xml(raw_response)
+        )
+      end
+
+      def assert_valid_packet(parsed_response)
+        raise(Webhookr::InvalidPayloadError,
+              "Missing data"
+        ) unless parsed_response.present?
+
+        raise(Webhookr::InvalidPayloadError,
+              "Missing event key in packet"
+        ) unless parsed_response.keys.first.present?
+
+        raise(Webhookr::InvalidPayloadError,
+              "No data in the response"
+        ) unless parsed_response[parsed_response.keys.first].present?
+
+        parsed_response
+      end
+
+    end
+
+  end
+end

data/lib/webhookr-recurly/version.rb

@@ -0,0 +1,5 @@
+module Webhookr
+  module Recurly
+    VERSION = "0.1"
+  end
+end

data/test/generators/webhookr/recurly/example_hooks_generator_tests.rb

@@ -0,0 +1,24 @@
+
+$: << File.join(File.dirname(__FILE__), %w{ .. .. .. })
+require 'test_helper'
+require 'generators/webhookr/recurly/example_hooks_generator'
+
+class ExampleHooksGeneratorTests < Rails::Generators::TestCase
+  tests Webhookr::Recurly::Generators::ExampleHooksGenerator
+  destination File.expand_path("../../../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  def setup
+    run_generator
+  end
+
+  test "it should create the example hook file" do
+    assert_file "app/models/recurly_hooks.rb"
+  end
+
+  test "it should on handlers" do
+    assert_file "app/models/recurly_hooks.rb" do |content|
+      assert_match(%r{on_canceled_subscription_notification}m, content)
+    end
+  end
+end

data/test/generators/webhookr/recurly/init_generator_tests.rb

@@ -0,0 +1,26 @@
+
+$: << File.join(File.dirname(__FILE__), %w{ .. .. .. })
+require 'test_helper'
+require 'generators/webhookr/recurly/init_generator'
+
+class InitGeneratorTests < Rails::Generators::TestCase
+  tests Webhookr::Recurly::Generators::InitGenerator
+  destination File.expand_path("../../../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  def setup
+    @name = "test_initializer"
+    @initializer = "config/initializers/#{@name}.rb"
+    run_generator Array.wrap(@name)
+  end
+
+  test "it should create the initializer" do
+    assert_file @initializer
+  end
+
+  test "it should have authorization information" do
+    assert_file @initializer do |content|
+      assert_match(%r{Webhookr::Recurly::Adapter\.config\.security_token}, content)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'rails'
+require "rails/generators/test_case"
+require File.expand_path('../../lib/webhookr-recurly.rb', __FILE__)
+
+if RUBY_VERSION >= "1.9"
+  MiniTest::Reporters.use!(MiniTest::Reporters::SpecReporter.new)
+end
+
+puts "Webhookr #{Webhookr::VERSION}"
+puts "Webhookr::Recurly #{Webhookr::Recurly::VERSION}"
+puts "Rails #{Rails::VERSION::STRING}"
+puts "Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} - #{RbConfig::CONFIG['RUBY_INSTALL_NAME']}"
+

data/test/unit/webhookr-recurly/version_tests.rb

@@ -0,0 +1,8 @@
+$: << File.join(File.dirname(__FILE__), %w{ .. .. })
+require 'test_helper'
+
+describe Webhookr::Recurly do
+  it "must be defined" do
+    Webhookr::Recurly::VERSION.wont_be_nil
+  end
+end

data/test/unit/webhookr-recurly_tests.rb

@@ -0,0 +1,123 @@
+
+$: << File.join(File.dirname(__FILE__), "..")
+require 'test_helper'
+
+describe Webhookr::Recurly::Adapter do
+  
+  before do
+    @valid_response = <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+      <canceled_subscription_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>
+        <subscription>
+          <plan>
+            <plan_code>1dpt</plan_code>
+            <name>Subscription One</name>
+          </plan>
+          <uuid>dccd742f4710e78515714d275839f891</uuid>
+          <state>canceled</state>
+          <quantity type="integer">1</quantity>
+          <total_amount_in_cents type="integer">200</total_amount_in_cents>
+          <activated_at type="datetime">2010-09-23T22:05:03Z</activated_at>
+          <canceled_at type="datetime">2010-09-23T22:05:43Z</canceled_at>
+          <expires_at type="datetime">2010-09-24T22:05:03Z</expires_at>
+          <current_period_started_at type="datetime">2010-09-23T22:05:03Z</current_period_started_at>
+          <current_period_ends_at type="datetime">2010-09-24T22:05:03Z</current_period_ends_at>
+          <trial_started_at nil="true" type="datetime"></trial_started_at>
+          <trial_ends_at nil="true" type="datetime"></trial_ends_at>
+          <collection_method>automatic</collection_method>
+        </subscription>
+      </canceled_subscription_notification>
+    XML
+  end
+
+  describe "class" do
+
+    subject { Webhookr::Recurly::Adapter }
+
+    it "must support process" do
+      subject.must_respond_to(:process)
+    end
+
+    it "should not return an error for a valid payload" do
+      lambda {
+        subject.process(@valid_response)
+      }.must_be_silent
+    end
+
+  end
+
+  describe "instance" do
+    subject { Webhookr::Recurly::Adapter.new }
+
+    it "should not return an error for a valid packet" do
+      lambda {
+        subject.process(@valid_response)
+      }.must_be_silent
+    end
+
+    it "should raise Webhookr::InvalidPayloadError for no data" do
+      lambda {
+        subject.process("")
+      }.must_raise(Webhookr::InvalidPayloadError)
+    end
+
+    it "should raise Webhookr::InvalidPayloadError for a missing event type" do
+      lambda {
+        subject.process("<canceled_subscription_notification />")
+      }.must_raise(Webhookr::InvalidPayloadError)
+    end
+
+    it "should raise Webhookr::InvalidPayloadError for a missing payload" do
+      lambda {
+        subject.process("<canceled_subscription_notification />")
+      }.must_raise(Webhookr::InvalidPayloadError)
+    end
+
+  end
+
+  describe "response" do
+    before do
+      @adapter = Webhookr::Recurly::Adapter.new
+    end
+
+    subject { @adapter.process(@valid_response) }
+
+    it "must respond to service_name" do
+      subject.must_respond_to(:service_name)
+    end
+
+    it "should return the correct service name" do
+      assert_equal(Webhookr::Recurly::Adapter::SERVICE_NAME, subject.service_name)
+    end
+
+    it "must respond to event_type" do
+      subject.must_respond_to(:event_type)
+    end
+
+    it "should return the correct event type" do
+      assert_equal("canceled_subscription_notification", subject.event_type)
+    end
+
+    it "must respond to payload" do
+      subject.must_respond_to(:payload)
+    end
+
+    it "should return the correct data" do
+      assert_equal("canceled", subject.payload.subscription.state)
+    end
+
+    it "should return nested data correctly" do
+      assert_equal("Subscription One", subject.payload.subscription.plan.name)
+    end
+
+  end
+
+end

data/webhookr-recurly.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webhookr-recurly/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "webhookr-recurly"
+  gem.version       = Webhookr::Recurly::VERSION
+  gem.required_rubygems_version = Gem::Requirement.new(">= 0") if gem.respond_to? :required_rubygems_version=
+  gem.authors       = ["Todd Eichel", "Gerry Power"]
+  gem.email         = ["todd@toddeichel.com", "code@zoocasa.com"]
+  gem.description   = "A webhookr extension to support Recurly webhooks."
+  gem.summary       = gem.description
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.homepage      = "http://github.com/tfe/webhookr-recurly"
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("webhookr")
+  gem.add_dependency("activesupport", [">= 3.1"])
+end
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: webhookr-recurly
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Todd Eichel
+- Gerry Power
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webhookr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: A webhookr extension to support Recurly webhooks.
+email:
+- todd@toddeichel.com
+- code@zoocasa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/webhookr/recurly/example_hooks_generator.rb
+- lib/generators/webhookr/recurly/init_generator.rb
+- lib/generators/webhookr/recurly/templates/recurly_hooks.rb
+- lib/webhookr-recurly.rb
+- lib/webhookr-recurly/version.rb
+- test/generators/webhookr/recurly/example_hooks_generator_tests.rb
+- test/generators/webhookr/recurly/init_generator_tests.rb
+- test/test_helper.rb
+- test/unit/webhookr-recurly/version_tests.rb
+- test/unit/webhookr-recurly_tests.rb
+- webhookr-recurly.gemspec
+homepage: http://github.com/tfe/webhookr-recurly
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A webhookr extension to support Recurly webhooks.
+test_files:
+- test/generators/webhookr/recurly/example_hooks_generator_tests.rb
+- test/generators/webhookr/recurly/init_generator_tests.rb
+- test/test_helper.rb
+- test/unit/webhookr-recurly/version_tests.rb
+- test/unit/webhookr-recurly_tests.rb