Billing client - new v2 subscriptions (#1125)

* billing-client updateed for v2 subscriptions

* fixes and specs

Author: piotrmilcarz

lib/travis/api/v3/billing_client.rb

@@ -16,17 +16,38 @@ def all
       Travis::API::V3::Models::SubscriptionsCollection.new(subscriptions, permissions)
     end
 
+    def all_v2
+      data = connection.get('/v2/subscriptions').body
+      subscriptions = data.fetch('plans').map do |subscription_data|
+        Travis::API::V3::Models::V2Subscription.new(subscription_data)
+      end
+      permissions = data.fetch('permissions')
+
+      Travis::API::V3::Models::SubscriptionsCollection.new(subscriptions, permissions)
+    end
+
     def get_subscription(id)
       response = connection.get("/subscriptions/#{id}")
       handle_subscription_response(response)
     end
 
+    def get_v2_subscription(id)
+      response = connection.get("/v2/subscriptions/#{id}")
+      handle_v2_subscription_response(response)
+    end
+
     def get_invoices_for_subscription(id)
       connection.get("/subscriptions/#{id}/invoices").body.map do |invoice_data|
         Travis::API::V3::Models::Invoice.new(invoice_data)
       end
     end
 
+    def get_invoices_for_v2_subscription(id)
+      connection.get("/v2/subscriptions/#{id}/invoices").body.map do |invoice_data|
+        Travis::API::V3::Models::Invoice.new(invoice_data)
+      end
+    end
+
     def trials
       connection.get('/trials').body.map do | trial_data |
         Travis::API::V3::Models::Trial.new(trial_data)
@@ -43,11 +64,21 @@ def update_address(subscription_id, address_data)
       handle_subscription_response(response)
     end
 
+    def update_v2_address(subscription_id, address_data)
+      response = connection.patch("/v2/subscriptions/#{subscription_id}/address", address_data)
+      handle_v2_subscription_response(response)
+    end
+
     def update_creditcard(subscription_id, creditcard_token)
       response = connection.patch("/subscriptions/#{subscription_id}/creditcard", token: creditcard_token)
       handle_subscription_response(response)
     end
 
+    def update_v2_creditcard(subscription_id, creditcard_token)
+      response = connection.patch("/v2/subscriptions/#{subscription_id}/creditcard", token: creditcard_token)
+      handle_v2_subscription_response(response)
+    end
+
     def update_plan(subscription_id, plan_data)
       response = connection.patch("/subscriptions/#{subscription_id}/plan", plan_data)
       handle_subscription_response(response)
@@ -58,6 +89,11 @@ def create_subscription(subscription_data)
       handle_subscription_response(response)
     end
 
+    def create_v2_subscription(subscription_data)
+      response = connection.post('/v2/subscriptions', subscription_data)
+      handle_v2_subscription_response(response)
+    end
+
     def cancel_subscription(id, reason_data)
       response = connection.post("/subscriptions/#{id}/cancel", reason_data)
       handle_subscription_response(response)
@@ -85,6 +121,11 @@ def pay(id)
       handle_subscription_response(response)
     end
 
+    def pay_v2(id)
+      response = connection.post("/v2/subscriptions/#{id}/pay")
+      handle_v2_subscription_response(response)
+    end
+
     def get_coupon(code)
       response = connection.get("/coupons/#{code}")
       handle_coupon_response(response)
@@ -101,6 +142,10 @@ def handle_subscription_response(response)
       handle_errors_and_respond(response) { |r| Travis::API::V3::Models::Subscription.new(r) }
     end
 
+    def handle_v2_subscription_response(response)
+      handle_errors_and_respond(response) { |r| Travis::API::V3::Models::V2Subscription.new(r) }
+    end
+
     def handle_coupon_response(response)
       handle_errors_and_respond(response) { |r| Travis::API::V3::Models::Coupon.new(r) }
     end

lib/travis/api/v3/models/v2_subscription.rb

@@ -0,0 +1,20 @@
+module Travis::API::V3
+  class Models::V2Subscription
+    include Models::Owner
+
+    attr_reader :id, :permissions, :status, :source, :billing_info, :credit_card_info, :owner, :payment_intent, :addons, :created_at
+
+    def initialize(attributes = {})
+      @id = attributes.fetch('id')
+      @permissions = Models::BillingPermissions.new(attributes.fetch('permissions'))
+      @status = attributes.fetch('status')
+      @source = attributes.fetch('source')
+      @billing_info = attributes['billing_info'] && Models::BillingInfo.new(@id, attributes['billing_info'])
+      @credit_card_info = attributes['credit_card_info'] && Models::CreditCardInfo.new(@id, attributes['credit_card_info'])
+      @payment_intent = attributes['payment_intent'] && Models::PaymentIntent.new(attributes['payment_intent'])
+      @owner = fetch_owner(attributes.fetch('owner'))
+      @addons = attributes.fetch('addons')
+      @created_at = attributes.fetch('created_at')
+    end
+  end
+end

spec/support/billing_spec_helper.rb

@@ -43,6 +43,86 @@ def billing_subscription_response_body(attributes={})
       }.deep_merge(attributes)
     end
 
