order_cloud 0.0.1

data/spec/api/user_group_api_spec.rb

@@ -0,0 +1,174 @@
+=begin
+#OrderCloud
+
+#A full ecommerce backend as a service.
+
+OpenAPI spec version: 1.0
+Contact: ordercloud@four51.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OrderCloud::UserGroupApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UserGroupApi' do
+  before do
+    # run before each test
+    @instance = OrderCloud::UserGroupApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UserGroupApi' do
+    it 'should create an instact of UserGroupApi' do
+      expect(@instance).to be_instance_of(OrderCloud::UserGroupApi)
+    end
+  end
+
+  # unit tests for create
+  # 
+  # 
+  # @param buyer_id ID of the buyer.
+  # @param group 
+  # @param [Hash] opts the optional parameters
+  # @return [UserGroup]
+  describe 'create 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
+  # 
+  # 
+  # @param buyer_id ID of the buyer.
+  # @param user_group_id ID of the user group.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete 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_user_assignment
+  # 
+  # 
+  # @param buyer_id ID of the buyer.
+  # @param user_group_id ID of the user group.
+  # @param user_id ID of the user.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_user_assignment 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
+  # 
+  # 
+  # @param buyer_id ID of the buyer.
+  # @param user_group_id ID of the user group.
+  # @param [Hash] opts the optional parameters
+  # @return [UserGroup]
+  describe 'get 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 list
+  # 
+  # 
+  # @param buyer_id ID of the buyer.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :search Word or phrase to search for.
+  # @option opts [String] :search_on Comma-delimited list of fields to search on.
+  # @option opts [String] :sort_by Comma-delimited list of fields to sort by.
+  # @option opts [Integer] :page Page of results to return. Default: 1
+  # @option opts [Integer] :page_size Number of results to return per page. Default: 20, max: 100.
+  # @option opts [Hash<String, String>] :filters Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;
+  # @return [ListUserGroup]
+  describe 'list 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 list_user_assignments
+  # 
+  # 
+  # @param buyer_id ID of the buyer.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :user_group_id ID of the user group.
+  # @option opts [String] :user_id ID of the user.
+  # @option opts [Integer] :page Page of results to return. Default: 1
+  # @option opts [Integer] :page_size Number of results to return per page. Default: 20, max: 100.
+  # @return [ListUserGroupAssignment]
+  describe 'list_user_assignments 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 patch
+  # 
+  # 
+  # @param buyer_id ID of the buyer.
+  # @param user_group_id ID of the user group.
+  # @param group 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'patch 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 save_user_assignment
+  # 
+  # 
+  # @param buyer_id ID of the buyer.
+  # @param user_group_assignment 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'save_user_assignment 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
+  # 
+  # 
+  # @param buyer_id ID of the buyer.
+  # @param user_group_id ID of the user group.
+  # @param group 
+  # @param [Hash] opts the optional parameters
+  # @return [UserGroup]
+  describe 'update 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_auth_spec.rb

