p4_web_api_client 2014.2.0.pre1

data/lib/p4_web_api_client/models/label.rb

@@ -0,0 +1,75 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'time'
+
+module P4WebApiClient
+  module Models
+    # Models the output of the Label specification.
+    #
+    # See also:
+    # - http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_label.html
+    # - http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_labels.html
+    class Label
+      # The label name and primary id
+      attr_accessor :label
+
+      # The label's owner, a Perforce login
+      attr_accessor :owner
+
+      # DateTime of when the label wa last modified
+      attr_accessor :update
+
+      # DateTime when the label was last accessed, by running p4 labelsync on
+      # the label, or otherwise referring to a file with the revision
+      # specifier `@label`
+      attr_accessor :access
+
+      # An optional description of the label's purpose
+      attr_accessor :description
+
+      # String of different options to control behavior.
+      attr_accessor :options
+
+      # An optional revision specification for an automatic label
+      attr_accessor :revision
+
+      # Array of depot file specifications that can be tagged with this label.
+      attr_accessor :view
+
+      # If set, restricts label usage to the named server
+      attr_accessor :server_id
+
+      def initialize(obj = {})
+        @label = obj['Label'] if obj.key?('Label')
+        @owner = obj['Owner'] if obj.key?('Owner')
+        @update = Time.at(obj['Update']).to_datetime if obj.key?('Update')
+        @access = Time.at(obj['Access']).to_datetime if obj.key?('Access')
+        @description = obj['Description'] if obj.key?('Description')
+        @options = obj['Options'] if obj.key?('Options')
+        @revision = obj['Revision'] if obj.key?('Revision')
+        @view = obj['View'].map(&:clone) if obj.key?('View')
+        @server_id = obj['ServerID'] if obj.key?('ServerID')
+
+        # If the user has defined symbols in the Ruby-ish API, then use that
+        # too, but we expect the data to be in the right format.
+        obj.each_key do |key|
+          accessor = "#{key}="
+          send(accessor, obj[key]) if self.respond_to?(accessor)
+        end
+      end
+
+      def to_internal_hash
+        hash = {
+          Label: @label
+        }
+        hash[:Owner] = @owner if @owner
+        hash[:Description] = @description if @description
+        hash[:Options] = @options if @options
+        hash[:Revision] = @revision if @revision
+        hash[:View] = @view if @view
+        hash[:ServerID] = @server_id if @server_id
+        hash
+      end
+    end
+  end
+end

data/lib/p4_web_api_client/models/protections.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+module P4WebApiClient
+  module Models
+    # Models the output of the 'p4 protects' command.
+    #
+    # See also:
+    # - http://www.perforce.com/perforce/doc.current/manuals/p4sag/chapter.protections.html
+    # - http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_protects.html
+    class Protections
+      # An array of strings, each string representing a line of the protections
+      # table. Order of the array is significant.
+      attr_accessor :protections
+
+      def initialize(obj = {})
+        @protections = obj['Protections'] if obj.key?('Protections')
+        @protections = [] unless @protections
+
+        # If the user has defined symbols in the Ruby-ish API, then use that
+        # too, but we expect the data to be in the right format.
+        obj.each_key do |key|
+          accessor = "#{key}="
+          send(accessor, obj[key]) if self.respond_to?(accessor)
+        end
+      end
+
+      def to_internal_hash
+        {
+          Protections: @protections
+        }
+      end
+    end
+  end
+end

data/lib/p4_web_api_client/models/server.rb

