Usage executions for owner (#1147)

Executions for owner

Author: piotrmilcarz

lib/travis/api/v3/billing_client.rb

@@ -17,6 +17,14 @@ def self.default_allowance_response(id = 0)
       Travis::API::V3::Models::Allowance.new(1, id, { "public_repos" => true, "private_repos" => false, "concurrency_limit" => 1 }.freeze)
     end
 
+    def executions(owner_type, owner_id, page, per_page, from, to)
+      response = connection.get("/usage/#{owner_type.downcase}s/#{owner_id}/executions?page=#{page}&per_page=#{per_page}&from=#{from}&to=#{to}")
+      executions = response.body.map do |execution_data|
+        Travis::API::V3::Models::Execution.new(execution_data)
+      end
+      executions
+    end
+
     def all
       data = connection.get('/subscriptions').body
       subscriptions = data.fetch('subscriptions').map do |subscription_data|

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

@@ -0,0 +1,27 @@
+module Travis::API::V3
+  class Models::Execution
+    attr_reader :id, :os, :instance_size, :arch, :virtualization_type, :queue, :job_id, :repository_id, :owner_id,
+                :owner_type, :plan_id, :sender_id, :credits_consumed, :started_at, :finished_at, :created_at,
+                :updated_at
+
+    def initialize(attributes = {})
+      @id = attributes.fetch('id')
+      @os = attributes.fetch('os')
+      @instance_size = attributes.fetch('instance_size')
+      @arch = attributes.fetch('arch')
+      @virtualization_type = attributes.fetch('virtualization_type')
+      @queue = attributes.fetch('queue')
+      @job_id = attributes.fetch('job_id')
+      @repository_id = attributes.fetch('repository_id')
+      @owner_id = attributes.fetch('owner_id')
+      @owner_type = attributes.fetch('owner_type')
+      @plan_id = attributes.fetch('plan_id')
+      @sender_id = attributes.fetch('sender_id')
+      @credits_consumed = attributes.fetch('credits_consumed')
+      @started_at = attributes.fetch('started_at')
+      @finished_at = attributes.fetch('finished_at')
+      @created_at = attributes.fetch('created_at')
+      @updated_at = attributes.fetch('updated_at')
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Travis::API::V3
+  class Queries::Executions < Query
+
+    def for_owner(owner, user_id, page, per_page, from, to)
+      client = BillingClient.new(user_id)
+      client.executions(owner_type(owner), owner.id, page, per_page, from, to)
+    end
+
+    private
+
+    def owner_type(owner)
+      owner.vcs_type =~ /User/ ? 'user' : 'organization'
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Travis::API::V3
+  class Renderer::Execution < ModelRenderer
+    representation :minimal, :id, :os, :instance_size, :arch, :virtualization_type, :queue, :job_id,
+                   :repository_id, :owner_id, :owner_type, :plan_id, :sender_id, :credits_consumed, :started_at,
+                   :finished_at, :created_at, :updated_at
+    representation :standard, *representations[:minimal]
+  end
+end

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

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

lib/travis/api/v3/routes.rb

@@ -126,6 +126,11 @@ module Routes
         route '/allowance'
         get :for_owner
       end
+
+      resource :executions do
+        route '/executions'
+        get :for_owner
+      end
     end
 
     resource :repositories do

lib/travis/api/v3/services.rb

@@ -24,6 +24,7 @@ module Services
     EnvVar                = Module.new { extend Services }
     EnvVars               = Module.new { extend Services }
     EnterpriseLicense     = Module.new { extend Services }
+    Executions            = Module.new { extend Services }
     Gdpr                  = Module.new { extend Services }
     Insights              = Module.new { extend Services }
     Installation          = Module.new { extend Services }

lib/travis/api/v3/services/executions/for_owner.rb

@@ -0,0 +1,19 @@
+module Travis::API::V3
+  class Services::Executions::ForOwner < Service
+    params :page, :per_page, :from, :to
+    result_type :executions
+
+    def run!
+      raise MethodNotAllowed if Travis.config.org?
+      raise LoginRequired unless access_control.logged_in?
+
+      owner = query(:owner).find
+
+      raise NotFound unless owner
+      raise InsufficientAccess unless access_control.visible?(owner)
+
+      result query(:executions).for_owner(owner, access_control.user.id, params['page'], params['per_page'],
+                                          params['from'], params['to'])
+    end
+  end
+end

spec/support/billing_spec_helper.rb

@@ -250,5 +250,27 @@ def billing_trial_response_body(attributes = {})
         'builds_remaining' => 5
       }.deep_merge(attributes)
     end
+
+    def billing_executions_response_body(attributes = {})
+      {
+        'id' => 1,
+        'os' => 'linux',
+        'instance_size' => 'standard-2',
+        'arch' => 'amd64',
+        'virtualization_type' => 'vm',
+        'queue' => 'builds.gce-oss',
+        'job_id' => 123,
+        'repository_id' => 123,
+        'owner_id' => 1,
+        'owner_type' => 'User',
+        'plan_id' => 2,
+        'sender_id' => 1,
+        'credits_consumed' => 5,
+        'started_at' => Time.now,
+        'finished_at' => Time.now,
+        'created_at' => Time.now,
+        'updated_at' => Time.now
+      }.deep_merge(attributes)
+    end
   end
 end

spec/v3/billing_client_spec.rb

@@ -12,6 +12,12 @@
 
   let(:subscription_id) { rand(999) }
   let(:invoice_id) { "TP#{rand(999)}" }
+  let(:page) { 1 }
+  let(:per_page) { 25 }
+  let(:from) { DateTime.now - 2.months }
+  let(:to) { DateTime.now }
+  let(:owner_id) { rand(999) }
+  let(:owner_type) { 'user' }
 
   describe '#get_subscription' do
     subject { billing.get_subscription(subscription_id) }
@@ -414,4 +420,17 @@
       expect(stubbed_request).to have_been_made
     end
   end
+
+  describe '#update_organization_billing_permission' do
+    subject { billing.executions(owner_type, owner_id, page, per_page, from, to) }
+
+    it 'returns the list of executions for the subscription' do
+      stub_request(:get, "#{billing_url}usage/#{owner_type.downcase}s/#{owner_id}/executions?page=#{page}&per_page=#{per_page}&from=#{from}&to=#{to}").with(basic_auth: ['_', auth_key],  headers: { 'X-Travis-User-Id' => user_id })
+        .to_return(body: JSON.dump([billing_executions_response_body]))
+
+      expect(subject.first).to be_a(Travis::API::V3::Models::Execution)
+      expect(subject.first.credits_consumed).to eq 5
+      expect(subject.first.os).to eq 'linux'
+    end
+  end
 end