Merge pull request #1143 from AndriiMysko/am-get-user-usage

Retrieve user license usage api point

Author: AndriiMysko

lib/travis/api/v3/billing_client.rb

@@ -125,6 +125,12 @@ def purchase_addon(subscription_id, addon_config_id)
       handle_v2_subscription_response(response)
     end
 
+    def v2_subscription_user_usages(subscription_id)
+      connection.get("/v2/subscriptions/#{subscription_id}/user_usage").body.map do |usage_data|
+        Travis::API::V3::Models::V2AddonUsage.new(usage_data)
+      end
+    end
+
     def v2_plans_for_organization(organization_id)
       connection.get("/v2/plans_for/organization/#{organization_id}").body.map do |plan_data|
         Travis::API::V3::Models::V2PlanConfig.new(plan_data)

lib/travis/api/v3/queries/v2_addon_usages.rb

@@ -0,0 +1,10 @@
+module Travis::API::V3
+  class Queries::V2AddonUsages < Query
+    def all(user_id)
+      return unless params['subscription.id']
+
+      client = BillingClient.new(user_id)
+      client.v2_subscription_user_usages(params['subscription.id'])
+    end
+  end
+end

lib/travis/api/v3/renderer/v2_addon_usages.rb

@@ -0,0 +1,6 @@
+module Travis::API::V3
+  class Renderer::V2AddonUsages < CollectionRenderer
+    type           :v2_addon_usages
+    collection_key :v2_addon_usages
+  end
+end

lib/travis/api/v3/routes.rb

@@ -326,6 +326,7 @@ module Routes
       patch :update_plan, '/plan'
       post :pay, '/pay'
       post :buy_addon, '/addon/{addon.id}'
+      get :user_usages, '/user_usages'
       get :invoices, '/invoices'
     end
 

lib/travis/api/v3/services/v2_subscription/user_usages.rb

@@ -0,0 +1,11 @@
+module Travis::API::V3
+  class Services::V2Subscription::UserUsages < Service
+    params :subscription_id
+    result_type :v2_addon_usages
+
+    def run!
+      raise LoginRequired unless access_control.full_access_or_logged_in?
+      result query(:v2_addon_usages).all(access_control.user.id)
+    end
+  end
+end

spec/support/billing_spec_helper.rb

@@ -160,6 +160,22 @@ def billing_addons_response_body
       ]
     end
 
+    def billing_addon_usage_response_body(attributes = {})
+      {
+        'id' => 1,
+        'addon_id' => 1,
+        'addon_quantity' => 100,
+        'addon_usage' => 0,
+        'remaining' => 100,
+        'purchase_date' => '2020-09-14T11:25:02.612Z',
+        'valid_to' => '2020-10-14T11:25:02.612Z',
+        'status' => 'subscribed',
+        'active' => true,
+        'created_at' => '2020-09-14T11:25:02.614Z',
+        'updated_at' => '2020-09-14T11:25:02.614Z'
+      }.deep_merge(attributes)
+    end
+
     def billing_plan_response_body(attributes={})
       {
         "id" => "travis-ci-ten-builds",
@@ -171,6 +187,42 @@ def billing_plan_response_body(attributes={})
       }.deep_merge(attributes)
     end
 
+    def billing_v2_plan_response_body(attributes = {})
+      {
+        'id' => 'free_tier_plan',
+        'name' => 'Free Tier Plan',
+        'private_repos' => true,
+        'addon_configs' => [
+          {
+            'id' => 'oss_tier_credits',
+            'name' => 'Free 40 000 credits (renewed monthly)',
+            'price' => 0,
+            'quantity' => 40_000,
+            'type' => 'credit_public'
+          },
+          {
+            'id' => 'free_tier_credits',
+            'name' => 'Free 10 000 credits (renewed monthly)',
+            'price' => 0,
+            'quantity' => 10_000,
+            'type' => 'credit_private'
+          },
+          {
+            'id' => 'users_free',
+            'name' => 'Unlimited users',
+            'price' => 0,
+            'quantity' => 999_999,
+            'type' => 'user_license'
+          }
+        ],
+        'starting_price' => 0,
+        'starting_users' => 999_999,
+        'private_credits' => 10_000,
+        'public_credits' => 40_000,
+        'available_standalone_addons' => []
+      }.deep_merge(attributes)
+    end
+
     def billing_coupon_response_body(attributes = {})
       {
         "id" => "10_BUCKS_OFF",

spec/v3/billing_client_spec.rb

@@ -360,6 +360,47 @@
     end
   end
 
+  describe '#v2_plans_for' do
+    describe '#organization' do
+      subject { billing.v2_plans_for_organization(organization.id) }
+
+      it 'returns the list of v2 plans for an organization' do
+        stub_request(:get, "#{billing_url}v2/plans_for/organization/#{organization.id}").with(basic_auth: ['_', auth_key], headers: { 'X-Travis-User-Id' => user_id })
+          .to_return(body: JSON.dump([billing_v2_plan_response_body('id' => 'plan-id')]))
+
+        expect(subject.size).to eq 1
+        expect(subject.first.id).to eq('plan-id')
+        expect(subject.first.addon_configs.first['id']).to eq('oss_tier_credits')
+      end
+    end
+
+    describe '#user' do
+      subject { billing.v2_plans_for_user }
+
+      it 'returns the list of v2 plans for an user' do
+        stub_request(:get, "#{billing_url}v2/plans_for/user").with(basic_auth: ['_', auth_key], headers: { 'X-Travis-User-Id' => user_id })
+          .to_return(body: JSON.dump([billing_v2_plan_response_body('id' => 'plan-id')]))
+
+        expect(subject.size).to eq 1
+        expect(subject.first.id).to eq('plan-id')
+        expect(subject.first.addon_configs.first['id']).to eq('oss_tier_credits')
+      end
+    end
+  end
+
+  describe '#v2_subscription_user_usages' do
+    subject { billing.v2_subscription_user_usages(subscription_id)}
+
+    it 'returns the list of user license usages for the subscription' do
+      stub_request(:get, "#{billing_url}v2/subscriptions/#{subscription_id}/user_usage").with(basic_auth: ['_', auth_key],  headers: { 'X-Travis-User-Id' => user_id })
+        .to_return(body: JSON.dump([billing_addon_usage_response_body]))
+
+      expect(subject.size).to eq 1
+      expect(subject.first.addon_quantity).to eq 100
+      expect(subject.first.addon_usage).to eq 0
+    end
+  end
+
   describe '#update_organization_billing_permission' do
     let(:billing_admin_only) { { billing_admin_only: true } }
     subject { billing.update_organization_billing_permission(organization.id, billing_admin_only) }