@@ -0,0 +1,96 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'time'
+
+module P4WebApiClient
+  module Models
+    # Server specifications in the system
+    #
+    # See also:
+    # - http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_server.html
+    # - http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_servers.html
+    class Server
+      # A unique ID for the server.
+      attr_accessor :server_id
+
+      # Server executable type: :server, :proxy, :broker
+      attr_accessor :type
+
+      # Services provided by this server, one of: :standard, :replica, :broker,
+      # :proxy, :commit_server, :edge_server, :forwarding_replica,
+      # :build_server, :P4AUTH, :P4CHANGE
+      attr_accessor :services
+
+      # The P4NAME associated with this server
+      attr_accessor :name
+
+      # The P4PORT associated with this server
+      attr_accessor :address
+
+      # Optional description
+      attr_accessor :description
+
+      # The service user that is used by the server.
+      attr_accessor :user
+
+      # For a replica server, this optional field can contain
+      # one or more patterns describing how active client
+      # workspace metadata is to be filtered. Active client
+      # workspace data includes have lists, working records,
+      # and pending resolves.
+      attr_accessor :client_data_filter
+
+      # For a replica server, this optional field can contain one
+      # or more patterns describing how submitted revision
+      # metadata is to be filtered. Submitted revision data
+      # includes revision records, integration records, label
+      # contents, and the files listed in submitted changelists.
+      attr_accessor :revision_data_filter
+
+      # For a replica server, this optional field can contain one or more
+      # patterns describing the policy for automatically scheduling the
+      # replication of file content. If this field is present, only those
+      # files described by the pattern are automatically transferred to the
+      # replica; other files will not be transferred until they are referenced
+      # by a replica command which needs the file content.
+      attr_accessor :archive_data_filter
+
+      def initialize(obj = {})
+        @server_id = obj['ServerID']
+        @type = obj['Type'].to_sym if obj.key?('Type')
+        @services = obj['Services'].to_sym if obj.key?('Services')
+        @name = obj['Name']
+        @address = obj['Address']
+        @description = obj['Description']
+        @user = obj['User']
+        @client_data_filter = obj['ClientDataFilter']
+        @revision_data_filter = obj['RevisionDataFilter']
+        @archive_data_filter = obj['ArchiveDataFilter']
+
+        # If the user has defined symbols in the Ruby-ish API, then use that
+        # too, but we expect the data to be in the right format.
+        obj.each_key do |key|
+          accessor = "#{key}="
+          send(accessor, obj[key]) if self.respond_to?(accessor)
+        end
+      end
+
+      def to_internal_hash
+        hash = {
+          ServerID: @server_id
+        }
+        hash[:Type] = @type.to_s if @type
+        hash[:Services] = @services if @services
+        hash[:Name] = @name if @name
+        hash[:Address] = @address if @address
+        hash[:Description] = @description if @description
+        hash[:User] = @user if @user
+        hash[:ClientDataFilter] = @client_data_filter if @client_data_filter
+        hash[:RevisionDataFilter] =
+            @revision_data_filter if @revision_data_filter
+        hash[:ArchiveDataFilter] = @archive_data_filter if @archive_data_filter
+        hash
+      end
+    end
+  end
+end

data/lib/p4_web_api_client/models/stream.rb

