directus_sdk 1.1.1

data/spec/api/preferences_api_spec.rb

@@ -0,0 +1,65 @@
+=begin
+#directus.io
+
+#API for directus.io
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DirectusSDK::PreferencesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'PreferencesApi' do
+  before do
+    # run before each test
+    @instance = DirectusSDK::PreferencesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PreferencesApi' do
+    it 'should create an instance of PreferencesApi' do
+      expect(@instance).to be_instance_of(DirectusSDK::PreferencesApi)
+    end
+  end
+
+  # unit tests for get_preferences
+  # Returns table preferences
+  # 
+  # @param table_id ID of table to return rows from
+  # @param [Hash] opts the optional parameters
+  # @return [GetPreferences]
+  describe 'get_preferences 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 update_preferences
+  # Update table preferences
+  # 
+  # @param table_id ID of table to return rows from
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :id Preference's Unique Identification number
+  # @option opts [String] :table_name Name of table to add
+  # @option opts [String] :columns_visible List of visible columns, separated by commas
+  # @option opts [Integer] :sort The sort order of the column used to override the column order in the schema
+  # @option opts [String] :sort_order Sort Order (ASC=Ascending or DESC=Descending)
+  # @option opts [String] :status List of status values. separated by comma
+  # @return [nil]
+  describe 'update_preferences 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/settings_api_spec.rb

@@ -0,0 +1,71 @@
+=begin
+#directus.io
+
+#API for directus.io
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DirectusSDK::SettingsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SettingsApi' do
+  before do
+    # run before each test
+    @instance = DirectusSDK::SettingsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SettingsApi' do
+    it 'should create an instance of SettingsApi' do
+      expect(@instance).to be_instance_of(DirectusSDK::SettingsApi)
+    end
+  end
+
+  # unit tests for get_settings
+  # Returns settings
+  # 
+  # @param [Hash] opts the optional parameters
+  # @return [GetSettings]
+  describe 'get_settings 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_settings_for
+  # Returns settings for collection
+  # 
+  # @param collection_name Name of collection to return settings for
+  # @param [Hash] opts the optional parameters
+  # @return [GetSettingsFor]
+  describe 'get_settings_for 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 update_settings
+  # Update settings
+  # 
+  # @param collection_name Name of collection to return settings for
+  # @param custom_data Data based on your specific schema eg: active=1&title=LoremIpsum
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_settings 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/tables_api_spec.rb

@@ -0,0 +1,236 @@
+=begin
+#directus.io
+
+#API for directus.io
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DirectusSDK::TablesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'TablesApi' do
+  before do
+    # run before each test
+    @instance = DirectusSDK::TablesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TablesApi' do
+    it 'should create an instance of TablesApi' do
+      expect(@instance).to be_instance_of(DirectusSDK::TablesApi)
+    end
+  end
+
+  # unit tests for add_column
+  # Create a column in a given table
+  # 
+  # @param table_id ID of table to return rows from
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :table_name Name of table to add
+  # @option opts [String] :column_name The unique name of the column to create
+  # @option opts [String] :type The datatype of the column, eg: INT
+  # @option opts [String] :ui The Directus Interface to use for this column
+  # @option opts [BOOLEAN] :hidden_input Whether the column will be hidden (globally) on the Edit Item page
+  # @option opts [BOOLEAN] :hidden_list Whether the column will be hidden (globally) on the Item Listing page
+  # @option opts [BOOLEAN] :required Whether the column is required. If required, the interface's validation function will be triggered
+  # @option opts [Integer] :sort The sort order of the column used to override the column order in the schema
+  # @option opts [String] :comment A helpful note to users for this column
+  # @option opts [String] :relationship_type The column's relationship type (only used when storing relational data) eg: ONETOMANY, MANYTOMANY or MANYTOONE
+  # @option opts [String] :related_table The table name this column is related to (only used when storing relational data)
+  # @option opts [String] :junction_table The pivot/junction table that joins the column's table with the related table (only used when storing relational data)
+  # @option opts [String] :junction_key_left The column name in junction that is related to the column's table (only used when storing relational data)
+  # @option opts [String] :junction_key_right The column name in junction that is related to the related table (only used when storing relational data)
+  # @return [nil]
+  describe 'add_column 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 add_row
+  # Add a new row
+  # 
+  # @param table_id ID of table to return rows from
+  # @param custom_data Data based on your specific schema eg: active=1&title=LoremIpsum
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'add_row 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 add_table
+  # Add a new table
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name Name of table to add
+  # @return [nil]
+  describe 'add_table 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 delete_column
+  # Delete row
+  # 
+  # @param table_id ID of table to return rows from
+  # @param column_name Name of column to return
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_column 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 delete_row
+  # Delete row
+  # 
+  # @param table_id ID of table to return rows from
+  # @param row_id ID of row to return from rows
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_row 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 delete_table
+  # Delete Table
+  # 
+  # @param table_id ID of table to return rows from
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_table 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_table
+  # Returns specific table
+  # 
+  # @param table_id ID of table to return rows from
+  # @param [Hash] opts the optional parameters
+  # @return [GetTable]
+  describe 'get_table 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_table_column
+  # Returns specific table column
+  # 
+  # @param table_id ID of table to return rows from
+  # @param column_name Name of column to return
+  # @param [Hash] opts the optional parameters
+  # @return [GetTableColumn]
+  describe 'get_table_column 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_table_columns
+  # Returns table columns
+  # 
+  # @param table_id ID of table to return rows from
+  # @param [Hash] opts the optional parameters
+  # @return [GetTableColumns]
+  describe 'get_table_columns 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_table_row
+  # Returns specific table row
+  # 
+  # @param table_id ID of table to return rows from
+  # @param row_id ID of row to return from rows
+  # @param [Hash] opts the optional parameters
+  # @return [GetTableRow]
+  describe 'get_table_row 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_table_rows
+  # Returns table rows
+  # 
+  # @param table_id ID of table to return rows from
+  # @param [Hash] opts the optional parameters
+  # @return [GetTableRows]
+  describe 'get_table_rows 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_tables
+  # Returns tables
+  # 
+  # @param [Hash] opts the optional parameters
+  # @return [GetTables]
+  describe 'get_tables 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 update_column
+  # Update column
+  # 
+  # @param table_id ID of table to return rows from
+  # @param column_name Name of column to return
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :data_type The datatype of the column, eg: INT
+  # @option opts [String] :ui The Directus Interface to use for this column
+  # @option opts [BOOLEAN] :hidden_input Whether the column will be hidden (globally) on the Edit Item page
+  # @option opts [BOOLEAN] :hidden_list Whether the column will be hidden (globally) on the Item Listing page
+  # @option opts [BOOLEAN] :required Whether the column is required. If required, the interface's validation function will be triggered
+  # @option opts [Integer] :sort The sort order of the column used to override the column order in the schema
+  # @option opts [String] :comment A helpful note to users for this column
+  # @option opts [String] :relationship_type The column's relationship type (only used when storing relational data) eg: ONETOMANY, MANYTOMANY or MANYTOONE
+  # @option opts [String] :related_table The table name this column is related to (only used when storing relational data)
+  # @option opts [String] :junction_table The pivot/junction table that joins the column's table with the related table (only used when storing relational data)
+  # @option opts [String] :junction_key_left The column name in junction that is related to the column's table (only used when storing relational data)
+  # @option opts [String] :junction_key_right The column name in junction that is related to the related table (only used when storing relational data)
+  # @return [nil]
+  describe 'update_column 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 update_row
+  # Update row
+  # 
+  # @param table_id ID of table to return rows from
+  # @param row_id ID of row to return from rows
+  # @param custom_data Data based on your specific schema eg: active=1&title=LoremIpsum
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_row 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/utils_api_spec.rb

