p4_web_api_client 2014.2.0.pre1

data/spec/files_spec.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#files' do
+
+  it 'should list the depots with no arguments' do
+    client_as_jdoe do |c|
+      depots = c.files
+      expect(depots.length).to be >= (1)
+      expect(depots.first.name).to eq('depot')
+    end
+  end
+
+  it "should list 'dev' and 'main' dirs at the /depot path" do
+    client_as_jdoe do |c|
+      dirs = c.files('depot')
+      expect(dirs.length).to eq(2)
+      dir_names = dirs.map(&:name)
+      expect(dir_names).to include('dev')
+      expect(dir_names).to include('main')
+    end
+  end
+
+  it "should list 'README' at the depot/dev/Experimental path" do
+    client_as_jdoe do |c|
+      paths = c.files('depot/dev/Experimental')
+      expect(paths.length).to eq(1)
+      names = paths.map(&:name)
+      expect(names).to include('README')
+    end
+  end
+end

data/spec/groups_spec.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#create_group' do
+
+  it 'should create a new group - and return it via #groups' do
+    client_as_jdoe do |c|
+      new_group = P4WebApiClient::Models::Group.new
+      new_group.group = 'jarjar'
+      new_group.users = %w(mmustermann jdoe)
+
+      c.create_group(new_group)
+
+      groups = c.groups
+      jarjar = groups.find { |g| g.group == 'jarjar' }
+      expect(jarjar.users).to include('mmustermann')
+      expect(jarjar.users).to include('jdoe')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#group' do
+
+  it 'should load a single group created via #create_group' do
+    client_as_jdoe do |c|
+      jarjar = c.group('jarjar')
+
+      expect(jarjar.users).to include('mmustermann')
+      expect(jarjar.users).to include('jdoe')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_group' do
+
+  it "'should be able to add a group owner'" do
+    client_as_jdoe do |c|
+      jarjar = c.group('jarjar')
+      jarjar.owners << 'super'
+
+      c.update_group(jarjar)
+
+      loaded = c.group('jarjar')
+      expect(loaded.owners).to include('super')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#delete_group' do
+
+  it "'should be able to delete a group created via #create_group'" do
+    client_as_jdoe do |c|
+      c.delete_group('jarjar')
+
+      groups = c.groups
+      expect(groups.map(&:group)).to_not include('jarjar')
+    end
+  end
+end

data/spec/init.base/init_p4d.rb

@@ -0,0 +1,52 @@
+
+# This sets up a security=0 server but in Unicode mode, not sure about other
+# 'recommended' settings
+class BaseSystemSettings < SystemSettingsModel
+  @unicode = true
+  @security_level = 3
+end
+
+class SuperUser < UserModel
+  @super = true
+  @login = 'super'
+  @password = 'superuser1A!'
+end
+
+class MaxUser < UserModel
+  def rank
+    10
+  end
+  @login = 'mmustermann'
+  @full_name = 'Max Mustermann'
+  @password = 'mustermann1A!'
+end
+
+class JohnDoeUser < UserModel
+  def rank
+    11
+  end
+  @login = 'jdoe'
+  @full_name = 'John Doe'
+  @password = 'johndoe1A!'
+end
+
+class Changelist1 < ChangelistModel
+  def rank
+    1000
+  end
+  @description = 'A few basic adds'
+  @adds = [
+    FileDefinition.new(
+        path: 'depot/main/My Project/README',
+        content: <<-STOP.gsub(/^ {8}/, '')
+      This is the readme for My Project
+    STOP
+    ),
+    FileDefinition.new(
+        path: 'depot/dev/Experimental/README',
+        content: <<-STOP.gsub(/^ {8}/, '')
+      This is an experimental project README.
+    STOP
+    )
+  ]
+end

data/spec/jobs_spec.rb

@@ -0,0 +1,66 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+first_job_id = nil
+
+RSpec.describe P4WebApiClient::Client, '#create_job' do
+
+  it 'should create a new job - and return it via #jobs' do
+    client_as_jdoe do |c|
+      new_job = {
+        'User' => 'jdoe',
+        'Description' => 'Get to work!'
+      }
+
+      c.create_job(new_job)
+
+      jobs = c.jobs
+      expect(jobs.first['Description'].strip).to eq('Get to work!')
+
+      first_job_id = jobs.first['Job']
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#job' do
+
+  it 'should load a single job created via #create_job' do
+    client_as_jdoe do |c|
+      loaded = c.job(first_job_id)
+
+      expect(loaded['Description'].strip).to eq('Get to work!')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_job' do
+
+  it "'should be able to change status'" do
+    client_as_jdoe do |c|
+      job = c.job(first_job_id)
+
+      job['Status'] = 'closed'
+
+      c.update_job(job)
+
+      loaded = c.job(first_job_id)
+      expect(loaded['Status']).to eq('closed')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#delete_job' do
+
+  it "'should be able to delete a job created via #create_job'" do
+    client_as_jdoe do |c|
+      c.delete_job(first_job_id)
+
+      jobs = c.jobs
+      expect(jobs.map { |b| b['Job'] }).to_not include(first_job_id)
+    end
+  end
+end