@@ -0,0 +1,111 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'time'
+
+module P4WebApiClient
+  module Models
+    # Model of stream specifications in the Perforce server.
+    #
+    # See also:
+    # - http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html
+    # - http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_streams.html
+    class Stream
+      # The stream name, which is also it's depot path, in the form
+      # //[depot name]/[stream name].
+      attr_accessor :stream
+
+      # DateTime the spec was last modified.
+      attr_accessor :update
+
+      # DateTime the stream was last accessed by any p4 command.
+      attr_accessor :access
+
+      # Perforce user or group that owns the stream.
+      attr_accessor :owner
+
+      # Display name for the stream. This is modifiable.
+      attr_accessor :name
+
+      # The stream parent, or :none if the `type` is :mainline
+      attr_accessor :parent
+
+      # The stream's type determines the expected flow of change. Valid stream
+      # types are :mainline, :virtual, :development, and :release.
+      attr_accessor :type
+
+      # Description of the stream
+      attr_accessor :description
+
+      # Settings that configure stream behavior. This is a single string with
+      # different values, e.g. "locked all toparent fromparent":
+      #
+      # See also:
+      # - http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html
+      attr_accessor :options
+
+      # Array of path definitions.
+      #
+      # Paths define how files are incorporated into the stream structure.
+      # Specify paths using the following format:
+      #
+      #     path_type view_path [depot_path]
+      #
+      # where path_type is a single keyword, view_path is a file path with no
+      # leading slashes, and the optional depot_path is a file path beginning
+      # with //.
+      #
+      # Default: `share ...`
+      #
+      # See also:
+      # - http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html
+      attr_accessor :paths
+
+      # Array of remap definitions.
+      #
+      # See also:
+      # - http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html
+      attr_accessor :remapped
+
+      # An array of path specifications that should be ignored in client views.
+      attr_accessor :ignored
+
+      def initialize(obj = {})
+        @stream = obj['Stream']
+        @update = Time.at(obj['Update']).to_datetime if obj.key?('Update')
+        @access = Time.at(obj['Access']).to_datetime if obj.key?('Access')
+        @owner = obj['Owner']
+        @name = obj['Name']
+        @parent = obj['Parent']
+        @type = obj['Type'].to_sym if obj.key?('Type')
+        @description = obj['Description']
+        @options = obj['Options']
+        @paths = obj['Paths'].map(&:clone) if obj.key?('Paths')
+        @remapped = obj['Remapped'].map(&:clone) if obj.key?('Remapped')
+        @ignored = obj['Ignored'].map(&:clone) if obj.key?('Ignored')
+
+        # If the user has defined symbols in the Ruby-ish API, then use that
+        # too, but we expect the data to be in the right format.
+        obj.each_key do |key|
+          accessor = "#{key}="
+          send(accessor, obj[key]) if self.respond_to?(accessor)
+        end
+      end
+
+      def to_internal_hash
+        hash = {
+          Stream: @stream
+        }
+        hash[:Owner] = @owner if @owner
+        hash[:Name] = @name if @name
+        hash[:Parent] = @parent if @parent
+        hash[:Type] = @type.to_s if @type
+        hash[:Description] = @description if @description
+        hash[:Options] = @options if @options
+        hash[:Paths] = @paths if @paths
+        hash[:Remapped] = @remapped if @remapped
+        hash[:Ignored] = @ignored if @ignored
+        hash
+      end
+    end
+  end
+end

data/lib/p4_web_api_client/models/triggers.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+module P4WebApiClient
+  module Models
+    # Represents output of the 'p4 triggers' command.
+    #
+    # See also:
+    # - http://www.perforce.com/perforce/doc.current/manuals/p4sag/chapter.scripting.html
+    # - http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_triggers.html
+    class Triggers
+      # An array of 'triggers' entries, each entry is a string
+      attr_accessor :triggers
+
+      def initialize(obj = {})
+        # Make sure the array a deep copy to avoid any potential confusion
+        @triggers = obj['Triggers'].map(&:clone) if obj.key?('Triggers')
+        @triggers = [] unless @triggers
+
+        # If the user has defined symbols in the Ruby-ish API, then use that
+        # too, but we expect the data to be in the right format.
+        obj.each_key do |key|
+          accessor = "#{key}="
+          send(accessor, obj[key]) if self.respond_to?(accessor)
+        end
+      end
+
+      def to_internal_hash
+        {
+          Triggers: @triggers
+        }
+      end
+    end
+  end
+end

data/lib/p4_web_api_client/models/user.rb

