apiverve_mortgagecalculator 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4020daac77cf0721e4a09928a85a494fb69f16abe264ef74435952ca4b73362f
+  data.tar.gz: b7aeb51c6018a8899217688a0d0e0e8e74b08af93193aed8c44c71a69f6c6cf3
+SHA512:
+  metadata.gz: 966253ccd7b70007f06ee551b2f11efebf92b375b05fa9f646199a96e64f04aaf42088f8ebe510cb5bed777337202ceb7d57cec215071e74a13fae82d5cb7834
+  data.tar.gz: 1df7e3ba134ef79fac82cd3a7c6557892c4532403d4abe5e13b2fcd0771cff616fc8146339bd0cfad5ed11b9510b53f22351691426e1df04bc5bcaffcf1e5fa2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) {{year}} APIVerve
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,142 @@
+# Mortgage Calculator API - Ruby Gem
+
+Mortgage Calculator is a simple tool for calculating mortgage payments. It returns the monthly payment, total interest, and more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apiverve_mortgagecalculator'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install apiverve_mortgagecalculator
+```
+
+## Getting Started
+
+Get your API key at [APIVerve](https://apiverve.com)
+
+### Basic Usage
+
+```ruby
+require 'apiverve_mortgagecalculator'
+
+# Initialize the client
+client = APIVerve::Mortgagecalculator::Client.new(api_key: "YOUR_API_KEY")
+
+# Make a request
+response = client.execute({
+  amount: 570000,
+  rate: 6.8,
+  years: 30
+})
+
+# Print the response
+puts response
+```
+
+
+### Error Handling
+
+```ruby
+begin
+  response = client.execute({ amount: 570000, rate: 6.8, years: 30 })
+  puts response["data"]
+rescue APIVerve::Mortgagecalculator::ValidationError => e
+  puts "Validation error: #{e.errors.join(', ')}"
+rescue APIVerve::Mortgagecalculator::APIError => e
+  puts "API error: #{e.message}"
+  puts "Status code: #{e.status_code}"
+end
+```
+
+### Debug Mode
+
+```ruby
+# Enable debug logging
+client = APIVerve::Mortgagecalculator::Client.new(
+  api_key: "YOUR_API_KEY",
+  debug: true
+)
+```
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "amount": 570000,
+    "downpayment": 0,
+    "rate": 6.8,
+    "years": 30,
+    "total_interest_paid": 767750.49,
+    "total_loan_payment": 1337750.49,
+    "interestRatio": 57.39,
+    "monthly_payment": {
+      "total": 3715.97,
+      "mortgage": 3715.97,
+      "property_tax": 0,
+      "hoa": 0,
+      "home_insurance": 0
+    },
+    "annual_payment": {
+      "total": 44591.68,
+      "mortgage": 44591.68,
+      "property_tax": 0,
+      "hoa": 0,
+      "home_insurance": 0
+    },
+    "formatted": {
+      "amount": "$570,000",
+      "monthlyPayment": "$3,715.97",
+      "totalInterestPaid": "$767,750.49",
+      "totalLoanPayment": "$1,337,750.49"
+    },
+    "amortization_schedule": [
+      {
+        "month": 1,
+        "interest_payment": 3230,
+        "principal_payment": 485.97,
+        "remaining_balance": 569514.03
+      },
+      {
+        "month": 2,
+        "interest_payment": 3227.25,
+        "principal_payment": 488.73,
+        "remaining_balance": 569025.3
+      },
+      {
+        "month": 3,
+        "interest_payment": 3224.48,
+        "principal_payment": 491.5,
+        "remaining_balance": 568533.8
+      }
+    ]
+  }
+}
+```
+
+## Documentation
+
+For more information, visit the [API Documentation](https://docs.apiverve.com/ref/mortgagecalculator?utm_source=rubygems&utm_medium=readme).
+
+## Support
+
+- Website: [https://mortgagecalculator.apiverve.com?utm_source=ruby&utm_medium=readme](https://mortgagecalculator.apiverve.com?utm_source=ruby&utm_medium=readme)
+- Email: hello@apiverve.com
+
+## License
+
+This gem is available under the [MIT License](LICENSE).

data/lib/apiverve/client.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/multipart"
+require "json"
+
+module APIVerve
+  module Mortgagecalculator
+    # Client for the Mortgage Calculator API
+    #
+    # @example Basic usage
+    #   client = APIVerve::Mortgagecalculator::Client.new(api_key: "your_api_key")
+    #   response = client.execute({ amount: 570000, rate: 6.8, years: 30 })
+    #   puts response
+    #
+    # @see https://mortgagecalculator.apiverve.com?utm_source=ruby&utm_medium=readme
+    class Client
+      BASE_URL = "https://api.apiverve.com/v1/mortgagecalculator"
+      DEFAULT_TIMEOUT = 30
+
+      # Validation rules for parameters
+      VALIDATION_RULES = { 'amount' => { type: 'number', required: true, min: 0 }, 'rate' => { type: 'number', required: true, min: 0, max: 100 }, 'years' => { type: 'integer', required: true, min: 1, max: 50 }, 'downpayment' => { type: 'number', required: false, min: 0 }, 'annual_propertytax' => { type: 'number', required: false, min: 0 }, 'annual_homeinsurance' => { type: 'number', required: false, min: 0 }, 'annual_hoa' => { type: 'number', required: false, min: 0 } }
+
+      # Format validation patterns
+      FORMAT_PATTERNS = {
+        'email' => /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
+        'url' => /^https?:\/\/.+/,
+        'ip' => /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
+        'date' => /^\d{4}-\d{2}-\d{2}$/,
+        'hexColor' => /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
+      }.freeze
+
+      # Initialize the client
+      #
+      # @param api_key [String] Your APIVerve API key
+      # @param timeout [Integer] Request timeout in seconds (default: 30)
+      # @param debug [Boolean] Enable debug logging (default: false)
+      # @raise [ArgumentError] If API key is invalid
+      def initialize(api_key:, timeout: DEFAULT_TIMEOUT, debug: false)
+        validate_api_key!(api_key)
+
+        @api_key = api_key
+        @timeout = timeout
+        @debug = debug
+
+        @connection = Faraday.new(url: BASE_URL) do |conn|
+          conn.request :multipart
+          conn.request :url_encoded
+          conn.adapter Faraday.default_adapter
+          conn.options.timeout = @timeout
+          conn.headers["x-api-key"] = @api_key
+          conn.headers["auth-mode"] = "rubygems-package"
+          conn.headers["Content-Type"] = "application/json"
+        end
+      end
+
+      # Execute the API request
+      #
+      # @param params [Hash] Query parameters or request body
+      # @return [Hash] API response
+      # @raise [APIError] If the request fails
+      # @raise [ValidationError] If parameter validation fails
+      def execute(params = {})
+        validate_params!(params)
+
+        log("Making POST request to #{BASE_URL}")
+        log("Parameters: #{params.inspect}") if params.any?
+
+        response = @connection.post do |req|
+          req.body = params.to_json
+        end
+
+        handle_response(response)
+      end
+
+      private
+
+      def validate_api_key!(api_key)
+        raise ArgumentError, "API key is required. Get your API key at: https://apiverve.com" if api_key.nil? || api_key.strip.empty?
+
+        unless api_key.match?(/^[a-zA-Z0-9_-]+$/)
+          raise ArgumentError, "Invalid API key format. API key should only contain letters, numbers, hyphens, and underscores."
+        end
+      end
+
+      def validate_params!(params)
+        return if VALIDATION_RULES.empty?
+
+        errors = []
+
+        VALIDATION_RULES.each do |param_name, rules|
+          value = params[param_name.to_sym] || params[param_name]
+
+          # Check required
+          if rules[:required] && (value.nil? || value.to_s.empty?)
+            errors << "Required parameter [#{param_name}] is missing."
+            next
+          end
+
+          next if value.nil?
+
+          case rules[:type]
+          when "integer", "number"
+            begin
+              num_value = rules[:type] == "number" ? Float(value) : Integer(value)
+              errors << "Parameter [#{param_name}] must be at least #{rules[:min]}." if rules[:min] && num_value < rules[:min]
+              errors << "Parameter [#{param_name}] must be at most #{rules[:max]}." if rules[:max] && num_value > rules[:max]
+            rescue ArgumentError, TypeError
+              errors << "Parameter [#{param_name}] must be a valid #{rules[:type]}."
+            end
+          when "string"
+            unless value.is_a?(String)
+              errors << "Parameter [#{param_name}] must be a string."
+              next
+            end
+            errors << "Parameter [#{param_name}] must be at least #{rules[:min_length]} characters." if rules[:min_length] && value.length < rules[:min_length]
+            errors << "Parameter [#{param_name}] must be at most #{rules[:max_length]} characters." if rules[:max_length] && value.length > rules[:max_length]
+
+            if rules[:format] && FORMAT_PATTERNS[rules[:format]]
+              unless value.match?(FORMAT_PATTERNS[rules[:format]])
+                errors << "Parameter [#{param_name}] must be a valid #{rules[:format]}."
+              end
+            end
+          when "boolean"
+            unless [true, false, "true", "false"].include?(value)
+              errors << "Parameter [#{param_name}] must be a boolean."
+            end
+          end
+
+          # Enum validation
+          if rules[:enum] && !rules[:enum].include?(value)
+            errors << "Parameter [#{param_name}] must be one of: #{rules[:enum].join(', ')}."
+          end
+        end
+
+        raise ValidationError, errors unless errors.empty?
+      end
+
+      def handle_response(response)
+        log("Response status: #{response.status}")
+
+        data = JSON.parse(response.body)
+
+        if data["status"] == "error"
+          raise APIError.new(data["error"] || "Unknown API error", response.status, data)
+        end
+
+        unless response.success?
+          raise APIError.new(data["error"] || "HTTP #{response.status} error", response.status, data)
+        end
+
+        log("Request successful")
+        data
+      rescue JSON::ParserError => e
+        raise APIError.new("Invalid JSON response: #{e.message}", response.status)
+      end
+
+      def log(message)
+        puts "[APIVerve::Mortgagecalculator] #{message}" if @debug
+      end
+    end
+
+    # Custom error class for API errors
+    class APIError < StandardError
+      attr_reader :status_code, :response
+
+      def initialize(message, status_code = nil, response = nil)
+        @status_code = status_code
+        @response = response
+        super(message)
+      end
+    end
+
+    # Custom error class for validation errors
+    class ValidationError < StandardError
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+        super("Validation failed: #{errors.join(' ')}")
+      end
+    end
+  end
+end

data/lib/apiverve_mortgagecalculator/client.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/multipart"
+require "json"
+
+module APIVerve
+  module Mortgagecalculator
+    # Client for the Mortgage Calculator API
+    #
+    # @example Basic usage
+    #   client = APIVerve::Mortgagecalculator::Client.new(api_key: "your_api_key")
+    #   response = client.execute({ amount: 570000, rate: 6.8, years: 30 })
+    #   puts response
+    #
+    # @see https://apiverve.com/marketplace/mortgagecalculator?utm_source=ruby&utm_medium=readme
+    class Client
+      BASE_URL = "https://api.apiverve.com/v1/mortgagecalculator"
+      DEFAULT_TIMEOUT = 30
+
+      # Validation rules for parameters
+      VALIDATION_RULES = {
+      'amount' => { type: 'number', required: true, min: 0 },
+      'rate' => { type: 'number', required: true, min: 0, max: 100 },
+      'years' => { type: 'integer', required: true, min: 1, max: 50 },
+      'downpayment' => { type: 'number', required: false, min: 0 },
+      'annual_propertytax' => { type: 'number', required: false, min: 0 },
+      'annual_homeinsurance' => { type: 'number', required: false, min: 0 },
+      'annual_hoa' => { type: 'number', required: false, min: 0 }
+    }
+
+      # Format validation patterns
+      FORMAT_PATTERNS = {
+        'email' => /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
+        'url' => /^https?:\/\/.+/,
+        'ip' => /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
+        'date' => /^\d{4}-\d{2}-\d{2}$/,
+        'hexColor' => /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
+      }.freeze
+
+      # Initialize the client
+      #
+      # @param api_key [String] Your APIVerve API key
+      # @param timeout [Integer] Request timeout in seconds (default: 30)
+      # @param debug [Boolean] Enable debug logging (default: false)
+      # @raise [ArgumentError] If API key is invalid
+      def initialize(api_key:, timeout: DEFAULT_TIMEOUT, debug: false)
+        validate_api_key!(api_key)
+
+        @api_key = api_key
+        @timeout = timeout
+        @debug = debug
+
+        @connection = Faraday.new(url: BASE_URL) do |conn|
+          conn.request :multipart
+          conn.request :url_encoded
+          conn.adapter Faraday.default_adapter
+          conn.options.timeout = @timeout
+          conn.headers["x-api-key"] = @api_key
+          conn.headers["auth-mode"] = "rubygems-package"
+          conn.headers["Content-Type"] = "application/json"
+        end
+      end
+
+      # Execute the API request
+      #
+      # @param params [Hash] Query parameters or request body
+      # @return [Hash] API response
+      # @raise [APIError] If the request fails
+      # @raise [ValidationError] If parameter validation fails
+      def execute(params = {})
+        validate_params!(params)
+
+        log("Making POST request to #{BASE_URL}")
+        log("Parameters: #{params.inspect}") if params.any?
+
+        response = @connection.post do |req|
+          req.body = params.to_json
+        end
+
+        handle_response(response)
+      end
+
+      private
+
+      def validate_api_key!(api_key)
+        raise ArgumentError, "API key is required. Get your API key at: https://apiverve.com" if api_key.nil? || api_key.strip.empty?
+
+        unless api_key.match?(/^[a-zA-Z0-9_-]+$/)
+          raise ArgumentError, "Invalid API key format. API key should only contain letters, numbers, hyphens, and underscores."
+        end
+      end
+
+      def validate_params!(params)
+        return if VALIDATION_RULES.empty?
+
+        errors = []
+
+        VALIDATION_RULES.each do |param_name, rules|
+          value = params[param_name.to_sym] || params[param_name]
+
+          # Check required
+          if rules[:required] && (value.nil? || value.to_s.empty?)
+            errors << "Required parameter [#{param_name}] is missing."
+            next
+          end
+
+          next if value.nil?
+
+          case rules[:type]
+          when "integer", "number"
+            begin
+              num_value = rules[:type] == "number" ? Float(value) : Integer(value)
+              errors << "Parameter [#{param_name}] must be at least #{rules[:min]}." if rules[:min] && num_value < rules[:min]
+              errors << "Parameter [#{param_name}] must be at most #{rules[:max]}." if rules[:max] && num_value > rules[:max]
+            rescue ArgumentError, TypeError
+              errors << "Parameter [#{param_name}] must be a valid #{rules[:type]}."
+            end
+          when "string"
+            unless value.is_a?(String)
+              errors << "Parameter [#{param_name}] must be a string."
+              next
+            end
+            errors << "Parameter [#{param_name}] must be at least #{rules[:min_length]} characters." if rules[:min_length] && value.length < rules[:min_length]
+            errors << "Parameter [#{param_name}] must be at most #{rules[:max_length]} characters." if rules[:max_length] && value.length > rules[:max_length]
+
+            if rules[:format] && FORMAT_PATTERNS[rules[:format]]
+              unless value.match?(FORMAT_PATTERNS[rules[:format]])
+                errors << "Parameter [#{param_name}] must be a valid #{rules[:format]}."
+              end
+            end
+          when "boolean"
+            unless [true, false, "true", "false"].include?(value)
+              errors << "Parameter [#{param_name}] must be a boolean."
+            end
+          end
+
+          # Enum validation
+          if rules[:enum] && !rules[:enum].include?(value)
+            errors << "Parameter [#{param_name}] must be one of: #{rules[:enum].join(', ')}."
+          end
+        end
+
+        raise ValidationError, errors unless errors.empty?
+      end
+
+      def handle_response(response)
+        log("Response status: #{response.status}")
+
+        data = JSON.parse(response.body)
+
+        if data["status"] == "error"
+          raise APIError.new(data["error"] || "Unknown API error", response.status, data)
+        end
+
+        unless response.success?
+          raise APIError.new(data["error"] || "HTTP #{response.status} error", response.status, data)
+        end
+
+        log("Request successful")
+        data
+      rescue JSON::ParserError => e
+        raise APIError.new("Invalid JSON response: #{e.message}", response.status)
+      end
+
+      def log(message)
+        puts "[APIVerve::Mortgagecalculator] #{message}" if @debug
+      end
+    end
+
+    # Custom error class for API errors
+    class APIError < StandardError
+      attr_reader :status_code, :response
+
+      def initialize(message, status_code = nil, response = nil)
+        @status_code = status_code
+        @response = response
+        super(message)
+      end
+    end
+
+    # Custom error class for validation errors
+    class ValidationError < StandardError
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+        super("Validation failed: #{errors.join(' ')}")
+      end
+    end
+  end
+end

data/lib/apiverve_mortgagecalculator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "apiverve_mortgagecalculator/client"
+
+module APIVerve
+  module Mortgagecalculator
+    VERSION = "1.2.0"
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: apiverve_mortgagecalculator
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- APIVerve
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Mortgage Calculator is a simple tool for calculating mortgage payments.
+  It returns the monthly payment, total interest, and more.
+email:
+- hello@apiverve.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/apiverve/client.rb
+- lib/apiverve_mortgagecalculator.rb
+- lib/apiverve_mortgagecalculator/client.rb
+homepage: https://mortgagecalculator.apiverve.com?utm_source=ruby&utm_medium=homepage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://mortgagecalculator.apiverve.com?utm_source=ruby&utm_medium=homepage
+  source_code_uri: https://github.com/apiverve/mortgagecalculator-API/tree/main/ruby
+  changelog_uri: https://apiverve.com/changelog
+  documentation_uri: https://docs.apiverve.com/ref/mortgagecalculator
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Mortgage Calculator API - Ruby Client
+test_files: []