Add env vars endpoints

This adds API V3 endpoints for querying, creating, modifying and
deleting environment variables.

It has no concept of encryption yet and should be considered a work in
progress.

We should also talk about the slightly off-track approach in the
EnvVars::Create service – maybe there's a way to standardise the
querying and rendering for post requests?

☕

lib/travis/api/v3.rb

@@ -31,6 +31,7 @@ module Travis
       AlreadySyncing      = ClientError        .create('sync already in progress', status: 409)
       BuildAlreadyRunning = ClientError        .create('build already running, cannot restart', status: 409)
       BuildNotCancelable  = ClientError        .create('build is not running, cannot cancel', status: 409)
+      DuplicateResource   = ClientError        .create('resource already exists', status: 409)
       EntityMissing       = NotFound           .create(type: 'not_found')
       InsufficientAccess  = ClientError        .create(status: 403)
       JobAlreadyRunning   = ClientError        .create('job already running, cannot restart', status: 409)

lib/travis/api/v3/access_control/generic.rb

@@ -96,6 +96,14 @@ module Travis::API::V3
       repository_visible?(settings.repository)
     end
 
+    def env_vars_visible?(env_vars)
+      repository_visible?(env_vars.repository)
+    end
+
+    def env_var_visible?(env_var)
+      repository_visible?(env_var.repository)
+    end
+
     def private_repository_visible?(repository)
       false
     end

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

@@ -0,0 +1,18 @@
+module Travis::API::V3
+  class Models::EnvVar < Travis::Settings::Model
+    attribute :id, Integer
+    attribute :name, String
+    attribute :value, String
+    attribute :public, Boolean
+    attribute :repository_id, Integer
+
+    def repository
+      @repository ||= Models::Repository.find(repository_id)
+    end
+
+    validates_each :id, :name do |record, attr, value|
+      others = record.repository.env_vars.select { |ev| ev.id != record.id } 
+      record.errors.add(:base, :duplicate_resource) if others.find { |ev| ev.send(attr) == record.send(attr) }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Travis::API::V3
+  class Models::EnvVars < Travis::Settings::Collection
+    model Models::EnvVar
+
+    def repository
+      @repository ||= Models::Repository.find(additional_attributes[:repository_id])
+    end
+
+    undef :to_hash
+  end
+end

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

@@ -75,5 +75,11 @@ module Travis::API::V3
     def admin_settings
       @admin_settings ||= Models::AdminSettings.new(settings)
     end
+
+    def env_vars
+      @env_vars ||= Models::EnvVars.new.tap do |vars|
+        vars.load(settings.fetch('env_vars', []), repository_id: self.id)
+      end
+    end
   end
 end

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

@@ -0,0 +1,21 @@
+module Travis::API::V3
+  class Queries::EnvVar < Query
+    params :id, :name, :value, :public, prefix: :env_var
+
+    def find(repository)
+      repository.env_vars.find(id)
+    end
+
+    def update(repository)
+      if env_var = find(repository)
+        env_var.update(env_var_params)
+        repository.save!
+        env_var
+      end
+    end
+
+    def delete(repository)
+      repository.env_vars.destroy(id)
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Travis::API::V3
+  class Queries::EnvVars < Query
+    params :id, :name, :value, :public, prefix: :env_var
+
+    def find(repository)
+      repository.env_vars    
+    end
+
+    def create(repository)
+      env_var = repository.env_vars.create(env_var_params)
+      handle_errors(env_var) unless env_var.valid?
+      repository.save!
+      env_var
+    end
+
+    private
+
+      def handle_errors(env_var)
+        base = env_var.errors[:base]
+        case
+        when base.include?(:format)             then raise WrongParams
+        when base.include?(:duplicate_resource) then raise DuplicateResource
+        else                                         raise ServerError
+        end
+      end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Travis::API::V3
+  class Renderer::EnvVar < Renderer::ModelRenderer
+    representation :standard, :id, :name, :value, :public
+  end
+end

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

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

lib/travis/api/v3/routes.rb