@@ -0,0 +1,75 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+module P4WebApiClient
+  module Models
+    # Models of Perforce users.
+    #
+    # See http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_user.html
+    class User
+      # The Perforce login
+      attr_accessor :user
+
+      # The type of User: :standard, :operator, or :service
+      attr_accessor :type
+
+      # Note that the default user email is `user@client`
+      attr_accessor :email
+
+      # Either :perforce or :ldap, please refer to the 'p4 user' command
+      # reference for more details.
+      attr_accessor :auth_method
+
+      # DateTime of the last update
+      attr_accessor :update
+
+      # DateTime of the user last ran a command
+      attr_accessor :access
+
+      # The user's full name, may not be set
+      attr_accessor :full_name
+
+      # DateTime of the user's last password change. May not be set
+      attr_accessor :password_change
+
+      # This can be set via Ruby code, though we never return the value, as
+      # parsed from JSON, since the tagged output is generally just a bunch of
+      # asterixes.
+      attr_accessor :password
+
+      # Assumed to be the parsed json response from either GET /v1/users or
+      # GET /v1/users/[userId]
+      def initialize(obj = {})
+        @user = obj['User'] if obj.key?('User')
+        @type = obj['Type'].to_sym if obj.key?('Type')
+        @email = obj['Email'] if obj.key?('Email')
+        @auth_method = obj['AuthMethod'].to_sym if obj.key?('AuthMethod')
+        @update = Time.at(obj['Update']).to_datetime if obj.key?('Update')
+        @access = Time.at(obj['Access']).to_datetime if obj.key?('Access')
+        @full_name = obj['FullName'] if obj.key?('FullName')
+        @password_change = Time.at(obj['PasswordChange']).to_datetime \
+          if obj.key?('PasswordChange')
+
+        # If the user has defined symbols in the Ruby-ish API, then use that
+        # too, but we expect the data to be in the right format.
+        obj.each_key do |key|
+          accessor = "#{key}="
+          send(accessor, obj[key]) if self.respond_to?(accessor)
+        end
+      end
+
+      # Returns a subset of values valid for POST operations
+      def to_internal_hash
+        hash = {
+          User: user
+        }
+        hash[:FullName] = full_name if full_name
+        hash[:Type] = type if type
+        hash[:Email] = email if email
+        hash[:AuthMethod] = auth_method if auth_method
+        hash[:Password] = password if password
+
+        hash
+      end
+    end
+  end
+end

data/lib/p4_web_api_client/models.rb

@@ -0,0 +1,14 @@
+
+require 'p4_web_api_client/models/branch'
+require 'p4_web_api_client/models/change'
+require 'p4_web_api_client/models/client'
+require 'p4_web_api_client/models/depot'
+require 'p4_web_api_client/models/dir'
+require 'p4_web_api_client/models/file'
+require 'p4_web_api_client/models/group'
+require 'p4_web_api_client/models/label'
+require 'p4_web_api_client/models/protections'
+require 'p4_web_api_client/models/server'
+require 'p4_web_api_client/models/stream'
+require 'p4_web_api_client/models/triggers'
+require 'p4_web_api_client/models/user'

data/lib/p4_web_api_client/version.rb

@@ -0,0 +1,3 @@
+module P4WebApiClient
+  VERSION = '2014.2.0.pre1'
+end

data/lib/p4_web_api_client.rb

@@ -0,0 +1,6 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+#
+# p4_web_api_client.rb
+
+require 'p4_web_api_client/connection'
+require 'p4_web_api_client/client'

data/spec/branches_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_branch' do
+
+  it 'should create a new branch - and return it via #branches' do
+    client_as_jdoe do |c|
+      new_branch = P4WebApiClient::Models::Branch.new
+      new_branch.branch = 'new_branch'
+      new_branch.description = 'Something for the kids'
+      new_branch.view = ['//depot/dev/kids/... //depot/main/kids/...']
+
+      c.create_branch(new_branch)
+
+      branches = c.branches
+      expect(branches.map(&:branch)).to include('new_branch')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#branch' do
+
+  it 'should load a single branch created via #create_branch' do
+    client_as_jdoe do |c|
+      new_branch = c.branch('new_branch')
+
+      expect(new_branch.description.strip).to eq('Something for the kids')
+      expect(new_branch.view.length).to eq(1)
+      expected_view = '//depot/dev/kids/... //depot/main/kids/...'
+      expect(new_branch.view.first).to eq(expected_view)
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_branch' do
+
+  it "'should be able to update the branch description'" do
+    client_as_jdoe do |c|
+      new_branch = c.branch('new_branch')
+      new_branch.description = 'updated'
+
+      c.update_branch(new_branch)
+
+      loaded = c.branch('new_branch')
+      expect(loaded.description.strip).to eq('updated')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#delete_branch' do
+
+  it "'should be able to delete a branch created via #create_branch'" do
+    client_as_jdoe do |c|
+      c.delete_branch('new_branch')
+
+      branches = c.branches
+      expect(branches.map(&:branch)).to_not include('new_branch')
+    end
+  end
+end