@@ -0,0 +1,61 @@
+=begin
+#directus.io
+
+#API for directus.io
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DirectusSDK::UtilsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UtilsApi' do
+  before do
+    # run before each test
+    @instance = DirectusSDK::UtilsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UtilsApi' do
+    it 'should create an instance of UtilsApi' do
+      expect(@instance).to be_instance_of(DirectusSDK::UtilsApi)
+    end
+  end
+
+  # unit tests for get_hash
+  # Get a hashed value
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :string The string to be hashed
+  # @option opts [String] :hasher The hasher used to hash the given string
+  # @option opts [String] :options The hasher options
+  # @return [nil]
+  describe 'get_hash 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_random
+  # Returns random alphanumeric string
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :length Integer(String) for length of random string
+  # @return [nil]
+  describe 'get_random 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_client_spec.rb

@@ -0,0 +1,226 @@
+=begin
+#directus.io
+
+#API for directus.io
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe DirectusSDK::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          DirectusSDK.configure { |c| c.host = 'http://example.com' }
+          expect(DirectusSDK::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          DirectusSDK.configure { |c| c.host = 'https://wookiee.com' }
+          expect(DirectusSDK::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          DirectusSDK.configure { |c| c.host = 'hobo.com/v4' }
+          expect(DirectusSDK::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          DirectusSDK.configure { |c| c.base_path = 'v4/dog' }
+          expect(DirectusSDK::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          DirectusSDK.configure { |c| c.base_path = '/v4/dog' }
+          expect(DirectusSDK::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          DirectusSDK.configure { |c| c.base_path = nil }
+          expect(DirectusSDK::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "params_encoding in #build_request" do
+    let(:config) { DirectusSDK::Configuration.new }
+    let(:api_client) { DirectusSDK::ApiClient.new(config) }
+
+    it "defaults to nil" do
+      expect(DirectusSDK::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it "can be customized" do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe "timeout in #build_request" do
+    let(:config) { DirectusSDK::Configuration.new }
+    let(:api_client) { DirectusSDK::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(DirectusSDK::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it "can be customized" do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe "#deserialize" do
+    it "handles Array<Integer>" do
+      api_client = DirectusSDK::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it "handles Array<Array<Integer>>" do
+      api_client = DirectusSDK::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it "handles Hash<String, String>" do
+      api_client = DirectusSDK::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq({:message => 'Hello'})
+    end
+  end
+
+  describe "#object_to_hash" do
+    it "ignores nils and includes empty arrays" do
+      # uncomment below to test object_to_hash for model
+      #api_client = DirectusSDK::ApiClient.new
+      #_model = DirectusSDK::ModelName.new
+      # update the model attribute below
+      #_model.id = 1 
+      # update the expected value (hash) below
+      #expected = {id: 1, name: '', tags: []}
+      #expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe "#build_collection_param" do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { DirectusSDK::ApiClient.new }
+
+    it "works for csv" do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it "works for ssv" do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it "works for tsv" do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it "works for pipes" do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it "works for multi" do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it "fails for invalid collection format" do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe "#json_mime?" do
+    let(:api_client) { DirectusSDK::ApiClient.new }
+
+    it "works" do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe "#select_header_accept" do
+    let(:api_client) { DirectusSDK::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe "#select_header_content_type" do
+    let(:api_client) { DirectusSDK::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe "#sanitize_filename" do
+    let(:api_client) { DirectusSDK::ApiClient.new }
+
+    it "works" do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end