ddr_client 2.0.0.d9f2bd2b

data/lib/ddr_client.rb

@@ -0,0 +1,74 @@
+=begin
+#Duke Digital Repository API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.36
+
+=end
+
+# Common files
+require 'ddr_client/api_client'
+require 'ddr_client/api_error'
+require 'ddr_client/version'
+require 'ddr_client/configuration'
+
+# Models
+require 'ddr_client/models/ddr_api_batch_entity'
+require 'ddr_client/models/ddr_api_batch_entity_logfile'
+require 'ddr_client/models/ddr_api_batch_object_attribute_entity'
+require 'ddr_client/models/ddr_api_batch_object_datastream_entity'
+require 'ddr_client/models/ddr_api_batch_object_entity'
+require 'ddr_client/models/ddr_api_batch_object_message_entity'
+require 'ddr_client/models/ddr_api_batch_object_relationship_entity'
+require 'ddr_client/models/ddr_api_batch_object_role_entity'
+require 'ddr_client/models/ddr_api_event_entity'
+require 'ddr_client/models/ddr_api_file_entity'
+require 'ddr_client/models/ddr_api_group_entity'
+require 'ddr_client/models/ddr_api_group_member_entity'
+require 'ddr_client/models/ddr_api_link_entity'
+require 'ddr_client/models/ddr_api_resource_entity'
+require 'ddr_client/models/ddr_api_resource_entity_files'
+require 'ddr_client/models/ddr_api_resource_entity_metadata'
+require 'ddr_client/models/ddr_api_resource_entity_related'
+require 'ddr_client/models/ddr_api_role_entity'
+require 'ddr_client/models/ddr_api_technical_metadata_entity'
+require 'ddr_client/models/ddr_api_user_entity'
+require 'ddr_client/models/patch_resources'
+require 'ddr_client/models/patch_resources_metadata'
+require 'ddr_client/models/patch_resources_related'
+require 'ddr_client/models/patch_resources_roles'
+require 'ddr_client/models/post_resources'
+
+# APIs
+require 'ddr_client/api/batch_objects_api'
+require 'ddr_client/api/batches_api'
+require 'ddr_client/api/events_api'
+require 'ddr_client/api/groups_api'
+require 'ddr_client/api/index_api'
+require 'ddr_client/api/queues_api'
+require 'ddr_client/api/reports_api'
+require 'ddr_client/api/resources_api'
+require 'ddr_client/api/schema_api'
+require 'ddr_client/api/users_api'
+
+module DdrClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   DdrClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/batch_objects_api_spec.rb

@@ -0,0 +1,61 @@
+=begin
+#Duke Digital Repository API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.36
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DdrClient::BatchObjectsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'BatchObjectsApi' do
+  before do
+    # run before each test
+    @instance = DdrClient::BatchObjectsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BatchObjectsApi' do
+    it 'should create an instance of BatchObjectsApi' do
+      expect(@instance).to be_instance_of(DdrClient::BatchObjectsApi)
+    end
+  end
+
+  # unit tests for get_batch_objects
+  # Retrieve batch object records
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :resource_id Filter by resource ID
+  # @option opts [String] :type Filter by batch object type
+  # @option opts [Array<String>] :model Filter by models(s)
+  # @option opts [Object] :per_page JSON only: Number of records to return per page (default: 20)
+  # @option opts [Object] :page JSON only: Page number of results to return (default: 1)
+  # @return [Array<DdrAPIBatchObjectEntity>]
+  describe 'get_batch_objects test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_batch_objects_id
+  # Retrieve a batch object record with details (attributes, files, messages, relationships, roles)
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [DdrAPIBatchObjectEntity]
+  describe 'get_batch_objects_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/batches_api_spec.rb

@@ -0,0 +1,100 @@
+=begin
+#Duke Digital Repository API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.36
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DdrClient::BatchesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'BatchesApi' do
+  before do
+    # run before each test
+    @instance = DdrClient::BatchesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BatchesApi' do
+    it 'should create an instance of BatchesApi' do
+      expect(@instance).to be_instance_of(DdrClient::BatchesApi)
+    end
+  end
+
+  # unit tests for get_batches
+  # List batches
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :outcome Filter by batch processing outcome
+  # @option opts [Integer] :user_id Filter by user ID associated with the batch
+  # @option opts [String] :status Filter by batch status
+  # @option opts [Object] :per_page JSON only: Number of records to return per page (default: 20)
+  # @option opts [Object] :page JSON only: Page number of results to return (default: 1)
+  # @return [Array<DdrAPIBatchEntity>]
+  describe 'get_batches test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_batches_id
+  # Retrieve a batch record
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :batch_objects Include related batch objects (not paginated)
+  # @return [DdrAPIBatchEntity]
+  describe 'get_batches_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_batches_id_batch_objects
+  # Retrieve the batch objects for a batch
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :batch_object_details JSON only: Include related attributes, files, messages, relationships, and roles for each batch object
+  # @option opts [Object] :per_page JSON only: Number of records to return per page (default: 20)
+  # @option opts [Object] :page JSON only: Page number of results to return (default: 1)
+  # @return [Array<DdrAPIBatchObjectEntity>]
+  describe 'get_batches_id_batch_objects test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_batches_id_log
+  # Download the batch log file
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'get_batches_id_log test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_batches_id_messages
+  # Retrieve the batch object messages for a batch
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Object] :per_page JSON only: Number of records to return per page (default: 20)
+  # @option opts [Object] :page JSON only: Page number of results to return (default: 1)
+  # @return [Array<DdrAPIBatchObjectMessageEntity>]
+  describe 'get_batches_id_messages test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/events_api_spec.rb

