braintree 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7279d06aef254f1954bf7b8801e4717aa258f7413f05f1c076fbb6f1e2258c5
-  data.tar.gz: 9b136fbc93fa3f251972a44b0728244f746ef1868507cb40385780cd2137ff22
+  metadata.gz: 34698c59add2b3613d0c75e58d2d9d8ee5f3aecdd6ef85c79e303211199b4fa8
+  data.tar.gz: 933cf9e7d93aec94ba227fef1f03e4f245b7e0e4512b57ebf96ddd9ffef89cab
 SHA512:
-  metadata.gz: d611127df5091cb248b434285a2cd2c5080749515d60beba2a00af28809106dca11a4b5607f8774ac111d8115e5bbc85965817ba8fb45e309bbb2ecb8b8e4382
-  data.tar.gz: c7f547f0a2b62aa36b94e2f410e3375d1b4a2d3d7e76c570f3c9d387c15299a8ed858237db461de7f1889b5552e4c85dd1cedd42ce741c2360eeb38b71ef87c3
+  metadata.gz: d44a8addd727ea6efe503a33c275956bf0a359abe402ee42fff43785b48e30a84a29ecf6e6cbf8aacb080e8562e553f6c9c2424878575815f08cd563647e6762
+  data.tar.gz: 4b631596ff355ee26deceac5c37b61e66b0c5cf5336392120df61802be53b276cf2ebf9d93c6fb64dae3bea06d3dcb925644620aa829afaf7d2382328e7b2152

data/lib/braintree/plan.rb

@@ -33,6 +33,26 @@ module Braintree
 
     class << self
       protected :new
+
+      def create(*args)
+        Configuration.gateway.plan.create(*args)
+      end
+
+      def create!(*args)
+        Configuration.gateway.plan.create!(*args)
+      end
+
+      def find(*args)
+        Configuration.gateway.plan.find(*args)
+      end
+
+      def update(*args)
+        Configuration.gateway.plan.update(*args)
+      end
+
+      def update!(*args)
+        Configuration.gateway.plan.update!(*args)
+      end
     end
 
     def self._new(*args)

data/lib/braintree/plan_gateway.rb

@@ -1,5 +1,7 @@
 module Braintree
   class PlanGateway # :nodoc:
+    include BaseModule
+
     def initialize(gateway)
       @gateway = gateway
       @config = gateway.config
@@ -13,5 +15,103 @@ module Braintree
         Plan._new(@gateway, attributes)
       end
     end
+
+    def create(attributes)
+      Util.verify_keys(PlanGateway._create_signature, attributes)
+      _do_create "/plans", :plan => attributes
+    end
+
+    def create!(*args)
+      return_object_or_raise(:plan) { create(*args) }
+    end
+
+    def find(id)
+      raise ArgumentError if id.nil? || id.to_s.strip == ""
+      response = @config.http.get("#{@config.base_merchant_path}/plans/#{id}")
+      Plan._new(@gateway, response[:plan])
+    rescue NotFoundError
+      raise NotFoundError, "plan with id #{id.inspect} not found"
+    end
+
+    def update(plan_id, attributes)
+      Util.verify_keys(PlanGateway._update_signature, attributes)
+      response = @config.http.put("#{@config.base_merchant_path}/plans/#{plan_id}", :plan => attributes)
+      if response[:plan]
+        SuccessfulResult.new(:plan => Plan._new(@gateway, response[:plan]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :plan or :api_error_response"
+      end
+    end
+
+    def update!(*args)
+      return_object_or_raise(:plan) { update(*args) }
+    end
+
+    def self._create_signature
+      [
+        :billing_day_of_month,
+        :billing_frequency,
+        :currency_iso_code,
+        :description,
+        :id,
+        :merchant_id,
+        :name,
+        :number_of_billing_cycles,
+        :price,
+        :trial_duration,
+        :trial_duration_unit,
+        :trial_period
+      ] + _add_on_discount_signature
+    end
+
+    def self._update_signature
+      [
+        :billing_day_of_month,
+        :billing_frequency,
+        :currency_iso_code,
+        :description,
+        :id,
+        :merchant_id,
+        :name,
+        :number_of_billing_cycles,
+        :price,
+        :trial_duration,
+        :trial_duration_unit,
+        :trial_period
+      ] + _add_on_discount_signature
+    end
+
+    def self._add_on_discount_signature
+      [
+        {
+          :add_ons => [
+            {:add => [:amount, :inherited_from_id, :never_expires, :number_of_billing_cycles, :quantity]},
+            {:update => [:amount, :existing_id, :never_expires, :number_of_billing_cycles, :quantity]},
+            {:remove => [:_any_key_]}
+          ]
+        },
+        {
+          :discounts => [
+            {:add => [:amount, :inherited_from_id, :never_expires, :number_of_billing_cycles, :quantity]},
+            {:update => [:amount, :existing_id, :never_expires, :number_of_billing_cycles, :quantity]},
+            {:remove => [:_any_key_]}
+          ]
+        }
+      ]
+    end
+
+    def _do_create(path, params) # :nodoc:
+      response = @config.http.post("#{@config.base_merchant_path}#{path}", params)
+      if response[:plan]
+        SuccessfulResult.new(:plan => Plan._new(@gateway, response[:plan]))
+      elsif response[:errors]
+        ErrorResult.new(@gateway, response[:errors])
+      else
+        raise UnexpectedError, "expected :plan or :errors"
+      end
+    end
   end
 end
+

data/lib/braintree/successful_result.rb

@@ -16,6 +16,7 @@ module Braintree
     attr_reader :payment_method
     attr_reader :payment_method_nonce
     attr_reader :paypal_account
+    attr_reader :plan
     attr_reader :settlement_batch_summary
     attr_reader :subscription
     attr_reader :supported_networks

data/lib/braintree/transaction_review.rb

@@ -0,0 +1,18 @@
+module Braintree
+  class TransactionReview
+    include BaseModule
+
+    attr_reader :transaction_id, :decision, :reviewer_email, :reviewer_note, :reviewer_time
+
+    def initialize(attributes)
+      set_instance_variables_from_hash(attributes)
+    end
+
+    class << self
+      protected :new
+      def _new(*args) # :nodoc:
+        self.new(*args)
+      end
+    end
+  end
+end

data/lib/braintree/version.rb

@@ -1,7 +1,7 @@
 module Braintree
   module Version
     Major = 4
-    Minor = 4
+    Minor = 5
     Tiny = 0
 
     String = "#{Major}.#{Minor}.#{Tiny}"

data/lib/braintree/webhook_notification.rb

@@ -54,6 +54,7 @@ module Braintree
       SubMerchantAccountDeclined = "sub_merchant_account_declined"
 
       TransactionDisbursed = "transaction_disbursed"
+      TransactionReviewed = "transaction_reviewed"
       TransactionSettlementDeclined = "transaction_settlement_declined"
       TransactionSettled = "transaction_settled"
     end
@@ -76,6 +77,7 @@ module Braintree
     attr_reader :subscription
     attr_reader :timestamp
     attr_reader :transaction
+    attr_reader :transaction_review
 
     def self.parse(*args)
       Configuration.gateway.webhook_notification.parse(*args)
@@ -94,6 +96,7 @@ module Braintree
       @oauth_access_revocation = OpenStruct.new(@subject[:oauth_application_revocation]) if @subject.has_key?(:oauth_application_revocation)
       @subscription = Subscription._new(gateway, @subject[:subscription]) if @subject.has_key?(:subscription)
       @transaction = Transaction._new(gateway, @subject[:transaction]) if @subject.has_key?(:transaction)
+      @transaction_review = OpenStruct.new(@subject[:transaction_review]) if @subject.has_key?(:transaction_review)
       @disbursement = Disbursement._new(gateway, @subject[:disbursement]) if @subject.has_key?(:disbursement)
       @dispute = Dispute._new(@subject[:dispute]) if @subject.has_key?(:dispute)
       @account_updater_daily_report = AccountUpdaterDailyReport._new(@subject[:account_updater_daily_report]) if @subject.has_key?(:account_updater_daily_report)

data/lib/braintree/webhook_testing_gateway.rb

@@ -60,6 +60,8 @@ module Braintree
         _merchant_account_declined_sample_xml(id)
       when Braintree::WebhookNotification::Kind::TransactionDisbursed
         _transaction_disbursed_sample_xml(id)
+      when Braintree::WebhookNotification::Kind::TransactionReviewed
+        _transaction_reviewed_sample_xml(id)
       when Braintree::WebhookNotification::Kind::TransactionSettled
         _transaction_settled_sample_xml(id)
       when Braintree::WebhookNotification::Kind::TransactionSettlementDeclined
@@ -248,6 +250,19 @@ module Braintree
       XML
     end
 
+    def _transaction_reviewed_sample_xml(id)
+
+      <<-XML
+        <transaction-review>
+          <transaction-id>my_id</transaction-id>
+          <decision>decision</decision>
+          <reviewer-email>hey@girl.com</reviewer-email>
+          <reviewer-note>i reviewed this</reviewer-note>
+          <reviewed-time type="datetime">2017-06-16T20:44:41Z</reviewed-time>
+        </transaction-review>
+      XML
+    end
+
     def _transaction_settled_sample_xml(id)
       <<-XML
         <transaction>

data/spec/integration/braintree/plan_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+require File.expand_path(File.dirname(__FILE__) + "/client_api/spec_helper")
 
 describe Braintree::Plan do
 
@@ -48,6 +49,87 @@ describe Braintree::Plan do
     end
   end
 
+  describe "self.create" do
+    let(:attributes) do
+      {
+        :billing_day_of_month => 12,
+        :billing_frequency => 1,
+        :currency_iso_code => "USD",
+        :description => "description on create",
+        :name => "my new plan name",
+        :number_of_billing_cycles => 1,
+        :price => "9.99",
+        :trial_period => false
+      }
+
+      it "is successful with given params" do
+        result = Braintree::Plan.create(attributes)
+        expect(result.success?).to be_truthy
+        expect(result.plan.billing_day_of_month).to eq 12
+        expect(result.plan.description).to eq "description on create"
+        expect(result.plan.name).to eq "my new plan name"
+        expect(result.plan.price).to eq "9.99"
+        expect(result.plan.billing_frequency).to eq 1
+      end
+    end
+  end
+
+  describe "self.find" do
+    it "finds a plan" do
+      plan = Braintree::Plan.create(
+        :billing_day_of_month => 12,
+        :billing_frequency => 1,
+        :currency_iso_code => "USD",
+        :description => "description on create",
+        :name => "my new plan name",
+        :number_of_billing_cycles => 1,
+        :price => "9.99",
+        :trial_period => false,
+      ).plan
+
+      found_plan = Braintree::Plan.find(plan.id)
+      expect(found_plan.name).to eq plan.name
+    end
+
+    it "raises Braintree::NotFoundError if it cannot find" do
+      expect {
+        Braintree::Plan.find("noSuchPlan")
+      }.to raise_error(Braintree::NotFoundError, 'plan with id "noSuchPlan" not found')
+    end
+  end
+
+  describe "self.update!" do
+    before(:each) do
+      @plan = Braintree::Plan.create(
+        :billing_day_of_month => 12,
+        :billing_frequency => 1,
+        :currency_iso_code => "USD",
+        :description => "description on create",
+        :name => "my new plan name",
+        :number_of_billing_cycles => 1,
+        :price => "9.99",
+        :trial_period => false,
+      ).plan
+    end
+
+    it "returns the updated plan if valid" do
+      new_id = rand(36**9).to_s(36)
+      plan = Braintree::Plan.update!(@plan.id,
+                                     :name => "updated name",
+                                     :price => 99.88,
+                                    )
+
+      expect(plan.name).to eq "updated name"
+      expect(plan.price).to eq BigDecimal("99.88")
+    end
+
+    it "raises a ValidationsFailed if invalid" do
+      expect do
+        Braintree::Plan.update!(@plan.id, :number_of_billing_cycles => "number of billing cycles")
+      end.to raise_error(Braintree::ValidationsFailed)
+    end
+  end
+
   def create_plan_for_tests(attributes)
     config = Braintree::Configuration.gateway.config
     config.http.post("#{config.base_merchant_path}/plans/create_plan_for_tests", :plan => attributes)

data/spec/unit/braintree/webhook_notification_spec.rb

@@ -317,6 +317,24 @@ describe Braintree::WebhookNotification do
       end
     end
 
+    context "transaction review" do
+      it " builds a sample notification for a transaction reviewed webhook" do
+        sample_notification = Braintree::WebhookTesting.sample_notification(
+          Braintree::WebhookNotification::Kind::TransactionReviewed,
+          "my_id",
+        )
+
+        notification = Braintree::WebhookNotification.parse(sample_notification[:bt_signature], sample_notification[:bt_payload])
+
+        expect(notification.kind).to eq(Braintree::WebhookNotification::Kind::TransactionReviewed)
+        expect(notification.transaction_review.transaction_id).to eq("my_id")
+        expect(notification.transaction_review.decision).to eq("decision")
+        expect(notification.transaction_review.reviewer_email).to eq("hey@girl.com")
+        expect(notification.transaction_review.reviewer_note).to eq("i reviewed this")
+        expect(notification.transaction_review.reviewed_time).to_not be_nil
+      end
+    end
+
     context "us bank account transactions" do
       it "builds a sample notification for a settlement webhook" do
         sample_notification = Braintree::WebhookTesting.sample_notification(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braintree
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Braintree
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -176,6 +176,7 @@ files:
 - lib/braintree/transaction_gateway.rb
 - lib/braintree/transaction_line_item.rb
 - lib/braintree/transaction_line_item_gateway.rb
+- lib/braintree/transaction_review.rb
 - lib/braintree/transaction_search.rb
 - lib/braintree/unknown_payment_method.rb
 - lib/braintree/us_bank_account.rb
@@ -333,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.2.31
 signing_key: 
 specification_version: 4
 summary: Braintree Ruby Server SDK