square_connect 2.0.0 → 2.0.2.13

data/spec/api/customer_card_api_spec.rb

@@ -0,0 +1,71 @@
+=begin
+Square Connect API
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SquareConnect::CustomerCardApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CustomerCardApi' do
+  before do
+    # run before each test
+    @instance = SquareConnect::CustomerCardApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CustomerCardApi' do
+    it 'should create an instact of CustomerCardApi' do
+      @instance.should be_a(SquareConnect::CustomerCardApi)
+    end
+  end
+
+  # unit tests for create_customer_card
+  # CreateCustomerCard
+  # Adds a card on file to an existing customer.
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param customer_id The ID of the customer to link the card on file to.
+  # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+  # @param [Hash] opts the optional parameters
+  # @return [CreateCustomerCardResponse]
+  describe 'create_customer_card test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for delete_customer_card
+  # DeleteCustomerCard
+  # Removes a card on file from a customer.
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param customer_id The ID of the customer that the card on file belongs to.
+  # @param card_id The ID of the card on file to delete.
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteCustomerCardResponse]
+  describe 'delete_customer_card test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/spec/api/location_api_spec.rb

@@ -0,0 +1,58 @@
+=begin
+Square Connect API
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SquareConnect::LocationApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'LocationApi' do
+
+  let(:accounts) { load_accounts() }
+  
+  before do
+    # run before each test
+    @instance = SquareConnect::LocationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of LocationApi' do
+    it 'should create an instact of LocationApi' do
+      @instance.should be_a(SquareConnect::LocationApi)
+    end
+  end
+
+  # unit tests for list_locations
+  # ListLocations
+  # Provides the details for all of a business's locations.  Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter.
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param [Hash] opts the optional parameters
+  # @return [ListLocationsResponse]
+  describe 'list_locations test' do
+    context "Sandbox" do
+      let(:account) { accounts["US-Prod-Sandbox"] }
+      it "should work" do
+        access_token = account["access_token"]
+        result = @instance.list_locations(access_token)
+        locations = result.locations
+        expect(locations.length).to be > 0
+        expect(locations[0]).to be_an_instance_of(SquareConnect::Location)
+        expect(locations[0].id).to eq("CBASEEffqN8pnVNXwoCL0dSGMVAgAQ")
+      end
+    end
+  end
+
+end

data/spec/api/refund_api_spec.rb

@@ -0,0 +1,75 @@
+=begin
+Square Connect API
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SquareConnect::RefundApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RefundApi' do
+  before do
+    # run before each test
+    @instance = SquareConnect::RefundApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RefundApi' do
+    it 'should create an instact of RefundApi' do
+      @instance.should be_a(SquareConnect::RefundApi)
+    end
+  end
+
+  # unit tests for create_refund
+  # CreateRefund
+  # Initiates a refund for a previously charged tender.
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param location_id The ID of the original transaction's associated location.
+  # @param transaction_id The ID of the original transaction that includes the tender to refund.
+  # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+  # @param [Hash] opts the optional parameters
+  # @return [CreateRefundResponse]
+  describe 'create_refund test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for list_refunds
+  # ListRefunds
+  # Lists refunds for one of a business's locations.  Refunds with a `status` of `PENDING` are not currently included in this endpoint's response.  Max results per [page](#paginatingresults): 50
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param location_id The ID of the location to list refunds for.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
+  # @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time.
+  # @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
+  # @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information.
+  # @return [ListRefundsResponse]
+  describe 'list_refunds test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/spec/api/transaction_api_spec.rb

@@ -0,0 +1,128 @@
+=begin
+Square Connect API
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SquareConnect::TransactionApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'TransactionApi' do
+  before do
+    # run before each test
+    @instance = SquareConnect::TransactionApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TransactionApi' do
+    it 'should create an instact of TransactionApi' do
+      @instance.should be_a(SquareConnect::TransactionApi)
+    end
+  end
+
+  # unit tests for capture_transaction
+  # CaptureTransaction
+  # Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param location_id 
+  # @param transaction_id 
+  # @param [Hash] opts the optional parameters
+  # @return [CaptureTransactionResponse]
+  describe 'capture_transaction test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for charge
+  # Charge
+  # Charges a card represented by a card nonce or a customer's card on file.  Your request to this endpoint must include _either_:  - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file)  In order for an e-commerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request:  - `buyer_email_address` - At least one of `billing_address` or `shipping_address`  When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction.
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param location_id The ID of the location to associate the created transaction with.
+  # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+  # @param [Hash] opts the optional parameters
+  # @return [ChargeResponse]
+  describe 'charge test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for list_transactions
+  # ListTransactions
+  # Lists transactions for a particular location.  Max results per [page](#paginatingresults): 50
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param location_id The ID of the location to list transactions for.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
+  # @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time.
+  # @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
+  # @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information.
+  # @return [ListTransactionsResponse]
+  describe 'list_transactions test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for retrieve_transaction
+  # RetrieveTransaction
+  # Retrieves details for a single transaction.
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param location_id The ID of the transaction's associated location.
+  # @param transaction_id The ID of the transaction to retrieve.
+  # @param [Hash] opts the optional parameters
+  # @return [RetrieveTransactionResponse]
+  describe 'retrieve_transaction test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for void_transaction
+  # VoidTransaction
+  # Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.
+  # @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
+  # @param location_id 
+  # @param transaction_id 
+  # @param [Hash] opts the optional parameters
+  # @return [VoidTransactionResponse]
+  describe 'void_transaction test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,226 @@
+=begin
+Square Connect API
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'spec_helper'
+
+describe SquareConnect::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          SquareConnect.configure { |c| c.host = 'http://example.com' }
+          expect(SquareConnect::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          SquareConnect.configure { |c| c.host = 'https://wookiee.com' }
+          expect(SquareConnect::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          SquareConnect.configure { |c| c.host = 'hobo.com/v4' }
+          expect(SquareConnect::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          SquareConnect.configure { |c| c.base_path = 'v4/dog' }
+          expect(SquareConnect::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          SquareConnect.configure { |c| c.base_path = '/v4/dog' }
+          expect(SquareConnect::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          SquareConnect.configure { |c| c.base_path = nil }
+          expect(SquareConnect::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "params_encoding in #build_request" do
+    let(:config) { SquareConnect::Configuration.new }
+    let(:api_client) { SquareConnect::ApiClient.new(config) }
+
+    it "defaults to nil" do
+      expect(SquareConnect::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) { SquareConnect::Configuration.new }
+    let(:api_client) { SquareConnect::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(SquareConnect::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 = SquareConnect::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 = SquareConnect::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 = SquareConnect::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 = SquareConnect::ApiClient.new
+      #_model = SquareConnect::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) { SquareConnect::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) { SquareConnect::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) { SquareConnect::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) { SquareConnect::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) { SquareConnect::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