stripe_tester 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ButterCloud LLC.
+
+MIT License
+
+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,122 @@
+# StripeTester
+
+StripeTester is a testing gem used to simulate Stripe webhooks and post them to a specified URL.
+
+StripeTester allows you to submit webhooks to your application without hitting Stripe or requiring connectivity. You can use it in your test suite to simulate webhooks and ensure that your application reacts accordingly. You can also use StripeTester in the console to simulate webhooks easily.
+
+## Installation
+---------------
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'stripe_tester'
+```
+And then execute:
+```bash
+$ bundle
+```
+Or install it yourself as:
+```bash
+$ gem install stripe_tester
+```
+Ruby Version `>= 1.9.3`
+
+## Usage
+--------
+In your test:
+
+1. Set the URL where the webhooks are handled:
+```ruby
+    StripeTester.webhook_url = "http://www.example.com/my_post_url"
+```
+       
+2. Send the webhook. This will send a POST request to the URL with the event data as JSON:
+
+  The default Stripe webhook version will be the latest supported version
+```ruby
+    # as a symbol
+    StripeTester.create_event(:invoice_created)
+        
+    # or as a string
+    StripeTester.create_event("invoice_created")
+```
+       
+  Or if you want to overwrite certain attributes:
+```ruby
+StripeTester.create_event(:invoice_created, {"amount" => 100, "currency" => 'gbp'})
+```
+
+  If you want to specify which stripe webhook API version you would like to use:
+```ruby
+StripeTester.create_event(:invoice_created, "2013-05-07")
+```
+
+## Supported Webhooks 
+---------------------
+
+* charge_failed
+* charge_refunded
+* charge_succeeded
+* customer_created
+* customer_deleted
+* customer_subscription_created
+* customer_subscription_deleted
+* customer_subscription_updated
+* customer_subscription_trial_will_end
+* invoice_created
+* invoice_payment_failed
+* invoice_payment_succeeded
+* invoice_updated
+
+## Supported Stripe Webhook API Versions
+----------------------------------------
+
+* 2013-07-05
+* 2013-02-13
+
+## Issues
+---------
+
+* Overwriting attributes only overwrites the first occurrence of the key. It needs to overwrite all of the occurrences or make the user specify a certain one.
+
+
+## Contributing
+---------------
+
+* Fork it
+* Create your feature branch
+* Add your changes, and add a test for the changes.
+* Run tests using
+
+```bash 
+  $ rspec spec
+```
+* Make sure everything is passing
+* Push to the branch
+* Create a new Pull Request
+
+## License
+----------
+
+Copyright (c) 2013 ButterCloud LLC.
+
+MIT License
+
+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/Rakefile

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

data/lib/stripe_tester.rb

@@ -0,0 +1,97 @@
+require "stripe_tester/version"
+require 'uri'
+require 'net/http'
+require 'json'
+
+module StripeTester
+
+  LATEST_STRIPE_VERSION = "2013-07-05"
+
+  # run callback with options to customize the json
+  def self.create_event(callback_type, stripe_version=LATEST_STRIPE_VERSION, options={})
+    webhook_data = self.load_template(callback_type, stripe_version)
+    if webhook_data
+      webhook_data = overwrite_attributes(webhook_data, options) unless options.empty?
+      post_to_url(webhook_data)
+      true
+    end
+  end
+
+  # replace multiple values for multiple keys in a hash
+  def self.overwrite_attributes(original_data, options={})
+    data = original_data.clone
+    if options
+      options.each do |k,v|
+        replace_value(data, k, v)
+      end
+    end
+    data
+  end
+
+  # replaces a value for a single key in a hash
+  def self.replace_value(hash, key, new_value)
+    if hash.key?(key)
+      hash[key] = new_value
+    else
+      hash.values.each do |value|
+        value = value.first if value.is_a?(Array)
+        replace_value(value, key, new_value) if value.is_a?(Hash)
+      end
+      hash
+    end
+  end
+
+  def self.post_to_url(data={})
+    post_url = webhook_url
+
+    if post_url
+      # set up request
+      req = Net::HTTP::Post.new(post_url.path)
+      req.content_type = 'application/json'
+      req.body = data.to_json
+
+      # send request
+      res = Net::HTTP.start(post_url.hostname, post_url.port) do |http|
+        http.request(req)
+      end
+
+      case res
+      when Net::HTTPSuccess, Net::HTTPRedirection
+        # good
+      else
+        res.value
+      end
+    else
+      raise "Could not post to URL. Please set URL."
+    end
+  end
+
+  # load yaml with specified callback type
+  def self.load_template(callback_type, version)
+    spec = Gem::Specification.find_by_name("stripe_tester")
+    gem_root = spec.gem_dir
+
+    path = gem_root + "/stripe_webhooks/#{version}/#{callback_type}.yml"
+    if File.exists?(path)
+      template = Psych.load_file(path)
+    else
+      raise "Webhook not found. Please use a correct webhook type or correct stripe version"
+    end
+  end
+
+  # save the url and a URI object
+  def self.webhook_url=(url)
+    if url =~ /^#{URI::regexp}$/
+      temp_url = URI.parse(url)
+      @url = temp_url
+    end
+  end
+
+  def self.webhook_url
+    @url
+  end
+
+  def self.remove_url
+    @url = nil
+  end
+end

data/lib/stripe_tester/version.rb

@@ -0,0 +1,3 @@
+module StripeTester
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'stripe_tester'

data/spec/stripe_tester_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe StripeTester do
+
+  describe "instance methods" do
+
+    before(:each) do
+      @version = "2013-02-13"
+    end
+
+    it "#load_template should return hash" do
+      result = StripeTester.load_template(:invoice_created, @version)
+
+      expect(result).to be_a_kind_of(Hash)
+    end
+
+    it "#load_template should return correct callback type" do
+      type = "invoice_created"
+
+      returned_hash = StripeTester.load_template(type, @version)
+      returned_type = returned_hash["type"]
+
+      returned_type.sub!('.', '_')
+
+      expect(returned_type).to eq(type)
+    end
+
+    it "#load_template should raise an exception when invalid event is given" do
+      type = "incorrect_type"
+
+      expect { StripeTester.load_template(type, @version) }.to raise_error
+    end
+
+    it "#webhook_url should set the default url for the class" do
+      url = 'http://www.google.com'
+      StripeTester.remove_url
+      StripeTester.webhook_url = url
+
+      result_url = StripeTester.webhook_url
+      expect(result_url.to_s).to eq(url)
+    end
+
+    it "#webhook_url should store url as and URI object" do
+      url = 'http://www.hello.com'
+      StripeTester.remove_url
+      StripeTester.webhook_url = url
+
+      result_url = StripeTester.webhook_url
+      expect(result_url).to be_a_kind_of(URI)
+    end
+
+    it "#webhook_url should not store URL when URL is invalid" do
+      StripeTester.remove_url
+      StripeTester.webhook_url = 'datatatat'
+      expect(StripeTester.webhook_url).to eq(nil)
+    end
+
+    it "#post_to_url should send data to url" do
+
+    end
+
+    it "#post_to_url should raise an error if webhook URL is not set" do
+      StripeTester.remove_url
+      expect { StripeTester.post_to_url() }.to raise_error
+    end
+
+    it "#overwrite_attributes should overwrite attributes in default data to custom data" do
+      original_data = {name: 'john smith', info: {age: 45, gender: 'male'}}
+      overwrite_data = {name: 'smith john', age: 99}
+
+      new_data = StripeTester.overwrite_attributes(original_data, overwrite_data)
+
+      expect(new_data[:name]).to eq(overwrite_data[:name])
+      expect(new_data[:info][:age]).to eq(overwrite_data[:age])
+    end
+
+    it "#overwrite_attributes should return an unmodified hash when options don't exist" do
+      original_data = {name: 'john smith', info: {age: 45, gender: 'male'}}
+
+      new_data = StripeTester.overwrite_attributes(original_data)
+
+      expect(new_data).to eq(original_data)
+    end
+
+    it "#replace_value should replace a value of a given key in the hash" do
+      original_data = {name: 'john smith', info: {age: 45, gender: 'male'}}
+
+      new_data = StripeTester.replace_value(original_data, :age, 99)
+
+      expect(new_data[:info][:age]).to eq(99)
+    end
+
+    it "#create_event should send the event to the URL with the modified hash if options exist" do
+      
+    end
+
+    it "#create_event should send the event with an unmodified hash to the URL if options don't exist" do
+      
+    end
+  end
+end

data/stripe_tester.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stripe_tester/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stripe_tester"
+  spec.version       = StripeTester::VERSION
+  spec.authors       = ["Buttercloud"]
+  spec.email         = ["info@buttercloud.com"]
+  spec.description   = %q{Test Stripe webhooks locally}
+  spec.summary       = %q{Test Stripe webhooks locally}
+  spec.homepage      = "https://github.com/buttercloud/stripe_tester"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/stripe_webhooks/2013-02-13/charge_failed.yml

@@ -0,0 +1,44 @@
+---
+created: 1326853478
+data:
+  object:
+    amount: 100
+    amount_refunded: 0
+    captured: true
+    card:
+      address_city: 
+      address_country: 
+      address_line1: 
+      address_line1_check: 
+      address_line2: 
+      address_state: 
+      address_zip: 
+      address_zip_check: 
+      country: US
+      cvc_check: 
+      exp_month: 8
+      exp_year: 2014
+      fingerprint: TTKQdP1Omgi1czlY
+      last4: '4242'
+      name: 
+      object: card
+      type: Visa
+    created: 1372666708
+    currency: usd
+    customer: 
+    description: My First Test Charge (created for API docs)
+    dispute: 
+    failure_code: 
+    failure_message: 
+    fee: 0
+    fee_details: []
+    id: ch_00000000000000
+    invoice: 
+    livemode: false
+    object: charge
+    paid: false
+    refunded: false
+id: evt_00000000000000
+livemode: false
+object: event
+type: charge.failed