data/spec/change_spec.rb

@@ -0,0 +1,16 @@
+# Copyright (c) 2014 Perforce Software, Inc.  All rights reserved.
+
+require 'rspec'
+require 'p4_web_api_client'
+require 'test_connections'
+
+RSpec.describe P4WebApiClient::Client, '#changes' do
+
+  it 'should list change 1' do
+    client_as_jdoe do |c|
+      changes = c.changes
+      expect(changes.length).to be >= 1
+      expect(changes.map(&:change)).to include('1')
+    end
+  end
+end

data/spec/clients_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_client' do
+
+  it 'should create a new client - and return it via #clients' do
+    client_as_jdoe do |c|
+      new_client = P4WebApiClient::Models::Client.new
+      new_client.client = 'new_client'
+      new_client.description = 'A client'
+      new_client.root = '/tmp/new_client'
+      new_client.view = ['//depot/dev/kids/... //new_client/dev/kids/...']
+
+      c.create_client(new_client)
+
+      clients = c.clients
+      expect(clients.map(&:client)).to include('new_client')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#client' do
+
+  it 'should load a single client created via #create_client' do
+    client_as_jdoe do |c|
+      new_client = c.client('new_client')
+
+      expect(new_client.description.strip).to eq('A client')
+      expect(new_client.view.length).to eq(1)
+      expected_view = '//depot/dev/kids/... //new_client/dev/kids/...'
+      expect(new_client.view.first).to eq(expected_view)
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_client' do
+
+  it "'should be able to update the client description'" do
+    client_as_jdoe do |c|
+      new_client = c.client('new_client')
+      new_client.description = 'updated'
+
+      c.update_client(new_client)
+
+      loaded = c.client('new_client')
+      expect(loaded.description.strip).to eq('updated')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#delete_client' do
+
+  it "'should be able to delete a client created via #create_client'" do
+    client_as_jdoe do |c|
+      c.delete_client('new_client')
+
+      clients = c.clients
+      expect(clients.map(&:client)).to_not include('new_client')
+    end
+  end
+end

data/spec/depots_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_depot' do
+
+  it 'should create a new depot - and return it via #depots' do
+    client_as_jdoe do |c|
+      new_depot = P4WebApiClient::Models::Depot.new
+      new_depot.depot = 'new_depot'
+      new_depot.description = 'A depot'
+      new_depot.type = :local
+      new_depot.map = 'new_depot/...'
+
+      c.create_depot(new_depot)
+
+      depots = c.depots
+      expect(depots.map(&:depot)).to include('new_depot')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#depot' do
+
+  it 'should load a single depot created via #create_depot' do
+    client_as_jdoe do |c|
+      new_depot = c.depot('new_depot')
+
+      expect(new_depot.description.strip).to eq('A depot')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#update_depot' do
+
+  it "'should be able to update the depot description'" do
+    client_as_jdoe do |c|
+      new_depot = c.depot('new_depot')
+      new_depot.description = 'updated'
+
+      c.update_depot(new_depot)
+
+      loaded = c.depot('new_depot')
+      expect(loaded.description.strip).to eq('updated')
+    end
+  end
+end
+
+RSpec.describe P4WebApiClient::Client, '#delete_depot' do
+
+  it "'should be able to delete a depot created via #create_depot'" do
+    client_as_jdoe do |c|
+      c.delete_depot('new_depot')
+
+      depots = c.depots
+      expect(depots.map(&:depot)).to_not include('new_depot')
+    end
+  end
+end