@@ -123,6 +123,19 @@ module Travis::API::V3
         get   :find
         patch :update
       end
+
+      resource :env_vars do
+        route '/env_vars'
+        get   :for_repository
+        post  :create
+      end
+
+      resource :env_var do
+        route  '/env_var/{env_var.id}'
+        get    :find
+        patch  :update
+        delete :delete
+      end
     end
 
     resource :user do

lib/travis/api/v3/services.rb

@@ -11,6 +11,8 @@ module Travis::API::V3
     Builds        = Module.new { extend Services }
     Cron          = Module.new { extend Services }
     Crons         = Module.new { extend Services }
+    EnvVar        = Module.new { extend Services }
+    EnvVars       = Module.new { extend Services }
     Job           = Module.new { extend Services }
     Jobs          = Module.new { extend Services }
     Lint          = Module.new { extend Services }

lib/travis/api/v3/services/env_var/delete.rb

@@ -0,0 +1,12 @@
+module Travis::API::V3
+  class Services::EnvVar::Delete < Service
+    params :id, prefix: :repository
+    params :id, prefix: :env_var
+
+    def run!
+      raise LoginRequired unless access_control.logged_in? or access_control.full_access?
+      raise NotFound      unless repository = find(:repository)
+      query.delete(repository)
+    end
+  end
+end

lib/travis/api/v3/services/env_var/find.rb

@@ -0,0 +1,12 @@
+module Travis::API::V3
+  class Services::EnvVar::Find < Service
+    params :id, prefix: :repository
+    params :id, prefix: :env_var
+
+    def run!
+      raise LoginRequired unless access_control.logged_in? or access_control.full_access?
+      raise NotFound      unless repository = find(:repository)
+      query.find(repository)
+    end
+  end
+end

lib/travis/api/v3/services/env_var/update.rb

@@ -0,0 +1,12 @@
+module Travis::API::V3
+  class Services::EnvVar::Update < Service
+    params :id, prefix: :repository
+    params :id, :name, :value, :public, prefix: :env_var
+
+    def run!
+      raise LoginRequired unless access_control.logged_in? or access_control.full_access?
+      raise NotFound      unless repository = find(:repository)
+      query.update(repository)
+    end
+  end
+end

lib/travis/api/v3/services/env_vars/create.rb

@@ -0,0 +1,13 @@
+module Travis::API::V3
+  class Services::EnvVars::Create < Service
+    params :id, prefix: :repository
+    params :id, :name, :value, :public, prefix: :env_var
+
+    def run!
+      raise LoginRequired unless access_control.logged_in? or access_control.full_access?
+      raise NotFound      unless repository = find(:repository)
+      env_var = query(:env_vars).create(repository)
+      result(:env_var, env_var, status: 201)
+    end
+  end
+end

lib/travis/api/v3/services/env_vars/for_repository.rb

@@ -0,0 +1,9 @@
+module Travis::API::V3
+  class Services::EnvVars::ForRepository < Service
+    def run!
+      raise LoginRequired unless access_control.logged_in? or access_control.full_access?
+      raise NotFound      unless repository = find(:repository)
+      find(:env_vars, repository)
+    end
+  end
+end

spec/spec_helper.rb

@@ -23,6 +23,40 @@ require 'support/payloads'
 require 'support/private_key'
 require 'support/s3'
 require 'support/test_helpers'
+require 'support/shared_examples'
+
+Travis.logger = Logger.new(StringIO.new)
+Travis::Api::App.setup
+Travis.config.client_domain = "www.example.com"
+Travis.config.endpoints.ssh_key = true
+
+module TestHelpers
+  include Sinatra::TestHelpers
+
+  def custom_endpoints
+    @custom_endpoints ||= []
+  end
+
+  def add_settings_endpoint(name, options = {})
+    if options[:singleton]
+      Travis::Api::App::SingletonSettingsEndpoint.subclass(name)
+    else
+      Travis::Api::App::SettingsEndpoint.subclass(name)
+    end
+    set_app Travis::Api::App.new
+  end
+
+  def add_endpoint(prefix, &block)
+    endpoint = Sinatra.new(Travis::Api::App::Endpoint, &block)
+    endpoint.set(prefix: prefix)
+    set_app Travis::Api::App.new
+    custom_endpoints << endpoint
+  end
+
+  def parsed_body
+    MultiJson.decode(body)
+  end
+end
 
 RSpec.configure do |c|
   c.mock_framework = :mocha

