Owner allowance refactor (#1142)

Allowance endpoint for owner

Author: piotrmilcarz

lib/travis/api/v3/billing_client.rb

@@ -10,11 +10,11 @@ def allowance(owner_type, owner_id)
       response = connection.get("/usage/#{owner_type.downcase}s/#{owner_id}/allowance")
       return BillingClient.default_allowance_response unless response.status == 200
 
-      Travis::API::V3::Models::Allowance.new(2, response.body)
+      Travis::API::V3::Models::Allowance.new(2, owner_id, response.body)
     end
 
-    def self.default_allowance_response
-      Travis::API::V3::Models::Allowance.new(1, { "public_repos" => true, "private_repos" => false, "concurrency_limit" => 1 }.freeze)
+    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 all

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

@@ -1,9 +1,10 @@
 module Travis::API::V3
   class Models::Allowance
-    attr_reader :subscription_type, :public_repos, :private_repos, :concurrency_limit
+    attr_reader :subscription_type, :public_repos, :private_repos, :concurrency_limit, :id
 
-    def initialize(subscription_type, attributes = {})
+    def initialize(subscription_type, owner_id, attributes = {})
       @subscription_type = subscription_type
+      @id = owner_id
       @public_repos = attributes.fetch('public_repos')
       @private_repos = attributes.fetch('private_repos')
       @concurrency_limit = attributes.fetch('concurrency_limit')

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

@@ -0,0 +1,16 @@
+module Travis::API::V3
+  class Queries::Allowance < Query
+    params :login, :github_id, :provider
+
+    def for_owner(owner, user_id)
+      client = BillingClient.new(user_id)
+      client.allowance(owner_type(owner), owner.id)
+    end
+
+    private
+
+    def owner_type(owner)
+      owner.vcs_type =~ /User/ ? 'user' : 'organization'
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 module Travis::API::V3
   class Renderer::Allowance < ModelRenderer
-    representation(:minimal, :subscription_type, :public_repos, :private_repos, :concurrency_limit)
+    representation(:minimal, :subscription_type, :public_repos, :private_repos, :concurrency_limit, :id)
+    representation(:standard, :subscription_type, :public_repos, :private_repos, :concurrency_limit, :id)
   end
 end

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

@@ -4,7 +4,7 @@ module Travis::API::V3
   class Renderer::Owner < ModelRenderer
     include Renderer::AvatarURL
 
-    representation(:minimal,    :id, :login, :vcs_type, :allowance)
+    representation(:minimal,    :id, :login, :vcs_type)
     representation(:standard,   :id, :login, :name, :github_id, :vcs_id, :vcs_type, :avatar_url, :education,
                    :allow_migration, :allowance)
     representation(:additional, :repositories, :installation)
@@ -31,8 +31,8 @@ def allow_migration
     end
 
     def allowance
-      return BillingClient.default_allowance_response if Travis.config.org?
-      return BillingClient.default_allowance_response unless access_control.user
+      return BillingClient.default_allowance_response(id) if Travis.config.org?
+      return BillingClient.default_allowance_response(id) unless access_control.user
 
       client = BillingClient.new(access_control.user.id)
       client.allowance(owner_type, id)

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

@@ -75,7 +75,7 @@ def owner
       if included_owner? and owner_href
         { :@href => owner_href }
       else
-        result = { :@type => owner_type, :id => model.owner_id, :login => model.owner_name, :allowance => owner_allowance }
+        result = { :@type => owner_type, :id => model.owner_id, :login => model.owner_name }
         result[:@href] = owner_href if owner_href
         result
       end
@@ -96,16 +96,6 @@ def owner_type
       @owner_type ||= model.owner_type.downcase if model.owner_type
     end
 
-    def owner_allowance
-      @owner_allowance ||= begin
-        return BillingClient.default_allowance_response if Travis.config.org?
-        return BillingClient.default_allowance_response unless access_control.user
-
-        client = BillingClient.new(access_control.user.id)
-        client.allowance(owner_type, model.owner_id)
-      end
-    end
-
     def managed_by_installation
       model.managed_by_installation?
     end

lib/travis/api/v3/routes.rb

@@ -115,6 +115,11 @@ module Routes
         route '/active'
         get :for_owner
       end
+
+      resource :allowance do
+        route '/allowance'
+        get :for_owner
+      end
     end
 
     resource :repositories do
@@ -152,7 +157,7 @@ module Routes
 
       resource :builds do
         route '/builds'
-        get  :find
+        get :find
       end
 
       resource :caches do

lib/travis/api/v3/services.rb

@@ -4,6 +4,7 @@ module Services
 
     Accounts              = Module.new { extend Services }
     Active                = Module.new { extend Services }
+    Allowance             = Module.new { extend Services }
     BetaFeature           = Module.new { extend Services }
     BetaFeatures          = Module.new { extend Services }
     BetaMigrationRequest  = Module.new { extend Services }

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

@@ -0,0 +1,15 @@
+module Travis::API::V3
+  class Services::Allowance::ForOwner < Service
+    def run!
+      return result BillingClient.default_allowance_response 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(:allowance).for_owner(owner, access_control.user.id)
+    end
+  end
+end

spec/v3/services/installation/find_spec.rb

@@ -18,14 +18,6 @@
       "github_id"        => installation.github_id,
       "owner"            => {
         "@type"=>"user",
-        "allowance"   => {
-          "@representation"   => "minimal",
-          "@type"             => "allowance",
-          "concurrency_limit" => 1,
-          "private_repos"     => false,
-          "public_repos"      => true,
-          "subscription_type" => 1
-        },
         "@href"=>"/v3/user/#{user.id}",
         "@representation"=>"minimal",
         "id"=>user.id,
@@ -63,15 +55,16 @@
         "is_syncing" => nil,
         "synced_at" => nil,
         "education" => nil,
-        "allow_migration" => false,
-        "allowance" => {
-          "@type"             => "allowance",
+        "allowance"   => {
           "@representation"   => "minimal",
-          "subscription_type" => 1,
-          "public_repos"      => true,
+          "@type"             => "allowance",
+          "id"                => 1,
+          "concurrency_limit" => 1,
           "private_repos"     => false,
-          "concurrency_limit" => 1
+          "public_repos"      => true,
+          "subscription_type" => 1
         },
+        "allow_migration" => false,
         "recently_signed_up" => false,
         "secure_user_hash" => nil,
       }