@@ -0,0 +1,165 @@
+=begin
+#OrderCloud
+
+#A full ecommerce backend as a service.
+
+OpenAPI spec version: 1.0
+Contact: ordercloud@four51.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+
+describe OrderCloud::ApiAuth do
+  let(:valid_client_id) { 'BA89381F-E787-477D-B220-F8A01F0D582A' }
+  let(:valid_username) { 'testo5' }
+  let(:valid_password) { 'testo5' }
+  let(:valid_client_secret) { '' }
+
+  let(:invalid_client_id) { 've1fYQ0NXME13wa5JetO' }
+  let(:invalid_username) { 'invaliduser' }
+  let(:invalid_password) { 'invalidpassword' }
+  let(:invalid_client_secret) { 'L6kzJlz1ewwYYeVozNCs' }
+
+  let(:scopes) { ['FullAccess'] }
+  let(:bad_auth_url) { 'thisshouldnotwork.com' }
+
+  let(:impersonation_token) { '4QAtuGBvK8bj22XdT0H5' }
+
+  let(:config) { OrderCloud::Configuration.default }
+  before(:each) do
+    OrderCloud::Configuration.reset
+    OrderCloud.configure { |c|
+      c.auth_url = "https://auth.ordercloud.io/oauth/token"
+    }
+  end
+
+  describe '#password_flow' do
+    context 'with valid data' do
+      it 'does not raise error and set an access token' do
+        OrderCloud.configure { |c|
+          c.client_id = valid_client_id
+          c.scopes = scopes
+        }
+        expect{ OrderCloud::ApiAuth::login(valid_username, valid_password)}.to_not raise_error
+        expect(config.access_token).to_not be_nil
+      end
+    end
+
+    context 'with invalid id or empty data' do
+      it 'fails if the auth url is invalid' do
+        OrderCloud.configure { |c|
+          c.client_id = valid_client_id
+          c.scopes = scopes
+          c.auth_url = bad_auth_url
+        }
+        expect { OrderCloud::ApiAuth::login(valid_username, valid_password)}.to raise_error(ArgumentError)
+        expect(config.access_token).to be_nil
+      end
+
+      it 'fails if the client id is not provided' do
+        OrderCloud.configure { |c|
+          c.scopes = scopes
+        }
+        expect { OrderCloud::ApiAuth::login(valid_username, valid_password)}.to raise_error(NoMethodError)
+        expect(config.access_token).to be_nil
+      end
+
+      it 'fails if the client id is invalid' do
+        OrderCloud.configure { |c|
+          c.client_id = invalid_client_id
+          c.scopes = scopes
+        }
+        expect { OrderCloud::ApiAuth::login(valid_username, valid_password)}.to raise_error(NoMethodError)
+        expect(config.access_token).to be_nil
+      end
+
+      it 'fails if invalid login/username' do
+        OrderCloud.configure { |c|
+          c.client_id = valid_client_id
+          c.scopes = @scopes
+        }
+        expect { OrderCloud::ApiAuth::login(invalid_username, invalid_password)}.to raise_error(NoMethodError)
+        expect(config.access_token).to be_nil
+      end
+    end
+  end
+
+  describe '#client_credentials_flow' do
+    it 'does not raise error and set an access token' do
+      OrderCloud.configure { |c|
+        c.client_id = valid_client_id
+        c.scopes = scopes
+      }
+      expect{ OrderCloud::ApiAuth::authenticate()}.to_not raise_error
+      expect(config.access_token).to_not be_nil
+    end
+
+    it 'fails if the auth url is invalid' do
+      OrderCloud.configure { |c|
+        c.client_id = valid_client_id
+        c.scopes = scopes
+        c.auth_url = bad_auth_url
+      }
+      expect { OrderCloud::ApiAuth::authenticate}.to raise_error(ArgumentError)
+      expect(config.access_token).to be_nil
+    end
+
+    it 'fails if the client id is not provided' do
+      OrderCloud.configure { |c|
+        c.scopes = scopes
+      }
+      expect { OrderCloud::ApiAuth::authenticate}.to raise_error(NoMethodError)
+      expect(config.access_token).to be_nil
+    end
+
+    it 'fails if the client id is invalid' do
+      OrderCloud.configure { |c|
+        c.client_id = invalid_client_id
+        c.scopes = scopes
+      }
+      expect { OrderCloud::ApiAuth::authenticate}.to raise_error(NoMethodError)
+      expect(config.access_token).to be_nil
+    end
+  end
+
+  describe '#impersonation' do
+    it 'succeeds when provided a token' do
+      expect{ OrderCloud::ApiAuth.start_impersonate(impersonation_token)}.to_not raise_error
+      expect(config.impersonating?).to be_truthy
+    end
+
+    it 'fails to start if not provided an impersonation token' do
+      expect{ OrderCloud::ApiAuth.start_impersonate(nil)}.to raise_error(ArgumentError)
+    end
+
+    it 'stops impersonating properly' do
+      OrderCloud::ApiAuth.start_impersonate(impersonation_token)
+      expect(config.impersonating?).to be_truthy
+
+      OrderCloud::ApiAuth.stop_impersonate()
+      expect(config.impersonating?).to be_falsey
+    end
+
+    it 'returns the proper access tokens' do
+      OrderCloud::ApiAuth.start_impersonate(impersonation_token)
+      expect(config.get_access_token).to eq(impersonation_token)
+
+      OrderCloud::ApiAuth.stop_impersonate()
+      expect(config.get_access_token).to_not eq(impersonation_token)
+    end
+  end
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,237 @@
+=begin
+#OrderCloud
+
+#A full ecommerce backend as a service.
+
+OpenAPI spec version: 1.0
+Contact: ordercloud@four51.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+
+describe OrderCloud::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          OrderCloud.configure { |c| c.host = 'http://example.com' }
+          expect(OrderCloud::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          OrderCloud.configure { |c| c.host = 'https://wookiee.com' }
+          expect(OrderCloud::Configuration.default.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          OrderCloud.configure { |c| c.host = 'hobo.com/v4' }
+          expect(OrderCloud::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          OrderCloud.configure { |c| c.base_path = 'v4/dog' }
+          expect(OrderCloud::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          OrderCloud.configure { |c| c.base_path = '/v4/dog' }
+          expect(OrderCloud::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          OrderCloud.configure { |c| c.base_path = nil }
+          expect(OrderCloud::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "params_encoding in #build_request" do
+    let(:config) { OrderCloud::Configuration.new }
+    let(:api_client) { OrderCloud::ApiClient.new(config) }
+
+    it "defaults to nil" do
+      expect(OrderCloud::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) { OrderCloud::Configuration.new }
+    let(:api_client) { OrderCloud::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(OrderCloud::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 = OrderCloud::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 = OrderCloud::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 = OrderCloud::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 = OrderCloud::ApiClient.new
+      #_model = OrderCloud::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) { OrderCloud::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) { OrderCloud::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) { OrderCloud::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) { OrderCloud::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) { OrderCloud::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