spec/support/shared_examples.rb

@@ -0,0 +1,34 @@
+RSpec.shared_examples 'not authenticated' do
+  example { expect(last_response.status).to eq(403) }
+  example do
+    expect(JSON.load(body)).to eq(
+      '@type' => 'error',
+      'error_type' => 'login_required',
+      'error_message' => 'login required'
+    )
+  end
+end
+
+RSpec.shared_examples 'missing repo' do
+  example { expect(last_response.status).to eq(404) }
+  example do
+    expect(JSON.load(body)).to eq(
+      '@type' => 'error',
+      'error_message' => 'repository not found (or insufficient access)',
+      'error_type' => 'not_found',
+      'resource_type' => 'repository'
+    )
+  end
+end
+
+RSpec.shared_examples 'missing env_var' do
+  example { expect(last_response.status).to eq 404 }
+  example do
+    expect(JSON.load(body)).to eq(
+      '@type' => 'error',
+      'error_message' => 'env_var not found (or insufficient access)',
+      'error_type' => 'not_found',
+      'resource_type' => 'env_var'
+    )
+  end
+end

spec/v3/services/env_var/delete_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Travis::API::V3::Services::EnvVar::Delete do
+  let(:repo)  { Travis::API::V3::Models::Repository.where(owner_name: 'svenfuchs', name: 'minimal').first_or_create }
+  let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) }
+  let(:env_var) { { id: 'abc', name: 'FOO', value: 'bar', public: true, repository_id: repo.id } }
+  let(:auth_headers) { { 'HTTP_AUTHORIZATION' => "token #{token}" } }
+
+  describe 'not authenticated' do
+    before { delete("/v3/repo/#{repo.id}/env_var/#{env_var[:id]}") }
+    include_examples 'not authenticated'
+  end
+
+  describe 'authenticated, missing repo' do
+    before { delete("/v3/repo/999999999/env_var/foo", {}, auth_headers) }
+    include_examples 'missing repo'
+  end
+
+  describe 'authenticated, missing repo, missing env var' do
+    before { delete("/v3/repo/#{repo.id}/env_var/#{env_var[:id]}", {}, auth_headers) }
+    include_examples 'missing env_var'
+  end
+
+  describe 'authenticated, missing repo, existing env var' do
+    before do
+      repo.update_attributes(settings: JSON.generate(env_vars: [env_var]))
+      delete("/v3/repo/#{repo.id}/env_var/#{env_var[:id]}", {}, auth_headers)
+    end
+
+    example { expect(last_response.status).to eq 200 }
+    example { pending 'should we return an empty body here?' }
+  end
+end

spec/v3/services/env_var/find_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Travis::API::V3::Services::EnvVar::Find do
+  let(:repo)  { Travis::API::V3::Models::Repository.where(owner_name: 'svenfuchs', name: 'minimal').first_or_create }
+  let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) }
+  let(:env_var) { { id: 'abc', name: 'FOO', value: 'bar', public: true, repository_id: repo.id } }
+  let(:auth_headers) { { 'HTTP_AUTHORIZATION' => "token #{token}" } }
+
+  describe 'not authenticated' do
+    before { get("/v3/repo/#{repo.id}/env_var/#{env_var[:id]}") }
+    include_examples 'not authenticated'
+  end
+
+  describe 'authenticated, missing repo' do
+    before { get("/v3/repo/999999999/env_var/foo", {}, auth_headers) }
+    include_examples 'missing repo'
+  end
+
+  describe 'authenticated, existing repo, missing env var' do
+    before { get("/v3/repo/#{repo.id}/env_var/#{env_var[:id]}", {}, auth_headers) }
+    include_examples 'missing env_var'
+  end
+
+  describe 'authenticated, existing repo, existing env var' do
+    before do
+      repo.update_attributes(settings: JSON.generate(env_vars: [env_var]))
+      get("/v3/repo/#{repo.id}/env_var/#{env_var[:id]}", {}, auth_headers)
+    end
+
+    example { expect(last_response.status).to eq 200 }
+    example do
+      expect(JSON.load(body)).to eq(
+        '@type' => 'env_var',
+        '@href' => "/v3/repo/#{repo.id}/env_var/#{env_var[:id]}",
+        '@representation' => 'standard',
+        'id' => env_var[:id],
+        'name' => env_var[:name],
+        'public' => env_var[:public],
+        'value' => env_var[:value]
+      )
+    end
+  end
+end