data/spec/labels_spec.rb

@@ -0,0 +1,62 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#create_label' do
+
+  it 'should create a new label - and return it via #labels' do
+    client_as_jdoe do |c|
+      new_label = P4WebApiClient::Models::Label.new
+      new_label.label = 'new_label'
+      new_label.description = 'A label'
+      new_label.view = ['//depot/...']
+
+      c.create_label(new_label)
+
+      labels = c.labels
+      expect(labels.map(&:label)).to include('new_label')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#label' do
+
+  it 'should load a single label created via #create_label' do
+    client_as_jdoe do |c|
+      new_label = c.label('new_label')
+
+      expect(new_label.description.strip).to eq('A label')
+      expect(new_label.view.first).to eq('//depot/...')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_label' do
+
+  it "'should be able to update the label description'" do
+    client_as_jdoe do |c|
+      new_label = c.label('new_label')
+      new_label.description = 'updated'
+
+      c.update_label(new_label)
+
+      loaded = c.label('new_label')
+      expect(loaded.description.strip).to eq('updated')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#delete_label' do
+
+  it "'should be able to delete a label created via #create_label'" do
+    client_as_jdoe do |c|
+      c.delete_label('new_label')
+
+      labels = c.labels
+      expect(labels.map(&:label)).to_not include('new_label')
+    end
+  end
+end

data/spec/lib/test_connections.rb

@@ -0,0 +1,28 @@
+
+require 'p4_web_api_client'
+
+def client_as_jdoe
+  conn = P4WebApiClient::Connection.new(
+      url: 'http://localhost:4567/',
+      login: 'jdoe',
+      password: 'johndoe1A!',
+      prefix: '/v1'
+  )
+  client = P4WebApiClient::Client.open(conn)
+  yield client
+ensure
+  client.close if client
+end
+
+def client_as_super
+  conn = P4WebApiClient::Connection.new(
+      url: 'http://localhost:4567/',
+      login: 'super',
+      password: 'superuser1A!',
+      prefix: '/v1'
+  )
+  client = P4WebApiClient::Client.open(conn)
+  yield client
+ensure
+  client.close if client
+end

data/spec/protections_spec.rb

@@ -0,0 +1,31 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#protections' do
+
+  it 'should return an array with at least two protections' do
+    client_as_super do |c|
+      p = c.protections
+      expect(p.protections.length).to be >= 2
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_protections' do
+
+  it 'should add a protections entry for the user jdoe' do
+    client_as_super do |c|
+      p = c.protections
+      p.protections << 'super user jdoe * //...'
+
+      c.update_protections(p)
+
+      loaded = c.protections
+      expect(loaded.protections).to include('super user jdoe * //...')
+    end
+  end
+end

data/spec/run_input_spec.rb

@@ -0,0 +1,23 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+#
+# run_input_spec.rb
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#run_input' do
+
+  it "should allow us to run 'user -f joeuser' to create a new user" do
+    client_as_super do |c|
+      input = {
+        'User' => 'joeuser',
+        'FullName' => 'Joe User',
+        'Email' => 'joeuser@example.com'
+      }
+      results = c.run_input('user', input, ['-i', '-f'])
+      expect(results.length).to eq(1)
+    end
+  end
+end

data/spec/run_spec.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+#
+# run_spec.rb
+#
+# Specifications for the P4WebApiClient::Client run method
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#run' do
+
+  it "should allow us to run 'user -o' for our known user" do
+    client_as_super do |c|
+      results = c.run('user', ['-o'])
+      expect(results.length).to eq(1)
+      expect(results[0]['User']).to eq('super')
+    end
+  end
+end

data/spec/servers_spec.rb

@@ -0,0 +1,64 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#create_server' do
+
+  it 'should create a new server - and return it via #servers' do
+    client_as_jdoe do |c|
+      new_server = P4WebApiClient::Models::Server.new
+      new_server.server_id = 'new_server'
+      new_server.type = :server
+      new_server.description = 'A new server'
+      new_server.services = :standard
+
+      c.create_server(new_server)
+
+      servers = c.servers
+      expect(servers.map(&:server_id)).to include('new_server')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#server' do
+
+  it 'should load a single server created via #create_server' do
+    client_as_jdoe do |c|
+      new_server = c.server('new_server')
+
+      expect(new_server.description.strip).to eq('A new server')
+      expect(new_server.type).to eq(:server)
+      expect(new_server.services).to eq(:standard)
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_server' do
+
+  it "'should be able to update the server description'" do
+    client_as_jdoe do |c|
+      new_server = c.server('new_server')
+      new_server.description = 'updated'
+
+      c.update_server(new_server)
+
+      loaded = c.server('new_server')
+      expect(loaded.description.strip).to eq('updated')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#delete_server' do
+
+  it "'should be able to delete a server created via #create_server'" do
+    client_as_jdoe do |c|
+      c.delete_server('new_server')
+
+      servers = c.servers
+      expect(servers.map(&:server_id)).to_not include('new_server')
+    end
+  end
+end

