zip_money 1.2.1

data/lib/zip_money/models/token.rb

@@ -0,0 +1,228 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+require 'date'
+
+module ZipMoney
+
+  class Token
+    attr_accessor :id
+
+    attr_accessor :value
+
+    attr_accessor :active
+
+    attr_accessor :created_date
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'value' => :'value',
+        :'active' => :'active',
+        :'created_date' => :'created_date'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.zip_types
+      {
+        :'id' => :'String',
+        :'value' => :'String',
+        :'active' => :'BOOLEAN',
+        :'created_date' => :'DateTime'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.has_key?(:'active')
+        self.active = attributes[:'active']
+      end
+
+      if attributes.has_key?(:'created_date')
+        self.created_date = attributes[:'created_date']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+      end
+
+      if @value.nil?
+        invalid_properties.push("invalid value for 'value', value cannot be nil.")
+      end
+
+      if @active.nil?
+        invalid_properties.push("invalid value for 'active', active cannot be nil.")
+      end
+
+      if @created_date.nil?
+        invalid_properties.push("invalid value for 'created_date', created_date cannot be nil.")
+      end
+
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @id.nil?
+      return false if @value.nil?
+      return false if @active.nil?
+      return false if @created_date.nil?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          value == o.value &&
+          active == o.active &&
+          created_date == o.created_date
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, value, active, created_date].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.zip_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = ZipMoney.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/zip_money/version.rb

@@ -0,0 +1,8 @@
+#Merchant API
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+module ZipMoney
+  VERSION = "1.2.1"
+end

data/spec/api/charges_api_spec.rb

@@ -0,0 +1,114 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ZipMoney::ChargesApi
+# Please update as you see appropriate
+describe 'ChargesApi' do
+  before do   
+    auth = JSON.parse(File.read('./spec/auth.json'))
+
+    ZipMoney.configure do |c|
+      c.environment = :sandbox;
+      c.host = "api.sandbox.zipmoney.com.au"
+      c.api_key['Authorization'] = auth["api_key"];
+      c.api_key_prefix['Authorization'] = "Bearer";
+      #c.debugging = true;
+    end
+    @instance = ZipMoney::ChargesApi.new
+    @payload_helper = ZipMoney::PayloadHelper.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ChargesApi' do
+    it 'should create an instact of ChargesApi' do
+      expect(@instance).to be_instance_of(ZipMoney::ChargesApi)
+    end
+  end
+
+  # unit tests for charges_cancel
+  # Cancel a charge
+  # Cancels an authorised charge.  | Error code | Description | |------------------------------------|--------------------------------------------------------------------------------------------------| | invalid_state | The charge is not in authorised state |
+  # @param id The id of the authorised charge
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :idempotency_key The unique idempotency key.
+  # @return [Charge]
+  describe 'charges_cancel 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 charges_capture
+  # Capture a charge
+  # | Error code | Description | |------------------------------------|--------------------------------------------------------------------------------------------------| | amount_invalid | Capture amount greater than authorised amount | | invalid_state | The charge is not in authorised state |
+  # @param id The id of the authorised charge
+  # @param [Hash] opts the optional parameters
+  # @option opts [CaptureChargeRequest] :body 
+  # @option opts [String] :idempotency_key The unique idempotency key.
+  # @return [Charge]
+  describe 'charges_capture 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 charges_create
+  # Create a charge
+  # Creates a #model:ehEN48PET29iNdex3 which represents a charge against a customer's account.  To execute this endpoint you must first obtain customer approval by implementing the #docTextSection:43C79g2JjeGs8AHWi as a part of your online store.  This endpoint will return 201 if successful otherwise 402 with a specific error response.  ## Capture or authorisation  A charge can be created as either an authorisation or an immediate capture. This can be controlled in the initial request to the charge.  In most cases you will want to immediately capture the payment, this will mark the debit for settlement into your account the very same day and will immediately deduct the funds from the customer's account.  In some cases you may wish to delay the settlement of funds until a later date, perhaps until the goods are shipped to the customer. In this scenario you should send { capture: false } in the request to the #endpoint:dtmp3HxaHKjewvvGW endpoint and the charge will be created in an authorised state.  An authorised charge will place a hold for the specified amount on the customer's account in the form of a pending debit. Once authorised you are guaranteed the funds are available and awaiting a capture request to the #endpoint:wReod3JtbzNutMSXj endpoint, at which point the charge will move to the captured state and the funds will be settled into your account. It is at this point the customer's interest free period will start if applicable for the selected account.  ## Specific error responses  If a charge was not able to be performed a \"402 - Request Failed\" status code will be returned as detailed in #docTextSection:fJYHM2ZKtEui8RrAM. The error object can contain more specific error reason codes, which are detailed below.  | Error code | Description | |------------------------------------|--------------------------------------------------------------------------------------------------| | account_insufficient_funds | Customer does not have sufficient funds to perform the charge | | account_inoperative | The account is in arrears or closed and cannot be charged | | account_locked | The account is locked | | amount_invalid | The amount provided does not match the approved checkout amount | | fraud_check | Fraud checks resulted in payment failure |
+  # @param [Hash] opts the optional parameters
+  # @option opts [CreateChargeRequest] :body 
+  # @option opts [String] :idempotency_key The unique idempotency key.
+  # @return [Charge]
+  describe 'charges_create test' do
+    it "should work" do
+        @checkoutapi = ZipMoney::CheckoutsApi.new
+        @payload = @payload_helper.checkout_request;      
+        result = @checkoutapi.checkouts_create(@payload);
+        @payload = @payload_helper.charge_request;
+        #@payload[:idempotency_key] = 1111
+        @payload[:body].authority.value = result.id;
+      begin
+        result = @instance.charges_create(@payload);
+      rescue ZipMoney::ApiError => e
+        puts e.response_body
+      end  
+    end
+  end
+
+  # unit tests for charges_list
+  # List charges
+  # Lists all charges matching search criteria.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :state The state filter
+  # @option opts [Integer] :skip Number of items to skip when paging
+  # @option opts [Integer] :limit Number of items to retrieve when paging
+  # @option opts [String] :expand Allows expanding related entities in the response. Only valid entry is 'customer'
+  # @return [ChargeCollection]
+  describe 'charges_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 charges_retrieve
+  # Retrieve a charge
+  # Retrieve details of a previously created charge.
+  # @param id The id of the charge
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :expand Allows expanding related entities in the response. Only valid entry is 'customer'
+  # @return [Charge]
+  describe 'charges_retrieve 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/checkouts_api_spec.rb