spec/v3/services/env_var/update_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Travis::API::V3::Services::EnvVar::Update do
+  let(:repo)  { Travis::API::V3::Models::Repository.where(owner_name: 'svenfuchs', name: 'minimal').first_or_create }
+  let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) }
+  let(:env_var) { { id: 'abc', name: 'FOO', value: 'bar', public: true, repository_id: repo.id } }
+  let(:auth_headers) { { 'HTTP_AUTHORIZATION' => "token #{token}" } }
+  let(:json_headers) { { 'CONTENT_TYPE' => 'application/json' } }
+
+  describe 'not authenticated' do
+    before { patch("/v3/repo/#{repo.id}/env_var/#{env_var[:id]}") }
+    include_examples 'not authenticated'
+  end
+
+  describe 'authenticated, missing repo' do
+    before { patch("/v3/repo/999999999/env_var/#{env_var[:id]}", {}, auth_headers) }
+    include_examples 'missing repo'
+  end
+
+  describe 'authenticated, existing repo, missing env var' do
+    before { patch("/v3/repo/#{repo.id}/env_var/foo", {}, auth_headers) }
+    include_examples 'missing env_var'
+  end
+
+  describe 'authenticated, existing repo, existing env var' do
+    let(:params) do
+      {
+        'env_var.name' => 'QUX'
+      }
+    end
+
+    before do
+      repo.update_attributes(settings: JSON.generate(env_vars: [env_var]))
+      patch("/v3/repo/#{repo.id}/env_var/#{env_var[:id]}", JSON.generate(params), auth_headers.merge(json_headers))
+    end
+
+    example { expect(last_response.status).to eq 200 }
+    example do
+      expect(JSON.load(body)).to eq(
+        '@type' => 'env_var',
+        '@href' => '/v3/repo/1/env_var/abc',
+        '@representation' => 'standard',
+        'id' => env_var[:id],
+        'name' => params['env_var.name'],
+        'value' => env_var[:value],
+        'public' => env_var[:public]
+      )
+    end
+  end
+end

spec/v3/services/env_vars/create_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Travis::API::V3::Services::EnvVars::Create do
+  let(:repo)  { Travis::API::V3::Models::Repository.where(owner_name: 'svenfuchs', name: 'minimal').first_or_create }
+  let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) }
+  let(:auth_headers) { { 'HTTP_AUTHORIZATION' => "token #{token}" } }
+  let(:json_headers) { { 'CONTENT_TYPE' => 'application/json' } }
+
+  describe 'not authenticated' do
+    before { post("/v3/repo/#{repo.id}/env_vars", {}) }
+    include_examples 'not authenticated'
+  end
+
+  describe 'authenticated, repo missing' do
+    before { post("/v3/repo/99999999/env_vars", {}, auth_headers) }
+    include_examples 'missing repo' 
+  end
+
+  describe 'authenticated, existing repo, env var already exists' do
+    let(:params) do
+      {
+        'env_var.name' => 'FOO',
+        'env_var.value' => 'bar',
+        'env_var.public' => false
+      }
+    end
+
+    before do
+      repo.update_attributes(settings: JSON.generate(env_vars: [{ id: 'abc', name: 'FOO', value: 'bar', public: false }]))
+      post("/v3/repo/#{repo.id}/env_vars", JSON.generate(params), auth_headers.merge(json_headers))
+    end
+
+    example { expect(last_response.status).to eq 409 }
+    example do
+      expect(JSON.load(body)).to eq(
+        '@type' => 'error',
+        'error_message' => 'resource already exists',
+        'error_type' => 'duplicate_resource'
+      )
+    end
+  end
+
+  describe 'authenticated, existing repo, env var is new' do
+    let(:params) do
+      {
+        'env_var.name' => 'FOO',
+        'env_var.value' => 'bar',
+        'env_var.public' => false
+      }
+    end
+
+    before { post("/v3/repo/#{repo.id}/env_vars", JSON.generate(params), auth_headers.merge(json_headers)) }
+
+    example { expect(last_response.status).to eq 201 }
+    example do
+      response = JSON.load(body)
+      expect(response).to include(
+        '@type' => 'env_var',
+        '@representation' => 'standard',
+        'name' => 'FOO',
+        'value' => 'bar',
+        'public' => false
+      )
+      expect(response).to include('@href', 'id')
+    end
+  end
+end

spec/v3/services/env_vars/for_repository_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Travis::API::V3::Services::EnvVars::ForRepository do
+  let(:repo)  { Travis::API::V3::Models::Repository.where(owner_name: 'svenfuchs', name: 'minimal').first_or_create }
+  let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) }
+  let(:env_var) { { id: 'abc', name: 'FOO', value: 'bar', public: true, repository_id: repo.id } }
+  let(:auth_headers) { { 'HTTP_AUTHORIZATION' => "token #{token}" } }
+  
+  describe 'not authenticated' do
+    before { get("/v3/repo/#{repo.id}/env_vars") }
+    include_examples 'not authenticated'
+  end
+
+  describe 'authenticated, missing repo' do
+    before { get("/v3/repo/999999999/env_vars", {}, auth_headers) }
+    include_examples 'missing repo'  
+  end
+
+  describe 'authenticated, existing repo, no env vars' do
+    before do
+      get("/v3/repo/#{repo.id}/env_vars", {}, auth_headers)
+    end
+    example { expect(last_response.status).to eq(200) }
+    example do
+      expect(JSON.load(body)).to eq(
+        '@type' => 'env_vars',
+        '@href' => "/v3/repo/#{repo.id}/env_vars",
+        '@representation' => 'standard',
+        'env_vars' => []
+      )
+    end
+  end
+
+  describe 'authenticated, existing repo, existing env vars' do
+    before do
+      repo.update_attributes(settings: JSON.generate(env_vars: [env_var]))
+      get("/v3/repo/#{repo.id}/env_vars", {}, auth_headers)
+    end
+    example { expect(last_response.status).to eq(200) }
+    example do
+      expect(JSON.load(body)).to eq(
+        '@type' => 'env_vars',
+        '@href' => "/v3/repo/#{repo.id}/env_vars",
+        '@representation' => 'standard',
+        'env_vars' => [
+          {
+            '@type' => 'env_var',
+            '@href' => "/v3/repo/#{repo.id}/env_var/#{env_var[:id]}",
+            '@representation' => 'standard',
+            'id' => env_var[:id],
+            'name' => env_var[:name],
+            'value' => env_var[:value],
+            'public' => env_var[:public]
+          }
+        ]
+      )
+    end
+  end
+end

spec/v3/services/settings_spec.rb

@@ -7,14 +7,7 @@ describe Travis::API::V3::Services::Settings, set_app: true do
   describe :Find do
     describe 'not authenticated' do
       before { get("/v3/repo/#{repo.id}/settings") }
-      example { expect(last_response.status).to eq(403) }
+      include_examples 'not authenticated'
-      example do
-        expect(JSON.load(body)).to eq(
-          '@type' => 'error',
-          'error_type' => 'login_required',
-          'error_message' => 'login required'
-        )
-      end
     end
 
     describe 'authenticated, missing repo' do