data/spec/streams_spec.rb

@@ -0,0 +1,74 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#create_stream' do
+
+  it 'should create a new stream - and return it via #streams' do
+    client_as_jdoe do |c|
+      new_depot = P4WebApiClient::Models::Depot.new
+      new_depot.depot = 'stuffs'
+      new_depot.type = :stream
+      new_depot.map = 'stuffs/...'
+
+      c.create_depot(new_depot)
+
+      new_stream = P4WebApiClient::Models::Stream.new
+      new_stream.stream = '//stuffs/new_stream'
+      new_stream.name = 'new_stream'
+      new_stream.description = 'A new stream'
+      new_stream.type = :mainline
+      new_stream.parent = 'none'
+      new_stream.paths = ['share ...']
+      new_stream.owner = 'jdoe'
+
+      c.create_stream(new_stream)
+
+      streams = c.streams
+      expect(streams.map(&:stream)).to include('//stuffs/new_stream')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#stream' do
+
+  it 'should load a single stream created via #create_stream' do
+    client_as_jdoe do |c|
+      new_stream = c.stream('//stuffs/new_stream')
+
+      expect(new_stream.description.strip).to eq('A new stream')
+      expect(new_stream.name).to eq('new_stream')
+      expect(new_stream.type).to eq(:mainline)
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_stream' do
+
+  it "'should be able to update the stream description'" do
+    client_as_jdoe do |c|
+      new_stream = c.stream('//stuffs/new_stream')
+      new_stream.description = 'updated'
+
+      c.update_stream(new_stream)
+
+      loaded = c.stream('//stuffs/new_stream')
+      expect(loaded.description.strip).to eq('updated')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#delete_stream' do
+
+  it "'should be able to delete a stream created via #create_stream'" do
+    client_as_jdoe do |c|
+      c.delete_stream('//stuffs/new_stream')
+
+      streams = c.streams
+      expect(streams.map(&:stream_id)).to_not include('//stuffs/new_stream')
+    end
+  end
+end

data/spec/triggers_spec.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#triggers' do
+
+  it 'should allow us to update and fetch a new example trigger line' do
+    client_as_super do |c|
+      t = c.triggers
+      t.triggers << 'cscheck change-submit //depot/... "cmd %changelist%"'
+      c.update_triggers(t)
+
+      loaded = c.triggers
+      expected_trigger = 'cscheck change-submit //depot/... "cmd %changelist%"'
+      expect(loaded.triggers).to include(expected_trigger)
+    end
+  end
+
+end

data/spec/users_spec.rb

@@ -0,0 +1,78 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#users' do
+
+  it "should at least return the 'jdoe' and 'super' users" do
+    client_as_jdoe do |c|
+      users = c.users
+      expect(users.length).to be >= 2
+      logins = users.map(&:user)
+      expect(logins).to include('jdoe')
+      expect(logins).to include('super')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#user' do
+
+  it "should return the user 'mmustermann' who has the name 'Max Mustermann'" do
+    client_as_jdoe do |c|
+      max = c.user('mmustermann')
+      expect(max.full_name).to eq('Max Mustermann')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#create_user' do
+
+  it 'should be able to create a new user and load it' do
+    client_as_jdoe do |c|
+      new_user = P4WebApiClient::Models::User.new
+      new_user.user = 'newuser'
+      new_user.full_name = 'New User'
+      new_user.email = 'newuser@example.com'
+
+      c.create_user(new_user)
+
+      loaded = c.user('newuser')
+
+      expect(loaded.user).to eq('newuser')
+      expect(loaded.full_name).to eq('New User')
+      expect(loaded.email).to eq('newuser@example.com')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_user' do
+
+  it "should be able update mmusterman's email to max_power@example.com" do
+    client_as_jdoe do |c|
+      max_user = c.user('mmustermann')
+      max_user.email = 'max_power@example.com'
+
+      c.update_user(max_user)
+
+      loaded = c.user('mmustermann')
+
+      expect(loaded.email).to eq('max_power@example.com')
+    end
+  end
+end
+
+# I *think* this will run after the create_user spec if defined here.
+RSpec.describe P4WebApiClient::Client, '#delete_user' do
+
+  it 'should be able to delete the newuser user' do
+    client_as_jdoe do |c|
+      c.delete_user('newuser')
+
+      users = c.users
+      expect(users.find { |u| u.user == 'newuser' }).to be nil
+    end
+  end
+end