@@ -0,0 +1,64 @@
+=begin
+#Duke Digital Repository API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.36
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DdrClient::EventsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'EventsApi' do
+  before do
+    # run before each test
+    @instance = DdrClient::EventsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EventsApi' do
+    it 'should create an instance of EventsApi' do
+      expect(@instance).to be_instance_of(DdrClient::EventsApi)
+    end
+  end
+
+  # unit tests for get_events
+  # Retrieve events
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :resource_id Filter by resource (required for XML output)
+  # @option opts [String] :type Filter by event type
+  # @option opts [String] :outcome Filter by event outcome
+  # @option opts [String] :operator Filter by event operator (user name or \"SYSTEM\")
+  # @option opts [DateTime] :since Filter events occurring since a point a time
+  # @option opts [DateTime] :before Filter events occurring up to (before) a point in time
+  # @option opts [Object] :per_page JSON only: Number of records to return per page (default: 20)
+  # @option opts [Object] :page JSON only: Page number of results to return (default: 1)
+  # @return [Array<DdrAPIEventEntity>]
+  describe 'get_events test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_events_id
+  # Retrieve event
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [DdrAPIEventEntity]
+  describe 'get_events_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/groups_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#Duke Digital Repository API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.36
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DdrClient::GroupsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'GroupsApi' do
+  before do
+    # run before each test
+    @instance = DdrClient::GroupsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GroupsApi' do
+    it 'should create an instance of GroupsApi' do
+      expect(@instance).to be_instance_of(DdrClient::GroupsApi)
+    end
+  end
+
+  # unit tests for get_groups
+  # List repository groups
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :include_members Include members for each group
+  # @return [Array<DdrAPIGroupEntity>]
+  describe 'get_groups test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/index_api_spec.rb

@@ -0,0 +1,67 @@
+=begin
+#Duke Digital Repository API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.36
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DdrClient::IndexApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'IndexApi' do
+  before do
+    # run before each test
+    @instance = DdrClient::IndexApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IndexApi' do
+    it 'should create an instance of IndexApi' do
+      expect(@instance).to be_instance_of(DdrClient::IndexApi)
+    end
+  end
+
+  # unit tests for delete_index_id
+  # Delete a document
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_index_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_index_id
+  # Retrieve a document
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_index_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_index_schema
+  # Retrieve the index schema
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_index_schema test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/queues_api_spec.rb

@@ -0,0 +1,55 @@
+=begin
+#Duke Digital Repository API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.36
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DdrClient::QueuesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'QueuesApi' do
+  before do
+    # run before each test
+    @instance = DdrClient::QueuesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of QueuesApi' do
+    it 'should create an instance of QueuesApi' do
+      expect(@instance).to be_instance_of(DdrClient::QueuesApi)
+    end
+  end
+
+  # unit tests for delete_queues_locks
+  # Unlock locked jobs
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_queues_locks test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_queues_stats
+  # Retrieve summary infomation on background job queues
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_queues_stats test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/reports_api_spec.rb

@@ -0,0 +1,70 @@
+=begin
+#Duke Digital Repository API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.36
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DdrClient::ReportsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ReportsApi' do
+  before do
+    # run before each test
+    @instance = DdrClient::ReportsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ReportsApi' do
+    it 'should create an instance of ReportsApi' do
+      expect(@instance).to be_instance_of(DdrClient::ReportsApi)
+    end
+  end
+
+  # unit tests for get_reports_collection_summary
+  # Collection summary report
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :fields Fields to include for each collection (default: id, title, ingestion_date, admin_set, workflow_state)
+  # @return [File]
+  describe 'get_reports_collection_summary test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_reports_duplicate_content
+  # Duplicate content report
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :fields Fields to include in the report (default: sha1, id, model, original_filename, parent_id, collection_title, workflow_state, ingestion_date)
+  # @return [File]
+  describe 'get_reports_duplicate_content test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_reports_roles
+  # Roles report
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :include_inherited Include inherited roles for Item resources
+  # @option opts [String] :collection_id Limit resources to members of Collection ID
+  # @option opts [Array<String>] :fields Fields to include in the report (default: id, model, title)
+  # @return [File]
+  describe 'get_reports_roles test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end