@@ -0,0 +1,54 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+require 'spec_helper'
+require 'payload_helper'
+require 'json'
+
+# Unit tests for ZipMoney::CheckoutsApi
+
+# Please update as you see appropriate
+describe 'CheckoutsApi' do
+  before do
+    # run before each test
+    auth = JSON.parse(File.read('./spec/auth.json'))
+
+    ZipMoney.configure do |c|
+      c.environment = :sandbox;
+      c.api_key['Authorization'] = auth["api_key"];
+      c.api_key_prefix['Authorization'] = "Bearer";
+    end
+    
+    @instance = ZipMoney::CheckoutsApi.new
+    @payload_helper = ZipMoney::PayloadHelper.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CheckoutsApi' do
+    it 'should create an instact of CheckoutsApi' do
+      expect(@instance).to be_instance_of(ZipMoney::CheckoutsApi)
+    end
+  end
+
+  # unit tests for checkouts_create
+  # Create a checkout
+  # Creates a zipMoney checkout.  During the checkout process a customer can apply for credit decisioning in real-time. This means the checkout needs to represent a good picture of known customer details along with order information and the checkout entity represents this as a resource.  For more information on how to checkout with zipMoney see the #model:Z2QcrzRGHACY8wM6G guide.
+  # @param [Hash] opts the optional parameters
+  # @option opts [CreateCheckoutRequest] :body 
+  # @return [Checkout]
+  # describe 'checkouts_create test' do
+  #   it "should work" do
+  #     @payload = @payload_helper.checkout_request;
+
+  #     result = @instance.checkouts_create(@payload);
+      
+  #     expect(result.uri.nil?).to eq false
+  #     expect(result.id.nil?).to eq false
+  #   end
+  # end
+end

data/spec/api/customers_api_spec.rb

@@ -0,0 +1,51 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ZipMoney::CustomersApi
+
+# Please update as you see appropriate
+describe 'CustomersApi' do
+  before do
+    # run before each test
+    @instance = ZipMoney::CustomersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CustomersApi' do
+    it 'should create an instact of CustomersApi' do
+      expect(@instance).to be_instance_of(ZipMoney::CustomersApi)
+    end
+  end
+
+  # unit tests for customers_get
+  # Retrieve customer
+  # Retrieves the details of a customer by id. This will only return customer details for customers who have transacted previously via the zip Merchant API.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'customers_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 customers_list
+  # List customers
+  # Returns a list of all customers who have transacted previously with your merchant account.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'customers_list test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end