stripe_tester 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06f6394aa9d07f63c05ab4ec77775015f244f57e
-  data.tar.gz: 5f8becdc1a3db570a0113a31fea1d331ffce73a4
+  metadata.gz: dc24a66f567268e0680c750da9e2946053fb0bc5
+  data.tar.gz: 5a96c275404f6cb1c60b0ac41900e4cadb953c27
 SHA512:
-  metadata.gz: 6a5fd56e31a7bdc6ab7cb1a13922636dbe994d6dffe0edff5e891920ea2cb3ff9dc464e8fd317cd5dfd9ff5fd44b1219e9df5edab0fedfa4340cce75b5f8f906
-  data.tar.gz: f83c7aa752beb8d06ebb2ad1b49696814807942cf38448a69d56405ef1dcd87139d447e9cc8917a33735670efa847afdd59a1e0871a93179be176fc1e014a096
+  metadata.gz: 271bfe5c2a9aa3a02dc15e697abe1c3c6beacf45dac985e4f148aa7e8e6f68028ead6ad26646b6df4509fcebcfa433a511e35099a00ea834e2ffdc9dc4ad0938
+  data.tar.gz: 1f0924a40305edbc408ff38a77949f771d875871ef4e6abfca013d498a1b2596d6e58690a65447a403aeafe38d620f5b3b9947ca005d5c0fe039d71f27c087c9

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 ButterCloud LLC.
+Copyright (c) 2016 ButterCloud LLC.
 
 MIT License
 

data/README.md

@@ -10,7 +10,7 @@ StripeTester allows you to submit webhooks to your application without hitting S
 
 Add this line to your application's Gemfile:
 ```ruby
-gem 'stripe_tester', "~> 0.4.0"
+gem 'stripe_tester', "~> 0.5.0"
 ```
 And then execute:
 ```bash
@@ -32,52 +32,67 @@ RSpec
 In your test:
 
 1. Set the URL where the webhooks are handled:
-```ruby
-    # Normal HTTP URL
-    StripeTester.webhook_url = "http://www.example.com/my_post_url"
+  ```ruby
+  # Normal HTTP URL
+  StripeTester.webhook_url = "http://www.example.com/my_post_url"
 
-    # HTTPS URL
-    StripeTester.webhook_url = "https://www.secure-example.com/my_post_url"
-```
+  # HTTPS URL
+  StripeTester.webhook_url = "https://www.secure-example.com/my_post_url"
+  ```
 
 2. If your URL is secured with a self-signed SSL certificate, disable SSL verification:
-```ruby
-StripeTester.verify_ssl = false
-```
+  ```ruby
+  StripeTester.verify_ssl = false
+  ```
 
 3. If you want to specify which Stripe webhook API version you would like to use (the default will be the latest [supported version](https://github.com/buttercloud/stripe_tester#supported-stripe-webhook-api-versions)):
-```ruby
-    StripeTester.stripe_version = "2015-10-16"
-```
-
-4. Send the webhook. This will send a POST request to the URL with the event data as JSON:
-```ruby
-    # as a symbol
-    StripeTester.create_event(:invoice_created)
-
-    # or as a string
-    StripeTester.create_event("invoice_created")
-```
+  ```ruby
+  StripeTester.stripe_version = "2015-10-16"
+  ```
+
+4. If you are using username and password in your Stripe webhook event, you can provide it in two ways:
+
+  This will set basic auth with the default username, `stripe`, and the password provided:
+  ```ruby
+      StripeTester.webhook_password = "<password>"
+  ```
+  Or you can set the username and password in the URL:
+  ```ruby
+      # Normal HTTP URL
+      StripeTester.webhook_url = "http://stripe:password@www.example.com/my_post_url"
+
+      # HTTPS URL
+      StripeTester.webhook_url = "https://stripe:password@www.secure-example.com/my_post_url"
+  ```
+
+5. Send the webhook. This will send a POST request to the URL with the event data as JSON:
+  ```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 globally:
-```ruby
-StripeTester.create_event(:invoice_created, {"amount" => 100, "currency" => 'gbp'})
-```
+  ```ruby
+  StripeTester.create_event(:invoice_created, {"amount" => 100, "currency" => 'gbp'})
+  ```
 
   Or you can explicitly overwrite certain attributes using deep object merging:
-```ruby
-StripeTester.create_event(:customer_subscription_created, {"data"=>{"object"=>{"plan"=>{"id"=>"gold-v1"}}}}, :method=>:merge)
-```
+  ```ruby
+  StripeTester.create_event(:customer_subscription_created, {"data"=>{"object"=>{"plan"=>{"id"=>"gold-v1"}}}}, :method=>:merge)
+  ```
 
   If you want to load the JSON only:
-```ruby
-json = StripeTester.load_template(:invoice_payment_failed)
-```
+  ```ruby
+  json = StripeTester.load_template(:invoice_payment_failed)
+  ```
 
   You can also overwrite certain attributes in the JSON:
-```ruby
-json = StripeTester.load_template(:invoice_payment_failed, {"data"=>{"object"=>{"customer"=>"cus_MYCUSTOMERID"}}}, :method=>:merge)
-```
+  ```ruby
+  json = StripeTester.load_template(:invoice_payment_failed, {"data"=>{"object"=>{"customer"=>"cus_MYCUSTOMERID"}}}, :method=>:merge)
+  ```
 
 ## Supported Stripe Webhook API Versions
 
@@ -106,7 +121,7 @@ json = StripeTester.load_template(:invoice_payment_failed, {"data"=>{"object"=>{
 
 ## License
 
-Copyright (c) 2015 ButterCloud LLC.
+Copyright (c) 2016 ButterCloud LLC.
 
 MIT License
 

data/lib/stripe_tester.rb

@@ -21,7 +21,7 @@ module StripeTester
   def self.overwrite_attributes(original_data, attributes={})
     data = original_data.clone
     if attributes
-      attributes.each do |k,v|
+      indifferent(attributes).each do |k,v|
         replace_value(data, k, v)
       end
     end
@@ -45,7 +45,7 @@ module StripeTester
   def self.merge_attributes(original_attributes, new_attributes={})
     original_attributes = original_attributes.clone
     if new_attributes
-      new_attributes.each do |key, value|
+      indifferent(new_attributes).each do |key, value|
         if value.is_a?(Hash) && original_attributes[key].is_a?(Hash)
           original_attributes[key] = self.merge_attributes original_attributes[key], value
         else
@@ -64,7 +64,7 @@ module StripeTester
       req = Net::HTTP::Post.new(post_url.path)
       req.content_type = 'application/json'
       req.body = data.to_json
-
+      req.basic_auth 'stripe', self.basic_authentication_password if !self.basic_authentication_password.nil?
       http_object = Net::HTTP.new(post_url.hostname, post_url.port)
       http_object.use_ssl = true if post_url.scheme == 'https'
       http_object.verify_mode = OpenSSL::SSL::VERIFY_NONE if (!verify_ssl? && http_object.use_ssl?)
@@ -93,8 +93,8 @@ module StripeTester
 
     path = gem_root + "/stripe_webhooks/#{version}/#{callback_type}.yml"
     if File.exists?(path)
-      template = Psych.load_file(path)
-
+      template = indifferent(Psych.load_file(path))
+      
       unless attributes.empty?
         if options[:method] == :merge
           template = merge_attributes(template, attributes)
@@ -125,6 +125,18 @@ module StripeTester
     @url = nil
   end
 
+  def self.webhook_password=(webhook_password)
+    @webhook_password =  webhook_password
+  end
+
+  def self.webhook_password
+    @webhook_password
+  end
+
+  def self.basic_authentication_password
+    @webhook_password || self.webhook_url.password
+  end
+
   def self.stripe_version=(version)
     @version = version
   end
@@ -140,5 +152,15 @@ module StripeTester
   def self.verify_ssl?
     !@verify_ssl.nil? ? @verify_ssl : true
   end
+  
+  private
+  
+  def self.indifferent(obj)
+    if obj.is_a?(Hash) && obj.respond_to?(:with_indifferent_access)
+      obj.with_indifferent_access
+    else
+      obj
+    end
+  end
 
 end

data/lib/stripe_tester/version.rb

@@ -1,3 +1,3 @@
 module StripeTester
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/stripe_tester_spec.rb

@@ -13,29 +13,47 @@ describe StripeTester do
     after(:each) do
       StripeTester.stripe_version = nil
       StripeTester.verify_ssl = nil
+      StripeTester.webhook_password = nil
     end
 
-    it "#load_template should return hash" do
-      result = StripeTester.load_template(:invoice_created)
-
-      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)
-      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) }.to raise_error
+    describe "#load_template" do
+      it "should return hash" do
+        result = StripeTester.load_template(:invoice_created)
+
+        expect(result).to be_a_kind_of(Hash)
+      end
+    
+      context "Hash with_indifferent_access supported" do
+        it "should call with_indifferent_access on Hash" do
+          allow_any_instance_of(Hash).to receive(:with_indifferent_access)
+          expect_any_instance_of(Hash).to receive(:with_indifferent_access)
+          StripeTester.load_template(:invoice_created)
+        end
+      end
+    
+      context "Hash with_indifferent_access not supported" do
+        it "should not call with_indifferent_access" do
+          allow_any_instance_of(Hash).to receive(:respond_to?).with(:with_indifferent_access).and_return(false)
+          expect_any_instance_of(Hash).not_to receive(:with_indifferent_access)
+          StripeTester.load_template(:invoice_created)
+        end
+      end
+    
+      it "should return correct callback type" do
+        type = "invoice_created"
+
+        returned_hash = StripeTester.load_template(type)
+        returned_type = returned_hash["type"]
+
+        returned_type.sub!('.', '_')
+
+        expect(returned_type).to eq(type)
+      end
+
+      it "should raise an exception when invalid event is given" do
+        type = "incorrect_type"
+        expect { StripeTester.load_template(type) }.to raise_error("Webhook not found. Please use a correct webhook type or correct Stripe version")
+      end
     end
 
     it "#stripe_version should set the correct stripe version" do
@@ -57,6 +75,23 @@ describe StripeTester do
       expect(result_url.to_s).to eq(url)
     end
 
+    it "#webhook_url should set the correct url if authentication is provided in url itself" do
+      url = 'http://abc:def@www.google.com'
+      StripeTester.webhook_url = url
+
+      result_url = StripeTester.webhook_url
+      expect(result_url.to_s).to eq(url)
+    end
+
+    it "#webhook_url should have correct url when password is provided through webhook_password" do
+      url = 'http://www.google.com'
+      StripeTester.webhook_url = url
+      StripeTester.webhook_password = 'password'
+
+      result_url = StripeTester.webhook_url
+      expect(result_url.to_s).to eq(url)
+    end
+
     it "#verify_ssl should default to true" do
       result_verify = StripeTester.verify_ssl?
       expect(result_verify).to eq(true)
@@ -97,6 +132,38 @@ describe StripeTester do
       expect(response).to be_truthy
     end
 
+    it "#post_to_url should return true when authentication is provided" do
+      data = StripeTester.load_template(:invoice_created)
+      url = "http://localhost:3000/transactions"
+      fake_web_url = "http://stripe:password@localhost:3000/transactions"
+      StripeTester.webhook_url = url
+      StripeTester.webhook_password='password'
+
+      FakeWeb.register_uri(:post,
+                           fake_web_url,
+                           body: data.to_json,
+                           content_type: 'application/json')
+
+      response = StripeTester.post_to_url(data)
+
+      expect(response).to be_truthy
+    end
+
+    it "#post_to_url should return true when authentication is provided through url" do
+      data = StripeTester.load_template(:invoice_created)
+      url = "http://stripe:password@localhost:3000/transactions"
+      StripeTester.webhook_url = url
+
+      FakeWeb.register_uri(:post,
+                           url,
+                           body: data.to_json,
+                           content_type: 'application/json')
+
+      response = StripeTester.post_to_url(data)
+
+      expect(response).to be_truthy
+    end
+
     it "#post_to_url should raise an error when request fails" do
       data = StripeTester.load_template(:invoice_created)
       url = "http://localhost:3000/"
@@ -112,7 +179,7 @@ describe StripeTester do
     end
 
     it "#post_to_url should raise an error if webhook URL is not set" do
-      expect { StripeTester.post_to_url() }.to raise_error
+      expect { StripeTester.post_to_url() }.to raise_error("Could not post to URL. Please set URL.")
     end
 
     it "#post_to_url should support HTTPS requests" do
@@ -147,24 +214,42 @@ describe StripeTester do
       expect(response).to be_truthy
     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)