+    def billing_v2_subscription_response_body(attributes={})
+      {
+        "permissions" => { "read" => true, "write" => true },
+        "id" => 81,
+        "addons" => billing_addons_response_body,
+        "source" => "manual",
+        "status" => "",
+        "created_at" => "2017-11-28T00:09:59.502Z",
+        "billing_info" => {
+          "first_name" => "ana",
+          "last_name" => "rosas",
+          "company" => "",
+          "billing_email" => "[email protected]",
+          "zip_code" => "28450",
+          "address" => "Luis Spota",
+          "address2" => "",
+          "city" => "Comala",
+          "state" => nil,
+          "country" => "Mexico",
+          "vat_id" => "123456"
+        },
+        "credit_card_info" => {
+          "card_owner" => "ana",
+          "last_digits" => "4242",
+          "expiration_date" => "9/2021"
+        },
+        "owner" => {
+          "type" => "Organization",
+          "id" => 43
+        }
+      }.deep_merge(attributes)
+    end
+
+    def billing_addons_response_body(attributes={})
+      {
+        "addons" => [
+          {
+            "id" => "1",
+            "plan_id" => "1",
+            "name" => "OSS Build Credits",
+            "addon_type" => "credit_public",
+            "created_at" => "2020-07-09T12:06:13.293Z",
+            "updated_at" => "2020-07-09T12:07:03.619Z",
+            "current_usage_id" => 1,
+            "current_usage" => {
+                "id" => 1,
+                "addon_id" => 1,
+                "addon_quantity" => 10000,
+                "addon_usage" => 0,
+                "purchase_date" => "2020-07-09T12:06:27.919Z",
+                "valid_to" => nil,
+                "status" => "active",
+                "created_at" => "2020-07-09T12:06:27.944Z",
+                "updated_at" => "2020-07-09T12:06:27.944Z"
+            }
+          },
+          {
+            "id" => 2,
+            "plan_id" => 1,
+            "name" => "Build Credits",
+            "addon_type" => "credit_private",
+            "created_at" => "2020-07-09T12:06:17.003Z",
+            "updated_at" => "2020-07-09T12:07:09.067Z",
+            "current_usage_id" => 2,
+            "current_usage" => {
+              "id" => 2,
+              "addon_id" => 2,
+              "addon_quantity" => 10000,
+              "addon_usage" => 0,
+              "purchase_date" => "2020-07-09T12:06:31.739Z",
+              "valid_to" => nil,
+              "status" => "active",
+              "created_at" => "2020-07-09T12:06:31.741Z",
+              "updated_at" => "2020-07-09T12:06:31.741Z"
+            }
+          }
+        ]
+      }.deep_merge(attributes)
+    end
+
     def billing_plan_response_body(attributes={})
       {
         "id" => "travis-ci-ten-builds",

spec/v3/billing_client_spec.rb

@@ -60,6 +60,25 @@
     end
   end
 
+  describe '#get_invoices_for_v2_subscription' do
+    subject { billing.get_invoices_for_v2_subscription(subscription_id) }
+
+    it 'returns a list of invoices' do
+      stub_billing_request(:get, "/v2/subscriptions/#{subscription_id}/invoices", auth_key: auth_key, user_id: user_id)
+        .to_return(body: JSON.dump([{'id' => invoice_id, 'created_at' => Time.now, 'url' => 'https://billing-test.travis-ci.com/invoices/111.pdf', amount_due: 999 }]))
+      expect(subject.first).to be_a(Travis::API::V3::Models::Invoice)
+      expect(subject.first.id).to eq(invoice_id)
+      expect(subject.first.amount_due).to eq(999)
+    end
+
+    it 'returns an empty list if there are no invoices' do
+      stub_billing_request(:get, "/v2/subscriptions/#{subscription_id}/invoices", auth_key: auth_key, user_id: user_id)
+        .to_return(body: JSON.dump([]))
+
+        expect(subject.size).to eq 0
+    end
+  end
+
   describe '#all' do
     subject { billing.all }
 
@@ -75,6 +94,21 @@
     end
   end
 
+  describe '#all_v2' do
+    subject { billing.all_v2 }
+
+    let(:permissions) { [{'owner' => {'type' => 'Organization', 'id' => 1}, 'create' => true}] }
+
+    it 'returns the list of subscriptions' do
+      stub_billing_request(:get, '/v2/subscriptions', auth_key: auth_key, user_id: user_id)
+        .to_return(body: JSON.dump(subscriptions: [billing_v2_subscription_response_body('id' => subscription_id, 'owner' => { 'type' => 'Organization', 'id' => organization.id })], permissions: permissions))
+
+      expect(subject.subscriptions.size).to eq 1
+      expect(subject.subscriptions.first.id).to eq(subscription_id)
+      expect(subject.permissions).to eq(permissions)
+    end
+  end
+
   describe '#update_address' do
     let(:address_data) { { 'address' => 'Rigaer Strasse' } }
     subject { billing.update_address(subscription_id, address_data) }
@@ -89,6 +123,20 @@
     end
   end
 
+  describe '#update_v2_address' do
+    let(:address_data) { { 'address' => 'Rigaer Strasse' } }
+    subject { billing.update_v2_address(subscription_id, address_data) }
+
+    it 'requests the update' do
+      stubbed_request = stub_billing_request(:patch, "/v2/subscriptions/#{subscription_id}/address", auth_key: auth_key, user_id: user_id)
+        .with(body: JSON.dump(address_data))
+        .to_return(status: 204)
+
+      expect { subject }.to_not raise_error
+      expect(stubbed_request).to have_been_made
+    end
+  end
+
   describe '#update_plan' do
     let(:plan_data) { { 'plan' => 'travis-ci-ten-builds' } }
     subject { billing.update_plan(subscription_id, plan_data) }
@@ -117,6 +165,20 @@
     end
   end
 
+  describe '#update_v2_creditcard' do
+    let(:creditcard_token) { 'token' }
+    subject { billing.update_v2_creditcard(subscription_id, creditcard_token) }
+
+    it 'requests the update' do
+      stubbed_request = stub_billing_request(:patch, "/v2/subscriptions/#{subscription_id}/creditcard", auth_key: auth_key, user_id: user_id)
+        .with(body: JSON.dump(token: creditcard_token))
+        .to_return(status: 204)
+
+      expect { subject }.to_not raise_error
+      expect(stubbed_request).to have_been_made
+    end
+  end
+
   describe '#resubscribe' do
     subject { billing.resubscribe(subscription_id) }
 
@@ -156,6 +218,20 @@
     end
   end
 
+  describe '#create_v2_subscription' do
+    let(:subscription_data) {{ 'address' => 'Rigaer' }}
+    subject { billing.create_v2_subscription(subscription_data) }
+
+    it 'requests the creation and returns the representation' do
+      stubbed_request = stub_billing_request(:post, "/v2/subscriptions", auth_key: auth_key, user_id: user_id)
+        .with(body: JSON.dump(subscription_data))
+        .to_return(status: 201, body: JSON.dump(billing_v2_subscription_response_body('id' => 456, 'owner' => { 'type' => 'Organization', 'id' => organization.id })))
+
+      expect(subject.id).to eq(456)
+      expect(stubbed_request).to have_been_made
+    end
+  end
+
   describe '#pay' do
     subject { billing.pay(subscription_id) }
 
@@ -168,6 +244,18 @@
     end
   end
 
+  describe '#pay_v2' do
+    subject { billing.pay_v2(subscription_id) }
+
+    it 'requests to retry payment' do
+      stubbed_request = stub_billing_request(:post, "/v2/subscriptions/#{subscription_id}/pay", auth_key: auth_key, user_id: user_id)
+        .to_return(status: 200, body: JSON.dump(billing_v2_subscription_response_body('id' => subscription_id, 'owner' => { 'type' => 'Organization', 'id' => organization.id })))
+
+      expect { subject }.to_not raise_error
+      expect(stubbed_request).to have_been_made
+    end
+  end
+
   describe '#trials' do
     subject { billing.trials }
     let(:trial_id) { rand(999) }