+    describe "#overwrite_attributes" do
+      it "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 "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
+      
+      context "Hash with_indifferent_access supported" do
+        it "should call with_indifferent_access on Hash" do
+          allow_any_instance_of(Hash).to receive(:with_indifferent_access).and_return({})
+          expect_any_instance_of(Hash).to receive(:with_indifferent_access)
+          StripeTester.overwrite_attributes({}, {})
+        end
+      end
+    
+      context "Hash with_indifferent_access not supported" do
+        it "should not call with_indifferent_access" do
+          allow_any_instance_of(Hash).to receive(:respond_to?).with(:with_indifferent_access).and_return(false)
+          expect_any_instance_of(Hash).not_to receive(:with_indifferent_access)
+          StripeTester.overwrite_attributes({}, {})
+        end
+      end
     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'}}
 
@@ -173,22 +258,41 @@ describe StripeTester do
       expect(new_data[:info][:age]).to eq(99)
     end
 
-    it "#merge_attributes should do a deep merge" do
-      original_data = {name: 'john smith',
-                       info: {age: 45,
-                              gender: 'male',
-                              occupation: {title: 'Software Developer',
-                                           employer: 'ACME, Inc'},
-                              address: {street: '123 Fake St',
-                                        city: 'Somewhere',
-                                        state: 'NC',
-                                        zip: '12345'}}}
-      new_data = StripeTester.merge_attributes(original_data, {name: 'jane smith', info: {gender: 'female', address: {city: 'Springfield'}}})
-      expect(new_data[:name]).to eq('jane smith')
-      expect(new_data[:info][:gender]).to eq('female')
-      expect(new_data[:info][:age]).to eq(45)
-      expect(new_data[:info][:address][:city]).to eq('Springfield')
-      expect(new_data[:info][:address][:state]).to eq('NC')
+    describe "#merge_attributes" do
+      it "should do a deep merge" do
+        original_data = {name: 'john smith',
+                         info: {age: 45,
+                                gender: 'male',
+                                occupation: {title: 'Software Developer',
+                                             employer: 'ACME, Inc'},
+                                address: {street: '123 Fake St',
+                                          city: 'Somewhere',
+                                          state: 'NC',
+                                          zip: '12345'}}}
+        new_data = StripeTester.merge_attributes(original_data, {name: 'jane smith', info: {gender: 'female', address: {city: 'Springfield'}}})
+        expect(new_data[:name]).to eq('jane smith')
+        expect(new_data[:info][:gender]).to eq('female')
+        expect(new_data[:info][:age]).to eq(45)
+        expect(new_data[:info][:address][:city]).to eq('Springfield')
+        expect(new_data[:info][:address][:state]).to eq('NC')
+      end
+    
+      context "Hash with_indifferent_access supported" do
+        it "should call with_indifferent_access on Hash" do
+          allow_any_instance_of(Hash).to receive(:with_indifferent_access).and_return({})
+          expect_any_instance_of(Hash).to receive(:with_indifferent_access)
+          StripeTester.merge_attributes({}, {})
+        end
+      end
+    
+      context "Hash with_indifferent_access not supported" do
+        it "should not call with_indifferent_access" do
+          allow_any_instance_of(Hash).to receive(:respond_to?).with(:with_indifferent_access).and_return(false)
+          expect_any_instance_of(Hash).not_to receive(:with_indifferent_access)
+          StripeTester.merge_attributes({}, {})
+        end
+      end
     end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe_tester
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Buttercloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-10 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler